blob: 8a7b961bbfbfb75163f3871dc2f44c26a9b982a7 [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,
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400103 /** @LOGC_COUNT: Number of log categories */
104 LOGC_COUNT,
105 /** @LOGC_END: Sentinel value for lists of log categories */
106 LOGC_END,
107 /** @LOGC_CONT: Use same category as in previous call */
108 LOGC_CONT = -1,
Simon Glasse9c8d492017-12-04 13:48:24 -0700109};
110
111/* Helper to cast a uclass ID to a log category */
112static inline int log_uc_cat(enum uclass_id id)
113{
114 return (enum log_category_t)id;
115}
116
117/**
118 * _log() - Internal function to emit a new log record
119 *
120 * @cat: Category of log record (indicating which subsystem generated it)
121 * @level: Level of log record (indicating its severity)
122 * @file: File name of file where log record was generated
123 * @line: Line number in file where log record was generated
124 * @func: Function where log record was generated
125 * @fmt: printf() format string for log record
126 * @...: Optional parameters, according to the format string @fmt
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400127 * Return: 0 if log record was emitted, -ve on error
Simon Glasse9c8d492017-12-04 13:48:24 -0700128 */
129int _log(enum log_category_t cat, enum log_level_t level, const char *file,
Simon Glassed4e9332019-01-07 16:44:19 -0700130 int line, const char *func, const char *fmt, ...)
131 __attribute__ ((format (__printf__, 6, 7)));
Simon Glasse9c8d492017-12-04 13:48:24 -0700132
Simon Glass58b4b712021-05-08 07:00:06 -0600133/**
134 * _log_buffer - Internal function to print data buffer in hex and ascii form
135 *
136 * @cat: Category of log record (indicating which subsystem generated it)
137 * @level: Level of log record (indicating its severity)
138 * @file: File name of file where log record was generated
139 * @line: Line number in file where log record was generated
140 * @func: Function where log record was generated
141 * @addr: Starting address to display at start of line
142 * @data: pointer to data buffer
143 * @width: data value width. May be 1, 2, or 4.
144 * @count: number of values to display
145 * @linelen: Number of values to print per line; specify 0 for default length
146 */
147int _log_buffer(enum log_category_t cat, enum log_level_t level,
148 const char *file, int line, const char *func, ulong addr,
149 const void *data, uint width, uint count, uint linelen);
150
Simon Glasse9c8d492017-12-04 13:48:24 -0700151/* Define this at the top of a file to add a prefix to debug messages */
152#ifndef pr_fmt
153#define pr_fmt(fmt) fmt
154#endif
155
156/* Use a default category if this file does not supply one */
157#ifndef LOG_CATEGORY
158#define LOG_CATEGORY LOGC_NONE
159#endif
160
161/*
162 * This header may be including when CONFIG_LOG is disabled, in which case
163 * CONFIG_LOG_MAX_LEVEL is not defined. Add a check for this.
164 */
165#if CONFIG_IS_ENABLED(LOG)
166#define _LOG_MAX_LEVEL CONFIG_VAL(LOG_MAX_LEVEL)
Simon Glasse1cbd912021-05-08 13:46:54 -0600167#else
168#define _LOG_MAX_LEVEL LOGL_INFO
169#endif
170
Heinrich Schuchardt24967962021-01-04 08:02:54 +0100171#define log_emer(_fmt...) log(LOG_CATEGORY, LOGL_EMERG, ##_fmt)
172#define log_alert(_fmt...) log(LOG_CATEGORY, LOGL_ALERT, ##_fmt)
173#define log_crit(_fmt...) log(LOG_CATEGORY, LOGL_CRIT, ##_fmt)
Simon Glasscdd140a2018-10-01 11:55:06 -0600174#define log_err(_fmt...) log(LOG_CATEGORY, LOGL_ERR, ##_fmt)
175#define log_warning(_fmt...) log(LOG_CATEGORY, LOGL_WARNING, ##_fmt)
176#define log_notice(_fmt...) log(LOG_CATEGORY, LOGL_NOTICE, ##_fmt)
177#define log_info(_fmt...) log(LOG_CATEGORY, LOGL_INFO, ##_fmt)
178#define log_debug(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG, ##_fmt)
179#define log_content(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG_CONTENT, ##_fmt)
180#define log_io(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG_IO, ##_fmt)
Heinrich Schuchardt24967962021-01-04 08:02:54 +0100181#define log_cont(_fmt...) log(LOGC_CONT, LOGL_CONT, ##_fmt)
Simon Glasse9c8d492017-12-04 13:48:24 -0700182
Simon Glassf9811e82019-02-16 20:24:37 -0700183#ifdef LOG_DEBUG
Simon Glass52d3df72020-09-12 11:13:34 -0600184#define _LOG_DEBUG LOGL_FORCE_DEBUG
Patrick Delaunay54e89a82022-07-12 09:39:49 +0200185#ifndef DEBUG
186#define DEBUG
187#endif
Simon Glassf9811e82019-02-16 20:24:37 -0700188#else
189#define _LOG_DEBUG 0
190#endif
Simon Glass4d8d3052018-11-15 18:43:49 -0700191
Simon Glasse1cbd912021-05-08 13:46:54 -0600192#if CONFIG_IS_ENABLED(LOG)
193
Simon Glasse9c8d492017-12-04 13:48:24 -0700194/* Emit a log record if the level is less that the maximum */
195#define log(_cat, _level, _fmt, _args...) ({ \
196 int _l = _level; \
Simon Glasse1cbd912021-05-08 13:46:54 -0600197 if (_LOG_DEBUG != 0 || _l <= _LOG_MAX_LEVEL) \
Simon Glass52d3df72020-09-12 11:13:34 -0600198 _log((enum log_category_t)(_cat), \
199 (enum log_level_t)(_l | _LOG_DEBUG), __FILE__, \
200 __LINE__, __func__, \
Simon Glasse9c8d492017-12-04 13:48:24 -0700201 pr_fmt(_fmt), ##_args); \
202 })
Simon Glass58b4b712021-05-08 07:00:06 -0600203
204/* Emit a dump if the level is less that the maximum */
205#define log_buffer(_cat, _level, _addr, _data, _width, _count, _linelen) ({ \
206 int _l = _level; \
207 if (_LOG_DEBUG != 0 || _l <= _LOG_MAX_LEVEL) \
208 _log_buffer((enum log_category_t)(_cat), \
209 (enum log_level_t)(_l | _LOG_DEBUG), __FILE__, \
210 __LINE__, __func__, _addr, _data, \
211 _width, _count, _linelen); \
212 })
Simon Glass4d8d3052018-11-15 18:43:49 -0700213#else
Simon Glasse1cbd912021-05-08 13:46:54 -0600214
215/* Note: _LOG_DEBUG != 0 avoids a warning with clang */
216#define log(_cat, _level, _fmt, _args...) ({ \
217 int _l = _level; \
218 if (_LOG_DEBUG != 0 || _l <= LOGL_INFO || \
219 (_DEBUG && _l == LOGL_DEBUG)) \
220 printf(_fmt, ##_args); \
221 })
Simon Glass58b4b712021-05-08 07:00:06 -0600222
223#define log_buffer(_cat, _level, _addr, _data, _width, _count, _linelen) ({ \
224 int _l = _level; \
225 if (_LOG_DEBUG != 0 || _l <= LOGL_INFO || \
226 (_DEBUG && _l == LOGL_DEBUG)) \
227 print_buffer(_addr, _data, _width, _count, _linelen); \
228 })
Simon Glass4d8d3052018-11-15 18:43:49 -0700229#endif
Simon Glasse9c8d492017-12-04 13:48:24 -0700230
Simon Glass0e98b0a2017-12-04 13:48:20 -0700231#ifdef DEBUG
232#define _DEBUG 1
233#else
234#define _DEBUG 0
235#endif
236
237#ifdef CONFIG_SPL_BUILD
238#define _SPL_BUILD 1
239#else
240#define _SPL_BUILD 0
241#endif
242
Simon Glass4ce5b812021-03-26 16:17:28 +1300243#if CONFIG_IS_ENABLED(LOG)
Simon Glasse9c8d492017-12-04 13:48:24 -0700244
Simon Glass4ce5b812021-03-26 16:17:28 +1300245#define debug_cond(cond, fmt, args...) \
246({ \
247 if (cond) \
248 log(LOG_CATEGORY, \
249 (enum log_level_t)(LOGL_FORCE_DEBUG | _LOG_DEBUG), \
250 fmt, ##args); \
Heinrich Schuchardt51763652021-01-04 08:02:53 +0100251})
Simon Glasse9c8d492017-12-04 13:48:24 -0700252
253#else /* _DEBUG */
254
Simon Glass0e98b0a2017-12-04 13:48:20 -0700255/*
256 * Output a debug text when condition "cond" is met. The "cond" should be
257 * computed by a preprocessor in the best case, allowing for the best
258 * optimization.
259 */
Heinrich Schuchardt51763652021-01-04 08:02:53 +0100260#define debug_cond(cond, fmt, args...) \
261({ \
262 if (cond) \
263 printf(pr_fmt(fmt), ##args); \
264})
Simon Glass0e98b0a2017-12-04 13:48:20 -0700265
Simon Glasse9c8d492017-12-04 13:48:24 -0700266#endif /* _DEBUG */
267
Simon Glass0e98b0a2017-12-04 13:48:20 -0700268/* Show a message if DEBUG is defined in a file */
269#define debug(fmt, args...) \
270 debug_cond(_DEBUG, fmt, ##args)
271
272/* Show a message if not in SPL */
273#define warn_non_spl(fmt, args...) \
274 debug_cond(!_SPL_BUILD, fmt, ##args)
275
276/*
277 * An assertion is run-time check done in debug mode only. If DEBUG is not
278 * defined then it is skipped. If DEBUG is defined and the assertion fails,
279 * then it calls panic*( which may or may not reset/halt U-Boot (see
280 * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
281 * before release, and after release it is hoped that they don't matter. But
282 * in any case these failing assertions cannot be fixed with a reset (which
283 * may just do the same assertion again).
284 */
285void __assert_fail(const char *assertion, const char *file, unsigned int line,
286 const char *function);
Heinrich Schuchardtb236f8c2019-07-27 20:21:06 +0200287
288/**
289 * assert() - assert expression is true
290 *
291 * If the expression x evaluates to false and _DEBUG evaluates to true, a panic
292 * message is written and the system stalls. The value of _DEBUG is set to true
293 * if DEBUG is defined before including common.h.
294 *
295 * The expression x is always executed irrespective of the value of _DEBUG.
296 *
297 * @x: expression to test
298 */
Simon Glass0e98b0a2017-12-04 13:48:20 -0700299#define assert(x) \
300 ({ if (!(x) && _DEBUG) \
301 __assert_fail(#x, __FILE__, __LINE__, __func__); })
302
Simon Glasscd01d2d2019-12-29 21:19:10 -0700303/*
304 * This one actually gets compiled in even without DEBUG. It doesn't include the
305 * full pathname as it may be huge. Only use this when the user should be
306 * warning, similar to BUG_ON() in linux.
307 *
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400308 * Return: true if assertion succeeded (condition is true), else false
Simon Glasscd01d2d2019-12-29 21:19:10 -0700309 */
310#define assert_noisy(x) \
311 ({ bool _val = (x); \
312 if (!_val) \
313 __assert_fail(#x, "?", __LINE__, __func__); \
314 _val; \
315 })
316
Simon Glass4d8d3052018-11-15 18:43:49 -0700317#if CONFIG_IS_ENABLED(LOG) && defined(CONFIG_LOG_ERROR_RETURN)
318/*
319 * Log an error return value, possibly with a message. Usage:
320 *
321 * return log_ret(fred_call());
322 *
323 * or:
324 *
Simon Glassb7f134e2022-09-06 20:26:53 -0600325 * return log_msg_ret("get", fred_call());
326 *
327 * It is recommended to use <= 3 characters for the name since this will only
328 * use 4 bytes in rodata
Simon Glass4d8d3052018-11-15 18:43:49 -0700329 */
Simon Glass3707c6e2017-12-28 13:14:23 -0700330#define log_ret(_ret) ({ \
331 int __ret = (_ret); \
332 if (__ret < 0) \
333 log(LOG_CATEGORY, LOGL_ERR, "returning err=%d\n", __ret); \
334 __ret; \
335 })
Simon Glassb616cef2018-06-11 13:07:14 -0600336#define log_msg_ret(_msg, _ret) ({ \
337 int __ret = (_ret); \
338 if (__ret < 0) \
339 log(LOG_CATEGORY, LOGL_ERR, "%s: returning err=%d\n", _msg, \
340 __ret); \
341 __ret; \
342 })
Simon Glass7bd06582021-01-20 20:10:54 -0700343
344/*
345 * Similar to the above, but any non-zero value is consider an error, not just
346 * values less than 0.
347 */
348#define log_retz(_ret) ({ \
349 int __ret = (_ret); \
350 if (__ret) \
351 log(LOG_CATEGORY, LOGL_ERR, "returning err=%d\n", __ret); \
352 __ret; \
353 })
354#define log_msg_retz(_msg, _ret) ({ \
355 int __ret = (_ret); \
356 if (__ret) \
357 log(LOG_CATEGORY, LOGL_ERR, "%s: returning err=%d\n", _msg, \
358 __ret); \
359 __ret; \
360 })
Simon Glass3707c6e2017-12-28 13:14:23 -0700361#else
Simon Glass4d8d3052018-11-15 18:43:49 -0700362/* Non-logging versions of the above which just return the error code */
Simon Glass3707c6e2017-12-28 13:14:23 -0700363#define log_ret(_ret) (_ret)
Simon Glass4d8d3052018-11-15 18:43:49 -0700364#define log_msg_ret(_msg, _ret) ((void)(_msg), _ret)
Simon Glass7bd06582021-01-20 20:10:54 -0700365#define log_retz(_ret) (_ret)
366#define log_msg_retz(_msg, _ret) ((void)(_msg), _ret)
Simon Glass3707c6e2017-12-28 13:14:23 -0700367#endif
368
Simon Glass79d59832021-01-20 20:10:52 -0700369/** * enum log_rec_flags - Flags for a log record */
370enum log_rec_flags {
371 /** @LOGRECF_FORCE_DEBUG: Force output of debug record */
372 LOGRECF_FORCE_DEBUG = BIT(0),
Simon Glass9ad7a6c2021-01-20 20:10:53 -0700373 /** @LOGRECF_CONT: Continuation of previous log record */
374 LOGRECF_CONT = BIT(1),
Simon Glass79d59832021-01-20 20:10:52 -0700375};
376
Simon Glasse9c8d492017-12-04 13:48:24 -0700377/**
378 * struct log_rec - a single log record
379 *
380 * Holds information about a single record in the log
381 *
382 * Members marked as 'not allocated' are stored as pointers and the caller is
383 * responsible for making sure that the data pointed to is not overwritten.
Heinrich Schuchardt9e925d02020-11-30 09:04:48 +0100384 * Members marked as 'allocated' are allocated (e.g. via strdup()) by the log
Simon Glasse9c8d492017-12-04 13:48:24 -0700385 * system.
386 *
Simon Glass52d3df72020-09-12 11:13:34 -0600387 * TODO(sjg@chromium.org): Compress this struct down a bit to reduce space, e.g.
388 * a single u32 for cat, level, line and force_debug
389 *
Simon Glasse9c8d492017-12-04 13:48:24 -0700390 * @cat: Category, representing a uclass or part of U-Boot
391 * @level: Severity level, less severe is higher
Simon Glasse9c8d492017-12-04 13:48:24 -0700392 * @line: Line number where the log record was generated
Simon Glass79d59832021-01-20 20:10:52 -0700393 * @flags: Flags for log record (enum log_rec_flags)
394 * @file: Name of file where the log record was generated (not allocated)
Simon Glasse9c8d492017-12-04 13:48:24 -0700395 * @func: Function where the log record was generated (not allocated)
396 * @msg: Log message (allocated)
397 */
398struct log_rec {
399 enum log_category_t cat;
400 enum log_level_t level;
Simon Glass79d59832021-01-20 20:10:52 -0700401 u16 line;
402 u8 flags;
Simon Glasse9c8d492017-12-04 13:48:24 -0700403 const char *file;
Simon Glasse9c8d492017-12-04 13:48:24 -0700404 const char *func;
405 const char *msg;
406};
407
408struct log_device;
409
Simon Glassb4520302020-09-12 12:28:47 -0600410enum log_device_flags {
411 LOGDF_ENABLE = BIT(0), /* Device is enabled */
412};
413
Simon Glasse9c8d492017-12-04 13:48:24 -0700414/**
415 * struct log_driver - a driver which accepts and processes log records
416 *
417 * @name: Name of driver
Simon Glassb4520302020-09-12 12:28:47 -0600418 * @emit: Method to call to emit a log record via this device
419 * @flags: Initial value for flags (use LOGDF_ENABLE to enable on start-up)
Simon Glasse9c8d492017-12-04 13:48:24 -0700420 */
421struct log_driver {
422 const char *name;
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400423
Simon Glasse9c8d492017-12-04 13:48:24 -0700424 /**
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400425 * @emit: emit a log record
Simon Glasse9c8d492017-12-04 13:48:24 -0700426 *
427 * Called by the log system to pass a log record to a particular driver
428 * for processing. The filter is checked before calling this function.
429 */
430 int (*emit)(struct log_device *ldev, struct log_rec *rec);
Simon Glassb4520302020-09-12 12:28:47 -0600431 unsigned short flags;
Simon Glasse9c8d492017-12-04 13:48:24 -0700432};
433
434/**
435 * struct log_device - an instance of a log driver
436 *
437 * Since drivers are set up at build-time we need to have a separate device for
438 * the run-time aspects of drivers (currently just a list of filters to apply
439 * to records send to this device).
440 *
Heinrich Schuchardt9e925d02020-11-30 09:04:48 +0100441 * @next_filter_num: Sequence number of next filter filter added (0=no filters
Simon Glasse9c8d492017-12-04 13:48:24 -0700442 * yet). This increments with each new filter on the device, but never
443 * decrements
Simon Glassb4520302020-09-12 12:28:47 -0600444 * @flags: Flags for this filter (enum log_device_flags)
Simon Glasse9c8d492017-12-04 13:48:24 -0700445 * @drv: Pointer to driver for this device
446 * @filter_head: List of filters for this device
447 * @sibling_node: Next device in the list of all devices
448 */
449struct log_device {
Simon Glassb4520302020-09-12 12:28:47 -0600450 unsigned short next_filter_num;
451 unsigned short flags;
Simon Glasse9c8d492017-12-04 13:48:24 -0700452 struct log_driver *drv;
453 struct list_head filter_head;
454 struct list_head sibling_node;
455};
456
457enum {
458 LOGF_MAX_CATEGORIES = 5, /* maximum categories per filter */
459};
460
Sean Andersonfe3b1a22020-10-27 19:55:26 -0400461/**
462 * enum log_filter_flags - Flags which modify a filter
463 */
Simon Glasse9c8d492017-12-04 13:48:24 -0700464enum log_filter_flags {
Sean Andersonfe3b1a22020-10-27 19:55:26 -0400465 /** @LOGFF_HAS_CAT: Filter has a category list */
466 LOGFF_HAS_CAT = 1 << 0,
467 /** @LOGFF_DENY: Filter denies matching messages */
468 LOGFF_DENY = 1 << 1,
Sean Anderson40455a62020-10-27 19:55:30 -0400469 /** @LOGFF_LEVEL_MIN: Filter's level is a minimum, not a maximum */
470 LOGFF_LEVEL_MIN = 1 << 2,
Simon Glasse9c8d492017-12-04 13:48:24 -0700471};
472
473/**
Heinrich Schuchardt9e925d02020-11-30 09:04:48 +0100474 * struct log_filter - criteria to filter out log messages
Simon Glasse9c8d492017-12-04 13:48:24 -0700475 *
Sean Andersonfe3b1a22020-10-27 19:55:26 -0400476 * If a message matches all criteria, then it is allowed. If LOGFF_DENY is set,
477 * then it is denied instead.
478 *
Simon Glasse9c8d492017-12-04 13:48:24 -0700479 * @filter_num: Sequence number of this filter. This is returned when adding a
480 * new filter, and must be provided when removing a previously added
481 * filter.
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400482 * @flags: Flags for this filter (``LOGFF_...``)
Sean Andersonb66a9242020-10-27 19:55:21 -0400483 * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400484 * then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
Simon Glasse9c8d492017-12-04 13:48:24 -0700485 * can be provided
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400486 * @level: Maximum (or minimum, if %LOGFF_MIN_LEVEL) log level to allow
Simon Glasse9c8d492017-12-04 13:48:24 -0700487 * @file_list: List of files to allow, separated by comma. If NULL then all
488 * files are permitted
489 * @sibling_node: Next filter in the list of filters for this log device
490 */
491struct log_filter {
492 int filter_num;
493 int flags;
494 enum log_category_t cat_list[LOGF_MAX_CATEGORIES];
Sean Anderson40455a62020-10-27 19:55:30 -0400495 enum log_level_t level;
Simon Glasse9c8d492017-12-04 13:48:24 -0700496 const char *file_list;
497 struct list_head sibling_node;
498};
499
500#define LOG_DRIVER(_name) \
501 ll_entry_declare(struct log_driver, _name, log_driver)
502
Simon Glass3d03ab62020-09-12 12:28:49 -0600503/* Get a pointer to a given driver */
504#define LOG_GET_DRIVER(__name) \
505 ll_entry_get(struct log_driver, __name, log_driver)
506
Simon Glassf941c8d2017-12-28 13:14:16 -0700507/**
508 * log_get_cat_name() - Get the name of a category
509 *
510 * @cat: Category to look up
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400511 * Return: category name (which may be a uclass driver name) if found, or
Sean Anderson1c593a12020-10-27 19:55:34 -0400512 * "<invalid>" if invalid, or "<missing>" if not found. All error
513 * responses begin with '<'.
Simon Glassf941c8d2017-12-28 13:14:16 -0700514 */
515const char *log_get_cat_name(enum log_category_t cat);
516
517/**
518 * log_get_cat_by_name() - Look up a category by name
519 *
520 * @name: Name to look up
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400521 * Return: Category, or %LOGC_NONE if not found
Simon Glassf941c8d2017-12-28 13:14:16 -0700522 */
523enum log_category_t log_get_cat_by_name(const char *name);
524
525/**
526 * log_get_level_name() - Get the name of a log level
527 *
528 * @level: Log level to look up
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400529 * Return: Log level name (in ALL CAPS)
Simon Glassf941c8d2017-12-28 13:14:16 -0700530 */
531const char *log_get_level_name(enum log_level_t level);
532
533/**
534 * log_get_level_by_name() - Look up a log level by name
535 *
536 * @name: Name to look up
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400537 * Return: Log level, or %LOGL_NONE if not found
Simon Glassf941c8d2017-12-28 13:14:16 -0700538 */
539enum log_level_t log_get_level_by_name(const char *name);
540
Sean Anderson3102c1d2020-10-27 19:55:24 -0400541/**
542 * log_device_find_by_name() - Look up a log device by its driver's name
543 *
544 * @drv_name: Name of the driver
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400545 * Return: the log device, or %NULL if not found
Sean Anderson3102c1d2020-10-27 19:55:24 -0400546 */
547struct log_device *log_device_find_by_name(const char *drv_name);
548
549/**
550 * log_has_cat() - check if a log category exists within a list
551 *
552 * @cat_list: List of categories to check, at most %LOGF_MAX_CATEGORIES entries
553 * long, terminated by %LC_END if fewer
554 * @cat: Category to search for
555 *
556 * Return: ``true`` if @cat is in @cat_list, else ``false``
557 */
558bool log_has_cat(enum log_category_t cat_list[], enum log_category_t cat);
559
560/**
561 * log_has_file() - check if a file is with a list
562 *
563 * @file_list: List of files to check, separated by comma
564 * @file: File to check for. This string is matched against the end of each
565 * file in the list, i.e. ignoring any preceding path. The list is
566 * intended to consist of relative pathnames, e.g. common/main.c,cmd/log.c
567 *
568 * Return: ``true`` if @file is in @file_list, else ``false``
569 */
570bool log_has_file(const char *file_list, const char *file);
571
Simon Glass3b73e8d2017-12-28 13:14:17 -0700572/* Log format flags (bit numbers) for gd->log_fmt. See log_fmt_chars */
573enum log_fmt {
574 LOGF_CAT = 0,
575 LOGF_LEVEL,
576 LOGF_FILE,
577 LOGF_LINE,
578 LOGF_FUNC,
579 LOGF_MSG,
580
581 LOGF_COUNT,
Simon Glass3b73e8d2017-12-28 13:14:17 -0700582 LOGF_ALL = 0x3f,
583};
584
Simon Glassef11ed82017-12-04 13:48:27 -0700585/* Handle the 'log test' command */
Simon Glass09140112020-05-10 11:40:03 -0600586int do_log_test(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
Simon Glassef11ed82017-12-04 13:48:27 -0700587
Simon Glasse9c8d492017-12-04 13:48:24 -0700588/**
Sean Andersona02f84e2020-10-27 19:55:25 -0400589 * log_add_filter_flags() - Add a new filter to a log device, specifying flags
590 *
591 * @drv_name: Driver name to add the filter to (since each driver only has a
592 * single device)
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400593 * @flags: Flags for this filter (``LOGFF_...``)
Sean Andersona02f84e2020-10-27 19:55:25 -0400594 * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400595 * then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
Sean Andersona02f84e2020-10-27 19:55:25 -0400596 * can be provided
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400597 * @level: Maximum (or minimum, if %LOGFF_LEVEL_MIN) log level to allow
Sean Andersona02f84e2020-10-27 19:55:25 -0400598 * @file_list: List of files to allow, separated by comma. If NULL then all
599 * files are permitted
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400600 * Return:
601 * the sequence number of the new filter (>=0) if the filter was added, or a
602 * -ve value on error
Sean Andersona02f84e2020-10-27 19:55:25 -0400603 */
604int log_add_filter_flags(const char *drv_name, enum log_category_t cat_list[],
Sean Anderson40455a62020-10-27 19:55:30 -0400605 enum log_level_t level, const char *file_list,
Sean Andersona02f84e2020-10-27 19:55:25 -0400606 int flags);
607
608/**
Simon Glasse9c8d492017-12-04 13:48:24 -0700609 * log_add_filter() - Add a new filter to a log device
610 *
611 * @drv_name: Driver name to add the filter to (since each driver only has a
612 * single device)
Sean Andersonb66a9242020-10-27 19:55:21 -0400613 * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400614 * then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
Simon Glasse9c8d492017-12-04 13:48:24 -0700615 * can be provided
616 * @max_level: Maximum log level to allow
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400617 * @file_list: List of files to allow, separated by comma. If %NULL then all
Simon Glasse9c8d492017-12-04 13:48:24 -0700618 * files are permitted
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400619 * Return:
620 * the sequence number of the new filter (>=0) if the filter was added, or a
621 * -ve value on error
Simon Glasse9c8d492017-12-04 13:48:24 -0700622 */
Sean Andersona02f84e2020-10-27 19:55:25 -0400623static inline int log_add_filter(const char *drv_name,
624 enum log_category_t cat_list[],
625 enum log_level_t max_level,
626 const char *file_list)
627{
628 return log_add_filter_flags(drv_name, cat_list, max_level, file_list,
629 0);
630}
Simon Glasse9c8d492017-12-04 13:48:24 -0700631
632/**
633 * log_remove_filter() - Remove a filter from a log device
634 *
635 * @drv_name: Driver name to remove the filter from (since each driver only has
636 * a single device)
637 * @filter_num: Filter number to remove (as returned by log_add_filter())
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400638 * Return:
639 * 0 if the filter was removed, -%ENOENT if either the driver or the filter
640 * number was not found
Simon Glasse9c8d492017-12-04 13:48:24 -0700641 */
642int log_remove_filter(const char *drv_name, int filter_num);
643
Simon Glass3d03ab62020-09-12 12:28:49 -0600644/**
645 * log_device_set_enable() - Enable or disable a log device
646 *
647 * Devices are referenced by their driver, so use LOG_GET_DRIVER(name) to pass
648 * the driver to this function. For example if the driver is declared with
649 * LOG_DRIVER(wibble) then pass LOG_GET_DRIVER(wibble) here.
650 *
651 * @drv: Driver of device to enable
652 * @enable: true to enable, false to disable
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100653 * Return: 0 if OK, -ENOENT if the driver was not found
Simon Glass3d03ab62020-09-12 12:28:49 -0600654 */
655int log_device_set_enable(struct log_driver *drv, bool enable);
656
Simon Glasse9c8d492017-12-04 13:48:24 -0700657#if CONFIG_IS_ENABLED(LOG)
658/**
659 * log_init() - Set up the log system ready for use
660 *
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400661 * Return: 0 if OK, -%ENOMEM if out of memory
Simon Glasse9c8d492017-12-04 13:48:24 -0700662 */
663int log_init(void);
664#else
665static inline int log_init(void)
666{
667 return 0;
668}
669#endif
670
Heinrich Schuchardt3c21d772020-06-17 21:52:44 +0200671/**
672 * log_get_default_format() - get default log format
673 *
674 * The default log format is configurable via
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400675 * %CONFIG_LOGF_FILE, %CONFIG_LOGF_LINE, and %CONFIG_LOGF_FUNC.
Heinrich Schuchardt3c21d772020-06-17 21:52:44 +0200676 *
677 * Return: default log format
678 */
679static inline int log_get_default_format(void)
680{
681 return BIT(LOGF_MSG) |
682 (IS_ENABLED(CONFIG_LOGF_FILE) ? BIT(LOGF_FILE) : 0) |
683 (IS_ENABLED(CONFIG_LOGF_LINE) ? BIT(LOGF_LINE) : 0) |
684 (IS_ENABLED(CONFIG_LOGF_FUNC) ? BIT(LOGF_FUNC) : 0);
685}
686
Simon Glass0e98b0a2017-12-04 13:48:20 -0700687#endif