8a7b961bbfbfb75163f3871dc2f44c26a9b982a7
[platform/kernel/u-boot.git] / include / log.h
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_EVENT: Related to event and event handling */
102         LOGC_EVENT,
103         /** @LOGC_COUNT: Number of log categories */
104         LOGC_COUNT,
105         /** @LOGC_END: Sentinel value for lists of log categories */
106         LOGC_END,
107         /** @LOGC_CONT: Use same category as in previous call */
108         LOGC_CONT = -1,
109 };
110
111 /* Helper to cast a uclass ID to a log category */
112 static inline int log_uc_cat(enum uclass_id id)
113 {
114         return (enum log_category_t)id;
115 }
116
117 /**
118  * _log() - Internal function to emit a new log record
119  *
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
128  */
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)));
132
133 /**
134  * _log_buffer - Internal function to print data buffer in hex and ascii form
135  *
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
146  */
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);
150
151 /* Define this at the top of a file to add a prefix to debug messages */
152 #ifndef pr_fmt
153 #define pr_fmt(fmt) fmt
154 #endif
155
156 /* Use a default category if this file does not supply one */
157 #ifndef LOG_CATEGORY
158 #define LOG_CATEGORY LOGC_NONE
159 #endif
160
161 /*
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.
164  */
165 #if CONFIG_IS_ENABLED(LOG)
166 #define _LOG_MAX_LEVEL CONFIG_VAL(LOG_MAX_LEVEL)
167 #else
168 #define _LOG_MAX_LEVEL LOGL_INFO
169 #endif
170
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)
182
183 #ifdef LOG_DEBUG
184 #define _LOG_DEBUG      LOGL_FORCE_DEBUG
185 #ifndef DEBUG
186 #define DEBUG
187 #endif
188 #else
189 #define _LOG_DEBUG      0
190 #endif
191
192 #if CONFIG_IS_ENABLED(LOG)
193
194 /* Emit a log record if the level is less that the maximum */
195 #define log(_cat, _level, _fmt, _args...) ({ \
196         int _l = _level; \
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); \
202         })
203
204 /* Emit a dump if the level is less that the maximum */
205 #define log_buffer(_cat, _level, _addr, _data, _width, _count, _linelen)  ({ \
206         int _l = _level; \
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); \
212         })
213 #else
214
215 /* Note: _LOG_DEBUG != 0 avoids a warning with clang */
216 #define log(_cat, _level, _fmt, _args...) ({ \
217         int _l = _level; \
218         if (_LOG_DEBUG != 0 || _l <= LOGL_INFO || \
219             (_DEBUG && _l == LOGL_DEBUG)) \
220                 printf(_fmt, ##_args); \
221         })
222
223 #define log_buffer(_cat, _level, _addr, _data, _width, _count, _linelen)  ({ \
224         int _l = _level; \
225         if (_LOG_DEBUG != 0 || _l <= LOGL_INFO || \
226             (_DEBUG && _l == LOGL_DEBUG)) \
227                 print_buffer(_addr, _data, _width, _count, _linelen); \
228         })
229 #endif
230
231 #ifdef DEBUG
232 #define _DEBUG  1
233 #else
234 #define _DEBUG  0
235 #endif
236
237 #ifdef CONFIG_SPL_BUILD
238 #define _SPL_BUILD      1
239 #else
240 #define _SPL_BUILD      0
241 #endif
242
243 #if CONFIG_IS_ENABLED(LOG)
244
245 #define debug_cond(cond, fmt, args...)                                  \
246 ({                                                                      \
247         if (cond)                                                       \
248                 log(LOG_CATEGORY,                                       \
249                     (enum log_level_t)(LOGL_FORCE_DEBUG | _LOG_DEBUG),  \
250                     fmt, ##args);                                       \
251 })
252
253 #else /* _DEBUG */
254
255 /*
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
258  * optimization.
259  */
260 #define debug_cond(cond, fmt, args...)          \
261 ({                                              \
262         if (cond)                               \
263                 printf(pr_fmt(fmt), ##args);    \
264 })
265
266 #endif /* _DEBUG */
267
268 /* Show a message if DEBUG is defined in a file */
269 #define debug(fmt, args...)                     \
270         debug_cond(_DEBUG, fmt, ##args)
271
272 /* Show a message if not in SPL */
273 #define warn_non_spl(fmt, args...)                      \
274         debug_cond(!_SPL_BUILD, fmt, ##args)
275
276 /*
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).
284  */
285 void __assert_fail(const char *assertion, const char *file, unsigned int line,
286                    const char *function);
287
288 /**
289  * assert() - assert expression is true
290  *
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.
294  *
295  * The expression x is always executed irrespective of the value of _DEBUG.
296  *
297  * @x:          expression to test
298  */
299 #define assert(x) \
300         ({ if (!(x) && _DEBUG) \
301                 __assert_fail(#x, __FILE__, __LINE__, __func__); })
302
303 /*
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.
307  *
308  * Return: true if assertion succeeded (condition is true), else false
309  */
310 #define assert_noisy(x) \
311         ({ bool _val = (x); \
312         if (!_val) \
313                 __assert_fail(#x, "?", __LINE__, __func__); \
314         _val; \
315         })
316
317 #if CONFIG_IS_ENABLED(LOG) && defined(CONFIG_LOG_ERROR_RETURN)
318 /*
319  * Log an error return value, possibly with a message. Usage:
320  *
321  *      return log_ret(fred_call());
322  *
323  * or:
324  *
325  *      return log_msg_ret("get", fred_call());
326  *
327  * It is recommended to use <= 3 characters for the name since this will only
328  * use 4 bytes in rodata
329  */
330 #define log_ret(_ret) ({ \
331         int __ret = (_ret); \
332         if (__ret < 0) \
333                 log(LOG_CATEGORY, LOGL_ERR, "returning err=%d\n", __ret); \
334         __ret; \
335         })
336 #define log_msg_ret(_msg, _ret) ({ \
337         int __ret = (_ret); \
338         if (__ret < 0) \
339                 log(LOG_CATEGORY, LOGL_ERR, "%s: returning err=%d\n", _msg, \
340                     __ret); \
341         __ret; \
342         })
343
344 /*
345  * Similar to the above, but any non-zero value is consider an error, not just
346  * values less than 0.
347  */
348 #define log_retz(_ret) ({ \
349         int __ret = (_ret); \
350         if (__ret) \
351                 log(LOG_CATEGORY, LOGL_ERR, "returning err=%d\n", __ret); \
352         __ret; \
353         })
354 #define log_msg_retz(_msg, _ret) ({ \
355         int __ret = (_ret); \
356         if (__ret) \
357                 log(LOG_CATEGORY, LOGL_ERR, "%s: returning err=%d\n", _msg, \
358                     __ret); \
359         __ret; \
360         })
361 #else
362 /* Non-logging versions of the above which just return the error code */
363 #define log_ret(_ret) (_ret)
364 #define log_msg_ret(_msg, _ret) ((void)(_msg), _ret)
365 #define log_retz(_ret) (_ret)
366 #define log_msg_retz(_msg, _ret) ((void)(_msg), _ret)
367 #endif
368
369 /** * enum log_rec_flags - Flags for a log record */
370 enum log_rec_flags {
371         /** @LOGRECF_FORCE_DEBUG: Force output of debug record */
372         LOGRECF_FORCE_DEBUG     = BIT(0),
373         /** @LOGRECF_CONT: Continuation of previous log record */
374         LOGRECF_CONT            = BIT(1),
375 };
376
377 /**
378  * struct log_rec - a single log record
379  *
380  * Holds information about a single record in the log
381  *
382  * Members marked as 'not allocated' are stored as pointers and the caller is
383  * responsible for making sure that the data pointed to is not overwritten.
384  * Members marked as 'allocated' are allocated (e.g. via strdup()) by the log
385  * system.
386  *
387  * TODO(sjg@chromium.org): Compress this struct down a bit to reduce space, e.g.
388  * a single u32 for cat, level, line and force_debug
389  *
390  * @cat: Category, representing a uclass or part of U-Boot
391  * @level: Severity level, less severe is higher
392  * @line: Line number where the log record was generated
393  * @flags: Flags for log record (enum log_rec_flags)
394  * @file: Name of file where the log record was generated (not allocated)
395  * @func: Function where the log record was generated (not allocated)
396  * @msg: Log message (allocated)
397  */
398 struct log_rec {
399         enum log_category_t cat;
400         enum log_level_t level;
401         u16 line;
402         u8 flags;
403         const char *file;
404         const char *func;
405         const char *msg;
406 };
407
408 struct log_device;
409
410 enum log_device_flags {
411         LOGDF_ENABLE            = BIT(0),       /* Device is enabled */
412 };
413
414 /**
415  * struct log_driver - a driver which accepts and processes log records
416  *
417  * @name: Name of driver
418  * @emit: Method to call to emit a log record via this device
419  * @flags: Initial value for flags (use LOGDF_ENABLE to enable on start-up)
420  */
421 struct log_driver {
422         const char *name;
423
424         /**
425          * @emit: emit a log record
426          *
427          * Called by the log system to pass a log record to a particular driver
428          * for processing. The filter is checked before calling this function.
429          */
430         int (*emit)(struct log_device *ldev, struct log_rec *rec);
431         unsigned short flags;
432 };
433
434 /**
435  * struct log_device - an instance of a log driver
436  *
437  * Since drivers are set up at build-time we need to have a separate device for
438  * the run-time aspects of drivers (currently just a list of filters to apply
439  * to records send to this device).
440  *
441  * @next_filter_num: Sequence number of next filter filter added (0=no filters
442  *      yet). This increments with each new filter on the device, but never
443  *      decrements
444  * @flags: Flags for this filter (enum log_device_flags)
445  * @drv: Pointer to driver for this device
446  * @filter_head: List of filters for this device
447  * @sibling_node: Next device in the list of all devices
448  */
449 struct log_device {
450         unsigned short next_filter_num;
451         unsigned short flags;
452         struct log_driver *drv;
453         struct list_head filter_head;
454         struct list_head sibling_node;
455 };
456
457 enum {
458         LOGF_MAX_CATEGORIES = 5,        /* maximum categories per filter */
459 };
460
461 /**
462  * enum log_filter_flags - Flags which modify a filter
463  */
464 enum log_filter_flags {
465         /** @LOGFF_HAS_CAT: Filter has a category list */
466         LOGFF_HAS_CAT   = 1 << 0,
467         /** @LOGFF_DENY: Filter denies matching messages */
468         LOGFF_DENY      = 1 << 1,
469         /** @LOGFF_LEVEL_MIN: Filter's level is a minimum, not a maximum */
470         LOGFF_LEVEL_MIN = 1 << 2,
471 };
472
473 /**
474  * struct log_filter - criteria to filter out log messages
475  *
476  * If a message matches all criteria, then it is allowed. If LOGFF_DENY is set,
477  * then it is denied instead.
478  *
479  * @filter_num: Sequence number of this filter.  This is returned when adding a
480  *      new filter, and must be provided when removing a previously added
481  *      filter.
482  * @flags: Flags for this filter (``LOGFF_...``)
483  * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
484  *      then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
485  *      can be provided
486  * @level: Maximum (or minimum, if %LOGFF_MIN_LEVEL) log level to allow
487  * @file_list: List of files to allow, separated by comma. If NULL then all
488  *      files are permitted
489  * @sibling_node: Next filter in the list of filters for this log device
490  */
491 struct log_filter {
492         int filter_num;
493         int flags;
494         enum log_category_t cat_list[LOGF_MAX_CATEGORIES];
495         enum log_level_t level;
496         const char *file_list;
497         struct list_head sibling_node;
498 };
499
500 #define LOG_DRIVER(_name) \
501         ll_entry_declare(struct log_driver, _name, log_driver)
502
503 /* Get a pointer to a given driver */
504 #define LOG_GET_DRIVER(__name)                                          \
505         ll_entry_get(struct log_driver, __name, log_driver)
506
507 /**
508  * log_get_cat_name() - Get the name of a category
509  *
510  * @cat: Category to look up
511  * Return: category name (which may be a uclass driver name) if found, or
512  *         "<invalid>" if invalid, or "<missing>" if not found. All error
513  *         responses begin with '<'.
514  */
515 const char *log_get_cat_name(enum log_category_t cat);
516
517 /**
518  * log_get_cat_by_name() - Look up a category by name
519  *
520  * @name: Name to look up
521  * Return: Category, or %LOGC_NONE if not found
522  */
523 enum log_category_t log_get_cat_by_name(const char *name);
524
525 /**
526  * log_get_level_name() - Get the name of a log level
527  *
528  * @level: Log level to look up
529  * Return: Log level name (in ALL CAPS)
530  */
531 const char *log_get_level_name(enum log_level_t level);
532
533 /**
534  * log_get_level_by_name() - Look up a log level by name
535  *
536  * @name: Name to look up
537  * Return: Log level, or %LOGL_NONE if not found
538  */
539 enum log_level_t log_get_level_by_name(const char *name);
540
541 /**
542  * log_device_find_by_name() - Look up a log device by its driver's name
543  *
544  * @drv_name: Name of the driver
545  * Return: the log device, or %NULL if not found
546  */
547 struct log_device *log_device_find_by_name(const char *drv_name);
548
549 /**
550  * log_has_cat() - check if a log category exists within a list
551  *
552  * @cat_list: List of categories to check, at most %LOGF_MAX_CATEGORIES entries
553  *      long, terminated by %LC_END if fewer
554  * @cat: Category to search for
555  *
556  * Return: ``true`` if @cat is in @cat_list, else ``false``
557  */
558 bool log_has_cat(enum log_category_t cat_list[], enum log_category_t cat);
559
560 /**
561  * log_has_file() - check if a file is with a list
562  *
563  * @file_list: List of files to check, separated by comma
564  * @file: File to check for. This string is matched against the end of each
565  *      file in the list, i.e. ignoring any preceding path. The list is
566  *      intended to consist of relative pathnames, e.g. common/main.c,cmd/log.c
567  *
568  * Return: ``true`` if @file is in @file_list, else ``false``
569  */
570 bool log_has_file(const char *file_list, const char *file);
571
572 /* Log format flags (bit numbers) for gd->log_fmt. See log_fmt_chars */
573 enum log_fmt {
574         LOGF_CAT        = 0,
575         LOGF_LEVEL,
576         LOGF_FILE,
577         LOGF_LINE,
578         LOGF_FUNC,
579         LOGF_MSG,
580
581         LOGF_COUNT,
582         LOGF_ALL = 0x3f,
583 };
584
585 /* Handle the 'log test' command */
586 int do_log_test(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
587
588 /**
589  * log_add_filter_flags() - Add a new filter to a log device, specifying flags
590  *
591  * @drv_name: Driver name to add the filter to (since each driver only has a
592  *      single device)
593  * @flags: Flags for this filter (``LOGFF_...``)
594  * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
595  *      then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
596  *      can be provided
597  * @level: Maximum (or minimum, if %LOGFF_LEVEL_MIN) log level to allow
598  * @file_list: List of files to allow, separated by comma. If NULL then all
599  *      files are permitted
600  * Return:
601  *   the sequence number of the new filter (>=0) if the filter was added, or a
602  *   -ve value on error
603  */
604 int log_add_filter_flags(const char *drv_name, enum log_category_t cat_list[],
605                          enum log_level_t level, const char *file_list,
606                          int flags);
607
608 /**
609  * log_add_filter() - Add a new filter to a log device
610  *
611  * @drv_name: Driver name to add the filter to (since each driver only has a
612  *      single device)
613  * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
614  *      then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
615  *      can be provided
616  * @max_level: Maximum log level to allow
617  * @file_list: List of files to allow, separated by comma. If %NULL then all
618  *      files are permitted
619  * Return:
620  *   the sequence number of the new filter (>=0) if the filter was added, or a
621  *   -ve value on error
622  */
623 static inline int log_add_filter(const char *drv_name,
624                                  enum log_category_t cat_list[],
625                                  enum log_level_t max_level,
626                                  const char *file_list)
627 {
628         return log_add_filter_flags(drv_name, cat_list, max_level, file_list,
629                                     0);
630 }
631
632 /**
633  * log_remove_filter() - Remove a filter from a log device
634  *
635  * @drv_name: Driver name to remove the filter from (since each driver only has
636  *      a single device)
637  * @filter_num: Filter number to remove (as returned by log_add_filter())
638  * Return:
639  *   0 if the filter was removed, -%ENOENT if either the driver or the filter
640  *   number was not found
641  */
642 int log_remove_filter(const char *drv_name, int filter_num);
643
644 /**
645  * log_device_set_enable() - Enable or disable a log device
646  *
647  * Devices are referenced by their driver, so use LOG_GET_DRIVER(name) to pass
648  * the driver to this function. For example if the driver is declared with
649  * LOG_DRIVER(wibble) then pass LOG_GET_DRIVER(wibble) here.
650  *
651  * @drv: Driver of device to enable
652  * @enable: true to enable, false to disable
653  * Return: 0 if OK, -ENOENT if the driver was not found
654  */
655 int log_device_set_enable(struct log_driver *drv, bool enable);
656
657 #if CONFIG_IS_ENABLED(LOG)
658 /**
659  * log_init() - Set up the log system ready for use
660  *
661  * Return: 0 if OK, -%ENOMEM if out of memory
662  */
663 int log_init(void);
664 #else
665 static inline int log_init(void)
666 {
667         return 0;
668 }
669 #endif
670
671 /**
672  * log_get_default_format() - get default log format
673  *
674  * The default log format is configurable via
675  * %CONFIG_LOGF_FILE, %CONFIG_LOGF_LINE, and %CONFIG_LOGF_FUNC.
676  *
677  * Return:      default log format
678  */
679 static inline int log_get_default_format(void)
680 {
681         return BIT(LOGF_MSG) |
682                (IS_ENABLED(CONFIG_LOGF_FILE) ? BIT(LOGF_FILE) : 0) |
683                (IS_ENABLED(CONFIG_LOGF_LINE) ? BIT(LOGF_LINE) : 0) |
684                (IS_ENABLED(CONFIG_LOGF_FUNC) ? BIT(LOGF_FUNC) : 0);
685 }
686
687 #endif