14ecca339SDan Handley /* 2cf24229eSSandrine Bailleux * Copyright (c) 2013-2018, ARM Limited and Contributors. All rights reserved. 34ecca339SDan Handley * 482cb2c1aSdp-arm * SPDX-License-Identifier: BSD-3-Clause 54ecca339SDan Handley */ 64ecca339SDan Handley 7870ce3ddSAntonio Nino Diaz #ifndef DEBUG_H 8870ce3ddSAntonio Nino Diaz #define DEBUG_H 94ecca339SDan Handley 10cf24229eSSandrine Bailleux /* 11cf24229eSSandrine Bailleux * The log output macros print output to the console. These macros produce 12289c28a8SDan Handley * compiled log output only if the LOG_LEVEL defined in the makefile (or the 13289c28a8SDan Handley * make command line) is greater or equal than the level required for that 14289c28a8SDan Handley * type of log output. 15cf24229eSSandrine Bailleux * 16289c28a8SDan Handley * The format expected is the same as for printf(). For example: 174ecca339SDan Handley * INFO("Info %s.\n", "message") -> INFO: Info message. 18289c28a8SDan Handley * WARN("Warning %s.\n", "message") -> WARNING: Warning message. 194ecca339SDan Handley */ 20289c28a8SDan Handley 21289c28a8SDan Handley #define LOG_LEVEL_NONE 0 22289c28a8SDan Handley #define LOG_LEVEL_ERROR 10 23289c28a8SDan Handley #define LOG_LEVEL_NOTICE 20 24289c28a8SDan Handley #define LOG_LEVEL_WARNING 30 25289c28a8SDan Handley #define LOG_LEVEL_INFO 40 26289c28a8SDan Handley #define LOG_LEVEL_VERBOSE 50 27289c28a8SDan Handley 281319e7b1SSoby Mathew #ifndef __ASSEMBLY__ 2993c78ed2SAntonio Nino Diaz #include <cdefs.h> 30*3e530d8eSAntonio Nino Diaz #include <console.h> 312d7e8282SSoby Mathew #include <stdarg.h> 32*3e530d8eSAntonio Nino Diaz #include <stdbool.h> 331319e7b1SSoby Mathew #include <stdio.h> 34289c28a8SDan Handley 357f56e9a3SSoby Mathew /* 367f56e9a3SSoby Mathew * Define Log Markers corresponding to each log level which will 377f56e9a3SSoby Mathew * be embedded in the format string and is expected by tf_log() to determine 387f56e9a3SSoby Mathew * the log level. 397f56e9a3SSoby Mathew */ 407f56e9a3SSoby Mathew #define LOG_MARKER_ERROR "\xa" /* 10 */ 417f56e9a3SSoby Mathew #define LOG_MARKER_NOTICE "\x14" /* 20 */ 427f56e9a3SSoby Mathew #define LOG_MARKER_WARNING "\x1e" /* 30 */ 437f56e9a3SSoby Mathew #define LOG_MARKER_INFO "\x28" /* 40 */ 447f56e9a3SSoby Mathew #define LOG_MARKER_VERBOSE "\x32" /* 50 */ 457f56e9a3SSoby Mathew 46cf24229eSSandrine Bailleux /* 47cf24229eSSandrine Bailleux * If the log output is too low then this macro is used in place of tf_log() 48cf24229eSSandrine Bailleux * below. The intent is to get the compiler to evaluate the function call for 49cf24229eSSandrine Bailleux * type checking and format specifier correctness but let it optimize it out. 50cf24229eSSandrine Bailleux */ 51cf24229eSSandrine Bailleux #define no_tf_log(fmt, ...) \ 52cf24229eSSandrine Bailleux do { \ 53cf24229eSSandrine Bailleux if (0) { \ 54cf24229eSSandrine Bailleux tf_log(fmt, ##__VA_ARGS__); \ 55cf24229eSSandrine Bailleux } \ 56cf24229eSSandrine Bailleux } while (0) 57cf24229eSSandrine Bailleux 58289c28a8SDan Handley #if LOG_LEVEL >= LOG_LEVEL_NOTICE 597f56e9a3SSoby Mathew # define NOTICE(...) tf_log(LOG_MARKER_NOTICE __VA_ARGS__) 604ecca339SDan Handley #else 61cf24229eSSandrine Bailleux # define NOTICE(...) no_tf_log(LOG_MARKER_NOTICE __VA_ARGS__) 62289c28a8SDan Handley #endif 63289c28a8SDan Handley 64289c28a8SDan Handley #if LOG_LEVEL >= LOG_LEVEL_ERROR 657f56e9a3SSoby Mathew # define ERROR(...) tf_log(LOG_MARKER_ERROR __VA_ARGS__) 66289c28a8SDan Handley #else 67cf24229eSSandrine Bailleux # define ERROR(...) no_tf_log(LOG_MARKER_ERROR __VA_ARGS__) 68289c28a8SDan Handley #endif 69289c28a8SDan Handley 70289c28a8SDan Handley #if LOG_LEVEL >= LOG_LEVEL_WARNING 717f56e9a3SSoby Mathew # define WARN(...) tf_log(LOG_MARKER_WARNING __VA_ARGS__) 72289c28a8SDan Handley #else 73cf24229eSSandrine Bailleux # define WARN(...) no_tf_log(LOG_MARKER_WARNING __VA_ARGS__) 744ecca339SDan Handley #endif 754ecca339SDan Handley 76289c28a8SDan Handley #if LOG_LEVEL >= LOG_LEVEL_INFO 777f56e9a3SSoby Mathew # define INFO(...) tf_log(LOG_MARKER_INFO __VA_ARGS__) 78289c28a8SDan Handley #else 79cf24229eSSandrine Bailleux # define INFO(...) no_tf_log(LOG_MARKER_INFO __VA_ARGS__) 80289c28a8SDan Handley #endif 81289c28a8SDan Handley 82289c28a8SDan Handley #if LOG_LEVEL >= LOG_LEVEL_VERBOSE 837f56e9a3SSoby Mathew # define VERBOSE(...) tf_log(LOG_MARKER_VERBOSE __VA_ARGS__) 84289c28a8SDan Handley #else 85cf24229eSSandrine Bailleux # define VERBOSE(...) no_tf_log(LOG_MARKER_VERBOSE __VA_ARGS__) 86289c28a8SDan Handley #endif 87289c28a8SDan Handley 880c62883fSDouglas Raillard #if ENABLE_BACKTRACE 890c62883fSDouglas Raillard void backtrace(const char *cookie); 900c62883fSDouglas Raillard #else 910c62883fSDouglas Raillard #define backtrace(x) 920c62883fSDouglas Raillard #endif 930c62883fSDouglas Raillard 94c6bc0710SDan Handley void __dead2 do_panic(void); 95*3e530d8eSAntonio Nino Diaz 96*3e530d8eSAntonio Nino Diaz #define panic() \ 97*3e530d8eSAntonio Nino Diaz do { \ 98*3e530d8eSAntonio Nino Diaz backtrace(__func__); \ 99*3e530d8eSAntonio Nino Diaz (void)console_flush(); \ 100*3e530d8eSAntonio Nino Diaz do_panic(); \ 101*3e530d8eSAntonio Nino Diaz } while (false) 102a43d431bSSoby Mathew 10351faada7SDouglas Raillard /* Function called when stack protection check code detects a corrupted stack */ 10451faada7SDouglas Raillard void __dead2 __stack_chk_fail(void); 10551faada7SDouglas Raillard 1067f56e9a3SSoby Mathew void tf_log(const char *fmt, ...) __printflike(1, 2); 1077f56e9a3SSoby Mathew void tf_log_set_max_level(unsigned int log_level); 108b79af934SSoby Mathew 1091319e7b1SSoby Mathew #endif /* __ASSEMBLY__ */ 110870ce3ddSAntonio Nino Diaz #endif /* DEBUG_H */ 111