sde_dbg.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462
  1. /* SPDX-License-Identifier: GPL-2.0-only */
  2. /*
  3. * Copyright (c) 2016-2019, 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. #define SDE_DBG_DUMP_DATA_LIMITER (NULL)
  28. enum sde_dbg_evtlog_flag {
  29. SDE_EVTLOG_CRITICAL = BIT(0),
  30. SDE_EVTLOG_IRQ = BIT(1),
  31. SDE_EVTLOG_VERBOSE = BIT(2),
  32. SDE_EVTLOG_ALWAYS = -1
  33. };
  34. enum sde_dbg_dump_flag {
  35. SDE_DBG_DUMP_IN_LOG = BIT(0),
  36. SDE_DBG_DUMP_IN_MEM = BIT(1),
  37. };
  38. enum sde_dbg_dump_context {
  39. SDE_DBG_DUMP_PROC_CTX,
  40. SDE_DBG_DUMP_IRQ_CTX,
  41. SDE_DBG_DUMP_CLK_ENABLED_CTX,
  42. };
  43. #define SDE_EVTLOG_DEFAULT_ENABLE (SDE_EVTLOG_CRITICAL | SDE_EVTLOG_IRQ)
  44. /*
  45. * evtlog will print this number of entries when it is called through
  46. * sysfs node or panic. This prevents kernel log from evtlog message
  47. * flood.
  48. */
  49. #define SDE_EVTLOG_PRINT_ENTRY 256
  50. /*
  51. * evtlog keeps this number of entries in memory for debug purpose. This
  52. * number must be greater than print entry to prevent out of bound evtlog
  53. * entry array access.
  54. */
  55. #define SDE_EVTLOG_ENTRY (SDE_EVTLOG_PRINT_ENTRY * 8)
  56. #define SDE_EVTLOG_MAX_DATA 15
  57. #define SDE_EVTLOG_BUF_MAX 512
  58. #define SDE_EVTLOG_BUF_ALIGN 32
  59. struct sde_dbg_power_ctrl {
  60. void *handle;
  61. void *client;
  62. int (*enable_fn)(void *handle, void *client, bool enable);
  63. };
  64. struct sde_dbg_evtlog_log {
  65. s64 time;
  66. const char *name;
  67. int line;
  68. u32 data[SDE_EVTLOG_MAX_DATA];
  69. u32 data_cnt;
  70. int pid;
  71. u8 cpu;
  72. };
  73. /**
  74. * @last_dump: Index of last entry to be output during evtlog dumps
  75. * @filter_list: Linked list of currently active filter strings
  76. */
  77. struct sde_dbg_evtlog {
  78. struct sde_dbg_evtlog_log logs[SDE_EVTLOG_ENTRY];
  79. u32 first;
  80. u32 last;
  81. u32 last_dump;
  82. u32 curr;
  83. u32 next;
  84. u32 enable;
  85. spinlock_t spin_lock;
  86. struct list_head filter_list;
  87. };
  88. extern struct sde_dbg_evtlog *sde_dbg_base_evtlog;
  89. /**
  90. * SDE_EVT32 - Write a list of 32bit values to the event log, default area
  91. * ... - variable arguments
  92. */
  93. #define SDE_EVT32(...) sde_evtlog_log(sde_dbg_base_evtlog, __func__, \
  94. __LINE__, SDE_EVTLOG_ALWAYS, ##__VA_ARGS__, \
  95. SDE_EVTLOG_DATA_LIMITER)
  96. /**
  97. * SDE_EVT32_VERBOSE - Write a list of 32bit values for verbose event logging
  98. * ... - variable arguments
  99. */
  100. #define SDE_EVT32_VERBOSE(...) sde_evtlog_log(sde_dbg_base_evtlog, __func__, \
  101. __LINE__, SDE_EVTLOG_VERBOSE, ##__VA_ARGS__, \
  102. SDE_EVTLOG_DATA_LIMITER)
  103. /**
  104. * SDE_EVT32_IRQ - Write a list of 32bit values to the event log, IRQ area
  105. * ... - variable arguments
  106. */
  107. #define SDE_EVT32_IRQ(...) sde_evtlog_log(sde_dbg_base_evtlog, __func__, \
  108. __LINE__, SDE_EVTLOG_IRQ, ##__VA_ARGS__, \
  109. SDE_EVTLOG_DATA_LIMITER)
  110. /**
  111. * SDE_DBG_DUMP - trigger dumping of all sde_dbg facilities
  112. * @va_args: list of named register dump ranges and regions to dump, as
  113. * registered previously through sde_dbg_reg_register_base and
  114. * sde_dbg_reg_register_dump_range.
  115. * Including the special name "panic" will trigger a panic after
  116. * the dumping work has completed.
  117. */
  118. #define SDE_DBG_DUMP(...) sde_dbg_dump(SDE_DBG_DUMP_PROC_CTX, __func__, \
  119. ##__VA_ARGS__, SDE_DBG_DUMP_DATA_LIMITER)
  120. /**
  121. * SDE_DBG_DUMP_WQ - trigger dumping of all sde_dbg facilities, queuing the work
  122. * @va_args: list of named register dump ranges and regions to dump, as
  123. * registered previously through sde_dbg_reg_register_base and
  124. * sde_dbg_reg_register_dump_range.
  125. * Including the special name "panic" will trigger a panic after
  126. * the dumping work has completed.
  127. */
  128. #define SDE_DBG_DUMP_WQ(...) sde_dbg_dump(SDE_DBG_DUMP_IRQ_CTX, __func__, \
  129. ##__VA_ARGS__, SDE_DBG_DUMP_DATA_LIMITER)
  130. /**
  131. * SDE_DBG_DUMP_CLK_EN - trigger dumping of all sde_dbg facilities, without clk
  132. * @va_args: list of named register dump ranges and regions to dump, as
  133. * registered previously through sde_dbg_reg_register_base and
  134. * sde_dbg_reg_register_dump_range.
  135. * Including the special name "panic" will trigger a panic after
  136. * the dumping work has completed.
  137. */
  138. #define SDE_DBG_DUMP_CLK_EN(...) sde_dbg_dump(SDE_DBG_DUMP_CLK_ENABLED_CTX, \
  139. __func__, ##__VA_ARGS__, SDE_DBG_DUMP_DATA_LIMITER)
  140. /**
  141. * SDE_DBG_EVT_CTRL - trigger a different driver events
  142. * event: event that trigger different behavior in the driver
  143. */
  144. #define SDE_DBG_CTRL(...) sde_dbg_ctrl(__func__, ##__VA_ARGS__, \
  145. SDE_DBG_DUMP_DATA_LIMITER)
  146. #if defined(CONFIG_DEBUG_FS)
  147. /**
  148. * sde_evtlog_init - allocate a new event log object
  149. * Returns: evtlog or -ERROR
  150. */
  151. struct sde_dbg_evtlog *sde_evtlog_init(void);
  152. /**
  153. * sde_evtlog_destroy - destroy previously allocated event log
  154. * @evtlog: pointer to evtlog
  155. * Returns: none
  156. */
  157. void sde_evtlog_destroy(struct sde_dbg_evtlog *evtlog);
  158. /**
  159. * sde_evtlog_log - log an entry into the event log.
  160. * log collection may be enabled/disabled entirely via debugfs
  161. * log area collection may be filtered by user provided flags via debugfs.
  162. * @evtlog: pointer to evtlog
  163. * @name: function name of call site
  164. * @line: line number of call site
  165. * @flag: log area filter flag checked against user's debugfs request
  166. * Returns: none
  167. */
  168. void sde_evtlog_log(struct sde_dbg_evtlog *evtlog, const char *name, int line,
  169. int flag, ...);
  170. /**
  171. * sde_evtlog_dump_all - print all entries in event log to kernel log
  172. * @evtlog: pointer to evtlog
  173. * Returns: none
  174. */
  175. void sde_evtlog_dump_all(struct sde_dbg_evtlog *evtlog);
  176. /**
  177. * sde_evtlog_is_enabled - check whether log collection is enabled for given
  178. * event log and log area flag
  179. * @evtlog: pointer to evtlog
  180. * @flag: log area filter flag
  181. * Returns: none
  182. */
  183. bool sde_evtlog_is_enabled(struct sde_dbg_evtlog *evtlog, u32 flag);
  184. /**
  185. * sde_evtlog_dump_to_buffer - print content of event log to the given buffer
  186. * @evtlog: pointer to evtlog
  187. * @evtlog_buf: target buffer to print into
  188. * @evtlog_buf_size: size of target buffer
  189. * @update_last_entry: whether or not to stop at most recent entry
  190. * @full_dump: whether to dump full or to limit print entries
  191. * Returns: number of bytes written to buffer
  192. */
  193. ssize_t sde_evtlog_dump_to_buffer(struct sde_dbg_evtlog *evtlog,
  194. char *evtlog_buf, ssize_t evtlog_buf_size,
  195. bool update_last_entry, bool full_dump);
  196. /**
  197. * sde_dbg_init_dbg_buses - initialize debug bus dumping support for the chipset
  198. * @hwversion: Chipset revision
  199. */
  200. void sde_dbg_init_dbg_buses(u32 hwversion);
  201. /**
  202. * sde_dbg_init - initialize global sde debug facilities: evtlog, regdump
  203. * @dev: device handle
  204. * Returns: 0 or -ERROR
  205. */
  206. int sde_dbg_init(struct device *dev);
  207. /**
  208. * sde_dbg_debugfs_register - register entries at the given debugfs dir
  209. * @debugfs_root: debugfs root in which to create sde debug entries
  210. * Returns: 0 or -ERROR
  211. */
  212. int sde_dbg_debugfs_register(struct dentry *debugfs_root);
  213. /**
  214. * sde_dbg_destroy - destroy the global sde debug facilities
  215. * Returns: none
  216. */
  217. void sde_dbg_destroy(void);
  218. /**
  219. * sde_dbg_dump - trigger dumping of all sde_dbg facilities
  220. * @queue_work: whether to queue the dumping work to the work_struct
  221. * @name: string indicating origin of dump
  222. * @va_args: list of named register dump ranges and regions to dump, as
  223. * registered previously through sde_dbg_reg_register_base and
  224. * sde_dbg_reg_register_dump_range.
  225. * Including the special name "panic" will trigger a panic after
  226. * the dumping work has completed.
  227. * Returns: none
  228. */
  229. void sde_dbg_dump(enum sde_dbg_dump_context mode, const char *name, ...);
  230. /**
  231. * sde_dbg_ctrl - trigger specific actions for the driver with debugging
  232. * purposes. Those actions need to be enabled by the debugfs entry
  233. * so the driver executes those actions in the corresponding calls.
  234. * @va_args: list of actions to trigger
  235. * Returns: none
  236. */
  237. void sde_dbg_ctrl(const char *name, ...);
  238. /**
  239. * sde_dbg_reg_register_base - register a hw register address section for later
  240. * dumping. call this before calling sde_dbg_reg_register_dump_range
  241. * to be able to specify sub-ranges within the base hw range.
  242. * @name: name of base region
  243. * @base: base pointer of region
  244. * @max_offset: length of region
  245. * Returns: 0 or -ERROR
  246. */
  247. int sde_dbg_reg_register_base(const char *name, void __iomem *base,
  248. size_t max_offset);
  249. /**
  250. * sde_dbg_reg_register_cb - register a hw register callback for later
  251. * dumping.
  252. * @name: name of base region
  253. * @cb: callback of external region
  254. * @cb_ptr: private pointer of external region
  255. * Returns: 0 or -ERROR
  256. */
  257. int sde_dbg_reg_register_cb(const char *name, void (*cb)(void *), void *ptr);
  258. /**
  259. * sde_dbg_reg_unregister_cb - register a hw unregister callback for later
  260. * dumping.
  261. * @name: name of base region
  262. * @cb: callback of external region
  263. * @cb_ptr: private pointer of external region
  264. * Returns: None
  265. */
  266. void sde_dbg_reg_unregister_cb(const char *name, void (*cb)(void *), void *ptr);
  267. /**
  268. * sde_dbg_reg_register_dump_range - register a hw register sub-region for
  269. * later register dumping associated with base specified by
  270. * sde_dbg_reg_register_base
  271. * @base_name: name of base region
  272. * @range_name: name of sub-range within base region
  273. * @offset_start: sub-range's start offset from base's base pointer
  274. * @offset_end: sub-range's end offset from base's base pointer
  275. * @xin_id: xin id
  276. * Returns: none
  277. */
  278. void sde_dbg_reg_register_dump_range(const char *base_name,
  279. const char *range_name, u32 offset_start, u32 offset_end,
  280. uint32_t xin_id);
  281. /**
  282. * sde_dbg_set_sde_top_offset - set the target specific offset from mdss base
  283. * address of the top registers. Used for accessing debug bus controls.
  284. * @blk_off: offset from mdss base of the top block
  285. */
  286. void sde_dbg_set_sde_top_offset(u32 blk_off);
  287. /**
  288. * sde_evtlog_set_filter - update evtlog filtering
  289. * @evtlog: pointer to evtlog
  290. * @filter: pointer to optional function name filter, set to NULL to disable
  291. */
  292. void sde_evtlog_set_filter(struct sde_dbg_evtlog *evtlog, char *filter);
  293. /**
  294. * sde_evtlog_get_filter - query configured evtlog filters
  295. * @evtlog: pointer to evtlog
  296. * @index: filter index to retrieve
  297. * @buf: pointer to output filter buffer
  298. * @bufsz: size of output filter buffer
  299. * Returns: zero if a filter string was returned
  300. */
  301. int sde_evtlog_get_filter(struct sde_dbg_evtlog *evtlog, int index,
  302. char *buf, size_t bufsz);
  303. #ifndef CONFIG_DRM_SDE_RSC
  304. static inline void sde_rsc_debug_dump(u32 mux_sel)
  305. {
  306. }
  307. #else
  308. /**
  309. * sde_rsc_debug_dump - sde rsc debug dump status
  310. * @mux_sel:» select mux on rsc debug bus
  311. */
  312. void sde_rsc_debug_dump(u32 mux_sel);
  313. #endif
  314. /**
  315. * dsi_ctrl_debug_dump - dump dsi debug dump status
  316. * @entries: array of debug bus control values
  317. * @size: size of the debug bus control array
  318. */
  319. void dsi_ctrl_debug_dump(u32 *entries, u32 size);
  320. #else
  321. static inline struct sde_dbg_evtlog *sde_evtlog_init(void)
  322. {
  323. return NULL;
  324. }
  325. static inline void sde_evtlog_destroy(struct sde_dbg_evtlog *evtlog)
  326. {
  327. }
  328. static inline void sde_evtlog_log(struct sde_dbg_evtlog *evtlog,
  329. const char *name, int line, int flag, ...)
  330. {
  331. }
  332. static inline void sde_evtlog_dump_all(struct sde_dbg_evtlog *evtlog)
  333. {
  334. }
  335. static inline bool sde_evtlog_is_enabled(struct sde_dbg_evtlog *evtlog,
  336. u32 flag)
  337. {
  338. return false;
  339. }
  340. static inline ssize_t sde_evtlog_dump_to_buffer(struct sde_dbg_evtlog *evtlog,
  341. char *evtlog_buf, ssize_t evtlog_buf_size,
  342. bool update_last_entry)
  343. {
  344. return 0;
  345. }
  346. static inline void sde_dbg_init_dbg_buses(u32 hwversion)
  347. {
  348. }
  349. static inline int sde_dbg_init(struct device *dev,
  350. struct sde_dbg_power_ctrl *power_ctrl)
  351. {
  352. return 0;
  353. }
  354. static inline int sde_dbg_debugfs_register(struct dentry *debugfs_root)
  355. {
  356. return 0;
  357. }
  358. static inline void sde_dbg_destroy(void)
  359. {
  360. }
  361. static inline void sde_dbg_dump(enum sde_dbg_dump_context,
  362. const char *name, ...)
  363. {
  364. }
  365. static inline void sde_dbg_ctrl(const char *name, ...)
  366. {
  367. }
  368. static inline int sde_dbg_reg_register_base(const char *name,
  369. void __iomem *base, size_t max_offset)
  370. {
  371. return 0;
  372. }
  373. static inline void sde_dbg_reg_register_dump_range(const char *base_name,
  374. const char *range_name, u32 offset_start, u32 offset_end,
  375. uint32_t xin_id)
  376. {
  377. }
  378. void sde_dbg_set_sde_top_offset(u32 blk_off)
  379. {
  380. }
  381. static inline void sde_evtlog_set_filter(
  382. struct sde_dbg_evtlog *evtlog, char *filter)
  383. {
  384. }
  385. static inline int sde_evtlog_get_filter(struct sde_dbg_evtlog *evtlog,
  386. int index, char *buf, size_t bufsz)
  387. {
  388. return -EINVAL;
  389. }
  390. static inline void sde_rsc_debug_dump(u32 mux_sel)
  391. {
  392. }
  393. static inline void dsi_ctrl_debug_dump(u32 entries, u32 size)
  394. {
  395. }
  396. #endif /* defined(CONFIG_DEBUG_FS) */
  397. #endif /* SDE_DBG_H_ */