U-Boot currently has fairly rudimentary logging features. A basic printf() provides console output and debug() provides debug output which is activated if DEBUG is defined in the file containing the debug() statements.
It would be useful to have a few more features:
- control of debug output at runtime, so problems can potentially be debugged without recompiling U-Boot - control of which subsystems output debug information, so that (for example) it is possible to enable debugging for MMC or SATA at runtime - indication of severity with each message, so that the user can control whether just errors are displayed, warnings, or all debug messages - sending logging information to different destinations, such as console, memory, linux, etc,
At present U-Boot has a logbuffer feature which records output in a memory buffer for later display or storage. This is useful but is not at present enabled for any board.
This series introduced a new logging system which supports: - various log levels from panic to debug - log categories including all uclasses and a few others - log drivers to which all log records can be sent - log filters which control which log records make it to which drivers
Enabling logging with the default options does not add much to code size. By default the maximum recorded log level is LOGL_INFO, meaning that debug messages (and above) are discarded a build-time. Increasing this level provides more run-time flexibility to enable/disable logging at the cost of increased code size.
This feature is by no means finished. The README provides a long list of features and clean-ups that could be done. But hopefully this is a starting point for improving this important area in U-Boot.
The series is available at u-boot-dm/log-working
Changes in v4: - Add an extra tab in the debug_cond() macro - Add new patch to correct use of debug() in usb_hub.c - Handle casting uclass ID to lgo category (for clang)
Changes in v3: - Rebase to master
Changes in v2: - Add a comment as to why CONFIG_LOG_MAX_LEVEL is not defined - Change log levels to match new header - Change sandbox log level to 6 - Drop MAINTAINERS entries for files not added by this patch - Drop the special log() functions from the README - Drop the use of 'continue' in the macro - Fix LOG_SPL_MAX_LEVEL typo (should be SPL_LOG_MAX_LEVEL) - Fix function called when test command is selected - Fix help output for 'log test' - Fix up bad use of #if CONFIG_VAL() - use #ifdef instead - Line up log levels with Linux - Only execute log tests if CONFIG_LOG is enabled - Rename LOGL_WARN to LOGL_WARNING - Split pre-console address change into a separate patch - Update commit message to explain that this is not just for serial output
Simon Glass (15): Revert "sandbox: remove os_putc() and os_puts()" sandbox: Adjust pre-console address to avoid conflict Revert "sandbox: Drop special case console code for sandbox" Move debug and logging support to a separate header mtdparts: Correct use of debug() usb: Correct use of debug() Drop the log buffer log: Add an implementation of logging log: Add a console driver log: Add a 'log level' command log: Add a test command log: Plumb logging into the init sequence log: sandbox: Enable logging log: test: Add a pytest for logging log: Add documentation
MAINTAINERS | 9 ++ arch/sandbox/cpu/os.c | 11 ++ cmd/Kconfig | 8 + cmd/Makefile | 2 +- cmd/log.c | 326 +++++--------------------------------- cmd/mtdparts.c | 3 - common/Kconfig | 86 ++++++++++ common/Makefile | 2 + common/board_f.c | 23 +-- common/board_r.c | 27 +--- common/console.c | 7 + common/image.c | 9 -- common/log.c | 245 ++++++++++++++++++++++++++++ common/log_console.c | 23 +++ common/stdio.c | 6 - common/usb_hub.c | 4 +- configs/sandbox_defconfig | 5 +- doc/README.log | 214 +++++++++++++++++++++++++ include/asm-generic/global_data.h | 8 +- include/common.h | 46 +----- include/log.h | 304 +++++++++++++++++++++++++++++++++++ include/logbuff.h | 49 ------ include/os.h | 20 +++ include/post.h | 4 +- post/post.c | 9 -- post/tests.c | 4 - scripts/config_whitelist.txt | 1 - test/Makefile | 1 + test/log/Makefile | 7 + test/log/log_test.c | 205 ++++++++++++++++++++++++ test/py/tests/test_log.py | 101 ++++++++++++ 31 files changed, 1304 insertions(+), 465 deletions(-) create mode 100644 common/log.c create mode 100644 common/log_console.c create mode 100644 doc/README.log create mode 100644 include/log.h delete mode 100644 include/logbuff.h create mode 100644 test/log/Makefile create mode 100644 test/log/log_test.c create mode 100644 test/py/tests/test_log.py