xref: /linux/include/drm/drm_print.h (revision a36e9f5cfe9eb3a1dce8769c7058251c42705357)
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/device.h>
32 #include <linux/dynamic_debug.h>
33 
34 #include <drm/drm.h>
35 
36 struct debugfs_regset32;
37 struct drm_device;
38 struct seq_file;
39 
40 /* Do *not* use outside of drm_print.[ch]! */
41 extern 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  */
97 enum 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 
143 static 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  */
173 struct 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 void *origin;
179 	const char *prefix;
180 	enum drm_debug_category category;
181 };
182 
183 void __drm_printfn_coredump(struct drm_printer *p, struct va_format *vaf);
184 void __drm_puts_coredump(struct drm_printer *p, const char *str);
185 void __drm_printfn_seq_file(struct drm_printer *p, struct va_format *vaf);
186 void __drm_puts_seq_file(struct drm_printer *p, const char *str);
187 void __drm_printfn_info(struct drm_printer *p, struct va_format *vaf);
188 void __drm_printfn_dbg(struct drm_printer *p, struct va_format *vaf);
189 void __drm_printfn_err(struct drm_printer *p, struct va_format *vaf);
190 
191 __printf(2, 3)
192 void drm_printf(struct drm_printer *p, const char *f, ...);
193 void drm_puts(struct drm_printer *p, const char *str);
194 void drm_print_regset32(struct drm_printer *p, struct debugfs_regset32 *regset);
195 void drm_print_bits(struct drm_printer *p, unsigned long value,
196 		    const char * const bits[], unsigned int nbits);
197 
198 __printf(2, 0)
199 /**
200  * drm_vprintf - print to a &drm_printer stream
201  * @p: the &drm_printer
202  * @fmt: format string
203  * @va: the va_list
204  */
205 static inline void
206 drm_vprintf(struct drm_printer *p, const char *fmt, va_list *va)
207 {
208 	struct va_format vaf = { .fmt = fmt, .va = va };
209 
210 	p->printfn(p, &vaf);
211 }
212 
213 /**
214  * drm_printf_indent - Print to a &drm_printer stream with indentation
215  * @printer: DRM printer
216  * @indent: Tab indentation level (max 5)
217  * @fmt: Format string
218  */
219 #define drm_printf_indent(printer, indent, fmt, ...) \
220 	drm_printf((printer), "%.*s" fmt, (indent), "\t\t\t\t\tX", ##__VA_ARGS__)
221 
222 /**
223  * struct drm_print_iterator - local struct used with drm_printer_coredump
224  * @data: Pointer to the devcoredump output buffer
225  * @start: The offset within the buffer to start writing
226  * @remain: The number of bytes to write for this iteration
227  */
228 struct drm_print_iterator {
229 	void *data;
230 	ssize_t start;
231 	ssize_t remain;
232 	/* private: */
233 	ssize_t offset;
234 };
235 
236 /**
237  * drm_coredump_printer - construct a &drm_printer that can output to a buffer
238  * from the read function for devcoredump
239  * @iter: A pointer to a struct drm_print_iterator for the read instance
240  *
241  * This wrapper extends drm_printf() to work with a dev_coredumpm() callback
242  * function. The passed in drm_print_iterator struct contains the buffer
243  * pointer, size and offset as passed in from devcoredump.
244  *
245  * For example::
246  *
247  *	void coredump_read(char *buffer, loff_t offset, size_t count,
248  *		void *data, size_t datalen)
249  *	{
250  *		struct drm_print_iterator iter;
251  *		struct drm_printer p;
252  *
253  *		iter.data = buffer;
254  *		iter.start = offset;
255  *		iter.remain = count;
256  *
257  *		p = drm_coredump_printer(&iter);
258  *
259  *		drm_printf(p, "foo=%d\n", foo);
260  *	}
261  *
262  *	void makecoredump(...)
263  *	{
264  *		...
265  *		dev_coredumpm(dev, THIS_MODULE, data, 0, GFP_KERNEL,
266  *			coredump_read, ...)
267  *	}
268  *
269  * RETURNS:
270  * The &drm_printer object
271  */
272 static inline struct drm_printer
273 drm_coredump_printer(struct drm_print_iterator *iter)
274 {
275 	struct drm_printer p = {
276 		.printfn = __drm_printfn_coredump,
277 		.puts = __drm_puts_coredump,
278 		.arg = iter,
279 	};
280 
281 	/* Set the internal offset of the iterator to zero */
282 	iter->offset = 0;
283 
284 	return p;
285 }
286 
287 /**
288  * drm_seq_file_printer - construct a &drm_printer that outputs to &seq_file
289  * @f:  the &struct seq_file to output to
290  *
291  * RETURNS:
292  * The &drm_printer object
293  */
294 static inline struct drm_printer drm_seq_file_printer(struct seq_file *f)
295 {
296 	struct drm_printer p = {
297 		.printfn = __drm_printfn_seq_file,
298 		.puts = __drm_puts_seq_file,
299 		.arg = f,
300 	};
301 	return p;
302 }
303 
304 /**
305  * drm_info_printer - construct a &drm_printer that outputs to dev_printk()
306  * @dev: the &struct device pointer
307  *
308  * RETURNS:
309  * The &drm_printer object
310  */
311 static inline struct drm_printer drm_info_printer(struct device *dev)
312 {
313 	struct drm_printer p = {
314 		.printfn = __drm_printfn_info,
315 		.arg = dev,
316 	};
317 	return p;
318 }
319 
320 /**
321  * drm_dbg_printer - construct a &drm_printer for drm device specific output
322  * @drm: the &struct drm_device pointer, or NULL
323  * @category: the debug category to use
324  * @prefix: debug output prefix, or NULL for no prefix
325  *
326  * RETURNS:
327  * The &drm_printer object
328  */
329 static inline struct drm_printer drm_dbg_printer(struct drm_device *drm,
330 						 enum drm_debug_category category,
331 						 const char *prefix)
332 {
333 	struct drm_printer p = {
334 		.printfn = __drm_printfn_dbg,
335 		.arg = drm,
336 		.origin = (const void *)_THIS_IP_, /* it's fine as we will be inlined */
337 		.prefix = prefix,
338 		.category = category,
339 	};
340 	return p;
341 }
342 
343 /**
344  * drm_err_printer - construct a &drm_printer that outputs to drm_err()
345  * @drm: the &struct drm_device pointer
346  * @prefix: debug output prefix, or NULL for no prefix
347  *
348  * RETURNS:
349  * The &drm_printer object
350  */
351 static inline struct drm_printer drm_err_printer(struct drm_device *drm,
352 						 const char *prefix)
353 {
354 	struct drm_printer p = {
355 		.printfn = __drm_printfn_err,
356 		.arg = drm,
357 		.prefix = prefix
358 	};
359 	return p;
360 }
361 
362 /*
363  * struct device based logging
364  *
365  * Prefer drm_device based logging over device or printk based logging.
366  */
367 
368 __printf(3, 4)
369 void drm_dev_printk(const struct device *dev, const char *level,
370 		    const char *format, ...);
371 struct _ddebug;
372 __printf(4, 5)
373 void __drm_dev_dbg(struct _ddebug *desc, const struct device *dev,
374 		   enum drm_debug_category category, const char *format, ...);
375 
376 /**
377  * DRM_DEV_ERROR() - Error output.
378  *
379  * NOTE: this is deprecated in favor of drm_err() or dev_err().
380  *
381  * @dev: device pointer
382  * @fmt: printf() like format string.
383  */
384 #define DRM_DEV_ERROR(dev, fmt, ...)					\
385 	drm_dev_printk(dev, KERN_ERR, "*ERROR* " fmt, ##__VA_ARGS__)
386 
387 /**
388  * DRM_DEV_ERROR_RATELIMITED() - Rate limited error output.
389  *
390  * NOTE: this is deprecated in favor of drm_err_ratelimited() or
391  * dev_err_ratelimited().
392  *
393  * @dev: device pointer
394  * @fmt: printf() like format string.
395  *
396  * Like DRM_ERROR() but won't flood the log.
397  */
398 #define DRM_DEV_ERROR_RATELIMITED(dev, fmt, ...)			\
399 ({									\
400 	static DEFINE_RATELIMIT_STATE(_rs,				\
401 				      DEFAULT_RATELIMIT_INTERVAL,	\
402 				      DEFAULT_RATELIMIT_BURST);		\
403 									\
404 	if (__ratelimit(&_rs))						\
405 		DRM_DEV_ERROR(dev, fmt, ##__VA_ARGS__);			\
406 })
407 
408 /* NOTE: this is deprecated in favor of drm_info() or dev_info(). */
409 #define DRM_DEV_INFO(dev, fmt, ...)				\
410 	drm_dev_printk(dev, KERN_INFO, fmt, ##__VA_ARGS__)
411 
412 /* NOTE: this is deprecated in favor of drm_info_once() or dev_info_once(). */
413 #define DRM_DEV_INFO_ONCE(dev, fmt, ...)				\
414 ({									\
415 	static bool __print_once __read_mostly;				\
416 	if (!__print_once) {						\
417 		__print_once = true;					\
418 		DRM_DEV_INFO(dev, fmt, ##__VA_ARGS__);			\
419 	}								\
420 })
421 
422 #if !defined(CONFIG_DRM_USE_DYNAMIC_DEBUG)
423 #define drm_dev_dbg(dev, cat, fmt, ...)				\
424 	__drm_dev_dbg(NULL, dev, cat, fmt, ##__VA_ARGS__)
425 #else
426 #define drm_dev_dbg(dev, cat, fmt, ...)				\
427 	_dynamic_func_call_cls(cat, fmt, __drm_dev_dbg,		\
428 			       dev, cat, fmt, ##__VA_ARGS__)
429 #endif
430 
431 /**
432  * DRM_DEV_DEBUG() - Debug output for generic drm code
433  *
434  * NOTE: this is deprecated in favor of drm_dbg_core().
435  *
436  * @dev: device pointer
437  * @fmt: printf() like format string.
438  */
439 #define DRM_DEV_DEBUG(dev, fmt, ...)					\
440 	drm_dev_dbg(dev, DRM_UT_CORE, fmt, ##__VA_ARGS__)
441 /**
442  * DRM_DEV_DEBUG_DRIVER() - Debug output for vendor specific part of the driver
443  *
444  * NOTE: this is deprecated in favor of drm_dbg() or dev_dbg().
445  *
446  * @dev: device pointer
447  * @fmt: printf() like format string.
448  */
449 #define DRM_DEV_DEBUG_DRIVER(dev, fmt, ...)				\
450 	drm_dev_dbg(dev, DRM_UT_DRIVER,	fmt, ##__VA_ARGS__)
451 /**
452  * DRM_DEV_DEBUG_KMS() - Debug output for modesetting code
453  *
454  * NOTE: this is deprecated in favor of drm_dbg_kms().
455  *
456  * @dev: device pointer
457  * @fmt: printf() like format string.
458  */
459 #define DRM_DEV_DEBUG_KMS(dev, fmt, ...)				\
460 	drm_dev_dbg(dev, DRM_UT_KMS, fmt, ##__VA_ARGS__)
461 
462 /*
463  * struct drm_device based logging
464  *
465  * Prefer drm_device based logging over device or prink based logging.
466  */
467 
468 /* Helper for struct drm_device based logging. */
469 #define __drm_printk(drm, level, type, fmt, ...)			\
470 	dev_##level##type((drm) ? (drm)->dev : NULL, "[drm] " fmt, ##__VA_ARGS__)
471 
472 
473 #define drm_info(drm, fmt, ...)					\
474 	__drm_printk((drm), info,, fmt, ##__VA_ARGS__)
475 
476 #define drm_notice(drm, fmt, ...)				\
477 	__drm_printk((drm), notice,, fmt, ##__VA_ARGS__)
478 
479 #define drm_warn(drm, fmt, ...)					\
480 	__drm_printk((drm), warn,, fmt, ##__VA_ARGS__)
481 
482 #define drm_err(drm, fmt, ...)					\
483 	__drm_printk((drm), err,, "*ERROR* " fmt, ##__VA_ARGS__)
484 
485 
486 #define drm_info_once(drm, fmt, ...)				\
487 	__drm_printk((drm), info, _once, fmt, ##__VA_ARGS__)
488 
489 #define drm_notice_once(drm, fmt, ...)				\
490 	__drm_printk((drm), notice, _once, fmt, ##__VA_ARGS__)
491 
492 #define drm_warn_once(drm, fmt, ...)				\
493 	__drm_printk((drm), warn, _once, fmt, ##__VA_ARGS__)
494 
495 #define drm_err_once(drm, fmt, ...)				\
496 	__drm_printk((drm), err, _once, "*ERROR* " fmt, ##__VA_ARGS__)
497 
498 
499 #define drm_err_ratelimited(drm, fmt, ...)				\
500 	__drm_printk((drm), err, _ratelimited, "*ERROR* " fmt, ##__VA_ARGS__)
501 
502 
503 #define drm_dbg_core(drm, fmt, ...)					\
504 	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_CORE, fmt, ##__VA_ARGS__)
505 #define drm_dbg_driver(drm, fmt, ...)						\
506 	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_DRIVER, fmt, ##__VA_ARGS__)
507 #define drm_dbg_kms(drm, fmt, ...)					\
508 	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_KMS, fmt, ##__VA_ARGS__)
509 #define drm_dbg_prime(drm, fmt, ...)					\
510 	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_PRIME, fmt, ##__VA_ARGS__)
511 #define drm_dbg_atomic(drm, fmt, ...)					\
512 	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_ATOMIC, fmt, ##__VA_ARGS__)
513 #define drm_dbg_vbl(drm, fmt, ...)					\
514 	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_VBL, fmt, ##__VA_ARGS__)
515 #define drm_dbg_state(drm, fmt, ...)					\
516 	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_STATE, fmt, ##__VA_ARGS__)
517 #define drm_dbg_lease(drm, fmt, ...)					\
518 	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_LEASE, fmt, ##__VA_ARGS__)
519 #define drm_dbg_dp(drm, fmt, ...)					\
520 	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_DP, fmt, ##__VA_ARGS__)
521 #define drm_dbg_drmres(drm, fmt, ...)					\
522 	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_DRMRES, fmt, ##__VA_ARGS__)
523 
524 #define drm_dbg(drm, fmt, ...)	drm_dbg_driver(drm, fmt, ##__VA_ARGS__)
525 
526 /*
527  * printk based logging
528  *
529  * Prefer drm_device based logging over device or prink based logging.
530  */
531 
532 __printf(1, 2)
533 void __drm_err(const char *format, ...);
534 
535 #if !defined(CONFIG_DRM_USE_DYNAMIC_DEBUG)
536 #define __drm_dbg(cat, fmt, ...)	__drm_dev_dbg(NULL, NULL, cat, fmt, ##__VA_ARGS__)
537 #else
538 #define __drm_dbg(cat, fmt, ...)					\
539 	_dynamic_func_call_cls(cat, fmt, __drm_dev_dbg,			\
540 			       NULL, 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: [drm] " 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: [drm] " 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_ */
653