reg_helper.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448
  1. /*
  2. * Copyright 2016 Advanced Micro Devices, Inc.
  3. *
  4. * Permission is hereby granted, free of charge, to any person obtaining a
  5. * copy of this software and associated documentation files (the "Software"),
  6. * to deal in the Software without restriction, including without limitation
  7. * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  8. * and/or sell copies of the Software, and to permit persons to whom the
  9. * Software is furnished to do so, subject to the following conditions:
  10. *
  11. * The above copyright notice and this permission notice shall be included in
  12. * all copies or substantial portions of the Software.
  13. *
  14. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  17. * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
  18. * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  19. * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  20. * OTHER DEALINGS IN THE SOFTWARE.
  21. *
  22. * Authors: AMD
  23. */
  24. #ifndef DRIVERS_GPU_DRM_AMD_DC_DEV_DC_INC_REG_HELPER_H_
  25. #define DRIVERS_GPU_DRM_AMD_DC_DEV_DC_INC_REG_HELPER_H_
  26. #include "dm_services.h"
  27. /* macro for register read/write
  28. * user of macro need to define
  29. *
  30. * CTX ==> macro to ptr to dc_context
  31. * eg. aud110->base.ctx
  32. *
  33. * REG ==> macro to location of register offset
  34. * eg. aud110->regs->reg
  35. */
  36. #define REG_READ(reg_name) \
  37. dm_read_reg(CTX, REG(reg_name))
  38. #define REG_WRITE(reg_name, value) \
  39. dm_write_reg(CTX, REG(reg_name), value)
  40. #ifdef REG_SET
  41. #undef REG_SET
  42. #endif
  43. #ifdef REG_GET
  44. #undef REG_GET
  45. #endif
  46. /* macro to set register fields. */
  47. #define REG_SET_N(reg_name, n, initial_val, ...) \
  48. generic_reg_update_ex(CTX, \
  49. REG(reg_name), \
  50. initial_val, \
  51. n, __VA_ARGS__)
  52. #define FN(reg_name, field) \
  53. FD(reg_name##__##field)
  54. #define REG_SET(reg_name, initial_val, field, val) \
  55. REG_SET_N(reg_name, 1, initial_val, \
  56. FN(reg_name, field), val)
  57. #define REG_SET_2(reg, init_value, f1, v1, f2, v2) \
  58. REG_SET_N(reg, 2, init_value, \
  59. FN(reg, f1), v1,\
  60. FN(reg, f2), v2)
  61. #define REG_SET_3(reg, init_value, f1, v1, f2, v2, f3, v3) \
  62. REG_SET_N(reg, 3, init_value, \
  63. FN(reg, f1), v1,\
  64. FN(reg, f2), v2,\
  65. FN(reg, f3), v3)
  66. #define REG_SET_4(reg, init_value, f1, v1, f2, v2, f3, v3, f4, v4) \
  67. REG_SET_N(reg, 4, init_value, \
  68. FN(reg, f1), v1,\
  69. FN(reg, f2), v2,\
  70. FN(reg, f3), v3,\
  71. FN(reg, f4), v4)
  72. #define REG_SET_5(reg, init_value, f1, v1, f2, v2, f3, v3, f4, v4, \
  73. f5, v5) \
  74. REG_SET_N(reg, 5, init_value, \
  75. FN(reg, f1), v1,\
  76. FN(reg, f2), v2,\
  77. FN(reg, f3), v3,\
  78. FN(reg, f4), v4,\
  79. FN(reg, f5), v5)
  80. #define REG_SET_6(reg, init_value, f1, v1, f2, v2, f3, v3, f4, v4, \
  81. f5, v5, f6, v6) \
  82. REG_SET_N(reg, 6, init_value, \
  83. FN(reg, f1), v1,\
  84. FN(reg, f2), v2,\
  85. FN(reg, f3), v3,\
  86. FN(reg, f4), v4,\
  87. FN(reg, f5), v5,\
  88. FN(reg, f6), v6)
  89. #define REG_SET_7(reg, init_value, f1, v1, f2, v2, f3, v3, f4, v4, \
  90. f5, v5, f6, v6, f7, v7) \
  91. REG_SET_N(reg, 7, init_value, \
  92. FN(reg, f1), v1,\
  93. FN(reg, f2), v2,\
  94. FN(reg, f3), v3,\
  95. FN(reg, f4), v4,\
  96. FN(reg, f5), v5,\
  97. FN(reg, f6), v6,\
  98. FN(reg, f7), v7)
  99. #define REG_SET_8(reg, init_value, f1, v1, f2, v2, f3, v3, f4, v4, \
  100. f5, v5, f6, v6, f7, v7, f8, v8) \
  101. REG_SET_N(reg, 8, init_value, \
  102. FN(reg, f1), v1,\
  103. FN(reg, f2), v2,\
  104. FN(reg, f3), v3,\
  105. FN(reg, f4), v4,\
  106. FN(reg, f5), v5,\
  107. FN(reg, f6), v6,\
  108. FN(reg, f7), v7,\
  109. FN(reg, f8), v8)
  110. #define REG_SET_9(reg, init_value, f1, v1, f2, v2, f3, v3, f4, v4, f5, \
  111. v5, f6, v6, f7, v7, f8, v8, f9, v9) \
  112. REG_SET_N(reg, 9, init_value, \
  113. FN(reg, f1), v1,\
  114. FN(reg, f2), v2, \
  115. FN(reg, f3), v3, \
  116. FN(reg, f4), v4, \
  117. FN(reg, f5), v5, \
  118. FN(reg, f6), v6, \
  119. FN(reg, f7), v7, \
  120. FN(reg, f8), v8, \
  121. FN(reg, f9), v9)
  122. #define REG_SET_10(reg, init_value, f1, v1, f2, v2, f3, v3, f4, v4, f5, \
  123. v5, f6, v6, f7, v7, f8, v8, f9, v9, f10, v10) \
  124. REG_SET_N(reg, 10, init_value, \
  125. FN(reg, f1), v1,\
  126. FN(reg, f2), v2, \
  127. FN(reg, f3), v3, \
  128. FN(reg, f4), v4, \
  129. FN(reg, f5), v5, \
  130. FN(reg, f6), v6, \
  131. FN(reg, f7), v7, \
  132. FN(reg, f8), v8, \
  133. FN(reg, f9), v9, \
  134. FN(reg, f10), v10)
  135. /* macro to get register fields
  136. * read given register and fill in field value in output parameter */
  137. #define REG_GET(reg_name, field, val) \
  138. generic_reg_get(CTX, REG(reg_name), \
  139. FN(reg_name, field), val)
  140. #define REG_GET_2(reg_name, f1, v1, f2, v2) \
  141. generic_reg_get2(CTX, REG(reg_name), \
  142. FN(reg_name, f1), v1, \
  143. FN(reg_name, f2), v2)
  144. #define REG_GET_3(reg_name, f1, v1, f2, v2, f3, v3) \
  145. generic_reg_get3(CTX, REG(reg_name), \
  146. FN(reg_name, f1), v1, \
  147. FN(reg_name, f2), v2, \
  148. FN(reg_name, f3), v3)
  149. #define REG_GET_4(reg_name, f1, v1, f2, v2, f3, v3, f4, v4) \
  150. generic_reg_get4(CTX, REG(reg_name), \
  151. FN(reg_name, f1), v1, \
  152. FN(reg_name, f2), v2, \
  153. FN(reg_name, f3), v3, \
  154. FN(reg_name, f4), v4)
  155. #define REG_GET_5(reg_name, f1, v1, f2, v2, f3, v3, f4, v4, f5, v5) \
  156. generic_reg_get5(CTX, REG(reg_name), \
  157. FN(reg_name, f1), v1, \
  158. FN(reg_name, f2), v2, \
  159. FN(reg_name, f3), v3, \
  160. FN(reg_name, f4), v4, \
  161. FN(reg_name, f5), v5)
  162. #define REG_GET_6(reg_name, f1, v1, f2, v2, f3, v3, f4, v4, f5, v5, f6, v6) \
  163. generic_reg_get6(CTX, REG(reg_name), \
  164. FN(reg_name, f1), v1, \
  165. FN(reg_name, f2), v2, \
  166. FN(reg_name, f3), v3, \
  167. FN(reg_name, f4), v4, \
  168. FN(reg_name, f5), v5, \
  169. FN(reg_name, f6), v6)
  170. #define REG_GET_7(reg_name, f1, v1, f2, v2, f3, v3, f4, v4, f5, v5, f6, v6, f7, v7) \
  171. generic_reg_get7(CTX, REG(reg_name), \
  172. FN(reg_name, f1), v1, \
  173. FN(reg_name, f2), v2, \
  174. FN(reg_name, f3), v3, \
  175. FN(reg_name, f4), v4, \
  176. FN(reg_name, f5), v5, \
  177. FN(reg_name, f6), v6, \
  178. FN(reg_name, f7), v7)
  179. #define REG_GET_8(reg_name, f1, v1, f2, v2, f3, v3, f4, v4, f5, v5, f6, v6, f7, v7, f8, v8) \
  180. generic_reg_get8(CTX, REG(reg_name), \
  181. FN(reg_name, f1), v1, \
  182. FN(reg_name, f2), v2, \
  183. FN(reg_name, f3), v3, \
  184. FN(reg_name, f4), v4, \
  185. FN(reg_name, f5), v5, \
  186. FN(reg_name, f6), v6, \
  187. FN(reg_name, f7), v7, \
  188. FN(reg_name, f8), v8)
  189. /* macro to poll and wait for a register field to read back given value */
  190. #define REG_WAIT(reg_name, field, val, delay_between_poll_us, max_try) \
  191. generic_reg_wait(CTX, \
  192. REG(reg_name), FN(reg_name, field), val,\
  193. delay_between_poll_us, max_try, __func__, __LINE__)
  194. /* macro to update (read, modify, write) register fields
  195. */
  196. #define REG_UPDATE_N(reg_name, n, ...) \
  197. generic_reg_update_ex(CTX, \
  198. REG(reg_name), \
  199. REG_READ(reg_name), \
  200. n, __VA_ARGS__)
  201. #define REG_UPDATE(reg_name, field, val) \
  202. REG_UPDATE_N(reg_name, 1, \
  203. FN(reg_name, field), val)
  204. #define REG_UPDATE_2(reg, f1, v1, f2, v2) \
  205. REG_UPDATE_N(reg, 2,\
  206. FN(reg, f1), v1,\
  207. FN(reg, f2), v2)
  208. #define REG_UPDATE_3(reg, f1, v1, f2, v2, f3, v3) \
  209. REG_UPDATE_N(reg, 3, \
  210. FN(reg, f1), v1,\
  211. FN(reg, f2), v2, \
  212. FN(reg, f3), v3)
  213. #define REG_UPDATE_4(reg, f1, v1, f2, v2, f3, v3, f4, v4) \
  214. REG_UPDATE_N(reg, 4, \
  215. FN(reg, f1), v1,\
  216. FN(reg, f2), v2, \
  217. FN(reg, f3), v3, \
  218. FN(reg, f4), v4)
  219. #define REG_UPDATE_5(reg, f1, v1, f2, v2, f3, v3, f4, v4, f5, v5) \
  220. REG_UPDATE_N(reg, 5, \
  221. FN(reg, f1), v1,\
  222. FN(reg, f2), v2, \
  223. FN(reg, f3), v3, \
  224. FN(reg, f4), v4, \
  225. FN(reg, f5), v5)
  226. #define REG_UPDATE_6(reg, f1, v1, f2, v2, f3, v3, f4, v4, f5, v5, f6, v6) \
  227. REG_UPDATE_N(reg, 6, \
  228. FN(reg, f1), v1,\
  229. FN(reg, f2), v2, \
  230. FN(reg, f3), v3, \
  231. FN(reg, f4), v4, \
  232. FN(reg, f5), v5, \
  233. FN(reg, f6), v6)
  234. #define REG_UPDATE_7(reg, f1, v1, f2, v2, f3, v3, f4, v4, f5, v5, f6, v6, f7, v7) \
  235. REG_UPDATE_N(reg, 7, \
  236. FN(reg, f1), v1,\
  237. FN(reg, f2), v2, \
  238. FN(reg, f3), v3, \
  239. FN(reg, f4), v4, \
  240. FN(reg, f5), v5, \
  241. FN(reg, f6), v6, \
  242. FN(reg, f7), v7)
  243. #define REG_UPDATE_8(reg, f1, v1, f2, v2, f3, v3, f4, v4, f5, v5, f6, v6, f7, v7, f8, v8) \
  244. REG_UPDATE_N(reg, 8, \
  245. FN(reg, f1), v1,\
  246. FN(reg, f2), v2, \
  247. FN(reg, f3), v3, \
  248. FN(reg, f4), v4, \
  249. FN(reg, f5), v5, \
  250. FN(reg, f6), v6, \
  251. FN(reg, f7), v7, \
  252. FN(reg, f8), v8)
  253. #define REG_UPDATE_9(reg, f1, v1, f2, v2, f3, v3, f4, v4, f5, v5, f6, v6, f7, v7, f8, v8, f9, v9) \
  254. REG_UPDATE_N(reg, 9, \
  255. FN(reg, f1), v1,\
  256. FN(reg, f2), v2, \
  257. FN(reg, f3), v3, \
  258. FN(reg, f4), v4, \
  259. FN(reg, f5), v5, \
  260. FN(reg, f6), v6, \
  261. FN(reg, f7), v7, \
  262. FN(reg, f8), v8, \
  263. FN(reg, f9), v9)
  264. #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)\
  265. REG_UPDATE_N(reg, 10, \
  266. FN(reg, f1), v1,\
  267. FN(reg, f2), v2, \
  268. FN(reg, f3), v3, \
  269. FN(reg, f4), v4, \
  270. FN(reg, f5), v5, \
  271. FN(reg, f6), v6, \
  272. FN(reg, f7), v7, \
  273. FN(reg, f8), v8, \
  274. FN(reg, f9), v9, \
  275. FN(reg, f10), v10)
  276. #define REG_UPDATE_14(reg, f1, v1, f2, v2, f3, v3, f4, v4, f5, v5, f6, v6, f7, v7, f8, v8, f9, v9, f10,\
  277. v10, f11, v11, f12, v12, f13, v13, f14, v14)\
  278. REG_UPDATE_N(reg, 14, \
  279. FN(reg, f1), v1,\
  280. FN(reg, f2), v2, \
  281. FN(reg, f3), v3, \
  282. FN(reg, f4), v4, \
  283. FN(reg, f5), v5, \
  284. FN(reg, f6), v6, \
  285. FN(reg, f7), v7, \
  286. FN(reg, f8), v8, \
  287. FN(reg, f9), v9, \
  288. FN(reg, f10), v10, \
  289. FN(reg, f11), v11, \
  290. FN(reg, f12), v12, \
  291. FN(reg, f13), v13, \
  292. FN(reg, f14), v14)
  293. #define REG_UPDATE_19(reg, f1, v1, f2, v2, f3, v3, f4, v4, f5, v5, f6, v6, f7, v7, f8, v8, f9, v9, f10,\
  294. v10, f11, v11, f12, v12, f13, v13, f14, v14, f15, v15, f16, v16, f17, v17, f18, v18, f19, v19)\
  295. REG_UPDATE_N(reg, 19, \
  296. FN(reg, f1), v1,\
  297. FN(reg, f2), v2, \
  298. FN(reg, f3), v3, \
  299. FN(reg, f4), v4, \
  300. FN(reg, f5), v5, \
  301. FN(reg, f6), v6, \
  302. FN(reg, f7), v7, \
  303. FN(reg, f8), v8, \
  304. FN(reg, f9), v9, \
  305. FN(reg, f10), v10, \
  306. FN(reg, f11), v11, \
  307. FN(reg, f12), v12, \
  308. FN(reg, f13), v13, \
  309. FN(reg, f14), v14, \
  310. FN(reg, f15), v15, \
  311. FN(reg, f16), v16, \
  312. FN(reg, f17), v17, \
  313. FN(reg, f18), v18, \
  314. FN(reg, f19), v19)
  315. #define REG_UPDATE_20(reg, f1, v1, f2, v2, f3, v3, f4, v4, f5, v5, f6, v6, f7, v7, f8, v8, f9, v9, f10,\
  316. v10, f11, v11, f12, v12, f13, v13, f14, v14, f15, v15, f16, v16, f17, v17, f18, v18, f19, v19, f20, v20)\
  317. REG_UPDATE_N(reg, 20, \
  318. FN(reg, f1), v1,\
  319. FN(reg, f2), v2, \
  320. FN(reg, f3), v3, \
  321. FN(reg, f4), v4, \
  322. FN(reg, f5), v5, \
  323. FN(reg, f6), v6, \
  324. FN(reg, f7), v7, \
  325. FN(reg, f8), v8, \
  326. FN(reg, f9), v9, \
  327. FN(reg, f10), v10, \
  328. FN(reg, f11), v11, \
  329. FN(reg, f12), v12, \
  330. FN(reg, f13), v13, \
  331. FN(reg, f14), v14, \
  332. FN(reg, f15), v15, \
  333. FN(reg, f16), v16, \
  334. FN(reg, f17), v17, \
  335. FN(reg, f18), v18, \
  336. FN(reg, f19), v19, \
  337. FN(reg, f20), v20)
  338. /* macro to update a register field to specified values in given sequences.
  339. * useful when toggling bits
  340. */
  341. #define REG_UPDATE_SEQ(reg, field, value1, value2) \
  342. { uint32_t val = REG_UPDATE(reg, field, value1); \
  343. REG_SET(reg, val, field, value2); }
  344. /* macro to update fields in register 1 field at a time in given order */
  345. #define REG_UPDATE_1BY1_2(reg, f1, v1, f2, v2) \
  346. { uint32_t val = REG_UPDATE(reg, f1, v1); \
  347. REG_SET(reg, val, f2, v2); }
  348. #define REG_UPDATE_1BY1_3(reg, f1, v1, f2, v2, f3, v3) \
  349. { uint32_t val = REG_UPDATE(reg, f1, v1); \
  350. val = REG_SET(reg, val, f2, v2); \
  351. REG_SET(reg, val, f3, v3); }
  352. uint32_t generic_reg_get(const struct dc_context *ctx, uint32_t addr,
  353. uint8_t shift, uint32_t mask, uint32_t *field_value);
  354. uint32_t generic_reg_get2(const struct dc_context *ctx, uint32_t addr,
  355. uint8_t shift1, uint32_t mask1, uint32_t *field_value1,
  356. uint8_t shift2, uint32_t mask2, uint32_t *field_value2);
  357. uint32_t generic_reg_get3(const struct dc_context *ctx, uint32_t addr,
  358. uint8_t shift1, uint32_t mask1, uint32_t *field_value1,
  359. uint8_t shift2, uint32_t mask2, uint32_t *field_value2,
  360. uint8_t shift3, uint32_t mask3, uint32_t *field_value3);
  361. uint32_t generic_reg_get4(const struct dc_context *ctx, uint32_t addr,
  362. uint8_t shift1, uint32_t mask1, uint32_t *field_value1,
  363. uint8_t shift2, uint32_t mask2, uint32_t *field_value2,
  364. uint8_t shift3, uint32_t mask3, uint32_t *field_value3,
  365. uint8_t shift4, uint32_t mask4, uint32_t *field_value4);
  366. uint32_t generic_reg_get5(const struct dc_context *ctx, uint32_t addr,
  367. uint8_t shift1, uint32_t mask1, uint32_t *field_value1,
  368. uint8_t shift2, uint32_t mask2, uint32_t *field_value2,
  369. uint8_t shift3, uint32_t mask3, uint32_t *field_value3,
  370. uint8_t shift4, uint32_t mask4, uint32_t *field_value4,
  371. uint8_t shift5, uint32_t mask5, uint32_t *field_value5);
  372. uint32_t generic_reg_get6(const struct dc_context *ctx, uint32_t addr,
  373. uint8_t shift1, uint32_t mask1, uint32_t *field_value1,
  374. uint8_t shift2, uint32_t mask2, uint32_t *field_value2,
  375. uint8_t shift3, uint32_t mask3, uint32_t *field_value3,
  376. uint8_t shift4, uint32_t mask4, uint32_t *field_value4,
  377. uint8_t shift5, uint32_t mask5, uint32_t *field_value5,
  378. uint8_t shift6, uint32_t mask6, uint32_t *field_value6);
  379. uint32_t generic_reg_get7(const struct dc_context *ctx, uint32_t addr,
  380. uint8_t shift1, uint32_t mask1, uint32_t *field_value1,
  381. uint8_t shift2, uint32_t mask2, uint32_t *field_value2,
  382. uint8_t shift3, uint32_t mask3, uint32_t *field_value3,
  383. uint8_t shift4, uint32_t mask4, uint32_t *field_value4,
  384. uint8_t shift5, uint32_t mask5, uint32_t *field_value5,
  385. uint8_t shift6, uint32_t mask6, uint32_t *field_value6,
  386. uint8_t shift7, uint32_t mask7, uint32_t *field_value7);
  387. uint32_t generic_reg_get8(const struct dc_context *ctx, uint32_t addr,
  388. uint8_t shift1, uint32_t mask1, uint32_t *field_value1,
  389. uint8_t shift2, uint32_t mask2, uint32_t *field_value2,
  390. uint8_t shift3, uint32_t mask3, uint32_t *field_value3,
  391. uint8_t shift4, uint32_t mask4, uint32_t *field_value4,
  392. uint8_t shift5, uint32_t mask5, uint32_t *field_value5,
  393. uint8_t shift6, uint32_t mask6, uint32_t *field_value6,
  394. uint8_t shift7, uint32_t mask7, uint32_t *field_value7,
  395. uint8_t shift8, uint32_t mask8, uint32_t *field_value8);
  396. #endif /* DRIVERS_GPU_DRM_AMD_DC_DEV_DC_INC_REG_HELPER_H_ */