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 !_DEBUG && CONFIG_IS_ENABLED(LOG)
226  
227  #define debug_cond(cond, fmt, args...)			\
228  ({							\
229  	log(LOG_CATEGORY, LOGL_DEBUG, fmt, ##args);	\
230  })
231  
232  #else /* _DEBUG */
233  
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   */
239  #define debug_cond(cond, fmt, args...)		\
240  ({						\
241  	if (cond)				\
242  		printf(pr_fmt(fmt), ##args);	\
243  })
244  
245  #endif /* _DEBUG */
246  
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);
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   */
278  #define assert(x) \
279  	({ if (!(x) && _DEBUG) \
280  		__assert_fail(#x, __FILE__, __LINE__, __func__); })
281  
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   *
287   * Return: true if assertion succeeded (condition is true), else false
288   */
289  #define assert_noisy(x) \
290  	({ bool _val = (x); \
291  	if (!_val) \
292  		__assert_fail(#x, "?", __LINE__, __func__); \
293  	_val; \
294  	})
295  
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   */
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  	})
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  	})
319  #else
320  /* Non-logging versions of the above which just return the error code */
321  #define log_ret(_ret) (_ret)
322  #define log_msg_ret(_msg, _ret) ((void)(_msg), _ret)
323  #endif
324  
325  /**
326   * struct log_rec - a single log record
327   *
328   * Holds information about a single record in the log
329   *
330   * Members marked as 'not allocated' are stored as pointers and the caller is
331   * responsible for making sure that the data pointed to is not overwritten.
332   * Members marked as 'allocated' are allocated (e.g. via strdup()) by the log
333   * system.
334   *
335   * TODO(sjg@chromium.org): Compress this struct down a bit to reduce space, e.g.
336   * a single u32 for cat, level, line and force_debug
337   *
338   * @cat: Category, representing a uclass or part of U-Boot
339   * @level: Severity level, less severe is higher
340   * @force_debug: Force output of debug
341   * @file: Name of file where the log record was generated (not allocated)
342   * @line: Line number where the log record was generated
343   * @func: Function where the log record was generated (not allocated)
344   * @msg: Log message (allocated)
345   */
346  struct log_rec {
347  	enum log_category_t cat;
348  	enum log_level_t level;
349  	bool force_debug;
350  	const char *file;
351  	int line;
352  	const char *func;
353  	const char *msg;
354  };
355  
356  struct log_device;
357  
358  enum log_device_flags {
359  	LOGDF_ENABLE		= BIT(0),	/* Device is enabled */
360  };
361  
362  /**
363   * struct log_driver - a driver which accepts and processes log records
364   *
365   * @name: Name of driver
366   * @emit: Method to call to emit a log record via this device
367   * @flags: Initial value for flags (use LOGDF_ENABLE to enable on start-up)
368   */
369  struct log_driver {
370  	const char *name;
371  
372  	/**
373  	 * @emit: emit a log record
374  	 *
375  	 * Called by the log system to pass a log record to a particular driver
376  	 * for processing. The filter is checked before calling this function.
377  	 */
378  	int (*emit)(struct log_device *ldev, struct log_rec *rec);
379  	unsigned short flags;
380  };
381  
382  /**
383   * struct log_device - an instance of a log driver
384   *
385   * Since drivers are set up at build-time we need to have a separate device for
386   * the run-time aspects of drivers (currently just a list of filters to apply
387   * to records send to this device).
388   *
389   * @next_filter_num: Sequence number of next filter filter added (0=no filters
390   *	yet). This increments with each new filter on the device, but never
391   *	decrements
392   * @flags: Flags for this filter (enum log_device_flags)
393   * @drv: Pointer to driver for this device
394   * @filter_head: List of filters for this device
395   * @sibling_node: Next device in the list of all devices
396   */
397  struct log_device {
398  	unsigned short next_filter_num;
399  	unsigned short flags;
400  	struct log_driver *drv;
401  	struct list_head filter_head;
402  	struct list_head sibling_node;
403  };
404  
405  enum {
406  	LOGF_MAX_CATEGORIES = 5,	/* maximum categories per filter */
407  };
408  
409  /**
410   * enum log_filter_flags - Flags which modify a filter
411   */
412  enum log_filter_flags {
413  	/** @LOGFF_HAS_CAT: Filter has a category list */
414  	LOGFF_HAS_CAT	= 1 << 0,
415  	/** @LOGFF_DENY: Filter denies matching messages */
416  	LOGFF_DENY	= 1 << 1,
417  	/** @LOGFF_LEVEL_MIN: Filter's level is a minimum, not a maximum */
418  	LOGFF_LEVEL_MIN = 1 << 2,
419  };
420  
421  /**
422   * struct log_filter - criteria to filter out log messages
423   *
424   * If a message matches all criteria, then it is allowed. If LOGFF_DENY is set,
425   * then it is denied instead.
426   *
427   * @filter_num: Sequence number of this filter.  This is returned when adding a
428   *	new filter, and must be provided when removing a previously added
429   *	filter.
430   * @flags: Flags for this filter (``LOGFF_...``)
431   * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
432   *	then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
433   *	can be provided
434   * @level: Maximum (or minimum, if %LOGFF_MIN_LEVEL) log level to allow
435   * @file_list: List of files to allow, separated by comma. If NULL then all
436   *	files are permitted
437   * @sibling_node: Next filter in the list of filters for this log device
438   */
439  struct log_filter {
440  	int filter_num;
441  	int flags;
442  	enum log_category_t cat_list[LOGF_MAX_CATEGORIES];
443  	enum log_level_t level;
444  	const char *file_list;
445  	struct list_head sibling_node;
446  };
447  
448  #define LOG_DRIVER(_name) \
449  	ll_entry_declare(struct log_driver, _name, log_driver)
450  
451  /* Get a pointer to a given driver */
452  #define LOG_GET_DRIVER(__name)						\
453  	ll_entry_get(struct log_driver, __name, log_driver)
454  
455  /**
456   * log_get_cat_name() - Get the name of a category
457   *
458   * @cat: Category to look up
459   * Return: category name (which may be a uclass driver name) if found, or
460   *	   "<invalid>" if invalid, or "<missing>" if not found. All error
461   *	   responses begin with '<'.
462   */
463  const char *log_get_cat_name(enum log_category_t cat);
464  
465  /**
466   * log_get_cat_by_name() - Look up a category by name
467   *
468   * @name: Name to look up
469   * Return: Category, or %LOGC_NONE if not found
470   */
471  enum log_category_t log_get_cat_by_name(const char *name);
472  
473  /**
474   * log_get_level_name() - Get the name of a log level
475   *
476   * @level: Log level to look up
477   * Return: Log level name (in ALL CAPS)
478   */
479  const char *log_get_level_name(enum log_level_t level);
480  
481  /**
482   * log_get_level_by_name() - Look up a log level by name
483   *
484   * @name: Name to look up
485   * Return: Log level, or %LOGL_NONE if not found
486   */
487  enum log_level_t log_get_level_by_name(const char *name);
488  
489  /**
490   * log_device_find_by_name() - Look up a log device by its driver's name
491   *
492   * @drv_name: Name of the driver
493   * Return: the log device, or %NULL if not found
494   */
495  struct log_device *log_device_find_by_name(const char *drv_name);
496  
497  /**
498   * log_has_cat() - check if a log category exists within a list
499   *
500   * @cat_list: List of categories to check, at most %LOGF_MAX_CATEGORIES entries
501   *	long, terminated by %LC_END if fewer
502   * @cat: Category to search for
503   *
504   * Return: ``true`` if @cat is in @cat_list, else ``false``
505   */
506  bool log_has_cat(enum log_category_t cat_list[], enum log_category_t cat);
507  
508  /**
509   * log_has_file() - check if a file is with a list
510   *
511   * @file_list: List of files to check, separated by comma
512   * @file: File to check for. This string is matched against the end of each
513   *	file in the list, i.e. ignoring any preceding path. The list is
514   *	intended to consist of relative pathnames, e.g. common/main.c,cmd/log.c
515   *
516   * Return: ``true`` if @file is in @file_list, else ``false``
517   */
518  bool log_has_file(const char *file_list, const char *file);
519  
520  /* Log format flags (bit numbers) for gd->log_fmt. See log_fmt_chars */
521  enum log_fmt {
522  	LOGF_CAT	= 0,
523  	LOGF_LEVEL,
524  	LOGF_FILE,
525  	LOGF_LINE,
526  	LOGF_FUNC,
527  	LOGF_MSG,
528  
529  	LOGF_COUNT,
530  	LOGF_ALL = 0x3f,
531  };
532  
533  /* Handle the 'log test' command */
534  int do_log_test(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
535  
536  /**
537   * log_add_filter_flags() - Add a new filter to a log device, specifying flags
538   *
539   * @drv_name: Driver name to add the filter to (since each driver only has a
540   *	single device)
541   * @flags: Flags for this filter (``LOGFF_...``)
542   * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
543   *	then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
544   *	can be provided
545   * @level: Maximum (or minimum, if %LOGFF_LEVEL_MIN) log level to allow
546   * @file_list: List of files to allow, separated by comma. If NULL then all
547   *	files are permitted
548   * Return:
549   *   the sequence number of the new filter (>=0) if the filter was added, or a
550   *   -ve value on error
551   */
552  int log_add_filter_flags(const char *drv_name, enum log_category_t cat_list[],
553  			 enum log_level_t level, const char *file_list,
554  			 int flags);
555  
556  /**
557   * log_add_filter() - Add a new filter to a log device
558   *
559   * @drv_name: Driver name to add the filter to (since each driver only has a
560   *	single device)
561   * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
562   *	then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
563   *	can be provided
564   * @max_level: Maximum log level to allow
565   * @file_list: List of files to allow, separated by comma. If %NULL then all
566   *	files are permitted
567   * Return:
568   *   the sequence number of the new filter (>=0) if the filter was added, or a
569   *   -ve value on error
570   */
log_add_filter(const char * drv_name,enum log_category_t cat_list[],enum log_level_t max_level,const char * file_list)571  static inline int log_add_filter(const char *drv_name,
572  				 enum log_category_t cat_list[],
573  				 enum log_level_t max_level,
574  				 const char *file_list)
575  {
576  	return log_add_filter_flags(drv_name, cat_list, max_level, file_list,
577  				    0);
578  }
579  
580  /**
581   * log_remove_filter() - Remove a filter from a log device
582   *
583   * @drv_name: Driver name to remove the filter from (since each driver only has
584   *	a single device)
585   * @filter_num: Filter number to remove (as returned by log_add_filter())
586   * Return:
587   *   0 if the filter was removed, -%ENOENT if either the driver or the filter
588   *   number was not found
589   */
590  int log_remove_filter(const char *drv_name, int filter_num);
591  
592  /**
593   * log_device_set_enable() - Enable or disable a log device
594   *
595   * Devices are referenced by their driver, so use LOG_GET_DRIVER(name) to pass
596   * the driver to this function. For example if the driver is declared with
597   * LOG_DRIVER(wibble) then pass LOG_GET_DRIVER(wibble) here.
598   *
599   * @drv: Driver of device to enable
600   * @enable: true to enable, false to disable
601   * @return 0 if OK, -ENOENT if the driver was not found
602   */
603  int log_device_set_enable(struct log_driver *drv, bool enable);
604  
605  #if CONFIG_IS_ENABLED(LOG)
606  /**
607   * log_init() - Set up the log system ready for use
608   *
609   * Return: 0 if OK, -%ENOMEM if out of memory
610   */
611  int log_init(void);
612  #else
log_init(void)613  static inline int log_init(void)
614  {
615  	return 0;
616  }
617  #endif
618  
619  /**
620   * log_get_default_format() - get default log format
621   *
622   * The default log format is configurable via
623   * %CONFIG_LOGF_FILE, %CONFIG_LOGF_LINE, and %CONFIG_LOGF_FUNC.
624   *
625   * Return:	default log format
626   */
log_get_default_format(void)627  static inline int log_get_default_format(void)
628  {
629  	return BIT(LOGF_MSG) |
630  	       (IS_ENABLED(CONFIG_LOGF_FILE) ? BIT(LOGF_FILE) : 0) |
631  	       (IS_ENABLED(CONFIG_LOGF_LINE) ? BIT(LOGF_LINE) : 0) |
632  	       (IS_ENABLED(CONFIG_LOGF_FUNC) ? BIT(LOGF_FUNC) : 0);
633  }
634  
635  #endif
636