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