]>
git.ipfire.org Git - people/ms/u-boot.git/blob - include/log.h
4 * Copyright (c) 2017 Google, Inc
5 * Written by Simon Glass <sjg@chromium.org>
7 * SPDX-License-Identifier: GPL-2.0+
13 #include <dm/uclass-id.h>
14 #include <linux/list.h>
16 /** Log levels supported, ranging from most to least important */
18 LOGL_EMERG
= 0, /*U-Boot is unstable */
19 LOGL_ALERT
, /* Action must be taken immediately */
20 LOGL_CRIT
, /* Critical conditions */
21 LOGL_ERR
, /* Error that prevents something from working */
22 LOGL_WARNING
, /* Warning may prevent optimial operation */
23 LOGL_NOTICE
, /* Normal but significant condition, printf() */
24 LOGL_INFO
, /* General information message */
25 LOGL_DEBUG
, /* Basic debug-level message */
26 LOGL_DEBUG_CONTENT
, /* Debug message showing full message content */
27 LOGL_DEBUG_IO
, /* Debug message showing hardware I/O access */
30 LOGL_FIRST
= LOGL_EMERG
,
31 LOGL_MAX
= LOGL_DEBUG
,
35 * Log categories supported. Most of these correspond to uclasses (i.e.
36 * enum uclass_id) but there are also some more generic categories
39 LOGC_FIRST
= 0, /* First part mirrors UCLASS_... */
41 LOGC_NONE
= UCLASS_COUNT
,
51 /* Helper to cast a uclass ID to a log category */
52 static inline int log_uc_cat(enum uclass_id id
)
54 return (enum log_category_t
)id
;
58 * _log() - Internal function to emit a new log record
60 * @cat: Category of log record (indicating which subsystem generated it)
61 * @level: Level of log record (indicating its severity)
62 * @file: File name of file where log record was generated
63 * @line: Line number in file where log record was generated
64 * @func: Function where log record was generated
65 * @fmt: printf() format string for log record
66 * @...: Optional parameters, according to the format string @fmt
67 * @return 0 if log record was emitted, -ve on error
69 int _log(enum log_category_t cat
, enum log_level_t level
, const char *file
,
70 int line
, const char *func
, const char *fmt
, ...);
72 /* Define this at the top of a file to add a prefix to debug messages */
74 #define pr_fmt(fmt) fmt
77 /* Use a default category if this file does not supply one */
79 #define LOG_CATEGORY LOGC_NONE
83 * This header may be including when CONFIG_LOG is disabled, in which case
84 * CONFIG_LOG_MAX_LEVEL is not defined. Add a check for this.
86 #if CONFIG_IS_ENABLED(LOG)
87 #define _LOG_MAX_LEVEL CONFIG_VAL(LOG_MAX_LEVEL)
89 #define _LOG_MAX_LEVEL LOGL_INFO
92 /* Emit a log record if the level is less that the maximum */
93 #define log(_cat, _level, _fmt, _args...) ({ \
95 if (_l <= _LOG_MAX_LEVEL) \
96 _log((enum log_category_t)(_cat), _l, __FILE__, __LINE__, \
98 pr_fmt(_fmt), ##_args); \
107 #ifdef CONFIG_SPL_BUILD
113 #if !_DEBUG && CONFIG_IS_ENABLED(LOG)
115 #define debug_cond(cond, fmt, args...) \
118 log(LOG_CATEGORY, LOGL_DEBUG, fmt, ##args); \
124 * Output a debug text when condition "cond" is met. The "cond" should be
125 * computed by a preprocessor in the best case, allowing for the best
128 #define debug_cond(cond, fmt, args...) \
131 printf(pr_fmt(fmt), ##args); \
136 /* Show a message if DEBUG is defined in a file */
137 #define debug(fmt, args...) \
138 debug_cond(_DEBUG, fmt, ##args)
140 /* Show a message if not in SPL */
141 #define warn_non_spl(fmt, args...) \
142 debug_cond(!_SPL_BUILD, fmt, ##args)
145 * An assertion is run-time check done in debug mode only. If DEBUG is not
146 * defined then it is skipped. If DEBUG is defined and the assertion fails,
147 * then it calls panic*( which may or may not reset/halt U-Boot (see
148 * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
149 * before release, and after release it is hoped that they don't matter. But
150 * in any case these failing assertions cannot be fixed with a reset (which
151 * may just do the same assertion again).
153 void __assert_fail(const char *assertion
, const char *file
, unsigned int line
,
154 const char *function
);
156 ({ if (!(x) && _DEBUG) \
157 __assert_fail(#x, __FILE__, __LINE__, __func__); })
160 * struct log_rec - a single log record
162 * Holds information about a single record in the log
164 * Members marked as 'not allocated' are stored as pointers and the caller is
165 * responsible for making sure that the data pointed to is not overwritten.
166 * Memebers marked as 'allocated' are allocated (e.g. via strdup()) by the log
169 * @cat: Category, representing a uclass or part of U-Boot
170 * @level: Severity level, less severe is higher
171 * @file: Name of file where the log record was generated (not allocated)
172 * @line: Line number where the log record was generated
173 * @func: Function where the log record was generated (not allocated)
174 * @msg: Log message (allocated)
177 enum log_category_t cat
;
178 enum log_level_t level
;
188 * struct log_driver - a driver which accepts and processes log records
190 * @name: Name of driver
195 * emit() - emit a log record
197 * Called by the log system to pass a log record to a particular driver
198 * for processing. The filter is checked before calling this function.
200 int (*emit
)(struct log_device
*ldev
, struct log_rec
*rec
);
204 * struct log_device - an instance of a log driver
206 * Since drivers are set up at build-time we need to have a separate device for
207 * the run-time aspects of drivers (currently just a list of filters to apply
208 * to records send to this device).
210 * @next_filter_num: Seqence number of next filter filter added (0=no filters
211 * yet). This increments with each new filter on the device, but never
213 * @drv: Pointer to driver for this device
214 * @filter_head: List of filters for this device
215 * @sibling_node: Next device in the list of all devices
219 struct log_driver
*drv
;
220 struct list_head filter_head
;
221 struct list_head sibling_node
;
225 LOGF_MAX_CATEGORIES
= 5, /* maximum categories per filter */
228 enum log_filter_flags
{
229 LOGFF_HAS_CAT
= 1 << 0, /* Filter has a category list */
233 * struct log_filter - criterial to filter out log messages
235 * @filter_num: Sequence number of this filter. This is returned when adding a
236 * new filter, and must be provided when removing a previously added
238 * @flags: Flags for this filter (LOGFF_...)
239 * @cat_list: List of categories to allow (terminated by LOGC_none). If empty
240 * then all categories are permitted. Up to LOGF_MAX_CATEGORIES entries
242 * @max_level: Maximum log level to allow
243 * @file_list: List of files to allow, separated by comma. If NULL then all
244 * files are permitted
245 * @sibling_node: Next filter in the list of filters for this log device
250 enum log_category_t cat_list
[LOGF_MAX_CATEGORIES
];
251 enum log_level_t max_level
;
252 const char *file_list
;
253 struct list_head sibling_node
;
256 #define LOG_DRIVER(_name) \
257 ll_entry_declare(struct log_driver, _name, log_driver)
259 /* Handle the 'log test' command */
260 int do_log_test(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char *const argv
[]);
263 * log_add_filter() - Add a new filter to a log device
265 * @drv_name: Driver name to add the filter to (since each driver only has a
267 * @cat_list: List of categories to allow (terminated by LOGC_none). If empty
268 * then all categories are permitted. Up to LOGF_MAX_CATEGORIES entries
270 * @max_level: Maximum log level to allow
271 * @file_list: List of files to allow, separated by comma. If NULL then all
272 * files are permitted
273 * @return the sequence number of the new filter (>=0) if the filter was added,
274 * or a -ve value on error
276 int log_add_filter(const char *drv_name
, enum log_category_t cat_list
[],
277 enum log_level_t max_level
, const char *file_list
);
280 * log_remove_filter() - Remove a filter from a log device
282 * @drv_name: Driver name to remove the filter from (since each driver only has
284 * @filter_num: Filter number to remove (as returned by log_add_filter())
285 * @return 0 if the filter was removed, -ENOENT if either the driver or the
286 * filter number was not found
288 int log_remove_filter(const char *drv_name
, int filter_num
);
290 #if CONFIG_IS_ENABLED(LOG)
292 * log_init() - Set up the log system ready for use
294 * @return 0 if OK, -ENOMEM if out of memory
298 static inline int log_init(void)