Commit 48a8659c authored by Michal Wajdeczko's avatar Michal Wajdeczko
Browse files

drm/xe: Add dedicated printk macros for tile and device 



We already have dedicated helper macros for printing GT-oriented
messages but we don't have any to print messages that are tile
oriented and we wrongly try to use plain drm or GT-oriented ones.

Add tile-oriented printk messages and to provide similar coverage
as we have with xe_assert() macros. Also add set of simple macros
for the top level xe_device, which we could easily tweak to include
extra device specific info if needed.

Typical output of our printk macros will look like:

 [drm] this is xe_WARN()
 [drm] *ERROR* this is xe_err()
 [drm] *ERROR* this is xe_err_printer()
 [drm] this is xe_info()
 [drm] this is xe_info_printer()
 [drm:printk_demo.cold] this is xe_dbg()
 [drm:printk_demo.cold] this is xe_dbg_printer()

 [drm] Tile0: this is xe_tile_WARN()
 [drm] *ERROR* Tile0: this is xe_tile_err()
 [drm] *ERROR* Tile0: this is xe_tile_err_printer()
 [drm] Tile0: this is xe_tile_info()
 [drm] Tile0: this is xe_tile_info_printer()
 [drm:printk_demo.cold] Tile0: this is xe_tile_dbg()
 [drm:printk_demo.cold] Tile0: this is xe_tile_dbg_printer()

 [drm] Tile0: GT0: this is xe_gt_WARN()
 [drm] *ERROR* Tile0: GT0: this is xe_gt_err()
 [drm] *ERROR* Tile0: GT0: this is xe_gt_err_printer()
 [drm] Tile0: GT0: this is xe_gt_info()
 [drm] Tile0: GT0: this is xe_gt_info_printer()
 [drm:printk_demo.cold] Tile0: GT0: this is xe_gt_dbg()
 [drm:printk_demo.cold] Tile0: GT0: this is xe_gt_dbg_printer()

Signed-off-by: default avatarMichal Wajdeczko <michal.wajdeczko@intel.com>
Cc: Lucas De Marchi <lucas.demarchi@intel.com>
Cc: Rodrigo Vivi <rodrigo.vivi@intel.com>
Reviewed-by: default avatarRodrigo Vivi <rodrigo.vivi@intel.com>
Reviewed-by: default avatarLucas De Marchi <lucas.demarchi@intel.com>
Link: https://lore.kernel.org/r/20250909165941.31730-5-michal.wajdeczko@intel.com
parent efd54b0c

drivers/gpu/drm/xe/xe_gt_printk.h

+5 −6
Original line number Diff line number Diff line
@@ -6,14 +6,13 @@ 
#ifndef _XE_GT_PRINTK_H_

#define _XE_GT_PRINTK_H_



#include <drm/drm_print.h>



#include "xe_gt_types.h"

#include "xe_tile_printk.h"



#define __XE_GT_PRINTK_FMT(_gt, _fmt, _args...)	"GT%u: " _fmt, (_gt)->info.id, ##_args



#define xe_gt_printk(_gt, _level, _fmt, ...) \

	drm_##_level(&gt_to_xe(_gt)->drm, __XE_GT_PRINTK_FMT((_gt), _fmt, ##__VA_ARGS__))

	xe_tile_printk((_gt)->tile, _level, __XE_GT_PRINTK_FMT((_gt), _fmt, ##__VA_ARGS__))



#define xe_gt_err(_gt, _fmt, ...) \

	xe_gt_printk((_gt), err, _fmt, ##__VA_ARGS__)
@@ -37,7 +36,7 @@ 
	xe_gt_printk((_gt), dbg, _fmt, ##__VA_ARGS__)



#define xe_gt_WARN_type(_gt, _type, _condition, _fmt, ...) \

	drm_WARN##_type(&gt_to_xe(_gt)->drm, _condition, _fmt, ## __VA_ARGS__)

	xe_tile_WARN##_type((_gt)->tile, _condition, _fmt, ## __VA_ARGS__)



#define xe_gt_WARN(_gt, _condition, _fmt, ...) \

	xe_gt_WARN_type((_gt),, _condition, __XE_GT_PRINTK_FMT((_gt), _fmt, ##__VA_ARGS__))
@@ -72,9 +71,9 @@ static inline void __xe_gt_printfn_dbg(struct drm_printer *p, struct va_format * 


	/*

	 * The original xe_gt_dbg() callsite annotations are useless here,

	 * redirect to the tweaked drm_dbg_printer() instead.

	 * redirect to the tweaked xe_tile_dbg_printer() instead.

	 */

	dbg = drm_dbg_printer(&gt_to_xe(gt)->drm, DRM_UT_DRIVER, NULL);

	dbg = xe_tile_dbg_printer((gt)->tile);

	dbg.origin = p->origin;



	drm_printf(&dbg, __XE_GT_PRINTK_FMT(gt, "%pV", vaf));

drivers/gpu/drm/xe/xe_printk.h

0 → 100644
+129 −0
Original line number Diff line number Diff line 
/* SPDX-License-Identifier: MIT */

/*

 * Copyright © 2025 Intel Corporation

 */



#ifndef _XE_PRINTK_H_

#define _XE_PRINTK_H_



#include <drm/drm_print.h>



#include "xe_device_types.h"



#define __XE_PRINTK_FMT(_xe, _fmt, _args...)	_fmt, ##_args



#define xe_printk(_xe, _level, _fmt, ...) \

	drm_##_level(&(_xe)->drm, __XE_PRINTK_FMT((_xe), _fmt, ## __VA_ARGS__))



#define xe_err(_xe, _fmt, ...) \

	xe_printk((_xe), err, _fmt, ##__VA_ARGS__)



#define xe_err_once(_xe, _fmt, ...) \

	xe_printk((_xe), err_once, _fmt, ##__VA_ARGS__)



#define xe_err_ratelimited(_xe, _fmt, ...) \

	xe_printk((_xe), err_ratelimited, _fmt, ##__VA_ARGS__)



#define xe_warn(_xe, _fmt, ...) \

	xe_printk((_xe), warn, _fmt, ##__VA_ARGS__)



#define xe_notice(_xe, _fmt, ...) \

	xe_printk((_xe), notice, _fmt, ##__VA_ARGS__)



#define xe_info(_xe, _fmt, ...) \

	xe_printk((_xe), info, _fmt, ##__VA_ARGS__)



#define xe_dbg(_xe, _fmt, ...) \

	xe_printk((_xe), dbg, _fmt, ##__VA_ARGS__)



#define xe_WARN_type(_xe, _type, _condition, _fmt, ...) \

	drm_WARN##_type(&(_xe)->drm, _condition, _fmt, ## __VA_ARGS__)



#define xe_WARN(_xe, _condition, _fmt, ...) \

	xe_WARN_type((_xe),, _condition, __XE_PRINTK_FMT((_xe), _fmt, ## __VA_ARGS__))



#define xe_WARN_ONCE(_xe, _condition, _fmt, ...) \

	xe_WARN_type((_xe), _ONCE, _condition, __XE_PRINTK_FMT((_xe), _fmt, ## __VA_ARGS__))



#define xe_WARN_ON(_xe, _condition) \

	xe_WARN((_xe), _condition, "%s(%s)", "WARN_ON", __stringify(_condition))



#define xe_WARN_ON_ONCE(_xe, _condition) \

	xe_WARN_ONCE((_xe), _condition, "%s(%s)", "WARN_ON_ONCE", __stringify(_condition))



static inline void __xe_printfn_err(struct drm_printer *p, struct va_format *vaf)

{

	struct xe_device *xe = p->arg;



	xe_err(xe, "%pV", vaf);

}



static inline void __xe_printfn_info(struct drm_printer *p, struct va_format *vaf)

{

	struct xe_device *xe = p->arg;



	xe_info(xe, "%pV", vaf);

}



static inline void __xe_printfn_dbg(struct drm_printer *p, struct va_format *vaf)

{

	struct xe_device *xe = p->arg;

	struct drm_printer ddp;



	/*

	 * The original xe_dbg() callsite annotations are useless here,

	 * redirect to the tweaked drm_dbg_printer() instead.

	 */

	ddp = drm_dbg_printer(&xe->drm, DRM_UT_DRIVER, NULL);

	ddp.origin = p->origin;



	drm_printf(&ddp, __XE_PRINTK_FMT(xe, "%pV", vaf));

}



/**

 * xe_err_printer - Construct a &drm_printer that outputs to xe_err()

 * @xe: the &xe_device pointer to use in xe_err()

 *

 * Return: The &drm_printer object.

 */

static inline struct drm_printer xe_err_printer(struct xe_device *xe)

{

	struct drm_printer p = {

		.printfn = __xe_printfn_err,

		.arg = xe,

	};

	return p;

}



/**

 * xe_info_printer - Construct a &drm_printer that outputs to xe_info()

 * @xe: the &xe_device pointer to use in xe_info()

 *

 * Return: The &drm_printer object.

 */

static inline struct drm_printer xe_info_printer(struct xe_device *xe)

{

	struct drm_printer p = {

		.printfn = __xe_printfn_info,

		.arg = xe,

	};

	return p;

}



/**

 * xe_dbg_printer - Construct a &drm_printer that outputs like xe_dbg()

 * @xe: the &xe_device pointer to use in xe_dbg()

 *

 * Return: The &drm_printer object.

 */

static inline struct drm_printer xe_dbg_printer(struct xe_device *xe)

{

	struct drm_printer p = {

		.printfn = __xe_printfn_dbg,

		.arg = xe,

		.origin = (const void *)_THIS_IP_,

	};

	return p;

}



#endif

drivers/gpu/drm/xe/xe_tile_printk.h

0 → 100644
+127 −0
Original line number Diff line number Diff line 
/* SPDX-License-Identifier: MIT */

/*

 * Copyright © 2025 Intel Corporation

 */



#ifndef _xe_tile_printk_H_

#define _xe_tile_printk_H_



#include "xe_printk.h"



#define __XE_TILE_PRINTK_FMT(_tile, _fmt, _args...)	"Tile%u: " _fmt, (_tile)->id, ##_args



#define xe_tile_printk(_tile, _level, _fmt, ...) \

	xe_printk((_tile)->xe, _level, __XE_TILE_PRINTK_FMT((_tile), _fmt, ##__VA_ARGS__))



#define xe_tile_err(_tile, _fmt, ...) \

	xe_tile_printk((_tile), err, _fmt, ##__VA_ARGS__)



#define xe_tile_err_once(_tile, _fmt, ...) \

	xe_tile_printk((_tile), err_once, _fmt, ##__VA_ARGS__)



#define xe_tile_err_ratelimited(_tile, _fmt, ...) \

	xe_tile_printk((_tile), err_ratelimited, _fmt, ##__VA_ARGS__)



#define xe_tile_warn(_tile, _fmt, ...) \

	xe_tile_printk((_tile), warn, _fmt, ##__VA_ARGS__)



#define xe_tile_notice(_tile, _fmt, ...) \

	xe_tile_printk((_tile), notice, _fmt, ##__VA_ARGS__)



#define xe_tile_info(_tile, _fmt, ...) \

	xe_tile_printk((_tile), info, _fmt, ##__VA_ARGS__)



#define xe_tile_dbg(_tile, _fmt, ...) \

	xe_tile_printk((_tile), dbg, _fmt, ##__VA_ARGS__)



#define xe_tile_WARN_type(_tile, _type, _condition, _fmt, ...) \

	xe_WARN##_type((_tile)->xe, _condition, _fmt, ## __VA_ARGS__)



#define xe_tile_WARN(_tile, _condition, _fmt, ...) \

	xe_tile_WARN_type((_tile),, _condition, __XE_TILE_PRINTK_FMT((_tile), _fmt, ##__VA_ARGS__))



#define xe_tile_WARN_ONCE(_tile, _condition, _fmt, ...) \

	xe_tile_WARN_type((_tile), _ONCE, _condition, __XE_TILE_PRINTK_FMT((_tile), _fmt, ##__VA_ARGS__))



#define xe_tile_WARN_ON(_tile, _condition) \

	xe_tile_WARN((_tile), _condition, "%s(%s)", "WARN_ON", __stringify(_condition))



#define xe_tile_WARN_ON_ONCE(_tile, _condition) \

	xe_tile_WARN_ONCE((_tile), _condition, "%s(%s)", "WARN_ON_ONCE", __stringify(_condition))



static inline void __xe_tile_printfn_err(struct drm_printer *p, struct va_format *vaf)

{

	struct xe_tile *tile = p->arg;



	xe_tile_err(tile, "%pV", vaf);

}



static inline void __xe_tile_printfn_info(struct drm_printer *p, struct va_format *vaf)

{

	struct xe_tile *tile = p->arg;



	xe_tile_info(tile, "%pV", vaf);

}



static inline void __xe_tile_printfn_dbg(struct drm_printer *p, struct va_format *vaf)

{

	struct xe_tile *tile = p->arg;

	struct drm_printer dbg;



	/*

	 * The original xe_tile_dbg() callsite annotations are useless here,

	 * redirect to the tweaked xe_dbg_printer() instead.

	 */

	dbg = xe_dbg_printer(tile->xe);

	dbg.origin = p->origin;



	drm_printf(&dbg, __XE_TILE_PRINTK_FMT(tile, "%pV", vaf));

}



/**

 * xe_tile_err_printer - Construct a &drm_printer that outputs to xe_tile_err()

 * @tile: the &xe_tile pointer to use in xe_tile_err()

 *

 * Return: The &drm_printer object.

 */

static inline struct drm_printer xe_tile_err_printer(struct xe_tile *tile)

{

	struct drm_printer p = {

		.printfn = __xe_tile_printfn_err,

		.arg = tile,

	};

	return p;

}



/**

 * xe_tile_info_printer - Construct a &drm_printer that outputs to xe_tile_info()

 * @tile: the &xe_tile pointer to use in xe_tile_info()

 *

 * Return: The &drm_printer object.

 */

static inline struct drm_printer xe_tile_info_printer(struct xe_tile *tile)

{

	struct drm_printer p = {

		.printfn = __xe_tile_printfn_info,

		.arg = tile,

	};

	return p;

}



/**

 * xe_tile_dbg_printer - Construct a &drm_printer that outputs like xe_tile_dbg()

 * @tile: the &xe_tile pointer to use in xe_tile_dbg()

 *

 * Return: The &drm_printer object.

 */

static inline struct drm_printer xe_tile_dbg_printer(struct xe_tile *tile)

{

	struct drm_printer p = {

		.printfn = __xe_tile_printfn_dbg,

		.arg = tile,

		.origin = (const void *)_THIS_IP_,

	};

	return p;

}



#endif