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