1 /* SPDX-License-Identifier: GPL-2.0+ */
5 * Copyright (c) 2017 Google, Inc
6 * Written by Simon Glass <sjg@chromium.org>
13 #include <linker_lists.h>
14 #include <dm/uclass-id.h>
15 #include <linux/bitops.h>
16 #include <linux/list.h>
21 * enum log_level_t - Log levels supported, ranging from most to least important
24 /** @LOGL_EMERG: U-Boot is unstable */
26 /** @LOGL_ALERT: Action must be taken immediately */
28 /** @LOGL_CRIT: Critical conditions */
30 /** @LOGL_ERR: Error that prevents something from working */
32 /** @LOGL_WARNING: Warning may prevent optimal operation */
34 /** @LOGL_NOTICE: Normal but significant condition, printf() */
36 /** @LOGL_INFO: General information message */
38 /** @LOGL_DEBUG: Basic debug-level message */
40 /** @LOGL_DEBUG_CONTENT: Debug message showing full message content */
42 /** @LOGL_DEBUG_IO: Debug message showing hardware I/O access */
45 /** @LOGL_COUNT: Total number of valid log levels */
47 /** @LOGL_NONE: Used to indicate that there is no valid log level */
50 /** @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,
55 /** @LOGL_FIRST: The first, most-important log level */
56 LOGL_FIRST = LOGL_EMERG,
57 /** @LOGL_MAX: The last, least-important log level */
58 LOGL_MAX = LOGL_DEBUG_IO,
59 /** @LOGL_CONT: Use same log level as in previous call */
64 * enum log_category_t - Log categories supported.
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.
69 * Remember to update log_cat_name[] after adding a new category.
72 /** @LOGC_FIRST: First log category */
73 LOGC_FIRST = 0, /* First part mirrors UCLASS_... */
75 /** @LOGC_NONE: Default log category */
76 LOGC_NONE = UCLASS_COUNT, /* First number is after all uclasses */
77 /** @LOGC_ARCH: Related to arch-specific code */
79 /** @LOGC_BOARD: Related to board-specific code */
81 /** @LOGC_CORE: Related to core features (non-driver-model) */
83 /** @LOGC_DM: Core driver-model */
85 /** @LOGC_DT: Device-tree */
87 /** @LOGC_EFI: EFI implementation */
89 /** @LOGC_ALLOC: Memory allocation */
91 /** @LOGC_SANDBOX: Related to the sandbox board */
93 /** @LOGC_BLOBLIST: Bloblist */
95 /** @LOGC_DEVRES: Device resources (``devres_...`` functions) */
97 /** @LOGC_ACPI: Advanced Configuration and Power Interface (ACPI) */
99 /** @LOGC_BOOT: Related to boot process / boot image processing */
101 /** @LOGC_EVENT: Related to event and event handling */
103 /** @LOGC_COUNT: Number of log categories */
105 /** @LOGC_END: Sentinel value for lists of log categories */
107 /** @LOGC_CONT: Use same category as in previous call */
111 /* Helper to cast a uclass ID to a log category */
112 static inline int log_uc_cat(enum uclass_id id)
114 return (enum log_category_t)id;
118 * _log() - Internal function to emit a new log record
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
127 * Return: 0 if log record was emitted, -ve on error
129 int _log(enum log_category_t cat, enum log_level_t level, const char *file,
130 int line, const char *func, const char *fmt, ...)
131 __attribute__ ((format (__printf__, 6, 7)));
134 * _log_buffer - Internal function to print data buffer in hex and ascii form
136 * @cat: Category of log record (indicating which subsystem generated it)
137 * @level: Level of log record (indicating its severity)
138 * @file: File name of file where log record was generated
139 * @line: Line number in file where log record was generated
140 * @func: Function where log record was generated
141 * @addr: Starting address to display at start of line
142 * @data: pointer to data buffer
143 * @width: data value width. May be 1, 2, or 4.
144 * @count: number of values to display
145 * @linelen: Number of values to print per line; specify 0 for default length
147 int _log_buffer(enum log_category_t cat, enum log_level_t level,
148 const char *file, int line, const char *func, ulong addr,
149 const void *data, uint width, uint count, uint linelen);
151 /* Define this at the top of a file to add a prefix to debug messages */
153 #define pr_fmt(fmt) fmt
156 /* Use a default category if this file does not supply one */
158 #define LOG_CATEGORY LOGC_NONE
162 * This header may be including when CONFIG_LOG is disabled, in which case
163 * CONFIG_LOG_MAX_LEVEL is not defined. Add a check for this.
165 #if CONFIG_IS_ENABLED(LOG)
166 #define _LOG_MAX_LEVEL CONFIG_VAL(LOG_MAX_LEVEL)
168 #define _LOG_MAX_LEVEL LOGL_INFO
171 #define log_emer(_fmt...) log(LOG_CATEGORY, LOGL_EMERG, ##_fmt)
172 #define log_alert(_fmt...) log(LOG_CATEGORY, LOGL_ALERT, ##_fmt)
173 #define log_crit(_fmt...) log(LOG_CATEGORY, LOGL_CRIT, ##_fmt)
174 #define log_err(_fmt...) log(LOG_CATEGORY, LOGL_ERR, ##_fmt)
175 #define log_warning(_fmt...) log(LOG_CATEGORY, LOGL_WARNING, ##_fmt)
176 #define log_notice(_fmt...) log(LOG_CATEGORY, LOGL_NOTICE, ##_fmt)
177 #define log_info(_fmt...) log(LOG_CATEGORY, LOGL_INFO, ##_fmt)
178 #define log_debug(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG, ##_fmt)
179 #define log_content(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG_CONTENT, ##_fmt)
180 #define log_io(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG_IO, ##_fmt)
181 #define log_cont(_fmt...) log(LOGC_CONT, LOGL_CONT, ##_fmt)
184 #define _LOG_DEBUG LOGL_FORCE_DEBUG
192 #if CONFIG_IS_ENABLED(LOG)
194 /* Emit a log record if the level is less that the maximum */
195 #define log(_cat, _level, _fmt, _args...) ({ \
197 if (_LOG_DEBUG != 0 || _l <= _LOG_MAX_LEVEL) \
198 _log((enum log_category_t)(_cat), \
199 (enum log_level_t)(_l | _LOG_DEBUG), __FILE__, \
200 __LINE__, __func__, \
201 pr_fmt(_fmt), ##_args); \
204 /* Emit a dump if the level is less that the maximum */
205 #define log_buffer(_cat, _level, _addr, _data, _width, _count, _linelen) ({ \
207 if (_LOG_DEBUG != 0 || _l <= _LOG_MAX_LEVEL) \
208 _log_buffer((enum log_category_t)(_cat), \
209 (enum log_level_t)(_l | _LOG_DEBUG), __FILE__, \
210 __LINE__, __func__, _addr, _data, \
211 _width, _count, _linelen); \
215 /* Note: _LOG_DEBUG != 0 avoids a warning with clang */
216 #define log(_cat, _level, _fmt, _args...) ({ \
218 if (_LOG_DEBUG != 0 || _l <= LOGL_INFO || \
219 (_DEBUG && _l == LOGL_DEBUG)) \
220 printf(_fmt, ##_args); \
223 #define log_buffer(_cat, _level, _addr, _data, _width, _count, _linelen) ({ \
225 if (_LOG_DEBUG != 0 || _l <= LOGL_INFO || \
226 (_DEBUG && _l == LOGL_DEBUG)) \
227 print_buffer(_addr, _data, _width, _count, _linelen); \
237 #ifdef CONFIG_SPL_BUILD
243 #if CONFIG_IS_ENABLED(LOG)
245 #define debug_cond(cond, fmt, args...) \
249 (enum log_level_t)(LOGL_FORCE_DEBUG | _LOG_DEBUG), \
256 * Output a debug text when condition "cond" is met. The "cond" should be
257 * computed by a preprocessor in the best case, allowing for the best
260 #define debug_cond(cond, fmt, args...) \
263 printf(pr_fmt(fmt), ##args); \
268 /* Show a message if DEBUG is defined in a file */
269 #define debug(fmt, args...) \
270 debug_cond(_DEBUG, fmt, ##args)
272 /* Show a message if not in SPL */
273 #define warn_non_spl(fmt, args...) \
274 debug_cond(!_SPL_BUILD, fmt, ##args)
277 * An assertion is run-time check done in debug mode only. If DEBUG is not
278 * defined then it is skipped. If DEBUG is defined and the assertion fails,
279 * then it calls panic*( which may or may not reset/halt U-Boot (see
280 * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
281 * before release, and after release it is hoped that they don't matter. But
282 * in any case these failing assertions cannot be fixed with a reset (which
283 * may just do the same assertion again).
285 void __assert_fail(const char *assertion, const char *file, unsigned int line,
286 const char *function);
289 * assert() - assert expression is true
291 * If the expression x evaluates to false and _DEBUG evaluates to true, a panic
292 * message is written and the system stalls. The value of _DEBUG is set to true
293 * if DEBUG is defined before including common.h.
295 * The expression x is always executed irrespective of the value of _DEBUG.
297 * @x: expression to test
300 ({ if (!(x) && _DEBUG) \
301 __assert_fail(#x, __FILE__, __LINE__, __func__); })
304 * This one actually gets compiled in even without DEBUG. It doesn't include the
305 * full pathname as it may be huge. Only use this when the user should be
306 * warning, similar to BUG_ON() in linux.
308 * Return: true if assertion succeeded (condition is true), else false
310 #define assert_noisy(x) \
311 ({ bool _val = (x); \
313 __assert_fail(#x, "?", __LINE__, __func__); \
317 #if CONFIG_IS_ENABLED(LOG) && defined(CONFIG_LOG_ERROR_RETURN)
319 * Log an error return value, possibly with a message. Usage:
321 * return log_ret(fred_call());
325 * return log_msg_ret("fred failed", fred_call());
327 #define log_ret(_ret) ({ \
328 int __ret = (_ret); \
330 log(LOG_CATEGORY, LOGL_ERR, "returning err=%d\n", __ret); \
333 #define log_msg_ret(_msg, _ret) ({ \
334 int __ret = (_ret); \
336 log(LOG_CATEGORY, LOGL_ERR, "%s: returning err=%d\n", _msg, \
342 * Similar to the above, but any non-zero value is consider an error, not just
343 * values less than 0.
345 #define log_retz(_ret) ({ \
346 int __ret = (_ret); \
348 log(LOG_CATEGORY, LOGL_ERR, "returning err=%d\n", __ret); \
351 #define log_msg_retz(_msg, _ret) ({ \
352 int __ret = (_ret); \
354 log(LOG_CATEGORY, LOGL_ERR, "%s: returning err=%d\n", _msg, \
359 /* Non-logging versions of the above which just return the error code */
360 #define log_ret(_ret) (_ret)
361 #define log_msg_ret(_msg, _ret) ((void)(_msg), _ret)
362 #define log_retz(_ret) (_ret)
363 #define log_msg_retz(_msg, _ret) ((void)(_msg), _ret)
366 /** * enum log_rec_flags - Flags for a log record */
368 /** @LOGRECF_FORCE_DEBUG: Force output of debug record */
369 LOGRECF_FORCE_DEBUG = BIT(0),
370 /** @LOGRECF_CONT: Continuation of previous log record */
371 LOGRECF_CONT = BIT(1),
375 * struct log_rec - a single log record
377 * Holds information about a single record in the log
379 * Members marked as 'not allocated' are stored as pointers and the caller is
380 * responsible for making sure that the data pointed to is not overwritten.
381 * Members marked as 'allocated' are allocated (e.g. via strdup()) by the log
384 * TODO(sjg@chromium.org): Compress this struct down a bit to reduce space, e.g.
385 * a single u32 for cat, level, line and force_debug
387 * @cat: Category, representing a uclass or part of U-Boot
388 * @level: Severity level, less severe is higher
389 * @line: Line number where the log record was generated
390 * @flags: Flags for log record (enum log_rec_flags)
391 * @file: Name of file where the log record was generated (not allocated)
392 * @func: Function where the log record was generated (not allocated)
393 * @msg: Log message (allocated)
396 enum log_category_t cat;
397 enum log_level_t level;
407 enum log_device_flags {
408 LOGDF_ENABLE = BIT(0), /* Device is enabled */
412 * struct log_driver - a driver which accepts and processes log records
414 * @name: Name of driver
415 * @emit: Method to call to emit a log record via this device
416 * @flags: Initial value for flags (use LOGDF_ENABLE to enable on start-up)
422 * @emit: emit a log record
424 * Called by the log system to pass a log record to a particular driver
425 * for processing. The filter is checked before calling this function.
427 int (*emit)(struct log_device *ldev, struct log_rec *rec);
428 unsigned short flags;
432 * struct log_device - an instance of a log driver
434 * Since drivers are set up at build-time we need to have a separate device for
435 * the run-time aspects of drivers (currently just a list of filters to apply
436 * to records send to this device).
438 * @next_filter_num: Sequence number of next filter filter added (0=no filters
439 * yet). This increments with each new filter on the device, but never
441 * @flags: Flags for this filter (enum log_device_flags)
442 * @drv: Pointer to driver for this device
443 * @filter_head: List of filters for this device
444 * @sibling_node: Next device in the list of all devices
447 unsigned short next_filter_num;
448 unsigned short flags;
449 struct log_driver *drv;
450 struct list_head filter_head;
451 struct list_head sibling_node;
455 LOGF_MAX_CATEGORIES = 5, /* maximum categories per filter */
459 * enum log_filter_flags - Flags which modify a filter
461 enum log_filter_flags {
462 /** @LOGFF_HAS_CAT: Filter has a category list */
463 LOGFF_HAS_CAT = 1 << 0,
464 /** @LOGFF_DENY: Filter denies matching messages */
466 /** @LOGFF_LEVEL_MIN: Filter's level is a minimum, not a maximum */
467 LOGFF_LEVEL_MIN = 1 << 2,
471 * struct log_filter - criteria to filter out log messages
473 * If a message matches all criteria, then it is allowed. If LOGFF_DENY is set,
474 * then it is denied instead.
476 * @filter_num: Sequence number of this filter. This is returned when adding a
477 * new filter, and must be provided when removing a previously added
479 * @flags: Flags for this filter (``LOGFF_...``)
480 * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
481 * then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
483 * @level: Maximum (or minimum, if %LOGFF_MIN_LEVEL) log level to allow
484 * @file_list: List of files to allow, separated by comma. If NULL then all
485 * files are permitted
486 * @sibling_node: Next filter in the list of filters for this log device
491 enum log_category_t cat_list[LOGF_MAX_CATEGORIES];
492 enum log_level_t level;
493 const char *file_list;
494 struct list_head sibling_node;
497 #define LOG_DRIVER(_name) \
498 ll_entry_declare(struct log_driver, _name, log_driver)
500 /* Get a pointer to a given driver */
501 #define LOG_GET_DRIVER(__name) \
502 ll_entry_get(struct log_driver, __name, log_driver)
505 * log_get_cat_name() - Get the name of a category
507 * @cat: Category to look up
508 * Return: category name (which may be a uclass driver name) if found, or
509 * "<invalid>" if invalid, or "<missing>" if not found. All error
510 * responses begin with '<'.
512 const char *log_get_cat_name(enum log_category_t cat);
515 * log_get_cat_by_name() - Look up a category by name
517 * @name: Name to look up
518 * Return: Category, or %LOGC_NONE if not found
520 enum log_category_t log_get_cat_by_name(const char *name);
523 * log_get_level_name() - Get the name of a log level
525 * @level: Log level to look up
526 * Return: Log level name (in ALL CAPS)
528 const char *log_get_level_name(enum log_level_t level);
531 * log_get_level_by_name() - Look up a log level by name
533 * @name: Name to look up
534 * Return: Log level, or %LOGL_NONE if not found
536 enum log_level_t log_get_level_by_name(const char *name);
539 * log_device_find_by_name() - Look up a log device by its driver's name
541 * @drv_name: Name of the driver
542 * Return: the log device, or %NULL if not found
544 struct log_device *log_device_find_by_name(const char *drv_name);
547 * log_has_cat() - check if a log category exists within a list
549 * @cat_list: List of categories to check, at most %LOGF_MAX_CATEGORIES entries
550 * long, terminated by %LC_END if fewer
551 * @cat: Category to search for
553 * Return: ``true`` if @cat is in @cat_list, else ``false``
555 bool log_has_cat(enum log_category_t cat_list[], enum log_category_t cat);
558 * log_has_file() - check if a file is with a list
560 * @file_list: List of files to check, separated by comma
561 * @file: File to check for. This string is matched against the end of each
562 * file in the list, i.e. ignoring any preceding path. The list is
563 * intended to consist of relative pathnames, e.g. common/main.c,cmd/log.c
565 * Return: ``true`` if @file is in @file_list, else ``false``
567 bool log_has_file(const char *file_list, const char *file);
569 /* Log format flags (bit numbers) for gd->log_fmt. See log_fmt_chars */
582 /* Handle the 'log test' command */
583 int do_log_test(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
586 * log_add_filter_flags() - Add a new filter to a log device, specifying flags
588 * @drv_name: Driver name to add the filter to (since each driver only has a
590 * @flags: Flags for this filter (``LOGFF_...``)
591 * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
592 * then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
594 * @level: Maximum (or minimum, if %LOGFF_LEVEL_MIN) log level to allow
595 * @file_list: List of files to allow, separated by comma. If NULL then all
596 * files are permitted
598 * the sequence number of the new filter (>=0) if the filter was added, or a
601 int log_add_filter_flags(const char *drv_name, enum log_category_t cat_list[],
602 enum log_level_t level, const char *file_list,
606 * log_add_filter() - Add a new filter to a log device
608 * @drv_name: Driver name to add the filter to (since each driver only has a
610 * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
611 * then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
613 * @max_level: Maximum log level to allow
614 * @file_list: List of files to allow, separated by comma. If %NULL then all
615 * files are permitted
617 * the sequence number of the new filter (>=0) if the filter was added, or a
620 static inline int log_add_filter(const char *drv_name,
621 enum log_category_t cat_list[],
622 enum log_level_t max_level,
623 const char *file_list)
625 return log_add_filter_flags(drv_name, cat_list, max_level, file_list,
630 * log_remove_filter() - Remove a filter from a log device
632 * @drv_name: Driver name to remove the filter from (since each driver only has
634 * @filter_num: Filter number to remove (as returned by log_add_filter())
636 * 0 if the filter was removed, -%ENOENT if either the driver or the filter
637 * number was not found
639 int log_remove_filter(const char *drv_name, int filter_num);
642 * log_device_set_enable() - Enable or disable a log device
644 * Devices are referenced by their driver, so use LOG_GET_DRIVER(name) to pass
645 * the driver to this function. For example if the driver is declared with
646 * LOG_DRIVER(wibble) then pass LOG_GET_DRIVER(wibble) here.
648 * @drv: Driver of device to enable
649 * @enable: true to enable, false to disable
650 * Return: 0 if OK, -ENOENT if the driver was not found
652 int log_device_set_enable(struct log_driver *drv, bool enable);
654 #if CONFIG_IS_ENABLED(LOG)
656 * log_init() - Set up the log system ready for use
658 * Return: 0 if OK, -%ENOMEM if out of memory
662 static inline int log_init(void)
669 * log_get_default_format() - get default log format
671 * The default log format is configurable via
672 * %CONFIG_LOGF_FILE, %CONFIG_LOGF_LINE, and %CONFIG_LOGF_FUNC.
674 * Return: default log format
676 static inline int log_get_default_format(void)
678 return BIT(LOGF_MSG) |
679 (IS_ENABLED(CONFIG_LOGF_FILE) ? BIT(LOGF_FILE) : 0) |
680 (IS_ENABLED(CONFIG_LOGF_LINE) ? BIT(LOGF_LINE) : 0) |
681 (IS_ENABLED(CONFIG_LOGF_FUNC) ? BIT(LOGF_FUNC) : 0);