3 * Copyright (C) 2012 BMW AG
5 * This file is part of GENIVI Project Dlt - Diagnostic Log and Trace console apps.
7 * Contributions are licensed to the GENIVI Alliance under one or more
8 * Contribution License Agreements.
11 * This Source Code Form is subject to the terms of the
12 * Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with
13 * this file, You can obtain one at http://mozilla.org/MPL/2.0/.
16 * \author Alexander Wenzel <alexander.aw.wenzel@bmw.de> BMW 2011-2012
18 * \file dlt_user_macros.h
19 * For further information see http://www.genivi.org/.
23 /*******************************************************************************
25 ** SRC-MODULE: dlt_user_macros.h **
31 ** AUTHOR : Alexander Wenzel Alexander.AW.Wenzel@bmw.de **
38 ** PLATFORM DEPENDANT [yes/no]: yes **
40 ** TO BE CHANGED BY USER [yes/no]: no **
42 *******************************************************************************/
44 /*******************************************************************************
46 ********************************************************************************
48 ** Initials Name Company **
49 ** -------- ------------------------- ---------------------------------- **
50 ** aw Alexander Wenzel BMW **
51 ** mk Markus Klein Fraunhofer ESK **
52 *******************************************************************************/
54 /*******************************************************************************
55 ** Revision Control History **
56 *******************************************************************************/
59 * $LastChangedRevision: 1515 $
60 * $LastChangedDate: 2010-12-13 09:18:54 +0100 (Mon, 13 Dec 2010) $
66 #ifndef DLT_USER_MACROS_H
67 #define DLT_USER_MACORS_H
69 #include "dlt_version.h"
72 \defgroup userapi DLT User API
77 /**************************************************************************************************
78 * The folowing macros define a macro interface for DLT
79 **************************************************************************************************/
82 * Create an object for a new context.
83 * This macro has to be called first for every.
84 * @param CONTEXT object containing information about one special logging context
86 #define DLT_DECLARE_CONTEXT(CONTEXT) \
90 * Use an object of a new context created in another module.
91 * This macro has to be called first for every.
92 * @param CONTEXT object containing information about one special logging context
94 #define DLT_IMPORT_CONTEXT(CONTEXT) \
95 extern DltContext CONTEXT;
98 * Register application.
99 * @param APPID application id with maximal four characters
100 * @param DESCRIPTION ASCII string containing description
102 #define DLT_REGISTER_APP(APPID,DESCRIPTION) do {\
103 dlt_check_library_version(_DLT_PACKAGE_MAJOR_VERSION, _DLT_PACKAGE_MINOR_VERSION ); \
104 dlt_register_app( APPID, DESCRIPTION);} while(0)
108 * Unregister application.
110 #define DLT_UNREGISTER_APP() do{\
111 dlt_unregister_app();} while(0)
114 * Register context (with default log level and default trace status)
115 * @param CONTEXT object containing information about one special logging context
116 * @param CONTEXTID context id with maximal four characters
117 * @param DESCRIPTION ASCII string containing description
119 #define DLT_REGISTER_CONTEXT(CONTEXT,CONTEXTID,DESCRIPTION) do{\
120 dlt_register_context(&(CONTEXT), CONTEXTID, DESCRIPTION);} while(0)
123 * Register context with pre-defined log level and pre-defined trace status.
124 * @param CONTEXT object containing information about one special logging context
125 * @param CONTEXTID context id with maximal four characters
126 * @param DESCRIPTION ASCII string containing description
127 * @param LOGLEVEL log level to be pre-set for this context
128 (DLT_LOG_DEFAULT is not allowed here)
129 * @param TRACESTATUS trace status to be pre-set for this context
130 (DLT_TRACE_STATUS_DEFAULT is not allowed here)
132 #define DLT_REGISTER_CONTEXT_LL_TS(CONTEXT,CONTEXTID,DESCRIPTION,LOGLEVEL,TRACESTATUS) do{\
133 dlt_register_context_ll_ts(&(CONTEXT), CONTEXTID, DESCRIPTION, LOGLEVEL, TRACESTATUS);} while(0)
136 * Unregister context.
137 * @param CONTEXT object containing information about one special logging context
139 #define DLT_UNREGISTER_CONTEXT(CONTEXT) do{\
140 dlt_unregister_context(&(CONTEXT));} while(0)
143 * Register callback function called when injection message was received
144 * @param CONTEXT object containing information about one special logging context
145 * @param SERVICEID service id of the injection message
146 * @param CALLBACK function pointer to callback function
148 #define DLT_REGISTER_INJECTION_CALLBACK(CONTEXT, SERVICEID, CALLBACK) do{\
149 dlt_register_injection_callback(&(CONTEXT),SERVICEID, CALLBACK);} while(0)
152 * Send log message with variable list of messages (intended for verbose mode)
153 * @param CONTEXT object containing information about one special logging context
154 * @param LOGLEVEL the log level of the log message
155 * @param ARGS variable list of arguments
158 /* DLT_LOG is not supported by MS Visual C++ */
159 /* use function interface instead */
161 #define DLT_LOG(CONTEXT,LOGLEVEL,ARGS...) \
163 DltContextData log; \
164 if (dlt_user_log_write_start(&CONTEXT,&log,LOGLEVEL)>0) \
167 dlt_user_log_write_finish(&log); \
173 * Send log message with variable list of messages (intended for non-verbose mode)
174 * @param CONTEXT object containing information about one special logging context
175 * @param LOGLEVEL the log level of the log message
176 * @param MSGID the message id of log message
177 * @param ARGS variable list of arguments:
178 calls to DLT_STRING(), DLT_BOOL(), DLT_FLOAT32(), DLT_FLOAT64(),
179 DLT_INT(), DLT_UINT(), DLT_RAW()
182 /* DLT_LOG_ID is not supported by MS Visual C++ */
183 /* use function interface instead */
185 #define DLT_LOG_ID(CONTEXT,LOGLEVEL,MSGID,ARGS...) \
187 DltContextData log; \
188 if (dlt_user_log_write_start_id(&CONTEXT,&log,LOGLEVEL,MSGID)>0) \
191 dlt_user_log_write_finish(&log); \
197 * Add string parameter to the log messsage.
198 * @param TEXT ASCII string
200 #define DLT_STRING(TEXT) \
201 dlt_user_log_write_string(&log,TEXT)
204 * Add utf8-encoded string parameter to the log messsage.
205 * @param TEXT UTF8-encoded string
207 #define DLT_UTF8(TEXT) \
208 dlt_user_log_write_utf8_string(&log,TEXT)
211 * Add boolean parameter to the log messsage.
212 * @param BOOL_VAR Boolean value (mapped to uint8)
214 #define DLT_BOOL(BOOL_VAR) \
215 dlt_user_log_write_bool(&log,BOOL_VAR)
218 * Add float32 parameter to the log messsage.
219 * @param FLOAT32_VAR Float32 value (mapped to float)
221 #define DLT_FLOAT32(FLOAT32_VAR) \
222 dlt_user_log_write_float32(&log,FLOAT32_VAR)
225 * Add float64 parameter to the log messsage.
226 * @param FLOAT64_VAR Float64 value (mapped to double)
228 #define DLT_FLOAT64(FLOAT64_VAR) \
229 dlt_user_log_write_float64(&log,FLOAT64_VAR)
232 * Add integer parameter to the log messsage.
233 * @param INT_VAR integer value
235 #define DLT_INT(INT_VAR) \
236 dlt_user_log_write_int(&log,INT_VAR)
238 #define DLT_INT8(INT_VAR) \
239 dlt_user_log_write_int8(&log,INT_VAR)
241 #define DLT_INT16(INT_VAR) \
242 dlt_user_log_write_int16(&log,INT_VAR)
244 #define DLT_INT32(INT_VAR) \
245 dlt_user_log_write_int32(&log,INT_VAR)
247 #define DLT_INT64(INT_VAR) \
248 dlt_user_log_write_int64(&log,INT_VAR)
251 * Add unsigned integer parameter to the log messsage.
252 * @param UINT_VAR unsigned integer value
254 #define DLT_UINT(UINT_VAR) \
255 dlt_user_log_write_uint(&log,UINT_VAR)
257 #define DLT_UINT8(UINT_VAR) \
258 dlt_user_log_write_uint8(&log,UINT_VAR)
260 #define DLT_UINT16(UINT_VAR) \
261 dlt_user_log_write_uint16(&log,UINT_VAR)
263 #define DLT_UINT32(UINT_VAR) \
264 dlt_user_log_write_uint32(&log,UINT_VAR)
266 #define DLT_UINT64(UINT_VAR) \
267 dlt_user_log_write_uint64(&log,UINT_VAR)
270 * Add binary memory block to the log messages.
271 * @param BUF pointer to memory block
272 * @param LEN length of memory block
274 #define DLT_RAW(BUF,LEN) \
275 dlt_user_log_write_raw(&log,BUF,LEN)
278 * Trace network message
279 * @param CONTEXT object containing information about one special logging context
280 * @param TYPE type of network trace message
281 * @param HEADERLEN length of network message header
282 * @param HEADER pointer to network message header
283 * @param PAYLOADLEN length of network message payload
284 * @param PAYLOAD pointer to network message payload
286 #define DLT_TRACE_NETWORK(CONTEXT,TYPE,HEADERLEN,HEADER,PAYLOADLEN,PAYLOAD) \
288 dlt_user_trace_network(&(CONTEXT),TYPE,HEADERLEN,HEADER,PAYLOADLEN,PAYLOAD); \
292 * Trace network message, allow truncation
293 * @param CONTEXT object containing information about one special logging context
294 * @param TYPE type of network trace message
295 * @param HEADERLEN length of network message header
296 * @param HEADER pointer to network message header
297 * @param PAYLOADLEN length of network message payload
298 * @param PAYLOAD pointer to network message payload
300 #define DLT_TRACE_NETWORK_TRUNCATED(CONTEXT,TYPE,HEADERLEN,HEADER,PAYLOADLEN,PAYLOAD) \
302 dlt_user_trace_network_truncated(&(CONTEXT),TYPE,HEADERLEN,HEADER,PAYLOADLEN,PAYLOAD, 1); \
306 * Trace network message, segment large messages
307 * @param CONTEXT object containing information about one special logging context
308 * @param TYPE type of network trace message
309 * @param HEADERLEN length of network message header
310 * @param HEADER pointer to network message header
311 * @param PAYLOADLEN length of network message payload
312 * @param PAYLOAD pointer to network message payload
314 #define DLT_TRACE_NETWORK_SEGMENTED(CONTEXT,TYPE,HEADERLEN,HEADER,PAYLOADLEN,PAYLOAD) \
316 dlt_user_trace_network_segmented(&(CONTEXT),TYPE,HEADERLEN,HEADER,PAYLOADLEN,PAYLOAD); \
320 * Send log message with string parameter.
321 * @param CONTEXT object containing information about one special logging context
322 * @param LOGLEVEL the log level of the log message
323 * @param TEXT ASCII string
325 #define DLT_LOG_STRING(CONTEXT,LOGLEVEL,TEXT) \
327 dlt_log_string(&(CONTEXT), LOGLEVEL, TEXT); \
331 * Send log message with string parameter and integer parameter.
332 * @param CONTEXT object containing information about one special logging context
333 * @param LOGLEVEL the log level of the log messages
334 * @param TEXT ASCII string
335 * @param INT_VAR integer value
337 #define DLT_LOG_STRING_INT(CONTEXT,LOGLEVEL,TEXT,INT_VAR) \
339 dlt_log_string_int(&(CONTEXT), LOGLEVEL, TEXT, INT_VAR); \
343 * Send log message with string parameter and unsigned integer parameter.
344 * @param CONTEXT object containing information about one special logging context
345 * @param LOGLEVEL the log level of the log message
346 * @param TEXT ASCII string
347 * @param UINT_VAR unsigned integer value
349 #define DLT_LOG_STRING_UINT(CONTEXT,LOGLEVEL,TEXT,UINT_VAR) \
351 dlt_log_string_uint(&(CONTEXT),LOGLEVEL,TEXT,UINT_VAR); \
355 * Send log message with unsigned integer parameter.
356 * @param CONTEXT object containing information about one special logging context
357 * @param LOGLEVEL the log level of the log message
358 * @param UINT_VAR unsigned integer value
360 #define DLT_LOG_UINT(CONTEXT,LOGLEVEL,UINT_VAR) \
362 dlt_log_uint(&(CONTEXT),LOGLEVEL,UINT_VAR); \
366 * Send log message with integer parameter.
367 * @param CONTEXT object containing information about one special logging context
368 * @param LOGLEVEL the log level of the log message
369 * @param INT_VAR integer value
371 #define DLT_LOG_INT(CONTEXT,LOGLEVEL,INT_VAR) \
373 dlt_log_int(&(CONTEXT),LOGLEVEL,INT_VAR); \
377 * Send log message with binary memory block.
378 * @param CONTEXT object containing information about one special logging context
379 * @param LOGLEVEL the log level of the log message
380 * @param BUF pointer to memory block
381 * @param LEN length of memory block
383 #define DLT_LOG_RAW(CONTEXT,LOGLEVEL,BUF,LEN) \
385 dlt_log_raw(&(CONTEXT),LOGLEVEL,BUF,LEN); \
389 * Switch to verbose mode
392 #define DLT_VERBOSE_MODE() do { \
393 dlt_verbose_mode();} while(0)
396 * Switch to non-verbose mode
399 #define DLT_NONVERBOSE_MODE() do {\
400 dlt_nonverbose_mode();} while(0)
403 * Set maximum logged log level and trace status of application
405 * @param LOGLEVEL This is the log level to be set for the whole application
406 * @param TRACESTATUS This is the trace status to be set for the whole application
408 #define DLT_SET_APPLICATION_LL_TS_LIMIT(LOGLEVEL, TRACESTATUS) do {\
409 dlt_set_application_ll_ts_limit(LOGLEVEL, TRACESTATUS);} while(0)
412 * Enable local printing of messages
415 #define DLT_ENABLE_LOCAL_PRINT() do {\
416 dlt_enable_local_print();} while(0)
419 * Disable local printing of messages
422 #define DLT_DISABLE_LOCAL_PRINT() do {\
423 dlt_disable_local_print();} while(0)
429 #endif /* DLT_USER_MACROS_H */