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>
20 /** Log levels supported, ranging from most to least important */
22 LOGL_EMERG = 0, /* U-Boot is unstable */
23 LOGL_ALERT, /* Action must be taken immediately */
24 LOGL_CRIT, /* Critical conditions */
25 LOGL_ERR, /* Error that prevents something from working */
26 LOGL_WARNING, /* Warning may prevent optimial operation */
27 LOGL_NOTICE, /* Normal but significant condition, printf() */
28 LOGL_INFO, /* General information message */
29 LOGL_DEBUG, /* Basic debug-level message */
30 LOGL_DEBUG_CONTENT, /* Debug message showing full message content */
31 LOGL_DEBUG_IO, /* Debug message showing hardware I/O access */
36 LOGL_LEVEL_MASK = 0xf, /* Mask for valid log levels */
37 LOGL_FORCE_DEBUG = 0x10, /* Mask to force output due to LOG_DEBUG */
39 LOGL_FIRST = LOGL_EMERG,
40 LOGL_MAX = LOGL_DEBUG_IO,
41 LOGL_CONT = -1, /* Use same log level as in previous call */
45 * Log categories supported. Most of these correspond to uclasses (i.e.
46 * enum uclass_id) but there are also some more generic categories.
48 * Remember to update log_cat_name[] after adding a new category.
51 LOGC_FIRST = 0, /* First part mirrors UCLASS_... */
53 LOGC_NONE = UCLASS_COUNT, /* First number is after all uclasses */
54 LOGC_ARCH, /* Related to arch-specific code */
55 LOGC_BOARD, /* Related to board-specific code */
56 LOGC_CORE, /* Related to core features (non-driver-model) */
57 LOGC_DM, /* Core driver-model */
58 LOGC_DT, /* Device-tree */
59 LOGC_EFI, /* EFI implementation */
60 LOGC_ALLOC, /* Memory allocation */
61 LOGC_SANDBOX, /* Related to the sandbox board */
62 LOGC_BLOBLIST, /* Bloblist */
63 LOGC_DEVRES, /* Device resources (devres_... functions) */
64 /* Advanced Configuration and Power Interface (ACPI) */
67 LOGC_COUNT, /* Number of log categories */
68 LOGC_END, /* Sentinel value for a list of log categories */
69 LOGC_CONT = -1, /* Use same category as in previous call */
72 /* Helper to cast a uclass ID to a log category */
73 static inline int log_uc_cat(enum uclass_id id)
75 return (enum log_category_t)id;
79 * _log() - Internal function to emit a new log record
81 * @cat: Category of log record (indicating which subsystem generated it)
82 * @level: Level of log record (indicating its severity)
83 * @file: File name of file where log record was generated
84 * @line: Line number in file where log record was generated
85 * @func: Function where log record was generated
86 * @fmt: printf() format string for log record
87 * @...: Optional parameters, according to the format string @fmt
88 * @return 0 if log record was emitted, -ve on error
90 int _log(enum log_category_t cat, enum log_level_t level, const char *file,
91 int line, const char *func, const char *fmt, ...)
92 __attribute__ ((format (__printf__, 6, 7)));
94 static inline int _log_nop(enum log_category_t cat, enum log_level_t level,
95 const char *file, int line, const char *func,
97 __attribute__ ((format (__printf__, 6, 7)));
99 static inline int _log_nop(enum log_category_t cat, enum log_level_t level,
100 const char *file, int line, const char *func,
101 const char *fmt, ...)
106 /* Define this at the top of a file to add a prefix to debug messages */
108 #define pr_fmt(fmt) fmt
111 /* Use a default category if this file does not supply one */
113 #define LOG_CATEGORY LOGC_NONE
117 * This header may be including when CONFIG_LOG is disabled, in which case
118 * CONFIG_LOG_MAX_LEVEL is not defined. Add a check for this.
120 #if CONFIG_IS_ENABLED(LOG)
121 #define _LOG_MAX_LEVEL CONFIG_VAL(LOG_MAX_LEVEL)
122 #define log_err(_fmt...) log(LOG_CATEGORY, LOGL_ERR, ##_fmt)
123 #define log_warning(_fmt...) log(LOG_CATEGORY, LOGL_WARNING, ##_fmt)
124 #define log_notice(_fmt...) log(LOG_CATEGORY, LOGL_NOTICE, ##_fmt)
125 #define log_info(_fmt...) log(LOG_CATEGORY, LOGL_INFO, ##_fmt)
126 #define log_debug(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG, ##_fmt)
127 #define log_content(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG_CONTENT, ##_fmt)
128 #define log_io(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG_IO, ##_fmt)
130 #define _LOG_MAX_LEVEL LOGL_INFO
131 #define log_err(_fmt, ...) printf(_fmt, ##__VA_ARGS__)
132 #define log_warning(_fmt, ...) printf(_fmt, ##__VA_ARGS__)
133 #define log_notice(_fmt, ...) printf(_fmt, ##__VA_ARGS__)
134 #define log_info(_fmt, ...) printf(_fmt, ##__VA_ARGS__)
135 #define log_debug(_fmt, ...) debug(_fmt, ##__VA_ARGS__)
136 #define log_content(_fmt...) log_nop(LOG_CATEGORY, \
137 LOGL_DEBUG_CONTENT, ##_fmt)
138 #define log_io(_fmt...) log_nop(LOG_CATEGORY, LOGL_DEBUG_IO, ##_fmt)
141 #if CONFIG_IS_ENABLED(LOG)
143 #define _LOG_DEBUG LOGL_FORCE_DEBUG
148 /* Emit a log record if the level is less that the maximum */
149 #define log(_cat, _level, _fmt, _args...) ({ \
151 if (CONFIG_IS_ENABLED(LOG) && \
152 (_LOG_DEBUG != 0 || _l <= _LOG_MAX_LEVEL)) \
153 _log((enum log_category_t)(_cat), \
154 (enum log_level_t)(_l | _LOG_DEBUG), __FILE__, \
155 __LINE__, __func__, \
156 pr_fmt(_fmt), ##_args); \
159 #define log(_cat, _level, _fmt, _args...)
162 #define log_nop(_cat, _level, _fmt, _args...) ({ \
164 _log_nop((enum log_category_t)(_cat), _l, __FILE__, __LINE__, \
165 __func__, pr_fmt(_fmt), ##_args); \
174 #ifdef CONFIG_SPL_BUILD
180 #if !_DEBUG && CONFIG_IS_ENABLED(LOG)
182 #define debug_cond(cond, fmt, args...) \
185 log(LOG_CATEGORY, LOGL_DEBUG, fmt, ##args); \
191 * Output a debug text when condition "cond" is met. The "cond" should be
192 * computed by a preprocessor in the best case, allowing for the best
195 #define debug_cond(cond, fmt, args...) \
198 printf(pr_fmt(fmt), ##args); \
203 /* Show a message if DEBUG is defined in a file */
204 #define debug(fmt, args...) \
205 debug_cond(_DEBUG, fmt, ##args)
207 /* Show a message if not in SPL */
208 #define warn_non_spl(fmt, args...) \
209 debug_cond(!_SPL_BUILD, fmt, ##args)
212 * An assertion is run-time check done in debug mode only. If DEBUG is not
213 * defined then it is skipped. If DEBUG is defined and the assertion fails,
214 * then it calls panic*( which may or may not reset/halt U-Boot (see
215 * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
216 * before release, and after release it is hoped that they don't matter. But
217 * in any case these failing assertions cannot be fixed with a reset (which
218 * may just do the same assertion again).
220 void __assert_fail(const char *assertion, const char *file, unsigned int line,
221 const char *function);
224 * assert() - assert expression is true
226 * If the expression x evaluates to false and _DEBUG evaluates to true, a panic
227 * message is written and the system stalls. The value of _DEBUG is set to true
228 * if DEBUG is defined before including common.h.
230 * The expression x is always executed irrespective of the value of _DEBUG.
232 * @x: expression to test
235 ({ if (!(x) && _DEBUG) \
236 __assert_fail(#x, __FILE__, __LINE__, __func__); })
239 * This one actually gets compiled in even without DEBUG. It doesn't include the
240 * full pathname as it may be huge. Only use this when the user should be
241 * warning, similar to BUG_ON() in linux.
243 * @return true if assertion succeeded (condition is true), else false
245 #define assert_noisy(x) \
246 ({ bool _val = (x); \
248 __assert_fail(#x, "?", __LINE__, __func__); \
252 #if CONFIG_IS_ENABLED(LOG) && defined(CONFIG_LOG_ERROR_RETURN)
254 * Log an error return value, possibly with a message. Usage:
256 * return log_ret(fred_call());
260 * return log_msg_ret("fred failed", fred_call());
262 #define log_ret(_ret) ({ \
263 int __ret = (_ret); \
265 log(LOG_CATEGORY, LOGL_ERR, "returning err=%d\n", __ret); \
268 #define log_msg_ret(_msg, _ret) ({ \
269 int __ret = (_ret); \
271 log(LOG_CATEGORY, LOGL_ERR, "%s: returning err=%d\n", _msg, \
276 /* Non-logging versions of the above which just return the error code */
277 #define log_ret(_ret) (_ret)
278 #define log_msg_ret(_msg, _ret) ((void)(_msg), _ret)
282 * struct log_rec - a single log record
284 * Holds information about a single record in the log
286 * Members marked as 'not allocated' are stored as pointers and the caller is
287 * responsible for making sure that the data pointed to is not overwritten.
288 * Memebers marked as 'allocated' are allocated (e.g. via strdup()) by the log
291 * TODO(sjg@chromium.org): Compress this struct down a bit to reduce space, e.g.
292 * a single u32 for cat, level, line and force_debug
294 * @cat: Category, representing a uclass or part of U-Boot
295 * @level: Severity level, less severe is higher
296 * @force_debug: Force output of debug
297 * @file: Name of file where the log record was generated (not allocated)
298 * @line: Line number where the log record was generated
299 * @func: Function where the log record was generated (not allocated)
300 * @msg: Log message (allocated)
303 enum log_category_t cat;
304 enum log_level_t level;
314 enum log_device_flags {
315 LOGDF_ENABLE = BIT(0), /* Device is enabled */
319 * struct log_driver - a driver which accepts and processes log records
321 * @name: Name of driver
322 * @emit: Method to call to emit a log record via this device
323 * @flags: Initial value for flags (use LOGDF_ENABLE to enable on start-up)
328 * emit() - emit a log record
330 * Called by the log system to pass a log record to a particular driver
331 * for processing. The filter is checked before calling this function.
333 int (*emit)(struct log_device *ldev, struct log_rec *rec);
334 unsigned short flags;
338 * struct log_device - an instance of a log driver
340 * Since drivers are set up at build-time we need to have a separate device for
341 * the run-time aspects of drivers (currently just a list of filters to apply
342 * to records send to this device).
344 * @next_filter_num: Seqence number of next filter filter added (0=no filters
345 * yet). This increments with each new filter on the device, but never
347 * @flags: Flags for this filter (enum log_device_flags)
348 * @drv: Pointer to driver for this device
349 * @filter_head: List of filters for this device
350 * @sibling_node: Next device in the list of all devices
353 unsigned short next_filter_num;
354 unsigned short flags;
355 struct log_driver *drv;
356 struct list_head filter_head;
357 struct list_head sibling_node;
361 LOGF_MAX_CATEGORIES = 5, /* maximum categories per filter */
365 * enum log_filter_flags - Flags which modify a filter
367 enum log_filter_flags {
368 /** @LOGFF_HAS_CAT: Filter has a category list */
369 LOGFF_HAS_CAT = 1 << 0,
370 /** @LOGFF_DENY: Filter denies matching messages */
372 /** @LOGFF_LEVEL_MIN: Filter's level is a minimum, not a maximum */
373 LOGFF_LEVEL_MIN = 1 << 2,
377 * struct log_filter - criterial to filter out log messages
379 * If a message matches all criteria, then it is allowed. If LOGFF_DENY is set,
380 * then it is denied instead.
382 * @filter_num: Sequence number of this filter. This is returned when adding a
383 * new filter, and must be provided when removing a previously added
385 * @flags: Flags for this filter (LOGFF_...)
386 * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
387 * then all categories are permitted. Up to LOGF_MAX_CATEGORIES entries
389 * @level: Maximum (or minimum, if LOGFF_MIN_LEVEL) log level to allow
390 * @file_list: List of files to allow, separated by comma. If NULL then all
391 * files are permitted
392 * @sibling_node: Next filter in the list of filters for this log device
397 enum log_category_t cat_list[LOGF_MAX_CATEGORIES];
398 enum log_level_t level;
399 const char *file_list;
400 struct list_head sibling_node;
403 #define LOG_DRIVER(_name) \
404 ll_entry_declare(struct log_driver, _name, log_driver)
406 /* Get a pointer to a given driver */
407 #define LOG_GET_DRIVER(__name) \
408 ll_entry_get(struct log_driver, __name, log_driver)
411 * log_get_cat_name() - Get the name of a category
413 * @cat: Category to look up
414 * @return category name (which may be a uclass driver name) if found, or
415 * "<invalid>" if invalid, or "<missing>" if not found
417 const char *log_get_cat_name(enum log_category_t cat);
420 * log_get_cat_by_name() - Look up a category by name
422 * @name: Name to look up
423 * @return category ID, or LOGC_NONE if not found
425 enum log_category_t log_get_cat_by_name(const char *name);
428 * log_get_level_name() - Get the name of a log level
430 * @level: Log level to look up
431 * @return log level name (in ALL CAPS)
433 const char *log_get_level_name(enum log_level_t level);
436 * log_get_level_by_name() - Look up a log level by name
438 * @name: Name to look up
439 * @return log level ID, or LOGL_NONE if not found
441 enum log_level_t log_get_level_by_name(const char *name);
444 * log_device_find_by_name() - Look up a log device by its driver's name
446 * @drv_name: Name of the driver
447 * @return the log device, or NULL if not found
449 struct log_device *log_device_find_by_name(const char *drv_name);
452 * log_has_cat() - check if a log category exists within a list
454 * @cat_list: List of categories to check, at most %LOGF_MAX_CATEGORIES entries
455 * long, terminated by %LC_END if fewer
456 * @cat: Category to search for
458 * Return: ``true`` if @cat is in @cat_list, else ``false``
460 bool log_has_cat(enum log_category_t cat_list[], enum log_category_t cat);
463 * log_has_file() - check if a file is with a list
465 * @file_list: List of files to check, separated by comma
466 * @file: File to check for. This string is matched against the end of each
467 * file in the list, i.e. ignoring any preceding path. The list is
468 * intended to consist of relative pathnames, e.g. common/main.c,cmd/log.c
470 * Return: ``true`` if @file is in @file_list, else ``false``
472 bool log_has_file(const char *file_list, const char *file);
474 /* Log format flags (bit numbers) for gd->log_fmt. See log_fmt_chars */
487 /* Handle the 'log test' command */
488 int do_log_test(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
491 * log_add_filter_flags() - Add a new filter to a log device, specifying flags
493 * @drv_name: Driver name to add the filter to (since each driver only has a
495 * @flags: Flags for this filter (LOGFF_...)
496 * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
497 * then all categories are permitted. Up to LOGF_MAX_CATEGORIES entries
499 * @level: Maximum (or minimum, if LOGFF_LEVEL_MIN) log level to allow
500 * @file_list: List of files to allow, separated by comma. If NULL then all
501 * files are permitted
502 * @return the sequence number of the new filter (>=0) if the filter was added,
503 * or a -ve value on error
505 int log_add_filter_flags(const char *drv_name, enum log_category_t cat_list[],
506 enum log_level_t level, const char *file_list,
510 * log_add_filter() - Add a new filter to a log device
512 * @drv_name: Driver name to add the filter to (since each driver only has a
514 * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
515 * then all categories are permitted. Up to LOGF_MAX_CATEGORIES entries
517 * @max_level: Maximum log level to allow
518 * @file_list: List of files to allow, separated by comma. If NULL then all
519 * files are permitted
520 * @return the sequence number of the new filter (>=0) if the filter was added,
521 * or a -ve value on error
523 static inline int log_add_filter(const char *drv_name,
524 enum log_category_t cat_list[],
525 enum log_level_t max_level,
526 const char *file_list)
528 return log_add_filter_flags(drv_name, cat_list, max_level, file_list,
533 * log_remove_filter() - Remove a filter from a log device
535 * @drv_name: Driver name to remove the filter from (since each driver only has
537 * @filter_num: Filter number to remove (as returned by log_add_filter())
538 * @return 0 if the filter was removed, -ENOENT if either the driver or the
539 * filter number was not found
541 int log_remove_filter(const char *drv_name, int filter_num);
544 * log_device_set_enable() - Enable or disable a log device
546 * Devices are referenced by their driver, so use LOG_GET_DRIVER(name) to pass
547 * the driver to this function. For example if the driver is declared with
548 * LOG_DRIVER(wibble) then pass LOG_GET_DRIVER(wibble) here.
550 * @drv: Driver of device to enable
551 * @enable: true to enable, false to disable
552 * @return 0 if OK, -ENOENT if the driver was not found
554 int log_device_set_enable(struct log_driver *drv, bool enable);
556 #if CONFIG_IS_ENABLED(LOG)
558 * log_init() - Set up the log system ready for use
560 * @return 0 if OK, -ENOMEM if out of memory
564 static inline int log_init(void)
571 * log_get_default_format() - get default log format
573 * The default log format is configurable via
574 * CONFIG_LOGF_FILE, CONFIG_LOGF_LINE, CONFIG_LOGF_FUNC.
576 * Return: default log format
578 static inline int log_get_default_format(void)
580 return BIT(LOGF_MSG) |
581 (IS_ENABLED(CONFIG_LOGF_FILE) ? BIT(LOGF_FILE) : 0) |
582 (IS_ENABLED(CONFIG_LOGF_LINE) ? BIT(LOGF_LINE) : 0) |
583 (IS_ENABLED(CONFIG_LOGF_FUNC) ? BIT(LOGF_FUNC) : 0);