/* * Copyright 2016 Advanced Micro Devices, Inc. * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), * to deal in the Software without restriction, including without limitation * the rights to use, copy, modify, merge, publish, distribute, sublicense, * and/or sell copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR * OTHER DEALINGS IN THE SOFTWARE. * * Authors: AMD */ #ifndef DRIVERS_GPU_DRM_AMD_DC_DEV_DC_INC_REG_HELPER_H_ #define DRIVERS_GPU_DRM_AMD_DC_DEV_DC_INC_REG_HELPER_H_ #include "dm_services.h" /* macro for register read/write * user of macro need to define * * CTX ==> macro to ptr to dc_context * eg. aud110->base.ctx * * REG ==> macro to location of register offset * eg. aud110->regs->reg */ #define REG_READ(reg_name) \ dm_read_reg(CTX, REG(reg_name)) #define REG_WRITE(reg_name, value) \ dm_write_reg(CTX, REG(reg_name), value) #ifdef REG_SET #undef REG_SET #endif #ifdef REG_GET #undef REG_GET #endif /* macro to set register fields. */ #define REG_SET_N(reg_name, n, initial_val, ...) \ generic_reg_update_ex(CTX, \ REG(reg_name), \ initial_val, \ n, __VA_ARGS__) #define FN(reg_name, field) \ FD(reg_name##__##field) #define REG_SET(reg_name, initial_val, field, val) \ REG_SET_N(reg_name, 1, initial_val, \ FN(reg_name, field), val) #define REG_SET_2(reg, init_value, f1, v1, f2, v2) \ REG_SET_N(reg, 2, init_value, \ FN(reg, f1), v1,\ FN(reg, f2), v2) #define REG_SET_3(reg, init_value, f1, v1, f2, v2, f3, v3) \ REG_SET_N(reg, 3, init_value, \ FN(reg, f1), v1,\ FN(reg, f2), v2,\ FN(reg, f3), v3) #define REG_SET_4(reg, init_value, f1, v1, f2, v2, f3, v3, f4, v4) \ REG_SET_N(reg, 4, init_value, \ FN(reg, f1), v1,\ FN(reg, f2), v2,\ FN(reg, f3), v3,\ FN(reg, f4), v4) #define REG_SET_5(reg, init_value, f1, v1, f2, v2, f3, v3, f4, v4, \ f5, v5) \ REG_SET_N(reg, 5, init_value, \ FN(reg, f1), v1,\ FN(reg, f2), v2,\ FN(reg, f3), v3,\ FN(reg, f4), v4,\ FN(reg, f5), v5) #define REG_SET_6(reg, init_value, f1, v1, f2, v2, f3, v3, f4, v4, \ f5, v5, f6, v6) \ REG_SET_N(reg, 6, init_value, \ FN(reg, f1), v1,\ FN(reg, f2), v2,\ FN(reg, f3), v3,\ FN(reg, f4), v4,\ FN(reg, f5), v5,\ FN(reg, f6), v6) #define REG_SET_7(reg, init_value, f1, v1, f2, v2, f3, v3, f4, v4, \ f5, v5, f6, v6, f7, v7) \ REG_SET_N(reg, 7, init_value, \ FN(reg, f1), v1,\ FN(reg, f2), v2,\ FN(reg, f3), v3,\ FN(reg, f4), v4,\ FN(reg, f5), v5,\ FN(reg, f6), v6,\ FN(reg, f7), v7) #define REG_SET_8(reg, init_value, f1, v1, f2, v2, f3, v3, f4, v4, \ f5, v5, f6, v6, f7, v7, f8, v8) \ REG_SET_N(reg, 8, init_value, \ FN(reg, f1), v1,\ FN(reg, f2), v2,\ FN(reg, f3), v3,\ FN(reg, f4), v4,\ FN(reg, f5), v5,\ FN(reg, f6), v6,\ FN(reg, f7), v7,\ FN(reg, f8), v8) #define REG_SET_9(reg, init_value, f1, v1, f2, v2, f3, v3, f4, v4, f5, \ v5, f6, v6, f7, v7, f8, v8, f9, v9) \ REG_SET_N(reg, 9, init_value, \ FN(reg, f1), v1,\ FN(reg, f2), v2, \ FN(reg, f3), v3, \ FN(reg, f4), v4, \ FN(reg, f5), v5, \ FN(reg, f6), v6, \ FN(reg, f7), v7, \ FN(reg, f8), v8, \ FN(reg, f9), v9) #define REG_SET_10(reg, init_value, f1, v1, f2, v2, f3, v3, f4, v4, f5, \ v5, f6, v6, f7, v7, f8, v8, f9, v9, f10, v10) \ REG_SET_N(reg, 10, init_value, \ FN(reg, f1), v1,\ FN(reg, f2), v2, \ FN(reg, f3), v3, \ FN(reg, f4), v4, \ FN(reg, f5), v5, \ FN(reg, f6), v6, \ FN(reg, f7), v7, \ FN(reg, f8), v8, \ FN(reg, f9), v9, \ FN(reg, f10), v10) /* macro to get register fields * read given register and fill in field value in output parameter */ #define REG_GET(reg_name, field, val) \ generic_reg_get(CTX, REG(reg_name), \ FN(reg_name, field), val) #define REG_GET_2(reg_name, f1, v1, f2, v2) \ generic_reg_get2(CTX, REG(reg_name), \ FN(reg_name, f1), v1, \ FN(reg_name, f2), v2) #define REG_GET_3(reg_name, f1, v1, f2, v2, f3, v3) \ generic_reg_get3(CTX, REG(reg_name), \ FN(reg_name, f1), v1, \ FN(reg_name, f2), v2, \ FN(reg_name, f3), v3) #define REG_GET_4(reg_name, f1, v1, f2, v2, f3, v3, f4, v4) \ generic_reg_get4(CTX, REG(reg_name), \ FN(reg_name, f1), v1, \ FN(reg_name, f2), v2, \ FN(reg_name, f3), v3, \ FN(reg_name, f4), v4) #define REG_GET_5(reg_name, f1, v1, f2, v2, f3, v3, f4, v4, f5, v5) \ generic_reg_get5(CTX, REG(reg_name), \ FN(reg_name, f1), v1, \ FN(reg_name, f2), v2, \ FN(reg_name, f3), v3, \ FN(reg_name, f4), v4, \ FN(reg_name, f5), v5) #define REG_GET_6(reg_name, f1, v1, f2, v2, f3, v3, f4, v4, f5, v5, f6, v6) \ generic_reg_get6(CTX, REG(reg_name), \ FN(reg_name, f1), v1, \ FN(reg_name, f2), v2, \ FN(reg_name, f3), v3, \ FN(reg_name, f4), v4, \ FN(reg_name, f5), v5, \ FN(reg_name, f6), v6) #define REG_GET_7(reg_name, f1, v1, f2, v2, f3, v3, f4, v4, f5, v5, f6, v6, f7, v7) \ generic_reg_get7(CTX, REG(reg_name), \ FN(reg_name, f1), v1, \ FN(reg_name, f2), v2, \ FN(reg_name, f3), v3, \ FN(reg_name, f4), v4, \ FN(reg_name, f5), v5, \ FN(reg_name, f6), v6, \ FN(reg_name, f7), v7) #define REG_GET_8(reg_name, f1, v1, f2, v2, f3, v3, f4, v4, f5, v5, f6, v6, f7, v7, f8, v8) \ generic_reg_get8(CTX, REG(reg_name), \ FN(reg_name, f1), v1, \ FN(reg_name, f2), v2, \ FN(reg_name, f3), v3, \ FN(reg_name, f4), v4, \ FN(reg_name, f5), v5, \ FN(reg_name, f6), v6, \ FN(reg_name, f7), v7, \ FN(reg_name, f8), v8) /* macro to poll and wait for a register field to read back given value */ #define REG_WAIT(reg_name, field, val, delay_between_poll_us, max_try) \ generic_reg_wait(CTX, \ REG(reg_name), FN(reg_name, field), val,\ delay_between_poll_us, max_try, __func__, __LINE__) /* macro to update (read, modify, write) register fields */ #define REG_UPDATE_N(reg_name, n, ...) \ generic_reg_update_ex(CTX, \ REG(reg_name), \ REG_READ(reg_name), \ n, __VA_ARGS__) #define REG_UPDATE(reg_name, field, val) \ REG_UPDATE_N(reg_name, 1, \ FN(reg_name, field), val) #define REG_UPDATE_2(reg, f1, v1, f2, v2) \ REG_UPDATE_N(reg, 2,\ FN(reg, f1), v1,\ FN(reg, f2), v2) #define REG_UPDATE_3(reg, f1, v1, f2, v2, f3, v3) \ REG_UPDATE_N(reg, 3, \ FN(reg, f1), v1,\ FN(reg, f2), v2, \ FN(reg, f3), v3) #define REG_UPDATE_4(reg, f1, v1, f2, v2, f3, v3, f4, v4) \ REG_UPDATE_N(reg, 4, \ FN(reg, f1), v1,\ FN(reg, f2), v2, \ FN(reg, f3), v3, \ FN(reg, f4), v4) #define REG_UPDATE_5(reg, f1, v1, f2, v2, f3, v3, f4, v4, f5, v5) \ REG_UPDATE_N(reg, 5, \ FN(reg, f1), v1,\ FN(reg, f2), v2, \ FN(reg, f3), v3, \ FN(reg, f4), v4, \ FN(reg, f5), v5) #define REG_UPDATE_6(reg, f1, v1, f2, v2, f3, v3, f4, v4, f5, v5, f6, v6) \ REG_UPDATE_N(reg, 6, \ FN(reg, f1), v1,\ FN(reg, f2), v2, \ FN(reg, f3), v3, \ FN(reg, f4), v4, \ FN(reg, f5), v5, \ FN(reg, f6), v6) #define REG_UPDATE_7(reg, f1, v1, f2, v2, f3, v3, f4, v4, f5, v5, f6, v6, f7, v7) \ REG_UPDATE_N(reg, 7, \ FN(reg, f1), v1,\ FN(reg, f2), v2, \ FN(reg, f3), v3, \ FN(reg, f4), v4, \ FN(reg, f5), v5, \ FN(reg, f6), v6, \ FN(reg, f7), v7) #define REG_UPDATE_8(reg, f1, v1, f2, v2, f3, v3, f4, v4, f5, v5, f6, v6, f7, v7, f8, v8) \ REG_UPDATE_N(reg, 8, \ FN(reg, f1), v1,\ FN(reg, f2), v2, \ FN(reg, f3), v3, \ FN(reg, f4), v4, \ FN(reg, f5), v5, \ FN(reg, f6), v6, \ FN(reg, f7), v7, \ FN(reg, f8), v8) #define REG_UPDATE_9(reg, f1, v1, f2, v2, f3, v3, f4, v4, f5, v5, f6, v6, f7, v7, f8, v8, f9, v9) \ REG_UPDATE_N(reg, 9, \ FN(reg, f1), v1,\ FN(reg, f2), v2, \ FN(reg, f3), v3, \ FN(reg, f4), v4, \ FN(reg, f5), v5, \ FN(reg, f6), v6, \ FN(reg, f7), v7, \ FN(reg, f8), v8, \ FN(reg, f9), v9) #define REG_UPDATE_10(reg, f1, v1, f2, v2, f3, v3, f4, v4, f5, v5, f6, v6, f7, v7, f8, v8, f9, v9, f10, v10)\ REG_UPDATE_N(reg, 10, \ FN(reg, f1), v1,\ FN(reg, f2), v2, \ FN(reg, f3), v3, \ FN(reg, f4), v4, \ FN(reg, f5), v5, \ FN(reg, f6), v6, \ FN(reg, f7), v7, \ FN(reg, f8), v8, \ FN(reg, f9), v9, \ FN(reg, f10), v10) #define REG_UPDATE_14(reg, f1, v1, f2, v2, f3, v3, f4, v4, f5, v5, f6, v6, f7, v7, f8, v8, f9, v9, f10,\ v10, f11, v11, f12, v12, f13, v13, f14, v14)\ REG_UPDATE_N(reg, 14, \ FN(reg, f1), v1,\ FN(reg, f2), v2, \ FN(reg, f3), v3, \ FN(reg, f4), v4, \ FN(reg, f5), v5, \ FN(reg, f6), v6, \ FN(reg, f7), v7, \ FN(reg, f8), v8, \ FN(reg, f9), v9, \ FN(reg, f10), v10, \ FN(reg, f11), v11, \ FN(reg, f12), v12, \ FN(reg, f13), v13, \ FN(reg, f14), v14) #define REG_UPDATE_19(reg, f1, v1, f2, v2, f3, v3, f4, v4, f5, v5, f6, v6, f7, v7, f8, v8, f9, v9, f10,\ v10, f11, v11, f12, v12, f13, v13, f14, v14, f15, v15, f16, v16, f17, v17, f18, v18, f19, v19)\ REG_UPDATE_N(reg, 19, \ FN(reg, f1), v1,\ FN(reg, f2), v2, \ FN(reg, f3), v3, \ FN(reg, f4), v4, \ FN(reg, f5), v5, \ FN(reg, f6), v6, \ FN(reg, f7), v7, \ FN(reg, f8), v8, \ FN(reg, f9), v9, \ FN(reg, f10), v10, \ FN(reg, f11), v11, \ FN(reg, f12), v12, \ FN(reg, f13), v13, \ FN(reg, f14), v14, \ FN(reg, f15), v15, \ FN(reg, f16), v16, \ FN(reg, f17), v17, \ FN(reg, f18), v18, \ FN(reg, f19), v19) #define REG_UPDATE_20(reg, f1, v1, f2, v2, f3, v3, f4, v4, f5, v5, f6, v6, f7, v7, f8, v8, f9, v9, f10,\ v10, f11, v11, f12, v12, f13, v13, f14, v14, f15, v15, f16, v16, f17, v17, f18, v18, f19, v19, f20, v20)\ REG_UPDATE_N(reg, 20, \ FN(reg, f1), v1,\ FN(reg, f2), v2, \ FN(reg, f3), v3, \ FN(reg, f4), v4, \ FN(reg, f5), v5, \ FN(reg, f6), v6, \ FN(reg, f7), v7, \ FN(reg, f8), v8, \ FN(reg, f9), v9, \ FN(reg, f10), v10, \ FN(reg, f11), v11, \ FN(reg, f12), v12, \ FN(reg, f13), v13, \ FN(reg, f14), v14, \ FN(reg, f15), v15, \ FN(reg, f16), v16, \ FN(reg, f17), v17, \ FN(reg, f18), v18, \ FN(reg, f19), v19, \ FN(reg, f20), v20) /* macro to update a register field to specified values in given sequences. * useful when toggling bits */ #define REG_UPDATE_SEQ(reg, field, value1, value2) \ { uint32_t val = REG_UPDATE(reg, field, value1); \ REG_SET(reg, val, field, value2); } /* macro to update fields in register 1 field at a time in given order */ #define REG_UPDATE_1BY1_2(reg, f1, v1, f2, v2) \ { uint32_t val = REG_UPDATE(reg, f1, v1); \ REG_SET(reg, val, f2, v2); } #define REG_UPDATE_1BY1_3(reg, f1, v1, f2, v2, f3, v3) \ { uint32_t val = REG_UPDATE(reg, f1, v1); \ val = REG_SET(reg, val, f2, v2); \ REG_SET(reg, val, f3, v3); } uint32_t generic_reg_get(const struct dc_context *ctx, uint32_t addr, uint8_t shift, uint32_t mask, uint32_t *field_value); uint32_t generic_reg_get2(const struct dc_context *ctx, uint32_t addr, uint8_t shift1, uint32_t mask1, uint32_t *field_value1, uint8_t shift2, uint32_t mask2, uint32_t *field_value2); uint32_t generic_reg_get3(const struct dc_context *ctx, uint32_t addr, uint8_t shift1, uint32_t mask1, uint32_t *field_value1, uint8_t shift2, uint32_t mask2, uint32_t *field_value2, uint8_t shift3, uint32_t mask3, uint32_t *field_value3); uint32_t generic_reg_get4(const struct dc_context *ctx, uint32_t addr, uint8_t shift1, uint32_t mask1, uint32_t *field_value1, uint8_t shift2, uint32_t mask2, uint32_t *field_value2, uint8_t shift3, uint32_t mask3, uint32_t *field_value3, uint8_t shift4, uint32_t mask4, uint32_t *field_value4); uint32_t generic_reg_get5(const struct dc_context *ctx, uint32_t addr, uint8_t shift1, uint32_t mask1, uint32_t *field_value1, uint8_t shift2, uint32_t mask2, uint32_t *field_value2, uint8_t shift3, uint32_t mask3, uint32_t *field_value3, uint8_t shift4, uint32_t mask4, uint32_t *field_value4, uint8_t shift5, uint32_t mask5, uint32_t *field_value5); uint32_t generic_reg_get6(const struct dc_context *ctx, uint32_t addr, uint8_t shift1, uint32_t mask1, uint32_t *field_value1, uint8_t shift2, uint32_t mask2, uint32_t *field_value2, uint8_t shift3, uint32_t mask3, uint32_t *field_value3, uint8_t shift4, uint32_t mask4, uint32_t *field_value4, uint8_t shift5, uint32_t mask5, uint32_t *field_value5, uint8_t shift6, uint32_t mask6, uint32_t *field_value6); uint32_t generic_reg_get7(const struct dc_context *ctx, uint32_t addr, uint8_t shift1, uint32_t mask1, uint32_t *field_value1, uint8_t shift2, uint32_t mask2, uint32_t *field_value2, uint8_t shift3, uint32_t mask3, uint32_t *field_value3, uint8_t shift4, uint32_t mask4, uint32_t *field_value4, uint8_t shift5, uint32_t mask5, uint32_t *field_value5, uint8_t shift6, uint32_t mask6, uint32_t *field_value6, uint8_t shift7, uint32_t mask7, uint32_t *field_value7); uint32_t generic_reg_get8(const struct dc_context *ctx, uint32_t addr, uint8_t shift1, uint32_t mask1, uint32_t *field_value1, uint8_t shift2, uint32_t mask2, uint32_t *field_value2, uint8_t shift3, uint32_t mask3, uint32_t *field_value3, uint8_t shift4, uint32_t mask4, uint32_t *field_value4, uint8_t shift5, uint32_t mask5, uint32_t *field_value5, uint8_t shift6, uint32_t mask6, uint32_t *field_value6, uint8_t shift7, uint32_t mask7, uint32_t *field_value7, uint8_t shift8, uint32_t mask8, uint32_t *field_value8); /* indirect register access */ #define IX_REG_SET_N(index_reg_name, data_reg_name, index, n, initial_val, ...) \ generic_indirect_reg_update_ex(CTX, \ REG(index_reg_name), REG(data_reg_name), IND_REG(index), \ initial_val, \ n, __VA_ARGS__) #define IX_REG_SET_2(index_reg_name, data_reg_name, index, init_value, f1, v1, f2, v2) \ IX_REG_SET_N(index_reg_name, data_reg_name, index, 2, init_value, \ FN(reg, f1), v1,\ FN(reg, f2), v2) #define IX_REG_READ(index_reg_name, data_reg_name, index) \ generic_read_indirect_reg(CTX, REG(index_reg_name), REG(data_reg_name), IND_REG(index)) #define IX_REG_UPDATE_N(index_reg_name, data_reg_name, index, n, ...) \ generic_indirect_reg_update_ex(CTX, \ REG(index_reg_name), REG(data_reg_name), IND_REG(index), \ IX_REG_READ(index_reg_name, data_reg_name, index), \ n, __VA_ARGS__) #define IX_REG_UPDATE_2(index_reg_name, data_reg_name, index, f1, v1, f2, v2) \ IX_REG_UPDATE_N(index_reg_name, data_reg_name, index, 2,\ FN(reg, f1), v1,\ FN(reg, f2), v2) void generic_write_indirect_reg(const struct dc_context *ctx, uint32_t addr_index, uint32_t addr_data, uint32_t index, uint32_t data); uint32_t generic_read_indirect_reg(const struct dc_context *ctx, uint32_t addr_index, uint32_t addr_data, uint32_t index); uint32_t generic_indirect_reg_update_ex(const struct dc_context *ctx, uint32_t addr_index, uint32_t addr_data, uint32_t index, uint32_t reg_val, int n, uint8_t shift1, uint32_t mask1, uint32_t field_value1, ...); #endif /* DRIVERS_GPU_DRM_AMD_DC_DEV_DC_INC_REG_HELPER_H_ */