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