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