blob: 8f35c10abb5e28f9c46793e581cc0abbcee0ca03 [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 Glassfd429482019-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 Glass58b4b712021-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 Glasse9c8d492017-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 Glasse1cbd912021-05-08 13:46:54 -0600179#else
180#define _LOG_MAX_LEVEL LOGL_INFO
181#endif
182
Heinrich Schuchardt24967962021-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 Glasscdd140a2018-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 Schuchardt24967962021-01-04 08:02:54 +0100193#define log_cont(_fmt...) log(LOGC_CONT, LOGL_CONT, ##_fmt)
Simon Glasse9c8d492017-12-04 13:48:24 -0700194
Simon Glassf9811e82019-02-16 20:24:37 -0700195#ifdef LOG_DEBUG
Simon Glass52d3df72020-09-12 11:13:34 -0600196#define _LOG_DEBUG LOGL_FORCE_DEBUG
Simon Glassf9811e82019-02-16 20:24:37 -0700197#else
198#define _LOG_DEBUG 0
199#endif
Simon Glass4d8d3052018-11-15 18:43:49 -0700200
Simon Glasse1cbd912021-05-08 13:46:54 -0600201#if CONFIG_IS_ENABLED(LOG)
202
Simon Glasse9c8d492017-12-04 13:48:24 -0700203/* Emit a log record if the level is less that the maximum */
204#define log(_cat, _level, _fmt, _args...) ({ \
205 int _l = _level; \
Simon Glasse1cbd912021-05-08 13:46:54 -0600206 if (_LOG_DEBUG != 0 || _l <= _LOG_MAX_LEVEL) \
Simon Glass52d3df72020-09-12 11:13:34 -0600207 _log((enum log_category_t)(_cat), \
208 (enum log_level_t)(_l | _LOG_DEBUG), __FILE__, \
209 __LINE__, __func__, \
Simon Glasse9c8d492017-12-04 13:48:24 -0700210 pr_fmt(_fmt), ##_args); \
211 })
Simon Glass58b4b712021-05-08 07:00:06 -0600212
213/* Emit a dump if the level is less that the maximum */
214#define log_buffer(_cat, _level, _addr, _data, _width, _count, _linelen) ({ \
215 int _l = _level; \
216 if (_LOG_DEBUG != 0 || _l <= _LOG_MAX_LEVEL) \
217 _log_buffer((enum log_category_t)(_cat), \
218 (enum log_level_t)(_l | _LOG_DEBUG), __FILE__, \
219 __LINE__, __func__, _addr, _data, \
220 _width, _count, _linelen); \
221 })
Simon Glass4d8d3052018-11-15 18:43:49 -0700222#else
Simon Glasse1cbd912021-05-08 13:46:54 -0600223
224/* Note: _LOG_DEBUG != 0 avoids a warning with clang */
225#define log(_cat, _level, _fmt, _args...) ({ \
226 int _l = _level; \
227 if (_LOG_DEBUG != 0 || _l <= LOGL_INFO || \
228 (_DEBUG && _l == LOGL_DEBUG)) \
229 printf(_fmt, ##_args); \
230 })
Simon Glass58b4b712021-05-08 07:00:06 -0600231
232#define log_buffer(_cat, _level, _addr, _data, _width, _count, _linelen) ({ \
233 int _l = _level; \
234 if (_LOG_DEBUG != 0 || _l <= LOGL_INFO || \
235 (_DEBUG && _l == LOGL_DEBUG)) \
236 print_buffer(_addr, _data, _width, _count, _linelen); \
237 })
Simon Glass4d8d3052018-11-15 18:43:49 -0700238#endif
Simon Glasse9c8d492017-12-04 13:48:24 -0700239
Simon Glassfd429482019-09-25 08:56:23 -0600240#define log_nop(_cat, _level, _fmt, _args...) ({ \
241 int _l = _level; \
242 _log_nop((enum log_category_t)(_cat), _l, __FILE__, __LINE__, \
243 __func__, pr_fmt(_fmt), ##_args); \
244})
245
Simon Glass0e98b0a2017-12-04 13:48:20 -0700246#ifdef DEBUG
247#define _DEBUG 1
248#else
249#define _DEBUG 0
250#endif
251
252#ifdef CONFIG_SPL_BUILD
253#define _SPL_BUILD 1
254#else
255#define _SPL_BUILD 0
256#endif
257
Simon Glass4ce5b812021-03-26 16:17:28 +1300258#if CONFIG_IS_ENABLED(LOG)
Simon Glasse9c8d492017-12-04 13:48:24 -0700259
Simon Glass4ce5b812021-03-26 16:17:28 +1300260#define debug_cond(cond, fmt, args...) \
261({ \
262 if (cond) \
263 log(LOG_CATEGORY, \
264 (enum log_level_t)(LOGL_FORCE_DEBUG | _LOG_DEBUG), \
265 fmt, ##args); \
Heinrich Schuchardt51763652021-01-04 08:02:53 +0100266})
Simon Glasse9c8d492017-12-04 13:48:24 -0700267
268#else /* _DEBUG */
269
Simon Glass0e98b0a2017-12-04 13:48:20 -0700270/*
271 * Output a debug text when condition "cond" is met. The "cond" should be
272 * computed by a preprocessor in the best case, allowing for the best
273 * optimization.
274 */
Heinrich Schuchardt51763652021-01-04 08:02:53 +0100275#define debug_cond(cond, fmt, args...) \
276({ \
277 if (cond) \
278 printf(pr_fmt(fmt), ##args); \
279})
Simon Glass0e98b0a2017-12-04 13:48:20 -0700280
Simon Glasse9c8d492017-12-04 13:48:24 -0700281#endif /* _DEBUG */
282
Simon Glass0e98b0a2017-12-04 13:48:20 -0700283/* Show a message if DEBUG is defined in a file */
284#define debug(fmt, args...) \
285 debug_cond(_DEBUG, fmt, ##args)
286
287/* Show a message if not in SPL */
288#define warn_non_spl(fmt, args...) \
289 debug_cond(!_SPL_BUILD, fmt, ##args)
290
291/*
292 * An assertion is run-time check done in debug mode only. If DEBUG is not
293 * defined then it is skipped. If DEBUG is defined and the assertion fails,
294 * then it calls panic*( which may or may not reset/halt U-Boot (see
295 * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
296 * before release, and after release it is hoped that they don't matter. But
297 * in any case these failing assertions cannot be fixed with a reset (which
298 * may just do the same assertion again).
299 */
300void __assert_fail(const char *assertion, const char *file, unsigned int line,
301 const char *function);
Heinrich Schuchardtb236f8c2019-07-27 20:21:06 +0200302
303/**
304 * assert() - assert expression is true
305 *
306 * If the expression x evaluates to false and _DEBUG evaluates to true, a panic
307 * message is written and the system stalls. The value of _DEBUG is set to true
308 * if DEBUG is defined before including common.h.
309 *
310 * The expression x is always executed irrespective of the value of _DEBUG.
311 *
312 * @x: expression to test
313 */
Simon Glass0e98b0a2017-12-04 13:48:20 -0700314#define assert(x) \
315 ({ if (!(x) && _DEBUG) \
316 __assert_fail(#x, __FILE__, __LINE__, __func__); })
317
Simon Glasscd01d2d2019-12-29 21:19:10 -0700318/*
319 * This one actually gets compiled in even without DEBUG. It doesn't include the
320 * full pathname as it may be huge. Only use this when the user should be
321 * warning, similar to BUG_ON() in linux.
322 *
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400323 * Return: true if assertion succeeded (condition is true), else false
Simon Glasscd01d2d2019-12-29 21:19:10 -0700324 */
325#define assert_noisy(x) \
326 ({ bool _val = (x); \
327 if (!_val) \
328 __assert_fail(#x, "?", __LINE__, __func__); \
329 _val; \
330 })
331
Simon Glass4d8d3052018-11-15 18:43:49 -0700332#if CONFIG_IS_ENABLED(LOG) && defined(CONFIG_LOG_ERROR_RETURN)
333/*
334 * Log an error return value, possibly with a message. Usage:
335 *
336 * return log_ret(fred_call());
337 *
338 * or:
339 *
340 * return log_msg_ret("fred failed", fred_call());
341 */
Simon Glass3707c6e2017-12-28 13:14:23 -0700342#define log_ret(_ret) ({ \
343 int __ret = (_ret); \
344 if (__ret < 0) \
345 log(LOG_CATEGORY, LOGL_ERR, "returning err=%d\n", __ret); \
346 __ret; \
347 })
Simon Glassb616cef2018-06-11 13:07:14 -0600348#define log_msg_ret(_msg, _ret) ({ \
349 int __ret = (_ret); \
350 if (__ret < 0) \
351 log(LOG_CATEGORY, LOGL_ERR, "%s: returning err=%d\n", _msg, \
352 __ret); \
353 __ret; \
354 })
Simon Glass7bd06582021-01-20 20:10:54 -0700355
356/*
357 * Similar to the above, but any non-zero value is consider an error, not just
358 * values less than 0.
359 */
360#define log_retz(_ret) ({ \
361 int __ret = (_ret); \
362 if (__ret) \
363 log(LOG_CATEGORY, LOGL_ERR, "returning err=%d\n", __ret); \
364 __ret; \
365 })
366#define log_msg_retz(_msg, _ret) ({ \
367 int __ret = (_ret); \
368 if (__ret) \
369 log(LOG_CATEGORY, LOGL_ERR, "%s: returning err=%d\n", _msg, \
370 __ret); \
371 __ret; \
372 })
Simon Glass3707c6e2017-12-28 13:14:23 -0700373#else
Simon Glass4d8d3052018-11-15 18:43:49 -0700374/* Non-logging versions of the above which just return the error code */
Simon Glass3707c6e2017-12-28 13:14:23 -0700375#define log_ret(_ret) (_ret)
Simon Glass4d8d3052018-11-15 18:43:49 -0700376#define log_msg_ret(_msg, _ret) ((void)(_msg), _ret)
Simon Glass7bd06582021-01-20 20:10:54 -0700377#define log_retz(_ret) (_ret)
378#define log_msg_retz(_msg, _ret) ((void)(_msg), _ret)
Simon Glass3707c6e2017-12-28 13:14:23 -0700379#endif
380
Simon Glass79d59832021-01-20 20:10:52 -0700381/** * enum log_rec_flags - Flags for a log record */
382enum log_rec_flags {
383 /** @LOGRECF_FORCE_DEBUG: Force output of debug record */
384 LOGRECF_FORCE_DEBUG = BIT(0),
Simon Glass9ad7a6c2021-01-20 20:10:53 -0700385 /** @LOGRECF_CONT: Continuation of previous log record */
386 LOGRECF_CONT = BIT(1),
Simon Glass79d59832021-01-20 20:10:52 -0700387};
388
Simon Glasse9c8d492017-12-04 13:48:24 -0700389/**
390 * struct log_rec - a single log record
391 *
392 * Holds information about a single record in the log
393 *
394 * Members marked as 'not allocated' are stored as pointers and the caller is
395 * responsible for making sure that the data pointed to is not overwritten.
Heinrich Schuchardt9e925d02020-11-30 09:04:48 +0100396 * Members marked as 'allocated' are allocated (e.g. via strdup()) by the log
Simon Glasse9c8d492017-12-04 13:48:24 -0700397 * system.
398 *
Simon Glass52d3df72020-09-12 11:13:34 -0600399 * TODO(sjg@chromium.org): Compress this struct down a bit to reduce space, e.g.
400 * a single u32 for cat, level, line and force_debug
401 *
Simon Glasse9c8d492017-12-04 13:48:24 -0700402 * @cat: Category, representing a uclass or part of U-Boot
403 * @level: Severity level, less severe is higher
Simon Glasse9c8d492017-12-04 13:48:24 -0700404 * @line: Line number where the log record was generated
Simon Glass79d59832021-01-20 20:10:52 -0700405 * @flags: Flags for log record (enum log_rec_flags)
406 * @file: Name of file where the log record was generated (not allocated)
Simon Glasse9c8d492017-12-04 13:48:24 -0700407 * @func: Function where the log record was generated (not allocated)
408 * @msg: Log message (allocated)
409 */
410struct log_rec {
411 enum log_category_t cat;
412 enum log_level_t level;
Simon Glass79d59832021-01-20 20:10:52 -0700413 u16 line;
414 u8 flags;
Simon Glasse9c8d492017-12-04 13:48:24 -0700415 const char *file;
Simon Glasse9c8d492017-12-04 13:48:24 -0700416 const char *func;
417 const char *msg;
418};
419
420struct log_device;
421
Simon Glassb4520302020-09-12 12:28:47 -0600422enum log_device_flags {
423 LOGDF_ENABLE = BIT(0), /* Device is enabled */
424};
425
Simon Glasse9c8d492017-12-04 13:48:24 -0700426/**
427 * struct log_driver - a driver which accepts and processes log records
428 *
429 * @name: Name of driver
Simon Glassb4520302020-09-12 12:28:47 -0600430 * @emit: Method to call to emit a log record via this device
431 * @flags: Initial value for flags (use LOGDF_ENABLE to enable on start-up)
Simon Glasse9c8d492017-12-04 13:48:24 -0700432 */
433struct log_driver {
434 const char *name;
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400435
Simon Glasse9c8d492017-12-04 13:48:24 -0700436 /**
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400437 * @emit: emit a log record
Simon Glasse9c8d492017-12-04 13:48:24 -0700438 *
439 * Called by the log system to pass a log record to a particular driver
440 * for processing. The filter is checked before calling this function.
441 */
442 int (*emit)(struct log_device *ldev, struct log_rec *rec);
Simon Glassb4520302020-09-12 12:28:47 -0600443 unsigned short flags;
Simon Glasse9c8d492017-12-04 13:48:24 -0700444};
445
446/**
447 * struct log_device - an instance of a log driver
448 *
449 * Since drivers are set up at build-time we need to have a separate device for
450 * the run-time aspects of drivers (currently just a list of filters to apply
451 * to records send to this device).
452 *
Heinrich Schuchardt9e925d02020-11-30 09:04:48 +0100453 * @next_filter_num: Sequence number of next filter filter added (0=no filters
Simon Glasse9c8d492017-12-04 13:48:24 -0700454 * yet). This increments with each new filter on the device, but never
455 * decrements
Simon Glassb4520302020-09-12 12:28:47 -0600456 * @flags: Flags for this filter (enum log_device_flags)
Simon Glasse9c8d492017-12-04 13:48:24 -0700457 * @drv: Pointer to driver for this device
458 * @filter_head: List of filters for this device
459 * @sibling_node: Next device in the list of all devices
460 */
461struct log_device {
Simon Glassb4520302020-09-12 12:28:47 -0600462 unsigned short next_filter_num;
463 unsigned short flags;
Simon Glasse9c8d492017-12-04 13:48:24 -0700464 struct log_driver *drv;
465 struct list_head filter_head;
466 struct list_head sibling_node;
467};
468
469enum {
470 LOGF_MAX_CATEGORIES = 5, /* maximum categories per filter */
471};
472
Sean Andersonfe3b1a22020-10-27 19:55:26 -0400473/**
474 * enum log_filter_flags - Flags which modify a filter
475 */
Simon Glasse9c8d492017-12-04 13:48:24 -0700476enum log_filter_flags {
Sean Andersonfe3b1a22020-10-27 19:55:26 -0400477 /** @LOGFF_HAS_CAT: Filter has a category list */
478 LOGFF_HAS_CAT = 1 << 0,
479 /** @LOGFF_DENY: Filter denies matching messages */
480 LOGFF_DENY = 1 << 1,
Sean Anderson40455a62020-10-27 19:55:30 -0400481 /** @LOGFF_LEVEL_MIN: Filter's level is a minimum, not a maximum */
482 LOGFF_LEVEL_MIN = 1 << 2,
Simon Glasse9c8d492017-12-04 13:48:24 -0700483};
484
485/**
Heinrich Schuchardt9e925d02020-11-30 09:04:48 +0100486 * struct log_filter - criteria to filter out log messages
Simon Glasse9c8d492017-12-04 13:48:24 -0700487 *
Sean Andersonfe3b1a22020-10-27 19:55:26 -0400488 * If a message matches all criteria, then it is allowed. If LOGFF_DENY is set,
489 * then it is denied instead.
490 *
Simon Glasse9c8d492017-12-04 13:48:24 -0700491 * @filter_num: Sequence number of this filter. This is returned when adding a
492 * new filter, and must be provided when removing a previously added
493 * filter.
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400494 * @flags: Flags for this filter (``LOGFF_...``)
Sean Andersonb66a9242020-10-27 19:55:21 -0400495 * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400496 * then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
Simon Glasse9c8d492017-12-04 13:48:24 -0700497 * can be provided
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400498 * @level: Maximum (or minimum, if %LOGFF_MIN_LEVEL) log level to allow
Simon Glasse9c8d492017-12-04 13:48:24 -0700499 * @file_list: List of files to allow, separated by comma. If NULL then all
500 * files are permitted
501 * @sibling_node: Next filter in the list of filters for this log device
502 */
503struct log_filter {
504 int filter_num;
505 int flags;
506 enum log_category_t cat_list[LOGF_MAX_CATEGORIES];
Sean Anderson40455a62020-10-27 19:55:30 -0400507 enum log_level_t level;
Simon Glasse9c8d492017-12-04 13:48:24 -0700508 const char *file_list;
509 struct list_head sibling_node;
510};
511
512#define LOG_DRIVER(_name) \
513 ll_entry_declare(struct log_driver, _name, log_driver)
514
Simon Glass3d03ab62020-09-12 12:28:49 -0600515/* Get a pointer to a given driver */
516#define LOG_GET_DRIVER(__name) \
517 ll_entry_get(struct log_driver, __name, log_driver)
518
Simon Glassf941c8d2017-12-28 13:14:16 -0700519/**
520 * log_get_cat_name() - Get the name of a category
521 *
522 * @cat: Category to look up
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400523 * Return: category name (which may be a uclass driver name) if found, or
Sean Anderson1c593a12020-10-27 19:55:34 -0400524 * "<invalid>" if invalid, or "<missing>" if not found. All error
525 * responses begin with '<'.
Simon Glassf941c8d2017-12-28 13:14:16 -0700526 */
527const char *log_get_cat_name(enum log_category_t cat);
528
529/**
530 * log_get_cat_by_name() - Look up a category by name
531 *
532 * @name: Name to look up
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400533 * Return: Category, or %LOGC_NONE if not found
Simon Glassf941c8d2017-12-28 13:14:16 -0700534 */
535enum log_category_t log_get_cat_by_name(const char *name);
536
537/**
538 * log_get_level_name() - Get the name of a log level
539 *
540 * @level: Log level to look up
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400541 * Return: Log level name (in ALL CAPS)
Simon Glassf941c8d2017-12-28 13:14:16 -0700542 */
543const char *log_get_level_name(enum log_level_t level);
544
545/**
546 * log_get_level_by_name() - Look up a log level by name
547 *
548 * @name: Name to look up
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400549 * Return: Log level, or %LOGL_NONE if not found
Simon Glassf941c8d2017-12-28 13:14:16 -0700550 */
551enum log_level_t log_get_level_by_name(const char *name);
552
Sean Anderson3102c1d2020-10-27 19:55:24 -0400553/**
554 * log_device_find_by_name() - Look up a log device by its driver's name
555 *
556 * @drv_name: Name of the driver
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400557 * Return: the log device, or %NULL if not found
Sean Anderson3102c1d2020-10-27 19:55:24 -0400558 */
559struct log_device *log_device_find_by_name(const char *drv_name);
560
561/**
562 * log_has_cat() - check if a log category exists within a list
563 *
564 * @cat_list: List of categories to check, at most %LOGF_MAX_CATEGORIES entries
565 * long, terminated by %LC_END if fewer
566 * @cat: Category to search for
567 *
568 * Return: ``true`` if @cat is in @cat_list, else ``false``
569 */
570bool log_has_cat(enum log_category_t cat_list[], enum log_category_t cat);
571
572/**
573 * log_has_file() - check if a file is with a list
574 *
575 * @file_list: List of files to check, separated by comma
576 * @file: File to check for. This string is matched against the end of each
577 * file in the list, i.e. ignoring any preceding path. The list is
578 * intended to consist of relative pathnames, e.g. common/main.c,cmd/log.c
579 *
580 * Return: ``true`` if @file is in @file_list, else ``false``
581 */
582bool log_has_file(const char *file_list, const char *file);
583
Simon Glass3b73e8d2017-12-28 13:14:17 -0700584/* Log format flags (bit numbers) for gd->log_fmt. See log_fmt_chars */
585enum log_fmt {
586 LOGF_CAT = 0,
587 LOGF_LEVEL,
588 LOGF_FILE,
589 LOGF_LINE,
590 LOGF_FUNC,
591 LOGF_MSG,
592
593 LOGF_COUNT,
Simon Glass3b73e8d2017-12-28 13:14:17 -0700594 LOGF_ALL = 0x3f,
595};
596
Simon Glassef11ed82017-12-04 13:48:27 -0700597/* Handle the 'log test' command */
Simon Glass09140112020-05-10 11:40:03 -0600598int do_log_test(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
Simon Glassef11ed82017-12-04 13:48:27 -0700599
Simon Glasse9c8d492017-12-04 13:48:24 -0700600/**
Sean Andersona02f84e2020-10-27 19:55:25 -0400601 * log_add_filter_flags() - Add a new filter to a log device, specifying flags
602 *
603 * @drv_name: Driver name to add the filter to (since each driver only has a
604 * single device)
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400605 * @flags: Flags for this filter (``LOGFF_...``)
Sean Andersona02f84e2020-10-27 19:55:25 -0400606 * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400607 * then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
Sean Andersona02f84e2020-10-27 19:55:25 -0400608 * can be provided
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400609 * @level: Maximum (or minimum, if %LOGFF_LEVEL_MIN) log level to allow
Sean Andersona02f84e2020-10-27 19:55:25 -0400610 * @file_list: List of files to allow, separated by comma. If NULL then all
611 * files are permitted
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400612 * Return:
613 * the sequence number of the new filter (>=0) if the filter was added, or a
614 * -ve value on error
Sean Andersona02f84e2020-10-27 19:55:25 -0400615 */
616int log_add_filter_flags(const char *drv_name, enum log_category_t cat_list[],
Sean Anderson40455a62020-10-27 19:55:30 -0400617 enum log_level_t level, const char *file_list,
Sean Andersona02f84e2020-10-27 19:55:25 -0400618 int flags);
619
620/**
Simon Glasse9c8d492017-12-04 13:48:24 -0700621 * log_add_filter() - Add a new filter to a log device
622 *
623 * @drv_name: Driver name to add the filter to (since each driver only has a
624 * single device)
Sean Andersonb66a9242020-10-27 19:55:21 -0400625 * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400626 * then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
Simon Glasse9c8d492017-12-04 13:48:24 -0700627 * can be provided
628 * @max_level: Maximum log level to allow
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400629 * @file_list: List of files to allow, separated by comma. If %NULL then all
Simon Glasse9c8d492017-12-04 13:48:24 -0700630 * files are permitted
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400631 * Return:
632 * the sequence number of the new filter (>=0) if the filter was added, or a
633 * -ve value on error
Simon Glasse9c8d492017-12-04 13:48:24 -0700634 */
Sean Andersona02f84e2020-10-27 19:55:25 -0400635static inline int log_add_filter(const char *drv_name,
636 enum log_category_t cat_list[],
637 enum log_level_t max_level,
638 const char *file_list)
639{
640 return log_add_filter_flags(drv_name, cat_list, max_level, file_list,
641 0);
642}
Simon Glasse9c8d492017-12-04 13:48:24 -0700643
644/**
645 * log_remove_filter() - Remove a filter from a log device
646 *
647 * @drv_name: Driver name to remove the filter from (since each driver only has
648 * a single device)
649 * @filter_num: Filter number to remove (as returned by log_add_filter())
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400650 * Return:
651 * 0 if the filter was removed, -%ENOENT if either the driver or the filter
652 * number was not found
Simon Glasse9c8d492017-12-04 13:48:24 -0700653 */
654int log_remove_filter(const char *drv_name, int filter_num);
655
Simon Glass3d03ab62020-09-12 12:28:49 -0600656/**
657 * log_device_set_enable() - Enable or disable a log device
658 *
659 * Devices are referenced by their driver, so use LOG_GET_DRIVER(name) to pass
660 * the driver to this function. For example if the driver is declared with
661 * LOG_DRIVER(wibble) then pass LOG_GET_DRIVER(wibble) here.
662 *
663 * @drv: Driver of device to enable
664 * @enable: true to enable, false to disable
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100665 * Return: 0 if OK, -ENOENT if the driver was not found
Simon Glass3d03ab62020-09-12 12:28:49 -0600666 */
667int log_device_set_enable(struct log_driver *drv, bool enable);
668
Simon Glasse9c8d492017-12-04 13:48:24 -0700669#if CONFIG_IS_ENABLED(LOG)
670/**
671 * log_init() - Set up the log system ready for use
672 *
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400673 * Return: 0 if OK, -%ENOMEM if out of memory
Simon Glasse9c8d492017-12-04 13:48:24 -0700674 */
675int log_init(void);
676#else
677static inline int log_init(void)
678{
679 return 0;
680}
681#endif
682
Heinrich Schuchardt3c21d772020-06-17 21:52:44 +0200683/**
684 * log_get_default_format() - get default log format
685 *
686 * The default log format is configurable via
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400687 * %CONFIG_LOGF_FILE, %CONFIG_LOGF_LINE, and %CONFIG_LOGF_FUNC.
Heinrich Schuchardt3c21d772020-06-17 21:52:44 +0200688 *
689 * Return: default log format
690 */
691static inline int log_get_default_format(void)
692{
693 return BIT(LOGF_MSG) |
694 (IS_ENABLED(CONFIG_LOGF_FILE) ? BIT(LOGF_FILE) : 0) |
695 (IS_ENABLED(CONFIG_LOGF_LINE) ? BIT(LOGF_LINE) : 0) |
696 (IS_ENABLED(CONFIG_LOGF_FUNC) ? BIT(LOGF_FUNC) : 0);
697}
698
Simon Glass0e98b0a2017-12-04 13:48:20 -0700699#endif