1 /*
2  * trace.h - CC31xx/CC32xx Host Driver Implementation
3  *
4  * Copyright (C) 2017 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 <ti/drivers/net/wifi/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 /*****************************************************************************/
50 /* Macro declarations                                                        */
51 /*****************************************************************************/
52 
53 #define SL_SYNC_SCAN_THRESHOLD  (( _u32 )2000)
54 
55 #define _SlDrvAssert() _SlDrvHandleFatalError(SL_DEVICE_EVENT_FATAL_DRIVER_ABORT, 0, 0)
56 
57 #define _SL_ASSERT(expr)              {if(!(expr)){ _SlDrvAssert();}}
58 #define _SL_ERROR(expr, error)        {if(!(expr)){return (error);}}
59 
60 #define _SL_ASSERT_ERROR(expr, error) {if(!(expr)){_SlDrvAssert(); return (error);}}
61 
62 #define SL_HANDLING_ASSERT          2
63 #define SL_HANDLING_ERROR           1
64 #define SL_HANDLING_NONE            0
65 
66 #define SL_SELF_COND_HANDLING       SL_HANDLING_ASSERT
67 #define SL_PROTOCOL_HANDLING        SL_HANDLING_ASSERT
68 #define SL_DRV_RET_CODE_HANDLING    SL_HANDLING_ERROR
69 #define SL_NWP_IF_HANDLING          SL_HANDLING_ASSERT
70 #define SL_OSI_RET_OK_HANDLING      SL_HANDLING_ERROR
71 #define SL_MALLOC_OK_HANDLING       SL_HANDLING_ASSERT
72 #define SL_USER_ARGS_HANDLING       SL_HANDLING_ASSERT
73 #define SL_ERR_IN_PROGRESS_HANDLING SL_HANDLING_ERROR
74 #define SL_ERR_IN_API_ALLOWED       SL_HANDLING_ERROR
75 #define SL_LOCK_OK_HANDLING         SL_HANDLING_ASSERT
76 
77 #if (SL_ERR_IN_PROGRESS_HANDLING == SL_HANDLING_ERROR)
78 #define VERIFY_NO_ERROR_HANDLING_IN_PROGRESS() { \
79         if (SL_IS_RESTART_REQUIRED) return SL_API_ABORTED; }
80 #else
81 #define VERIFY_NO_ERROR_HANDLING_IN_PROGRESS()
82 #endif
83 
84 #if (SL_ERR_IN_API_ALLOWED == SL_HANDLING_ERROR)
85 #define VERIFY_API_ALLOWED(Silo) { \
86         _SlReturnVal_t status = _SlDrvDriverIsApiAllowed(Silo); \
87         if ( status ) return status; }
88 #else
89 #define VERIFY_API_ALLOWED(Silo)
90 #endif
91 
92 #if (SL_DRV_RET_CODE_HANDLING == SL_HANDLING_ASSERT)
93 #define VERIFY_RET_OK(Func)                     {_SlReturnVal_t _RetVal = (Func); _SL_ASSERT((_SlReturnVal_t)SL_OS_RET_CODE_OK == _RetVal)}
94 #elif (SL_DRV_RET_CODE_HANDLING == SL_HANDLING_ERROR)
95 #define VERIFY_RET_OK(Func)                     {_SlReturnVal_t _RetVal = (Func); if (SL_OS_RET_CODE_OK != _RetVal) return (_SlReturnVal_t)_RetVal;}
96 #else
97 #define VERIFY_RET_OK(Func)                     (Func);
98 #endif
99 
100 #if (SL_PROTOCOL_HANDLING == SL_HANDLING_ASSERT)
101 #define VERIFY_PROTOCOL(expr)                   _SL_ASSERT(expr)
102 #elif (SL_PROTOCOL_HANDLING == SL_HANDLING_ERROR)
103 #define VERIFY_PROTOCOL(expr)                   _SL_ERROR(expr, SL_RET_CODE_PROTOCOL_ERROR)
104 #else
105 #define VERIFY_PROTOCOL(expr)
106 #endif
107 
108 #if (defined(PROTECT_SOCKET_ASYNC_RESP) && (SL_SELF_COND_HANDLING == SL_HANDLING_ASSERT))
109 #define VERIFY_SOCKET_CB(expr)                  _SL_ASSERT(expr)
110 #elif (defined(PROTECT_SOCKET_ASYNC_RESP) && (SL_SELF_COND_HANDLING == SL_HANDLING_ERROR))
111 #define VERIFY_SOCKET_CB(expr)                  _SL_ERROR(expr, SL_RET_CODE_SELF_ERROR)
112 #else
113 #define VERIFY_SOCKET_CB(expr)
114 #endif
115 
116 #if (SL_NWP_IF_HANDLING == SL_HANDLING_ASSERT)
117 #define NWP_IF_WRITE_CHECK(fd,pBuff,len)       { _i16 RetSize, ExpSize = (_i16)(len); RetSize = sl_IfWrite((fd),(pBuff),ExpSize); _SL_ASSERT(ExpSize == RetSize)}
118 #define NWP_IF_READ_CHECK(fd,pBuff,len)        { _i16 RetSize, ExpSize = (_i16)(len); RetSize = sl_IfRead((fd),(pBuff),ExpSize);  _SL_ASSERT(ExpSize == RetSize)}
119 #elif (SL_NWP_IF_HANDLING == SL_HANDLING_ERROR)
120 #define NWP_IF_WRITE_CHECK(fd,pBuff,len)       { _SL_ERROR((len == sl_IfWrite((fd),(pBuff),(len))), SL_RET_CODE_NWP_IF_ERROR);}
121 #define NWP_IF_READ_CHECK(fd,pBuff,len)        { _SL_ERROR((len == sl_IfRead((fd),(pBuff),(len))),  SL_RET_CODE_NWP_IF_ERROR);}
122 #else
123 #define NWP_IF_WRITE_CHECK(fd,pBuff,len)       { sl_IfWrite((fd),(pBuff),(len));}
124 #define NWP_IF_READ_CHECK(fd,pBuff,len)        { sl_IfRead((fd),(pBuff),(len));}
125 #endif
126 
127 #if (SL_OSI_RET_OK_HANDLING == SL_HANDLING_ASSERT)
128 #define OSI_RET_OK_CHECK(Func)                  {_SlReturnVal_t _RetVal = (Func); _SL_ASSERT((_SlReturnVal_t)SL_OS_RET_CODE_OK == _RetVal)}
129 #elif (SL_OSI_RET_OK_HANDLING == SL_HANDLING_ERROR)
130 #define OSI_RET_OK_CHECK(Func)                  {_SlReturnVal_t _RetVal = (Func); if (SL_OS_RET_CODE_OK != _RetVal) return  _RetVal;}
131 #else
132 #define OSI_RET_OK_CHECK(Func)                  (Func);
133 #endif
134 
135 #if (SL_MALLOC_OK_HANDLING == SL_HANDLING_ASSERT)
136 #define MALLOC_OK_CHECK(Ptr)                    _SL_ASSERT(NULL != Ptr)
137 #elif (SL_MALLOC_OK_HANDLING == SL_HANDLING_ERROR)
138 #define MALLOC_OK_CHECK(Ptr)                    _SL_ERROR((NULL != Ptr), SL_RET_CODE_MALLOC_ERROR)
139 #else
140 #define MALLOC_OK_CHECK(Ptr)
141 #endif
142 
143 
144 #if (SL_LOCK_OK_HANDLING == SL_HANDLING_ASSERT)
145 #define LOCK_OK_CHECK(Func)                  {_SlReturnVal_t _RetVal = (Func); _SL_ASSERT((_SlReturnVal_t)SL_OS_RET_CODE_OK == _RetVal)}
146 #elif (SL_LOCK_OK_HANDLING == SL_HANDLING_ERROR)
147 #define LOCK_OK_CHECK(Func)                  {_SlReturnVal_t _RetVal = (Func); if (SL_OS_RET_CODE_OK != _RetVal) return  _RetVal;}
148 #else
149 #define LOCK_OK_CHECK(Func)                  (Func);
150 #endif
151 
152 
153 #ifdef SL_INC_ARG_CHECK
154 
155 #if (SL_USER_ARGS_HANDLING == SL_HANDLING_ASSERT)
156 #define ARG_CHECK_PTR(Ptr)                      _SL_ASSERT(NULL != Ptr)
157 #elif (SL_USER_ARGS_HANDLING == SL_HANDLING_ERROR)
158 #define ARG_CHECK_PTR(Ptr)                      _SL_ERROR((NULL != Ptr), SL_RET_CODE_INVALID_INPUT)
159 #else
160 #define ARG_CHECK_PTR(Ptr)
161 #endif
162 
163 #else
164 #define ARG_CHECK_PTR(Ptr)
165 #endif
166 
167 /*#define SL_DBG_TRACE_ENABLE*/
168 #ifdef SL_DBG_TRACE_ENABLE
169 #define SL_TRACE0(level,msg_id,str)                     printf(str)
170 #define SL_TRACE1(level,msg_id,str,p1)                  printf(str,(p1))
171 #define SL_TRACE2(level,msg_id,str,p1,p2)               printf(str,(p1),(p2))
172 #define SL_TRACE3(level,msg_id,str,p1,p2,p3)            printf(str,(p1),(p2),(p3))
173 #define SL_TRACE4(level,msg_id,str,p1,p2,p3,p4)         printf(str,(p1),(p2),(p3),(p4))
174 #define SL_ERROR_TRACE(msg_id,str)                      printf(str)
175 #define SL_ERROR_TRACE1(msg_id,str,p1)                  printf(str,(p1))
176 #define SL_ERROR_TRACE2(msg_id,str,p1,p2)               printf(str,(p1),(p2))
177 #define SL_ERROR_TRACE3(msg_id,str,p1,p2,p3)            printf(str,(p1),(p2),(p3))
178 #define SL_ERROR_TRACE4(msg_id,str,p1,p2,p3,p4)         printf(str,(p1),(p2),(p3),(p4))
179 #define SL_TRACE_FLUSH()
180 #else
181 #define SL_TRACE0(level,msg_id,str)
182 #define SL_TRACE1(level,msg_id,str,p1)
183 #define SL_TRACE2(level,msg_id,str,p1,p2)
184 #define SL_TRACE3(level,msg_id,str,p1,p2,p3)
185 #define SL_TRACE4(level,msg_id,str,p1,p2,p3,p4)
186 #define SL_ERROR_TRACE(msg_id,str)
187 #define SL_ERROR_TRACE1(msg_id,str,p1)
188 #define SL_ERROR_TRACE2(msg_id,str,p1,p2)
189 #define SL_ERROR_TRACE3(msg_id,str,p1,p2,p3)
190 #define SL_ERROR_TRACE4(msg_id,str,p1,p2,p3,p4)
191 #define SL_TRACE_FLUSH()
192 #endif
193 
194 /* #define SL_DBG_CNT_ENABLE */
195 #ifdef SL_DBG_CNT_ENABLE
196 #define _SL_DBG_CNT_INC(Cnt)            g_DbgCnt. ## Cnt++
197 #define _SL_DBG_SYNC_LOG(index,value)   {if(index < SL_DBG_SYNC_LOG_SIZE){*(_u32 *)&g_DbgCnt.SyncLog[index] = *(_u32 *)(value);}}
198 
199 #else
200 #define _SL_DBG_CNT_INC(Cnt)
201 #define _SL_DBG_SYNC_LOG(index,value)
202 #endif
203 
204 #define SL_DBG_LEVEL_1                  1
205 #define SL_DBG_LEVEL_2                  2
206 #define SL_DBG_LEVEL_3                  4
207 #define SL_DBG_LEVEL_MASK               (SL_DBG_LEVEL_2|SL_DBG_LEVEL_3)
208 
209 #define SL_INCLUDE_DBG_FUNC(Name)       ((Name ## _DBG_LEVEL) & SL_DBG_LEVEL_MASK)
210 
211 #define _SlDrvPrintStat_DBG_LEVEL       SL_DBG_LEVEL_3
212 #define _SlDrvOtherFunc_DBG_LEVEL       SL_DBG_LEVEL_1
213 
214 #ifdef  __cplusplus
215 }
216 #endif
217 
218 
219 #endif /*__SIMPLELINK_TRACE_H__*/
220 
221