summaryrefslogtreecommitdiff
path: root/include/dlt/dlt_common_api.h
blob: 5927ac78f93c0f32a591cc02eca4df8bc19ec4b0 (plain)
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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
/*
 * @licence app begin@
 * SPDX license identifier: MPL-2.0
 *
 * Copyright (C) 2011-2015, BMW AG
 *
 * This file is part of GENIVI Project DLT - Diagnostic Log and Trace.
 *
 * This Source Code Form is subject to the terms of the
 * Mozilla Public License (MPL), v. 2.0.
 * If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * For further information see http://www.genivi.org/.
 * @licence end@
 */

/*!
 * \author Alexander Wenzel <alexander.aw.wenzel@bmw.de>
 *
 * \copyright Copyright © 2011-2015 BMW AG. \n
 * License MPL-2.0: Mozilla Public License version 2.0 http://mozilla.org/MPL/2.0/.
 *
 * \file dlt_common_api.h
 */

/*******************************************************************************
**                                                                            **
**  SRC-MODULE: dlt_commpn_api.h                                              **
**                                                                            **
**  TARGET    : linux                                                         **
**                                                                            **
**  PROJECT   : DLT                                                           **
**                                                                            **
**  AUTHOR    : Alexander Wenzel Alexander.AW.Wenzel@bmw.de                   **
**                                                                            **
**  PURPOSE   :                                                               **
**                                                                            **
**  REMARKS   :                                                               **
**                                                                            **
**  PLATFORM DEPENDANT [yes/no]: yes                                          **
**                                                                            **
**  TO BE CHANGED BY USER [yes/no]: no                                        **
**                                                                            **
*******************************************************************************/

/*******************************************************************************
**                      Author Identity                                       **
********************************************************************************
**                                                                            **
** Initials     Name                       Company                            **
** --------     -------------------------  ---------------------------------- **
**  aw          Alexander Wenzel           BMW                                **
*******************************************************************************/

#ifndef DLT_COMMON_API_H
#define DLT_COMMON_API_H

#include "dlt.h"

/**
 * Create an object for a new context.
 * Common API with DLT Embedded
 * This macro has to be called first for every.
 * @param CONTEXT object containing information about one special logging context
 */
/* #define DLT_DECLARE_CONTEXT(CONTEXT) */
/* UNCHANGED */

/**
 * Use an object of a new context created in another module.
 * Common API with DLT Embedded
 * This macro has to be called first for every.
 * @param CONTEXT object containing information about one special logging context
 */
/* #define DLT_IMPORT_CONTEXT(CONTEXT) */
/* UNCHANGED */

/**
 * Register application.
 * Common API with DLT Embedded
 * @param APPID application id with maximal four characters
 * @param DESCRIPTION ASCII string containing description
 */
/* #define DLT_REGISTER_APP(APPID,DESCRIPTION) */
/* UNCHANGED */

/**
 * Register context including application (with default log level and default trace status)
 * Common API with DLT Embedded
 * @param CONTEXT object containing information about one special logging context
 * @param CONTEXTID context id with maximal four characters
 * @param APPID context id with maximal four characters
 * @param DESCRIPTION ASCII string containing description
 */
#define DLT_REGISTER_CONTEXT_APP(CONTEXT, CONTEXTID, APPID, DESCRIPTION) \
    DLT_REGISTER_CONTEXT(CONTEXT, CONTEXTID, DESCRIPTION)

/**
 * Send log message with variable list of messages (intended for verbose mode)
 * Common API with DLT Embedded
 * @param CONTEXT object containing information about one special logging context
 * @param LOGLEVEL the log level of the log message
 * @param ARGS variable list of arguments
 */
/*****************************************/
#define DLT_LOG0(CONTEXT, LOGLEVEL) \
    DLT_LOG(CONTEXT, LOGLEVEL)
/*****************************************/
#define DLT_LOG1(CONTEXT, LOGLEVEL, ARGS1) \
    DLT_LOG(CONTEXT, LOGLEVEL, ARGS1)
/*****************************************/
#define DLT_LOG2(CONTEXT, LOGLEVEL, ARGS1, ARGS2) \
    DLT_LOG(CONTEXT, LOGLEVEL, ARGS1, ARGS2)
/*****************************************/
#define DLT_LOG3(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3) \
    DLT_LOG(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3)
/*****************************************/
#define DLT_LOG4(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4) \
    DLT_LOG(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4)
/*****************************************/
#define DLT_LOG5(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5) \
    DLT_LOG(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5)
/*****************************************/
#define DLT_LOG6(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6) \
    DLT_LOG(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6)
/*****************************************/
#define DLT_LOG7(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7) \
    DLT_LOG(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7)
/*****************************************/
#define DLT_LOG8(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8) \
    DLT_LOG(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8)
/*****************************************/
#define DLT_LOG9(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9) \
    DLT_LOG(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9)
/*****************************************/
#define DLT_LOG10(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10) \
    DLT_LOG(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10)
/*****************************************/
#define DLT_LOG11(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10, ARGS11) \
    DLT_LOG(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10, ARGS11)
/*****************************************/
#define DLT_LOG12(CONTEXT, \
                  LOGLEVEL, \
                  ARGS1, \
                  ARGS2, \
                  ARGS3, \
                  ARGS4, \
                  ARGS5, \
                  ARGS6, \
                  ARGS7, \
                  ARGS8, \
                  ARGS9, \
                  ARGS10, \
                  ARGS11, \
                  ARGS12) \
    DLT_LOG(CONTEXT, LOGLEVEL, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10, ARGS11, ARGS12)
/*****************************************/
#define DLT_LOG13(CONTEXT, \
                  LOGLEVEL, \
                  ARGS1, \
                  ARGS2, \
                  ARGS3, \
                  ARGS4, \
                  ARGS5, \
                  ARGS6, \
                  ARGS7, \
                  ARGS8, \
                  ARGS9, \
                  ARGS10, \
                  ARGS11, \
                  ARGS12, \
                  ARGS13) \
    DLT_LOG(CONTEXT, \
            LOGLEVEL, \
            ARGS1, \
            ARGS2, \
            ARGS3, \
            ARGS4, \
            ARGS5, \
            ARGS6, \
            ARGS7, \
            ARGS8, \
            ARGS9, \
            ARGS10, \
            ARGS11, \
            ARGS12, \
            ARGS13)
/*****************************************/
#define DLT_LOG14(CONTEXT, \
                  LOGLEVEL, \
                  ARGS1, \
                  ARGS2, \
                  ARGS3, \
                  ARGS4, \
                  ARGS5, \
                  ARGS6, \
                  ARGS7, \
                  ARGS8, \
                  ARGS9, \
                  ARGS10, \
                  ARGS11, \
                  ARGS12, \
                  ARGS13, \
                  ARGS14) \
    DLT_LOG(CONTEXT, \
            LOGLEVEL, \
            ARGS1, \
            ARGS2, \
            ARGS3, \
            ARGS4, \
            ARGS5, \
            ARGS6, \
            ARGS7, \
            ARGS8, \
            ARGS9, \
            ARGS10, \
            ARGS11, \
            ARGS12, \
            ARGS13, \
            ARGS14)
/*****************************************/
#define DLT_LOG15(CONTEXT, \
                  LOGLEVEL, \
                  ARGS1, \
                  ARGS2, \
                  ARGS3, \
                  ARGS4, \
                  ARGS5, \
                  ARGS6, \
                  ARGS7, \
                  ARGS8, \
                  ARGS9, \
                  ARGS10, \
                  ARGS11, \
                  ARGS12, \
                  ARGS13, \
                  ARGS14, \
                  ARGS15) \
    DLT_LOG(CONTEXT, \
            LOGLEVEL, \
            ARGS1, \
            ARGS2, \
            ARGS3, \
            ARGS4, \
            ARGS5, \
            ARGS6, \
            ARGS7, \
            ARGS8, \
            ARGS9, \
            ARGS10, \
            ARGS11, \
            ARGS12, \
            ARGS13, \
            ARGS14, \
            ARGS15)
/*****************************************/
#define DLT_LOG16(CONTEXT, \
                  LOGLEVEL, \
                  ARGS1, \
                  ARGS2, \
                  ARGS3, \
                  ARGS4, \
                  ARGS5, \
                  ARGS6, \
                  ARGS7, \
                  ARGS8, \
                  ARGS9, \
                  ARGS10, \
                  ARGS11, \
                  ARGS12, \
                  ARGS13, \
                  ARGS14, \
                  ARGS15, \
                  ARGS16) \
    DLT_LOG(CONTEXT, \
            LOGLEVEL, \
            ARGS1, \
            ARGS2, \
            ARGS3, \
            ARGS4, \
            ARGS5, \
            ARGS6, \
            ARGS7, \
            ARGS8, \
            ARGS9, \
            ARGS10, \
            ARGS11, \
            ARGS12, \
            ARGS13, \
            ARGS14, \
            ARGS15, \
            ARGS16)

/**
 * Send log message with variable list of messages (intended for non-verbose mode)
 * Common API with DLT Embedded
 * @param CONTEXT object containing information about one special logging context
 * @param LOGLEVEL the log level of the log message
 * @param MSGID the message id of log message
 * @param ARGS variable list of arguments:
 * calls to DLT_STRING(), DLT_BOOL(), DLT_FLOAT32(), DLT_FLOAT64(),
 * DLT_INT(), DLT_UINT(), DLT_RAW()
 */
/*****************************************/
#define DLT_LOG_ID0(CONTEXT, LOGLEVEL, MSGID) \
    DLT_LOG_ID(CONTEXT, LOGLEVEL, MSGID)
/*****************************************/
#define DLT_LOG_ID1(CONTEXT, LOGLEVEL, MSGID, ARGS1) \
    DLT_LOG_ID(CONTEXT, LOGLEVEL, MSGID, ARGS1)
/*****************************************/
#define DLT_LOG_ID2(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2) \
    DLT_LOG_ID(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2)
/*****************************************/
#define DLT_LOG_ID3(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3) \
    DLT_LOG_ID(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3)
/*****************************************/
#define DLT_LOG_ID4(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3, ARGS4) \
    DLT_LOG_ID(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3, ARGS4)
/*****************************************/
#define DLT_LOG_ID5(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5) \
    DLT_LOG_ID(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5)
/*****************************************/
#define DLT_LOG_ID6(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6) \
    DLT_LOG_ID(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6)
/*****************************************/
#define DLT_LOG_ID7(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7) \
    DLT_LOG_ID(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7)
/*****************************************/
#define DLT_LOG_ID8(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8) \
    DLT_LOG_ID(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8)
/*****************************************/
#define DLT_LOG_ID9(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9) \
    DLT_LOG_ID(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9)
/*****************************************/
#define DLT_LOG_ID10(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10) \
    DLT_LOG_ID(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10)
/*****************************************/
#define DLT_LOG_ID11(CONTEXT, \
                     LOGLEVEL, \
                     MSGID, \
                     ARGS1, \
                     ARGS2, \
                     ARGS3, \
                     ARGS4, \
                     ARGS5, \
                     ARGS6, \
                     ARGS7, \
                     ARGS8, \
                     ARGS9, \
                     ARGS10, \
                     ARGS11) \
    DLT_LOG_ID(CONTEXT, LOGLEVEL, MSGID, ARGS1, ARGS2, ARGS3, ARGS4, ARGS5, ARGS6, ARGS7, ARGS8, ARGS9, ARGS10, ARGS11)
/*****************************************/
#define DLT_LOG_ID12(CONTEXT, \
                     LOGLEVEL, \
                     MSGID, \
                     ARGS1, \
                     ARGS2, \
                     ARGS3, \
                     ARGS4, \
                     ARGS5, \
                     ARGS6, \
                     ARGS7, \
                     ARGS8, \
                     ARGS9, \
                     ARGS10, \
                     ARGS11, \
                     ARGS12) \
    DLT_LOG_ID(CONTEXT, \
               LOGLEVEL, \
               MSGID, \
               ARGS1, \
               ARGS2, \
               ARGS3, \
               ARGS4, \
               ARGS5, \
               ARGS6, \
               ARGS7, \
               ARGS8, \
               ARGS9, \
               ARGS10, \
               ARGS11, \
               ARGS12)
/*****************************************/
#define DLT_LOG_ID13(CONTEXT, \
                     LOGLEVEL, \
                     MSGID, \
                     ARGS1, \
                     ARGS2, \
                     ARGS3, \
                     ARGS4, \
                     ARGS5, \
                     ARGS6, \
                     ARGS7, \
                     ARGS8, \
                     ARGS9, \
                     ARGS10, \
                     ARGS11, \
                     ARGS12, \
                     ARGS13) \
    DLT_LOG_ID(CONTEXT, \
               LOGLEVEL, \
               MSGID, \
               ARGS1, \
               ARGS2, \
               ARGS3, \
               ARGS4, \
               ARGS5, \
               ARGS6, \
               ARGS7, \
               ARGS8, \
               ARGS9, \
               ARGS10, \
               ARGS11, \
               ARGS12, \
               ARGS13)
/*****************************************/
#define DLT_LOG_ID14(CONTEXT, \
                     LOGLEVEL, \
                     MSGID, \
                     ARGS1, \
                     ARGS2, \
                     ARGS3, \
                     ARGS4, \
                     ARGS5, \
                     ARGS6, \
                     ARGS7, \
                     ARGS8, \
                     ARGS9, \
                     ARGS10, \
                     ARGS11, \
                     ARGS12, \
                     ARGS13, \
                     ARGS14) \
    DLT_LOG_ID(CONTEXT, \
               LOGLEVEL, \
               MSGID, \
               ARGS1, \
               ARGS2, \
               ARGS3, \
               ARGS4, \
               ARGS5, \
               ARGS6, \
               ARGS7, \
               ARGS8, \
               ARGS9, \
               ARGS10, \
               ARGS11, \
               ARGS12, \
               ARGS13, \
               ARGS14)
/*****************************************/
#define DLT_LOG_ID15(CONTEXT, \
                     LOGLEVEL, \
                     MSGID, \
                     ARGS1, \
                     ARGS2, \
                     ARGS3, \
                     ARGS4, \
                     ARGS5, \
                     ARGS6, \
                     ARGS7, \
                     ARGS8, \
                     ARGS9, \
                     ARGS10, \
                     ARGS11, \
                     ARGS12, \
                     ARGS13, \
                     ARGS14, \
                     ARGS15) \
    DLT_LOG_ID(CONTEXT, \
               LOGLEVEL, \
               MSGID, \
               ARGS1, \
               ARGS2, \
               ARGS3, \
               ARGS4, \
               ARGS5, \
               ARGS6, \
               ARGS7, \
               ARGS8, \
               ARGS9, \
               ARGS10, \
               ARGS11, \
               ARGS12, \
               ARGS13, \
               ARGS14, \
               ARGS15)
/*****************************************/
#define DLT_LOG_ID16(CONTEXT, \
                     LOGLEVEL, \
                     MSGID, \
                     ARGS1, \
                     ARGS2, \
                     ARGS3, \
                     ARGS4, \
                     ARGS5, \
                     ARGS6, \
                     ARGS7, \
                     ARGS8, \
                     ARGS9, \
                     ARGS10, \
                     ARGS11, \
                     ARGS12, \
                     ARGS13, \
                     ARGS14, \
                     ARGS15, \
                     ARGS16) \
    DLT_LOG_ID(CONTEXT, \
               LOGLEVEL, \
               MSGID, \
               ARGS1, \
               ARGS2, \
               ARGS3, \
               ARGS4, \
               ARGS5, \
               ARGS6, \
               ARGS7, \
               ARGS8, \
               ARGS9, \
               ARGS10, \
               ARGS11, \
               ARGS12, \
               ARGS13, \
               ARGS14, \
               ARGS15, \
               ARGS16)

/**
 * Unregister context.
 * Common API with DLT Embedded
 * @param CONTEXT object containing information about one special logging context
 */
/* #define DLT_UNREGISTER_CONTEXT(CONTEXT) */
/* UNCHANGED */

/**
 * Unregister application.
 * Common API with DLT Embedded
 */
/* #define DLT_UNREGISTER_APP() */
/* UNCHANGED */

/**
 * Add string parameter to the log messsage.
 * Common API with DLT Embedded
 * In the future in none verbose mode the string will not be sent via DLT message.
 * @param TEXT ASCII string
 */
/* #define DLT_CSTRING(TEXT) */
/* UNCHANGED */

#endif /* DLT_COMMON_API_H */