blob: a14a66e859e1e883dbad1f3f35a820dce26f172d [file] [log] [blame]
Harry Liebel57bb6582013-12-19 13:30:58 +00001/*
Sandrine Bailleuxbf789e72018-06-20 14:50:48 +02002 * Copyright (c) 2013-2018, ARM Limited and Contributors. All rights reserved.
Harry Liebel57bb6582013-12-19 13:30:58 +00003 *
dp-armfa3cf0b2017-05-03 09:38:09 +01004 * SPDX-License-Identifier: BSD-3-Clause
Harry Liebel57bb6582013-12-19 13:30:58 +00005 */
6
Antonio Nino Diazc0c8eb62018-08-15 17:02:28 +01007#ifndef DEBUG_H
8#define DEBUG_H
Harry Liebel57bb6582013-12-19 13:30:58 +00009
Antonio Nino Diaz14fabd02018-08-28 11:44:44 +010010#include <utils_def.h>
11
Sandrine Bailleuxbf789e72018-06-20 14:50:48 +020012/*
13 * The log output macros print output to the console. These macros produce
Dan Handleycba2c502014-08-08 14:36:42 +010014 * 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.
Sandrine Bailleuxbf789e72018-06-20 14:50:48 +020017 *
Dan Handleycba2c502014-08-08 14:36:42 +010018 * 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.
Harry Liebel57bb6582013-12-19 13:30:58 +000021 */
Dan Handleycba2c502014-08-08 14:36:42 +010022
Antonio Nino Diaz14fabd02018-08-28 11:44:44 +010023#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)
Dan Handleycba2c502014-08-08 14:36:42 +010029
Soby Mathew6b28c572016-03-21 10:36:47 +000030#ifndef __ASSEMBLY__
Antonio Nino Diaz4b32e622018-08-16 16:52:57 +010031#include <cdefs.h>
Antonio Nino Diazd5876462018-08-23 15:13:58 +010032#include <console.h>
Soby Mathewf583a062017-09-04 11:45:52 +010033#include <stdarg.h>
Antonio Nino Diazd5876462018-08-23 15:13:58 +010034#include <stdbool.h>
Soby Mathew6b28c572016-03-21 10:36:47 +000035#include <stdio.h>
Dan Handleycba2c502014-08-08 14:36:42 +010036
Soby Mathewaaf15f52017-09-04 11:49:29 +010037/*
38 * Define Log Markers corresponding to each log level which will
39 * be embedded in the format string and is expected by tf_log() to determine
40 * the log level.
41 */
42#define LOG_MARKER_ERROR "\xa" /* 10 */
43#define LOG_MARKER_NOTICE "\x14" /* 20 */
44#define LOG_MARKER_WARNING "\x1e" /* 30 */
45#define LOG_MARKER_INFO "\x28" /* 40 */
46#define LOG_MARKER_VERBOSE "\x32" /* 50 */
47
Sandrine Bailleuxbf789e72018-06-20 14:50:48 +020048/*
49 * If the log output is too low then this macro is used in place of tf_log()
50 * below. The intent is to get the compiler to evaluate the function call for
51 * type checking and format specifier correctness but let it optimize it out.
52 */
53#define no_tf_log(fmt, ...) \
54 do { \
Antonio Nino Diaz14fabd02018-08-28 11:44:44 +010055 if (false) { \
Sandrine Bailleuxbf789e72018-06-20 14:50:48 +020056 tf_log(fmt, ##__VA_ARGS__); \
57 } \
Antonio Nino Diaz14fabd02018-08-28 11:44:44 +010058 } while (false)
Sandrine Bailleuxbf789e72018-06-20 14:50:48 +020059
Dan Handleycba2c502014-08-08 14:36:42 +010060#if LOG_LEVEL >= LOG_LEVEL_ERROR
Soby Mathewaaf15f52017-09-04 11:49:29 +010061# define ERROR(...) tf_log(LOG_MARKER_ERROR __VA_ARGS__)
Dan Handleycba2c502014-08-08 14:36:42 +010062#else
Sandrine Bailleuxbf789e72018-06-20 14:50:48 +020063# define ERROR(...) no_tf_log(LOG_MARKER_ERROR __VA_ARGS__)
Dan Handleycba2c502014-08-08 14:36:42 +010064#endif
65
John Tsichritzise75b9a52018-09-07 14:42:09 +010066#if LOG_LEVEL >= LOG_LEVEL_NOTICE
67# define NOTICE(...) tf_log(LOG_MARKER_NOTICE __VA_ARGS__)
68#else
69# define NOTICE(...) no_tf_log(LOG_MARKER_NOTICE __VA_ARGS__)
70#endif
71
Dan Handleycba2c502014-08-08 14:36:42 +010072#if LOG_LEVEL >= LOG_LEVEL_WARNING
Soby Mathewaaf15f52017-09-04 11:49:29 +010073# define WARN(...) tf_log(LOG_MARKER_WARNING __VA_ARGS__)
Dan Handleycba2c502014-08-08 14:36:42 +010074#else
Sandrine Bailleuxbf789e72018-06-20 14:50:48 +020075# define WARN(...) no_tf_log(LOG_MARKER_WARNING __VA_ARGS__)
Dan Handleycba2c502014-08-08 14:36:42 +010076#endif
77
78#if LOG_LEVEL >= LOG_LEVEL_INFO
Soby Mathewaaf15f52017-09-04 11:49:29 +010079# define INFO(...) tf_log(LOG_MARKER_INFO __VA_ARGS__)
Dan Handleycba2c502014-08-08 14:36:42 +010080#else
Sandrine Bailleuxbf789e72018-06-20 14:50:48 +020081# define INFO(...) no_tf_log(LOG_MARKER_INFO __VA_ARGS__)
Dan Handleycba2c502014-08-08 14:36:42 +010082#endif
83
84#if LOG_LEVEL >= LOG_LEVEL_VERBOSE
Soby Mathewaaf15f52017-09-04 11:49:29 +010085# define VERBOSE(...) tf_log(LOG_MARKER_VERBOSE __VA_ARGS__)
Harry Liebel57bb6582013-12-19 13:30:58 +000086#else
Sandrine Bailleuxbf789e72018-06-20 14:50:48 +020087# define VERBOSE(...) no_tf_log(LOG_MARKER_VERBOSE __VA_ARGS__)
Harry Liebel57bb6582013-12-19 13:30:58 +000088#endif
89
Douglas Raillard77414632018-08-21 12:54:45 +010090#if ENABLE_BACKTRACE
91void backtrace(const char *cookie);
92#else
93#define backtrace(x)
94#endif
95
Dan Handleya17fefa2014-05-14 12:38:32 +010096void __dead2 do_panic(void);
Antonio Nino Diazd5876462018-08-23 15:13:58 +010097
98#define panic() \
99 do { \
100 backtrace(__func__); \
101 (void)console_flush(); \
102 do_panic(); \
103 } while (false)
Soby Mathew5e5c2072014-04-07 15:28:55 +0100104
Douglas Raillard306593d2017-02-24 18:14:15 +0000105/* Function called when stack protection check code detects a corrupted stack */
106void __dead2 __stack_chk_fail(void);
107
Soby Mathewaaf15f52017-09-04 11:49:29 +0100108void tf_log(const char *fmt, ...) __printflike(1, 2);
Soby Mathewaaf15f52017-09-04 11:49:29 +0100109void tf_log_set_max_level(unsigned int log_level);
Soby Mathewafe7e2f2014-06-12 17:23:58 +0100110
Soby Mathew6b28c572016-03-21 10:36:47 +0000111#endif /* __ASSEMBLY__ */
Antonio Nino Diazc0c8eb62018-08-15 17:02:28 +0100112#endif /* DEBUG_H */