xref: /rk3399_ARM-atf/include/common/debug.h (revision c6bc071020baebc660fc94390b50bc240e34c0a3)
1 /*
2  * Copyright (c) 2013-2014, 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 #include <stdio.h>
35 
36 /* If building the project with DEBUG disabled the INFO and WARN macros
37  * won't produce any output. The ERROR macro is always enabled.
38  * The format expected is the same as for printf().
39  * INFO("Info %s.\n", "message")    -> INFO: Info message.
40  * WARN("Warning %s.\n", "message") -> WARN: Warning message.
41  * ERROR("Error %s.\n", "message")  -> ERROR: Error message.
42  *
43  * TODO : add debug levels.
44  */
45 #if DEBUG
46  #define INFO(...)	printf("INFO: " __VA_ARGS__)
47  #define WARN(...)	printf("WARN: " __VA_ARGS__)
48 #else
49  #define INFO(...)
50  #define WARN(...)
51 #endif
52 
53 #define ERROR(...)	printf("ERROR: " __VA_ARGS__)
54 
55 
56 /* For the moment this Panic function is very basic, Report an error and
57  * spin. This can be expanded in the future to provide more information.
58  */
59 #if DEBUG
60 void __dead2 do_panic(const char *file, int line);
61 #define panic()	do_panic(__FILE__, __LINE__)
62 
63 #else
64 void __dead2 do_panic(void);
65 #define panic()	do_panic()
66 
67 #endif
68 
69 void print_string_value(char *s, unsigned long *mem);
70 
71 #endif /* __DEBUG_H__ */
72