blob: 6e84f080ef3d1e763b55e08b548585fa34f019fe [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Simon Glass0e98b0a2017-12-04 13:48:20 -07002/*
3 * Logging support
4 *
5 * Copyright (c) 2017 Google, Inc
6 * Written by Simon Glass <sjg@chromium.org>
Simon Glass0e98b0a2017-12-04 13:48:20 -07007 */
8
9#ifndef __LOG_H
10#define __LOG_H
11
Simon Glass90526e92020-05-10 11:39:56 -060012#include <stdio.h>
Simon Glass09140112020-05-10 11:40:03 -060013#include <linker_lists.h>
Simon Glasse9c8d492017-12-04 13:48:24 -070014#include <dm/uclass-id.h>
Heinrich Schuchardt3c21d772020-06-17 21:52:44 +020015#include <linux/bitops.h>
Simon Glasse9c8d492017-12-04 13:48:24 -070016#include <linux/list.h>
17
Simon Glass09140112020-05-10 11:40:03 -060018struct cmd_tbl;
19
Sean Anderson00ebb7f2020-10-27 19:55:40 -040020/**
21 * enum log_level_t - Log levels supported, ranging from most to least important
22 */
Simon Glasse9c8d492017-12-04 13:48:24 -070023enum log_level_t {
Sean Anderson00ebb7f2020-10-27 19:55:40 -040024 /** @LOGL_EMERG: U-Boot is unstable */
25 LOGL_EMERG = 0,
26 /** @LOGL_ALERT: Action must be taken immediately */
27 LOGL_ALERT,
28 /** @LOGL_CRIT: Critical conditions */
29 LOGL_CRIT,
30 /** @LOGL_ERR: Error that prevents something from working */
31 LOGL_ERR,
Heinrich Schuchardt9e925d02020-11-30 09:04:48 +010032 /** @LOGL_WARNING: Warning may prevent optimal operation */
Sean Anderson00ebb7f2020-10-27 19:55:40 -040033 LOGL_WARNING,
34 /** @LOGL_NOTICE: Normal but significant condition, printf() */
35 LOGL_NOTICE,
36 /** @LOGL_INFO: General information message */
37 LOGL_INFO,
38 /** @LOGL_DEBUG: Basic debug-level message */
39 LOGL_DEBUG,
40 /** @LOGL_DEBUG_CONTENT: Debug message showing full message content */
41 LOGL_DEBUG_CONTENT,
42 /** @LOGL_DEBUG_IO: Debug message showing hardware I/O access */
43 LOGL_DEBUG_IO,
Simon Glasse9c8d492017-12-04 13:48:24 -070044
Sean Anderson00ebb7f2020-10-27 19:55:40 -040045 /** @LOGL_COUNT: Total number of valid log levels */
Simon Glasse9c8d492017-12-04 13:48:24 -070046 LOGL_COUNT,
Sean Anderson00ebb7f2020-10-27 19:55:40 -040047 /** @LOGL_NONE: Used to indicate that there is no valid log level */
Simon Glassf941c8d2017-12-28 13:14:16 -070048 LOGL_NONE,
49
Sean Anderson00ebb7f2020-10-27 19:55:40 -040050 /** @LOGL_LEVEL_MASK: Mask for valid log levels */
51 LOGL_LEVEL_MASK = 0xf,
52 /** @LOGL_FORCE_DEBUG: Mask to force output due to LOG_DEBUG */
53 LOGL_FORCE_DEBUG = 0x10,
Simon Glass52d3df72020-09-12 11:13:34 -060054
Sean Anderson00ebb7f2020-10-27 19:55:40 -040055 /** @LOGL_FIRST: The first, most-important log level */
Simon Glasse9c8d492017-12-04 13:48:24 -070056 LOGL_FIRST = LOGL_EMERG,
Sean Anderson00ebb7f2020-10-27 19:55:40 -040057 /** @LOGL_MAX: The last, least-important log level */
Simon Glassf941c8d2017-12-28 13:14:16 -070058 LOGL_MAX = LOGL_DEBUG_IO,
Sean Anderson00ebb7f2020-10-27 19:55:40 -040059 /** @LOGL_CONT: Use same log level as in previous call */
60 LOGL_CONT = -1,
Simon Glasse9c8d492017-12-04 13:48:24 -070061};
62
63/**
Sean Anderson00ebb7f2020-10-27 19:55:40 -040064 * enum log_category_t - Log categories supported.
65 *
66 * Log categories between %LOGC_FIRST and %LOGC_NONE correspond to uclasses
67 * (i.e. &enum uclass_id), but there are also some more generic categories.
Simon Glass80212962020-09-27 18:46:13 -060068 *
69 * Remember to update log_cat_name[] after adding a new category.
Simon Glasse9c8d492017-12-04 13:48:24 -070070 */
71enum log_category_t {
Sean Anderson00ebb7f2020-10-27 19:55:40 -040072 /** @LOGC_FIRST: First log category */
Simon Glasse9c8d492017-12-04 13:48:24 -070073 LOGC_FIRST = 0, /* First part mirrors UCLASS_... */
74
Sean Anderson00ebb7f2020-10-27 19:55:40 -040075 /** @LOGC_NONE: Default log category */
Simon Glass0bf96452018-10-01 12:22:32 -060076 LOGC_NONE = UCLASS_COUNT, /* First number is after all uclasses */
Sean Anderson00ebb7f2020-10-27 19:55:40 -040077 /** @LOGC_ARCH: Related to arch-specific code */
78 LOGC_ARCH,
79 /** @LOGC_BOARD: Related to board-specific code */
80 LOGC_BOARD,
81 /** @LOGC_CORE: Related to core features (non-driver-model) */
82 LOGC_CORE,
83 /** @LOGC_DM: Core driver-model */
84 LOGC_DM,
85 /** @LOGC_DT: Device-tree */
86 LOGC_DT,
87 /** @LOGC_EFI: EFI implementation */
88 LOGC_EFI,
89 /** @LOGC_ALLOC: Memory allocation */
90 LOGC_ALLOC,
91 /** @LOGC_SANDBOX: Related to the sandbox board */
92 LOGC_SANDBOX,
93 /** @LOGC_BLOBLIST: Bloblist */
94 LOGC_BLOBLIST,
95 /** @LOGC_DEVRES: Device resources (``devres_...`` functions) */
96 LOGC_DEVRES,
97 /** @LOGC_ACPI: Advanced Configuration and Power Interface (ACPI) */
Simon Glass7ca28502020-04-09 10:27:38 -060098 LOGC_ACPI,
Simon Glassd61e7842020-11-29 17:07:04 -070099 /** @LOGC_BOOT: Related to boot process / boot image processing */
100 LOGC_BOOT,
Simon Glass87a5d1b2022-03-04 08:43:00 -0700101 /** @LOGC_EVENT: Related to event and event handling */
102 LOGC_EVENT,
Simon Glass4f6daac2023-01-28 15:00:16 -0700103 /** @LOGC_FS: Related to filesystems */
104 LOGC_FS,
Simon Glassc98cb512023-06-01 10:22:43 -0600105 /** @LOGC_EXPO: Related to expo handling */
106 LOGC_EXPO,
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400107 /** @LOGC_COUNT: Number of log categories */
108 LOGC_COUNT,
109 /** @LOGC_END: Sentinel value for lists of log categories */
110 LOGC_END,
111 /** @LOGC_CONT: Use same category as in previous call */
112 LOGC_CONT = -1,
Simon Glasse9c8d492017-12-04 13:48:24 -0700113};
114
115/* Helper to cast a uclass ID to a log category */
116static inline int log_uc_cat(enum uclass_id id)
117{
118 return (enum log_category_t)id;
119}
120
121/**
122 * _log() - Internal function to emit a new log record
123 *
124 * @cat: Category of log record (indicating which subsystem generated it)
125 * @level: Level of log record (indicating its severity)
126 * @file: File name of file where log record was generated
127 * @line: Line number in file where log record was generated
128 * @func: Function where log record was generated
129 * @fmt: printf() format string for log record
130 * @...: Optional parameters, according to the format string @fmt
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400131 * Return: 0 if log record was emitted, -ve on error
Simon Glasse9c8d492017-12-04 13:48:24 -0700132 */
133int _log(enum log_category_t cat, enum log_level_t level, const char *file,
Simon Glassed4e9332019-01-07 16:44:19 -0700134 int line, const char *func, const char *fmt, ...)
135 __attribute__ ((format (__printf__, 6, 7)));
Simon Glasse9c8d492017-12-04 13:48:24 -0700136
Simon Glass58b4b712021-05-08 07:00:06 -0600137/**
138 * _log_buffer - Internal function to print data buffer in hex and ascii form
139 *
140 * @cat: Category of log record (indicating which subsystem generated it)
141 * @level: Level of log record (indicating its severity)
142 * @file: File name of file where log record was generated
143 * @line: Line number in file where log record was generated
144 * @func: Function where log record was generated
145 * @addr: Starting address to display at start of line
146 * @data: pointer to data buffer
147 * @width: data value width. May be 1, 2, or 4.
148 * @count: number of values to display
149 * @linelen: Number of values to print per line; specify 0 for default length
150 */
151int _log_buffer(enum log_category_t cat, enum log_level_t level,
152 const char *file, int line, const char *func, ulong addr,
153 const void *data, uint width, uint count, uint linelen);
154
Simon Glasse9c8d492017-12-04 13:48:24 -0700155/* Define this at the top of a file to add a prefix to debug messages */
156#ifndef pr_fmt
157#define pr_fmt(fmt) fmt
158#endif
159
160/* Use a default category if this file does not supply one */
161#ifndef LOG_CATEGORY
162#define LOG_CATEGORY LOGC_NONE
163#endif
164
165/*
166 * This header may be including when CONFIG_LOG is disabled, in which case
167 * CONFIG_LOG_MAX_LEVEL is not defined. Add a check for this.
168 */
169#if CONFIG_IS_ENABLED(LOG)
170#define _LOG_MAX_LEVEL CONFIG_VAL(LOG_MAX_LEVEL)
Simon Glasse1cbd912021-05-08 13:46:54 -0600171#else
172#define _LOG_MAX_LEVEL LOGL_INFO
173#endif
174
Heinrich Schuchardt24967962021-01-04 08:02:54 +0100175#define log_emer(_fmt...) log(LOG_CATEGORY, LOGL_EMERG, ##_fmt)
176#define log_alert(_fmt...) log(LOG_CATEGORY, LOGL_ALERT, ##_fmt)
177#define log_crit(_fmt...) log(LOG_CATEGORY, LOGL_CRIT, ##_fmt)
Simon Glasscdd140a2018-10-01 11:55:06 -0600178#define log_err(_fmt...) log(LOG_CATEGORY, LOGL_ERR, ##_fmt)
179#define log_warning(_fmt...) log(LOG_CATEGORY, LOGL_WARNING, ##_fmt)
180#define log_notice(_fmt...) log(LOG_CATEGORY, LOGL_NOTICE, ##_fmt)
181#define log_info(_fmt...) log(LOG_CATEGORY, LOGL_INFO, ##_fmt)
182#define log_debug(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG, ##_fmt)
183#define log_content(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG_CONTENT, ##_fmt)
184#define log_io(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG_IO, ##_fmt)
Heinrich Schuchardt24967962021-01-04 08:02:54 +0100185#define log_cont(_fmt...) log(LOGC_CONT, LOGL_CONT, ##_fmt)
Simon Glasse9c8d492017-12-04 13:48:24 -0700186
Simon Glassf9811e82019-02-16 20:24:37 -0700187#ifdef LOG_DEBUG
Simon Glass52d3df72020-09-12 11:13:34 -0600188#define _LOG_DEBUG LOGL_FORCE_DEBUG
Patrick Delaunay54e89a82022-07-12 09:39:49 +0200189#ifndef DEBUG
190#define DEBUG
191#endif
Simon Glassf9811e82019-02-16 20:24:37 -0700192#else
193#define _LOG_DEBUG 0
194#endif
Simon Glass4d8d3052018-11-15 18:43:49 -0700195
Simon Glasse1cbd912021-05-08 13:46:54 -0600196#if CONFIG_IS_ENABLED(LOG)
197
Simon Glasse9c8d492017-12-04 13:48:24 -0700198/* Emit a log record if the level is less that the maximum */
199#define log(_cat, _level, _fmt, _args...) ({ \
200 int _l = _level; \
Simon Glasse1cbd912021-05-08 13:46:54 -0600201 if (_LOG_DEBUG != 0 || _l <= _LOG_MAX_LEVEL) \
Simon Glass52d3df72020-09-12 11:13:34 -0600202 _log((enum log_category_t)(_cat), \
203 (enum log_level_t)(_l | _LOG_DEBUG), __FILE__, \
204 __LINE__, __func__, \
Simon Glasse9c8d492017-12-04 13:48:24 -0700205 pr_fmt(_fmt), ##_args); \
206 })
Simon Glass58b4b712021-05-08 07:00:06 -0600207
208/* Emit a dump if the level is less that the maximum */
209#define log_buffer(_cat, _level, _addr, _data, _width, _count, _linelen) ({ \
210 int _l = _level; \
211 if (_LOG_DEBUG != 0 || _l <= _LOG_MAX_LEVEL) \
212 _log_buffer((enum log_category_t)(_cat), \
213 (enum log_level_t)(_l | _LOG_DEBUG), __FILE__, \
214 __LINE__, __func__, _addr, _data, \
215 _width, _count, _linelen); \
216 })
Simon Glass4d8d3052018-11-15 18:43:49 -0700217#else
Simon Glasse1cbd912021-05-08 13:46:54 -0600218
219/* Note: _LOG_DEBUG != 0 avoids a warning with clang */
220#define log(_cat, _level, _fmt, _args...) ({ \
221 int _l = _level; \
222 if (_LOG_DEBUG != 0 || _l <= LOGL_INFO || \
223 (_DEBUG && _l == LOGL_DEBUG)) \
224 printf(_fmt, ##_args); \
225 })
Simon Glass58b4b712021-05-08 07:00:06 -0600226
227#define log_buffer(_cat, _level, _addr, _data, _width, _count, _linelen) ({ \
228 int _l = _level; \
229 if (_LOG_DEBUG != 0 || _l <= LOGL_INFO || \
230 (_DEBUG && _l == LOGL_DEBUG)) \
231 print_buffer(_addr, _data, _width, _count, _linelen); \
232 })
Simon Glass4d8d3052018-11-15 18:43:49 -0700233#endif
Simon Glasse9c8d492017-12-04 13:48:24 -0700234
Simon Glass0e98b0a2017-12-04 13:48:20 -0700235#ifdef DEBUG
236#define _DEBUG 1
237#else
238#define _DEBUG 0
239#endif
240
241#ifdef CONFIG_SPL_BUILD
242#define _SPL_BUILD 1
243#else
244#define _SPL_BUILD 0
245#endif
246
Simon Glass4ce5b812021-03-26 16:17:28 +1300247#if CONFIG_IS_ENABLED(LOG)
Simon Glasse9c8d492017-12-04 13:48:24 -0700248
Simon Glass4ce5b812021-03-26 16:17:28 +1300249#define debug_cond(cond, fmt, args...) \
250({ \
251 if (cond) \
252 log(LOG_CATEGORY, \
253 (enum log_level_t)(LOGL_FORCE_DEBUG | _LOG_DEBUG), \
254 fmt, ##args); \
Heinrich Schuchardt51763652021-01-04 08:02:53 +0100255})
Simon Glasse9c8d492017-12-04 13:48:24 -0700256
257#else /* _DEBUG */
258
Simon Glass0e98b0a2017-12-04 13:48:20 -0700259/*
260 * Output a debug text when condition "cond" is met. The "cond" should be
261 * computed by a preprocessor in the best case, allowing for the best
262 * optimization.
263 */
Heinrich Schuchardt51763652021-01-04 08:02:53 +0100264#define debug_cond(cond, fmt, args...) \
265({ \
266 if (cond) \
267 printf(pr_fmt(fmt), ##args); \
268})
Simon Glass0e98b0a2017-12-04 13:48:20 -0700269
Simon Glasse9c8d492017-12-04 13:48:24 -0700270#endif /* _DEBUG */
271
Simon Glass0e98b0a2017-12-04 13:48:20 -0700272/* Show a message if DEBUG is defined in a file */
273#define debug(fmt, args...) \
274 debug_cond(_DEBUG, fmt, ##args)
275
276/* Show a message if not in SPL */
277#define warn_non_spl(fmt, args...) \
278 debug_cond(!_SPL_BUILD, fmt, ##args)
279
280/*
281 * An assertion is run-time check done in debug mode only. If DEBUG is not
282 * defined then it is skipped. If DEBUG is defined and the assertion fails,
283 * then it calls panic*( which may or may not reset/halt U-Boot (see
284 * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
285 * before release, and after release it is hoped that they don't matter. But
286 * in any case these failing assertions cannot be fixed with a reset (which
287 * may just do the same assertion again).
288 */
289void __assert_fail(const char *assertion, const char *file, unsigned int line,
290 const char *function);
Heinrich Schuchardtb236f8c2019-07-27 20:21:06 +0200291
292/**
293 * assert() - assert expression is true
294 *
295 * If the expression x evaluates to false and _DEBUG evaluates to true, a panic
296 * message is written and the system stalls. The value of _DEBUG is set to true
297 * if DEBUG is defined before including common.h.
298 *
299 * The expression x is always executed irrespective of the value of _DEBUG.
300 *
301 * @x: expression to test
302 */
Simon Glass0e98b0a2017-12-04 13:48:20 -0700303#define assert(x) \
304 ({ if (!(x) && _DEBUG) \
305 __assert_fail(#x, __FILE__, __LINE__, __func__); })
306
Simon Glasscd01d2d2019-12-29 21:19:10 -0700307/*
308 * This one actually gets compiled in even without DEBUG. It doesn't include the
309 * full pathname as it may be huge. Only use this when the user should be
310 * warning, similar to BUG_ON() in linux.
311 *
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400312 * Return: true if assertion succeeded (condition is true), else false
Simon Glasscd01d2d2019-12-29 21:19:10 -0700313 */
314#define assert_noisy(x) \
315 ({ bool _val = (x); \
316 if (!_val) \
317 __assert_fail(#x, "?", __LINE__, __func__); \
318 _val; \
319 })
320
Simon Glass4d8d3052018-11-15 18:43:49 -0700321#if CONFIG_IS_ENABLED(LOG) && defined(CONFIG_LOG_ERROR_RETURN)
322/*
323 * Log an error return value, possibly with a message. Usage:
324 *
325 * return log_ret(fred_call());
326 *
327 * or:
328 *
Simon Glassb7f134e2022-09-06 20:26:53 -0600329 * return log_msg_ret("get", fred_call());
330 *
331 * It is recommended to use <= 3 characters for the name since this will only
332 * use 4 bytes in rodata
Simon Glass4d8d3052018-11-15 18:43:49 -0700333 */
Simon Glass3707c6e2017-12-28 13:14:23 -0700334#define log_ret(_ret) ({ \
335 int __ret = (_ret); \
336 if (__ret < 0) \
337 log(LOG_CATEGORY, LOGL_ERR, "returning err=%d\n", __ret); \
338 __ret; \
339 })
Simon Glassb616cef2018-06-11 13:07:14 -0600340#define log_msg_ret(_msg, _ret) ({ \
341 int __ret = (_ret); \
342 if (__ret < 0) \
343 log(LOG_CATEGORY, LOGL_ERR, "%s: returning err=%d\n", _msg, \
344 __ret); \
345 __ret; \
346 })
Simon Glass7bd06582021-01-20 20:10:54 -0700347
348/*
349 * Similar to the above, but any non-zero value is consider an error, not just
350 * values less than 0.
351 */
352#define log_retz(_ret) ({ \
353 int __ret = (_ret); \
354 if (__ret) \
355 log(LOG_CATEGORY, LOGL_ERR, "returning err=%d\n", __ret); \
356 __ret; \
357 })
358#define log_msg_retz(_msg, _ret) ({ \
359 int __ret = (_ret); \
360 if (__ret) \
361 log(LOG_CATEGORY, LOGL_ERR, "%s: returning err=%d\n", _msg, \
362 __ret); \
363 __ret; \
364 })
Simon Glass3707c6e2017-12-28 13:14:23 -0700365#else
Simon Glass4d8d3052018-11-15 18:43:49 -0700366/* Non-logging versions of the above which just return the error code */
Simon Glass3707c6e2017-12-28 13:14:23 -0700367#define log_ret(_ret) (_ret)
Simon Glass4d8d3052018-11-15 18:43:49 -0700368#define log_msg_ret(_msg, _ret) ((void)(_msg), _ret)
Simon Glass7bd06582021-01-20 20:10:54 -0700369#define log_retz(_ret) (_ret)
370#define log_msg_retz(_msg, _ret) ((void)(_msg), _ret)
Simon Glass3707c6e2017-12-28 13:14:23 -0700371#endif
372
Simon Glass79d59832021-01-20 20:10:52 -0700373/** * enum log_rec_flags - Flags for a log record */
374enum log_rec_flags {
375 /** @LOGRECF_FORCE_DEBUG: Force output of debug record */
376 LOGRECF_FORCE_DEBUG = BIT(0),
Simon Glass9ad7a6c2021-01-20 20:10:53 -0700377 /** @LOGRECF_CONT: Continuation of previous log record */
378 LOGRECF_CONT = BIT(1),
Simon Glass79d59832021-01-20 20:10:52 -0700379};
380
Simon Glasse9c8d492017-12-04 13:48:24 -0700381/**
382 * struct log_rec - a single log record
383 *
384 * Holds information about a single record in the log
385 *
386 * Members marked as 'not allocated' are stored as pointers and the caller is
387 * responsible for making sure that the data pointed to is not overwritten.
Heinrich Schuchardt9e925d02020-11-30 09:04:48 +0100388 * Members marked as 'allocated' are allocated (e.g. via strdup()) by the log
Simon Glasse9c8d492017-12-04 13:48:24 -0700389 * system.
390 *
Simon Glass52d3df72020-09-12 11:13:34 -0600391 * TODO(sjg@chromium.org): Compress this struct down a bit to reduce space, e.g.
392 * a single u32 for cat, level, line and force_debug
393 *
Simon Glasse9c8d492017-12-04 13:48:24 -0700394 * @cat: Category, representing a uclass or part of U-Boot
395 * @level: Severity level, less severe is higher
Simon Glasse9c8d492017-12-04 13:48:24 -0700396 * @line: Line number where the log record was generated
Simon Glass79d59832021-01-20 20:10:52 -0700397 * @flags: Flags for log record (enum log_rec_flags)
398 * @file: Name of file where the log record was generated (not allocated)
Simon Glasse9c8d492017-12-04 13:48:24 -0700399 * @func: Function where the log record was generated (not allocated)
400 * @msg: Log message (allocated)
401 */
402struct log_rec {
403 enum log_category_t cat;
404 enum log_level_t level;
Simon Glass79d59832021-01-20 20:10:52 -0700405 u16 line;
406 u8 flags;
Simon Glasse9c8d492017-12-04 13:48:24 -0700407 const char *file;
Simon Glasse9c8d492017-12-04 13:48:24 -0700408 const char *func;
409 const char *msg;
410};
411
412struct log_device;
413
Simon Glassb4520302020-09-12 12:28:47 -0600414enum log_device_flags {
415 LOGDF_ENABLE = BIT(0), /* Device is enabled */
416};
417
Simon Glasse9c8d492017-12-04 13:48:24 -0700418/**
419 * struct log_driver - a driver which accepts and processes log records
420 *
421 * @name: Name of driver
Simon Glassb4520302020-09-12 12:28:47 -0600422 * @emit: Method to call to emit a log record via this device
423 * @flags: Initial value for flags (use LOGDF_ENABLE to enable on start-up)
Simon Glasse9c8d492017-12-04 13:48:24 -0700424 */
425struct log_driver {
426 const char *name;
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400427
Simon Glasse9c8d492017-12-04 13:48:24 -0700428 /**
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400429 * @emit: emit a log record
Simon Glasse9c8d492017-12-04 13:48:24 -0700430 *
431 * Called by the log system to pass a log record to a particular driver
432 * for processing. The filter is checked before calling this function.
433 */
434 int (*emit)(struct log_device *ldev, struct log_rec *rec);
Simon Glassb4520302020-09-12 12:28:47 -0600435 unsigned short flags;
Simon Glasse9c8d492017-12-04 13:48:24 -0700436};
437
438/**
439 * struct log_device - an instance of a log driver
440 *
441 * Since drivers are set up at build-time we need to have a separate device for
442 * the run-time aspects of drivers (currently just a list of filters to apply
443 * to records send to this device).
444 *
Heinrich Schuchardt9e925d02020-11-30 09:04:48 +0100445 * @next_filter_num: Sequence number of next filter filter added (0=no filters
Simon Glasse9c8d492017-12-04 13:48:24 -0700446 * yet). This increments with each new filter on the device, but never
447 * decrements
Simon Glassb4520302020-09-12 12:28:47 -0600448 * @flags: Flags for this filter (enum log_device_flags)
Simon Glasse9c8d492017-12-04 13:48:24 -0700449 * @drv: Pointer to driver for this device
450 * @filter_head: List of filters for this device
451 * @sibling_node: Next device in the list of all devices
452 */
453struct log_device {
Simon Glassb4520302020-09-12 12:28:47 -0600454 unsigned short next_filter_num;
455 unsigned short flags;
Simon Glasse9c8d492017-12-04 13:48:24 -0700456 struct log_driver *drv;
457 struct list_head filter_head;
458 struct list_head sibling_node;
459};
460
461enum {
462 LOGF_MAX_CATEGORIES = 5, /* maximum categories per filter */
463};
464
Sean Andersonfe3b1a22020-10-27 19:55:26 -0400465/**
466 * enum log_filter_flags - Flags which modify a filter
467 */
Simon Glasse9c8d492017-12-04 13:48:24 -0700468enum log_filter_flags {
Sean Andersonfe3b1a22020-10-27 19:55:26 -0400469 /** @LOGFF_HAS_CAT: Filter has a category list */
470 LOGFF_HAS_CAT = 1 << 0,
471 /** @LOGFF_DENY: Filter denies matching messages */
472 LOGFF_DENY = 1 << 1,
Sean Anderson40455a62020-10-27 19:55:30 -0400473 /** @LOGFF_LEVEL_MIN: Filter's level is a minimum, not a maximum */
474 LOGFF_LEVEL_MIN = 1 << 2,
Simon Glasse9c8d492017-12-04 13:48:24 -0700475};
476
477/**
Heinrich Schuchardt9e925d02020-11-30 09:04:48 +0100478 * struct log_filter - criteria to filter out log messages
Simon Glasse9c8d492017-12-04 13:48:24 -0700479 *
Sean Andersonfe3b1a22020-10-27 19:55:26 -0400480 * If a message matches all criteria, then it is allowed. If LOGFF_DENY is set,
481 * then it is denied instead.
482 *
Simon Glasse9c8d492017-12-04 13:48:24 -0700483 * @filter_num: Sequence number of this filter. This is returned when adding a
484 * new filter, and must be provided when removing a previously added
485 * filter.
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400486 * @flags: Flags for this filter (``LOGFF_...``)
Sean Andersonb66a9242020-10-27 19:55:21 -0400487 * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400488 * then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
Simon Glasse9c8d492017-12-04 13:48:24 -0700489 * can be provided
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400490 * @level: Maximum (or minimum, if %LOGFF_MIN_LEVEL) log level to allow
Simon Glasse9c8d492017-12-04 13:48:24 -0700491 * @file_list: List of files to allow, separated by comma. If NULL then all
492 * files are permitted
493 * @sibling_node: Next filter in the list of filters for this log device
494 */
495struct log_filter {
496 int filter_num;
497 int flags;
498 enum log_category_t cat_list[LOGF_MAX_CATEGORIES];
Sean Anderson40455a62020-10-27 19:55:30 -0400499 enum log_level_t level;
Simon Glasse9c8d492017-12-04 13:48:24 -0700500 const char *file_list;
501 struct list_head sibling_node;
502};
503
504#define LOG_DRIVER(_name) \
505 ll_entry_declare(struct log_driver, _name, log_driver)
506
Simon Glass3d03ab62020-09-12 12:28:49 -0600507/* Get a pointer to a given driver */
508#define LOG_GET_DRIVER(__name) \
509 ll_entry_get(struct log_driver, __name, log_driver)
510
Simon Glassf941c8d2017-12-28 13:14:16 -0700511/**
512 * log_get_cat_name() - Get the name of a category
513 *
514 * @cat: Category to look up
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400515 * Return: category name (which may be a uclass driver name) if found, or
Sean Anderson1c593a12020-10-27 19:55:34 -0400516 * "<invalid>" if invalid, or "<missing>" if not found. All error
517 * responses begin with '<'.
Simon Glassf941c8d2017-12-28 13:14:16 -0700518 */
519const char *log_get_cat_name(enum log_category_t cat);
520
521/**
522 * log_get_cat_by_name() - Look up a category by name
523 *
524 * @name: Name to look up
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400525 * Return: Category, or %LOGC_NONE if not found
Simon Glassf941c8d2017-12-28 13:14:16 -0700526 */
527enum log_category_t log_get_cat_by_name(const char *name);
528
529/**
530 * log_get_level_name() - Get the name of a log level
531 *
532 * @level: Log level to look up
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400533 * Return: Log level name (in ALL CAPS)
Simon Glassf941c8d2017-12-28 13:14:16 -0700534 */
535const char *log_get_level_name(enum log_level_t level);
536
537/**
538 * log_get_level_by_name() - Look up a log level by name
539 *
540 * @name: Name to look up
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400541 * Return: Log level, or %LOGL_NONE if not found
Simon Glassf941c8d2017-12-28 13:14:16 -0700542 */
543enum log_level_t log_get_level_by_name(const char *name);
544
Sean Anderson3102c1d2020-10-27 19:55:24 -0400545/**
546 * log_device_find_by_name() - Look up a log device by its driver's name
547 *
548 * @drv_name: Name of the driver
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400549 * Return: the log device, or %NULL if not found
Sean Anderson3102c1d2020-10-27 19:55:24 -0400550 */
551struct log_device *log_device_find_by_name(const char *drv_name);
552
553/**
554 * log_has_cat() - check if a log category exists within a list
555 *
556 * @cat_list: List of categories to check, at most %LOGF_MAX_CATEGORIES entries
557 * long, terminated by %LC_END if fewer
558 * @cat: Category to search for
559 *
560 * Return: ``true`` if @cat is in @cat_list, else ``false``
561 */
562bool log_has_cat(enum log_category_t cat_list[], enum log_category_t cat);
563
564/**
565 * log_has_file() - check if a file is with a list
566 *
567 * @file_list: List of files to check, separated by comma
568 * @file: File to check for. This string is matched against the end of each
569 * file in the list, i.e. ignoring any preceding path. The list is
570 * intended to consist of relative pathnames, e.g. common/main.c,cmd/log.c
571 *
572 * Return: ``true`` if @file is in @file_list, else ``false``
573 */
574bool log_has_file(const char *file_list, const char *file);
575
Simon Glass3b73e8d2017-12-28 13:14:17 -0700576/* Log format flags (bit numbers) for gd->log_fmt. See log_fmt_chars */
577enum log_fmt {
578 LOGF_CAT = 0,
579 LOGF_LEVEL,
580 LOGF_FILE,
581 LOGF_LINE,
582 LOGF_FUNC,
583 LOGF_MSG,
584
585 LOGF_COUNT,
Simon Glass3b73e8d2017-12-28 13:14:17 -0700586 LOGF_ALL = 0x3f,
587};
588
Simon Glassef11ed82017-12-04 13:48:27 -0700589/* Handle the 'log test' command */
Simon Glass09140112020-05-10 11:40:03 -0600590int do_log_test(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
Simon Glassef11ed82017-12-04 13:48:27 -0700591
Simon Glasse9c8d492017-12-04 13:48:24 -0700592/**
Sean Andersona02f84e2020-10-27 19:55:25 -0400593 * log_add_filter_flags() - Add a new filter to a log device, specifying flags
594 *
595 * @drv_name: Driver name to add the filter to (since each driver only has a
596 * single device)
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400597 * @flags: Flags for this filter (``LOGFF_...``)
Sean Andersona02f84e2020-10-27 19:55:25 -0400598 * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400599 * then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
Sean Andersona02f84e2020-10-27 19:55:25 -0400600 * can be provided
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400601 * @level: Maximum (or minimum, if %LOGFF_LEVEL_MIN) log level to allow
Sean Andersona02f84e2020-10-27 19:55:25 -0400602 * @file_list: List of files to allow, separated by comma. If NULL then all
603 * files are permitted
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400604 * Return:
605 * the sequence number of the new filter (>=0) if the filter was added, or a
606 * -ve value on error
Sean Andersona02f84e2020-10-27 19:55:25 -0400607 */
608int log_add_filter_flags(const char *drv_name, enum log_category_t cat_list[],
Sean Anderson40455a62020-10-27 19:55:30 -0400609 enum log_level_t level, const char *file_list,
Sean Andersona02f84e2020-10-27 19:55:25 -0400610 int flags);
611
612/**
Simon Glasse9c8d492017-12-04 13:48:24 -0700613 * log_add_filter() - Add a new filter to a log device
614 *
615 * @drv_name: Driver name to add the filter to (since each driver only has a
616 * single device)
Sean Andersonb66a9242020-10-27 19:55:21 -0400617 * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400618 * then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
Simon Glasse9c8d492017-12-04 13:48:24 -0700619 * can be provided
620 * @max_level: Maximum log level to allow
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400621 * @file_list: List of files to allow, separated by comma. If %NULL then all
Simon Glasse9c8d492017-12-04 13:48:24 -0700622 * files are permitted
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400623 * Return:
624 * the sequence number of the new filter (>=0) if the filter was added, or a
625 * -ve value on error
Simon Glasse9c8d492017-12-04 13:48:24 -0700626 */
Sean Andersona02f84e2020-10-27 19:55:25 -0400627static inline int log_add_filter(const char *drv_name,
628 enum log_category_t cat_list[],
629 enum log_level_t max_level,
630 const char *file_list)
631{
632 return log_add_filter_flags(drv_name, cat_list, max_level, file_list,
633 0);
634}
Simon Glasse9c8d492017-12-04 13:48:24 -0700635
636/**
637 * log_remove_filter() - Remove a filter from a log device
638 *
639 * @drv_name: Driver name to remove the filter from (since each driver only has
640 * a single device)
641 * @filter_num: Filter number to remove (as returned by log_add_filter())
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400642 * Return:
643 * 0 if the filter was removed, -%ENOENT if either the driver or the filter
644 * number was not found
Simon Glasse9c8d492017-12-04 13:48:24 -0700645 */
646int log_remove_filter(const char *drv_name, int filter_num);
647
Simon Glass3d03ab62020-09-12 12:28:49 -0600648/**
649 * log_device_set_enable() - Enable or disable a log device
650 *
651 * Devices are referenced by their driver, so use LOG_GET_DRIVER(name) to pass
652 * the driver to this function. For example if the driver is declared with
653 * LOG_DRIVER(wibble) then pass LOG_GET_DRIVER(wibble) here.
654 *
655 * @drv: Driver of device to enable
656 * @enable: true to enable, false to disable
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100657 * Return: 0 if OK, -ENOENT if the driver was not found
Simon Glass3d03ab62020-09-12 12:28:49 -0600658 */
659int log_device_set_enable(struct log_driver *drv, bool enable);
660
Simon Glasse9c8d492017-12-04 13:48:24 -0700661#if CONFIG_IS_ENABLED(LOG)
662/**
663 * log_init() - Set up the log system ready for use
664 *
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400665 * Return: 0 if OK, -%ENOMEM if out of memory
Simon Glasse9c8d492017-12-04 13:48:24 -0700666 */
667int log_init(void);
668#else
669static inline int log_init(void)
670{
671 return 0;
672}
673#endif
674
Heinrich Schuchardt3c21d772020-06-17 21:52:44 +0200675/**
676 * log_get_default_format() - get default log format
677 *
678 * The default log format is configurable via
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400679 * %CONFIG_LOGF_FILE, %CONFIG_LOGF_LINE, and %CONFIG_LOGF_FUNC.
Heinrich Schuchardt3c21d772020-06-17 21:52:44 +0200680 *
681 * Return: default log format
682 */
683static inline int log_get_default_format(void)
684{
685 return BIT(LOGF_MSG) |
686 (IS_ENABLED(CONFIG_LOGF_FILE) ? BIT(LOGF_FILE) : 0) |
687 (IS_ENABLED(CONFIG_LOGF_LINE) ? BIT(LOGF_LINE) : 0) |
688 (IS_ENABLED(CONFIG_LOGF_FUNC) ? BIT(LOGF_FUNC) : 0);
689}
690
Simon Glass0e98b0a2017-12-04 13:48:20 -0700691#endif