Lloyd Atkinson | 113aefd | 2016-10-23 13:15:18 -0400 | [diff] [blame] | 1 | /* Copyright (c) 2016-2017, The Linux Foundation. All rights reserved. |
Lloyd Atkinson | 5d40d31 | 2016-09-06 08:34:13 -0400 | [diff] [blame] | 2 | * |
| 3 | * This program is free software; you can redistribute it and/or modify |
| 4 | * it under the terms of the GNU General Public License version 2 and |
| 5 | * only version 2 as published by the Free Software Foundation. |
| 6 | * |
| 7 | * This program is distributed in the hope that it will be useful, |
| 8 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 9 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 10 | * GNU General Public License for more details. |
| 11 | */ |
| 12 | |
| 13 | #ifndef SDE_DBG_H_ |
| 14 | #define SDE_DBG_H_ |
| 15 | |
| 16 | #include <stdarg.h> |
| 17 | #include <linux/debugfs.h> |
| 18 | #include <linux/list.h> |
| 19 | |
| 20 | #define SDE_EVTLOG_DATA_LIMITER (-1) |
| 21 | #define SDE_EVTLOG_FUNC_ENTRY 0x1111 |
| 22 | #define SDE_EVTLOG_FUNC_EXIT 0x2222 |
| 23 | |
Lloyd Atkinson | a54513f | 2016-10-03 22:31:43 -0400 | [diff] [blame] | 24 | #define SDE_DBG_DUMP_DATA_LIMITER (NULL) |
| 25 | |
Lloyd Atkinson | 5d40d31 | 2016-09-06 08:34:13 -0400 | [diff] [blame] | 26 | enum sde_dbg_evtlog_flag { |
Clarence Ip | 6ac61cc | 2017-03-22 15:01:53 -0400 | [diff] [blame] | 27 | SDE_EVTLOG_CRITICAL = BIT(0), |
Lloyd Atkinson | 5d40d31 | 2016-09-06 08:34:13 -0400 | [diff] [blame] | 28 | SDE_EVTLOG_IRQ = BIT(1), |
Clarence Ip | 6ac61cc | 2017-03-22 15:01:53 -0400 | [diff] [blame] | 29 | SDE_EVTLOG_VERBOSE = BIT(2), |
| 30 | SDE_EVTLOG_ALWAYS = -1 |
Lloyd Atkinson | 5d40d31 | 2016-09-06 08:34:13 -0400 | [diff] [blame] | 31 | }; |
| 32 | |
Lloyd Atkinson | 113aefd | 2016-10-23 13:15:18 -0400 | [diff] [blame] | 33 | enum sde_dbg_dump_flag { |
| 34 | SDE_DBG_DUMP_IN_LOG = BIT(0), |
| 35 | SDE_DBG_DUMP_IN_MEM = BIT(1), |
| 36 | }; |
| 37 | |
| 38 | #ifdef CONFIG_DRM_SDE_EVTLOG_DEBUG |
Clarence Ip | 6ac61cc | 2017-03-22 15:01:53 -0400 | [diff] [blame] | 39 | #define SDE_EVTLOG_DEFAULT_ENABLE SDE_EVTLOG_CRITICAL |
Lloyd Atkinson | 113aefd | 2016-10-23 13:15:18 -0400 | [diff] [blame] | 40 | #else |
| 41 | #define SDE_EVTLOG_DEFAULT_ENABLE 0 |
| 42 | #endif |
| 43 | |
| 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 | /* |
| 52 | * evtlog keeps this number of entries in memory for debug purpose. This |
| 53 | * number must be greater than print entry to prevent out of bound evtlog |
| 54 | * entry array access. |
| 55 | */ |
| 56 | #define SDE_EVTLOG_ENTRY (SDE_EVTLOG_PRINT_ENTRY * 4) |
| 57 | #define SDE_EVTLOG_MAX_DATA 15 |
| 58 | #define SDE_EVTLOG_BUF_MAX 512 |
| 59 | #define SDE_EVTLOG_BUF_ALIGN 32 |
| 60 | |
| 61 | struct sde_dbg_power_ctrl { |
| 62 | void *handle; |
| 63 | void *client; |
| 64 | int (*enable_fn)(void *handle, void *client, bool enable); |
| 65 | }; |
| 66 | |
| 67 | struct sde_dbg_evtlog_log { |
Lloyd Atkinson | 113aefd | 2016-10-23 13:15:18 -0400 | [diff] [blame] | 68 | s64 time; |
| 69 | const char *name; |
| 70 | int line; |
| 71 | u32 data[SDE_EVTLOG_MAX_DATA]; |
| 72 | u32 data_cnt; |
| 73 | int pid; |
| 74 | }; |
| 75 | |
Clarence Ip | 6ac61cc | 2017-03-22 15:01:53 -0400 | [diff] [blame] | 76 | /** |
| 77 | * @filter_list: Linked list of currently active filter strings |
| 78 | */ |
Lloyd Atkinson | 113aefd | 2016-10-23 13:15:18 -0400 | [diff] [blame] | 79 | struct sde_dbg_evtlog { |
| 80 | struct sde_dbg_evtlog_log logs[SDE_EVTLOG_ENTRY]; |
| 81 | u32 first; |
| 82 | u32 last; |
| 83 | u32 curr; |
| 84 | u32 next; |
| 85 | u32 enable; |
| 86 | spinlock_t spin_lock; |
Clarence Ip | 6ac61cc | 2017-03-22 15:01:53 -0400 | [diff] [blame] | 87 | struct list_head filter_list; |
Lloyd Atkinson | 113aefd | 2016-10-23 13:15:18 -0400 | [diff] [blame] | 88 | }; |
| 89 | |
| 90 | extern struct sde_dbg_evtlog *sde_dbg_base_evtlog; |
| 91 | |
Lloyd Atkinson | 5d40d31 | 2016-09-06 08:34:13 -0400 | [diff] [blame] | 92 | /** |
Lloyd Atkinson | 113aefd | 2016-10-23 13:15:18 -0400 | [diff] [blame] | 93 | * SDE_EVT32 - Write a list of 32bit values to the event log, default area |
Lloyd Atkinson | 5d40d31 | 2016-09-06 08:34:13 -0400 | [diff] [blame] | 94 | * ... - variable arguments |
| 95 | */ |
Lloyd Atkinson | 113aefd | 2016-10-23 13:15:18 -0400 | [diff] [blame] | 96 | #define SDE_EVT32(...) sde_evtlog_log(sde_dbg_base_evtlog, __func__, \ |
Clarence Ip | 6ac61cc | 2017-03-22 15:01:53 -0400 | [diff] [blame] | 97 | __LINE__, SDE_EVTLOG_ALWAYS, ##__VA_ARGS__, \ |
| 98 | SDE_EVTLOG_DATA_LIMITER) |
| 99 | |
| 100 | /** |
| 101 | * SDE_EVT32_VERBOSE - Write a list of 32bit values for verbose event logging |
| 102 | * ... - variable arguments |
| 103 | */ |
| 104 | #define SDE_EVT32_VERBOSE(...) sde_evtlog_log(sde_dbg_base_evtlog, __func__, \ |
| 105 | __LINE__, SDE_EVTLOG_VERBOSE, ##__VA_ARGS__, \ |
Lloyd Atkinson | 113aefd | 2016-10-23 13:15:18 -0400 | [diff] [blame] | 106 | SDE_EVTLOG_DATA_LIMITER) |
Lloyd Atkinson | 5d40d31 | 2016-09-06 08:34:13 -0400 | [diff] [blame] | 107 | |
Lloyd Atkinson | 113aefd | 2016-10-23 13:15:18 -0400 | [diff] [blame] | 108 | /** |
| 109 | * SDE_EVT32_IRQ - Write a list of 32bit values to the event log, IRQ area |
| 110 | * ... - variable arguments |
| 111 | */ |
| 112 | #define SDE_EVT32_IRQ(...) sde_evtlog_log(sde_dbg_base_evtlog, __func__, \ |
| 113 | __LINE__, SDE_EVTLOG_IRQ, ##__VA_ARGS__, \ |
| 114 | SDE_EVTLOG_DATA_LIMITER) |
| 115 | |
| 116 | /** |
| 117 | * SDE_DBG_DUMP - trigger dumping of all sde_dbg facilities |
| 118 | * @va_args: list of named register dump ranges and regions to dump, as |
| 119 | * registered previously through sde_dbg_reg_register_base and |
| 120 | * sde_dbg_reg_register_dump_range. |
| 121 | * Including the special name "panic" will trigger a panic after |
| 122 | * the dumping work has completed. |
| 123 | */ |
| 124 | #define SDE_DBG_DUMP(...) sde_dbg_dump(false, __func__, ##__VA_ARGS__, \ |
Lloyd Atkinson | a54513f | 2016-10-03 22:31:43 -0400 | [diff] [blame] | 125 | SDE_DBG_DUMP_DATA_LIMITER) |
| 126 | |
Lloyd Atkinson | 113aefd | 2016-10-23 13:15:18 -0400 | [diff] [blame] | 127 | /** |
| 128 | * SDE_DBG_DUMP_WQ - trigger dumping of all sde_dbg facilities, queuing the work |
| 129 | * @va_args: list of named register dump ranges and regions to dump, as |
| 130 | * registered previously through sde_dbg_reg_register_base and |
| 131 | * sde_dbg_reg_register_dump_range. |
| 132 | * Including the special name "panic" will trigger a panic after |
| 133 | * the dumping work has completed. |
| 134 | */ |
| 135 | #define SDE_DBG_DUMP_WQ(...) sde_dbg_dump(true, __func__, ##__VA_ARGS__, \ |
Lloyd Atkinson | a54513f | 2016-10-03 22:31:43 -0400 | [diff] [blame] | 136 | SDE_DBG_DUMP_DATA_LIMITER) |
Lloyd Atkinson | 5d40d31 | 2016-09-06 08:34:13 -0400 | [diff] [blame] | 137 | |
| 138 | #if defined(CONFIG_DEBUG_FS) |
| 139 | |
Lloyd Atkinson | 113aefd | 2016-10-23 13:15:18 -0400 | [diff] [blame] | 140 | /** |
| 141 | * sde_evtlog_init - allocate a new event log object |
| 142 | * Returns: evtlog or -ERROR |
| 143 | */ |
| 144 | struct sde_dbg_evtlog *sde_evtlog_init(void); |
| 145 | |
| 146 | /** |
| 147 | * sde_evtlog_destroy - destroy previously allocated event log |
| 148 | * @evtlog: pointer to evtlog |
| 149 | * Returns: none |
| 150 | */ |
| 151 | void sde_evtlog_destroy(struct sde_dbg_evtlog *evtlog); |
| 152 | |
| 153 | /** |
| 154 | * sde_evtlog_log - log an entry into the event log. |
| 155 | * log collection may be enabled/disabled entirely via debugfs |
| 156 | * log area collection may be filtered by user provided flags via debugfs. |
| 157 | * @evtlog: pointer to evtlog |
| 158 | * @name: function name of call site |
| 159 | * @line: line number of call site |
| 160 | * @flag: log area filter flag checked against user's debugfs request |
| 161 | * Returns: none |
| 162 | */ |
| 163 | void sde_evtlog_log(struct sde_dbg_evtlog *evtlog, const char *name, int line, |
| 164 | int flag, ...); |
| 165 | |
| 166 | /** |
| 167 | * sde_evtlog_dump_all - print all entries in event log to kernel log |
| 168 | * @evtlog: pointer to evtlog |
| 169 | * Returns: none |
| 170 | */ |
| 171 | void sde_evtlog_dump_all(struct sde_dbg_evtlog *evtlog); |
| 172 | |
| 173 | /** |
| 174 | * sde_evtlog_is_enabled - check whether log collection is enabled for given |
| 175 | * event log and log area flag |
| 176 | * @evtlog: pointer to evtlog |
| 177 | * @flag: log area filter flag |
| 178 | * Returns: none |
| 179 | */ |
| 180 | bool sde_evtlog_is_enabled(struct sde_dbg_evtlog *evtlog, u32 flag); |
| 181 | |
| 182 | /** |
| 183 | * sde_evtlog_dump_to_buffer - print content of event log to the given buffer |
| 184 | * @evtlog: pointer to evtlog |
| 185 | * @evtlog_buf: target buffer to print into |
| 186 | * @evtlog_buf_size: size of target buffer |
| 187 | * Returns: number of bytes written to buffer |
| 188 | */ |
| 189 | ssize_t sde_evtlog_dump_to_buffer(struct sde_dbg_evtlog *evtlog, |
| 190 | char *evtlog_buf, ssize_t evtlog_buf_size); |
| 191 | |
| 192 | /** |
Lloyd Atkinson | 274cc46 | 2017-02-21 11:52:06 -0500 | [diff] [blame] | 193 | * sde_dbg_init_dbg_buses - initialize debug bus dumping support for the chipset |
| 194 | * @hwversion: Chipset revision |
| 195 | */ |
| 196 | void sde_dbg_init_dbg_buses(u32 hwversion); |
| 197 | |
| 198 | /** |
Lloyd Atkinson | 113aefd | 2016-10-23 13:15:18 -0400 | [diff] [blame] | 199 | * sde_dbg_init - initialize global sde debug facilities: evtlog, regdump |
Lloyd Atkinson | 113aefd | 2016-10-23 13:15:18 -0400 | [diff] [blame] | 200 | * @dev: device handle |
| 201 | * @power_ctrl: power control callback structure for enabling clocks |
| 202 | * during register dumping |
| 203 | * Returns: 0 or -ERROR |
| 204 | */ |
Lloyd Atkinson | b020e0f | 2017-03-14 08:05:18 -0700 | [diff] [blame] | 205 | int sde_dbg_init(struct device *dev, struct sde_dbg_power_ctrl *power_ctrl); |
| 206 | |
| 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); |
Lloyd Atkinson | 113aefd | 2016-10-23 13:15:18 -0400 | [diff] [blame] | 213 | |
| 214 | /** |
| 215 | * sde_dbg_destroy - destroy the global sde debug facilities |
| 216 | * Returns: none |
| 217 | */ |
| 218 | void sde_dbg_destroy(void); |
| 219 | |
| 220 | /** |
| 221 | * sde_dbg_dump - trigger dumping of all sde_dbg facilities |
| 222 | * @queue_work: whether to queue the dumping work to the work_struct |
| 223 | * @name: string indicating origin of dump |
| 224 | * @va_args: list of named register dump ranges and regions to dump, as |
| 225 | * registered previously through sde_dbg_reg_register_base and |
| 226 | * sde_dbg_reg_register_dump_range. |
| 227 | * Including the special name "panic" will trigger a panic after |
| 228 | * the dumping work has completed. |
| 229 | * Returns: none |
| 230 | */ |
| 231 | void sde_dbg_dump(bool queue_work, const char *name, ...); |
| 232 | |
| 233 | /** |
| 234 | * sde_dbg_reg_register_base - register a hw register address section for later |
| 235 | * dumping. call this before calling sde_dbg_reg_register_dump_range |
| 236 | * to be able to specify sub-ranges within the base hw range. |
| 237 | * @name: name of base region |
| 238 | * @base: base pointer of region |
| 239 | * @max_offset: length of region |
| 240 | * Returns: 0 or -ERROR |
| 241 | */ |
| 242 | int sde_dbg_reg_register_base(const char *name, void __iomem *base, |
| 243 | size_t max_offset); |
| 244 | |
| 245 | /** |
| 246 | * sde_dbg_reg_register_dump_range - register a hw register sub-region for |
| 247 | * later register dumping associated with base specified by |
| 248 | * sde_dbg_reg_register_base |
| 249 | * @base_name: name of base region |
| 250 | * @range_name: name of sub-range within base region |
| 251 | * @offset_start: sub-range's start offset from base's base pointer |
| 252 | * @offset_end: sub-range's end offset from base's base pointer |
| 253 | * @xin_id: xin id |
| 254 | * Returns: none |
| 255 | */ |
| 256 | void sde_dbg_reg_register_dump_range(const char *base_name, |
| 257 | const char *range_name, u32 offset_start, u32 offset_end, |
| 258 | uint32_t xin_id); |
| 259 | |
Clarence Ip | 6ac61cc | 2017-03-22 15:01:53 -0400 | [diff] [blame] | 260 | /** |
| 261 | * sde_evtlog_set_filter - update evtlog filtering |
| 262 | * @evtlog: pointer to evtlog |
| 263 | * @filter: pointer to optional function name filter, set to NULL to disable |
| 264 | */ |
| 265 | void sde_evtlog_set_filter(struct sde_dbg_evtlog *evtlog, char *filter); |
| 266 | |
| 267 | /** |
| 268 | * sde_evtlog_get_filter - query configured evtlog filters |
| 269 | * @evtlog: pointer to evtlog |
| 270 | * @index: filter index to retrieve |
| 271 | * @buf: pointer to output filter buffer |
| 272 | * @bufsz: size of output filter buffer |
| 273 | * Returns: zero if a filter string was returned |
| 274 | */ |
| 275 | int sde_evtlog_get_filter(struct sde_dbg_evtlog *evtlog, int index, |
| 276 | char *buf, size_t bufsz); |
| 277 | |
Lloyd Atkinson | 5d40d31 | 2016-09-06 08:34:13 -0400 | [diff] [blame] | 278 | #else |
Lloyd Atkinson | 113aefd | 2016-10-23 13:15:18 -0400 | [diff] [blame] | 279 | static inline struct sde_dbg_evtlog *sde_evtlog_init(void) |
| 280 | { |
| 281 | return NULL; |
| 282 | } |
| 283 | |
| 284 | static inline void sde_evtlog_destroy(struct sde_dbg_evtlog *evtlog) |
| 285 | { |
| 286 | } |
| 287 | |
| 288 | static inline void sde_evtlog_log(struct sde_dbg_evtlog *evtlog, |
| 289 | const char *name, int line, int flag, ...) |
| 290 | { |
| 291 | } |
| 292 | |
| 293 | static inline void sde_evtlog_dump_all(struct sde_dbg_evtlog *evtlog) |
| 294 | { |
| 295 | } |
| 296 | |
| 297 | static inline bool sde_evtlog_is_enabled(struct sde_dbg_evtlog *evtlog, |
| 298 | u32 flag) |
| 299 | { |
| 300 | return false; |
| 301 | } |
| 302 | |
| 303 | static inline ssize_t sde_evtlog_dump_to_buffer(struct sde_dbg_evtlog *evtlog, |
| 304 | char *evtlog_buf, ssize_t evtlog_buf_size) |
| 305 | { |
| 306 | return 0; |
| 307 | } |
| 308 | |
Clarence Ip | 6ac61cc | 2017-03-22 15:01:53 -0400 | [diff] [blame] | 309 | static inline void sde_dbg_init_dbg_buses(u32 hwversion) |
Lloyd Atkinson | 274cc46 | 2017-02-21 11:52:06 -0500 | [diff] [blame] | 310 | { |
| 311 | } |
| 312 | |
Lloyd Atkinson | b020e0f | 2017-03-14 08:05:18 -0700 | [diff] [blame] | 313 | static inline int sde_dbg_init(struct device *dev, |
Lloyd Atkinson | 113aefd | 2016-10-23 13:15:18 -0400 | [diff] [blame] | 314 | struct sde_dbg_power_ctrl *power_ctrl) |
| 315 | { |
| 316 | return 0; |
| 317 | } |
| 318 | |
Clarence Ip | 6ac61cc | 2017-03-22 15:01:53 -0400 | [diff] [blame] | 319 | static inline int sde_dbg_debugfs_register(struct dentry *debugfs_root) |
Lloyd Atkinson | b020e0f | 2017-03-14 08:05:18 -0700 | [diff] [blame] | 320 | { |
| 321 | return 0; |
| 322 | } |
| 323 | |
Lloyd Atkinson | 113aefd | 2016-10-23 13:15:18 -0400 | [diff] [blame] | 324 | static inline void sde_dbg_destroy(void) |
| 325 | { |
| 326 | } |
| 327 | |
| 328 | static inline void sde_dbg_dump(bool queue_work, const char *name, ...) |
| 329 | { |
| 330 | } |
| 331 | |
| 332 | static inline int sde_dbg_reg_register_base(const char *name, |
| 333 | void __iomem *base, size_t max_offset) |
| 334 | { |
| 335 | return 0; |
| 336 | } |
| 337 | |
| 338 | static inline void sde_dbg_reg_register_dump_range(const char *base_name, |
| 339 | const char *range_name, u32 offset_start, u32 offset_end, |
| 340 | uint32_t xin_id) |
| 341 | { |
| 342 | } |
| 343 | |
Clarence Ip | 6ac61cc | 2017-03-22 15:01:53 -0400 | [diff] [blame] | 344 | static inline void sde_evtlog_set_filter( |
| 345 | struct sde_dbg_evtlog *evtlog, char *filter) |
| 346 | { |
| 347 | } |
| 348 | |
| 349 | static inline int sde_evtlog_get_filter(struct sde_dbg_evtlog *evtlog, |
| 350 | int index, char *buf, size_t bufsz) |
| 351 | { |
| 352 | return -EINVAL; |
| 353 | } |
| 354 | |
Lloyd Atkinson | 113aefd | 2016-10-23 13:15:18 -0400 | [diff] [blame] | 355 | #endif /* defined(CONFIG_DEBUG_FS) */ |
| 356 | |
Lloyd Atkinson | 5d40d31 | 2016-09-06 08:34:13 -0400 | [diff] [blame] | 357 | |
| 358 | #endif /* SDE_DBG_H_ */ |