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