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