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
|
/*
* @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_client.h
*/
/*******************************************************************************
** **
** SRC-MODULE: dlt_client.h **
** **
** TARGET : linux **
** **
** PROJECT : DLT **
** **
** AUTHOR : Alexander Wenzel Alexander.AW.Wenzel@bmw.de **
** Markus Klein **
** **
** PURPOSE : **
** **
** REMARKS : **
** **
** PLATFORM DEPENDANT [yes/no]: yes **
** **
** TO BE CHANGED BY USER [yes/no]: no **
** **
*******************************************************************************/
/*******************************************************************************
** Author Identity **
********************************************************************************
** **
** Initials Name Company **
** -------- ------------------------- ---------------------------------- **
** aw Alexander Wenzel BMW **
** mk Markus Klein Fraunhofer ESK **
*******************************************************************************/
/*******************************************************************************
** Revision Control History **
*******************************************************************************/
/*
* $LastChangedRevision$
* $LastChangedDate$
* $LastChangedBy$
*/
#ifndef DLT_CLIENT_H
#define DLT_CLIENT_H
/**
\defgroup clientapi DLT Client API
\addtogroup clientapi
\{
*/
#include "dlt_types.h"
#include "dlt_common.h"
typedef struct
{
DltReceiver receiver; /**< receiver pointer to dlt receiver structure */
int sock; /**< sock Connection handle/socket */
char *servIP; /**< servIP IP adress/Hostname of TCP/IP interface */
char *serialDevice; /**< serialDevice Devicename of serial device */
speed_t baudrate; /**< baudrate Baudrate of serial interface, as speed_t */
int serial_mode; /**< serial_mode Serial mode enabled =1, disabled =0 */
} DltClient;
#ifdef __cplusplus
extern "C" {
#endif
void dlt_client_register_message_callback(int (*registerd_callback) (DltMessage *message, void *data));
/**
* Initialising dlt client structure
* @param client pointer to dlt client structure
* @param verbose if set to true verbose information is printed out.
* @return negative value if there was an error
*/
int dlt_client_init(DltClient *client, int verbose);
/**
* Connect to dlt daemon using the information from the dlt client structure
* @param client pointer to dlt client structure
* @param verbose if set to true verbose information is printed out.
* @return negative value if there was an error
*/
int dlt_client_connect(DltClient *client, int verbose);
/**
* Cleanup dlt client structure
* @param client pointer to dlt client structure
* @param verbose if set to true verbose information is printed out.
* @return negative value if there was an error
*/
int dlt_client_cleanup(DltClient *client, int verbose);
/**
* Main Loop of dlt client application
* @param client pointer to dlt client structure
* @param data pointer to data to be provided to the main loop
* @param verbose if set to true verbose information is printed out.
* @return negative value if there was an error
*/
int dlt_client_main_loop(DltClient *client, void *data, int verbose);
/**
* Send ancontrol message to the dlt daemon
* @param client pointer to dlt client structure
* @param apid application id
* @param ctid context id
* @param payload Buffer filled with control message data
* @param size Size of control message data
* @return negative value if there was an error
*/
int dlt_client_send_ctrl_msg(DltClient *client, char *apid, char *ctid, uint8_t *payload, uint32_t size);
/**
* Send an injection message to the dlt daemon
* @param client pointer to dlt client structure
* @param apid application id
* @param ctid context id
* @param serviceID service id
* @param buffer Buffer filled with injection message data
* @param size Size of injection data within buffer
* @return negative value if there was an error
*/
int dlt_client_send_inject_msg(DltClient *client, char *apid, char *ctid, uint32_t serviceID, uint8_t *buffer, uint32_t size);
/**
* Send an set log level message to the dlt daemon
* @param client pointer to dlt client structure
* @param apid application id
* @param ctid context id
* @param SendLogLevel Log Level
* @return negative value if there was an error
*/
int dlt_client_send_log_level(DltClient *client, char *apid, char *ctid, uint8_t logLevel);
/**
* Send a set trace status message to the dlt daemon
* @param client pointer to dlt client structure
* @param apid application id
* @param ctid context id
* @param defaultTraceStatus Default Trace Status
* @return negative value if there was an error
*/
int dlt_client_send_trace_status(DltClient *client, char *apid, char *ctid, uint8_t traceStatus);
/**
* Send the default log level to the dlt daemon
* @param client pointer to dlt client structure
* @param defaultLogLevel Default Log Level
* @return negative value if there was an error
*/
int dlt_client_send_default_log_level(DltClient *client, uint8_t defaultLogLevel);
/**
* Send the default trace status to the dlt daemon
* @param client pointer to dlt client structure
* @param defaultTraceStatus Default Trace Status
* @return negative value if there was an error
*/
int dlt_client_send_default_trace_status(DltClient *client, uint8_t defaultTraceStatus);
/**
* Send the timing pakets status to the dlt daemon
* @param client pointer to dlt client structure
* @param timingPakets Timing pakets enabled
* @return negative value if there was an error
*/
int dlt_client_send_timing_pakets(DltClient *client, uint8_t timingPakets);
/**
* Send the store config command to the dlt daemon
* @param client pointer to dlt client structure
* @return negative value if there was an error
*/
int dlt_client_send_store_config(DltClient *client);
/**
* Send the reset to factory default command to the dlt daemon
* @param client pointer to dlt client structure
* @return negative value if there was an error
*/
int dlt_client_send_reset_to_factory_default(DltClient *client);
/**
* Set baudrate within dlt client structure
* @param client pointer to dlt client structure
* @param baudrate Baudrate
* @return negative value if there was an error
*/
int dlt_client_setbaudrate(DltClient *client, int baudrate);
#ifdef __cplusplus
}
#endif
/**
\}
*/
#endif /* DLT_CLIENT_H */
|
