2 * Dlt- Diagnostic Log and Trace console apps
5 * Copyright (C) 2011, BMW AG - Alexander Wenzel <alexander.wenzel@bmw.de>
7 * This program is free software; you can redistribute it and/or modify it under the terms of the
8 * GNU Lesser General Public License, version 2.1, as published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
10 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
11 * Public License, version 2.1, for more details.
13 * You should have received a copy of the GNU Lesser General Public License, version 2.1, along
14 * with this program; if not, see <http://www.gnu.org/licenses/lgpl-2.1.html>.
16 * Note that the copyright holders assume that the GNU Lesser General Public License, version 2.1, may
17 * also be applicable to programs even in cases in which the program is not a library in the technical sense.
19 * Linking DLT statically or dynamically with other modules is making a combined work based on DLT. You may
20 * license such other modules under the GNU Lesser General Public License, version 2.1. If you do not want to
21 * license your linked modules under the GNU Lesser General Public License, version 2.1, you
22 * may use the program under the following exception.
24 * As a special exception, the copyright holders of DLT give you permission to combine DLT
25 * with software programs or libraries that are released under any license unless such a combination is not
26 * permitted by the license of such a software program or library. You may copy and distribute such a
27 * system following the terms of the GNU Lesser General Public License, version 2.1, including this
28 * special exception, for DLT and the licenses of the other code concerned.
30 * Note that people who make modified versions of DLT are not obligated to grant this special exception
31 * for their modified versions; it is their choice whether to do so. The GNU Lesser General Public License,
32 * version 2.1, gives permission to release a modified version without this exception; this exception
33 * also makes it possible to release a modified version which carries forward this exception.
39 /*******************************************************************************
41 ** SRC-MODULE: dlt_user_macros.h **
47 ** AUTHOR : Alexander Wenzel Alexander.AW.Wenzel@bmw.de **
54 ** PLATFORM DEPENDANT [yes/no]: yes **
56 ** TO BE CHANGED BY USER [yes/no]: no **
58 *******************************************************************************/
60 /*******************************************************************************
62 ********************************************************************************
64 ** Initials Name Company **
65 ** -------- ------------------------- ---------------------------------- **
66 ** aw Alexander Wenzel BMW **
67 ** mk Markus Klein Fraunhofer ESK **
68 *******************************************************************************/
70 /*******************************************************************************
71 ** Revision Control History **
72 *******************************************************************************/
75 * $LastChangedRevision: 1515 $
76 * $LastChangedDate: 2010-12-13 09:18:54 +0100 (Mon, 13 Dec 2010) $
82 #ifndef DLT_USER_MACROS_H
83 #define DLT_USER_MACORS_H
86 \defgroup userapi DLT User API
91 /**************************************************************************************************
92 * The folowing macros define a macro interface for DLT
93 **************************************************************************************************/
96 * Create an object for a new context.
97 * This macro has to be called first for every.
98 * @param CONTEXT object containing information about one special logging context
100 #define DLT_DECLARE_CONTEXT(CONTEXT) \
104 * Use an object of a new context created in another module.
105 * This macro has to be called first for every.
106 * @param CONTEXT object containing information about one special logging context
108 #define DLT_IMPORT_CONTEXT(CONTEXT) \
109 extern DltContext CONTEXT;
112 * Register application.
113 * @param APPID application id with maximal four characters
114 * @param DESCRIPTION ASCII string containing description
116 #define DLT_REGISTER_APP(APPID,DESCRIPTION) \
117 dlt_register_app( APPID, DESCRIPTION);
120 * Unregister application.
122 #define DLT_UNREGISTER_APP() \
123 dlt_unregister_app();
126 * Register context (with default log level and default trace status)
127 * @param CONTEXT object containing information about one special logging context
128 * @param CONTEXTID context id with maximal four characters
129 * @param DESCRIPTION ASCII string containing description
131 #define DLT_REGISTER_CONTEXT(CONTEXT,CONTEXTID,DESCRIPTION) \
132 dlt_register_context(&(CONTEXT), CONTEXTID, DESCRIPTION);
135 * Register context with pre-defined log level and pre-defined trace status.
136 * @param CONTEXT object containing information about one special logging context
137 * @param CONTEXTID context id with maximal four characters
138 * @param DESCRIPTION ASCII string containing description
139 * @param LOGLEVEL log level to be pre-set for this context
140 (DLT_LOG_DEFAULT is not allowed here)
141 * @param TRACESTATUS trace status to be pre-set for this context
142 (DLT_TRACE_STATUS_DEFAULT is not allowed here)
144 #define DLT_REGISTER_CONTEXT_LL_TS(CONTEXT,CONTEXTID,DESCRIPTION,LOGLEVEL,TRACESTATUS) \
145 dlt_register_context_ll_ts(&(CONTEXT), CONTEXTID, DESCRIPTION, LOGLEVEL, TRACESTATUS);
148 * Unregister context.
149 * @param CONTEXT object containing information about one special logging context
151 #define DLT_UNREGISTER_CONTEXT(CONTEXT) \
152 dlt_unregister_context(&(CONTEXT));
155 * Register callback function called when injection message was received
156 * @param CONTEXT object containing information about one special logging context
157 * @param SERVICEID service id of the injection message
158 * @param CALLBACK function pointer to callback function
160 #define DLT_REGISTER_INJECTION_CALLBACK(CONTEXT, SERVICEID, CALLBACK) \
161 dlt_register_injection_callback(&(CONTEXT),SERVICEID, CALLBACK);
164 * Send log message with variable list of messages (intended for verbose mode)
165 * @param CONTEXT object containing information about one special logging context
166 * @param LOGLEVEL the log level of the log message
167 * @param ARGS variable list of arguments
170 /* DLT_LOG is not supported by MS Visual C++ */
171 /* use function interface instead */
173 #define DLT_LOG(CONTEXT,LOGLEVEL,ARGS...) \
175 DltContextData log; \
176 if (dlt_user_log_write_start(&CONTEXT,&log,LOGLEVEL)) \
179 dlt_user_log_write_finish(&log); \
185 * Send log message with variable list of messages (intended for non-verbose mode)
186 * @param CONTEXT object containing information about one special logging context
187 * @param LOGLEVEL the log level of the log message
188 * @param MSGID the message id of log message
189 * @param ARGS variable list of arguments:
190 calls to DLT_STRING(), DLT_BOOL(), DLT_FLOAT32(), DLT_FLOAT64(),
191 DLT_INT(), DLT_UINT(), DLT_RAW()
194 /* DLT_LOG_ID is not supported by MS Visual C++ */
195 /* use function interface instead */
197 #define DLT_LOG_ID(CONTEXT,LOGLEVEL,MSGID,ARGS...) \
199 DltContextData log; \
200 if (dlt_user_log_write_start_id(&CONTEXT,&log,LOGLEVEL,MSGID)) \
203 dlt_user_log_write_finish(&log); \
209 * Add string parameter to the log messsage.
210 * @param TEXT ASCII string
212 #define DLT_STRING(TEXT) ({ \
213 dlt_user_log_write_string(&log,TEXT); \
217 * Add boolean parameter to the log messsage.
218 * @param BOOL_VAR Boolean value (mapped to uint8)
220 #define DLT_BOOL(BOOL_VAR) ({ \
221 dlt_user_log_write_bool(&log,BOOL_VAR); \
225 * Add float32 parameter to the log messsage.
226 * @param FLOAT32_VAR Float32 value (mapped to float)
228 #define DLT_FLOAT32(FLOAT32_VAR) ({ \
229 dlt_user_log_write_float32(&log,FLOAT32_VAR); \
233 * Add float64 parameter to the log messsage.
234 * @param FLOAT64_VAR Float64 value (mapped to double)
236 #define DLT_FLOAT64(FLOAT64_VAR) ({ \
237 dlt_user_log_write_float64(&log,FLOAT64_VAR); \
241 * Add integer parameter to the log messsage.
242 * @param INT_VAR integer value
244 #define DLT_INT(INT_VAR) ({ \
245 dlt_user_log_write_int(&log,INT_VAR); \
247 #define DLT_INT8(INT_VAR) ({ \
248 dlt_user_log_write_int8(&log,INT_VAR); \
250 #define DLT_INT16(INT_VAR) ({ \
251 dlt_user_log_write_int16(&log,INT_VAR); \
253 #define DLT_INT32(INT_VAR) ({ \
254 dlt_user_log_write_int32(&log,INT_VAR); \
256 #define DLT_INT64(INT_VAR) ({ \
257 dlt_user_log_write_int64(&log,INT_VAR); \
261 * Add unsigned integer parameter to the log messsage.
262 * @param UINT_VAR unsigned integer value
264 #define DLT_UINT(UINT_VAR) ({ \
265 dlt_user_log_write_uint(&log,UINT_VAR); \
267 #define DLT_UINT8(UINT_VAR) ({ \
268 dlt_user_log_write_uint8(&log,UINT_VAR); \
270 #define DLT_UINT16(UINT_VAR) ({ \
271 dlt_user_log_write_uint16(&log,UINT_VAR); \
273 #define DLT_UINT32(UINT_VAR) ({ \
274 dlt_user_log_write_uint32(&log,UINT_VAR); \
276 #define DLT_UINT64(UINT_VAR) ({ \
277 dlt_user_log_write_uint64(&log,UINT_VAR); \
281 * Add binary memory block to the log messages.
282 * @param BUF pointer to memory block
283 * @param LEN length of memory block
285 #define DLT_RAW(BUF,LEN) ({ \
286 dlt_user_log_write_raw(&log,BUF,LEN); \
290 * Trace network message
291 * @param CONTEXT object containing information about one special logging context
292 * @param TYPE type of network trace message
293 * @param HEADERLEN length of network message header
294 * @param HEADER pointer to network message header
295 * @param PAYLOADLEN length of network message payload
296 * @param PAYLOAD pointer to network message payload
298 #define DLT_TRACE_NETWORK(CONTEXT,TYPE,HEADERLEN,HEADER,PAYLOADLEN,PAYLOAD) \
300 dlt_user_trace_network(&(CONTEXT),TYPE,HEADERLEN,HEADER,PAYLOADLEN,PAYLOAD); \
304 * Send log message with string parameter.
305 * @param CONTEXT object containing information about one special logging context
306 * @param LOGLEVEL the log level of the log message
307 * @param TEXT ASCII string
309 #define DLT_LOG_STRING(CONTEXT,LOGLEVEL,TEXT) \
311 dlt_log_string(&(CONTEXT), LOGLEVEL, TEXT); \
316 * Send log message with string parameter and integer parameter.
317 * @param CONTEXT object containing information about one special logging context
318 * @param LOGLEVEL the log level of the log messages
319 * @param TEXT ASCII string
320 * @param INT_VAR integer value
322 #define DLT_LOG_STRING_INT(CONTEXT,LOGLEVEL,TEXT,INT_VAR) \
324 dlt_log_string_int(&(CONTEXT), LOGLEVEL, TEXT, INT_VAR); \
328 * Send log message with string parameter and unsigned integer parameter.
329 * @param CONTEXT object containing information about one special logging context
330 * @param LOGLEVEL the log level of the log message
331 * @param TEXT ASCII string
332 * @param UINT_VAR unsigned integer value
334 #define DLT_LOG_STRING_UINT(CONTEXT,LOGLEVEL,TEXT,UINT_VAR) \
336 dlt_log_string_uint(&(CONTEXT),LOGLEVEL,TEXT,UINT_VAR); \
340 * Send log message with unsigned integer parameter.
341 * @param CONTEXT object containing information about one special logging context
342 * @param LOGLEVEL the log level of the log message
343 * @param UINT_VAR unsigned integer value
345 #define DLT_LOG_UINT(CONTEXT,LOGLEVEL,UINT_VAR) \
347 dlt_log_uint(&(CONTEXT),LOGLEVEL,UINT_VAR); \
351 * Send log message with integer parameter.
352 * @param CONTEXT object containing information about one special logging context
353 * @param LOGLEVEL the log level of the log message
354 * @param INT_VAR integer value
356 #define DLT_LOG_INT(CONTEXT,LOGLEVEL,INT_VAR) \
358 dlt_log_int(&(CONTEXT),LOGLEVEL,INT_VAR); \
362 * Send log message with binary memory block.
363 * @param CONTEXT object containing information about one special logging context
364 * @param LOGLEVEL the log level of the log message
365 * @param BUF pointer to memory block
366 * @param LEN length of memory block
368 #define DLT_LOG_RAW(CONTEXT,LOGLEVEL,BUF,LEN) \
370 dlt_log_raw(&(CONTEXT),LOGLEVEL,BUF,LEN); \
374 * Switch to verbose mode
377 #define DLT_VERBOSE_MODE() \
381 * Switch to non-verbose mode
384 #define DLT_NONVERBOSE_MODE() \
385 dlt_nonverbose_mode();
388 * Set maximum logged log level and trace status of application
390 * @param LOGLEVEL This is the log level to be set for the whole application
391 * @param TRACESTATUS This is the trace status to be set for the whole application
393 #define DLT_SET_APPLICATION_LL_TS_LIMIT(LOGLEVEL, TRACESTATUS) \
394 dlt_set_application_ll_ts_limit(LOGLEVEL, TRACESTATUS);
397 * Enable local printing of messages
400 #define DLT_ENABLE_LOCAL_PRINT() \
401 dlt_enable_local_print();
404 * Disable local printing of messages
407 #define DLT_DISABLE_LOCAL_PRINT() \
408 dlt_disable_local_print();
414 #endif /* DLT_USER_MACROS_H */