[mirror_ubuntu-jammy-kernel.git] / include / drm / drm_print.h

/*
 * Copyright (C) 2016 Red Hat
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 * Authors:
 * Rob Clark <robdclark@gmail.com>
 */

#ifndef DRM_PRINT_H_
#define DRM_PRINT_H_

#include <linux/compiler.h>
#include <linux/printk.h>
#include <linux/seq_file.h>
#include <linux/device.h>

/**
 * DOC: print
 *
 * A simple wrapper for dev_printk(), seq_printf(), etc.  Allows same
 * debug code to be used for both debugfs and printk logging.
 *
 * For example::
 *
 *     void log_some_info(struct drm_printer *p)
 *     {
 *             drm_printf(p, "foo=%d\n", foo);
 *             drm_printf(p, "bar=%d\n", bar);
 *     }
 *
 *     #ifdef CONFIG_DEBUG_FS
 *     void debugfs_show(struct seq_file *f)
 *     {
 *             struct drm_printer p = drm_seq_file_printer(f);
 *             log_some_info(&p);
 *     }
 *     #endif
 *
 *     void some_other_function(...)
 *     {
 *             struct drm_printer p = drm_info_printer(drm->dev);
 *             log_some_info(&p);
 *     }
 */

/**
 * struct drm_printer - drm output "stream"
 *
 * Do not use struct members directly.  Use drm_printer_seq_file(),
 * drm_printer_info(), etc to initialize.  And drm_printf() for output.
 */
struct drm_printer {
	/* private: */
	void (*printfn)(struct drm_printer *p, struct va_format *vaf);
	void *arg;
	const char *prefix;
};

void __drm_printfn_seq_file(struct drm_printer *p, struct va_format *vaf);
void __drm_printfn_info(struct drm_printer *p, struct va_format *vaf);
void __drm_printfn_debug(struct drm_printer *p, struct va_format *vaf);

__printf(2, 3)
void drm_printf(struct drm_printer *p, const char *f, ...);

__printf(2, 0)
/**
 * drm_vprintf - print to a &drm_printer stream
 * @p: the &drm_printer
 * @fmt: format string
 * @va: the va_list
 */
static inline void
drm_vprintf(struct drm_printer *p, const char *fmt, va_list *va)
{
	struct va_format vaf = { .fmt = fmt, .va = va };

	p->printfn(p, &vaf);
}

/**
 * drm_printf_indent - Print to a &drm_printer stream with indentation
 * @printer: DRM printer
 * @indent: Tab indentation level (max 5)
 * @fmt: Format string
 */
#define drm_printf_indent(printer, indent, fmt, ...) \
	drm_printf((printer), "%.*s" fmt, (indent), "\t\t\t\t\tX", ##__VA_ARGS__)

/**
 * drm_seq_file_printer - construct a &drm_printer that outputs to &seq_file
 * @f:  the &struct seq_file to output to
 *
 * RETURNS:
 * The &drm_printer object
 */
static inline struct drm_printer drm_seq_file_printer(struct seq_file *f)
{
	struct drm_printer p = {
		.printfn = __drm_printfn_seq_file,
		.arg = f,
	};
	return p;
}

/**
 * drm_info_printer - construct a &drm_printer that outputs to dev_printk()
 * @dev: the &struct device pointer
 *
 * RETURNS:
 * The &drm_printer object
 */
static inline struct drm_printer drm_info_printer(struct device *dev)
{
	struct drm_printer p = {
		.printfn = __drm_printfn_info,
		.arg = dev,
	};
	return p;
}

/**
 * drm_debug_printer - construct a &drm_printer that outputs to pr_debug()
 * @prefix: debug output prefix
 *
 * RETURNS:
 * The &drm_printer object
 */
static inline struct drm_printer drm_debug_printer(const char *prefix)
{
	struct drm_printer p = {
		.printfn = __drm_printfn_debug,
		.prefix = prefix
	};
	return p;
}

/*
 * The following categories are defined:
 *
 * CORE: Used in the generic drm code: drm_ioctl.c, drm_mm.c, drm_memory.c, ...
 *	 This is the category used by the DRM_DEBUG() macro.
 *
 * DRIVER: Used in the vendor specific part of the driver: i915, radeon, ...
 *	   This is the category used by the DRM_DEBUG_DRIVER() macro.
 *
 * KMS: used in the modesetting code.
 *	This is the category used by the DRM_DEBUG_KMS() macro.
 *
 * PRIME: used in the prime code.
 *	  This is the category used by the DRM_DEBUG_PRIME() macro.
 *
 * ATOMIC: used in the atomic code.
 *	  This is the category used by the DRM_DEBUG_ATOMIC() macro.
 *
 * VBL: used for verbose debug message in the vblank code
 *	  This is the category used by the DRM_DEBUG_VBL() macro.
 *
 * Enabling verbose debug messages is done through the drm.debug parameter,
 * each category being enabled by a bit.
 *
 * drm.debug=0x1 will enable CORE messages
 * drm.debug=0x2 will enable DRIVER messages
 * drm.debug=0x3 will enable CORE and DRIVER messages
 * ...
 * drm.debug=0x3f will enable all messages
 *
 * An interesting feature is that it's possible to enable verbose logging at
 * run-time by echoing the debug value in its sysfs node:
 *   # echo 0xf > /sys/module/drm/parameters/debug
 */
#define DRM_UT_NONE		0x00
#define DRM_UT_CORE		0x01
#define DRM_UT_DRIVER		0x02
#define DRM_UT_KMS		0x04
#define DRM_UT_PRIME		0x08
#define DRM_UT_ATOMIC		0x10
#define DRM_UT_VBL		0x20
#define DRM_UT_STATE		0x40
#define DRM_UT_LEASE		0x80

__printf(6, 7)
void drm_dev_printk(const struct device *dev, const char *level,
		    unsigned int category, const char *function_name,
		    const char *prefix, const char *format, ...);
__printf(2, 3)
void drm_dbg(unsigned int category, const char *format, ...);
__printf(1, 2)
void drm_err(const char *format, ...);

/* Macros to make printk easier */

#define _DRM_PRINTK(once, level, fmt, ...)				\
	do {								\
		printk##once(KERN_##level "[" DRM_NAME "] " fmt,	\
			     ##__VA_ARGS__);				\
	} while (0)

#define DRM_INFO(fmt, ...)						\
	_DRM_PRINTK(, INFO, fmt, ##__VA_ARGS__)
#define DRM_NOTE(fmt, ...)						\
	_DRM_PRINTK(, NOTICE, fmt, ##__VA_ARGS__)
#define DRM_WARN(fmt, ...)						\
	_DRM_PRINTK(, WARNING, fmt, ##__VA_ARGS__)

#define DRM_INFO_ONCE(fmt, ...)						\
	_DRM_PRINTK(_once, INFO, fmt, ##__VA_ARGS__)
#define DRM_NOTE_ONCE(fmt, ...)						\
	_DRM_PRINTK(_once, NOTICE, fmt, ##__VA_ARGS__)
#define DRM_WARN_ONCE(fmt, ...)						\
	_DRM_PRINTK(_once, WARNING, fmt, ##__VA_ARGS__)

/**
 * Error output.
 *
 * @dev: device pointer
 * @fmt: printf() like format string.
 */
#define DRM_DEV_ERROR(dev, fmt, ...)					\
	drm_dev_printk(dev, KERN_ERR, DRM_UT_NONE, __func__, " *ERROR*",\
		       fmt, ##__VA_ARGS__)
#define DRM_ERROR(fmt, ...)						\
	drm_err(fmt, ##__VA_ARGS__)

/**
 * Rate limited error output.  Like DRM_ERROR() but won't flood the log.
 *
 * @dev: device pointer
 * @fmt: printf() like format string.
 */
#define DRM_DEV_ERROR_RATELIMITED(dev, fmt, ...)			\
({									\
	static DEFINE_RATELIMIT_STATE(_rs,				\
				      DEFAULT_RATELIMIT_INTERVAL,	\
				      DEFAULT_RATELIMIT_BURST);		\
									\
	if (__ratelimit(&_rs))						\
		DRM_DEV_ERROR(dev, fmt, ##__VA_ARGS__);			\
})
#define DRM_ERROR_RATELIMITED(fmt, ...)					\
	DRM_DEV_ERROR_RATELIMITED(NULL, fmt, ##__VA_ARGS__)

#define DRM_DEV_INFO(dev, fmt, ...)					\
	drm_dev_printk(dev, KERN_INFO, DRM_UT_NONE, __func__, "", fmt,	\
		       ##__VA_ARGS__)

#define DRM_DEV_INFO_ONCE(dev, fmt, ...)				\
({									\
	static bool __print_once __read_mostly;				\
	if (!__print_once) {						\
		__print_once = true;					\
		DRM_DEV_INFO(dev, fmt, ##__VA_ARGS__);			\
	}								\
})

/**
 * Debug output.
 *
 * @dev: device pointer
 * @fmt: printf() like format string.
 */
#define DRM_DEV_DEBUG(dev, fmt, args...)				\
	drm_dev_printk(dev, KERN_DEBUG, DRM_UT_CORE, __func__, "", fmt,	\
		       ##args)
#define DRM_DEBUG(fmt, ...)						\
	drm_dbg(DRM_UT_CORE, fmt, ##__VA_ARGS__)

#define DRM_DEV_DEBUG_DRIVER(dev, fmt, args...)				\
	drm_dev_printk(dev, KERN_DEBUG, DRM_UT_DRIVER, __func__, "",	\
		       fmt, ##args)
#define DRM_DEBUG_DRIVER(fmt, ...)					\
	drm_dbg(DRM_UT_DRIVER, fmt, ##__VA_ARGS__)

#define DRM_DEV_DEBUG_KMS(dev, fmt, args...)				\
	drm_dev_printk(dev, KERN_DEBUG, DRM_UT_KMS, __func__, "", fmt,	\
		       ##args)
#define DRM_DEBUG_KMS(fmt, ...)						\
	drm_dbg(DRM_UT_KMS, fmt, ##__VA_ARGS__)

#define DRM_DEV_DEBUG_PRIME(dev, fmt, args...)				\
	drm_dev_printk(dev, KERN_DEBUG, DRM_UT_PRIME, __func__, "",	\
		       fmt, ##args)
#define DRM_DEBUG_PRIME(fmt, ...)					\
	drm_dbg(DRM_UT_PRIME, fmt, ##__VA_ARGS__)

#define DRM_DEV_DEBUG_ATOMIC(dev, fmt, args...)				\
	drm_dev_printk(dev, KERN_DEBUG, DRM_UT_ATOMIC, __func__, "",	\
		       fmt, ##args)
#define DRM_DEBUG_ATOMIC(fmt, ...)					\
	drm_dbg(DRM_UT_ATOMIC, fmt, ##__VA_ARGS__)

#define DRM_DEV_DEBUG_VBL(dev, fmt, args...)				\
	drm_dev_printk(dev, KERN_DEBUG, DRM_UT_VBL, __func__, "", fmt,	\
		       ##args)
#define DRM_DEBUG_VBL(fmt, ...)						\
	drm_dbg(DRM_UT_VBL, fmt, ##__VA_ARGS__)

#define DRM_DEBUG_LEASE(fmt, ...)					\
	drm_dbg(DRM_UT_LEASE, fmt, ##__VA_ARGS__)

#define _DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, level, fmt, args...)	\
({									\
	static DEFINE_RATELIMIT_STATE(_rs,				\
				      DEFAULT_RATELIMIT_INTERVAL,	\
				      DEFAULT_RATELIMIT_BURST);		\
	if (__ratelimit(&_rs))						\
		drm_dev_printk(dev, KERN_DEBUG, DRM_UT_ ## level,	\
			       __func__, "", fmt, ##args);		\
})

/**
 * Rate limited debug output. Like DRM_DEBUG() but won't flood the log.
 *
 * @dev: device pointer
 * @fmt: printf() like format string.
 */
#define DRM_DEV_DEBUG_RATELIMITED(dev, fmt, args...)			\
	DEV__DRM_DEFINE_DEBUG_RATELIMITED(dev, CORE, fmt, ##args)
#define DRM_DEBUG_RATELIMITED(fmt, args...)				\
	DRM_DEV_DEBUG_RATELIMITED(NULL, fmt, ##args)
#define DRM_DEV_DEBUG_DRIVER_RATELIMITED(dev, fmt, args...)		\
	_DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, DRIVER, fmt, ##args)
#define DRM_DEBUG_DRIVER_RATELIMITED(fmt, args...)			\
	DRM_DEV_DEBUG_DRIVER_RATELIMITED(NULL, fmt, ##args)
#define DRM_DEV_DEBUG_KMS_RATELIMITED(dev, fmt, args...)		\
	_DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, KMS, fmt, ##args)
#define DRM_DEBUG_KMS_RATELIMITED(fmt, args...)				\
	DRM_DEV_DEBUG_KMS_RATELIMITED(NULL, fmt, ##args)
#define DRM_DEV_DEBUG_PRIME_RATELIMITED(dev, fmt, args...)		\
	_DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, PRIME, fmt, ##args)
#define DRM_DEBUG_PRIME_RATELIMITED(fmt, args...)			\
	DRM_DEV_DEBUG_PRIME_RATELIMITED(NULL, fmt, ##args)

#endif /* DRM_PRINT_H_ */
Commit	Line	Data
d8187177 RC	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
3c6d6e0f JP	29	#include <linux/compiler.h>
3c6d6e0f JP	30	#include <linux/printk.h>
d8187177 RC	31	#include <linux/seq_file.h>
	32	#include <linux/device.h>
	33
	34	/**
	35	* DOC: print
	36	*
	37	* A simple wrapper for dev_printk(), seq_printf(), etc. Allows same
	38	* debug code to be used for both debugfs and printk logging.
	39	*
	40	* For example::
	41	*
	42	* void log_some_info(struct drm_printer *p)
	43	* {
	44	* drm_printf(p, "foo=%d\n", foo);
	45	* drm_printf(p, "bar=%d\n", bar);
	46	* }
	47	*
	48	* #ifdef CONFIG_DEBUG_FS
	49	* void debugfs_show(struct seq_file *f)
	50	* {
	51	* struct drm_printer p = drm_seq_file_printer(f);
	52	* log_some_info(&p);
	53	* }
	54	* #endif
	55	*
	56	* void some_other_function(...)
	57	* {
	58	* struct drm_printer p = drm_info_printer(drm->dev);
	59	* log_some_info(&p);
	60	* }
	61	*/
	62
	63	/**
	64	* struct drm_printer - drm output "stream"
d8187177 RC	65	*
	66	* Do not use struct members directly. Use drm_printer_seq_file(),
	67	* drm_printer_info(), etc to initialize. And drm_printf() for output.
	68	*/
	69	struct drm_printer {
3d387d92	70	/* private: */
d8187177 RC	71	void (printfn)(struct drm_printer p, struct va_format *vaf);
d8187177 RC	72	void *arg;
3d387d92	73	const char *prefix;
d8187177 RC	74	};
	75
	76	void __drm_printfn_seq_file(struct drm_printer p, struct va_format vaf);
	77	void __drm_printfn_info(struct drm_printer p, struct va_format vaf);
3d387d92	78	void __drm_printfn_debug(struct drm_printer p, struct va_format vaf);
d8187177	79
3c6d6e0f	80	__printf(2, 3)
d8187177 RC	81	void drm_printf(struct drm_printer p, const char f, ...);
d8187177 RC	82
42f1b310	83	__printf(2, 0)
e2b155e9 CW	84	/**
	85	* drm_vprintf - print to a &drm_printer stream
	86	* @p: the &drm_printer
	87	* @fmt: format string
	88	* @va: the va_list
	89	*/
e2b155e9 CW	90	static inline void
	91	drm_vprintf(struct drm_printer p, const char fmt, va_list *va)
	92	{
	93	struct va_format vaf = { .fmt = fmt, .va = va };
	94
	95	p->printfn(p, &vaf);
	96	}
	97
bf6234a2 NT	98	/**
	99	* drm_printf_indent - Print to a &drm_printer stream with indentation
	100	* @printer: DRM printer
	101	* @indent: Tab indentation level (max 5)
	102	* @fmt: Format string
	103	*/
	104	#define drm_printf_indent(printer, indent, fmt, ...) \
	105	drm_printf((printer), "%.*s" fmt, (indent), "\t\t\t\t\tX", ##__VA_ARGS__)
d8187177 RC	106
	107	/**
	108	* drm_seq_file_printer - construct a &drm_printer that outputs to &seq_file
ea0dd85a	109	* @f: the &struct seq_file to output to
d8187177 RC	110	*
	111	* RETURNS:
	112	* The &drm_printer object
	113	*/
	114	static inline struct drm_printer drm_seq_file_printer(struct seq_file *f)
	115	{
	116	struct drm_printer p = {
	117	.printfn = __drm_printfn_seq_file,
	118	.arg = f,
	119	};
	120	return p;
	121	}
	122
	123	/**
	124	* drm_info_printer - construct a &drm_printer that outputs to dev_printk()
ea0dd85a	125	* @dev: the &struct device pointer
d8187177 RC	126	*
	127	* RETURNS:
	128	* The &drm_printer object
	129	*/
	130	static inline struct drm_printer drm_info_printer(struct device *dev)
	131	{
	132	struct drm_printer p = {
	133	.printfn = __drm_printfn_info,
	134	.arg = dev,
	135	};
	136	return p;
	137	}
	138
3d387d92 DV	139	/**
	140	* drm_debug_printer - construct a &drm_printer that outputs to pr_debug()
	141	* @prefix: debug output prefix
	142	*
	143	* RETURNS:
	144	* The &drm_printer object
	145	*/
	146	static inline struct drm_printer drm_debug_printer(const char *prefix)
	147	{
	148	struct drm_printer p = {
	149	.printfn = __drm_printfn_debug,
	150	.prefix = prefix
	151	};
	152	return p;
	153	}
02c9656b HM	154
	155	/*
	156	* The following categories are defined:
	157	*
	158	* CORE: Used in the generic drm code: drm_ioctl.c, drm_mm.c, drm_memory.c, ...
	159	* This is the category used by the DRM_DEBUG() macro.
	160	*
	161	* DRIVER: Used in the vendor specific part of the driver: i915, radeon, ...
	162	* This is the category used by the DRM_DEBUG_DRIVER() macro.
	163	*
	164	* KMS: used in the modesetting code.
	165	* This is the category used by the DRM_DEBUG_KMS() macro.
	166	*
	167	* PRIME: used in the prime code.
	168	* This is the category used by the DRM_DEBUG_PRIME() macro.
	169	*
	170	* ATOMIC: used in the atomic code.
	171	* This is the category used by the DRM_DEBUG_ATOMIC() macro.
	172	*
	173	* VBL: used for verbose debug message in the vblank code
	174	* This is the category used by the DRM_DEBUG_VBL() macro.
	175	*
	176	* Enabling verbose debug messages is done through the drm.debug parameter,
	177	* each category being enabled by a bit.
	178	*
	179	* drm.debug=0x1 will enable CORE messages
	180	* drm.debug=0x2 will enable DRIVER messages
	181	* drm.debug=0x3 will enable CORE and DRIVER messages
	182	* ...
	183	* drm.debug=0x3f will enable all messages
	184	*
	185	* An interesting feature is that it's possible to enable verbose logging at
	186	* run-time by echoing the debug value in its sysfs node:
	187	* # echo 0xf > /sys/module/drm/parameters/debug
	188	*/
	189	#define DRM_UT_NONE 0x00
	190	#define DRM_UT_CORE 0x01
	191	#define DRM_UT_DRIVER 0x02
	192	#define DRM_UT_KMS 0x04
	193	#define DRM_UT_PRIME 0x08
	194	#define DRM_UT_ATOMIC 0x10
	195	#define DRM_UT_VBL 0x20
	196	#define DRM_UT_STATE 0x40
70c5f936	197	#define DRM_UT_LEASE 0x80
02c9656b HM	198
	199	__printf(6, 7)
	200	void drm_dev_printk(const struct device dev, const char level,
	201	unsigned int category, const char *function_name,
	202	const char prefix, const char format, ...);
99a95487 JP	203	__printf(2, 3)
	204	void drm_dbg(unsigned int category, const char *format, ...);
	205	__printf(1, 2)
	206	void drm_err(const char *format, ...);
091756bb HM	207
091756bb HM	208	/* Macros to make printk easier */
02c9656b HM	209
	210	#define _DRM_PRINTK(once, level, fmt, ...) \
	211	do { \
	212	printk##once(KERN_##level "[" DRM_NAME "] " fmt, \
	213	##__VA_ARGS__); \
	214	} while (0)
	215
	216	#define DRM_INFO(fmt, ...) \
	217	_DRM_PRINTK(, INFO, fmt, ##__VA_ARGS__)
	218	#define DRM_NOTE(fmt, ...) \
	219	_DRM_PRINTK(, NOTICE, fmt, ##__VA_ARGS__)
	220	#define DRM_WARN(fmt, ...) \
	221	_DRM_PRINTK(, WARNING, fmt, ##__VA_ARGS__)
	222
	223	#define DRM_INFO_ONCE(fmt, ...) \
	224	_DRM_PRINTK(_once, INFO, fmt, ##__VA_ARGS__)
	225	#define DRM_NOTE_ONCE(fmt, ...) \
	226	_DRM_PRINTK(_once, NOTICE, fmt, ##__VA_ARGS__)
	227	#define DRM_WARN_ONCE(fmt, ...) \
	228	_DRM_PRINTK(_once, WARNING, fmt, ##__VA_ARGS__)
	229
	230	/**
	231	* Error output.
	232	*
091756bb HM	233	* @dev: device pointer
091756bb HM	234	* @fmt: printf() like format string.
02c9656b HM	235	*/
	236	#define DRM_DEV_ERROR(dev, fmt, ...) \
	237	drm_dev_printk(dev, KERN_ERR, DRM_UT_NONE, __func__, " ERROR",\
	238	fmt, ##__VA_ARGS__)
	239	#define DRM_ERROR(fmt, ...) \
99a95487	240	drm_err(fmt, ##__VA_ARGS__)
02c9656b HM	241
	242	/**
	243	* Rate limited error output. Like DRM_ERROR() but won't flood the log.
	244	*
091756bb HM	245	* @dev: device pointer
091756bb HM	246	* @fmt: printf() like format string.
02c9656b HM	247	*/
	248	#define DRM_DEV_ERROR_RATELIMITED(dev, fmt, ...) \
	249	({ \
	250	static DEFINE_RATELIMIT_STATE(_rs, \
	251	DEFAULT_RATELIMIT_INTERVAL, \
	252	DEFAULT_RATELIMIT_BURST); \
	253	\
	254	if (__ratelimit(&_rs)) \
	255	DRM_DEV_ERROR(dev, fmt, ##__VA_ARGS__); \
	256	})
	257	#define DRM_ERROR_RATELIMITED(fmt, ...) \
	258	DRM_DEV_ERROR_RATELIMITED(NULL, fmt, ##__VA_ARGS__)
	259
	260	#define DRM_DEV_INFO(dev, fmt, ...) \
	261	drm_dev_printk(dev, KERN_INFO, DRM_UT_NONE, __func__, "", fmt, \
	262	##__VA_ARGS__)
	263
	264	#define DRM_DEV_INFO_ONCE(dev, fmt, ...) \
	265	({ \
	266	static bool __print_once __read_mostly; \
	267	if (!__print_once) { \
	268	__print_once = true; \
	269	DRM_DEV_INFO(dev, fmt, ##__VA_ARGS__); \
	270	} \
	271	})
	272
	273	/**
	274	* Debug output.
	275	*
091756bb HM	276	* @dev: device pointer
091756bb HM	277	* @fmt: printf() like format string.
02c9656b HM	278	*/
	279	#define DRM_DEV_DEBUG(dev, fmt, args...) \
	280	drm_dev_printk(dev, KERN_DEBUG, DRM_UT_CORE, __func__, "", fmt, \
	281	##args)
	282	#define DRM_DEBUG(fmt, ...) \
99a95487	283	drm_dbg(DRM_UT_CORE, fmt, ##__VA_ARGS__)
02c9656b HM	284
	285	#define DRM_DEV_DEBUG_DRIVER(dev, fmt, args...) \
	286	drm_dev_printk(dev, KERN_DEBUG, DRM_UT_DRIVER, __func__, "", \
	287	fmt, ##args)
	288	#define DRM_DEBUG_DRIVER(fmt, ...) \
99a95487	289	drm_dbg(DRM_UT_DRIVER, fmt, ##__VA_ARGS__)
02c9656b HM	290
	291	#define DRM_DEV_DEBUG_KMS(dev, fmt, args...) \
	292	drm_dev_printk(dev, KERN_DEBUG, DRM_UT_KMS, __func__, "", fmt, \
	293	##args)
99a95487 JP	294	#define DRM_DEBUG_KMS(fmt, ...) \
99a95487 JP	295	drm_dbg(DRM_UT_KMS, fmt, ##__VA_ARGS__)
02c9656b HM	296
	297	#define DRM_DEV_DEBUG_PRIME(dev, fmt, args...) \
	298	drm_dev_printk(dev, KERN_DEBUG, DRM_UT_PRIME, __func__, "", \
	299	fmt, ##args)
	300	#define DRM_DEBUG_PRIME(fmt, ...) \
99a95487	301	drm_dbg(DRM_UT_PRIME, fmt, ##__VA_ARGS__)
02c9656b HM	302
	303	#define DRM_DEV_DEBUG_ATOMIC(dev, fmt, args...) \
	304	drm_dev_printk(dev, KERN_DEBUG, DRM_UT_ATOMIC, __func__, "", \
	305	fmt, ##args)
	306	#define DRM_DEBUG_ATOMIC(fmt, ...) \
99a95487	307	drm_dbg(DRM_UT_ATOMIC, fmt, ##__VA_ARGS__)
02c9656b HM	308
	309	#define DRM_DEV_DEBUG_VBL(dev, fmt, args...) \
	310	drm_dev_printk(dev, KERN_DEBUG, DRM_UT_VBL, __func__, "", fmt, \
	311	##args)
99a95487 JP	312	#define DRM_DEBUG_VBL(fmt, ...) \
99a95487 JP	313	drm_dbg(DRM_UT_VBL, fmt, ##__VA_ARGS__)
02c9656b	314
70c5f936	315	#define DRM_DEBUG_LEASE(fmt, ...) \
99a95487	316	drm_dbg(DRM_UT_LEASE, fmt, ##__VA_ARGS__)
70c5f936	317
02c9656b HM	318	#define _DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, level, fmt, args...) \
	319	({ \
	320	static DEFINE_RATELIMIT_STATE(_rs, \
	321	DEFAULT_RATELIMIT_INTERVAL, \
	322	DEFAULT_RATELIMIT_BURST); \
	323	if (__ratelimit(&_rs)) \
	324	drm_dev_printk(dev, KERN_DEBUG, DRM_UT_ ## level, \
	325	__func__, "", fmt, ##args); \
	326	})
	327
	328	/**
	329	* Rate limited debug output. Like DRM_DEBUG() but won't flood the log.
	330	*
091756bb HM	331	* @dev: device pointer
091756bb HM	332	* @fmt: printf() like format string.
02c9656b HM	333	*/
	334	#define DRM_DEV_DEBUG_RATELIMITED(dev, fmt, args...) \
	335	DEV__DRM_DEFINE_DEBUG_RATELIMITED(dev, CORE, fmt, ##args)
	336	#define DRM_DEBUG_RATELIMITED(fmt, args...) \
	337	DRM_DEV_DEBUG_RATELIMITED(NULL, fmt, ##args)
	338	#define DRM_DEV_DEBUG_DRIVER_RATELIMITED(dev, fmt, args...) \
	339	_DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, DRIVER, fmt, ##args)
	340	#define DRM_DEBUG_DRIVER_RATELIMITED(fmt, args...) \
	341	DRM_DEV_DEBUG_DRIVER_RATELIMITED(NULL, fmt, ##args)
	342	#define DRM_DEV_DEBUG_KMS_RATELIMITED(dev, fmt, args...) \
	343	_DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, KMS, fmt, ##args)
	344	#define DRM_DEBUG_KMS_RATELIMITED(fmt, args...) \
	345	DRM_DEV_DEBUG_KMS_RATELIMITED(NULL, fmt, ##args)
	346	#define DRM_DEV_DEBUG_PRIME_RATELIMITED(dev, fmt, args...) \
	347	_DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, PRIME, fmt, ##args)
	348	#define DRM_DEBUG_PRIME_RATELIMITED(fmt, args...) \
	349	DRM_DEV_DEBUG_PRIME_RATELIMITED(NULL, fmt, ##args)
	350
d8187177	351	#endif /* DRM_PRINT_H_ */