mirror of
https://github.com/ARM-software/arm-trusted-firmware.git
synced 2025-04-25 22:35:42 +00:00
7f56e9a31c
This patch gives users control over logging messages printed from the C code using the LOG macros defined in debug.h Users now have the ability to reduce the log_level at run time using the tf_log_set_max_level() function. The default prefix string can be defined by platform by overriding the `plat_log_get_prefix()` platform API which is also introduced in this patch. The new log framework results in saving of some RO data. For example, when BL1 is built for FVP with LOG_LEVEL=LOG_LEVEL_VERBOSE, resulted in saving 384 bytes of RO data and increase of 8 bytes of RW data. The framework also adds about 108 bytes of code to the release build of FVP. Fixes ARM-software/tf-issues#462 Change-Id: I476013d9c3deedfdd4c8b0b0f125665ba6250554 Co-authored-by: Eleanor Bonnici <Eleanor.bonnici@arm.com> Signed-off-by: Soby Mathew <soby.mathew@arm.com>
85 lines
2.4 KiB
C
85 lines
2.4 KiB
C
/*
|
|
* Copyright (c) 2013-2017, ARM Limited and Contributors. All rights reserved.
|
|
*
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
*/
|
|
|
|
#ifndef __DEBUG_H__
|
|
#define __DEBUG_H__
|
|
|
|
/* The log output macros print output to the console. These macros produce
|
|
* compiled log output only if the LOG_LEVEL defined in the makefile (or the
|
|
* make command line) is greater or equal than the level required for that
|
|
* type of log output.
|
|
* The format expected is the same as for printf(). For example:
|
|
* INFO("Info %s.\n", "message") -> INFO: Info message.
|
|
* WARN("Warning %s.\n", "message") -> WARNING: Warning message.
|
|
*/
|
|
|
|
#define LOG_LEVEL_NONE 0
|
|
#define LOG_LEVEL_ERROR 10
|
|
#define LOG_LEVEL_NOTICE 20
|
|
#define LOG_LEVEL_WARNING 30
|
|
#define LOG_LEVEL_INFO 40
|
|
#define LOG_LEVEL_VERBOSE 50
|
|
|
|
#ifndef __ASSEMBLY__
|
|
#include <stdarg.h>
|
|
#include <stdio.h>
|
|
|
|
/*
|
|
* Define Log Markers corresponding to each log level which will
|
|
* be embedded in the format string and is expected by tf_log() to determine
|
|
* the log level.
|
|
*/
|
|
#define LOG_MARKER_ERROR "\xa" /* 10 */
|
|
#define LOG_MARKER_NOTICE "\x14" /* 20 */
|
|
#define LOG_MARKER_WARNING "\x1e" /* 30 */
|
|
#define LOG_MARKER_INFO "\x28" /* 40 */
|
|
#define LOG_MARKER_VERBOSE "\x32" /* 50 */
|
|
|
|
#if LOG_LEVEL >= LOG_LEVEL_NOTICE
|
|
# define NOTICE(...) tf_log(LOG_MARKER_NOTICE __VA_ARGS__)
|
|
#else
|
|
# define NOTICE(...)
|
|
#endif
|
|
|
|
#if LOG_LEVEL >= LOG_LEVEL_ERROR
|
|
# define ERROR(...) tf_log(LOG_MARKER_ERROR __VA_ARGS__)
|
|
#else
|
|
# define ERROR(...)
|
|
#endif
|
|
|
|
#if LOG_LEVEL >= LOG_LEVEL_WARNING
|
|
# define WARN(...) tf_log(LOG_MARKER_WARNING __VA_ARGS__)
|
|
#else
|
|
# define WARN(...)
|
|
#endif
|
|
|
|
#if LOG_LEVEL >= LOG_LEVEL_INFO
|
|
# define INFO(...) tf_log(LOG_MARKER_INFO __VA_ARGS__)
|
|
#else
|
|
# define INFO(...)
|
|
#endif
|
|
|
|
#if LOG_LEVEL >= LOG_LEVEL_VERBOSE
|
|
# define VERBOSE(...) tf_log(LOG_MARKER_VERBOSE __VA_ARGS__)
|
|
#else
|
|
# define VERBOSE(...)
|
|
#endif
|
|
|
|
void __dead2 do_panic(void);
|
|
#define panic() do_panic()
|
|
|
|
/* Function called when stack protection check code detects a corrupted stack */
|
|
void __dead2 __stack_chk_fail(void);
|
|
|
|
void tf_log(const char *fmt, ...) __printflike(1, 2);
|
|
void tf_printf(const char *fmt, ...) __printflike(1, 2);
|
|
int tf_snprintf(char *s, size_t n, const char *fmt, ...) __printflike(3, 4);
|
|
void tf_vprintf(const char *fmt, va_list args);
|
|
void tf_string_print(const char *str);
|
|
void tf_log_set_max_level(unsigned int log_level);
|
|
|
|
#endif /* __ASSEMBLY__ */
|
|
#endif /* __DEBUG_H__ */
|