1 /*
2  * Copyright (C) 2017 ALLWINNERTECH TECHNOLOGY CO., LTD. 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
6  *  are met:
7  *    1. Redistributions of source code must retain the above copyright
8  *       notice, this list of conditions and the following disclaimer.
9  *    2. Redistributions in binary form must reproduce the above copyright
10  *       notice, this list of conditions and the following disclaimer in the
11  *       documentation and/or other materials provided with the
12  *       distribution.
13  *    3. Neither the name of ALLWINNERTECH TECHNOLOGY CO., LTD. nor the names of
14  *       its contributors may be used to endorse or promote products derived
15  *       from this software without specific prior written permission.
16  *
17  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29 
30 #ifndef _OS_DEBUG_H_
31 #define _OS_DEBUG_H_
32 
33 #include <stdio.h>
34 #include <hal_debug.h>
35 
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39 
40 #ifndef __CONFIG_BOOTLOADER
41 
42 #define OS_DBG_ON           0
43 #define OS_WRN_ON           1
44 #define OS_ERR_ON           1
45 #define OS_ABORT_ON         0
46 
47 #define OS_HANDLE_CHECK     1
48 #define OS_RESOURCE_TRACE   1 /* trace OS resource or not */
49 
50 #else /* __CONFIG_BOOTLOADER */
51 
52 #define OS_DBG_ON           1
53 #define OS_WRN_ON           1
54 #define OS_ERR_ON           1
55 #define OS_ABORT_ON         1
56 
57 #define OS_HANDLE_CHECK     1
58 #define OS_RESOURCE_TRACE   1 /* trace OS resource or not */
59 
60 #endif /* __CONFIG_BOOTLOADER */
61 
62 #define OS_SYSLOG       printf
63 #define OS_ABORT()      hal_sys_abort()
64 #define OS_PANIC()      exception_panic(__FILE__, __func__, __LINE__)
65 
66 /* Define (sn)printf formatters for some types */
67 #define OS_BASETYPE_F   "ld"
68 #define OS_HANDLE_F     "p"
69 #define OS_TIME_F       "u"
70 
71 #define OS_LOG(flags, fmt, arg...)  \
72     do {                            \
73         if (flags)                  \
74             OS_SYSLOG(fmt, ##arg);  \
75     } while (0)
76 
77 #define OS_DBG(fmt, arg...)     OS_LOG(OS_DBG_ON, "[os] "fmt, ##arg)
78 #define OS_WRN(fmt, arg...)     OS_LOG(OS_WRN_ON, "[os W] "fmt, ##arg)
79 #define OS_ERR(fmt, arg...)                         \
80     do {                                            \
81         OS_LOG(OS_ERR_ON, "[os E] %s():%d, "fmt,    \
82                __func__, __LINE__, ##arg);          \
83         if (OS_ABORT_ON)                            \
84             OS_ABORT();                             \
85     } while (0)
86 
87 #define OS_HANDLE_ASSERT(exp, handle)               \
88     if (OS_HANDLE_CHECK && !(exp)) {                \
89         OS_ERR("handle %"OS_HANDLE_F"\n", handle);  \
90         return OS_E_PARAM;                          \
91     }
92 
93 extern void exception_panic(const char *file, const char *func, const int line);
94 
95 #ifdef __cplusplus
96 }
97 #endif
98 
99 #endif /* _OS_DEBUG_H_ */
100