Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 02c9656b authored by Haneen Mohammed's avatar Haneen Mohammed Committed by Sean Paul
Browse files

drm: Move debug macros out of drmP.h 



This patch extract DRM_* debug macros from drmP.h to drm_print.h and
move printing related functions used by these macros from drm_drv.[hc]
to drm_print.[hc].

Signed-off-by: default avatarHaneen Mohammed <hamohammed.sa@gmail.com>
Signed-off-by: default avatarSean Paul <seanpaul@chromium.org>
Link: https://patchwork.freedesktop.org/patch/msgid/4020bc7c5ffad2af516919f78bb837c7f366b82b.1508297716.git.hamohammed.sa@gmail.com
parent 102712a3

drivers/gpu/drm/drm_drv.c

+0 −47
Original line number Diff line number Diff line
@@ -74,53 +74,6 @@ static bool drm_core_init_complete = false; 


static struct dentry *drm_debugfs_root;



#define DRM_PRINTK_FMT "[" DRM_NAME ":%s]%s %pV"



void drm_dev_printk(const struct device *dev, const char *level,

		    unsigned int category, const char *function_name,

		    const char *prefix, const char *format, ...)

{

	struct va_format vaf;

	va_list args;



	if (category != DRM_UT_NONE && !(drm_debug & category))

		return;



	va_start(args, format);

	vaf.fmt = format;

	vaf.va = &args;



	if (dev)

		dev_printk(level, dev, DRM_PRINTK_FMT, function_name, prefix,

			   &vaf);

	else

		printk("%s" DRM_PRINTK_FMT, level, function_name, prefix, &vaf);



	va_end(args);

}

EXPORT_SYMBOL(drm_dev_printk);



void drm_printk(const char *level, unsigned int category,

		const char *format, ...)

{

	struct va_format vaf;

	va_list args;



	if (category != DRM_UT_NONE && !(drm_debug & category))

		return;



	va_start(args, format);

	vaf.fmt = format;

	vaf.va = &args;



	printk("%s" "[" DRM_NAME ":%ps]%s %pV",

	       level, __builtin_return_address(0),

	       strcmp(level, KERN_ERR) == 0 ? " *ERROR*" : "", &vaf);



	va_end(args);

}

EXPORT_SYMBOL(drm_printk);



/*

 * DRM Minors

 * A DRM device can provide several char-dev interfaces on the DRM-Major. Each

drivers/gpu/drm/drm_print.c

+47 −0
Original line number Diff line number Diff line
@@ -63,3 +63,50 @@ void drm_printf(struct drm_printer *p, const char *f, ...) 
	va_end(args);

}

EXPORT_SYMBOL(drm_printf);



#define DRM_PRINTK_FMT "[" DRM_NAME ":%s]%s %pV"



void drm_dev_printk(const struct device *dev, const char *level,

		    unsigned int category, const char *function_name,

		    const char *prefix, const char *format, ...)

{

	struct va_format vaf;

	va_list args;



	if (category != DRM_UT_NONE && !(drm_debug & category))

		return;



	va_start(args, format);

	vaf.fmt = format;

	vaf.va = &args;



	if (dev)

		dev_printk(level, dev, DRM_PRINTK_FMT, function_name, prefix,

			   &vaf);

	else

		printk("%s" DRM_PRINTK_FMT, level, function_name, prefix, &vaf);



	va_end(args);

}

EXPORT_SYMBOL(drm_dev_printk);



void drm_printk(const char *level, unsigned int category,

		const char *format, ...)

{

	struct va_format vaf;

	va_list args;



	if (category != DRM_UT_NONE && !(drm_debug & category))

		return;



	va_start(args, format);

	vaf.fmt = format;

	vaf.va = &args;



	printk("%s" "[" DRM_NAME ":%ps]%s %pV",

	       level, __builtin_return_address(0),

	       strcmp(level, KERN_ERR) == 0 ? " *ERROR*" : "", &vaf);



	va_end(args);

}

EXPORT_SYMBOL(drm_printk);

include/drm/drmP.h

+1 −192
Original line number Diff line number Diff line
@@ -75,6 +75,7 @@ 
#include <drm/drm_sarea.h>

#include <drm/drm_drv.h>

#include <drm/drm_prime.h>

#include <drm/drm_print.h>

#include <drm/drm_pci.h>

#include <drm/drm_file.h>

#include <drm/drm_debugfs.h>
@@ -94,208 +95,16 @@ struct dma_buf_attachment; 
struct pci_dev;

struct pci_controller;



/*

 * 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



/***********************************************************************/

/** \name DRM template customization defaults */

/*@{*/



/***********************************************************************/

/** \name 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.

 *

 * \param fmt printf() like format string.

 * \param arg arguments

 */

#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_printk(KERN_ERR, DRM_UT_NONE, fmt,	##__VA_ARGS__)



/**

 * Rate limited error output.  Like DRM_ERROR() but won't flood the log.

 *

 * \param fmt printf() like format string.

 * \param arg arguments

 */

#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.

 *

 * \param fmt printf() like format string.

 * \param arg arguments

 */

#define DRM_DEV_DEBUG(dev, fmt, args...)				\

	drm_dev_printk(dev, KERN_DEBUG, DRM_UT_CORE, __func__, "", fmt,	\

		       ##args)

#define DRM_DEBUG(fmt, ...)						\

	drm_printk(KERN_DEBUG, 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_printk(KERN_DEBUG, 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_printk(KERN_DEBUG, 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_printk(KERN_DEBUG, 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_printk(KERN_DEBUG, 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_printk(KERN_DEBUG, DRM_UT_VBL, 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.

 *

 * \param fmt printf() like format string.

 * \param arg arguments

 */

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



/* Format strings and argument splitters to simplify printing

 * various "complex" objects

 */



/*@}*/



/***********************************************************************/

/** \name Internal types and structures */

/*@{*/



#define DRM_IF_VERSION(maj, min) (maj << 16 | min)





/**

 * drm_drv_uses_atomic_modeset - check if the driver implements

 * atomic_commit()

include/drm/drm_drv.h

+0 −7
Original line number Diff line number Diff line
@@ -592,13 +592,6 @@ struct drm_driver { 
	int dev_priv_size;

};



__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(3, 4)

void drm_printk(const char *level, unsigned int category,

		const char *format, ...);

extern unsigned int drm_debug;



int drm_dev_init(struct drm_device *dev,

include/drm/drm_print.h

+199 −0
Original line number Diff line number Diff line
@@ -128,4 +128,203 @@ static inline struct drm_printer drm_debug_printer(const char *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



__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(3, 4)

void drm_printk(const char *level, unsigned int category,

		const char *format, ...);

/***********************************************************************/

/** \name 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.

 *

 * \param fmt printf() like format string.

 * \param arg arguments

 */

#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_printk(KERN_ERR, DRM_UT_NONE, fmt,	##__VA_ARGS__)



/**

 * Rate limited error output.  Like DRM_ERROR() but won't flood the log.

 *

 * \param fmt printf() like format string.

 * \param arg arguments

 */

#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.

 *

 * \param fmt printf() like format string.

 * \param arg arguments

 */

#define DRM_DEV_DEBUG(dev, fmt, args...)				\

	drm_dev_printk(dev, KERN_DEBUG, DRM_UT_CORE, __func__, "", fmt,	\

		       ##args)

#define DRM_DEBUG(fmt, ...)						\

	drm_printk(KERN_DEBUG, 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_printk(KERN_DEBUG, 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_printk(KERN_DEBUG, 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_printk(KERN_DEBUG, 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_printk(KERN_DEBUG, 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_printk(KERN_DEBUG, DRM_UT_VBL, 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.

 *

 * \param fmt printf() like format string.

 * \param arg arguments

 */

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



/* Format strings and argument splitters to simplify printing

 * various "complex" objects

 */



/*@}*/



#endif /* DRM_PRINT_H_ */