blob: 7abc70e439830e36a886428cb312f0d1d6083ed0 [file] [log] [blame]
Tom Rini10e47792018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Simon Glass9054a022017-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 Glass9054a022017-12-04 13:48:20 -07007 */
8
9#ifndef __LOG_H
10#define __LOG_H
11
Simon Glass274e0b02020-05-10 11:39:56 -060012#include <stdio.h>
Simon Glassed38aef2020-05-10 11:40:03 -060013#include <linker_lists.h>
Simon Glassd95645d2017-12-04 13:48:24 -070014#include <dm/uclass-id.h>
Heinrich Schuchardt2d349c72020-06-17 21:52:44 +020015#include <linux/bitops.h>
Simon Glassd95645d2017-12-04 13:48:24 -070016#include <linux/list.h>
17
Simon Glassed38aef2020-05-10 11:40:03 -060018struct cmd_tbl;
19
Sean Andersonce02d8f2020-10-27 19:55:40 -040020/**
21 * enum log_level_t - Log levels supported, ranging from most to least important
22 */
Simon Glassd95645d2017-12-04 13:48:24 -070023enum log_level_t {
Sean Andersonce02d8f2020-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 Schuchardtec506d92020-11-30 09:04:48 +010032 /** @LOGL_WARNING: Warning may prevent optimal operation */
Sean Andersonce02d8f2020-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 Glassd95645d2017-12-04 13:48:24 -070044
Sean Andersonce02d8f2020-10-27 19:55:40 -040045 /** @LOGL_COUNT: Total number of valid log levels */
Simon Glassd95645d2017-12-04 13:48:24 -070046 LOGL_COUNT,
Sean Andersonce02d8f2020-10-27 19:55:40 -040047 /** @LOGL_NONE: Used to indicate that there is no valid log level */
Simon Glass4f0fdb72017-12-28 13:14:16 -070048 LOGL_NONE,
49
Sean Andersonce02d8f2020-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 Glass9c83cac2020-09-12 11:13:34 -060054
Sean Andersonce02d8f2020-10-27 19:55:40 -040055 /** @LOGL_FIRST: The first, most-important log level */
Simon Glassd95645d2017-12-04 13:48:24 -070056 LOGL_FIRST = LOGL_EMERG,
Sean Andersonce02d8f2020-10-27 19:55:40 -040057 /** @LOGL_MAX: The last, least-important log level */
Simon Glass4f0fdb72017-12-28 13:14:16 -070058 LOGL_MAX = LOGL_DEBUG_IO,
Sean Andersonce02d8f2020-10-27 19:55:40 -040059 /** @LOGL_CONT: Use same log level as in previous call */
60 LOGL_CONT = -1,
Simon Glassd95645d2017-12-04 13:48:24 -070061};
62
63/**
Sean Andersonce02d8f2020-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 Glass31120e12020-09-27 18:46:13 -060068 *
69 * Remember to update log_cat_name[] after adding a new category.
Simon Glassd95645d2017-12-04 13:48:24 -070070 */
71enum log_category_t {
Sean Andersonce02d8f2020-10-27 19:55:40 -040072 /** @LOGC_FIRST: First log category */
Simon Glassd95645d2017-12-04 13:48:24 -070073 LOGC_FIRST = 0, /* First part mirrors UCLASS_... */
74
Sean Andersonce02d8f2020-10-27 19:55:40 -040075 /** @LOGC_NONE: Default log category */
Simon Glassd5063fd2018-10-01 12:22:32 -060076 LOGC_NONE = UCLASS_COUNT, /* First number is after all uclasses */
Sean Andersonce02d8f2020-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 Glass9fb9e9b2020-04-09 10:27:38 -060098 LOGC_ACPI,
Simon Glass372e2272020-11-29 17:07:04 -070099 /** @LOGC_BOOT: Related to boot process / boot image processing */
100 LOGC_BOOT,
Simon Glassaa4bce92022-03-04 08:43:00 -0700101 /** @LOGC_EVENT: Related to event and event handling */
102 LOGC_EVENT,
Sean Andersonce02d8f2020-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 Glassd95645d2017-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 Andersonce02d8f2020-10-27 19:55:40 -0400127 * Return: 0 if log record was emitted, -ve on error
Simon Glassd95645d2017-12-04 13:48:24 -0700128 */
129int _log(enum log_category_t cat, enum log_level_t level, const char *file,
Simon Glassbd923322019-01-07 16:44:19 -0700130 int line, const char *func, const char *fmt, ...)
131 __attribute__ ((format (__printf__, 6, 7)));
Simon Glassd95645d2017-12-04 13:48:24 -0700132
Simon Glass9ba72ef2019-09-25 08:56:23 -0600133static inline int _log_nop(enum log_category_t cat, enum log_level_t level,
134 const char *file, int line, const char *func,
135 const char *fmt, ...)
136 __attribute__ ((format (__printf__, 6, 7)));
137
138static inline int _log_nop(enum log_category_t cat, enum log_level_t level,
139 const char *file, int line, const char *func,
140 const char *fmt, ...)
141{
142 return 0;
143}
144
Simon Glass7fb97592021-05-08 07:00:06 -0600145/**
146 * _log_buffer - Internal function to print data buffer in hex and ascii form
147 *
148 * @cat: Category of log record (indicating which subsystem generated it)
149 * @level: Level of log record (indicating its severity)
150 * @file: File name of file where log record was generated
151 * @line: Line number in file where log record was generated
152 * @func: Function where log record was generated
153 * @addr: Starting address to display at start of line
154 * @data: pointer to data buffer
155 * @width: data value width. May be 1, 2, or 4.
156 * @count: number of values to display
157 * @linelen: Number of values to print per line; specify 0 for default length
158 */
159int _log_buffer(enum log_category_t cat, enum log_level_t level,
160 const char *file, int line, const char *func, ulong addr,
161 const void *data, uint width, uint count, uint linelen);
162
Simon Glassd95645d2017-12-04 13:48:24 -0700163/* Define this at the top of a file to add a prefix to debug messages */
164#ifndef pr_fmt
165#define pr_fmt(fmt) fmt
166#endif
167
168/* Use a default category if this file does not supply one */
169#ifndef LOG_CATEGORY
170#define LOG_CATEGORY LOGC_NONE
171#endif
172
173/*
174 * This header may be including when CONFIG_LOG is disabled, in which case
175 * CONFIG_LOG_MAX_LEVEL is not defined. Add a check for this.
176 */
177#if CONFIG_IS_ENABLED(LOG)
178#define _LOG_MAX_LEVEL CONFIG_VAL(LOG_MAX_LEVEL)
Simon Glass8eaaedb2021-05-08 13:46:54 -0600179#else
180#define _LOG_MAX_LEVEL LOGL_INFO
181#endif
182
Heinrich Schuchardt2e396a12021-01-04 08:02:54 +0100183#define log_emer(_fmt...) log(LOG_CATEGORY, LOGL_EMERG, ##_fmt)
184#define log_alert(_fmt...) log(LOG_CATEGORY, LOGL_ALERT, ##_fmt)
185#define log_crit(_fmt...) log(LOG_CATEGORY, LOGL_CRIT, ##_fmt)
Simon Glass1b69a992018-10-01 11:55:06 -0600186#define log_err(_fmt...) log(LOG_CATEGORY, LOGL_ERR, ##_fmt)
187#define log_warning(_fmt...) log(LOG_CATEGORY, LOGL_WARNING, ##_fmt)
188#define log_notice(_fmt...) log(LOG_CATEGORY, LOGL_NOTICE, ##_fmt)
189#define log_info(_fmt...) log(LOG_CATEGORY, LOGL_INFO, ##_fmt)
190#define log_debug(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG, ##_fmt)
191#define log_content(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG_CONTENT, ##_fmt)
192#define log_io(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG_IO, ##_fmt)
Heinrich Schuchardt2e396a12021-01-04 08:02:54 +0100193#define log_cont(_fmt...) log(LOGC_CONT, LOGL_CONT, ##_fmt)
Simon Glassd95645d2017-12-04 13:48:24 -0700194
Simon Glasse0144f22019-02-16 20:24:37 -0700195#ifdef LOG_DEBUG
Simon Glass9c83cac2020-09-12 11:13:34 -0600196#define _LOG_DEBUG LOGL_FORCE_DEBUG
Patrick Delaunay816585d2022-07-12 09:39:49 +0200197#ifndef DEBUG
198#define DEBUG
199#endif
Simon Glasse0144f22019-02-16 20:24:37 -0700200#else
201#define _LOG_DEBUG 0
202#endif
Simon Glassb56cdc02018-11-15 18:43:49 -0700203
Simon Glass8eaaedb2021-05-08 13:46:54 -0600204#if CONFIG_IS_ENABLED(LOG)
205
Simon Glassd95645d2017-12-04 13:48:24 -0700206/* Emit a log record if the level is less that the maximum */
207#define log(_cat, _level, _fmt, _args...) ({ \
208 int _l = _level; \
Simon Glass8eaaedb2021-05-08 13:46:54 -0600209 if (_LOG_DEBUG != 0 || _l <= _LOG_MAX_LEVEL) \
Simon Glass9c83cac2020-09-12 11:13:34 -0600210 _log((enum log_category_t)(_cat), \
211 (enum log_level_t)(_l | _LOG_DEBUG), __FILE__, \
212 __LINE__, __func__, \
Simon Glassd95645d2017-12-04 13:48:24 -0700213 pr_fmt(_fmt), ##_args); \
214 })
Simon Glass7fb97592021-05-08 07:00:06 -0600215
216/* Emit a dump if the level is less that the maximum */
217#define log_buffer(_cat, _level, _addr, _data, _width, _count, _linelen) ({ \
218 int _l = _level; \
219 if (_LOG_DEBUG != 0 || _l <= _LOG_MAX_LEVEL) \
220 _log_buffer((enum log_category_t)(_cat), \
221 (enum log_level_t)(_l | _LOG_DEBUG), __FILE__, \
222 __LINE__, __func__, _addr, _data, \
223 _width, _count, _linelen); \
224 })
Simon Glassb56cdc02018-11-15 18:43:49 -0700225#else
Simon Glass8eaaedb2021-05-08 13:46:54 -0600226
227/* Note: _LOG_DEBUG != 0 avoids a warning with clang */
228#define log(_cat, _level, _fmt, _args...) ({ \
229 int _l = _level; \
230 if (_LOG_DEBUG != 0 || _l <= LOGL_INFO || \
231 (_DEBUG && _l == LOGL_DEBUG)) \
232 printf(_fmt, ##_args); \
233 })
Simon Glass7fb97592021-05-08 07:00:06 -0600234
235#define log_buffer(_cat, _level, _addr, _data, _width, _count, _linelen) ({ \
236 int _l = _level; \
237 if (_LOG_DEBUG != 0 || _l <= LOGL_INFO || \
238 (_DEBUG && _l == LOGL_DEBUG)) \
239 print_buffer(_addr, _data, _width, _count, _linelen); \
240 })
Simon Glassb56cdc02018-11-15 18:43:49 -0700241#endif
Simon Glassd95645d2017-12-04 13:48:24 -0700242
Simon Glass9ba72ef2019-09-25 08:56:23 -0600243#define log_nop(_cat, _level, _fmt, _args...) ({ \
244 int _l = _level; \
245 _log_nop((enum log_category_t)(_cat), _l, __FILE__, __LINE__, \
246 __func__, pr_fmt(_fmt), ##_args); \
247})
248
Simon Glass9054a022017-12-04 13:48:20 -0700249#ifdef DEBUG
250#define _DEBUG 1
251#else
252#define _DEBUG 0
253#endif
254
255#ifdef CONFIG_SPL_BUILD
256#define _SPL_BUILD 1
257#else
258#define _SPL_BUILD 0
259#endif
260
Simon Glass63580312021-03-26 16:17:28 +1300261#if CONFIG_IS_ENABLED(LOG)
Simon Glassd95645d2017-12-04 13:48:24 -0700262
Simon Glass63580312021-03-26 16:17:28 +1300263#define debug_cond(cond, fmt, args...) \
264({ \
265 if (cond) \
266 log(LOG_CATEGORY, \
267 (enum log_level_t)(LOGL_FORCE_DEBUG | _LOG_DEBUG), \
268 fmt, ##args); \
Heinrich Schuchardt42b74812021-01-04 08:02:53 +0100269})
Simon Glassd95645d2017-12-04 13:48:24 -0700270
271#else /* _DEBUG */
272
Simon Glass9054a022017-12-04 13:48:20 -0700273/*
274 * Output a debug text when condition "cond" is met. The "cond" should be
275 * computed by a preprocessor in the best case, allowing for the best
276 * optimization.
277 */
Heinrich Schuchardt42b74812021-01-04 08:02:53 +0100278#define debug_cond(cond, fmt, args...) \
279({ \
280 if (cond) \
281 printf(pr_fmt(fmt), ##args); \
282})
Simon Glass9054a022017-12-04 13:48:20 -0700283
Simon Glassd95645d2017-12-04 13:48:24 -0700284#endif /* _DEBUG */
285
Simon Glass9054a022017-12-04 13:48:20 -0700286/* Show a message if DEBUG is defined in a file */
287#define debug(fmt, args...) \
288 debug_cond(_DEBUG, fmt, ##args)
289
290/* Show a message if not in SPL */
291#define warn_non_spl(fmt, args...) \
292 debug_cond(!_SPL_BUILD, fmt, ##args)
293
294/*
295 * An assertion is run-time check done in debug mode only. If DEBUG is not
296 * defined then it is skipped. If DEBUG is defined and the assertion fails,
297 * then it calls panic*( which may or may not reset/halt U-Boot (see
298 * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
299 * before release, and after release it is hoped that they don't matter. But
300 * in any case these failing assertions cannot be fixed with a reset (which
301 * may just do the same assertion again).
302 */
303void __assert_fail(const char *assertion, const char *file, unsigned int line,
304 const char *function);
Heinrich Schuchardt7c395c92019-07-27 20:21:06 +0200305
306/**
307 * assert() - assert expression is true
308 *
309 * If the expression x evaluates to false and _DEBUG evaluates to true, a panic
310 * message is written and the system stalls. The value of _DEBUG is set to true
311 * if DEBUG is defined before including common.h.
312 *
313 * The expression x is always executed irrespective of the value of _DEBUG.
314 *
315 * @x: expression to test
316 */
Simon Glass9054a022017-12-04 13:48:20 -0700317#define assert(x) \
318 ({ if (!(x) && _DEBUG) \
319 __assert_fail(#x, __FILE__, __LINE__, __func__); })
320
Simon Glasse1277ff2019-12-29 21:19:10 -0700321/*
322 * This one actually gets compiled in even without DEBUG. It doesn't include the
323 * full pathname as it may be huge. Only use this when the user should be
324 * warning, similar to BUG_ON() in linux.
325 *
Sean Andersonce02d8f2020-10-27 19:55:40 -0400326 * Return: true if assertion succeeded (condition is true), else false
Simon Glasse1277ff2019-12-29 21:19:10 -0700327 */
328#define assert_noisy(x) \
329 ({ bool _val = (x); \
330 if (!_val) \
331 __assert_fail(#x, "?", __LINE__, __func__); \
332 _val; \
333 })
334
Simon Glassb56cdc02018-11-15 18:43:49 -0700335#if CONFIG_IS_ENABLED(LOG) && defined(CONFIG_LOG_ERROR_RETURN)
336/*
337 * Log an error return value, possibly with a message. Usage:
338 *
339 * return log_ret(fred_call());
340 *
341 * or:
342 *
343 * return log_msg_ret("fred failed", fred_call());
344 */
Simon Glassaa1d73b2017-12-28 13:14:23 -0700345#define log_ret(_ret) ({ \
346 int __ret = (_ret); \
347 if (__ret < 0) \
348 log(LOG_CATEGORY, LOGL_ERR, "returning err=%d\n", __ret); \
349 __ret; \
350 })
Simon Glassbfad6ed2018-06-11 13:07:14 -0600351#define log_msg_ret(_msg, _ret) ({ \
352 int __ret = (_ret); \
353 if (__ret < 0) \
354 log(LOG_CATEGORY, LOGL_ERR, "%s: returning err=%d\n", _msg, \
355 __ret); \
356 __ret; \
357 })
Simon Glassb2faacc2021-01-20 20:10:54 -0700358
359/*
360 * Similar to the above, but any non-zero value is consider an error, not just
361 * values less than 0.
362 */
363#define log_retz(_ret) ({ \
364 int __ret = (_ret); \
365 if (__ret) \
366 log(LOG_CATEGORY, LOGL_ERR, "returning err=%d\n", __ret); \
367 __ret; \
368 })
369#define log_msg_retz(_msg, _ret) ({ \
370 int __ret = (_ret); \
371 if (__ret) \
372 log(LOG_CATEGORY, LOGL_ERR, "%s: returning err=%d\n", _msg, \
373 __ret); \
374 __ret; \
375 })
Simon Glassaa1d73b2017-12-28 13:14:23 -0700376#else
Simon Glassb56cdc02018-11-15 18:43:49 -0700377/* Non-logging versions of the above which just return the error code */
Simon Glassaa1d73b2017-12-28 13:14:23 -0700378#define log_ret(_ret) (_ret)
Simon Glassb56cdc02018-11-15 18:43:49 -0700379#define log_msg_ret(_msg, _ret) ((void)(_msg), _ret)
Simon Glassb2faacc2021-01-20 20:10:54 -0700380#define log_retz(_ret) (_ret)
381#define log_msg_retz(_msg, _ret) ((void)(_msg), _ret)
Simon Glassaa1d73b2017-12-28 13:14:23 -0700382#endif
383
Simon Glassf0803432021-01-20 20:10:52 -0700384/** * enum log_rec_flags - Flags for a log record */
385enum log_rec_flags {
386 /** @LOGRECF_FORCE_DEBUG: Force output of debug record */
387 LOGRECF_FORCE_DEBUG = BIT(0),
Simon Glass5fc47e32021-01-20 20:10:53 -0700388 /** @LOGRECF_CONT: Continuation of previous log record */
389 LOGRECF_CONT = BIT(1),
Simon Glassf0803432021-01-20 20:10:52 -0700390};
391
Simon Glassd95645d2017-12-04 13:48:24 -0700392/**
393 * struct log_rec - a single log record
394 *
395 * Holds information about a single record in the log
396 *
397 * Members marked as 'not allocated' are stored as pointers and the caller is
398 * responsible for making sure that the data pointed to is not overwritten.
Heinrich Schuchardtec506d92020-11-30 09:04:48 +0100399 * Members marked as 'allocated' are allocated (e.g. via strdup()) by the log
Simon Glassd95645d2017-12-04 13:48:24 -0700400 * system.
401 *
Simon Glass9c83cac2020-09-12 11:13:34 -0600402 * TODO(sjg@chromium.org): Compress this struct down a bit to reduce space, e.g.
403 * a single u32 for cat, level, line and force_debug
404 *
Simon Glassd95645d2017-12-04 13:48:24 -0700405 * @cat: Category, representing a uclass or part of U-Boot
406 * @level: Severity level, less severe is higher
Simon Glassd95645d2017-12-04 13:48:24 -0700407 * @line: Line number where the log record was generated
Simon Glassf0803432021-01-20 20:10:52 -0700408 * @flags: Flags for log record (enum log_rec_flags)
409 * @file: Name of file where the log record was generated (not allocated)
Simon Glassd95645d2017-12-04 13:48:24 -0700410 * @func: Function where the log record was generated (not allocated)
411 * @msg: Log message (allocated)
412 */
413struct log_rec {
414 enum log_category_t cat;
415 enum log_level_t level;
Simon Glassf0803432021-01-20 20:10:52 -0700416 u16 line;
417 u8 flags;
Simon Glassd95645d2017-12-04 13:48:24 -0700418 const char *file;
Simon Glassd95645d2017-12-04 13:48:24 -0700419 const char *func;
420 const char *msg;
421};
422
423struct log_device;
424
Simon Glass885cf5f2020-09-12 12:28:47 -0600425enum log_device_flags {
426 LOGDF_ENABLE = BIT(0), /* Device is enabled */
427};
428
Simon Glassd95645d2017-12-04 13:48:24 -0700429/**
430 * struct log_driver - a driver which accepts and processes log records
431 *
432 * @name: Name of driver
Simon Glass885cf5f2020-09-12 12:28:47 -0600433 * @emit: Method to call to emit a log record via this device
434 * @flags: Initial value for flags (use LOGDF_ENABLE to enable on start-up)
Simon Glassd95645d2017-12-04 13:48:24 -0700435 */
436struct log_driver {
437 const char *name;
Sean Andersonce02d8f2020-10-27 19:55:40 -0400438
Simon Glassd95645d2017-12-04 13:48:24 -0700439 /**
Sean Andersonce02d8f2020-10-27 19:55:40 -0400440 * @emit: emit a log record
Simon Glassd95645d2017-12-04 13:48:24 -0700441 *
442 * Called by the log system to pass a log record to a particular driver
443 * for processing. The filter is checked before calling this function.
444 */
445 int (*emit)(struct log_device *ldev, struct log_rec *rec);
Simon Glass885cf5f2020-09-12 12:28:47 -0600446 unsigned short flags;
Simon Glassd95645d2017-12-04 13:48:24 -0700447};
448
449/**
450 * struct log_device - an instance of a log driver
451 *
452 * Since drivers are set up at build-time we need to have a separate device for
453 * the run-time aspects of drivers (currently just a list of filters to apply
454 * to records send to this device).
455 *
Heinrich Schuchardtec506d92020-11-30 09:04:48 +0100456 * @next_filter_num: Sequence number of next filter filter added (0=no filters
Simon Glassd95645d2017-12-04 13:48:24 -0700457 * yet). This increments with each new filter on the device, but never
458 * decrements
Simon Glass885cf5f2020-09-12 12:28:47 -0600459 * @flags: Flags for this filter (enum log_device_flags)
Simon Glassd95645d2017-12-04 13:48:24 -0700460 * @drv: Pointer to driver for this device
461 * @filter_head: List of filters for this device
462 * @sibling_node: Next device in the list of all devices
463 */
464struct log_device {
Simon Glass885cf5f2020-09-12 12:28:47 -0600465 unsigned short next_filter_num;
466 unsigned short flags;
Simon Glassd95645d2017-12-04 13:48:24 -0700467 struct log_driver *drv;
468 struct list_head filter_head;
469 struct list_head sibling_node;
470};
471
472enum {
473 LOGF_MAX_CATEGORIES = 5, /* maximum categories per filter */
474};
475
Sean Andersond5032122020-10-27 19:55:26 -0400476/**
477 * enum log_filter_flags - Flags which modify a filter
478 */
Simon Glassd95645d2017-12-04 13:48:24 -0700479enum log_filter_flags {
Sean Andersond5032122020-10-27 19:55:26 -0400480 /** @LOGFF_HAS_CAT: Filter has a category list */
481 LOGFF_HAS_CAT = 1 << 0,
482 /** @LOGFF_DENY: Filter denies matching messages */
483 LOGFF_DENY = 1 << 1,
Sean Anderson34dc8042020-10-27 19:55:30 -0400484 /** @LOGFF_LEVEL_MIN: Filter's level is a minimum, not a maximum */
485 LOGFF_LEVEL_MIN = 1 << 2,
Simon Glassd95645d2017-12-04 13:48:24 -0700486};
487
488/**
Heinrich Schuchardtec506d92020-11-30 09:04:48 +0100489 * struct log_filter - criteria to filter out log messages
Simon Glassd95645d2017-12-04 13:48:24 -0700490 *
Sean Andersond5032122020-10-27 19:55:26 -0400491 * If a message matches all criteria, then it is allowed. If LOGFF_DENY is set,
492 * then it is denied instead.
493 *
Simon Glassd95645d2017-12-04 13:48:24 -0700494 * @filter_num: Sequence number of this filter. This is returned when adding a
495 * new filter, and must be provided when removing a previously added
496 * filter.
Sean Andersonce02d8f2020-10-27 19:55:40 -0400497 * @flags: Flags for this filter (``LOGFF_...``)
Sean Andersone1eb6ca2020-10-27 19:55:21 -0400498 * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
Sean Andersonce02d8f2020-10-27 19:55:40 -0400499 * then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
Simon Glassd95645d2017-12-04 13:48:24 -0700500 * can be provided
Sean Andersonce02d8f2020-10-27 19:55:40 -0400501 * @level: Maximum (or minimum, if %LOGFF_MIN_LEVEL) log level to allow
Simon Glassd95645d2017-12-04 13:48:24 -0700502 * @file_list: List of files to allow, separated by comma. If NULL then all
503 * files are permitted
504 * @sibling_node: Next filter in the list of filters for this log device
505 */
506struct log_filter {
507 int filter_num;
508 int flags;
509 enum log_category_t cat_list[LOGF_MAX_CATEGORIES];
Sean Anderson34dc8042020-10-27 19:55:30 -0400510 enum log_level_t level;
Simon Glassd95645d2017-12-04 13:48:24 -0700511 const char *file_list;
512 struct list_head sibling_node;
513};
514
515#define LOG_DRIVER(_name) \
516 ll_entry_declare(struct log_driver, _name, log_driver)
517
Simon Glass133350a2020-09-12 12:28:49 -0600518/* Get a pointer to a given driver */
519#define LOG_GET_DRIVER(__name) \
520 ll_entry_get(struct log_driver, __name, log_driver)
521
Simon Glass4f0fdb72017-12-28 13:14:16 -0700522/**
523 * log_get_cat_name() - Get the name of a category
524 *
525 * @cat: Category to look up
Sean Andersonce02d8f2020-10-27 19:55:40 -0400526 * Return: category name (which may be a uclass driver name) if found, or
Sean Andersoncd6f8ab2020-10-27 19:55:34 -0400527 * "<invalid>" if invalid, or "<missing>" if not found. All error
528 * responses begin with '<'.
Simon Glass4f0fdb72017-12-28 13:14:16 -0700529 */
530const char *log_get_cat_name(enum log_category_t cat);
531
532/**
533 * log_get_cat_by_name() - Look up a category by name
534 *
535 * @name: Name to look up
Sean Andersonce02d8f2020-10-27 19:55:40 -0400536 * Return: Category, or %LOGC_NONE if not found
Simon Glass4f0fdb72017-12-28 13:14:16 -0700537 */
538enum log_category_t log_get_cat_by_name(const char *name);
539
540/**
541 * log_get_level_name() - Get the name of a log level
542 *
543 * @level: Log level to look up
Sean Andersonce02d8f2020-10-27 19:55:40 -0400544 * Return: Log level name (in ALL CAPS)
Simon Glass4f0fdb72017-12-28 13:14:16 -0700545 */
546const char *log_get_level_name(enum log_level_t level);
547
548/**
549 * log_get_level_by_name() - Look up a log level by name
550 *
551 * @name: Name to look up
Sean Andersonce02d8f2020-10-27 19:55:40 -0400552 * Return: Log level, or %LOGL_NONE if not found
Simon Glass4f0fdb72017-12-28 13:14:16 -0700553 */
554enum log_level_t log_get_level_by_name(const char *name);
555
Sean Andersoncc4960d2020-10-27 19:55:24 -0400556/**
557 * log_device_find_by_name() - Look up a log device by its driver's name
558 *
559 * @drv_name: Name of the driver
Sean Andersonce02d8f2020-10-27 19:55:40 -0400560 * Return: the log device, or %NULL if not found
Sean Andersoncc4960d2020-10-27 19:55:24 -0400561 */
562struct log_device *log_device_find_by_name(const char *drv_name);
563
564/**
565 * log_has_cat() - check if a log category exists within a list
566 *
567 * @cat_list: List of categories to check, at most %LOGF_MAX_CATEGORIES entries
568 * long, terminated by %LC_END if fewer
569 * @cat: Category to search for
570 *
571 * Return: ``true`` if @cat is in @cat_list, else ``false``
572 */
573bool log_has_cat(enum log_category_t cat_list[], enum log_category_t cat);
574
575/**
576 * log_has_file() - check if a file is with a list
577 *
578 * @file_list: List of files to check, separated by comma
579 * @file: File to check for. This string is matched against the end of each
580 * file in the list, i.e. ignoring any preceding path. The list is
581 * intended to consist of relative pathnames, e.g. common/main.c,cmd/log.c
582 *
583 * Return: ``true`` if @file is in @file_list, else ``false``
584 */
585bool log_has_file(const char *file_list, const char *file);
586
Simon Glass1fe93012017-12-28 13:14:17 -0700587/* Log format flags (bit numbers) for gd->log_fmt. See log_fmt_chars */
588enum log_fmt {
589 LOGF_CAT = 0,
590 LOGF_LEVEL,
591 LOGF_FILE,
592 LOGF_LINE,
593 LOGF_FUNC,
594 LOGF_MSG,
595
596 LOGF_COUNT,
Simon Glass1fe93012017-12-28 13:14:17 -0700597 LOGF_ALL = 0x3f,
598};
599
Simon Glass14c8a062017-12-04 13:48:27 -0700600/* Handle the 'log test' command */
Simon Glassed38aef2020-05-10 11:40:03 -0600601int do_log_test(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
Simon Glass14c8a062017-12-04 13:48:27 -0700602
Simon Glassd95645d2017-12-04 13:48:24 -0700603/**
Sean Anderson8c410182020-10-27 19:55:25 -0400604 * log_add_filter_flags() - Add a new filter to a log device, specifying flags
605 *
606 * @drv_name: Driver name to add the filter to (since each driver only has a
607 * single device)
Sean Andersonce02d8f2020-10-27 19:55:40 -0400608 * @flags: Flags for this filter (``LOGFF_...``)
Sean Anderson8c410182020-10-27 19:55:25 -0400609 * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
Sean Andersonce02d8f2020-10-27 19:55:40 -0400610 * then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
Sean Anderson8c410182020-10-27 19:55:25 -0400611 * can be provided
Sean Andersonce02d8f2020-10-27 19:55:40 -0400612 * @level: Maximum (or minimum, if %LOGFF_LEVEL_MIN) log level to allow
Sean Anderson8c410182020-10-27 19:55:25 -0400613 * @file_list: List of files to allow, separated by comma. If NULL then all
614 * files are permitted
Sean Andersonce02d8f2020-10-27 19:55:40 -0400615 * Return:
616 * the sequence number of the new filter (>=0) if the filter was added, or a
617 * -ve value on error
Sean Anderson8c410182020-10-27 19:55:25 -0400618 */
619int log_add_filter_flags(const char *drv_name, enum log_category_t cat_list[],
Sean Anderson34dc8042020-10-27 19:55:30 -0400620 enum log_level_t level, const char *file_list,
Sean Anderson8c410182020-10-27 19:55:25 -0400621 int flags);
622
623/**
Simon Glassd95645d2017-12-04 13:48:24 -0700624 * log_add_filter() - Add a new filter to a log device
625 *
626 * @drv_name: Driver name to add the filter to (since each driver only has a
627 * single device)
Sean Andersone1eb6ca2020-10-27 19:55:21 -0400628 * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
Sean Andersonce02d8f2020-10-27 19:55:40 -0400629 * then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
Simon Glassd95645d2017-12-04 13:48:24 -0700630 * can be provided
631 * @max_level: Maximum log level to allow
Sean Andersonce02d8f2020-10-27 19:55:40 -0400632 * @file_list: List of files to allow, separated by comma. If %NULL then all
Simon Glassd95645d2017-12-04 13:48:24 -0700633 * files are permitted
Sean Andersonce02d8f2020-10-27 19:55:40 -0400634 * Return:
635 * the sequence number of the new filter (>=0) if the filter was added, or a
636 * -ve value on error
Simon Glassd95645d2017-12-04 13:48:24 -0700637 */
Sean Anderson8c410182020-10-27 19:55:25 -0400638static inline int log_add_filter(const char *drv_name,
639 enum log_category_t cat_list[],
640 enum log_level_t max_level,
641 const char *file_list)
642{
643 return log_add_filter_flags(drv_name, cat_list, max_level, file_list,
644 0);
645}
Simon Glassd95645d2017-12-04 13:48:24 -0700646
647/**
648 * log_remove_filter() - Remove a filter from a log device
649 *
650 * @drv_name: Driver name to remove the filter from (since each driver only has
651 * a single device)
652 * @filter_num: Filter number to remove (as returned by log_add_filter())
Sean Andersonce02d8f2020-10-27 19:55:40 -0400653 * Return:
654 * 0 if the filter was removed, -%ENOENT if either the driver or the filter
655 * number was not found
Simon Glassd95645d2017-12-04 13:48:24 -0700656 */
657int log_remove_filter(const char *drv_name, int filter_num);
658
Simon Glass133350a2020-09-12 12:28:49 -0600659/**
660 * log_device_set_enable() - Enable or disable a log device
661 *
662 * Devices are referenced by their driver, so use LOG_GET_DRIVER(name) to pass
663 * the driver to this function. For example if the driver is declared with
664 * LOG_DRIVER(wibble) then pass LOG_GET_DRIVER(wibble) here.
665 *
666 * @drv: Driver of device to enable
667 * @enable: true to enable, false to disable
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100668 * Return: 0 if OK, -ENOENT if the driver was not found
Simon Glass133350a2020-09-12 12:28:49 -0600669 */
670int log_device_set_enable(struct log_driver *drv, bool enable);
671
Simon Glassd95645d2017-12-04 13:48:24 -0700672#if CONFIG_IS_ENABLED(LOG)
673/**
674 * log_init() - Set up the log system ready for use
675 *
Sean Andersonce02d8f2020-10-27 19:55:40 -0400676 * Return: 0 if OK, -%ENOMEM if out of memory
Simon Glassd95645d2017-12-04 13:48:24 -0700677 */
678int log_init(void);
679#else
680static inline int log_init(void)
681{
682 return 0;
683}
684#endif
685
Heinrich Schuchardt2d349c72020-06-17 21:52:44 +0200686/**
687 * log_get_default_format() - get default log format
688 *
689 * The default log format is configurable via
Sean Andersonce02d8f2020-10-27 19:55:40 -0400690 * %CONFIG_LOGF_FILE, %CONFIG_LOGF_LINE, and %CONFIG_LOGF_FUNC.
Heinrich Schuchardt2d349c72020-06-17 21:52:44 +0200691 *
692 * Return: default log format
693 */
694static inline int log_get_default_format(void)
695{
696 return BIT(LOGF_MSG) |
697 (IS_ENABLED(CONFIG_LOGF_FILE) ? BIT(LOGF_FILE) : 0) |
698 (IS_ENABLED(CONFIG_LOGF_LINE) ? BIT(LOGF_LINE) : 0) |
699 (IS_ENABLED(CONFIG_LOGF_FUNC) ? BIT(LOGF_FUNC) : 0);
700}
701
Simon Glass9054a022017-12-04 13:48:20 -0700702#endif