xref: /rk3399_ARM-atf/include/common/debug.h (revision 51faada71a219a8b94cd8d8e423f0f22e9da4d8f)
1 /*
2  * Copyright (c) 2013-2017, ARM Limited and Contributors. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * Redistributions of source code must retain the above copyright notice, this
8  * list of conditions and the following disclaimer.
9  *
10  * Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  *
14  * Neither the name of ARM nor the names of its contributors may be used
15  * to endorse or promote products derived from this software without specific
16  * prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 #ifndef __DEBUG_H__
32 #define __DEBUG_H__
33 
34 /* The log output macros print output to the console. These macros produce
35  * compiled log output only if the LOG_LEVEL defined in the makefile (or the
36  * make command line) is greater or equal than the level required for that
37  * type of log output.
38  * The format expected is the same as for printf(). For example:
39  * INFO("Info %s.\n", "message")    -> INFO:    Info message.
40  * WARN("Warning %s.\n", "message") -> WARNING: Warning message.
41  */
42 
43 #define LOG_LEVEL_NONE			0
44 #define LOG_LEVEL_ERROR			10
45 #define LOG_LEVEL_NOTICE		20
46 #define LOG_LEVEL_WARNING		30
47 #define LOG_LEVEL_INFO			40
48 #define LOG_LEVEL_VERBOSE		50
49 
50 #ifndef __ASSEMBLY__
51 #include <stdio.h>
52 
53 #if LOG_LEVEL >= LOG_LEVEL_NOTICE
54 # define NOTICE(...)	tf_printf("NOTICE:  " __VA_ARGS__)
55 #else
56 # define NOTICE(...)
57 #endif
58 
59 #if LOG_LEVEL >= LOG_LEVEL_ERROR
60 # define ERROR(...)	tf_printf("ERROR:   " __VA_ARGS__)
61 #else
62 # define ERROR(...)
63 #endif
64 
65 #if LOG_LEVEL >= LOG_LEVEL_WARNING
66 # define WARN(...)	tf_printf("WARNING: " __VA_ARGS__)
67 #else
68 # define WARN(...)
69 #endif
70 
71 #if LOG_LEVEL >= LOG_LEVEL_INFO
72 # define INFO(...)	tf_printf("INFO:    " __VA_ARGS__)
73 #else
74 # define INFO(...)
75 #endif
76 
77 #if LOG_LEVEL >= LOG_LEVEL_VERBOSE
78 # define VERBOSE(...)	tf_printf("VERBOSE: " __VA_ARGS__)
79 #else
80 # define VERBOSE(...)
81 #endif
82 
83 
84 void __dead2 do_panic(void);
85 #define panic()	do_panic()
86 
87 /* Function called when stack protection check code detects a corrupted stack */
88 void __dead2 __stack_chk_fail(void);
89 
90 void tf_printf(const char *fmt, ...) __printflike(1, 2);
91 
92 #endif /* __ASSEMBLY__ */
93 #endif /* __DEBUG_H__ */
94