SimpleLink Host Driver  0.0.5.1
 All Data Structures Functions Variables Groups
trace.h
1 /*
2  * trace.h - CC31xx/CC32xx Host Driver Implementation
3  *
4  * Copyright (C) 2014 Texas Instruments Incorporated - http://www.ti.com/
5  *
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  *
14  * Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in the
16  * documentation and/or other materials provided with the
17  * distribution.
18  *
19  * Neither the name of Texas Instruments Incorporated nor the names of
20  * its contributors may be used to endorse or promote products derived
21  * from this software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34  *
35 */
36 
37 
38 
39 #include "simplelink.h"
40 
41 #ifndef __SIMPLELINK_TRACE_H__
42 #define __SIMPLELINK_TRACE_H__
43 
44 
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48 
49 #define SL_SYNC_SCAN_THRESHOLD (( UINT32 )2000)
50 
51 
52 //*****************************************************************************
53 //
54 //*****************************************************************************
55 #define _SlDrvAssert(line ) { while(1); }
56 
57 #define _SL_ASSERT(expr) { if(!(expr)){_SlDrvAssert(__LINE__); } }
58 #define _SL_ERROR(expr, error) { if(!(expr)){return (error); } }
59 
60 #define SL_HANDLING_ASSERT 2
61 #define SL_HANDLING_ERROR 1
62 #define SL_HANDLING_NONE 0
63 
64 #define SL_SELF_COND_HANDLING SL_HANDLING_ASSERT
65 #define SL_PROTOCOL_HANDLING SL_HANDLING_ASSERT
66 #define SL_DRV_RET_CODE_HANDLING SL_HANDLING_ASSERT
67 #define SL_NWP_IF_HANDLING SL_HANDLING_ASSERT
68 #define SL_OSI_RET_OK_HANDLING SL_HANDLING_ASSERT
69 #define SL_MALLOC_OK_HANDLING SL_HANDLING_ASSERT
70 #define SL_USER_ARGS_HANDLING SL_HANDLING_ASSERT
71 
72 #if (SL_DRV_RET_CODE_HANDLING == SL_HANDLING_ASSERT)
73 #define VERIFY_RET_OK(Func) {_SlReturnVal_t _RetVal = (Func); _SL_ASSERT((_SlReturnVal_t)SL_OS_RET_CODE_OK == _RetVal)}
74 #elif (SL_DRV_RET_CODE_HANDLING == SL_HANDLING_ERROR)
75 #define VERIFY_RET_OK(Func) {_SlReturnVal_t _RetVal = (Func); if (SL_OS_RET_CODE_OK != _RetVal) return _RetVal;}
76 #else
77 #define VERIFY_RET_OK(Func) (Func);
78 #endif
79 
80 #if (SL_PROTOCOL_HANDLING == SL_HANDLING_ASSERT)
81 #define VERIFY_PROTOCOL(expr) _SL_ASSERT(expr)
82 #elif (SL_PROTOCOL_HANDLING == SL_HANDLING_ERROR)
83 #define VERIFY_PROTOCOL(expr) _SL_ERROR(expr, SL_RET_CODE_PROTOCOL_ERROR)
84 #else
85 #define VERIFY_PROTOCOL(expr)
86 #endif
87 
88 #if (defined(PROTECT_SOCKET_ASYNC_RESP) && (SL_SELF_COND_HANDLING == SL_HANDLING_ASSERT))
89 #define VERIFY_SOCKET_CB(expr) _SL_ASSERT(expr)
90 #elif (defined(PROTECT_SOCKET_ASYNC_RESP) && (SL_SELF_COND_HANDLING == SL_HANDLING_ERROR))
91 #define VERIFY_SOCKET_CB(expr) _SL_ERROR(expr, SL_RET_CODE_SELF_ERROR)
92 #else
93 #define VERIFY_SOCKET_CB(expr)
94 #endif
95 
96 #if (SL_NWP_IF_HANDLING == SL_HANDLING_ASSERT)
97 #define NWP_IF_WRITE_CHECK(fd,pBuff,len) { int RetSize, ExpSize = (len); RetSize = sl_IfWrite((fd),(pBuff),ExpSize); _SL_ASSERT(ExpSize == RetSize)}
98 #define NWP_IF_READ_CHECK(fd,pBuff,len) { int RetSize, ExpSize = (len); RetSize = sl_IfRead((fd),(pBuff),ExpSize); _SL_ASSERT(ExpSize == RetSize)}
99 #elif (SL_NWP_IF_HANDLING == SL_HANDLING_ERROR)
100 #define NWP_IF_WRITE_CHECK(fd,pBuff,len) { _SL_ERROR((len == sl_IfWrite((fd),(pBuff),(len))), SL_RET_CODE_NWP_IF_ERROR);}
101 #define NWP_IF_READ_CHECK(fd,pBuff,len) { _SL_ERROR((len == sl_IfRead((fd),(pBuff),(len))), SL_RET_CODE_NWP_IF_ERROR);}
102 #else
103 #define NWP_IF_WRITE_CHECK(fd,pBuff,len) { sl_IfWrite((fd),(pBuff),(len));}
104 #define NWP_IF_READ_CHECK(fd,pBuff,len) { sl_IfRead((fd),(pBuff),(len));}
105 #endif
106 
107 #if (SL_OSI_RET_OK_HANDLING == SL_HANDLING_ASSERT)
108 #define OSI_RET_OK_CHECK(Func) {_SlReturnVal_t _RetVal = (Func); _SL_ASSERT((_SlReturnVal_t)SL_OS_RET_CODE_OK == _RetVal)}
109 #elif (SL_OSI_RET_OK_HANDLING == SL_HANDLING_ERROR)
110 #define OSI_RET_OK_CHECK(Func) {_SlReturnVal_t _RetVal = (Func); if (SL_OS_RET_CODE_OK != _RetVal) return _RetVal;}
111 #else
112 #define OSI_RET_OK_CHECK(Func) (Func);
113 #endif
114 
115 #if (SL_MALLOC_OK_HANDLING == SL_HANDLING_ASSERT)
116 #define MALLOC_OK_CHECK(Ptr) _SL_ASSERT(NULL != Ptr)
117 #elif (SL_MALLOC_OK_HANDLING == SL_HANDLING_ERROR)
118 #define MALLOC_OK_CHECK(Ptr) _SL_ERROR((NULL != Ptr), SL_RET_CODE_MALLOC_ERROR)
119 #else
120 #define MALLOC_OK_CHECK(Ptr)
121 #endif
122 
123 #ifdef SL_INC_ARG_CHECK
124 
125 #if (SL_USER_ARGS_HANDLING == SL_HANDLING_ASSERT)
126 #define ARG_CHECK_PTR(Ptr) _SL_ASSERT(NULL != Ptr)
127 #elif (SL_USER_ARGS_HANDLING == SL_HANDLING_ERROR)
128 #define ARG_CHECK_PTR(Ptr) _SL_ERROR((NULL != Ptr), SL_RET_CODE_INVALID_INPUT)
129 #else
130 #define ARG_CHECK_PTR(Ptr)
131 #endif
132 
133 #else
134 #define ARG_CHECK_PTR(Ptr)
135 #endif
136 
137 //#define SL_DBG_TRACE_ENABLE
138 #ifdef SL_DBG_TRACE_ENABLE
139 #define SL_TRACE0(level,msg_id,str) printf(str)
140 #define SL_TRACE1(level,msg_id,str,p1) printf(str,(p1))
141 #define SL_TRACE2(level,msg_id,str,p1,p2) printf(str,(p1),(p2))
142 #define SL_TRACE3(level,msg_id,str,p1,p2,p3) printf(str,(p1),(p2),(p3))
143 #define SL_TRACE4(level,msg_id,str,p1,p2,p3,p4) printf(str,(p1),(p2),(p3),(p4))
144 #define SL_ERROR_TRACE(msg_id,str) printf(str)
145 #define SL_ERROR_TRACE1(msg_id,str,p1) printf(str,(p1))
146 #define SL_ERROR_TRACE2(msg_id,str,p1,p2) printf(str,(p1),(p2))
147 #define SL_ERROR_TRACE3(msg_id,str,p1,p2,p3) printf(str,(p1),(p2),(p3))
148 #define SL_ERROR_TRACE4(msg_id,str,p1,p2,p3,p4) printf(str,(p1),(p2),(p3),(p4))
149 #define SL_TRACE_FLUSH()
150 #else
151 #define SL_TRACE0(level,msg_id,str)
152 #define SL_TRACE1(level,msg_id,str,p1)
153 #define SL_TRACE2(level,msg_id,str,p1,p2)
154 #define SL_TRACE3(level,msg_id,str,p1,p2,p3)
155 #define SL_TRACE4(level,msg_id,str,p1,p2,p3,p4)
156 #define SL_ERROR_TRACE(msg_id,str)
157 #define SL_ERROR_TRACE1(msg_id,str,p1)
158 #define SL_ERROR_TRACE2(msg_id,str,p1,p2)
159 #define SL_ERROR_TRACE3(msg_id,str,p1,p2,p3)
160 #define SL_ERROR_TRACE4(msg_id,str,p1,p2,p3,p4)
161 #define SL_TRACE_FLUSH()
162 #endif
163 
164 //#define SL_DBG_CNT_ENABLE
165 #ifdef SL_DBG_CNT_ENABLE
166 #define _SL_DBG_CNT_INC(Cnt) g_DbgCnt. ## Cnt++
167 #define _SL_DBG_SYNC_LOG(index,value) {if(index < SL_DBG_SYNC_LOG_SIZE){*(UINT32 *)&g_DbgCnt.SyncLog[index] = *(UINT32 *)(value);}}
168 
169 #else
170 #define _SL_DBG_CNT_INC(Cnt)
171 #define _SL_DBG_SYNC_LOG(index,value)
172 #endif
173 
174 #define SL_DBG_LEVEL_1 1
175 #define SL_DBG_LEVEL_2 2
176 #define SL_DBG_LEVEL_3 4
177 #define SL_DBG_LEVEL_MASK (SL_DBG_LEVEL_2|SL_DBG_LEVEL_3)
178 
179 #define SL_INCLUDE_DBG_FUNC(Name) ((Name ## _DBG_LEVEL) & SL_DBG_LEVEL_MASK)
180 
181 #define _SlDrvPrintStat_DBG_LEVEL SL_DBG_LEVEL_3
182 #define _SlDrvOtherFunc_DBG_LEVEL SL_DBG_LEVEL_1
183 
184 #ifdef __cplusplus
185 }
186 #endif
187 
188 
189 #endif //__SIMPLELINK_TRACE_H__