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

/* SPDX-License-Identifier: GPL-2.0+ */
/*
 * Logging support
 *
 * Copyright (c) 2017 Google, Inc
 * Written by Simon Glass <sjg@chromium.org>
 */

#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,
	LOGC_ARCH,
	LOGC_BOARD,
	LOGC_CORE,
	LOGC_DM,	/* Core driver-model */
	LOGC_DT,	/* Device-tree */
	LOGC_EFI,	/* EFI implementation */

	LOGC_COUNT,
	LOGC_END,
};

/* 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, ...);

/* 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)
#else
#define _LOG_MAX_LEVEL LOGL_INFO
#endif

/* Emit a log record if the level is less that the maximum */
#define log(_cat, _level, _fmt, _args...) ({ \
	int _l = _level; \
	if (_l <= _LOG_MAX_LEVEL) \
		_log((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);
#define assert(x) \
	({ if (!(x) && _DEBUG) \
		__assert_fail(#x, __FILE__, __LINE__, __func__); })

#ifdef CONFIG_LOG_ERROR_RETURN
#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
#define log_ret(_ret) (_ret)
#define log_msg_ret(_ret) (_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 <sjg@chromium.org>
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 {
	17	LOGL_EMERG = 0, /U-Boot is unstable /
	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
	42	LOGC_NONE = UCLASS_COUNT,
	43	LOGC_ARCH,
	44	LOGC_BOARD,
	45	LOGC_CORE,
f941c8d7 SG	46	LOGC_DM, /* Core driver-model */
f941c8d7 SG	47	LOGC_DT, /* Device-tree */
d8d8997b	48	LOGC_EFI, /* EFI implementation */
e9c8d49d SG	49
	50	LOGC_COUNT,
	51	LOGC_END,
	52	};
	53
	54	/* Helper to cast a uclass ID to a log category */
	55	static inline int log_uc_cat(enum uclass_id id)
	56	{
	57	return (enum log_category_t)id;
	58	}
	59
	60	/**
	61	* _log() - Internal function to emit a new log record
	62	*
	63	* @cat: Category of log record (indicating which subsystem generated it)
	64	* @level: Level of log record (indicating its severity)
	65	* @file: File name of file where log record was generated
	66	* @line: Line number in file where log record was generated
	67	* @func: Function where log record was generated
	68	* @fmt: printf() format string for log record
	69	* @...: Optional parameters, according to the format string @fmt
	70	* @return 0 if log record was emitted, -ve on error
	71	*/
	72	int _log(enum log_category_t cat, enum log_level_t level, const char *file,
	73	int line, const char func, const char fmt, ...);
	74
	75	/* Define this at the top of a file to add a prefix to debug messages */
	76	#ifndef pr_fmt
	77	#define pr_fmt(fmt) fmt
	78	#endif
	79
	80	/* Use a default category if this file does not supply one */
	81	#ifndef LOG_CATEGORY
	82	#define LOG_CATEGORY LOGC_NONE
	83	#endif
	84
	85	/*
	86	* This header may be including when CONFIG_LOG is disabled, in which case
	87	* CONFIG_LOG_MAX_LEVEL is not defined. Add a check for this.
	88	*/
	89	#if CONFIG_IS_ENABLED(LOG)
	90	#define _LOG_MAX_LEVEL CONFIG_VAL(LOG_MAX_LEVEL)
	91	#else
	92	#define _LOG_MAX_LEVEL LOGL_INFO
	93	#endif
	94
	95	/* Emit a log record if the level is less that the maximum */
	96	#define log(_cat, _level, _fmt, _args...) ({ \
	97	int _l = _level; \
	98	if (_l <= _LOG_MAX_LEVEL) \
	99	_log((enum log_category_t)(_cat), _l, __FILE__, __LINE__, \
	100	__func__, \
	101	pr_fmt(_fmt), ##_args); \
	102	})
	103
0e98b0a6 SG	104	#ifdef DEBUG
	105	#define _DEBUG 1
	106	#else
	107	#define _DEBUG 0
	108	#endif
	109
	110	#ifdef CONFIG_SPL_BUILD
	111	#define _SPL_BUILD 1
	112	#else
	113	#define _SPL_BUILD 0
	114	#endif
	115
e9c8d49d SG	116	#if !_DEBUG && CONFIG_IS_ENABLED(LOG)
	117
	118	#define debug_cond(cond, fmt, args...) \
	119	do { \
	120	if (1) \
	121	log(LOG_CATEGORY, LOGL_DEBUG, fmt, ##args); \
	122	} while (0)
	123
	124	#else /* _DEBUG */
	125
0e98b0a6 SG	126	/*
	127	* Output a debug text when condition "cond" is met. The "cond" should be
	128	* computed by a preprocessor in the best case, allowing for the best
	129	* optimization.
	130	*/
	131	#define debug_cond(cond, fmt, args...) \
	132	do { \
	133	if (cond) \
	134	printf(pr_fmt(fmt), ##args); \
	135	} while (0)
	136
e9c8d49d SG	137	#endif /* _DEBUG */
e9c8d49d SG	138
0e98b0a6 SG	139	/* Show a message if DEBUG is defined in a file */
	140	#define debug(fmt, args...) \
	141	debug_cond(_DEBUG, fmt, ##args)
	142
	143	/* Show a message if not in SPL */
	144	#define warn_non_spl(fmt, args...) \
	145	debug_cond(!_SPL_BUILD, fmt, ##args)
	146
	147	/*
	148	* An assertion is run-time check done in debug mode only. If DEBUG is not
	149	* defined then it is skipped. If DEBUG is defined and the assertion fails,
	150	* then it calls panic*( which may or may not reset/halt U-Boot (see
	151	* CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
	152	* before release, and after release it is hoped that they don't matter. But
	153	* in any case these failing assertions cannot be fixed with a reset (which
	154	* may just do the same assertion again).
	155	*/
	156	void __assert_fail(const char assertion, const char file, unsigned int line,
	157	const char *function);
	158	#define assert(x) \
	159	({ if (!(x) && _DEBUG) \
	160	__assert_fail(#x, __FILE__, __LINE__, __func__); })
	161
3707c6ee SG	162	#ifdef CONFIG_LOG_ERROR_RETURN
	163	#define log_ret(_ret) ({ \
	164	int __ret = (_ret); \
	165	if (__ret < 0) \
	166	log(LOG_CATEGORY, LOGL_ERR, "returning err=%d\n", __ret); \
	167	__ret; \
	168	})
b616cef9 SG	169	#define log_msg_ret(_msg, _ret) ({ \
	170	int __ret = (_ret); \
	171	if (__ret < 0) \
	172	log(LOG_CATEGORY, LOGL_ERR, "%s: returning err=%d\n", _msg, \
	173	__ret); \
	174	__ret; \
	175	})
3707c6ee SG	176	#else
3707c6ee SG	177	#define log_ret(_ret) (_ret)
b616cef9	178	#define log_msg_ret(_ret) (_ret)
3707c6ee SG	179	#endif
3707c6ee SG	180
e9c8d49d SG	181	/**
	182	* struct log_rec - a single log record
	183	*
	184	* Holds information about a single record in the log
	185	*
	186	* Members marked as 'not allocated' are stored as pointers and the caller is
	187	* responsible for making sure that the data pointed to is not overwritten.
	188	* Memebers marked as 'allocated' are allocated (e.g. via strdup()) by the log
	189	* system.
	190	*
	191	* @cat: Category, representing a uclass or part of U-Boot
	192	* @level: Severity level, less severe is higher
	193	* @file: Name of file where the log record was generated (not allocated)
	194	* @line: Line number where the log record was generated
	195	* @func: Function where the log record was generated (not allocated)
	196	* @msg: Log message (allocated)
	197	*/
	198	struct log_rec {
	199	enum log_category_t cat;
	200	enum log_level_t level;
	201	const char *file;
	202	int line;
	203	const char *func;
	204	const char *msg;
	205	};
	206
	207	struct log_device;
	208
	209	/**
	210	* struct log_driver - a driver which accepts and processes log records
	211	*
	212	* @name: Name of driver
	213	*/
	214	struct log_driver {
	215	const char *name;
	216	/**
	217	* emit() - emit a log record
	218	*
	219	* Called by the log system to pass a log record to a particular driver
	220	* for processing. The filter is checked before calling this function.
	221	*/
	222	int (emit)(struct log_device ldev, struct log_rec *rec);
	223	};
	224
	225	/**
	226	* struct log_device - an instance of a log driver
	227	*
	228	* Since drivers are set up at build-time we need to have a separate device for
	229	* the run-time aspects of drivers (currently just a list of filters to apply
	230	* to records send to this device).
	231	*
	232	* @next_filter_num: Seqence number of next filter filter added (0=no filters
	233	* yet). This increments with each new filter on the device, but never
	234	* decrements
	235	* @drv: Pointer to driver for this device
	236	* @filter_head: List of filters for this device
	237	* @sibling_node: Next device in the list of all devices
	238	*/
	239	struct log_device {
	240	int next_filter_num;
	241	struct log_driver *drv;
	242	struct list_head filter_head;
	243	struct list_head sibling_node;
	244	};
245
246	enum {
247	LOGF_MAX_CATEGORIES = 5, /* maximum categories per filter */
248	};
249
250	enum log_filter_flags {
251	LOGFF_HAS_CAT = 1 << 0, /* Filter has a category list */
252	};
253
254	/**
255	* struct log_filter - criterial to filter out log messages
256	*
257	* @filter_num: Sequence number of this filter. This is returned when adding a
258	* new filter, and must be provided when removing a previously added
259	* filter.
260	* @flags: Flags for this filter (LOGFF_...)
261	* @cat_list: List of categories to allow (terminated by LOGC_none). If empty
262	* then all categories are permitted. Up to LOGF_MAX_CATEGORIES entries
263	* can be provided
264	* @max_level: Maximum log level to allow
265	* @file_list: List of files to allow, separated by comma. If NULL then all
266	* files are permitted
267	* @sibling_node: Next filter in the list of filters for this log device
268	*/
269	struct log_filter {
270	int filter_num;
271	int flags;
272	enum log_category_t cat_list[LOGF_MAX_CATEGORIES];
273	enum log_level_t max_level;
274	const char *file_list;
275	struct list_head sibling_node;
276	};
277
278	#define LOG_DRIVER(_name) \
279	ll_entry_declare(struct log_driver, _name, log_driver)
280
f941c8d7 SG	281	/**
	282	* log_get_cat_name() - Get the name of a category
	283	*
	284	* @cat: Category to look up
c2e4e7e6 SG	285	* @return category name (which may be a uclass driver name) if found, or
c2e4e7e6 SG	286	* "<invalid>" if invalid, or "<missing>" if not found
f941c8d7 SG	287	*/
	288	const char *log_get_cat_name(enum log_category_t cat);
	289
	290	/**
	291	* log_get_cat_by_name() - Look up a category by name
	292	*
	293	* @name: Name to look up
	294	* @return category ID, or LOGC_NONE if not found
	295	*/
	296	enum log_category_t log_get_cat_by_name(const char *name);
	297
	298	/**
	299	* log_get_level_name() - Get the name of a log level
	300	*
	301	* @level: Log level to look up
	302	* @return log level name (in ALL CAPS)
	303	*/
	304	const char *log_get_level_name(enum log_level_t level);
	305
	306	/**
	307	* log_get_level_by_name() - Look up a log level by name
	308	*
	309	* @name: Name to look up
	310	* @return log level ID, or LOGL_NONE if not found
	311	*/
	312	enum log_level_t log_get_level_by_name(const char *name);
	313
3b73e8d0 SG	314	/* Log format flags (bit numbers) for gd->log_fmt. See log_fmt_chars */
	315	enum log_fmt {
	316	LOGF_CAT = 0,
	317	LOGF_LEVEL,
	318	LOGF_FILE,
	319	LOGF_LINE,
	320	LOGF_FUNC,
	321	LOGF_MSG,
	322
	323	LOGF_COUNT,
	324	LOGF_DEFAULT = (1 << LOGF_FUNC) \| (1 << LOGF_MSG),
	325	LOGF_ALL = 0x3f,
	326	};
	327
ef11ed82 SG	328	/* Handle the 'log test' command */
	329	int do_log_test(cmd_tbl_t cmdtp, int flag, int argc, char const argv[]);
	330
e9c8d49d SG	331	/**
	332	* log_add_filter() - Add a new filter to a log device
	333	*
	334	* @drv_name: Driver name to add the filter to (since each driver only has a
	335	* single device)
	336	* @cat_list: List of categories to allow (terminated by LOGC_none). If empty
	337	* then all categories are permitted. Up to LOGF_MAX_CATEGORIES entries
	338	* can be provided
	339	* @max_level: Maximum log level to allow
	340	* @file_list: List of files to allow, separated by comma. If NULL then all
	341	* files are permitted
	342	* @return the sequence number of the new filter (>=0) if the filter was added,
	343	* or a -ve value on error
	344	*/
	345	int log_add_filter(const char *drv_name, enum log_category_t cat_list[],
	346	enum log_level_t max_level, const char *file_list);
	347
	348	/**
	349	* log_remove_filter() - Remove a filter from a log device
	350	*
	351	* @drv_name: Driver name to remove the filter from (since each driver only has
	352	* a single device)
	353	* @filter_num: Filter number to remove (as returned by log_add_filter())
	354	* @return 0 if the filter was removed, -ENOENT if either the driver or the
	355	* filter number was not found
	356	*/
	357	int log_remove_filter(const char *drv_name, int filter_num);
	358
	359	#if CONFIG_IS_ENABLED(LOG)
	360	/**
	361	* log_init() - Set up the log system ready for use
	362	*
	363	* @return 0 if OK, -ENOMEM if out of memory
	364	*/
	365	int log_init(void);
	366	#else
	367	static inline int log_init(void)
	368	{
	369	return 0;
	370	}
	371	#endif
	372
0e98b0a6	373	#endif