1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
|
/**
* @file IxQMgrTrace_p.h
*
* @date 01-Mar-04
*
* @brief Private API for Queue Manager Tracing
*
* @par
* This file is provided under a dual BSD/GPLv2 license. When using or
* redistributing this file, you may do so under either license.
*
* GPL LICENSE SUMMARY
*
* Copyright(c) 2007,2008,2009 Intel Corporation. All rights reserved.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of version 2 of the GNU General Public License as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
* The full GNU General Public License is included in this distribution
* in the file called LICENSE.GPL.
*
* Contact Information:
* Intel Corporation
*
* BSD LICENSE
*
* Copyright(c) 2007,2008,2009 Intel Corporation. All rights reserved.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Intel Corporation nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*
*
*/
/**
* @defgroup IxQMgr IxQMgrTracing_p
*
* @brief Private API for Queue Manager Error and Debug Tracing
*
* @{
*/
#ifndef IXQMGRTRACE_P_H
#define IXQMGRTRACE_P_H
#include "IxOsal.h"
/**
* Prototypes for interface functions.
*/
/**
* @typedef IxQMgrTraceTypes
* @brief Enumeration defining Queue Manager trace levels
*/
typedef enum
{
IX_QMGR_TRACE_OFF, /**< NO TRACE */
IX_QMGR_DEBUG, /**< Select traces of interest */
IX_QMGR_FN_ENTRY_EXIT /**< ALL function entry/exit traces */
} IxQMgrTraceTypes;
/**
* #defines for function return types, etc.
*/
/**
* @def IX_QMGR_TRACE_LEVEL
*
* @brief Queue Manager debug trace level
*/
#ifndef IX_CONFIGURATION_unit_test
#define IX_QMGR_TRACE_LEVEL IX_QMGR_TRACE_OFF
#else
#define IX_QMGR_TRACE_LEVEL IX_QMGR_FN_ENTRY_EXIT
#endif
/**
* @def IX_QMGR_REPORT_ERROR
*
* @brief Mechanism for reporting Queue Manager software errors
*
* @param char* [in] STR - Error string to report
*
* This macro sends the error string passed to ixOsalLog
*
* @return none
*/
#define IX_QMGR_REPORT_ERROR(STR) ixOsalLog (IX_OSAL_LOG_LVL_ERROR, IX_OSAL_LOG_DEV_STDOUT, STR, 0, 0, 0, 0, 0, 0);
/**
* @def IX_QMGR_REPORT_ERROR_2
*
* @brief Mechanism for reporting Queue Manager software errors
* with 2 arguments
*
* @param char* [in] STR - Error string to report
* @param argType [in] ARG1 - Argument to trace
* @param argType [in] ARG2 - Argument to trace
*
* This macro sends the error string passed to ixOsalLog
*
* @return none
*/
#define IX_QMGR_REPORT_ERROR_2(STR,ARG1,ARG2) ixOsalLog (IX_OSAL_LOG_LVL_ERROR, IX_OSAL_LOG_DEV_STDOUT, STR, ARG1, ARG2, 0, 0, 0, 0);
/**
* @def IX_QMGR_TRACE0
*
* @brief Mechanism for tracing debug for the Queue Manager component, for no
* arguments
*
* @param unsigned [in] LEVEL - one of IxQMgrTraceTypes enumerated values
* @param char* [in] STR - Trace string
*
* This macro sends the trace string passed to ixOsalLog
*
* @return none
*/
#define IX_QMGR_TRACE0(LEVEL, STR) \
{ \
if (LEVEL <= IX_QMGR_TRACE_LEVEL) \
{ \
ixOsalLog (IX_OSAL_LOG_LVL_MESSAGE, IX_OSAL_LOG_DEV_STDOUT, STR, 0, 0, 0, 0, 0, 0); \
} \
}
/*
* @def IX_QMGR_TRACE1
*
* @brief Mechanism for tracing debug for the Queue Manager component, with one
* argument
*
* @param unsigned [in] LEVEL - one of IxQMgrTraceTypes enumerated values
* @param char* [in] STR - Trace string
* @param argType [in] ARG1 - Argument to trace
*
* This macro sends the trace string passed to ixOsalLog
*
* @return none
*/
#define IX_QMGR_TRACE1(LEVEL, STR, ARG1) \
{ \
if (LEVEL <= IX_QMGR_TRACE_LEVEL) \
{ \
ixOsalLog (IX_OSAL_LOG_LVL_MESSAGE, IX_OSAL_LOG_DEV_STDOUT, STR, (int) ARG1, 0, 0, 0, 0, 0); \
} \
}
/**
* @def IX_QMGR_TRACE2
*
* @brief Mechanism for tracing debug for the Queue Manager component, with two
* arguments
*
* @param unsigned [in] LEVEL - one of IxQMgrTraceTypes enumerated values
* @param char* [in] STR - Trace string
* @param argType [in] ARG1 - Argument to trace
* @param argType [in] ARG2 - Argument to trace
*
* This macro sends the trace string passed to ixOsalLog
*
* @return none
*/
#define IX_QMGR_TRACE2(LEVEL, STR, ARG1, ARG2) \
{ \
if (LEVEL <= IX_QMGR_TRACE_LEVEL) \
{ \
ixOsalLog (IX_OSAL_LOG_LVL_MESSAGE, IX_OSAL_LOG_DEV_STDOUT, STR, (int) ARG1, (int) ARG2, 0, 0, 0, 0); \
} \
}
/**
* @def IX_QMGR_TRACE3
*
* @brief Mechanism for tracing debug for the Queue Manager component, with two
* arguments
*
* @param unsigned [in] LEVEL - one of IxQMgrTraceTypes enumerated values
* @param char* [in] STR - Trace string
* @param argType [in] ARG1 - Argument to trace
* @param argType [in] ARG2 - Argument to trace
* @param argType [in] ARG3 - Argument to trace
*
* This macro sends the trace string passed to ixOsalLog
*
* @return none
*/
#define IX_QMGR_TRACE3(LEVEL, STR, ARG1, ARG2, ARG3) \
{ \
if (LEVEL <= IX_QMGR_TRACE_LEVEL) \
{ \
ixOsalLog (IX_OSAL_LOG_LVL_MESSAGE, IX_OSAL_LOG_DEV_STDOUT, STR, (int) ARG1, (int) ARG2, (int) ARG3, 0, 0, 0); \
} \
}
/**
* @def IX_QMGR_PRINT
*
* @brief macro to separate the Queue Manager component from the OS specific
* printing function. this is solely for debug purposes during development
* and integration
*
* @return none
*/
#ifdef __KERNEL__
#define IX_QMGR_PRINT printk
#else
#define IX_QMGR_PRINT printf
#endif /* __KERNEL__ */
#endif /* IXQMGRTRACE_H */
/**
* @} defgroup IxQMgr
*/
|
