[J-u-boot.git] / include / log.h

/* SPDX-License-Identifier: GPL-2.0+ */
/*
 * Logging support
 *
 * Copyright (c) 2017 Google, Inc
 * Written by Simon Glass <[email protected]>
 */

#ifndef __LOG_H
#define __LOG_H

#include <dm/uclass-id.h>
#include <linux/list.h>

/** Log levels supported, ranging from most to least important */
enum log_level_t {
	LOGL_EMERG = 0,		/* U-Boot is unstable */
	LOGL_ALERT,		/* Action must be taken immediately */
	LOGL_CRIT,		/* Critical conditions */
	LOGL_ERR,		/* Error that prevents something from working */
	LOGL_WARNING,		/* Warning may prevent optimial operation */
	LOGL_NOTICE,		/* Normal but significant condition, printf() */
	LOGL_INFO,		/* General information message */
	LOGL_DEBUG,		/* Basic debug-level message */
	LOGL_DEBUG_CONTENT,	/* Debug message showing full message content */
	LOGL_DEBUG_IO,		/* Debug message showing hardware I/O access */

	LOGL_COUNT,
	LOGL_NONE,

	LOGL_FIRST = LOGL_EMERG,
	LOGL_MAX = LOGL_DEBUG_IO,
};

/**
 * Log categories supported. Most of these correspond to uclasses (i.e.
 * enum uclass_id) but there are also some more generic categories
 */
enum log_category_t {
	LOGC_FIRST = 0,	/* First part mirrors UCLASS_... */

	LOGC_NONE = UCLASS_COUNT,	/* First number is after all uclasses */
	LOGC_ARCH,	/* Related to arch-specific code */
	LOGC_BOARD,	/* Related to board-specific code */
	LOGC_CORE,	/* Related to core features (non-driver-model) */
	LOGC_DM,	/* Core driver-model */
	LOGC_DT,	/* Device-tree */
	LOGC_EFI,	/* EFI implementation */
	LOGC_ALLOC,	/* Memory allocation */
	LOGC_SANDBOX,	/* Related to the sandbox board */
	LOGC_BLOBLIST,	/* Bloblist */

	LOGC_COUNT,	/* Number of log categories */
	LOGC_END,	/* Sentinel value for a list of log categories */
};

/* Helper to cast a uclass ID to a log category */
static inline int log_uc_cat(enum uclass_id id)
{
	return (enum log_category_t)id;
}

/**
 * _log() - Internal function to emit a new log record
 *
 * @cat: Category of log record (indicating which subsystem generated it)
 * @level: Level of log record (indicating its severity)
 * @file: File name of file where log record was generated
 * @line: Line number in file where log record was generated
 * @func: Function where log record was generated
 * @fmt: printf() format string for log record
 * @...: Optional parameters, according to the format string @fmt
 * @return 0 if log record was emitted, -ve on error
 */
int _log(enum log_category_t cat, enum log_level_t level, const char *file,
	 int line, const char *func, const char *fmt, ...)
		__attribute__ ((format (__printf__, 6, 7)));

static inline int _log_nop(enum log_category_t cat, enum log_level_t level,
			   const char *file, int line, const char *func,
			   const char *fmt, ...)
		__attribute__ ((format (__printf__, 6, 7)));

static inline int _log_nop(enum log_category_t cat, enum log_level_t level,
			   const char *file, int line, const char *func,
			   const char *fmt, ...)
{
	return 0;
}

/* Define this at the top of a file to add a prefix to debug messages */
#ifndef pr_fmt
#define pr_fmt(fmt) fmt
#endif

/* Use a default category if this file does not supply one */
#ifndef LOG_CATEGORY
#define LOG_CATEGORY LOGC_NONE
#endif

/*
 * This header may be including when CONFIG_LOG is disabled, in which case
 * CONFIG_LOG_MAX_LEVEL is not defined. Add a check for this.
 */
#if CONFIG_IS_ENABLED(LOG)
#define _LOG_MAX_LEVEL CONFIG_VAL(LOG_MAX_LEVEL)
#define log_err(_fmt...)	log(LOG_CATEGORY, LOGL_ERR, ##_fmt)
#define log_warning(_fmt...)	log(LOG_CATEGORY, LOGL_WARNING, ##_fmt)
#define log_notice(_fmt...)	log(LOG_CATEGORY, LOGL_NOTICE, ##_fmt)
#define log_info(_fmt...)	log(LOG_CATEGORY, LOGL_INFO, ##_fmt)
#define log_debug(_fmt...)	log(LOG_CATEGORY, LOGL_DEBUG, ##_fmt)
#define log_content(_fmt...)	log(LOG_CATEGORY, LOGL_DEBUG_CONTENT, ##_fmt)
#define log_io(_fmt...)		log(LOG_CATEGORY, LOGL_DEBUG_IO, ##_fmt)
#else
#define _LOG_MAX_LEVEL LOGL_INFO
#define log_err(_fmt...)	log_nop(LOG_CATEGORY, LOGL_ERR, ##_fmt)
#define log_warning(_fmt...)	log_nop(LOG_CATEGORY, LOGL_WARNING, ##_fmt)
#define log_notice(_fmt...)	log_nop(LOG_CATEGORY, LOGL_NOTICE, ##_fmt)
#define log_info(_fmt...)	log_nop(LOG_CATEGORY, LOGL_INFO, ##_fmt)
#define log_debug(_fmt...)	log_nop(LOG_CATEGORY, LOGL_DEBUG, ##_fmt)
#define log_content(_fmt...)	log_nop(LOG_CATEGORY, \
					LOGL_DEBUG_CONTENT, ##_fmt)
#define log_io(_fmt...)		log_nop(LOG_CATEGORY, LOGL_DEBUG_IO, ##_fmt)
#endif

#if CONFIG_IS_ENABLED(LOG)
#ifdef LOG_DEBUG
#define _LOG_DEBUG	1
#else
#define _LOG_DEBUG	0
#endif

/* Emit a log record if the level is less that the maximum */
#define log(_cat, _level, _fmt, _args...) ({ \
	int _l = _level; \
	if (CONFIG_IS_ENABLED(LOG) && (_l <= _LOG_MAX_LEVEL || _LOG_DEBUG)) \
		_log((enum log_category_t)(_cat), _l, __FILE__, __LINE__, \
		      __func__, \
		      pr_fmt(_fmt), ##_args); \
	})
#else
#define log(_cat, _level, _fmt, _args...)
#endif

#define log_nop(_cat, _level, _fmt, _args...) ({ \
	int _l = _level; \
	_log_nop((enum log_category_t)(_cat), _l, __FILE__, __LINE__, \
		      __func__, pr_fmt(_fmt), ##_args); \
})

#ifdef DEBUG
#define _DEBUG	1
#else
#define _DEBUG	0
#endif

#ifdef CONFIG_SPL_BUILD
#define _SPL_BUILD	1
#else
#define _SPL_BUILD	0
#endif

#if !_DEBUG && CONFIG_IS_ENABLED(LOG)

#define debug_cond(cond, fmt, args...)			\
	do {						\
		if (1)					\
			log(LOG_CATEGORY, LOGL_DEBUG, fmt, ##args); \
	} while (0)

#else /* _DEBUG */

/*
 * Output a debug text when condition "cond" is met. The "cond" should be
 * computed by a preprocessor in the best case, allowing for the best
 * optimization.
 */
#define debug_cond(cond, fmt, args...)			\
	do {						\
		if (cond)				\
			printf(pr_fmt(fmt), ##args);	\
	} while (0)

#endif /* _DEBUG */

/* Show a message if DEBUG is defined in a file */
#define debug(fmt, args...)			\
	debug_cond(_DEBUG, fmt, ##args)

/* Show a message if not in SPL */
#define warn_non_spl(fmt, args...)			\
	debug_cond(!_SPL_BUILD, fmt, ##args)

/*
 * An assertion is run-time check done in debug mode only. If DEBUG is not
 * defined then it is skipped. If DEBUG is defined and the assertion fails,
 * then it calls panic*( which may or may not reset/halt U-Boot (see
 * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
 * before release, and after release it is hoped that they don't matter. But
 * in any case these failing assertions cannot be fixed with a reset (which
 * may just do the same assertion again).
 */
void __assert_fail(const char *assertion, const char *file, unsigned int line,
		   const char *function);

/**
 * assert() - assert expression is true
 *
 * If the expression x evaluates to false and _DEBUG evaluates to true, a panic
 * message is written and the system stalls. The value of _DEBUG is set to true
 * if DEBUG is defined before including common.h.
 *
 * The expression x is always executed irrespective of the value of _DEBUG.
 *
 * @x:		expression to test
 */
#define assert(x) \
	({ if (!(x) && _DEBUG) \
		__assert_fail(#x, __FILE__, __LINE__, __func__); })

#if CONFIG_IS_ENABLED(LOG) && defined(CONFIG_LOG_ERROR_RETURN)
/*
 * Log an error return value, possibly with a message. Usage:
 *
 *	return log_ret(fred_call());
 *
 * or:
 *
 *	return log_msg_ret("fred failed", fred_call());
 */
#define log_ret(_ret) ({ \
	int __ret = (_ret); \
	if (__ret < 0) \
		log(LOG_CATEGORY, LOGL_ERR, "returning err=%d\n", __ret); \
	__ret; \
	})
#define log_msg_ret(_msg, _ret) ({ \
	int __ret = (_ret); \
	if (__ret < 0) \
		log(LOG_CATEGORY, LOGL_ERR, "%s: returning err=%d\n", _msg, \
		    __ret); \
	__ret; \
	})
#else
/* Non-logging versions of the above which just return the error code */
#define log_ret(_ret) (_ret)
#define log_msg_ret(_msg, _ret) ((void)(_msg), _ret)
#endif

/**
 * struct log_rec - a single log record
 *
 * Holds information about a single record in the log
 *
 * Members marked as 'not allocated' are stored as pointers and the caller is
 * responsible for making sure that the data pointed to is not overwritten.
 * Memebers marked as 'allocated' are allocated (e.g. via strdup()) by the log
 * system.
 *
 * @cat: Category, representing a uclass or part of U-Boot
 * @level: Severity level, less severe is higher
 * @file: Name of file where the log record was generated (not allocated)
 * @line: Line number where the log record was generated
 * @func: Function where the log record was generated (not allocated)
 * @msg: Log message (allocated)
 */
struct log_rec {
	enum log_category_t cat;
	enum log_level_t level;
	const char *file;
	int line;
	const char *func;
	const char *msg;
};

struct log_device;

/**
 * struct log_driver - a driver which accepts and processes log records
 *
 * @name: Name of driver
 */
struct log_driver {
	const char *name;
	/**
	 * emit() - emit a log record
	 *
	 * Called by the log system to pass a log record to a particular driver
	 * for processing. The filter is checked before calling this function.
	 */
	int (*emit)(struct log_device *ldev, struct log_rec *rec);
};

/**
 * struct log_device - an instance of a log driver
 *
 * Since drivers are set up at build-time we need to have a separate device for
 * the run-time aspects of drivers (currently just a list of filters to apply
 * to records send to this device).
 *
 * @next_filter_num: Seqence number of next filter filter added (0=no filters
 *	yet). This increments with each new filter on the device, but never
 *	decrements
 * @drv: Pointer to driver for this device
 * @filter_head: List of filters for this device
 * @sibling_node: Next device in the list of all devices
 */
struct log_device {
	int next_filter_num;
	struct log_driver *drv;
	struct list_head filter_head;
	struct list_head sibling_node;
};

enum {
	LOGF_MAX_CATEGORIES = 5,	/* maximum categories per filter */
};

enum log_filter_flags {
	LOGFF_HAS_CAT		= 1 << 0,	/* Filter has a category list */
};

/**
 * struct log_filter - criterial to filter out log messages
 *
 * @filter_num: Sequence number of this filter.  This is returned when adding a
 *	new filter, and must be provided when removing a previously added
 *	filter.
 * @flags: Flags for this filter (LOGFF_...)
 * @cat_list: List of categories to allow (terminated by LOGC_none). If empty
 *	then all categories are permitted. Up to LOGF_MAX_CATEGORIES entries
 *	can be provided
 * @max_level: Maximum log level to allow
 * @file_list: List of files to allow, separated by comma. If NULL then all
 *	files are permitted
 * @sibling_node: Next filter in the list of filters for this log device
 */
struct log_filter {
	int filter_num;
	int flags;
	enum log_category_t cat_list[LOGF_MAX_CATEGORIES];
	enum log_level_t max_level;
	const char *file_list;
	struct list_head sibling_node;
};

#define LOG_DRIVER(_name) \
	ll_entry_declare(struct log_driver, _name, log_driver)

/**
 * log_get_cat_name() - Get the name of a category
 *
 * @cat: Category to look up
 * @return category name (which may be a uclass driver name) if found, or
 *	 "<invalid>" if invalid, or "<missing>" if not found
 */
const char *log_get_cat_name(enum log_category_t cat);

/**
 * log_get_cat_by_name() - Look up a category by name
 *
 * @name: Name to look up
 * @return category ID, or LOGC_NONE if not found
 */
enum log_category_t log_get_cat_by_name(const char *name);

/**
 * log_get_level_name() - Get the name of a log level
 *
 * @level: Log level to look up
 * @return log level name (in ALL CAPS)
 */
const char *log_get_level_name(enum log_level_t level);

/**
 * log_get_level_by_name() - Look up a log level by name
 *
 * @name: Name to look up
 * @return log level ID, or LOGL_NONE if not found
 */
enum log_level_t log_get_level_by_name(const char *name);

/* Log format flags (bit numbers) for gd->log_fmt. See log_fmt_chars */
enum log_fmt {
	LOGF_CAT	= 0,
	LOGF_LEVEL,
	LOGF_FILE,
	LOGF_LINE,
	LOGF_FUNC,
	LOGF_MSG,

	LOGF_COUNT,
	LOGF_DEFAULT = (1 << LOGF_FUNC) | (1 << LOGF_MSG),
	LOGF_ALL = 0x3f,
};

/* Handle the 'log test' command */
int do_log_test(cmd_tbl_t *cmdtp, int flag, int argc, char *const argv[]);

/**
 * log_add_filter() - Add a new filter to a log device
 *
 * @drv_name: Driver name to add the filter to (since each driver only has a
 *	single device)
 * @cat_list: List of categories to allow (terminated by LOGC_none). If empty
 *	then all categories are permitted. Up to LOGF_MAX_CATEGORIES entries
 *	can be provided
 * @max_level: Maximum log level to allow
 * @file_list: List of files to allow, separated by comma. If NULL then all
 *	files are permitted
 * @return the sequence number of the new filter (>=0) if the filter was added,
 *	or a -ve value on error
 */
int log_add_filter(const char *drv_name, enum log_category_t cat_list[],
		   enum log_level_t max_level, const char *file_list);

/**
 * log_remove_filter() - Remove a filter from a log device
 *
 * @drv_name: Driver name to remove the filter from (since each driver only has
 *	a single device)
 * @filter_num: Filter number to remove (as returned by log_add_filter())
 * @return 0 if the filter was removed, -ENOENT if either the driver or the
 *	filter number was not found
 */
int log_remove_filter(const char *drv_name, int filter_num);

#if CONFIG_IS_ENABLED(LOG)
/**
 * log_init() - Set up the log system ready for use
 *
 * @return 0 if OK, -ENOMEM if out of memory
 */
int log_init(void);
#else
static inline int log_init(void)
{
	return 0;
}
#endif

#endif
Commit	Line	Data
83d290c5	1	/* SPDX-License-Identifier: GPL-2.0+ */
0e98b0a6 SG	2	/*
	3	* Logging support
	4	*
	5	* Copyright (c) 2017 Google, Inc
	6	* Written by Simon Glass <[email protected]>
0e98b0a6 SG	7	*/
	8
	9	#ifndef __LOG_H
	10	#define __LOG_H
	11
e9c8d49d SG	12	#include <dm/uclass-id.h>
	13	#include <linux/list.h>
	14
	15	/** Log levels supported, ranging from most to least important */
	16	enum log_level_t {
6fc7e938	17	LOGL_EMERG = 0, /* U-Boot is unstable */
e9c8d49d SG	18	LOGL_ALERT, /* Action must be taken immediately */
	19	LOGL_CRIT, /* Critical conditions */
	20	LOGL_ERR, /* Error that prevents something from working */
	21	LOGL_WARNING, /* Warning may prevent optimial operation */
	22	LOGL_NOTICE, /* Normal but significant condition, printf() */
	23	LOGL_INFO, /* General information message */
	24	LOGL_DEBUG, /* Basic debug-level message */
	25	LOGL_DEBUG_CONTENT, /* Debug message showing full message content */
	26	LOGL_DEBUG_IO, /* Debug message showing hardware I/O access */
	27
	28	LOGL_COUNT,
f941c8d7 SG	29	LOGL_NONE,
f941c8d7 SG	30
e9c8d49d	31	LOGL_FIRST = LOGL_EMERG,
f941c8d7	32	LOGL_MAX = LOGL_DEBUG_IO,
e9c8d49d SG	33	};
	34
	35	/**
	36	* Log categories supported. Most of these correspond to uclasses (i.e.
	37	* enum uclass_id) but there are also some more generic categories
	38	*/
	39	enum log_category_t {
	40	LOGC_FIRST = 0, /* First part mirrors UCLASS_... */
	41
0bf96459 SG	42	LOGC_NONE = UCLASS_COUNT, /* First number is after all uclasses */
	43	LOGC_ARCH, /* Related to arch-specific code */
	44	LOGC_BOARD, /* Related to board-specific code */
	45	LOGC_CORE, /* Related to core features (non-driver-model) */
f941c8d7 SG	46	LOGC_DM, /* Core driver-model */
f941c8d7 SG	47	LOGC_DT, /* Device-tree */
d8d8997b	48	LOGC_EFI, /* EFI implementation */
c3aed5db	49	LOGC_ALLOC, /* Memory allocation */
a5c13b68	50	LOGC_SANDBOX, /* Related to the sandbox board */
9f407d4e	51	LOGC_BLOBLIST, /* Bloblist */
e9c8d49d	52
0bf96459 SG	53	LOGC_COUNT, /* Number of log categories */
0bf96459 SG	54	LOGC_END, /* Sentinel value for a list of log categories */
e9c8d49d SG	55	};
	56
	57	/* Helper to cast a uclass ID to a log category */
	58	static inline int log_uc_cat(enum uclass_id id)
	59	{
	60	return (enum log_category_t)id;
	61	}
	62
	63	/**
	64	* _log() - Internal function to emit a new log record
	65	*
	66	* @cat: Category of log record (indicating which subsystem generated it)
	67	* @level: Level of log record (indicating its severity)
	68	* @file: File name of file where log record was generated
	69	* @line: Line number in file where log record was generated
	70	* @func: Function where log record was generated
	71	* @fmt: printf() format string for log record
	72	* @...: Optional parameters, according to the format string @fmt
	73	* @return 0 if log record was emitted, -ve on error
	74	*/
	75	int _log(enum log_category_t cat, enum log_level_t level, const char *file,
ed4e933d SG	76	int line, const char func, const char fmt, ...)
ed4e933d SG	77	__attribute__ ((format (__printf__, 6, 7)));
e9c8d49d	78
fd42948f SG	79	static inline int _log_nop(enum log_category_t cat, enum log_level_t level,
	80	const char file, int line, const char func,
	81	const char *fmt, ...)
	82	__attribute__ ((format (__printf__, 6, 7)));
	83
	84	static inline int _log_nop(enum log_category_t cat, enum log_level_t level,
	85	const char file, int line, const char func,
	86	const char *fmt, ...)
	87	{
	88	return 0;
	89	}
	90
e9c8d49d SG	91	/* Define this at the top of a file to add a prefix to debug messages */
	92	#ifndef pr_fmt
	93	#define pr_fmt(fmt) fmt
	94	#endif
	95
	96	/* Use a default category if this file does not supply one */
	97	#ifndef LOG_CATEGORY
	98	#define LOG_CATEGORY LOGC_NONE
	99	#endif
	100
	101	/*
	102	* This header may be including when CONFIG_LOG is disabled, in which case
	103	* CONFIG_LOG_MAX_LEVEL is not defined. Add a check for this.
	104	*/
	105	#if CONFIG_IS_ENABLED(LOG)
	106	#define _LOG_MAX_LEVEL CONFIG_VAL(LOG_MAX_LEVEL)
cdd140af SG	107	#define log_err(_fmt...) log(LOG_CATEGORY, LOGL_ERR, ##_fmt)
	108	#define log_warning(_fmt...) log(LOG_CATEGORY, LOGL_WARNING, ##_fmt)
	109	#define log_notice(_fmt...) log(LOG_CATEGORY, LOGL_NOTICE, ##_fmt)
	110	#define log_info(_fmt...) log(LOG_CATEGORY, LOGL_INFO, ##_fmt)
	111	#define log_debug(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG, ##_fmt)
	112	#define log_content(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG_CONTENT, ##_fmt)
	113	#define log_io(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG_IO, ##_fmt)
e9c8d49d SG	114	#else
e9c8d49d SG	115	#define _LOG_MAX_LEVEL LOGL_INFO
fd42948f SG	116	#define log_err(_fmt...) log_nop(LOG_CATEGORY, LOGL_ERR, ##_fmt)
	117	#define log_warning(_fmt...) log_nop(LOG_CATEGORY, LOGL_WARNING, ##_fmt)
	118	#define log_notice(_fmt...) log_nop(LOG_CATEGORY, LOGL_NOTICE, ##_fmt)
	119	#define log_info(_fmt...) log_nop(LOG_CATEGORY, LOGL_INFO, ##_fmt)
	120	#define log_debug(_fmt...) log_nop(LOG_CATEGORY, LOGL_DEBUG, ##_fmt)
	121	#define log_content(_fmt...) log_nop(LOG_CATEGORY, \
	122	LOGL_DEBUG_CONTENT, ##_fmt)
	123	#define log_io(_fmt...) log_nop(LOG_CATEGORY, LOGL_DEBUG_IO, ##_fmt)
e9c8d49d SG	124	#endif
e9c8d49d SG	125
4d8d3056	126	#if CONFIG_IS_ENABLED(LOG)
f9811e85 SG	127	#ifdef LOG_DEBUG
	128	#define _LOG_DEBUG 1
	129	#else
	130	#define _LOG_DEBUG 0
	131	#endif
4d8d3056	132
e9c8d49d SG	133	/* Emit a log record if the level is less that the maximum */
	134	#define log(_cat, _level, _fmt, _args...) ({ \
	135	int _l = _level; \
f9811e85	136	if (CONFIG_IS_ENABLED(LOG) && (_l <= _LOG_MAX_LEVEL \|\| _LOG_DEBUG)) \
e9c8d49d SG	137	_log((enum log_category_t)(_cat), _l, __FILE__, __LINE__, \
	138	__func__, \
	139	pr_fmt(_fmt), ##_args); \
	140	})
4d8d3056 SG	141	#else
	142	#define log(_cat, _level, _fmt, _args...)
	143	#endif
e9c8d49d	144
fd42948f SG	145	#define log_nop(_cat, _level, _fmt, _args...) ({ \
	146	int _l = _level; \
	147	_log_nop((enum log_category_t)(_cat), _l, __FILE__, __LINE__, \
	148	__func__, pr_fmt(_fmt), ##_args); \
	149	})
	150
0e98b0a6 SG	151	#ifdef DEBUG
	152	#define _DEBUG 1
	153	#else
	154	#define _DEBUG 0
	155	#endif
	156
	157	#ifdef CONFIG_SPL_BUILD
	158	#define _SPL_BUILD 1
	159	#else
	160	#define _SPL_BUILD 0
	161	#endif
	162
e9c8d49d SG	163	#if !_DEBUG && CONFIG_IS_ENABLED(LOG)
	164
	165	#define debug_cond(cond, fmt, args...) \
	166	do { \
	167	if (1) \
	168	log(LOG_CATEGORY, LOGL_DEBUG, fmt, ##args); \
	169	} while (0)
	170
	171	#else /* _DEBUG */
	172
0e98b0a6 SG	173	/*
	174	* Output a debug text when condition "cond" is met. The "cond" should be
	175	* computed by a preprocessor in the best case, allowing for the best
	176	* optimization.
	177	*/
	178	#define debug_cond(cond, fmt, args...) \
	179	do { \
	180	if (cond) \
	181	printf(pr_fmt(fmt), ##args); \
	182	} while (0)
	183
e9c8d49d SG	184	#endif /* _DEBUG */
e9c8d49d SG	185
0e98b0a6 SG	186	/* Show a message if DEBUG is defined in a file */
	187	#define debug(fmt, args...) \
	188	debug_cond(_DEBUG, fmt, ##args)
	189
	190	/* Show a message if not in SPL */
	191	#define warn_non_spl(fmt, args...) \
	192	debug_cond(!_SPL_BUILD, fmt, ##args)
	193
	194	/*
	195	* An assertion is run-time check done in debug mode only. If DEBUG is not
	196	* defined then it is skipped. If DEBUG is defined and the assertion fails,
	197	* then it calls panic*( which may or may not reset/halt U-Boot (see
	198	* CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
	199	* before release, and after release it is hoped that they don't matter. But
	200	* in any case these failing assertions cannot be fixed with a reset (which
	201	* may just do the same assertion again).
	202	*/
	203	void __assert_fail(const char assertion, const char file, unsigned int line,
	204	const char *function);
b236f8c0 HS	205
	206	/**
	207	* assert() - assert expression is true
	208	*
	209	* If the expression x evaluates to false and _DEBUG evaluates to true, a panic
	210	* message is written and the system stalls. The value of _DEBUG is set to true
	211	* if DEBUG is defined before including common.h.
	212	*
	213	* The expression x is always executed irrespective of the value of _DEBUG.
	214	*
	215	* @x: expression to test
	216	*/
0e98b0a6 SG	217	#define assert(x) \
	218	({ if (!(x) && _DEBUG) \
	219	__assert_fail(#x, __FILE__, __LINE__, __func__); })
	220
4d8d3056 SG	221	#if CONFIG_IS_ENABLED(LOG) && defined(CONFIG_LOG_ERROR_RETURN)
	222	/*
	223	* Log an error return value, possibly with a message. Usage:
	224	*
	225	* return log_ret(fred_call());
	226	*
	227	* or:
	228	*
	229	* return log_msg_ret("fred failed", fred_call());
	230	*/
3707c6ee SG	231	#define log_ret(_ret) ({ \
	232	int __ret = (_ret); \
	233	if (__ret < 0) \
	234	log(LOG_CATEGORY, LOGL_ERR, "returning err=%d\n", __ret); \
	235	__ret; \
	236	})
b616cef9 SG	237	#define log_msg_ret(_msg, _ret) ({ \
	238	int __ret = (_ret); \
	239	if (__ret < 0) \
	240	log(LOG_CATEGORY, LOGL_ERR, "%s: returning err=%d\n", _msg, \
	241	__ret); \
	242	__ret; \
	243	})
3707c6ee	244	#else
4d8d3056	245	/* Non-logging versions of the above which just return the error code */
3707c6ee	246	#define log_ret(_ret) (_ret)
4d8d3056	247	#define log_msg_ret(_msg, _ret) ((void)(_msg), _ret)
3707c6ee SG	248	#endif
3707c6ee SG	249
e9c8d49d SG	250	/**
	251	* struct log_rec - a single log record
	252	*
	253	* Holds information about a single record in the log
	254	*
	255	* Members marked as 'not allocated' are stored as pointers and the caller is
	256	* responsible for making sure that the data pointed to is not overwritten.
	257	* Memebers marked as 'allocated' are allocated (e.g. via strdup()) by the log
	258	* system.
	259	*
	260	* @cat: Category, representing a uclass or part of U-Boot
	261	* @level: Severity level, less severe is higher
	262	* @file: Name of file where the log record was generated (not allocated)
	263	* @line: Line number where the log record was generated
	264	* @func: Function where the log record was generated (not allocated)
	265	* @msg: Log message (allocated)
	266	*/
	267	struct log_rec {
	268	enum log_category_t cat;
	269	enum log_level_t level;
	270	const char *file;
	271	int line;
	272	const char *func;
	273	const char *msg;
	274	};
	275
	276	struct log_device;
	277
	278	/**
	279	* struct log_driver - a driver which accepts and processes log records
	280	*
	281	* @name: Name of driver
	282	*/
	283	struct log_driver {
	284	const char *name;
	285	/**
	286	* emit() - emit a log record
	287	*
	288	* Called by the log system to pass a log record to a particular driver
	289	* for processing. The filter is checked before calling this function.
	290	*/
	291	int (emit)(struct log_device ldev, struct log_rec *rec);
	292	};
	293
	294	/**
	295	* struct log_device - an instance of a log driver
	296	*
	297	* Since drivers are set up at build-time we need to have a separate device for
	298	* the run-time aspects of drivers (currently just a list of filters to apply
	299	* to records send to this device).
	300	*
	301	* @next_filter_num: Seqence number of next filter filter added (0=no filters
	302	* yet). This increments with each new filter on the device, but never
	303	* decrements
	304	* @drv: Pointer to driver for this device
	305	* @filter_head: List of filters for this device
	306	* @sibling_node: Next device in the list of all devices
	307	*/
	308	struct log_device {
	309	int next_filter_num;
	310	struct log_driver *drv;
	311	struct list_head filter_head;
	312	struct list_head sibling_node;
	313	};
314
315	enum {
316	LOGF_MAX_CATEGORIES = 5, /* maximum categories per filter */
317	};
318
319	enum log_filter_flags {
320	LOGFF_HAS_CAT = 1 << 0, /* Filter has a category list */
321	};
322
323	/**
324	* struct log_filter - criterial to filter out log messages
325	*
326	* @filter_num: Sequence number of this filter. This is returned when adding a
327	* new filter, and must be provided when removing a previously added
328	* filter.
329	* @flags: Flags for this filter (LOGFF_...)
330	* @cat_list: List of categories to allow (terminated by LOGC_none). If empty
331	* then all categories are permitted. Up to LOGF_MAX_CATEGORIES entries
332	* can be provided
333	* @max_level: Maximum log level to allow
334	* @file_list: List of files to allow, separated by comma. If NULL then all
335	* files are permitted
336	* @sibling_node: Next filter in the list of filters for this log device
337	*/
338	struct log_filter {
339	int filter_num;
340	int flags;
341	enum log_category_t cat_list[LOGF_MAX_CATEGORIES];
342	enum log_level_t max_level;
343	const char *file_list;
344	struct list_head sibling_node;
345	};
346
347	#define LOG_DRIVER(_name) \
348	ll_entry_declare(struct log_driver, _name, log_driver)
349
f941c8d7 SG	350	/**
	351	* log_get_cat_name() - Get the name of a category
	352	*
	353	* @cat: Category to look up
c2e4e7e6 SG	354	* @return category name (which may be a uclass driver name) if found, or
c2e4e7e6 SG	355	* "<invalid>" if invalid, or "<missing>" if not found
f941c8d7 SG	356	*/
	357	const char *log_get_cat_name(enum log_category_t cat);
	358
	359	/**
	360	* log_get_cat_by_name() - Look up a category by name
	361	*
	362	* @name: Name to look up
	363	* @return category ID, or LOGC_NONE if not found
	364	*/
	365	enum log_category_t log_get_cat_by_name(const char *name);
	366
	367	/**
	368	* log_get_level_name() - Get the name of a log level
	369	*
	370	* @level: Log level to look up
	371	* @return log level name (in ALL CAPS)
	372	*/
	373	const char *log_get_level_name(enum log_level_t level);
	374
	375	/**
	376	* log_get_level_by_name() - Look up a log level by name
	377	*
	378	* @name: Name to look up
	379	* @return log level ID, or LOGL_NONE if not found
	380	*/
	381	enum log_level_t log_get_level_by_name(const char *name);
	382
3b73e8d0 SG	383	/* Log format flags (bit numbers) for gd->log_fmt. See log_fmt_chars */
	384	enum log_fmt {
	385	LOGF_CAT = 0,
	386	LOGF_LEVEL,
	387	LOGF_FILE,
	388	LOGF_LINE,
	389	LOGF_FUNC,
	390	LOGF_MSG,
	391
	392	LOGF_COUNT,
	393	LOGF_DEFAULT = (1 << LOGF_FUNC) \| (1 << LOGF_MSG),
	394	LOGF_ALL = 0x3f,
	395	};
	396
ef11ed82 SG	397	/* Handle the 'log test' command */
	398	int do_log_test(cmd_tbl_t cmdtp, int flag, int argc, char const argv[]);
	399
e9c8d49d SG	400	/**
	401	* log_add_filter() - Add a new filter to a log device
	402	*
	403	* @drv_name: Driver name to add the filter to (since each driver only has a
	404	* single device)
	405	* @cat_list: List of categories to allow (terminated by LOGC_none). If empty
	406	* then all categories are permitted. Up to LOGF_MAX_CATEGORIES entries
	407	* can be provided
	408	* @max_level: Maximum log level to allow
	409	* @file_list: List of files to allow, separated by comma. If NULL then all
	410	* files are permitted
	411	* @return the sequence number of the new filter (>=0) if the filter was added,
	412	* or a -ve value on error
	413	*/
	414	int log_add_filter(const char *drv_name, enum log_category_t cat_list[],
	415	enum log_level_t max_level, const char *file_list);
	416
	417	/**
	418	* log_remove_filter() - Remove a filter from a log device
	419	*
	420	* @drv_name: Driver name to remove the filter from (since each driver only has
	421	* a single device)
	422	* @filter_num: Filter number to remove (as returned by log_add_filter())
	423	* @return 0 if the filter was removed, -ENOENT if either the driver or the
	424	* filter number was not found
	425	*/
	426	int log_remove_filter(const char *drv_name, int filter_num);
	427
	428	#if CONFIG_IS_ENABLED(LOG)
	429	/**
	430	* log_init() - Set up the log system ready for use
	431	*
	432	* @return 0 if OK, -ENOMEM if out of memory
	433	*/
	434	int log_init(void);
	435	#else
	436	static inline int log_init(void)
	437	{
	438	return 0;
	439	}
	440	#endif
	441
0e98b0a6	442	#endif