Loading...
1/*
2 * Copyright (C) 2016 Red Hat
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:
23 * Rob Clark <robdclark@gmail.com>
24 */
25
26#ifndef DRM_PRINT_H_
27#define DRM_PRINT_H_
28
29#include <linux/compiler.h>
30#include <linux/printk.h>
31#include <linux/seq_file.h>
32#include <linux/device.h>
33#include <linux/debugfs.h>
34
35#include <drm/drm.h>
36
37/**
38 * DOC: print
39 *
40 * A simple wrapper for dev_printk(), seq_printf(), etc. Allows same
41 * debug code to be used for both debugfs and printk logging.
42 *
43 * For example::
44 *
45 * void log_some_info(struct drm_printer *p)
46 * {
47 * drm_printf(p, "foo=%d\n", foo);
48 * drm_printf(p, "bar=%d\n", bar);
49 * }
50 *
51 * #ifdef CONFIG_DEBUG_FS
52 * void debugfs_show(struct seq_file *f)
53 * {
54 * struct drm_printer p = drm_seq_file_printer(f);
55 * log_some_info(&p);
56 * }
57 * #endif
58 *
59 * void some_other_function(...)
60 * {
61 * struct drm_printer p = drm_info_printer(drm->dev);
62 * log_some_info(&p);
63 * }
64 */
65
66/**
67 * struct drm_printer - drm output "stream"
68 *
69 * Do not use struct members directly. Use drm_printer_seq_file(),
70 * drm_printer_info(), etc to initialize. And drm_printf() for output.
71 */
72struct drm_printer {
73 /* private: */
74 void (*printfn)(struct drm_printer *p, struct va_format *vaf);
75 void (*puts)(struct drm_printer *p, const char *str);
76 void *arg;
77 const char *prefix;
78};
79
80void __drm_printfn_coredump(struct drm_printer *p, struct va_format *vaf);
81void __drm_puts_coredump(struct drm_printer *p, const char *str);
82void __drm_printfn_seq_file(struct drm_printer *p, struct va_format *vaf);
83void __drm_puts_seq_file(struct drm_printer *p, const char *str);
84void __drm_printfn_info(struct drm_printer *p, struct va_format *vaf);
85void __drm_printfn_debug(struct drm_printer *p, struct va_format *vaf);
86
87__printf(2, 3)
88void drm_printf(struct drm_printer *p, const char *f, ...);
89void drm_puts(struct drm_printer *p, const char *str);
90void drm_print_regset32(struct drm_printer *p, struct debugfs_regset32 *regset);
91
92__printf(2, 0)
93/**
94 * drm_vprintf - print to a &drm_printer stream
95 * @p: the &drm_printer
96 * @fmt: format string
97 * @va: the va_list
98 */
99static inline void
100drm_vprintf(struct drm_printer *p, const char *fmt, va_list *va)
101{
102 struct va_format vaf = { .fmt = fmt, .va = va };
103
104 p->printfn(p, &vaf);
105}
106
107/**
108 * drm_printf_indent - Print to a &drm_printer stream with indentation
109 * @printer: DRM printer
110 * @indent: Tab indentation level (max 5)
111 * @fmt: Format string
112 */
113#define drm_printf_indent(printer, indent, fmt, ...) \
114 drm_printf((printer), "%.*s" fmt, (indent), "\t\t\t\t\tX", ##__VA_ARGS__)
115
116/**
117 * struct drm_print_iterator - local struct used with drm_printer_coredump
118 * @data: Pointer to the devcoredump output buffer
119 * @start: The offset within the buffer to start writing
120 * @remain: The number of bytes to write for this iteration
121 */
122struct drm_print_iterator {
123 void *data;
124 ssize_t start;
125 ssize_t remain;
126 /* private: */
127 ssize_t offset;
128};
129
130/**
131 * drm_coredump_printer - construct a &drm_printer that can output to a buffer
132 * from the read function for devcoredump
133 * @iter: A pointer to a struct drm_print_iterator for the read instance
134 *
135 * This wrapper extends drm_printf() to work with a dev_coredumpm() callback
136 * function. The passed in drm_print_iterator struct contains the buffer
137 * pointer, size and offset as passed in from devcoredump.
138 *
139 * For example::
140 *
141 * void coredump_read(char *buffer, loff_t offset, size_t count,
142 * void *data, size_t datalen)
143 * {
144 * struct drm_print_iterator iter;
145 * struct drm_printer p;
146 *
147 * iter.data = buffer;
148 * iter.start = offset;
149 * iter.remain = count;
150 *
151 * p = drm_coredump_printer(&iter);
152 *
153 * drm_printf(p, "foo=%d\n", foo);
154 * }
155 *
156 * void makecoredump(...)
157 * {
158 * ...
159 * dev_coredumpm(dev, THIS_MODULE, data, 0, GFP_KERNEL,
160 * coredump_read, ...)
161 * }
162 *
163 * RETURNS:
164 * The &drm_printer object
165 */
166static inline struct drm_printer
167drm_coredump_printer(struct drm_print_iterator *iter)
168{
169 struct drm_printer p = {
170 .printfn = __drm_printfn_coredump,
171 .puts = __drm_puts_coredump,
172 .arg = iter,
173 };
174
175 /* Set the internal offset of the iterator to zero */
176 iter->offset = 0;
177
178 return p;
179}
180
181/**
182 * drm_seq_file_printer - construct a &drm_printer that outputs to &seq_file
183 * @f: the &struct seq_file to output to
184 *
185 * RETURNS:
186 * The &drm_printer object
187 */
188static inline struct drm_printer drm_seq_file_printer(struct seq_file *f)
189{
190 struct drm_printer p = {
191 .printfn = __drm_printfn_seq_file,
192 .puts = __drm_puts_seq_file,
193 .arg = f,
194 };
195 return p;
196}
197
198/**
199 * drm_info_printer - construct a &drm_printer that outputs to dev_printk()
200 * @dev: the &struct device pointer
201 *
202 * RETURNS:
203 * The &drm_printer object
204 */
205static inline struct drm_printer drm_info_printer(struct device *dev)
206{
207 struct drm_printer p = {
208 .printfn = __drm_printfn_info,
209 .arg = dev,
210 };
211 return p;
212}
213
214/**
215 * drm_debug_printer - construct a &drm_printer that outputs to pr_debug()
216 * @prefix: debug output prefix
217 *
218 * RETURNS:
219 * The &drm_printer object
220 */
221static inline struct drm_printer drm_debug_printer(const char *prefix)
222{
223 struct drm_printer p = {
224 .printfn = __drm_printfn_debug,
225 .prefix = prefix
226 };
227 return p;
228}
229
230/*
231 * The following categories are defined:
232 *
233 * CORE: Used in the generic drm code: drm_ioctl.c, drm_mm.c, drm_memory.c, ...
234 * This is the category used by the DRM_DEBUG() macro.
235 *
236 * DRIVER: Used in the vendor specific part of the driver: i915, radeon, ...
237 * This is the category used by the DRM_DEBUG_DRIVER() macro.
238 *
239 * KMS: used in the modesetting code.
240 * This is the category used by the DRM_DEBUG_KMS() macro.
241 *
242 * PRIME: used in the prime code.
243 * This is the category used by the DRM_DEBUG_PRIME() macro.
244 *
245 * ATOMIC: used in the atomic code.
246 * This is the category used by the DRM_DEBUG_ATOMIC() macro.
247 *
248 * VBL: used for verbose debug message in the vblank code
249 * This is the category used by the DRM_DEBUG_VBL() macro.
250 *
251 * Enabling verbose debug messages is done through the drm.debug parameter,
252 * each category being enabled by a bit.
253 *
254 * drm.debug=0x1 will enable CORE messages
255 * drm.debug=0x2 will enable DRIVER messages
256 * drm.debug=0x3 will enable CORE and DRIVER messages
257 * ...
258 * drm.debug=0x3f will enable all messages
259 *
260 * An interesting feature is that it's possible to enable verbose logging at
261 * run-time by echoing the debug value in its sysfs node:
262 * # echo 0xf > /sys/module/drm/parameters/debug
263 */
264#define DRM_UT_NONE 0x00
265#define DRM_UT_CORE 0x01
266#define DRM_UT_DRIVER 0x02
267#define DRM_UT_KMS 0x04
268#define DRM_UT_PRIME 0x08
269#define DRM_UT_ATOMIC 0x10
270#define DRM_UT_VBL 0x20
271#define DRM_UT_STATE 0x40
272#define DRM_UT_LEASE 0x80
273#define DRM_UT_DP 0x100
274
275__printf(3, 4)
276void drm_dev_printk(const struct device *dev, const char *level,
277 const char *format, ...);
278__printf(3, 4)
279void drm_dev_dbg(const struct device *dev, unsigned int category,
280 const char *format, ...);
281
282__printf(2, 3)
283void drm_dbg(unsigned int category, const char *format, ...);
284__printf(1, 2)
285void drm_err(const char *format, ...);
286
287/* Macros to make printk easier */
288
289#define _DRM_PRINTK(once, level, fmt, ...) \
290 printk##once(KERN_##level "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
291
292#define DRM_INFO(fmt, ...) \
293 _DRM_PRINTK(, INFO, fmt, ##__VA_ARGS__)
294#define DRM_NOTE(fmt, ...) \
295 _DRM_PRINTK(, NOTICE, fmt, ##__VA_ARGS__)
296#define DRM_WARN(fmt, ...) \
297 _DRM_PRINTK(, WARNING, fmt, ##__VA_ARGS__)
298
299#define DRM_INFO_ONCE(fmt, ...) \
300 _DRM_PRINTK(_once, INFO, fmt, ##__VA_ARGS__)
301#define DRM_NOTE_ONCE(fmt, ...) \
302 _DRM_PRINTK(_once, NOTICE, fmt, ##__VA_ARGS__)
303#define DRM_WARN_ONCE(fmt, ...) \
304 _DRM_PRINTK(_once, WARNING, fmt, ##__VA_ARGS__)
305
306/**
307 * Error output.
308 *
309 * @dev: device pointer
310 * @fmt: printf() like format string.
311 */
312#define DRM_DEV_ERROR(dev, fmt, ...) \
313 drm_dev_printk(dev, KERN_ERR, "*ERROR* " fmt, ##__VA_ARGS__)
314#define DRM_ERROR(fmt, ...) \
315 drm_err(fmt, ##__VA_ARGS__)
316
317/**
318 * Rate limited error output. Like DRM_ERROR() but won't flood the log.
319 *
320 * @dev: device pointer
321 * @fmt: printf() like format string.
322 */
323#define DRM_DEV_ERROR_RATELIMITED(dev, fmt, ...) \
324({ \
325 static DEFINE_RATELIMIT_STATE(_rs, \
326 DEFAULT_RATELIMIT_INTERVAL, \
327 DEFAULT_RATELIMIT_BURST); \
328 \
329 if (__ratelimit(&_rs)) \
330 DRM_DEV_ERROR(dev, fmt, ##__VA_ARGS__); \
331})
332#define DRM_ERROR_RATELIMITED(fmt, ...) \
333 DRM_DEV_ERROR_RATELIMITED(NULL, fmt, ##__VA_ARGS__)
334
335#define DRM_DEV_INFO(dev, fmt, ...) \
336 drm_dev_printk(dev, KERN_INFO, fmt, ##__VA_ARGS__)
337
338#define DRM_DEV_INFO_ONCE(dev, fmt, ...) \
339({ \
340 static bool __print_once __read_mostly; \
341 if (!__print_once) { \
342 __print_once = true; \
343 DRM_DEV_INFO(dev, fmt, ##__VA_ARGS__); \
344 } \
345})
346
347/**
348 * Debug output.
349 *
350 * @dev: device pointer
351 * @fmt: printf() like format string.
352 */
353#define DRM_DEV_DEBUG(dev, fmt, ...) \
354 drm_dev_dbg(dev, DRM_UT_CORE, fmt, ##__VA_ARGS__)
355#define DRM_DEBUG(fmt, ...) \
356 drm_dbg(DRM_UT_CORE, fmt, ##__VA_ARGS__)
357
358#define DRM_DEV_DEBUG_DRIVER(dev, fmt, ...) \
359 drm_dev_dbg(dev, DRM_UT_DRIVER, fmt, ##__VA_ARGS__)
360#define DRM_DEBUG_DRIVER(fmt, ...) \
361 drm_dbg(DRM_UT_DRIVER, fmt, ##__VA_ARGS__)
362
363#define DRM_DEV_DEBUG_KMS(dev, fmt, ...) \
364 drm_dev_dbg(dev, DRM_UT_KMS, fmt, ##__VA_ARGS__)
365#define DRM_DEBUG_KMS(fmt, ...) \
366 drm_dbg(DRM_UT_KMS, fmt, ##__VA_ARGS__)
367
368#define DRM_DEV_DEBUG_PRIME(dev, fmt, ...) \
369 drm_dev_dbg(dev, DRM_UT_PRIME, fmt, ##__VA_ARGS__)
370#define DRM_DEBUG_PRIME(fmt, ...) \
371 drm_dbg(DRM_UT_PRIME, fmt, ##__VA_ARGS__)
372
373#define DRM_DEV_DEBUG_ATOMIC(dev, fmt, ...) \
374 drm_dev_dbg(dev, DRM_UT_ATOMIC, fmt, ##__VA_ARGS__)
375#define DRM_DEBUG_ATOMIC(fmt, ...) \
376 drm_dbg(DRM_UT_ATOMIC, fmt, ##__VA_ARGS__)
377
378#define DRM_DEV_DEBUG_VBL(dev, fmt, ...) \
379 drm_dev_dbg(dev, DRM_UT_VBL, fmt, ##__VA_ARGS__)
380#define DRM_DEBUG_VBL(fmt, ...) \
381 drm_dbg(DRM_UT_VBL, fmt, ##__VA_ARGS__)
382
383#define DRM_DEBUG_LEASE(fmt, ...) \
384 drm_dbg(DRM_UT_LEASE, fmt, ##__VA_ARGS__)
385
386#define DRM_DEV_DEBUG_DP(dev, fmt, ...) \
387 drm_dev_dbg(dev, DRM_UT_DP, fmt, ## __VA_ARGS__)
388#define DRM_DEBUG_DP(fmt, ...) \
389 drm_dbg(DRM_UT_DP, fmt, ## __VA_ARGS__)
390
391#define _DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, category, fmt, ...) \
392({ \
393 static DEFINE_RATELIMIT_STATE(_rs, \
394 DEFAULT_RATELIMIT_INTERVAL, \
395 DEFAULT_RATELIMIT_BURST); \
396 if (__ratelimit(&_rs)) \
397 drm_dev_dbg(dev, category, fmt, ##__VA_ARGS__); \
398})
399
400/**
401 * Rate limited debug output. Like DRM_DEBUG() but won't flood the log.
402 *
403 * @dev: device pointer
404 * @fmt: printf() like format string.
405 */
406#define DRM_DEV_DEBUG_RATELIMITED(dev, fmt, ...) \
407 _DEV_DRM_DEFINE_DEBUG_RATELIMITED(dev, DRM_UT_CORE, \
408 fmt, ##__VA_ARGS__)
409#define DRM_DEBUG_RATELIMITED(fmt, ...) \
410 DRM_DEV_DEBUG_RATELIMITED(NULL, fmt, ##__VA_ARGS__)
411
412#define DRM_DEV_DEBUG_DRIVER_RATELIMITED(dev, fmt, ...) \
413 _DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, DRM_UT_DRIVER, \
414 fmt, ##__VA_ARGS__)
415#define DRM_DEBUG_DRIVER_RATELIMITED(fmt, ...) \
416 DRM_DEV_DEBUG_DRIVER_RATELIMITED(NULL, fmt, ##__VA_ARGS__)
417
418#define DRM_DEV_DEBUG_KMS_RATELIMITED(dev, fmt, ...) \
419 _DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, DRM_UT_KMS, \
420 fmt, ##__VA_ARGS__)
421#define DRM_DEBUG_KMS_RATELIMITED(fmt, ...) \
422 DRM_DEV_DEBUG_KMS_RATELIMITED(NULL, fmt, ##__VA_ARGS__)
423
424#define DRM_DEV_DEBUG_PRIME_RATELIMITED(dev, fmt, ...) \
425 _DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, DRM_UT_PRIME, \
426 fmt, ##__VA_ARGS__)
427#define DRM_DEBUG_PRIME_RATELIMITED(fmt, ...) \
428 DRM_DEV_DEBUG_PRIME_RATELIMITED(NULL, fmt, ##__VA_ARGS__)
429
430#endif /* DRM_PRINT_H_ */
1/*
2 * Copyright (C) 2016 Red Hat
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:
23 * Rob Clark <robdclark@gmail.com>
24 */
25
26#ifndef DRM_PRINT_H_
27#define DRM_PRINT_H_
28
29#include <linux/compiler.h>
30#include <linux/printk.h>
31#include <linux/seq_file.h>
32#include <linux/device.h>
33#include <linux/debugfs.h>
34#include <linux/dynamic_debug.h>
35
36#include <drm/drm.h>
37
38struct drm_device;
39
40/* Do *not* use outside of drm_print.[ch]! */
41extern unsigned long __drm_debug;
42
43/**
44 * DOC: print
45 *
46 * A simple wrapper for dev_printk(), seq_printf(), etc. Allows same
47 * debug code to be used for both debugfs and printk logging.
48 *
49 * For example::
50 *
51 * void log_some_info(struct drm_printer *p)
52 * {
53 * drm_printf(p, "foo=%d\n", foo);
54 * drm_printf(p, "bar=%d\n", bar);
55 * }
56 *
57 * #ifdef CONFIG_DEBUG_FS
58 * void debugfs_show(struct seq_file *f)
59 * {
60 * struct drm_printer p = drm_seq_file_printer(f);
61 * log_some_info(&p);
62 * }
63 * #endif
64 *
65 * void some_other_function(...)
66 * {
67 * struct drm_printer p = drm_info_printer(drm->dev);
68 * log_some_info(&p);
69 * }
70 */
71
72/**
73 * enum drm_debug_category - The DRM debug categories
74 *
75 * Each of the DRM debug logging macros use a specific category, and the logging
76 * is filtered by the drm.debug module parameter. This enum specifies the values
77 * for the interface.
78 *
79 * Each DRM_DEBUG_<CATEGORY> macro logs to DRM_UT_<CATEGORY> category, except
80 * DRM_DEBUG() logs to DRM_UT_CORE.
81 *
82 * Enabling verbose debug messages is done through the drm.debug parameter, each
83 * category being enabled by a bit:
84 *
85 * - drm.debug=0x1 will enable CORE messages
86 * - drm.debug=0x2 will enable DRIVER messages
87 * - drm.debug=0x3 will enable CORE and DRIVER messages
88 * - ...
89 * - drm.debug=0x1ff will enable all messages
90 *
91 * An interesting feature is that it's possible to enable verbose logging at
92 * run-time by echoing the debug value in its sysfs node::
93 *
94 * # echo 0xf > /sys/module/drm/parameters/debug
95 *
96 */
97enum drm_debug_category {
98 /* These names must match those in DYNAMIC_DEBUG_CLASSBITS */
99 /**
100 * @DRM_UT_CORE: Used in the generic drm code: drm_ioctl.c, drm_mm.c,
101 * drm_memory.c, ...
102 */
103 DRM_UT_CORE,
104 /**
105 * @DRM_UT_DRIVER: Used in the vendor specific part of the driver: i915,
106 * radeon, ... macro.
107 */
108 DRM_UT_DRIVER,
109 /**
110 * @DRM_UT_KMS: Used in the modesetting code.
111 */
112 DRM_UT_KMS,
113 /**
114 * @DRM_UT_PRIME: Used in the prime code.
115 */
116 DRM_UT_PRIME,
117 /**
118 * @DRM_UT_ATOMIC: Used in the atomic code.
119 */
120 DRM_UT_ATOMIC,
121 /**
122 * @DRM_UT_VBL: Used for verbose debug message in the vblank code.
123 */
124 DRM_UT_VBL,
125 /**
126 * @DRM_UT_STATE: Used for verbose atomic state debugging.
127 */
128 DRM_UT_STATE,
129 /**
130 * @DRM_UT_LEASE: Used in the lease code.
131 */
132 DRM_UT_LEASE,
133 /**
134 * @DRM_UT_DP: Used in the DP code.
135 */
136 DRM_UT_DP,
137 /**
138 * @DRM_UT_DRMRES: Used in the drm managed resources code.
139 */
140 DRM_UT_DRMRES
141};
142
143static inline bool drm_debug_enabled_raw(enum drm_debug_category category)
144{
145 return unlikely(__drm_debug & BIT(category));
146}
147
148#define drm_debug_enabled_instrumented(category) \
149 ({ \
150 pr_debug("todo: is this frequent enough to optimize ?\n"); \
151 drm_debug_enabled_raw(category); \
152 })
153
154#if defined(CONFIG_DRM_USE_DYNAMIC_DEBUG)
155/*
156 * the drm.debug API uses dyndbg, so each drm_*dbg macro/callsite gets
157 * a descriptor, and only enabled callsites are reachable. They use
158 * the private macro to avoid re-testing the enable-bit.
159 */
160#define __drm_debug_enabled(category) true
161#define drm_debug_enabled(category) drm_debug_enabled_instrumented(category)
162#else
163#define __drm_debug_enabled(category) drm_debug_enabled_raw(category)
164#define drm_debug_enabled(category) drm_debug_enabled_raw(category)
165#endif
166
167/**
168 * struct drm_printer - drm output "stream"
169 *
170 * Do not use struct members directly. Use drm_printer_seq_file(),
171 * drm_printer_info(), etc to initialize. And drm_printf() for output.
172 */
173struct drm_printer {
174 /* private: */
175 void (*printfn)(struct drm_printer *p, struct va_format *vaf);
176 void (*puts)(struct drm_printer *p, const char *str);
177 void *arg;
178 const char *prefix;
179 enum drm_debug_category category;
180};
181
182void __drm_printfn_coredump(struct drm_printer *p, struct va_format *vaf);
183void __drm_puts_coredump(struct drm_printer *p, const char *str);
184void __drm_printfn_seq_file(struct drm_printer *p, struct va_format *vaf);
185void __drm_puts_seq_file(struct drm_printer *p, const char *str);
186void __drm_printfn_info(struct drm_printer *p, struct va_format *vaf);
187void __drm_printfn_dbg(struct drm_printer *p, struct va_format *vaf);
188void __drm_printfn_err(struct drm_printer *p, struct va_format *vaf);
189
190__printf(2, 3)
191void drm_printf(struct drm_printer *p, const char *f, ...);
192void drm_puts(struct drm_printer *p, const char *str);
193void drm_print_regset32(struct drm_printer *p, struct debugfs_regset32 *regset);
194void drm_print_bits(struct drm_printer *p, unsigned long value,
195 const char * const bits[], unsigned int nbits);
196
197__printf(2, 0)
198/**
199 * drm_vprintf - print to a &drm_printer stream
200 * @p: the &drm_printer
201 * @fmt: format string
202 * @va: the va_list
203 */
204static inline void
205drm_vprintf(struct drm_printer *p, const char *fmt, va_list *va)
206{
207 struct va_format vaf = { .fmt = fmt, .va = va };
208
209 p->printfn(p, &vaf);
210}
211
212/**
213 * drm_printf_indent - Print to a &drm_printer stream with indentation
214 * @printer: DRM printer
215 * @indent: Tab indentation level (max 5)
216 * @fmt: Format string
217 */
218#define drm_printf_indent(printer, indent, fmt, ...) \
219 drm_printf((printer), "%.*s" fmt, (indent), "\t\t\t\t\tX", ##__VA_ARGS__)
220
221/**
222 * struct drm_print_iterator - local struct used with drm_printer_coredump
223 * @data: Pointer to the devcoredump output buffer
224 * @start: The offset within the buffer to start writing
225 * @remain: The number of bytes to write for this iteration
226 */
227struct drm_print_iterator {
228 void *data;
229 ssize_t start;
230 ssize_t remain;
231 /* private: */
232 ssize_t offset;
233};
234
235/**
236 * drm_coredump_printer - construct a &drm_printer that can output to a buffer
237 * from the read function for devcoredump
238 * @iter: A pointer to a struct drm_print_iterator for the read instance
239 *
240 * This wrapper extends drm_printf() to work with a dev_coredumpm() callback
241 * function. The passed in drm_print_iterator struct contains the buffer
242 * pointer, size and offset as passed in from devcoredump.
243 *
244 * For example::
245 *
246 * void coredump_read(char *buffer, loff_t offset, size_t count,
247 * void *data, size_t datalen)
248 * {
249 * struct drm_print_iterator iter;
250 * struct drm_printer p;
251 *
252 * iter.data = buffer;
253 * iter.start = offset;
254 * iter.remain = count;
255 *
256 * p = drm_coredump_printer(&iter);
257 *
258 * drm_printf(p, "foo=%d\n", foo);
259 * }
260 *
261 * void makecoredump(...)
262 * {
263 * ...
264 * dev_coredumpm(dev, THIS_MODULE, data, 0, GFP_KERNEL,
265 * coredump_read, ...)
266 * }
267 *
268 * RETURNS:
269 * The &drm_printer object
270 */
271static inline struct drm_printer
272drm_coredump_printer(struct drm_print_iterator *iter)
273{
274 struct drm_printer p = {
275 .printfn = __drm_printfn_coredump,
276 .puts = __drm_puts_coredump,
277 .arg = iter,
278 };
279
280 /* Set the internal offset of the iterator to zero */
281 iter->offset = 0;
282
283 return p;
284}
285
286/**
287 * drm_seq_file_printer - construct a &drm_printer that outputs to &seq_file
288 * @f: the &struct seq_file to output to
289 *
290 * RETURNS:
291 * The &drm_printer object
292 */
293static inline struct drm_printer drm_seq_file_printer(struct seq_file *f)
294{
295 struct drm_printer p = {
296 .printfn = __drm_printfn_seq_file,
297 .puts = __drm_puts_seq_file,
298 .arg = f,
299 };
300 return p;
301}
302
303/**
304 * drm_info_printer - construct a &drm_printer that outputs to dev_printk()
305 * @dev: the &struct device pointer
306 *
307 * RETURNS:
308 * The &drm_printer object
309 */
310static inline struct drm_printer drm_info_printer(struct device *dev)
311{
312 struct drm_printer p = {
313 .printfn = __drm_printfn_info,
314 .arg = dev,
315 };
316 return p;
317}
318
319/**
320 * drm_dbg_printer - construct a &drm_printer for drm device specific output
321 * @drm: the &struct drm_device pointer, or NULL
322 * @category: the debug category to use
323 * @prefix: debug output prefix, or NULL for no prefix
324 *
325 * RETURNS:
326 * The &drm_printer object
327 */
328static inline struct drm_printer drm_dbg_printer(struct drm_device *drm,
329 enum drm_debug_category category,
330 const char *prefix)
331{
332 struct drm_printer p = {
333 .printfn = __drm_printfn_dbg,
334 .arg = drm,
335 .prefix = prefix,
336 .category = category,
337 };
338 return p;
339}
340
341/**
342 * drm_err_printer - construct a &drm_printer that outputs to drm_err()
343 * @drm: the &struct drm_device pointer
344 * @prefix: debug output prefix, or NULL for no prefix
345 *
346 * RETURNS:
347 * The &drm_printer object
348 */
349static inline struct drm_printer drm_err_printer(struct drm_device *drm,
350 const char *prefix)
351{
352 struct drm_printer p = {
353 .printfn = __drm_printfn_err,
354 .arg = drm,
355 .prefix = prefix
356 };
357 return p;
358}
359
360/*
361 * struct device based logging
362 *
363 * Prefer drm_device based logging over device or printk based logging.
364 */
365
366__printf(3, 4)
367void drm_dev_printk(const struct device *dev, const char *level,
368 const char *format, ...);
369struct _ddebug;
370__printf(4, 5)
371void __drm_dev_dbg(struct _ddebug *desc, const struct device *dev,
372 enum drm_debug_category category, const char *format, ...);
373
374/**
375 * DRM_DEV_ERROR() - Error output.
376 *
377 * NOTE: this is deprecated in favor of drm_err() or dev_err().
378 *
379 * @dev: device pointer
380 * @fmt: printf() like format string.
381 */
382#define DRM_DEV_ERROR(dev, fmt, ...) \
383 drm_dev_printk(dev, KERN_ERR, "*ERROR* " fmt, ##__VA_ARGS__)
384
385/**
386 * DRM_DEV_ERROR_RATELIMITED() - Rate limited error output.
387 *
388 * NOTE: this is deprecated in favor of drm_err_ratelimited() or
389 * dev_err_ratelimited().
390 *
391 * @dev: device pointer
392 * @fmt: printf() like format string.
393 *
394 * Like DRM_ERROR() but won't flood the log.
395 */
396#define DRM_DEV_ERROR_RATELIMITED(dev, fmt, ...) \
397({ \
398 static DEFINE_RATELIMIT_STATE(_rs, \
399 DEFAULT_RATELIMIT_INTERVAL, \
400 DEFAULT_RATELIMIT_BURST); \
401 \
402 if (__ratelimit(&_rs)) \
403 DRM_DEV_ERROR(dev, fmt, ##__VA_ARGS__); \
404})
405
406/* NOTE: this is deprecated in favor of drm_info() or dev_info(). */
407#define DRM_DEV_INFO(dev, fmt, ...) \
408 drm_dev_printk(dev, KERN_INFO, fmt, ##__VA_ARGS__)
409
410/* NOTE: this is deprecated in favor of drm_info_once() or dev_info_once(). */
411#define DRM_DEV_INFO_ONCE(dev, fmt, ...) \
412({ \
413 static bool __print_once __read_mostly; \
414 if (!__print_once) { \
415 __print_once = true; \
416 DRM_DEV_INFO(dev, fmt, ##__VA_ARGS__); \
417 } \
418})
419
420#if !defined(CONFIG_DRM_USE_DYNAMIC_DEBUG)
421#define drm_dev_dbg(dev, cat, fmt, ...) \
422 __drm_dev_dbg(NULL, dev, cat, fmt, ##__VA_ARGS__)
423#else
424#define drm_dev_dbg(dev, cat, fmt, ...) \
425 _dynamic_func_call_cls(cat, fmt, __drm_dev_dbg, \
426 dev, cat, fmt, ##__VA_ARGS__)
427#endif
428
429/**
430 * DRM_DEV_DEBUG() - Debug output for generic drm code
431 *
432 * NOTE: this is deprecated in favor of drm_dbg_core().
433 *
434 * @dev: device pointer
435 * @fmt: printf() like format string.
436 */
437#define DRM_DEV_DEBUG(dev, fmt, ...) \
438 drm_dev_dbg(dev, DRM_UT_CORE, fmt, ##__VA_ARGS__)
439/**
440 * DRM_DEV_DEBUG_DRIVER() - Debug output for vendor specific part of the driver
441 *
442 * NOTE: this is deprecated in favor of drm_dbg() or dev_dbg().
443 *
444 * @dev: device pointer
445 * @fmt: printf() like format string.
446 */
447#define DRM_DEV_DEBUG_DRIVER(dev, fmt, ...) \
448 drm_dev_dbg(dev, DRM_UT_DRIVER, fmt, ##__VA_ARGS__)
449/**
450 * DRM_DEV_DEBUG_KMS() - Debug output for modesetting code
451 *
452 * NOTE: this is deprecated in favor of drm_dbg_kms().
453 *
454 * @dev: device pointer
455 * @fmt: printf() like format string.
456 */
457#define DRM_DEV_DEBUG_KMS(dev, fmt, ...) \
458 drm_dev_dbg(dev, DRM_UT_KMS, fmt, ##__VA_ARGS__)
459
460/*
461 * struct drm_device based logging
462 *
463 * Prefer drm_device based logging over device or prink based logging.
464 */
465
466/* Helper for struct drm_device based logging. */
467#define __drm_printk(drm, level, type, fmt, ...) \
468 dev_##level##type((drm) ? (drm)->dev : NULL, "[drm] " fmt, ##__VA_ARGS__)
469
470
471#define drm_info(drm, fmt, ...) \
472 __drm_printk((drm), info,, fmt, ##__VA_ARGS__)
473
474#define drm_notice(drm, fmt, ...) \
475 __drm_printk((drm), notice,, fmt, ##__VA_ARGS__)
476
477#define drm_warn(drm, fmt, ...) \
478 __drm_printk((drm), warn,, fmt, ##__VA_ARGS__)
479
480#define drm_err(drm, fmt, ...) \
481 __drm_printk((drm), err,, "*ERROR* " fmt, ##__VA_ARGS__)
482
483
484#define drm_info_once(drm, fmt, ...) \
485 __drm_printk((drm), info, _once, fmt, ##__VA_ARGS__)
486
487#define drm_notice_once(drm, fmt, ...) \
488 __drm_printk((drm), notice, _once, fmt, ##__VA_ARGS__)
489
490#define drm_warn_once(drm, fmt, ...) \
491 __drm_printk((drm), warn, _once, fmt, ##__VA_ARGS__)
492
493#define drm_err_once(drm, fmt, ...) \
494 __drm_printk((drm), err, _once, "*ERROR* " fmt, ##__VA_ARGS__)
495
496
497#define drm_err_ratelimited(drm, fmt, ...) \
498 __drm_printk((drm), err, _ratelimited, "*ERROR* " fmt, ##__VA_ARGS__)
499
500
501#define drm_dbg_core(drm, fmt, ...) \
502 drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_CORE, fmt, ##__VA_ARGS__)
503#define drm_dbg_driver(drm, fmt, ...) \
504 drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_DRIVER, fmt, ##__VA_ARGS__)
505#define drm_dbg_kms(drm, fmt, ...) \
506 drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_KMS, fmt, ##__VA_ARGS__)
507#define drm_dbg_prime(drm, fmt, ...) \
508 drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_PRIME, fmt, ##__VA_ARGS__)
509#define drm_dbg_atomic(drm, fmt, ...) \
510 drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_ATOMIC, fmt, ##__VA_ARGS__)
511#define drm_dbg_vbl(drm, fmt, ...) \
512 drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_VBL, fmt, ##__VA_ARGS__)
513#define drm_dbg_state(drm, fmt, ...) \
514 drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_STATE, fmt, ##__VA_ARGS__)
515#define drm_dbg_lease(drm, fmt, ...) \
516 drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_LEASE, fmt, ##__VA_ARGS__)
517#define drm_dbg_dp(drm, fmt, ...) \
518 drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_DP, fmt, ##__VA_ARGS__)
519#define drm_dbg_drmres(drm, fmt, ...) \
520 drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_DRMRES, fmt, ##__VA_ARGS__)
521
522#define drm_dbg(drm, fmt, ...) drm_dbg_driver(drm, fmt, ##__VA_ARGS__)
523
524/*
525 * printk based logging
526 *
527 * Prefer drm_device based logging over device or prink based logging.
528 */
529
530__printf(3, 4)
531void ___drm_dbg(struct _ddebug *desc, enum drm_debug_category category, const char *format, ...);
532__printf(1, 2)
533void __drm_err(const char *format, ...);
534
535#if !defined(CONFIG_DRM_USE_DYNAMIC_DEBUG)
536#define __drm_dbg(cat, fmt, ...) ___drm_dbg(NULL, cat, fmt, ##__VA_ARGS__)
537#else
538#define __drm_dbg(cat, fmt, ...) \
539 _dynamic_func_call_cls(cat, fmt, ___drm_dbg, \
540 cat, fmt, ##__VA_ARGS__)
541#endif
542
543/* Macros to make printk easier */
544
545#define _DRM_PRINTK(once, level, fmt, ...) \
546 printk##once(KERN_##level "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
547
548/* NOTE: this is deprecated in favor of pr_info(). */
549#define DRM_INFO(fmt, ...) \
550 _DRM_PRINTK(, INFO, fmt, ##__VA_ARGS__)
551/* NOTE: this is deprecated in favor of pr_notice(). */
552#define DRM_NOTE(fmt, ...) \
553 _DRM_PRINTK(, NOTICE, fmt, ##__VA_ARGS__)
554/* NOTE: this is deprecated in favor of pr_warn(). */
555#define DRM_WARN(fmt, ...) \
556 _DRM_PRINTK(, WARNING, fmt, ##__VA_ARGS__)
557
558/* NOTE: this is deprecated in favor of pr_info_once(). */
559#define DRM_INFO_ONCE(fmt, ...) \
560 _DRM_PRINTK(_once, INFO, fmt, ##__VA_ARGS__)
561/* NOTE: this is deprecated in favor of pr_notice_once(). */
562#define DRM_NOTE_ONCE(fmt, ...) \
563 _DRM_PRINTK(_once, NOTICE, fmt, ##__VA_ARGS__)
564/* NOTE: this is deprecated in favor of pr_warn_once(). */
565#define DRM_WARN_ONCE(fmt, ...) \
566 _DRM_PRINTK(_once, WARNING, fmt, ##__VA_ARGS__)
567
568/* NOTE: this is deprecated in favor of pr_err(). */
569#define DRM_ERROR(fmt, ...) \
570 __drm_err(fmt, ##__VA_ARGS__)
571
572/* NOTE: this is deprecated in favor of pr_err_ratelimited(). */
573#define DRM_ERROR_RATELIMITED(fmt, ...) \
574 DRM_DEV_ERROR_RATELIMITED(NULL, fmt, ##__VA_ARGS__)
575
576/* NOTE: this is deprecated in favor of drm_dbg_core(NULL, ...). */
577#define DRM_DEBUG(fmt, ...) \
578 __drm_dbg(DRM_UT_CORE, fmt, ##__VA_ARGS__)
579
580/* NOTE: this is deprecated in favor of drm_dbg(NULL, ...). */
581#define DRM_DEBUG_DRIVER(fmt, ...) \
582 __drm_dbg(DRM_UT_DRIVER, fmt, ##__VA_ARGS__)
583
584/* NOTE: this is deprecated in favor of drm_dbg_kms(NULL, ...). */
585#define DRM_DEBUG_KMS(fmt, ...) \
586 __drm_dbg(DRM_UT_KMS, fmt, ##__VA_ARGS__)
587
588/* NOTE: this is deprecated in favor of drm_dbg_prime(NULL, ...). */
589#define DRM_DEBUG_PRIME(fmt, ...) \
590 __drm_dbg(DRM_UT_PRIME, fmt, ##__VA_ARGS__)
591
592/* NOTE: this is deprecated in favor of drm_dbg_atomic(NULL, ...). */
593#define DRM_DEBUG_ATOMIC(fmt, ...) \
594 __drm_dbg(DRM_UT_ATOMIC, fmt, ##__VA_ARGS__)
595
596/* NOTE: this is deprecated in favor of drm_dbg_vbl(NULL, ...). */
597#define DRM_DEBUG_VBL(fmt, ...) \
598 __drm_dbg(DRM_UT_VBL, fmt, ##__VA_ARGS__)
599
600/* NOTE: this is deprecated in favor of drm_dbg_lease(NULL, ...). */
601#define DRM_DEBUG_LEASE(fmt, ...) \
602 __drm_dbg(DRM_UT_LEASE, fmt, ##__VA_ARGS__)
603
604/* NOTE: this is deprecated in favor of drm_dbg_dp(NULL, ...). */
605#define DRM_DEBUG_DP(fmt, ...) \
606 __drm_dbg(DRM_UT_DP, fmt, ## __VA_ARGS__)
607
608#define __DRM_DEFINE_DBG_RATELIMITED(category, drm, fmt, ...) \
609({ \
610 static DEFINE_RATELIMIT_STATE(rs_, DEFAULT_RATELIMIT_INTERVAL, DEFAULT_RATELIMIT_BURST);\
611 const struct drm_device *drm_ = (drm); \
612 \
613 if (drm_debug_enabled(DRM_UT_ ## category) && __ratelimit(&rs_)) \
614 drm_dev_printk(drm_ ? drm_->dev : NULL, KERN_DEBUG, fmt, ## __VA_ARGS__); \
615})
616
617#define drm_dbg_ratelimited(drm, fmt, ...) \
618 __DRM_DEFINE_DBG_RATELIMITED(DRIVER, drm, fmt, ## __VA_ARGS__)
619
620#define drm_dbg_kms_ratelimited(drm, fmt, ...) \
621 __DRM_DEFINE_DBG_RATELIMITED(KMS, drm, fmt, ## __VA_ARGS__)
622
623/*
624 * struct drm_device based WARNs
625 *
626 * drm_WARN*() acts like WARN*(), but with the key difference of
627 * using device specific information so that we know from which device
628 * warning is originating from.
629 *
630 * Prefer drm_device based drm_WARN* over regular WARN*
631 */
632
633/* Helper for struct drm_device based WARNs */
634#define drm_WARN(drm, condition, format, arg...) \
635 WARN(condition, "%s %s: " format, \
636 dev_driver_string((drm)->dev), \
637 dev_name((drm)->dev), ## arg)
638
639#define drm_WARN_ONCE(drm, condition, format, arg...) \
640 WARN_ONCE(condition, "%s %s: " format, \
641 dev_driver_string((drm)->dev), \
642 dev_name((drm)->dev), ## arg)
643
644#define drm_WARN_ON(drm, x) \
645 drm_WARN((drm), (x), "%s", \
646 "drm_WARN_ON(" __stringify(x) ")")
647
648#define drm_WARN_ON_ONCE(drm, x) \
649 drm_WARN_ONCE((drm), (x), "%s", \
650 "drm_WARN_ON_ONCE(" __stringify(x) ")")
651
652#endif /* DRM_PRINT_H_ */