blob: ce48d51446f5fa79fc84adc338f3129f141bd6af [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,
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400101 /** @LOGC_COUNT: Number of log categories */
102 LOGC_COUNT,
103 /** @LOGC_END: Sentinel value for lists of log categories */
104 LOGC_END,
105 /** @LOGC_CONT: Use same category as in previous call */
106 LOGC_CONT = -1,
Simon Glasse9c8d492017-12-04 13:48:24 -0700107};
108
109/* Helper to cast a uclass ID to a log category */
110static inline int log_uc_cat(enum uclass_id id)
111{
112 return (enum log_category_t)id;
113}
114
115/**
116 * _log() - Internal function to emit a new log record
117 *
118 * @cat: Category of log record (indicating which subsystem generated it)
119 * @level: Level of log record (indicating its severity)
120 * @file: File name of file where log record was generated
121 * @line: Line number in file where log record was generated
122 * @func: Function where log record was generated
123 * @fmt: printf() format string for log record
124 * @...: Optional parameters, according to the format string @fmt
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400125 * Return: 0 if log record was emitted, -ve on error
Simon Glasse9c8d492017-12-04 13:48:24 -0700126 */
127int _log(enum log_category_t cat, enum log_level_t level, const char *file,
Simon Glassed4e9332019-01-07 16:44:19 -0700128 int line, const char *func, const char *fmt, ...)
129 __attribute__ ((format (__printf__, 6, 7)));
Simon Glasse9c8d492017-12-04 13:48:24 -0700130
Simon Glassfd429482019-09-25 08:56:23 -0600131static inline int _log_nop(enum log_category_t cat, enum log_level_t level,
132 const char *file, int line, const char *func,
133 const char *fmt, ...)
134 __attribute__ ((format (__printf__, 6, 7)));
135
136static inline int _log_nop(enum log_category_t cat, enum log_level_t level,
137 const char *file, int line, const char *func,
138 const char *fmt, ...)
139{
140 return 0;
141}
142
Simon Glass58b4b712021-05-08 07:00:06 -0600143/**
144 * _log_buffer - Internal function to print data buffer in hex and ascii form
145 *
146 * @cat: Category of log record (indicating which subsystem generated it)
147 * @level: Level of log record (indicating its severity)
148 * @file: File name of file where log record was generated
149 * @line: Line number in file where log record was generated
150 * @func: Function where log record was generated
151 * @addr: Starting address to display at start of line
152 * @data: pointer to data buffer
153 * @width: data value width. May be 1, 2, or 4.
154 * @count: number of values to display
155 * @linelen: Number of values to print per line; specify 0 for default length
156 */
157int _log_buffer(enum log_category_t cat, enum log_level_t level,
158 const char *file, int line, const char *func, ulong addr,
159 const void *data, uint width, uint count, uint linelen);
160
Simon Glasse9c8d492017-12-04 13:48:24 -0700161/* Define this at the top of a file to add a prefix to debug messages */
162#ifndef pr_fmt
163#define pr_fmt(fmt) fmt
164#endif
165
166/* Use a default category if this file does not supply one */
167#ifndef LOG_CATEGORY
168#define LOG_CATEGORY LOGC_NONE
169#endif
170
171/*
172 * This header may be including when CONFIG_LOG is disabled, in which case
173 * CONFIG_LOG_MAX_LEVEL is not defined. Add a check for this.
174 */
175#if CONFIG_IS_ENABLED(LOG)
176#define _LOG_MAX_LEVEL CONFIG_VAL(LOG_MAX_LEVEL)
Simon Glasse1cbd912021-05-08 13:46:54 -0600177#else
178#define _LOG_MAX_LEVEL LOGL_INFO
179#endif
180
Heinrich Schuchardt24967962021-01-04 08:02:54 +0100181#define log_emer(_fmt...) log(LOG_CATEGORY, LOGL_EMERG, ##_fmt)
182#define log_alert(_fmt...) log(LOG_CATEGORY, LOGL_ALERT, ##_fmt)
183#define log_crit(_fmt...) log(LOG_CATEGORY, LOGL_CRIT, ##_fmt)
Simon Glasscdd140a2018-10-01 11:55:06 -0600184#define log_err(_fmt...) log(LOG_CATEGORY, LOGL_ERR, ##_fmt)
185#define log_warning(_fmt...) log(LOG_CATEGORY, LOGL_WARNING, ##_fmt)
186#define log_notice(_fmt...) log(LOG_CATEGORY, LOGL_NOTICE, ##_fmt)
187#define log_info(_fmt...) log(LOG_CATEGORY, LOGL_INFO, ##_fmt)
188#define log_debug(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG, ##_fmt)
189#define log_content(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG_CONTENT, ##_fmt)
190#define log_io(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG_IO, ##_fmt)
Heinrich Schuchardt24967962021-01-04 08:02:54 +0100191#define log_cont(_fmt...) log(LOGC_CONT, LOGL_CONT, ##_fmt)
Simon Glasse9c8d492017-12-04 13:48:24 -0700192
Simon Glassf9811e82019-02-16 20:24:37 -0700193#ifdef LOG_DEBUG
Simon Glass52d3df72020-09-12 11:13:34 -0600194#define _LOG_DEBUG LOGL_FORCE_DEBUG
Simon Glassf9811e82019-02-16 20:24:37 -0700195#else
196#define _LOG_DEBUG 0
197#endif
Simon Glass4d8d3052018-11-15 18:43:49 -0700198
Simon Glasse1cbd912021-05-08 13:46:54 -0600199#if CONFIG_IS_ENABLED(LOG)
200
Simon Glasse9c8d492017-12-04 13:48:24 -0700201/* Emit a log record if the level is less that the maximum */
202#define log(_cat, _level, _fmt, _args...) ({ \
203 int _l = _level; \
Simon Glasse1cbd912021-05-08 13:46:54 -0600204 if (_LOG_DEBUG != 0 || _l <= _LOG_MAX_LEVEL) \
Simon Glass52d3df72020-09-12 11:13:34 -0600205 _log((enum log_category_t)(_cat), \
206 (enum log_level_t)(_l | _LOG_DEBUG), __FILE__, \
207 __LINE__, __func__, \
Simon Glasse9c8d492017-12-04 13:48:24 -0700208 pr_fmt(_fmt), ##_args); \
209 })
Simon Glass58b4b712021-05-08 07:00:06 -0600210
211/* Emit a dump if the level is less that the maximum */
212#define log_buffer(_cat, _level, _addr, _data, _width, _count, _linelen) ({ \
213 int _l = _level; \
214 if (_LOG_DEBUG != 0 || _l <= _LOG_MAX_LEVEL) \
215 _log_buffer((enum log_category_t)(_cat), \
216 (enum log_level_t)(_l | _LOG_DEBUG), __FILE__, \
217 __LINE__, __func__, _addr, _data, \
218 _width, _count, _linelen); \
219 })
Simon Glass4d8d3052018-11-15 18:43:49 -0700220#else
Simon Glasse1cbd912021-05-08 13:46:54 -0600221
222/* Note: _LOG_DEBUG != 0 avoids a warning with clang */
223#define log(_cat, _level, _fmt, _args...) ({ \
224 int _l = _level; \
225 if (_LOG_DEBUG != 0 || _l <= LOGL_INFO || \
226 (_DEBUG && _l == LOGL_DEBUG)) \
227 printf(_fmt, ##_args); \
228 })
Simon Glass58b4b712021-05-08 07:00:06 -0600229
230#define log_buffer(_cat, _level, _addr, _data, _width, _count, _linelen) ({ \
231 int _l = _level; \
232 if (_LOG_DEBUG != 0 || _l <= LOGL_INFO || \
233 (_DEBUG && _l == LOGL_DEBUG)) \
234 print_buffer(_addr, _data, _width, _count, _linelen); \
235 })
Simon Glass4d8d3052018-11-15 18:43:49 -0700236#endif
Simon Glasse9c8d492017-12-04 13:48:24 -0700237
Simon Glassfd429482019-09-25 08:56:23 -0600238#define log_nop(_cat, _level, _fmt, _args...) ({ \
239 int _l = _level; \
240 _log_nop((enum log_category_t)(_cat), _l, __FILE__, __LINE__, \
241 __func__, pr_fmt(_fmt), ##_args); \
242})
243
Simon Glass0e98b0a2017-12-04 13:48:20 -0700244#ifdef DEBUG
245#define _DEBUG 1
246#else
247#define _DEBUG 0
248#endif
249
250#ifdef CONFIG_SPL_BUILD
251#define _SPL_BUILD 1
252#else
253#define _SPL_BUILD 0
254#endif
255
Simon Glass4ce5b812021-03-26 16:17:28 +1300256#if CONFIG_IS_ENABLED(LOG)
Simon Glasse9c8d492017-12-04 13:48:24 -0700257
Simon Glass4ce5b812021-03-26 16:17:28 +1300258#define debug_cond(cond, fmt, args...) \
259({ \
260 if (cond) \
261 log(LOG_CATEGORY, \
262 (enum log_level_t)(LOGL_FORCE_DEBUG | _LOG_DEBUG), \
263 fmt, ##args); \
Heinrich Schuchardt51763652021-01-04 08:02:53 +0100264})
Simon Glasse9c8d492017-12-04 13:48:24 -0700265
266#else /* _DEBUG */
267
Simon Glass0e98b0a2017-12-04 13:48:20 -0700268/*
269 * Output a debug text when condition "cond" is met. The "cond" should be
270 * computed by a preprocessor in the best case, allowing for the best
271 * optimization.
272 */
Heinrich Schuchardt51763652021-01-04 08:02:53 +0100273#define debug_cond(cond, fmt, args...) \
274({ \
275 if (cond) \
276 printf(pr_fmt(fmt), ##args); \
277})
Simon Glass0e98b0a2017-12-04 13:48:20 -0700278
Simon Glasse9c8d492017-12-04 13:48:24 -0700279#endif /* _DEBUG */
280
Simon Glass0e98b0a2017-12-04 13:48:20 -0700281/* Show a message if DEBUG is defined in a file */
282#define debug(fmt, args...) \
283 debug_cond(_DEBUG, fmt, ##args)
284
285/* Show a message if not in SPL */
286#define warn_non_spl(fmt, args...) \
287 debug_cond(!_SPL_BUILD, fmt, ##args)
288
289/*
290 * An assertion is run-time check done in debug mode only. If DEBUG is not
291 * defined then it is skipped. If DEBUG is defined and the assertion fails,
292 * then it calls panic*( which may or may not reset/halt U-Boot (see
293 * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
294 * before release, and after release it is hoped that they don't matter. But
295 * in any case these failing assertions cannot be fixed with a reset (which
296 * may just do the same assertion again).
297 */
298void __assert_fail(const char *assertion, const char *file, unsigned int line,
299 const char *function);
Heinrich Schuchardtb236f8c2019-07-27 20:21:06 +0200300
301/**
302 * assert() - assert expression is true
303 *
304 * If the expression x evaluates to false and _DEBUG evaluates to true, a panic
305 * message is written and the system stalls. The value of _DEBUG is set to true
306 * if DEBUG is defined before including common.h.
307 *
308 * The expression x is always executed irrespective of the value of _DEBUG.
309 *
310 * @x: expression to test
311 */
Simon Glass0e98b0a2017-12-04 13:48:20 -0700312#define assert(x) \
313 ({ if (!(x) && _DEBUG) \
314 __assert_fail(#x, __FILE__, __LINE__, __func__); })
315
Simon Glasscd01d2d2019-12-29 21:19:10 -0700316/*
317 * This one actually gets compiled in even without DEBUG. It doesn't include the
318 * full pathname as it may be huge. Only use this when the user should be
319 * warning, similar to BUG_ON() in linux.
320 *
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400321 * Return: true if assertion succeeded (condition is true), else false
Simon Glasscd01d2d2019-12-29 21:19:10 -0700322 */
323#define assert_noisy(x) \
324 ({ bool _val = (x); \
325 if (!_val) \
326 __assert_fail(#x, "?", __LINE__, __func__); \
327 _val; \
328 })
329
Simon Glass4d8d3052018-11-15 18:43:49 -0700330#if CONFIG_IS_ENABLED(LOG) && defined(CONFIG_LOG_ERROR_RETURN)
331/*
332 * Log an error return value, possibly with a message. Usage:
333 *
334 * return log_ret(fred_call());
335 *
336 * or:
337 *
338 * return log_msg_ret("fred failed", fred_call());
339 */
Simon Glass3707c6e2017-12-28 13:14:23 -0700340#define log_ret(_ret) ({ \
341 int __ret = (_ret); \
342 if (__ret < 0) \
343 log(LOG_CATEGORY, LOGL_ERR, "returning err=%d\n", __ret); \
344 __ret; \
345 })
Simon Glassb616cef2018-06-11 13:07:14 -0600346#define log_msg_ret(_msg, _ret) ({ \
347 int __ret = (_ret); \
348 if (__ret < 0) \
349 log(LOG_CATEGORY, LOGL_ERR, "%s: returning err=%d\n", _msg, \
350 __ret); \
351 __ret; \
352 })
Simon Glass7bd06582021-01-20 20:10:54 -0700353
354/*
355 * Similar to the above, but any non-zero value is consider an error, not just
356 * values less than 0.
357 */
358#define log_retz(_ret) ({ \
359 int __ret = (_ret); \
360 if (__ret) \
361 log(LOG_CATEGORY, LOGL_ERR, "returning err=%d\n", __ret); \
362 __ret; \
363 })
364#define log_msg_retz(_msg, _ret) ({ \
365 int __ret = (_ret); \
366 if (__ret) \
367 log(LOG_CATEGORY, LOGL_ERR, "%s: returning err=%d\n", _msg, \
368 __ret); \
369 __ret; \
370 })
Simon Glass3707c6e2017-12-28 13:14:23 -0700371#else
Simon Glass4d8d3052018-11-15 18:43:49 -0700372/* Non-logging versions of the above which just return the error code */
Simon Glass3707c6e2017-12-28 13:14:23 -0700373#define log_ret(_ret) (_ret)
Simon Glass4d8d3052018-11-15 18:43:49 -0700374#define log_msg_ret(_msg, _ret) ((void)(_msg), _ret)
Simon Glass7bd06582021-01-20 20:10:54 -0700375#define log_retz(_ret) (_ret)
376#define log_msg_retz(_msg, _ret) ((void)(_msg), _ret)
Simon Glass3707c6e2017-12-28 13:14:23 -0700377#endif
378
Simon Glass79d59832021-01-20 20:10:52 -0700379/** * enum log_rec_flags - Flags for a log record */
380enum log_rec_flags {
381 /** @LOGRECF_FORCE_DEBUG: Force output of debug record */
382 LOGRECF_FORCE_DEBUG = BIT(0),
Simon Glass9ad7a6c2021-01-20 20:10:53 -0700383 /** @LOGRECF_CONT: Continuation of previous log record */
384 LOGRECF_CONT = BIT(1),
Simon Glass79d59832021-01-20 20:10:52 -0700385};
386
Simon Glasse9c8d492017-12-04 13:48:24 -0700387/**
388 * struct log_rec - a single log record
389 *
390 * Holds information about a single record in the log
391 *
392 * Members marked as 'not allocated' are stored as pointers and the caller is
393 * responsible for making sure that the data pointed to is not overwritten.
Heinrich Schuchardt9e925d02020-11-30 09:04:48 +0100394 * Members marked as 'allocated' are allocated (e.g. via strdup()) by the log
Simon Glasse9c8d492017-12-04 13:48:24 -0700395 * system.
396 *
Simon Glass52d3df72020-09-12 11:13:34 -0600397 * TODO(sjg@chromium.org): Compress this struct down a bit to reduce space, e.g.
398 * a single u32 for cat, level, line and force_debug
399 *
Simon Glasse9c8d492017-12-04 13:48:24 -0700400 * @cat: Category, representing a uclass or part of U-Boot
401 * @level: Severity level, less severe is higher
Simon Glasse9c8d492017-12-04 13:48:24 -0700402 * @line: Line number where the log record was generated
Simon Glass79d59832021-01-20 20:10:52 -0700403 * @flags: Flags for log record (enum log_rec_flags)
404 * @file: Name of file where the log record was generated (not allocated)
Simon Glasse9c8d492017-12-04 13:48:24 -0700405 * @func: Function where the log record was generated (not allocated)
406 * @msg: Log message (allocated)
407 */
408struct log_rec {
409 enum log_category_t cat;
410 enum log_level_t level;
Simon Glass79d59832021-01-20 20:10:52 -0700411 u16 line;
412 u8 flags;
Simon Glasse9c8d492017-12-04 13:48:24 -0700413 const char *file;
Simon Glasse9c8d492017-12-04 13:48:24 -0700414 const char *func;
415 const char *msg;
416};
417
418struct log_device;
419
Simon Glassb4520302020-09-12 12:28:47 -0600420enum log_device_flags {
421 LOGDF_ENABLE = BIT(0), /* Device is enabled */
422};
423
Simon Glasse9c8d492017-12-04 13:48:24 -0700424/**
425 * struct log_driver - a driver which accepts and processes log records
426 *
427 * @name: Name of driver
Simon Glassb4520302020-09-12 12:28:47 -0600428 * @emit: Method to call to emit a log record via this device
429 * @flags: Initial value for flags (use LOGDF_ENABLE to enable on start-up)
Simon Glasse9c8d492017-12-04 13:48:24 -0700430 */
431struct log_driver {
432 const char *name;
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400433
Simon Glasse9c8d492017-12-04 13:48:24 -0700434 /**
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400435 * @emit: emit a log record
Simon Glasse9c8d492017-12-04 13:48:24 -0700436 *
437 * Called by the log system to pass a log record to a particular driver
438 * for processing. The filter is checked before calling this function.
439 */
440 int (*emit)(struct log_device *ldev, struct log_rec *rec);
Simon Glassb4520302020-09-12 12:28:47 -0600441 unsigned short flags;
Simon Glasse9c8d492017-12-04 13:48:24 -0700442};
443
444/**
445 * struct log_device - an instance of a log driver
446 *
447 * Since drivers are set up at build-time we need to have a separate device for
448 * the run-time aspects of drivers (currently just a list of filters to apply
449 * to records send to this device).
450 *
Heinrich Schuchardt9e925d02020-11-30 09:04:48 +0100451 * @next_filter_num: Sequence number of next filter filter added (0=no filters
Simon Glasse9c8d492017-12-04 13:48:24 -0700452 * yet). This increments with each new filter on the device, but never
453 * decrements
Simon Glassb4520302020-09-12 12:28:47 -0600454 * @flags: Flags for this filter (enum log_device_flags)
Simon Glasse9c8d492017-12-04 13:48:24 -0700455 * @drv: Pointer to driver for this device
456 * @filter_head: List of filters for this device
457 * @sibling_node: Next device in the list of all devices
458 */
459struct log_device {
Simon Glassb4520302020-09-12 12:28:47 -0600460 unsigned short next_filter_num;
461 unsigned short flags;
Simon Glasse9c8d492017-12-04 13:48:24 -0700462 struct log_driver *drv;
463 struct list_head filter_head;
464 struct list_head sibling_node;
465};
466
467enum {
468 LOGF_MAX_CATEGORIES = 5, /* maximum categories per filter */
469};
470
Sean Andersonfe3b1a22020-10-27 19:55:26 -0400471/**
472 * enum log_filter_flags - Flags which modify a filter
473 */
Simon Glasse9c8d492017-12-04 13:48:24 -0700474enum log_filter_flags {
Sean Andersonfe3b1a22020-10-27 19:55:26 -0400475 /** @LOGFF_HAS_CAT: Filter has a category list */
476 LOGFF_HAS_CAT = 1 << 0,
477 /** @LOGFF_DENY: Filter denies matching messages */
478 LOGFF_DENY = 1 << 1,
Sean Anderson40455a62020-10-27 19:55:30 -0400479 /** @LOGFF_LEVEL_MIN: Filter's level is a minimum, not a maximum */
480 LOGFF_LEVEL_MIN = 1 << 2,
Simon Glasse9c8d492017-12-04 13:48:24 -0700481};
482
483/**
Heinrich Schuchardt9e925d02020-11-30 09:04:48 +0100484 * struct log_filter - criteria to filter out log messages
Simon Glasse9c8d492017-12-04 13:48:24 -0700485 *
Sean Andersonfe3b1a22020-10-27 19:55:26 -0400486 * If a message matches all criteria, then it is allowed. If LOGFF_DENY is set,
487 * then it is denied instead.
488 *
Simon Glasse9c8d492017-12-04 13:48:24 -0700489 * @filter_num: Sequence number of this filter. This is returned when adding a
490 * new filter, and must be provided when removing a previously added
491 * filter.
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400492 * @flags: Flags for this filter (``LOGFF_...``)
Sean Andersonb66a9242020-10-27 19:55:21 -0400493 * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400494 * then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
Simon Glasse9c8d492017-12-04 13:48:24 -0700495 * can be provided
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400496 * @level: Maximum (or minimum, if %LOGFF_MIN_LEVEL) log level to allow
Simon Glasse9c8d492017-12-04 13:48:24 -0700497 * @file_list: List of files to allow, separated by comma. If NULL then all
498 * files are permitted
499 * @sibling_node: Next filter in the list of filters for this log device
500 */
501struct log_filter {
502 int filter_num;
503 int flags;
504 enum log_category_t cat_list[LOGF_MAX_CATEGORIES];
Sean Anderson40455a62020-10-27 19:55:30 -0400505 enum log_level_t level;
Simon Glasse9c8d492017-12-04 13:48:24 -0700506 const char *file_list;
507 struct list_head sibling_node;
508};
509
510#define LOG_DRIVER(_name) \
511 ll_entry_declare(struct log_driver, _name, log_driver)
512
Simon Glass3d03ab62020-09-12 12:28:49 -0600513/* Get a pointer to a given driver */
514#define LOG_GET_DRIVER(__name) \
515 ll_entry_get(struct log_driver, __name, log_driver)
516
Simon Glassf941c8d2017-12-28 13:14:16 -0700517/**
518 * log_get_cat_name() - Get the name of a category
519 *
520 * @cat: Category to look up
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400521 * Return: category name (which may be a uclass driver name) if found, or
Sean Anderson1c593a12020-10-27 19:55:34 -0400522 * "<invalid>" if invalid, or "<missing>" if not found. All error
523 * responses begin with '<'.
Simon Glassf941c8d2017-12-28 13:14:16 -0700524 */
525const char *log_get_cat_name(enum log_category_t cat);
526
527/**
528 * log_get_cat_by_name() - Look up a category by name
529 *
530 * @name: Name to look up
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400531 * Return: Category, or %LOGC_NONE if not found
Simon Glassf941c8d2017-12-28 13:14:16 -0700532 */
533enum log_category_t log_get_cat_by_name(const char *name);
534
535/**
536 * log_get_level_name() - Get the name of a log level
537 *
538 * @level: Log level to look up
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400539 * Return: Log level name (in ALL CAPS)
Simon Glassf941c8d2017-12-28 13:14:16 -0700540 */
541const char *log_get_level_name(enum log_level_t level);
542
543/**
544 * log_get_level_by_name() - Look up a log level by name
545 *
546 * @name: Name to look up
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400547 * Return: Log level, or %LOGL_NONE if not found
Simon Glassf941c8d2017-12-28 13:14:16 -0700548 */
549enum log_level_t log_get_level_by_name(const char *name);
550
Sean Anderson3102c1d2020-10-27 19:55:24 -0400551/**
552 * log_device_find_by_name() - Look up a log device by its driver's name
553 *
554 * @drv_name: Name of the driver
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400555 * Return: the log device, or %NULL if not found
Sean Anderson3102c1d2020-10-27 19:55:24 -0400556 */
557struct log_device *log_device_find_by_name(const char *drv_name);
558
559/**
560 * log_has_cat() - check if a log category exists within a list
561 *
562 * @cat_list: List of categories to check, at most %LOGF_MAX_CATEGORIES entries
563 * long, terminated by %LC_END if fewer
564 * @cat: Category to search for
565 *
566 * Return: ``true`` if @cat is in @cat_list, else ``false``
567 */
568bool log_has_cat(enum log_category_t cat_list[], enum log_category_t cat);
569
570/**
571 * log_has_file() - check if a file is with a list
572 *
573 * @file_list: List of files to check, separated by comma
574 * @file: File to check for. This string is matched against the end of each
575 * file in the list, i.e. ignoring any preceding path. The list is
576 * intended to consist of relative pathnames, e.g. common/main.c,cmd/log.c
577 *
578 * Return: ``true`` if @file is in @file_list, else ``false``
579 */
580bool log_has_file(const char *file_list, const char *file);
581
Simon Glass3b73e8d2017-12-28 13:14:17 -0700582/* Log format flags (bit numbers) for gd->log_fmt. See log_fmt_chars */
583enum log_fmt {
584 LOGF_CAT = 0,
585 LOGF_LEVEL,
586 LOGF_FILE,
587 LOGF_LINE,
588 LOGF_FUNC,
589 LOGF_MSG,
590
591 LOGF_COUNT,
Simon Glass3b73e8d2017-12-28 13:14:17 -0700592 LOGF_ALL = 0x3f,
593};
594
Simon Glassef11ed82017-12-04 13:48:27 -0700595/* Handle the 'log test' command */
Simon Glass09140112020-05-10 11:40:03 -0600596int do_log_test(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
Simon Glassef11ed82017-12-04 13:48:27 -0700597
Simon Glasse9c8d492017-12-04 13:48:24 -0700598/**
Sean Andersona02f84e2020-10-27 19:55:25 -0400599 * log_add_filter_flags() - Add a new filter to a log device, specifying flags
600 *
601 * @drv_name: Driver name to add the filter to (since each driver only has a
602 * single device)
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400603 * @flags: Flags for this filter (``LOGFF_...``)
Sean Andersona02f84e2020-10-27 19:55:25 -0400604 * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400605 * then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
Sean Andersona02f84e2020-10-27 19:55:25 -0400606 * can be provided
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400607 * @level: Maximum (or minimum, if %LOGFF_LEVEL_MIN) log level to allow
Sean Andersona02f84e2020-10-27 19:55:25 -0400608 * @file_list: List of files to allow, separated by comma. If NULL then all
609 * files are permitted
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400610 * Return:
611 * the sequence number of the new filter (>=0) if the filter was added, or a
612 * -ve value on error
Sean Andersona02f84e2020-10-27 19:55:25 -0400613 */
614int log_add_filter_flags(const char *drv_name, enum log_category_t cat_list[],
Sean Anderson40455a62020-10-27 19:55:30 -0400615 enum log_level_t level, const char *file_list,
Sean Andersona02f84e2020-10-27 19:55:25 -0400616 int flags);
617
618/**
Simon Glasse9c8d492017-12-04 13:48:24 -0700619 * log_add_filter() - Add a new filter to a log device
620 *
621 * @drv_name: Driver name to add the filter to (since each driver only has a
622 * single device)
Sean Andersonb66a9242020-10-27 19:55:21 -0400623 * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400624 * then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
Simon Glasse9c8d492017-12-04 13:48:24 -0700625 * can be provided
626 * @max_level: Maximum log level to allow
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400627 * @file_list: List of files to allow, separated by comma. If %NULL then all
Simon Glasse9c8d492017-12-04 13:48:24 -0700628 * files are permitted
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400629 * Return:
630 * the sequence number of the new filter (>=0) if the filter was added, or a
631 * -ve value on error
Simon Glasse9c8d492017-12-04 13:48:24 -0700632 */
Sean Andersona02f84e2020-10-27 19:55:25 -0400633static inline int log_add_filter(const char *drv_name,
634 enum log_category_t cat_list[],
635 enum log_level_t max_level,
636 const char *file_list)
637{
638 return log_add_filter_flags(drv_name, cat_list, max_level, file_list,
639 0);
640}
Simon Glasse9c8d492017-12-04 13:48:24 -0700641
642/**
643 * log_remove_filter() - Remove a filter from a log device
644 *
645 * @drv_name: Driver name to remove the filter from (since each driver only has
646 * a single device)
647 * @filter_num: Filter number to remove (as returned by log_add_filter())
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400648 * Return:
649 * 0 if the filter was removed, -%ENOENT if either the driver or the filter
650 * number was not found
Simon Glasse9c8d492017-12-04 13:48:24 -0700651 */
652int log_remove_filter(const char *drv_name, int filter_num);
653
Simon Glass3d03ab62020-09-12 12:28:49 -0600654/**
655 * log_device_set_enable() - Enable or disable a log device
656 *
657 * Devices are referenced by their driver, so use LOG_GET_DRIVER(name) to pass
658 * the driver to this function. For example if the driver is declared with
659 * LOG_DRIVER(wibble) then pass LOG_GET_DRIVER(wibble) here.
660 *
661 * @drv: Driver of device to enable
662 * @enable: true to enable, false to disable
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100663 * Return: 0 if OK, -ENOENT if the driver was not found
Simon Glass3d03ab62020-09-12 12:28:49 -0600664 */
665int log_device_set_enable(struct log_driver *drv, bool enable);
666
Simon Glasse9c8d492017-12-04 13:48:24 -0700667#if CONFIG_IS_ENABLED(LOG)
668/**
669 * log_init() - Set up the log system ready for use
670 *
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400671 * Return: 0 if OK, -%ENOMEM if out of memory
Simon Glasse9c8d492017-12-04 13:48:24 -0700672 */
673int log_init(void);
674#else
675static inline int log_init(void)
676{
677 return 0;
678}
679#endif
680
Heinrich Schuchardt3c21d772020-06-17 21:52:44 +0200681/**
682 * log_get_default_format() - get default log format
683 *
684 * The default log format is configurable via
Sean Anderson00ebb7f2020-10-27 19:55:40 -0400685 * %CONFIG_LOGF_FILE, %CONFIG_LOGF_LINE, and %CONFIG_LOGF_FUNC.
Heinrich Schuchardt3c21d772020-06-17 21:52:44 +0200686 *
687 * Return: default log format
688 */
689static inline int log_get_default_format(void)
690{
691 return BIT(LOGF_MSG) |
692 (IS_ENABLED(CONFIG_LOGF_FILE) ? BIT(LOGF_FILE) : 0) |
693 (IS_ENABLED(CONFIG_LOGF_LINE) ? BIT(LOGF_LINE) : 0) |
694 (IS_ENABLED(CONFIG_LOGF_FUNC) ? BIT(LOGF_FUNC) : 0);
695}
696
Simon Glass0e98b0a2017-12-04 13:48:20 -0700697#endif