| Imre Kis | d8b3120 | 2020-01-28 15:24:06 +0100 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright (c) 2013-2018, ARM Limited and Contributors. All rights reserved. |
| 3 | * |
| 4 | * SPDX-License-Identifier: BSD-3-Clause |
| 5 | */ |
| 6 | |
| 7 | #ifndef DEBUG_H |
| 8 | #define DEBUG_H |
| 9 | |
| 10 | #include <lib/utils_def.h> |
| 11 | |
| 12 | /* |
| 13 | * The log output macros print output to the console. These macros produce |
| 14 | * compiled log output only if the LOG_LEVEL defined in the makefile (or the |
| 15 | * make command line) is greater or equal than the level required for that |
| 16 | * type of log output. |
| 17 | * |
| 18 | * The format expected is the same as for printf(). For example: |
| 19 | * INFO("Info %s.\n", "message") -> INFO: Info message. |
| 20 | * WARN("Warning %s.\n", "message") -> WARNING: Warning message. |
| 21 | */ |
| 22 | |
| 23 | #define LOG_LEVEL_NONE U(0) |
| 24 | #define LOG_LEVEL_ERROR U(10) |
| 25 | #define LOG_LEVEL_NOTICE U(20) |
| 26 | #define LOG_LEVEL_WARNING U(30) |
| 27 | #define LOG_LEVEL_INFO U(40) |
| 28 | #define LOG_LEVEL_VERBOSE U(50) |
| 29 | |
| 30 | #ifndef __ASSEMBLER__ |
| 31 | |
| 32 | #include <cdefs.h> |
| 33 | #include <stdarg.h> |
| 34 | #include <stdbool.h> |
| 35 | #include <stdio.h> |
| 36 | |
| 37 | #include <drivers/console.h> |
| 38 | |
| 39 | /* |
| 40 | * Define Log Markers corresponding to each log level which will |
| 41 | * be embedded in the format string and is expected by tf_log() to determine |
| 42 | * the log level. |
| 43 | */ |
| 44 | #define LOG_MARKER_ERROR "\xa" /* 10 */ |
| 45 | #define LOG_MARKER_NOTICE "\x14" /* 20 */ |
| 46 | #define LOG_MARKER_WARNING "\x1e" /* 30 */ |
| 47 | #define LOG_MARKER_INFO "\x28" /* 40 */ |
| 48 | #define LOG_MARKER_VERBOSE "\x32" /* 50 */ |
| 49 | |
| 50 | /* |
| 51 | * If the log output is too low then this macro is used in place of tf_log() |
| 52 | * below. The intent is to get the compiler to evaluate the function call for |
| 53 | * type checking and format specifier correctness but let it optimize it out. |
| 54 | */ |
| 55 | #define no_tf_log(fmt, ...) \ |
| 56 | do { \ |
| 57 | if (false) { \ |
| 58 | tf_log(fmt, ##__VA_ARGS__); \ |
| 59 | } \ |
| 60 | } while (false) |
| 61 | |
| 62 | #if LOG_LEVEL >= LOG_LEVEL_ERROR |
| 63 | # define ERROR(...) tf_log(LOG_MARKER_ERROR __VA_ARGS__) |
| 64 | #else |
| 65 | # define ERROR(...) no_tf_log(LOG_MARKER_ERROR __VA_ARGS__) |
| 66 | #endif |
| 67 | |
| 68 | #if LOG_LEVEL >= LOG_LEVEL_NOTICE |
| 69 | # define NOTICE(...) tf_log(LOG_MARKER_NOTICE __VA_ARGS__) |
| 70 | #else |
| 71 | # define NOTICE(...) no_tf_log(LOG_MARKER_NOTICE __VA_ARGS__) |
| 72 | #endif |
| 73 | |
| 74 | #if LOG_LEVEL >= LOG_LEVEL_WARNING |
| 75 | # define WARN(...) tf_log(LOG_MARKER_WARNING __VA_ARGS__) |
| 76 | #else |
| 77 | # define WARN(...) no_tf_log(LOG_MARKER_WARNING __VA_ARGS__) |
| 78 | #endif |
| 79 | |
| 80 | #if LOG_LEVEL >= LOG_LEVEL_INFO |
| 81 | # define INFO(...) tf_log(LOG_MARKER_INFO __VA_ARGS__) |
| 82 | #else |
| 83 | # define INFO(...) no_tf_log(LOG_MARKER_INFO __VA_ARGS__) |
| 84 | #endif |
| 85 | |
| 86 | #if LOG_LEVEL >= LOG_LEVEL_VERBOSE |
| 87 | # define VERBOSE(...) tf_log(LOG_MARKER_VERBOSE __VA_ARGS__) |
| 88 | #else |
| 89 | # define VERBOSE(...) no_tf_log(LOG_MARKER_VERBOSE __VA_ARGS__) |
| 90 | #endif |
| 91 | |
| 92 | #if ENABLE_BACKTRACE |
| 93 | void backtrace(const char *cookie); |
| 94 | #else |
| 95 | #define backtrace(x) |
| 96 | #endif |
| 97 | |
| 98 | void __dead2 do_panic(void); |
| 99 | |
| 100 | #define panic() \ |
| 101 | do { \ |
| 102 | backtrace(__func__); \ |
| 103 | (void)console_flush(); \ |
| 104 | do_panic(); \ |
| 105 | } while (false) |
| 106 | |
| 107 | /* Function called when stack protection check code detects a corrupted stack */ |
| 108 | void __dead2 __stack_chk_fail(void); |
| 109 | |
| 110 | void tf_log(const char *fmt, ...) __printflike(1, 2); |
| 111 | void tf_log_set_max_level(unsigned int log_level); |
| 112 | |
| 113 | #endif /* __ASSEMBLER__ */ |
| 114 | #endif /* DEBUG_H */ |