[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>
#include <linux/debugfs.h>

#include <drm/drm.h>

/* Do *not* use outside of drm_print.[ch]! */
extern unsigned int __drm_debug;

/**
 * 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 (*puts)(struct drm_printer *p, const char *str);
	void *arg;
	const char *prefix;
};

void __drm_printfn_coredump(struct drm_printer *p, struct va_format *vaf);
void __drm_puts_coredump(struct drm_printer *p, const char *str);
void __drm_printfn_seq_file(struct drm_printer *p, struct va_format *vaf);
void __drm_puts_seq_file(struct drm_printer *p, const char *str);
void __drm_printfn_info(struct drm_printer *p, struct va_format *vaf);
void __drm_printfn_debug(struct drm_printer *p, struct va_format *vaf);
void __drm_printfn_err(struct drm_printer *p, struct va_format *vaf);

__printf(2, 3)
void drm_printf(struct drm_printer *p, const char *f, ...);
void drm_puts(struct drm_printer *p, const char *str);
void drm_print_regset32(struct drm_printer *p, struct debugfs_regset32 *regset);
void drm_print_bits(struct drm_printer *p, unsigned long value,
		    const char * const bits[], unsigned int nbits);

__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__)

/**
 * struct drm_print_iterator - local struct used with drm_printer_coredump
 * @data: Pointer to the devcoredump output buffer
 * @start: The offset within the buffer to start writing
 * @remain: The number of bytes to write for this iteration
 */
struct drm_print_iterator {
	void *data;
	ssize_t start;
	ssize_t remain;
	/* private: */
	ssize_t offset;
};

/**
 * drm_coredump_printer - construct a &drm_printer that can output to a buffer
 * from the read function for devcoredump
 * @iter: A pointer to a struct drm_print_iterator for the read instance
 *
 * This wrapper extends drm_printf() to work with a dev_coredumpm() callback
 * function. The passed in drm_print_iterator struct contains the buffer
 * pointer, size and offset as passed in from devcoredump.
 *
 * For example::
 *
 *	void coredump_read(char *buffer, loff_t offset, size_t count,
 *		void *data, size_t datalen)
 *	{
 *		struct drm_print_iterator iter;
 *		struct drm_printer p;
 *
 *		iter.data = buffer;
 *		iter.start = offset;
 *		iter.remain = count;
 *
 *		p = drm_coredump_printer(&iter);
 *
 *		drm_printf(p, "foo=%d\n", foo);
 *	}
 *
 *	void makecoredump(...)
 *	{
 *		...
 *		dev_coredumpm(dev, THIS_MODULE, data, 0, GFP_KERNEL,
 *			coredump_read, ...)
 *	}
 *
 * RETURNS:
 * The &drm_printer object
 */
static inline struct drm_printer
drm_coredump_printer(struct drm_print_iterator *iter)
{
	struct drm_printer p = {
		.printfn = __drm_printfn_coredump,
		.puts = __drm_puts_coredump,
		.arg = iter,
	};

	/* Set the internal offset of the iterator to zero */
	iter->offset = 0;

	return p;
}

/**
 * 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,
		.puts = __drm_puts_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;
}

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

/**
 * enum drm_debug_category - The DRM debug categories
 *
 * Each of the DRM debug logging macros use a specific category, and the logging
 * is filtered by the drm.debug module parameter. This enum specifies the values
 * for the interface.
 *
 * Each DRM_DEBUG_<CATEGORY> macro logs to DRM_UT_<CATEGORY> category, except
 * DRM_DEBUG() logs to DRM_UT_CORE.
 *
 * 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=0x1ff 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
 *
 */
enum drm_debug_category {
	/**
	 * @DRM_UT_CORE: Used in the generic drm code: drm_ioctl.c, drm_mm.c,
	 * drm_memory.c, ...
	 */
	DRM_UT_CORE		= 0x01,
	/**
	 * @DRM_UT_DRIVER: Used in the vendor specific part of the driver: i915,
	 * radeon, ... macro.
	 */
	DRM_UT_DRIVER		= 0x02,
	/**
	 * @DRM_UT_KMS: Used in the modesetting code.
	 */
	DRM_UT_KMS		= 0x04,
	/**
	 * @DRM_UT_PRIME: Used in the prime code.
	 */
	DRM_UT_PRIME		= 0x08,
	/**
	 * @DRM_UT_ATOMIC: Used in the atomic code.
	 */
	DRM_UT_ATOMIC		= 0x10,
	/**
	 * @DRM_UT_VBL: Used for verbose debug message in the vblank code.
	 */
	DRM_UT_VBL		= 0x20,
	/**
	 * @DRM_UT_STATE: Used for verbose atomic state debugging.
	 */
	DRM_UT_STATE		= 0x40,
	/**
	 * @DRM_UT_LEASE: Used in the lease code.
	 */
	DRM_UT_LEASE		= 0x80,
	/**
	 * @DRM_UT_DP: Used in the DP code.
	 */
	DRM_UT_DP		= 0x100,
	/**
	 * @DRM_UT_DRMRES: Used in the drm managed resources code.
	 */
	DRM_UT_DRMRES		= 0x200,
};

static inline bool drm_debug_enabled(enum drm_debug_category category)
{
	return unlikely(__drm_debug & category);
}

/*
 * struct device based logging
 *
 * Prefer drm_device based logging over device or printk based logging.
 */

__printf(3, 4)
void drm_dev_printk(const struct device *dev, const char *level,
		    const char *format, ...);
__printf(3, 4)
void drm_dev_dbg(const struct device *dev, enum drm_debug_category category,
		 const char *format, ...);

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

/**
 * DRM_DEV_ERROR_RATELIMITED() - Rate limited error output.
 *
 * @dev: device pointer
 * @fmt: printf() like format string.
 *
 * Like DRM_ERROR() but won't flood the log.
 */
#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_DEV_INFO(dev, fmt, ...)				\
	drm_dev_printk(dev, KERN_INFO, 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__);			\
	}								\
})

/**
 * DRM_DEV_DEBUG() - Debug output for generic drm code
 *
 * @dev: device pointer
 * @fmt: printf() like format string.
 */
#define DRM_DEV_DEBUG(dev, fmt, ...)					\
	drm_dev_dbg(dev, DRM_UT_CORE, fmt, ##__VA_ARGS__)
/**
 * DRM_DEV_DEBUG_DRIVER() - Debug output for vendor specific part of the driver
 *
 * @dev: device pointer
 * @fmt: printf() like format string.
 */
#define DRM_DEV_DEBUG_DRIVER(dev, fmt, ...)				\
	drm_dev_dbg(dev, DRM_UT_DRIVER,	fmt, ##__VA_ARGS__)
/**
 * DRM_DEV_DEBUG_KMS() - Debug output for modesetting code
 *
 * @dev: device pointer
 * @fmt: printf() like format string.
 */
#define DRM_DEV_DEBUG_KMS(dev, fmt, ...)				\
	drm_dev_dbg(dev, DRM_UT_KMS, fmt, ##__VA_ARGS__)

/*
 * struct drm_device based logging
 *
 * Prefer drm_device based logging over device or prink based logging.
 */

/* Helper for struct drm_device based logging. */
#define __drm_printk(drm, level, type, fmt, ...)			\
	dev_##level##type((drm)->dev, "[drm] " fmt, ##__VA_ARGS__)


#define drm_info(drm, fmt, ...)					\
	__drm_printk((drm), info,, fmt, ##__VA_ARGS__)

#define drm_notice(drm, fmt, ...)				\
	__drm_printk((drm), notice,, fmt, ##__VA_ARGS__)

#define drm_warn(drm, fmt, ...)					\
	__drm_printk((drm), warn,, fmt, ##__VA_ARGS__)

#define drm_err(drm, fmt, ...)					\
	__drm_printk((drm), err,, "*ERROR* " fmt, ##__VA_ARGS__)


#define drm_info_once(drm, fmt, ...)				\
	__drm_printk((drm), info, _once, fmt, ##__VA_ARGS__)

#define drm_notice_once(drm, fmt, ...)				\
	__drm_printk((drm), notice, _once, fmt, ##__VA_ARGS__)

#define drm_warn_once(drm, fmt, ...)				\
	__drm_printk((drm), warn, _once, fmt, ##__VA_ARGS__)

#define drm_err_once(drm, fmt, ...)				\
	__drm_printk((drm), err, _once, "*ERROR* " fmt, ##__VA_ARGS__)


#define drm_err_ratelimited(drm, fmt, ...)				\
	__drm_printk((drm), err, _ratelimited, "*ERROR* " fmt, ##__VA_ARGS__)


#define drm_dbg_core(drm, fmt, ...)					\
	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_CORE, fmt, ##__VA_ARGS__)
#define drm_dbg(drm, fmt, ...)						\
	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_DRIVER, fmt, ##__VA_ARGS__)
#define drm_dbg_kms(drm, fmt, ...)					\
	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_KMS, fmt, ##__VA_ARGS__)
#define drm_dbg_prime(drm, fmt, ...)					\
	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_PRIME, fmt, ##__VA_ARGS__)
#define drm_dbg_atomic(drm, fmt, ...)					\
	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_ATOMIC, fmt, ##__VA_ARGS__)
#define drm_dbg_vbl(drm, fmt, ...)					\
	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_VBL, fmt, ##__VA_ARGS__)
#define drm_dbg_state(drm, fmt, ...)					\
	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_STATE, fmt, ##__VA_ARGS__)
#define drm_dbg_lease(drm, fmt, ...)					\
	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_LEASE, fmt, ##__VA_ARGS__)
#define drm_dbg_dp(drm, fmt, ...)					\
	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_DP, fmt, ##__VA_ARGS__)
#define drm_dbg_drmres(drm, fmt, ...)					\
	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_DRMRES, fmt, ##__VA_ARGS__)


/*
 * printk based logging
 *
 * Prefer drm_device based logging over device or prink based logging.
 */

__printf(2, 3)
void __drm_dbg(enum drm_debug_category category, const char *format, ...);
__printf(1, 2)
void __drm_err(const char *format, ...);

/* Macros to make printk easier */

#define _DRM_PRINTK(once, level, fmt, ...)				\
	printk##once(KERN_##level "[" DRM_NAME "] " fmt, ##__VA_ARGS__)

#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__)

#define DRM_ERROR(fmt, ...)						\
	__drm_err(fmt, ##__VA_ARGS__)

#define DRM_ERROR_RATELIMITED(fmt, ...)					\
	DRM_DEV_ERROR_RATELIMITED(NULL, fmt, ##__VA_ARGS__)

#define DRM_DEBUG(fmt, ...)						\
	__drm_dbg(DRM_UT_CORE, fmt, ##__VA_ARGS__)

#define DRM_DEBUG_DRIVER(fmt, ...)					\
	__drm_dbg(DRM_UT_DRIVER, fmt, ##__VA_ARGS__)

#define DRM_DEBUG_KMS(fmt, ...)						\
	__drm_dbg(DRM_UT_KMS, fmt, ##__VA_ARGS__)

#define DRM_DEBUG_PRIME(fmt, ...)					\
	__drm_dbg(DRM_UT_PRIME, fmt, ##__VA_ARGS__)

#define DRM_DEBUG_ATOMIC(fmt, ...)					\
	__drm_dbg(DRM_UT_ATOMIC, fmt, ##__VA_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_DEBUG_DP(fmt, ...)						\
	__drm_dbg(DRM_UT_DP, fmt, ## __VA_ARGS__)

#define __DRM_DEFINE_DBG_RATELIMITED(category, drm, fmt, ...)					\
({												\
	static DEFINE_RATELIMIT_STATE(rs_, DEFAULT_RATELIMIT_INTERVAL, DEFAULT_RATELIMIT_BURST);\
	const struct drm_device *drm_ = (drm);							\
												\
	if (drm_debug_enabled(DRM_UT_ ## category) && __ratelimit(&rs_))			\
		drm_dev_printk(drm_ ? drm_->dev : NULL, KERN_DEBUG, fmt, ## __VA_ARGS__);	\
})

#define drm_dbg_kms_ratelimited(drm, fmt, ...) \
	__DRM_DEFINE_DBG_RATELIMITED(KMS, drm, fmt, ## __VA_ARGS__)

#define DRM_DEBUG_KMS_RATELIMITED(fmt, ...) drm_dbg_kms_ratelimited(NULL, fmt, ## __VA_ARGS__)

/*
 * struct drm_device based WARNs
 *
 * drm_WARN*() acts like WARN*(), but with the key difference of
 * using device specific information so that we know from which device
 * warning is originating from.
 *
 * Prefer drm_device based drm_WARN* over regular WARN*
 */

/* Helper for struct drm_device based WARNs */
#define drm_WARN(drm, condition, format, arg...)			\
	WARN(condition, "%s %s: " format,				\
			dev_driver_string((drm)->dev),			\
			dev_name((drm)->dev), ## arg)

#define drm_WARN_ONCE(drm, condition, format, arg...)			\
	WARN_ONCE(condition, "%s %s: " format,				\
			dev_driver_string((drm)->dev),			\
			dev_name((drm)->dev), ## arg)

#define drm_WARN_ON(drm, x)						\
	drm_WARN((drm), (x), "%s",					\
		 "drm_WARN_ON(" __stringify(x) ")")

#define drm_WARN_ON_ONCE(drm, x)					\
	drm_WARN_ONCE((drm), (x), "%s",					\
		      "drm_WARN_ON_ONCE(" __stringify(x) ")")

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