sde_dbg.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498
  1. /* SPDX-License-Identifier: GPL-2.0-only */
  2. /*
  3. * Copyright (c) 2016-2021, The Linux Foundation. All rights reserved.
  4. */
  5. #ifndef SDE_DBG_H_
  6. #define SDE_DBG_H_
  7. #include <stdarg.h>
  8. #include <linux/debugfs.h>
  9. #include <linux/list.h>
  10. /* select an uncommon hex value for the limiter */
  11. #define SDE_EVTLOG_DATA_LIMITER (0xC0DEBEEF)
  12. #define SDE_EVTLOG_FUNC_ENTRY 0x1111
  13. #define SDE_EVTLOG_FUNC_EXIT 0x2222
  14. #define SDE_EVTLOG_FUNC_CASE1 0x3333
  15. #define SDE_EVTLOG_FUNC_CASE2 0x4444
  16. #define SDE_EVTLOG_FUNC_CASE3 0x5555
  17. #define SDE_EVTLOG_FUNC_CASE4 0x6666
  18. #define SDE_EVTLOG_FUNC_CASE5 0x7777
  19. #define SDE_EVTLOG_FUNC_CASE6 0x8888
  20. #define SDE_EVTLOG_FUNC_CASE7 0x9999
  21. #define SDE_EVTLOG_FUNC_CASE8 0xaaaa
  22. #define SDE_EVTLOG_FUNC_CASE9 0xbbbb
  23. #define SDE_EVTLOG_FUNC_CASE10 0xcccc
  24. #define SDE_EVTLOG_PANIC 0xdead
  25. #define SDE_EVTLOG_FATAL 0xbad
  26. #define SDE_EVTLOG_ERROR 0xebad
  27. /* flags to enable the HW block dumping */
  28. #define SDE_DBG_SDE BIT(0)
  29. #define SDE_DBG_RSC BIT(1)
  30. #define SDE_DBG_SID BIT(2)
  31. #define SDE_DBG_LUTDMA BIT(3)
  32. #define SDE_DBG_VBIF_RT BIT(4)
  33. #define SDE_DBG_DSI BIT(5)
  34. /* flags to enable the HW block debugbus dumping */
  35. #define SDE_DBG_SDE_DBGBUS BIT(12)
  36. #define SDE_DBG_RSC_DBGBUS BIT(13)
  37. #define SDE_DBG_LUTDMA_DBGBUS BIT(14)
  38. #define SDE_DBG_VBIF_RT_DBGBUS BIT(15)
  39. #define SDE_DBG_DSI_DBGBUS BIT(16)
  40. /* mask to enable all the built-in register blocks */
  41. #define SDE_DBG_BUILT_IN_ALL 0xffffff
  42. /* keeping DP separate as DP specific clks needs to be enabled for accessing */
  43. #define SDE_DBG_DP BIT(24)
  44. #define SDE_DBG_DP_DBGBUS BIT(25)
  45. #define SDE_DBG_DUMP_DATA_LIMITER (NULL)
  46. enum sde_dbg_evtlog_flag {
  47. SDE_EVTLOG_CRITICAL = BIT(0),
  48. SDE_EVTLOG_IRQ = BIT(1),
  49. SDE_EVTLOG_VERBOSE = BIT(2),
  50. SDE_EVTLOG_EXTERNAL = BIT(3),
  51. SDE_EVTLOG_ALWAYS = -1
  52. };
  53. enum sde_dbg_dump_flag {
  54. SDE_DBG_DUMP_IN_LOG = BIT(0),
  55. SDE_DBG_DUMP_IN_MEM = BIT(1),
  56. SDE_DBG_DUMP_IN_LOG_LIMITED = BIT(2),
  57. };
  58. enum sde_dbg_dump_context {
  59. SDE_DBG_DUMP_PROC_CTX,
  60. SDE_DBG_DUMP_IRQ_CTX,
  61. SDE_DBG_DUMP_CLK_ENABLED_CTX,
  62. };
  63. /* default dump mode for eventlogs, reg-dump & debugbus-dump */
  64. #define SDE_DBG_DEFAULT_DUMP_MODE SDE_DBG_DUMP_IN_MEM
  65. /*
  66. * Define blocks for register write logging.
  67. */
  68. #define SDE_REG_LOG_DEFAULT 0
  69. #define SDE_REG_LOG_NONE 1
  70. #define SDE_REG_LOG_CDM 2
  71. #define SDE_REG_LOG_DSPP 3
  72. #define SDE_REG_LOG_INTF 4
  73. #define SDE_REG_LOG_LM 5
  74. #define SDE_REG_LOG_CTL 6
  75. #define SDE_REG_LOG_PINGPONG 7
  76. #define SDE_REG_LOG_SSPP 8
  77. #define SDE_REG_LOG_WB 9
  78. #define SDE_REG_LOG_TOP 10
  79. #define SDE_REG_LOG_VBIF 11
  80. #define SDE_REG_LOG_DSC 12
  81. #define SDE_REG_LOG_ROT 13
  82. #define SDE_REG_LOG_DS 14
  83. #define SDE_REG_LOG_REGDMA 15
  84. #define SDE_REG_LOG_UIDLE 16
  85. #define SDE_REG_LOG_SID 16
  86. #define SDE_REG_LOG_QDSS 17
  87. /*
  88. * 0-32 are reserved for sde_reg_write due to log masks
  89. * Additional blocks are assigned from 33 to avoid conflict
  90. */
  91. #define SDE_REG_LOG_RSCC 33
  92. #define SDE_EVTLOG_DEFAULT_ENABLE (SDE_EVTLOG_CRITICAL | SDE_EVTLOG_IRQ | SDE_EVTLOG_EXTERNAL)
  93. /*
  94. * evtlog will print this number of entries when it is called through
  95. * sysfs node or panic. This prevents kernel log from evtlog message
  96. * flood.
  97. */
  98. #define SDE_EVTLOG_PRINT_ENTRY 256
  99. /*
  100. * evtlog keeps this number of entries in memory for debug purpose. This
  101. * number must be greater than print entry to prevent out of bound evtlog
  102. * entry array access.
  103. */
  104. #define SDE_EVTLOG_ENTRY (SDE_EVTLOG_PRINT_ENTRY * 32)
  105. #define SDE_EVTLOG_MAX_DATA 15
  106. #define SDE_EVTLOG_BUF_MAX 512
  107. #define SDE_EVTLOG_BUF_ALIGN 32
  108. struct sde_dbg_power_ctrl {
  109. void *handle;
  110. void *client;
  111. int (*enable_fn)(void *handle, void *client, bool enable);
  112. };
  113. struct sde_dbg_evtlog_log {
  114. s64 time;
  115. const char *name;
  116. int line;
  117. u32 data[SDE_EVTLOG_MAX_DATA];
  118. u32 data_cnt;
  119. int pid;
  120. u8 cpu;
  121. };
  122. /**
  123. * @last_dump: Index of last entry to be output during evtlog dumps
  124. * @filter_list: Linked list of currently active filter strings
  125. */
  126. struct sde_dbg_evtlog {
  127. struct sde_dbg_evtlog_log logs[SDE_EVTLOG_ENTRY];
  128. u32 first;
  129. u32 last;
  130. u32 last_dump;
  131. u32 curr;
  132. u32 next;
  133. u32 enable;
  134. u32 dump_mode;
  135. spinlock_t spin_lock;
  136. struct list_head filter_list;
  137. };
  138. extern struct sde_dbg_evtlog *sde_dbg_base_evtlog;
  139. /*
  140. * reglog keeps this number of entries in memory for debug purpose. This
  141. * number must be greater than number of possible writes in at least one
  142. * single commit.
  143. */
  144. #define SDE_REGLOG_ENTRY 1024
  145. struct sde_dbg_reglog_log {
  146. s64 time;
  147. u32 pid;
  148. u32 addr;
  149. u32 val;
  150. u8 blk_id;
  151. };
  152. /**
  153. * @last_dump: Index of last entry to be output during reglog dumps
  154. * @filter_list: Linked list of currently active filter strings
  155. */
  156. struct sde_dbg_reglog {
  157. struct sde_dbg_reglog_log logs[SDE_REGLOG_ENTRY];
  158. u32 first;
  159. u32 last;
  160. u32 last_dump;
  161. u32 curr;
  162. u32 next;
  163. u32 enable;
  164. u32 enable_mask;
  165. spinlock_t spin_lock;
  166. };
  167. extern struct sde_dbg_reglog *sde_dbg_base_reglog;
  168. /**
  169. * SDE_REG_LOG - Write register write to the register log
  170. */
  171. #define SDE_REG_LOG(blk_id, val, addr) sde_reglog_log(blk_id, val, addr)
  172. /**
  173. * SDE_EVT32 - Write a list of 32bit values to the event log, default area
  174. * ... - variable arguments
  175. */
  176. #define SDE_EVT32(...) sde_evtlog_log(sde_dbg_base_evtlog, __func__, \
  177. __LINE__, SDE_EVTLOG_ALWAYS, ##__VA_ARGS__, \
  178. SDE_EVTLOG_DATA_LIMITER)
  179. /**
  180. * SDE_EVT32_VERBOSE - Write a list of 32bit values for verbose event logging
  181. * ... - variable arguments
  182. */
  183. #define SDE_EVT32_VERBOSE(...) sde_evtlog_log(sde_dbg_base_evtlog, __func__, \
  184. __LINE__, SDE_EVTLOG_VERBOSE, ##__VA_ARGS__, \
  185. SDE_EVTLOG_DATA_LIMITER)
  186. /**
  187. * SDE_EVT32_IRQ - Write a list of 32bit values to the event log, IRQ area
  188. * ... - variable arguments
  189. */
  190. #define SDE_EVT32_IRQ(...) sde_evtlog_log(sde_dbg_base_evtlog, __func__, \
  191. __LINE__, SDE_EVTLOG_IRQ, ##__VA_ARGS__, \
  192. SDE_EVTLOG_DATA_LIMITER)
  193. /**
  194. * SDE_EVT32_EXTERNAL - Write a list of 32bit values for external display events
  195. * ... - variable arguments
  196. */
  197. #define SDE_EVT32_EXTERNAL(...) sde_evtlog_log(sde_dbg_base_evtlog, __func__, \
  198. __LINE__, SDE_EVTLOG_EXTERNAL, ##__VA_ARGS__, \
  199. SDE_EVTLOG_DATA_LIMITER)
  200. /**
  201. * SDE_DBG_DUMP - trigger dumping of all sde_dbg facilities
  202. * @dump_blk_mask: mask of all the hw blk-ids that has to be dumped
  203. * @va_args: list of named register dump ranges and regions to dump, as
  204. * registered previously through sde_dbg_reg_register_base and
  205. * sde_dbg_reg_register_dump_range.
  206. * Including the special name "panic" will trigger a panic after
  207. * the dumping work has completed.
  208. */
  209. #define SDE_DBG_DUMP(dump_blk_mask, ...) sde_dbg_dump(SDE_DBG_DUMP_PROC_CTX, __func__, \
  210. dump_blk_mask, ##__VA_ARGS__, SDE_DBG_DUMP_DATA_LIMITER)
  211. /**
  212. * SDE_DBG_DUMP_WQ - trigger dumping of all sde_dbg facilities, queuing the work
  213. * @dump_blk_mask: mask of all the hw blk-ids that has to be dumped
  214. * @va_args: list of named register dump ranges and regions to dump, as
  215. * registered previously through sde_dbg_reg_register_base and
  216. * sde_dbg_reg_register_dump_range.
  217. * Including the special name "panic" will trigger a panic after
  218. * the dumping work has completed.
  219. */
  220. #define SDE_DBG_DUMP_WQ(dump_blk_mask, ...) sde_dbg_dump(SDE_DBG_DUMP_IRQ_CTX, __func__, \
  221. dump_blk_mask, ##__VA_ARGS__, SDE_DBG_DUMP_DATA_LIMITER)
  222. /**
  223. * SDE_DBG_DUMP_CLK_EN - trigger dumping of all sde_dbg facilities, without clk
  224. * @dump_blk_mask: mask of all the hw blk-ids that has to be dumped
  225. * @va_args: list of named register dump ranges and regions to dump, as
  226. * registered previously through sde_dbg_reg_register_base and
  227. * sde_dbg_reg_register_dump_range.
  228. * Including the special name "panic" will trigger a panic after
  229. * the dumping work has completed.
  230. */
  231. #define SDE_DBG_DUMP_CLK_EN(dump_blk_mask, ...) sde_dbg_dump(SDE_DBG_DUMP_CLK_ENABLED_CTX, \
  232. __func__, dump_blk_mask, ##__VA_ARGS__, SDE_DBG_DUMP_DATA_LIMITER)
  233. /**
  234. * SDE_DBG_EVT_CTRL - trigger a different driver events
  235. * event: event that trigger different behavior in the driver
  236. */
  237. #define SDE_DBG_CTRL(...) sde_dbg_ctrl(__func__, ##__VA_ARGS__, \
  238. SDE_DBG_DUMP_DATA_LIMITER)
  239. /**
  240. * sde_evtlog_init - allocate a new event log object
  241. * Returns: evtlog or -ERROR
  242. */
  243. struct sde_dbg_evtlog *sde_evtlog_init(void);
  244. /**
  245. * sde_reglog_init - allocate a new reg log object
  246. * Returns: reglog or -ERROR
  247. */
  248. struct sde_dbg_reglog *sde_reglog_init(void);
  249. /**
  250. * sde_evtlog_destroy - destroy previously allocated event log
  251. * @evtlog: pointer to evtlog
  252. * Returns: none
  253. */
  254. void sde_evtlog_destroy(struct sde_dbg_evtlog *evtlog);
  255. /**
  256. * sde_reglog_destroy - destroy previously allocated reg log
  257. * @reglog: pointer to reglog
  258. * Returns: none
  259. */
  260. void sde_reglog_destroy(struct sde_dbg_reglog *reglog);
  261. /**
  262. * sde_evtlog_log - log an entry into the event log.
  263. * log collection may be enabled/disabled entirely via debugfs
  264. * log area collection may be filtered by user provided flags via debugfs.
  265. * @evtlog: pointer to evtlog
  266. * @name: function name of call site
  267. * @line: line number of call site
  268. * @flag: log area filter flag checked against user's debugfs request
  269. * Returns: none
  270. */
  271. void sde_evtlog_log(struct sde_dbg_evtlog *evtlog, const char *name, int line,
  272. int flag, ...);
  273. /**
  274. * sde_reglog_log - log an entry into the reg log.
  275. * log collection may be enabled/disabled entirely via debugfs
  276. * log area collection may be filtered by user provided flags via debugfs.
  277. * @reglog: pointer to evtlog
  278. * Returns: none
  279. */
  280. void sde_reglog_log(u8 blk_id, u32 val, u32 addr);
  281. /**
  282. * sde_evtlog_dump_all - print all entries in event log to kernel log
  283. * @evtlog: pointer to evtlog
  284. * Returns: none
  285. */
  286. void sde_evtlog_dump_all(struct sde_dbg_evtlog *evtlog);
  287. /**
  288. * sde_evtlog_is_enabled - check whether log collection is enabled for given
  289. * event log and log area flag
  290. * @evtlog: pointer to evtlog
  291. * @flag: log area filter flag
  292. * Returns: none
  293. */
  294. bool sde_evtlog_is_enabled(struct sde_dbg_evtlog *evtlog, u32 flag);
  295. /**
  296. * sde_evtlog_dump_to_buffer - print content of event log to the given buffer
  297. * @evtlog: pointer to evtlog
  298. * @evtlog_buf: target buffer to print into
  299. * @evtlog_buf_size: size of target buffer
  300. * @update_last_entry: whether or not to stop at most recent entry
  301. * @full_dump: whether to dump full or to limit print entries
  302. * Returns: number of bytes written to buffer
  303. */
  304. ssize_t sde_evtlog_dump_to_buffer(struct sde_dbg_evtlog *evtlog,
  305. char *evtlog_buf, ssize_t evtlog_buf_size,
  306. bool update_last_entry, bool full_dump);
  307. /**
  308. * sde_dbg_init_dbg_buses - initialize debug bus dumping support for the chipset
  309. * @hwversion: Chipset revision
  310. */
  311. void sde_dbg_init_dbg_buses(u32 hwversion);
  312. /**
  313. * sde_dbg_init - initialize global sde debug facilities: evtlog, regdump
  314. * @dev: device handle
  315. * Returns: 0 or -ERROR
  316. */
  317. int sde_dbg_init(struct device *dev);
  318. /**
  319. * sde_dbg_debugfs_register - register entries at the given debugfs dir
  320. * @dev: pointer to device
  321. * Returns: 0 or -ERROR
  322. */
  323. int sde_dbg_debugfs_register(struct device *dev);
  324. /**
  325. * sde_dbg_destroy - destroy the global sde debug facilities
  326. * Returns: none
  327. */
  328. void sde_dbg_destroy(void);
  329. /**
  330. * sde_dbg_dump - trigger dumping of all sde_dbg facilities
  331. * @queue_work: whether to queue the dumping work to the work_struct
  332. * @name: string indicating origin of dump
  333. * @dump_blk_mask: mask of all the hw blk-ids that has to be dumped
  334. * @va_args: list of named register dump ranges and regions to dump, as
  335. * registered previously through sde_dbg_reg_register_base and
  336. * sde_dbg_reg_register_dump_range.
  337. * Including the special name "panic" will trigger a panic after
  338. * the dumping work has completed.
  339. * Returns: none
  340. */
  341. void sde_dbg_dump(enum sde_dbg_dump_context mode, const char *name, u64 dump_blk_mask, ...);
  342. /**
  343. * sde_dbg_ctrl - trigger specific actions for the driver with debugging
  344. * purposes. Those actions need to be enabled by the debugfs entry
  345. * so the driver executes those actions in the corresponding calls.
  346. * @va_args: list of actions to trigger
  347. * Returns: none
  348. */
  349. void sde_dbg_ctrl(const char *name, ...);
  350. /**
  351. * sde_dbg_reg_register_base - register a hw register address section for later
  352. * dumping. call this before calling sde_dbg_reg_register_dump_range
  353. * to be able to specify sub-ranges within the base hw range.
  354. * @name: name of base region
  355. * @base: base pointer of region
  356. * @max_offset: length of region
  357. * @blk_id: hw block id
  358. * Returns: 0 or -ERROR
  359. */
  360. int sde_dbg_reg_register_base(const char *name, void __iomem *base,
  361. size_t max_offset, u64 blk_id);
  362. /**
  363. * sde_dbg_reg_register_cb - register a hw register callback for later
  364. * dumping.
  365. * @name: name of base region
  366. * @cb: callback of external region
  367. * @cb_ptr: private pointer of external region
  368. * Returns: 0 or -ERROR
  369. */
  370. int sde_dbg_reg_register_cb(const char *name, void (*cb)(void *), void *ptr);
  371. /**
  372. * sde_dbg_reg_unregister_cb - register a hw unregister callback for later
  373. * dumping.
  374. * @name: name of base region
  375. * @cb: callback of external region
  376. * @cb_ptr: private pointer of external region
  377. * Returns: None
  378. */
  379. void sde_dbg_reg_unregister_cb(const char *name, void (*cb)(void *), void *ptr);
  380. /**
  381. * sde_dbg_reg_register_dump_range - register a hw register sub-region for
  382. * later register dumping associated with base specified by
  383. * sde_dbg_reg_register_base
  384. * @base_name: name of base region
  385. * @range_name: name of sub-range within base region
  386. * @offset_start: sub-range's start offset from base's base pointer
  387. * @offset_end: sub-range's end offset from base's base pointer
  388. * @xin_id: xin id
  389. * Returns: none
  390. */
  391. void sde_dbg_reg_register_dump_range(const char *base_name,
  392. const char *range_name, u32 offset_start, u32 offset_end,
  393. uint32_t xin_id);
  394. /**
  395. * sde_dbg_dsi_ctrl_register - register a dsi ctrl for debugbus dumping
  396. * @base: iomem base address for dsi controller
  397. * @name: name of the dsi controller
  398. * Returns: 0 or -ERROR
  399. */
  400. int sde_dbg_dsi_ctrl_register(void __iomem *base, const char *name);
  401. /**
  402. * sde_dbg_set_sde_top_offset - set the target specific offset from mdss base
  403. * address of the top registers. Used for accessing debug bus controls.
  404. * @blk_off: offset from mdss base of the top block
  405. */
  406. void sde_dbg_set_sde_top_offset(u32 blk_off);
  407. /**
  408. * sde_dbg_set_hw_ownership_status - set the VM HW ownership status
  409. * @enable: flag to control HW ownership status
  410. */
  411. void sde_dbg_set_hw_ownership_status(bool enable);
  412. /**
  413. * sde_evtlog_set_filter - update evtlog filtering
  414. * @evtlog: pointer to evtlog
  415. * @filter: pointer to optional function name filter, set to NULL to disable
  416. */
  417. void sde_evtlog_set_filter(struct sde_dbg_evtlog *evtlog, char *filter);
  418. /**
  419. * sde_evtlog_get_filter - query configured evtlog filters
  420. * @evtlog: pointer to evtlog
  421. * @index: filter index to retrieve
  422. * @buf: pointer to output filter buffer
  423. * @bufsz: size of output filter buffer
  424. * Returns: zero if a filter string was returned
  425. */
  426. int sde_evtlog_get_filter(struct sde_dbg_evtlog *evtlog, int index,
  427. char *buf, size_t bufsz);
  428. #ifndef CONFIG_DRM_SDE_RSC
  429. static inline void sde_rsc_debug_dump(u32 mux_sel)
  430. {
  431. }
  432. #else
  433. /**
  434. * sde_rsc_debug_dump - sde rsc debug dump status
  435. * @mux_sel:» select mux on rsc debug bus
  436. */
  437. void sde_rsc_debug_dump(u32 mux_sel);
  438. #endif
  439. #endif /* SDE_DBG_H_ */