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 74ecca339SDan Handley #ifndef __DEBUG_H__ 84ecca339SDan Handley #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__ 29*93c78ed2SAntonio Nino Diaz #include <cdefs.h> 302d7e8282SSoby Mathew #include <stdarg.h> 311319e7b1SSoby Mathew #include <stdio.h> 32289c28a8SDan Handley 337f56e9a3SSoby Mathew /* 347f56e9a3SSoby Mathew * Define Log Markers corresponding to each log level which will 357f56e9a3SSoby Mathew * be embedded in the format string and is expected by tf_log() to determine 367f56e9a3SSoby Mathew * the log level. 377f56e9a3SSoby Mathew */ 387f56e9a3SSoby Mathew #define LOG_MARKER_ERROR "\xa" /* 10 */ 397f56e9a3SSoby Mathew #define LOG_MARKER_NOTICE "\x14" /* 20 */ 407f56e9a3SSoby Mathew #define LOG_MARKER_WARNING "\x1e" /* 30 */ 417f56e9a3SSoby Mathew #define LOG_MARKER_INFO "\x28" /* 40 */ 427f56e9a3SSoby Mathew #define LOG_MARKER_VERBOSE "\x32" /* 50 */ 437f56e9a3SSoby Mathew 44cf24229eSSandrine Bailleux /* 45cf24229eSSandrine Bailleux * If the log output is too low then this macro is used in place of tf_log() 46cf24229eSSandrine Bailleux * below. The intent is to get the compiler to evaluate the function call for 47cf24229eSSandrine Bailleux * type checking and format specifier correctness but let it optimize it out. 48cf24229eSSandrine Bailleux */ 49cf24229eSSandrine Bailleux #define no_tf_log(fmt, ...) \ 50cf24229eSSandrine Bailleux do { \ 51cf24229eSSandrine Bailleux if (0) { \ 52cf24229eSSandrine Bailleux tf_log(fmt, ##__VA_ARGS__); \ 53cf24229eSSandrine Bailleux } \ 54cf24229eSSandrine Bailleux } while (0) 55cf24229eSSandrine Bailleux 56289c28a8SDan Handley #if LOG_LEVEL >= LOG_LEVEL_NOTICE 577f56e9a3SSoby Mathew # define NOTICE(...) tf_log(LOG_MARKER_NOTICE __VA_ARGS__) 584ecca339SDan Handley #else 59cf24229eSSandrine Bailleux # define NOTICE(...) no_tf_log(LOG_MARKER_NOTICE __VA_ARGS__) 60289c28a8SDan Handley #endif 61289c28a8SDan Handley 62289c28a8SDan Handley #if LOG_LEVEL >= LOG_LEVEL_ERROR 637f56e9a3SSoby Mathew # define ERROR(...) tf_log(LOG_MARKER_ERROR __VA_ARGS__) 64289c28a8SDan Handley #else 65cf24229eSSandrine Bailleux # define ERROR(...) no_tf_log(LOG_MARKER_ERROR __VA_ARGS__) 66289c28a8SDan Handley #endif 67289c28a8SDan Handley 68289c28a8SDan Handley #if LOG_LEVEL >= LOG_LEVEL_WARNING 697f56e9a3SSoby Mathew # define WARN(...) tf_log(LOG_MARKER_WARNING __VA_ARGS__) 70289c28a8SDan Handley #else 71cf24229eSSandrine Bailleux # define WARN(...) no_tf_log(LOG_MARKER_WARNING __VA_ARGS__) 724ecca339SDan Handley #endif 734ecca339SDan Handley 74289c28a8SDan Handley #if LOG_LEVEL >= LOG_LEVEL_INFO 757f56e9a3SSoby Mathew # define INFO(...) tf_log(LOG_MARKER_INFO __VA_ARGS__) 76289c28a8SDan Handley #else 77cf24229eSSandrine Bailleux # define INFO(...) no_tf_log(LOG_MARKER_INFO __VA_ARGS__) 78289c28a8SDan Handley #endif 79289c28a8SDan Handley 80289c28a8SDan Handley #if LOG_LEVEL >= LOG_LEVEL_VERBOSE 817f56e9a3SSoby Mathew # define VERBOSE(...) tf_log(LOG_MARKER_VERBOSE __VA_ARGS__) 82289c28a8SDan Handley #else 83cf24229eSSandrine Bailleux # define VERBOSE(...) no_tf_log(LOG_MARKER_VERBOSE __VA_ARGS__) 84289c28a8SDan Handley #endif 85289c28a8SDan Handley 86c6bc0710SDan Handley void __dead2 do_panic(void); 87a43d431bSSoby Mathew #define panic() do_panic() 88a43d431bSSoby Mathew 8951faada7SDouglas Raillard /* Function called when stack protection check code detects a corrupted stack */ 9051faada7SDouglas Raillard void __dead2 __stack_chk_fail(void); 9151faada7SDouglas Raillard 927f56e9a3SSoby Mathew void tf_log(const char *fmt, ...) __printflike(1, 2); 93dad25049SSandrine Bailleux void tf_printf(const char *fmt, ...) __printflike(1, 2); 94da5241cbSAntonio Nino Diaz int tf_snprintf(char *s, size_t n, const char *fmt, ...) __printflike(3, 4); 952d7e8282SSoby Mathew void tf_vprintf(const char *fmt, va_list args); 962d7e8282SSoby Mathew void tf_string_print(const char *str); 977f56e9a3SSoby Mathew void tf_log_set_max_level(unsigned int log_level); 98b79af934SSoby Mathew 991319e7b1SSoby Mathew #endif /* __ASSEMBLY__ */ 1004ecca339SDan Handley #endif /* __DEBUG_H__ */ 101