]>
Commit | Line | Data |
---|---|---|
83d290c5 | 1 | /* SPDX-License-Identifier: GPL-2.0+ */ |
0e98b0a6 SG |
2 | /* |
3 | * Logging support | |
4 | * | |
5 | * Copyright (c) 2017 Google, Inc | |
6 | * Written by Simon Glass <sjg@chromium.org> | |
0e98b0a6 SG |
7 | */ |
8 | ||
9 | #ifndef __LOG_H | |
10 | #define __LOG_H | |
11 | ||
90526e9f | 12 | #include <stdio.h> |
09140113 | 13 | #include <linker_lists.h> |
e9c8d49d | 14 | #include <dm/uclass-id.h> |
3c21d773 | 15 | #include <linux/bitops.h> |
e9c8d49d SG |
16 | #include <linux/list.h> |
17 | ||
09140113 SG |
18 | struct cmd_tbl; |
19 | ||
00ebb7fe SA |
20 | /** |
21 | * enum log_level_t - Log levels supported, ranging from most to least important | |
22 | */ | |
e9c8d49d | 23 | enum log_level_t { |
00ebb7fe SA |
24 | /** @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, | |
9e925d0c | 32 | /** @LOGL_WARNING: Warning may prevent optimal operation */ |
00ebb7fe SA |
33 | 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, | |
44 | ||
45 | /** @LOGL_COUNT: Total number of valid log levels */ | |
e9c8d49d | 46 | LOGL_COUNT, |
00ebb7fe | 47 | /** @LOGL_NONE: Used to indicate that there is no valid log level */ |
f941c8d7 SG |
48 | LOGL_NONE, |
49 | ||
00ebb7fe SA |
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, | |
52d3df7f | 54 | |
00ebb7fe | 55 | /** @LOGL_FIRST: The first, most-important log level */ |
e9c8d49d | 56 | LOGL_FIRST = LOGL_EMERG, |
00ebb7fe | 57 | /** @LOGL_MAX: The last, least-important log level */ |
f941c8d7 | 58 | LOGL_MAX = LOGL_DEBUG_IO, |
00ebb7fe SA |
59 | /** @LOGL_CONT: Use same log level as in previous call */ |
60 | LOGL_CONT = -1, | |
e9c8d49d SG |
61 | }; |
62 | ||
63 | /** | |
00ebb7fe SA |
64 | * 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. | |
8021296a SG |
68 | * |
69 | * Remember to update log_cat_name[] after adding a new category. | |
e9c8d49d SG |
70 | */ |
71 | enum log_category_t { | |
00ebb7fe | 72 | /** @LOGC_FIRST: First log category */ |
e9c8d49d SG |
73 | LOGC_FIRST = 0, /* First part mirrors UCLASS_... */ |
74 | ||
00ebb7fe | 75 | /** @LOGC_NONE: Default log category */ |
0bf96459 | 76 | LOGC_NONE = UCLASS_COUNT, /* First number is after all uclasses */ |
00ebb7fe SA |
77 | /** @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) */ | |
7ca2850c | 98 | LOGC_ACPI, |
d61e7841 SG |
99 | /** @LOGC_BOOT: Related to boot process / boot image processing */ |
100 | LOGC_BOOT, | |
00ebb7fe SA |
101 | /** @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, | |
e9c8d49d SG |
107 | }; |
108 | ||
109 | /* Helper to cast a uclass ID to a log category */ | |
110 | static 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 | |
00ebb7fe | 125 | * Return: 0 if log record was emitted, -ve on error |
e9c8d49d SG |
126 | */ |
127 | int _log(enum log_category_t cat, enum log_level_t level, const char *file, | |
ed4e933d SG |
128 | int line, const char *func, const char *fmt, ...) |
129 | __attribute__ ((format (__printf__, 6, 7))); | |
e9c8d49d | 130 | |
fd42948f SG |
131 | static 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 | ||
136 | static 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 | ||
e9c8d49d SG |
143 | /* Define this at the top of a file to add a prefix to debug messages */ |
144 | #ifndef pr_fmt | |
145 | #define pr_fmt(fmt) fmt | |
146 | #endif | |
147 | ||
148 | /* Use a default category if this file does not supply one */ | |
149 | #ifndef LOG_CATEGORY | |
150 | #define LOG_CATEGORY LOGC_NONE | |
151 | #endif | |
152 | ||
153 | /* | |
154 | * This header may be including when CONFIG_LOG is disabled, in which case | |
155 | * CONFIG_LOG_MAX_LEVEL is not defined. Add a check for this. | |
156 | */ | |
157 | #if CONFIG_IS_ENABLED(LOG) | |
158 | #define _LOG_MAX_LEVEL CONFIG_VAL(LOG_MAX_LEVEL) | |
24967965 HS |
159 | #define log_emer(_fmt...) log(LOG_CATEGORY, LOGL_EMERG, ##_fmt) |
160 | #define log_alert(_fmt...) log(LOG_CATEGORY, LOGL_ALERT, ##_fmt) | |
161 | #define log_crit(_fmt...) log(LOG_CATEGORY, LOGL_CRIT, ##_fmt) | |
cdd140af SG |
162 | #define log_err(_fmt...) log(LOG_CATEGORY, LOGL_ERR, ##_fmt) |
163 | #define log_warning(_fmt...) log(LOG_CATEGORY, LOGL_WARNING, ##_fmt) | |
164 | #define log_notice(_fmt...) log(LOG_CATEGORY, LOGL_NOTICE, ##_fmt) | |
165 | #define log_info(_fmt...) log(LOG_CATEGORY, LOGL_INFO, ##_fmt) | |
166 | #define log_debug(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG, ##_fmt) | |
167 | #define log_content(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG_CONTENT, ##_fmt) | |
168 | #define log_io(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG_IO, ##_fmt) | |
24967965 | 169 | #define log_cont(_fmt...) log(LOGC_CONT, LOGL_CONT, ##_fmt) |
e9c8d49d SG |
170 | #else |
171 | #define _LOG_MAX_LEVEL LOGL_INFO | |
24967965 HS |
172 | #define log_emerg(_fmt, ...) printf(_fmt, ##__VA_ARGS__) |
173 | #define log_alert(_fmt, ...) printf(_fmt, ##__VA_ARGS__) | |
174 | #define log_crit(_fmt, ...) printf(_fmt, ##__VA_ARGS__) | |
20fd256d HS |
175 | #define log_err(_fmt, ...) printf(_fmt, ##__VA_ARGS__) |
176 | #define log_warning(_fmt, ...) printf(_fmt, ##__VA_ARGS__) | |
177 | #define log_notice(_fmt, ...) printf(_fmt, ##__VA_ARGS__) | |
178 | #define log_info(_fmt, ...) printf(_fmt, ##__VA_ARGS__) | |
24967965 | 179 | #define log_cont(_fmt, ...) printf(_fmt, ##__VA_ARGS__) |
20fd256d | 180 | #define log_debug(_fmt, ...) debug(_fmt, ##__VA_ARGS__) |
fd42948f SG |
181 | #define log_content(_fmt...) log_nop(LOG_CATEGORY, \ |
182 | LOGL_DEBUG_CONTENT, ##_fmt) | |
183 | #define log_io(_fmt...) log_nop(LOG_CATEGORY, LOGL_DEBUG_IO, ##_fmt) | |
e9c8d49d SG |
184 | #endif |
185 | ||
4d8d3056 | 186 | #if CONFIG_IS_ENABLED(LOG) |
f9811e85 | 187 | #ifdef LOG_DEBUG |
52d3df7f | 188 | #define _LOG_DEBUG LOGL_FORCE_DEBUG |
f9811e85 SG |
189 | #else |
190 | #define _LOG_DEBUG 0 | |
191 | #endif | |
4d8d3056 | 192 | |
e9c8d49d SG |
193 | /* Emit a log record if the level is less that the maximum */ |
194 | #define log(_cat, _level, _fmt, _args...) ({ \ | |
195 | int _l = _level; \ | |
52d3df7f SG |
196 | if (CONFIG_IS_ENABLED(LOG) && \ |
197 | (_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__, \ | |
e9c8d49d SG |
201 | pr_fmt(_fmt), ##_args); \ |
202 | }) | |
4d8d3056 SG |
203 | #else |
204 | #define log(_cat, _level, _fmt, _args...) | |
205 | #endif | |
e9c8d49d | 206 | |
fd42948f SG |
207 | #define log_nop(_cat, _level, _fmt, _args...) ({ \ |
208 | int _l = _level; \ | |
209 | _log_nop((enum log_category_t)(_cat), _l, __FILE__, __LINE__, \ | |
210 | __func__, pr_fmt(_fmt), ##_args); \ | |
211 | }) | |
212 | ||
0e98b0a6 SG |
213 | #ifdef DEBUG |
214 | #define _DEBUG 1 | |
215 | #else | |
216 | #define _DEBUG 0 | |
217 | #endif | |
218 | ||
219 | #ifdef CONFIG_SPL_BUILD | |
220 | #define _SPL_BUILD 1 | |
221 | #else | |
222 | #define _SPL_BUILD 0 | |
223 | #endif | |
224 | ||
e9c8d49d SG |
225 | #if !_DEBUG && CONFIG_IS_ENABLED(LOG) |
226 | ||
227 | #define debug_cond(cond, fmt, args...) \ | |
5176365a HS |
228 | ({ \ |
229 | log(LOG_CATEGORY, LOGL_DEBUG, fmt, ##args); \ | |
230 | }) | |
e9c8d49d SG |
231 | |
232 | #else /* _DEBUG */ | |
233 | ||
0e98b0a6 SG |
234 | /* |
235 | * Output a debug text when condition "cond" is met. The "cond" should be | |
236 | * computed by a preprocessor in the best case, allowing for the best | |
237 | * optimization. | |
238 | */ | |
5176365a HS |
239 | #define debug_cond(cond, fmt, args...) \ |
240 | ({ \ | |
241 | if (cond) \ | |
242 | printf(pr_fmt(fmt), ##args); \ | |
243 | }) | |
0e98b0a6 | 244 | |
e9c8d49d SG |
245 | #endif /* _DEBUG */ |
246 | ||
0e98b0a6 SG |
247 | /* Show a message if DEBUG is defined in a file */ |
248 | #define debug(fmt, args...) \ | |
249 | debug_cond(_DEBUG, fmt, ##args) | |
250 | ||
251 | /* Show a message if not in SPL */ | |
252 | #define warn_non_spl(fmt, args...) \ | |
253 | debug_cond(!_SPL_BUILD, fmt, ##args) | |
254 | ||
255 | /* | |
256 | * An assertion is run-time check done in debug mode only. If DEBUG is not | |
257 | * defined then it is skipped. If DEBUG is defined and the assertion fails, | |
258 | * then it calls panic*( which may or may not reset/halt U-Boot (see | |
259 | * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found | |
260 | * before release, and after release it is hoped that they don't matter. But | |
261 | * in any case these failing assertions cannot be fixed with a reset (which | |
262 | * may just do the same assertion again). | |
263 | */ | |
264 | void __assert_fail(const char *assertion, const char *file, unsigned int line, | |
265 | const char *function); | |
b236f8c0 HS |
266 | |
267 | /** | |
268 | * assert() - assert expression is true | |
269 | * | |
270 | * If the expression x evaluates to false and _DEBUG evaluates to true, a panic | |
271 | * message is written and the system stalls. The value of _DEBUG is set to true | |
272 | * if DEBUG is defined before including common.h. | |
273 | * | |
274 | * The expression x is always executed irrespective of the value of _DEBUG. | |
275 | * | |
276 | * @x: expression to test | |
277 | */ | |
0e98b0a6 SG |
278 | #define assert(x) \ |
279 | ({ if (!(x) && _DEBUG) \ | |
280 | __assert_fail(#x, __FILE__, __LINE__, __func__); }) | |
281 | ||
cd01d2d5 SG |
282 | /* |
283 | * This one actually gets compiled in even without DEBUG. It doesn't include the | |
284 | * full pathname as it may be huge. Only use this when the user should be | |
285 | * warning, similar to BUG_ON() in linux. | |
286 | * | |
00ebb7fe | 287 | * Return: true if assertion succeeded (condition is true), else false |
cd01d2d5 SG |
288 | */ |
289 | #define assert_noisy(x) \ | |
290 | ({ bool _val = (x); \ | |
291 | if (!_val) \ | |
292 | __assert_fail(#x, "?", __LINE__, __func__); \ | |
293 | _val; \ | |
294 | }) | |
295 | ||
4d8d3056 SG |
296 | #if CONFIG_IS_ENABLED(LOG) && defined(CONFIG_LOG_ERROR_RETURN) |
297 | /* | |
298 | * Log an error return value, possibly with a message. Usage: | |
299 | * | |
300 | * return log_ret(fred_call()); | |
301 | * | |
302 | * or: | |
303 | * | |
304 | * return log_msg_ret("fred failed", fred_call()); | |
305 | */ | |
3707c6ee SG |
306 | #define log_ret(_ret) ({ \ |
307 | int __ret = (_ret); \ | |
308 | if (__ret < 0) \ | |
309 | log(LOG_CATEGORY, LOGL_ERR, "returning err=%d\n", __ret); \ | |
310 | __ret; \ | |
311 | }) | |
b616cef9 SG |
312 | #define log_msg_ret(_msg, _ret) ({ \ |
313 | int __ret = (_ret); \ | |
314 | if (__ret < 0) \ | |
315 | log(LOG_CATEGORY, LOGL_ERR, "%s: returning err=%d\n", _msg, \ | |
316 | __ret); \ | |
317 | __ret; \ | |
318 | }) | |
3707c6ee | 319 | #else |
4d8d3056 | 320 | /* Non-logging versions of the above which just return the error code */ |
3707c6ee | 321 | #define log_ret(_ret) (_ret) |
4d8d3056 | 322 | #define log_msg_ret(_msg, _ret) ((void)(_msg), _ret) |
3707c6ee SG |
323 | #endif |
324 | ||
79d5983b SG |
325 | /** * enum log_rec_flags - Flags for a log record */ |
326 | enum log_rec_flags { | |
327 | /** @LOGRECF_FORCE_DEBUG: Force output of debug record */ | |
328 | LOGRECF_FORCE_DEBUG = BIT(0), | |
329 | }; | |
330 | ||
e9c8d49d SG |
331 | /** |
332 | * struct log_rec - a single log record | |
333 | * | |
334 | * Holds information about a single record in the log | |
335 | * | |
336 | * Members marked as 'not allocated' are stored as pointers and the caller is | |
337 | * responsible for making sure that the data pointed to is not overwritten. | |
9e925d0c | 338 | * Members marked as 'allocated' are allocated (e.g. via strdup()) by the log |
e9c8d49d SG |
339 | * system. |
340 | * | |
52d3df7f SG |
341 | * TODO(sjg@chromium.org): Compress this struct down a bit to reduce space, e.g. |
342 | * a single u32 for cat, level, line and force_debug | |
343 | * | |
e9c8d49d SG |
344 | * @cat: Category, representing a uclass or part of U-Boot |
345 | * @level: Severity level, less severe is higher | |
e9c8d49d | 346 | * @line: Line number where the log record was generated |
79d5983b SG |
347 | * @flags: Flags for log record (enum log_rec_flags) |
348 | * @file: Name of file where the log record was generated (not allocated) | |
e9c8d49d SG |
349 | * @func: Function where the log record was generated (not allocated) |
350 | * @msg: Log message (allocated) | |
351 | */ | |
352 | struct log_rec { | |
353 | enum log_category_t cat; | |
354 | enum log_level_t level; | |
79d5983b SG |
355 | u16 line; |
356 | u8 flags; | |
e9c8d49d | 357 | const char *file; |
e9c8d49d SG |
358 | const char *func; |
359 | const char *msg; | |
360 | }; | |
361 | ||
362 | struct log_device; | |
363 | ||
b4520300 SG |
364 | enum log_device_flags { |
365 | LOGDF_ENABLE = BIT(0), /* Device is enabled */ | |
366 | }; | |
367 | ||
e9c8d49d SG |
368 | /** |
369 | * struct log_driver - a driver which accepts and processes log records | |
370 | * | |
371 | * @name: Name of driver | |
b4520300 SG |
372 | * @emit: Method to call to emit a log record via this device |
373 | * @flags: Initial value for flags (use LOGDF_ENABLE to enable on start-up) | |
e9c8d49d SG |
374 | */ |
375 | struct log_driver { | |
376 | const char *name; | |
00ebb7fe | 377 | |
e9c8d49d | 378 | /** |
00ebb7fe | 379 | * @emit: emit a log record |
e9c8d49d SG |
380 | * |
381 | * Called by the log system to pass a log record to a particular driver | |
382 | * for processing. The filter is checked before calling this function. | |
383 | */ | |
384 | int (*emit)(struct log_device *ldev, struct log_rec *rec); | |
b4520300 | 385 | unsigned short flags; |
e9c8d49d SG |
386 | }; |
387 | ||
388 | /** | |
389 | * struct log_device - an instance of a log driver | |
390 | * | |
391 | * Since drivers are set up at build-time we need to have a separate device for | |
392 | * the run-time aspects of drivers (currently just a list of filters to apply | |
393 | * to records send to this device). | |
394 | * | |
9e925d0c | 395 | * @next_filter_num: Sequence number of next filter filter added (0=no filters |
e9c8d49d SG |
396 | * yet). This increments with each new filter on the device, but never |
397 | * decrements | |
b4520300 | 398 | * @flags: Flags for this filter (enum log_device_flags) |
e9c8d49d SG |
399 | * @drv: Pointer to driver for this device |
400 | * @filter_head: List of filters for this device | |
401 | * @sibling_node: Next device in the list of all devices | |
402 | */ | |
403 | struct log_device { | |
b4520300 SG |
404 | unsigned short next_filter_num; |
405 | unsigned short flags; | |
e9c8d49d SG |
406 | struct log_driver *drv; |
407 | struct list_head filter_head; | |
408 | struct list_head sibling_node; | |
409 | }; | |
410 | ||
411 | enum { | |
412 | LOGF_MAX_CATEGORIES = 5, /* maximum categories per filter */ | |
413 | }; | |
414 | ||
fe3b1a2d SA |
415 | /** |
416 | * enum log_filter_flags - Flags which modify a filter | |
417 | */ | |
e9c8d49d | 418 | enum log_filter_flags { |
fe3b1a2d SA |
419 | /** @LOGFF_HAS_CAT: Filter has a category list */ |
420 | LOGFF_HAS_CAT = 1 << 0, | |
421 | /** @LOGFF_DENY: Filter denies matching messages */ | |
422 | LOGFF_DENY = 1 << 1, | |
40455a69 SA |
423 | /** @LOGFF_LEVEL_MIN: Filter's level is a minimum, not a maximum */ |
424 | LOGFF_LEVEL_MIN = 1 << 2, | |
e9c8d49d SG |
425 | }; |
426 | ||
427 | /** | |
9e925d0c | 428 | * struct log_filter - criteria to filter out log messages |
e9c8d49d | 429 | * |
fe3b1a2d SA |
430 | * If a message matches all criteria, then it is allowed. If LOGFF_DENY is set, |
431 | * then it is denied instead. | |
432 | * | |
e9c8d49d SG |
433 | * @filter_num: Sequence number of this filter. This is returned when adding a |
434 | * new filter, and must be provided when removing a previously added | |
435 | * filter. | |
00ebb7fe | 436 | * @flags: Flags for this filter (``LOGFF_...``) |
b66a924f | 437 | * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty |
00ebb7fe | 438 | * then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries |
e9c8d49d | 439 | * can be provided |
00ebb7fe | 440 | * @level: Maximum (or minimum, if %LOGFF_MIN_LEVEL) log level to allow |
e9c8d49d SG |
441 | * @file_list: List of files to allow, separated by comma. If NULL then all |
442 | * files are permitted | |
443 | * @sibling_node: Next filter in the list of filters for this log device | |
444 | */ | |
445 | struct log_filter { | |
446 | int filter_num; | |
447 | int flags; | |
448 | enum log_category_t cat_list[LOGF_MAX_CATEGORIES]; | |
40455a69 | 449 | enum log_level_t level; |
e9c8d49d SG |
450 | const char *file_list; |
451 | struct list_head sibling_node; | |
452 | }; | |
453 | ||
454 | #define LOG_DRIVER(_name) \ | |
455 | ll_entry_declare(struct log_driver, _name, log_driver) | |
456 | ||
3d03ab63 SG |
457 | /* Get a pointer to a given driver */ |
458 | #define LOG_GET_DRIVER(__name) \ | |
459 | ll_entry_get(struct log_driver, __name, log_driver) | |
460 | ||
f941c8d7 SG |
461 | /** |
462 | * log_get_cat_name() - Get the name of a category | |
463 | * | |
464 | * @cat: Category to look up | |
00ebb7fe | 465 | * Return: category name (which may be a uclass driver name) if found, or |
1c593a10 SA |
466 | * "<invalid>" if invalid, or "<missing>" if not found. All error |
467 | * responses begin with '<'. | |
f941c8d7 SG |
468 | */ |
469 | const char *log_get_cat_name(enum log_category_t cat); | |
470 | ||
471 | /** | |
472 | * log_get_cat_by_name() - Look up a category by name | |
473 | * | |
474 | * @name: Name to look up | |
00ebb7fe | 475 | * Return: Category, or %LOGC_NONE if not found |
f941c8d7 SG |
476 | */ |
477 | enum log_category_t log_get_cat_by_name(const char *name); | |
478 | ||
479 | /** | |
480 | * log_get_level_name() - Get the name of a log level | |
481 | * | |
482 | * @level: Log level to look up | |
00ebb7fe | 483 | * Return: Log level name (in ALL CAPS) |
f941c8d7 SG |
484 | */ |
485 | const char *log_get_level_name(enum log_level_t level); | |
486 | ||
487 | /** | |
488 | * log_get_level_by_name() - Look up a log level by name | |
489 | * | |
490 | * @name: Name to look up | |
00ebb7fe | 491 | * Return: Log level, or %LOGL_NONE if not found |
f941c8d7 SG |
492 | */ |
493 | enum log_level_t log_get_level_by_name(const char *name); | |
494 | ||
3102c1d2 SA |
495 | /** |
496 | * log_device_find_by_name() - Look up a log device by its driver's name | |
497 | * | |
498 | * @drv_name: Name of the driver | |
00ebb7fe | 499 | * Return: the log device, or %NULL if not found |
3102c1d2 SA |
500 | */ |
501 | struct log_device *log_device_find_by_name(const char *drv_name); | |
502 | ||
503 | /** | |
504 | * log_has_cat() - check if a log category exists within a list | |
505 | * | |
506 | * @cat_list: List of categories to check, at most %LOGF_MAX_CATEGORIES entries | |
507 | * long, terminated by %LC_END if fewer | |
508 | * @cat: Category to search for | |
509 | * | |
510 | * Return: ``true`` if @cat is in @cat_list, else ``false`` | |
511 | */ | |
512 | bool log_has_cat(enum log_category_t cat_list[], enum log_category_t cat); | |
513 | ||
514 | /** | |
515 | * log_has_file() - check if a file is with a list | |
516 | * | |
517 | * @file_list: List of files to check, separated by comma | |
518 | * @file: File to check for. This string is matched against the end of each | |
519 | * file in the list, i.e. ignoring any preceding path. The list is | |
520 | * intended to consist of relative pathnames, e.g. common/main.c,cmd/log.c | |
521 | * | |
522 | * Return: ``true`` if @file is in @file_list, else ``false`` | |
523 | */ | |
524 | bool log_has_file(const char *file_list, const char *file); | |
525 | ||
3b73e8d0 SG |
526 | /* Log format flags (bit numbers) for gd->log_fmt. See log_fmt_chars */ |
527 | enum log_fmt { | |
528 | LOGF_CAT = 0, | |
529 | LOGF_LEVEL, | |
530 | LOGF_FILE, | |
531 | LOGF_LINE, | |
532 | LOGF_FUNC, | |
533 | LOGF_MSG, | |
534 | ||
535 | LOGF_COUNT, | |
3b73e8d0 SG |
536 | LOGF_ALL = 0x3f, |
537 | }; | |
538 | ||
ef11ed82 | 539 | /* Handle the 'log test' command */ |
09140113 | 540 | int do_log_test(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]); |
ef11ed82 | 541 | |
a02f84ee SA |
542 | /** |
543 | * log_add_filter_flags() - Add a new filter to a log device, specifying flags | |
544 | * | |
545 | * @drv_name: Driver name to add the filter to (since each driver only has a | |
546 | * single device) | |
00ebb7fe | 547 | * @flags: Flags for this filter (``LOGFF_...``) |
a02f84ee | 548 | * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty |
00ebb7fe | 549 | * then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries |
a02f84ee | 550 | * can be provided |
00ebb7fe | 551 | * @level: Maximum (or minimum, if %LOGFF_LEVEL_MIN) log level to allow |
a02f84ee SA |
552 | * @file_list: List of files to allow, separated by comma. If NULL then all |
553 | * files are permitted | |
00ebb7fe SA |
554 | * Return: |
555 | * the sequence number of the new filter (>=0) if the filter was added, or a | |
556 | * -ve value on error | |
a02f84ee SA |
557 | */ |
558 | int log_add_filter_flags(const char *drv_name, enum log_category_t cat_list[], | |
40455a69 | 559 | enum log_level_t level, const char *file_list, |
a02f84ee SA |
560 | int flags); |
561 | ||
e9c8d49d SG |
562 | /** |
563 | * log_add_filter() - Add a new filter to a log device | |
564 | * | |
565 | * @drv_name: Driver name to add the filter to (since each driver only has a | |
566 | * single device) | |
b66a924f | 567 | * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty |
00ebb7fe | 568 | * then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries |
e9c8d49d SG |
569 | * can be provided |
570 | * @max_level: Maximum log level to allow | |
00ebb7fe | 571 | * @file_list: List of files to allow, separated by comma. If %NULL then all |
e9c8d49d | 572 | * files are permitted |
00ebb7fe SA |
573 | * Return: |
574 | * the sequence number of the new filter (>=0) if the filter was added, or a | |
575 | * -ve value on error | |
e9c8d49d | 576 | */ |
a02f84ee SA |
577 | static inline int log_add_filter(const char *drv_name, |
578 | enum log_category_t cat_list[], | |
579 | enum log_level_t max_level, | |
580 | const char *file_list) | |
581 | { | |
582 | return log_add_filter_flags(drv_name, cat_list, max_level, file_list, | |
583 | 0); | |
584 | } | |
e9c8d49d SG |
585 | |
586 | /** | |
587 | * log_remove_filter() - Remove a filter from a log device | |
588 | * | |
589 | * @drv_name: Driver name to remove the filter from (since each driver only has | |
590 | * a single device) | |
591 | * @filter_num: Filter number to remove (as returned by log_add_filter()) | |
00ebb7fe SA |
592 | * Return: |
593 | * 0 if the filter was removed, -%ENOENT if either the driver or the filter | |
594 | * number was not found | |
e9c8d49d SG |
595 | */ |
596 | int log_remove_filter(const char *drv_name, int filter_num); | |
597 | ||
3d03ab63 SG |
598 | /** |
599 | * log_device_set_enable() - Enable or disable a log device | |
600 | * | |
601 | * Devices are referenced by their driver, so use LOG_GET_DRIVER(name) to pass | |
602 | * the driver to this function. For example if the driver is declared with | |
603 | * LOG_DRIVER(wibble) then pass LOG_GET_DRIVER(wibble) here. | |
604 | * | |
605 | * @drv: Driver of device to enable | |
606 | * @enable: true to enable, false to disable | |
607 | * @return 0 if OK, -ENOENT if the driver was not found | |
608 | */ | |
609 | int log_device_set_enable(struct log_driver *drv, bool enable); | |
610 | ||
e9c8d49d SG |
611 | #if CONFIG_IS_ENABLED(LOG) |
612 | /** | |
613 | * log_init() - Set up the log system ready for use | |
614 | * | |
00ebb7fe | 615 | * Return: 0 if OK, -%ENOMEM if out of memory |
e9c8d49d SG |
616 | */ |
617 | int log_init(void); | |
618 | #else | |
619 | static inline int log_init(void) | |
620 | { | |
621 | return 0; | |
622 | } | |
623 | #endif | |
624 | ||
3c21d773 HS |
625 | /** |
626 | * log_get_default_format() - get default log format | |
627 | * | |
628 | * The default log format is configurable via | |
00ebb7fe | 629 | * %CONFIG_LOGF_FILE, %CONFIG_LOGF_LINE, and %CONFIG_LOGF_FUNC. |
3c21d773 HS |
630 | * |
631 | * Return: default log format | |
632 | */ | |
633 | static inline int log_get_default_format(void) | |
634 | { | |
635 | return BIT(LOGF_MSG) | | |
636 | (IS_ENABLED(CONFIG_LOGF_FILE) ? BIT(LOGF_FILE) : 0) | | |
637 | (IS_ENABLED(CONFIG_LOGF_LINE) ? BIT(LOGF_LINE) : 0) | | |
638 | (IS_ENABLED(CONFIG_LOGF_FUNC) ? BIT(LOGF_FUNC) : 0); | |
639 | } | |
640 | ||
0e98b0a6 | 641 | #endif |