First version
[3rdparty/ote_partner/tlk.git] / include / debug.h
1 /*
2  * Copyright (c) 2008-2012 Travis Geiselbrecht
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining
5  * a copy of this software and associated documentation files
6  * (the "Software"), to deal in the Software without restriction,
7  * including without limitation the rights to use, copy, modify, merge,
8  * publish, distribute, sublicense, and/or sell copies of the Software,
9  * and to permit persons to whom the Software is furnished to do so,
10  * subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be
13  * included in all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
18  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
19  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
20  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
21  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22  */
23 #ifndef __DEBUG_H
24 #define __DEBUG_H
25
26 #include <stdarg.h>
27 #include <stddef.h>
28 #include <compiler.h>
29 #include <platform/debug.h>
30 #include <printf.h>
31
32 __BEGIN_CDECLS
33
34 /*
35  * It defines the debug level and restricts the number of prints that
36  * is to be printed in release or debug builds.
37  */
38 #if defined(DEBUG)
39 #define DEBUGLEVEL DEBUG
40 #else
41 #define DEBUGLEVEL 2
42 #endif
43
44 /* Various logging output mechanisms */
45
46 /* debug levels */
47 #define CRITICAL 0
48 #define ALWAYS 0
49 #define INFO 1
50 #define SPEW 2
51
52 /* Shared buffer size */
53 #define EARLYBUF_SIZE 4096
54
55 struct circular_buffer {
56         uint32_t size; /* Indicates the total size of the buffer */
57         uint32_t start; /* Starting point of valid data in buffer */
58         uint32_t end; /* First character which is empty (can be written to) */
59         uint32_t overflow; /* Indicator whether buffer has overflown or not */
60         nsaddr_t buf;
61 };
62
63 extern char early_logbuf[EARLYBUF_SIZE];
64 extern int early_char_count;
65
66 #if !DISABLE_DEBUG_OUTPUT
67
68 /* input/output */
69 #define _dputc(c) platform_dputc(c)
70 int _dputs(const char *str);
71 int _dprintf(const char *fmt, ...) __PRINTFLIKE(1, 2);
72 int _dvprintf(const char *fmt, va_list ap);
73
74 /* dump memory */
75 void hexdump(const void *ptr, size_t len);
76 void hexdump8(const void *ptr, size_t len);
77
78 #else
79
80 /* input/output */
81 static inline void _dputc(char c) { }
82 static inline int _dputs(const char *str) { return 0; }
83 static inline int __PRINTFLIKE(1, 2) _dprintf(const char *fmt, ...) { return 0; }
84 static inline int _dvprintf(const char *fmt, va_list ap) { return 0; }
85
86 /* dump memory */
87 static inline void hexdump(const void *ptr, size_t len) { }
88 static inline void hexdump8(const void *ptr, size_t len) { }
89
90 #endif /* DISABLE_DEBUG_OUTPUT */
91
92 #define dputc(level, str) do { if ((level) <= DEBUGLEVEL) { _dputc(str); } } while (0)
93 #define dputs(level, str) do { if ((level) <= DEBUGLEVEL) { _dputs(str); } } while (0)
94 #define dprintf(level, x...) do { if ((level) <= DEBUGLEVEL) { _dprintf(x); } } while (0)
95 #define dvprintf(level, x...) do { if ((level) <= DEBUGLEVEL) { _dvprintf(x); } } while (0)
96
97 /* trace routines */
98 #define TRACE_ENTRY printf("%s: entry\n", __PRETTY_FUNCTION__)
99 #define TRACE_EXIT printf("%s: exit\n", __PRETTY_FUNCTION__)
100 #define TRACE_ENTRY_OBJ printf("%s: entry obj %p\n", __PRETTY_FUNCTION__, this)
101 #define TRACE_EXIT_OBJ printf("%s: exit obj %p\n", __PRETTY_FUNCTION__, this)
102 #define TRACE printf("%s:%d\n", __PRETTY_FUNCTION__, __LINE__)
103 #define TRACEF(str, x...) do { printf("%s:%d: " str, __PRETTY_FUNCTION__, __LINE__, ## x); } while (0)
104
105 /* trace routines that work if LOCAL_TRACE is set */
106 #define LTRACE_ENTRY do { if (LOCAL_TRACE) { TRACE_ENTRY; } } while (0)
107 #define LTRACE_EXIT do { if (LOCAL_TRACE) { TRACE_EXIT; } } while (0)
108 #define LTRACE do { if (LOCAL_TRACE) { TRACE; } } while (0)
109 #define LTRACEF(x...) do { if (LOCAL_TRACE) { TRACEF(x); } } while (0)
110
111 /* systemwide halts */
112 void halt(void) __NO_RETURN;
113
114 void _panic(void *caller, const char *fmt, ...) __PRINTFLIKE(2, 3) __NO_RETURN;
115 #define panic(x...) _panic(__GET_CALLER(), x)
116
117 #define PANIC_UNIMPLEMENTED panic("%s unimplemented\n", __PRETTY_FUNCTION__)
118
119 /* spin the cpu for a period of (short) time */
120 void spin(uint32_t usecs);
121
122 __END_CDECLS
123
124 #endif