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
|
/**
* @licence app begin@
* Copyright (C) 2014 BMW AG
*
* This file is part of COVESA Project Dlt - Diagnostic Log and Trace console apps.
*
* Contributions are licensed to the COVESA Alliance under one or more
* Contribution License Agreements.
*
* \copyright
* This Source Code Form is subject to the terms of the
* Mozilla Public License, 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/.
*
*
* \author Alexander Wenzel <alexander.aw.wenzel@bmw.de> BMW 2011-2012
*
* \file dlt_common_api.h
* For further information see http://www.covesa.global/.
* @licence end@
*/
/*******************************************************************************
** **
** 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,APPID,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) */
/* UNCHANGED */
/**
* 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) */
/* UNCHANGED */
/**
* 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 */
|
