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
|
/*******************************************************************************
* Copyright (C) ST-Ericsson SA 2011
* License terms: 3-clause BSD license
******************************************************************************/
#ifndef _INCLUSION_GUARD_R_COMMUNICATION_SERVICE_H_
#define _INCLUSION_GUARD_R_COMMUNICATION_SERVICE_H_
/**
* @addtogroup ldr_communication_module Loader communication module
* The Loader Communication module is introduced with the intention of sharing
* code and bridging the gap between Loaders and the tools using Loaders.
* By having a module that exposes an interface to both Loaders and tools and
* this interface are generated from a common specification, we can more easily
* change and version control the interface.
*
* @{
*
*/
/*******************************************************************************
* Includes
******************************************************************************/
#include "c_system.h"
#include "error_codes.h"
#include "t_communication_service.h"
#if (defined(WIN32) || defined(__CYGWIN__))
#ifdef LCM_EXPORTS
#define LCM_API __declspec(dllexport) // export DLL information
#else //LCM_EXPORTS
#define LCM_API __declspec(dllimport) // import DLL information
#endif // LCM_EXPORTS
#elif (defined(__linux__) || defined(__APPLE__))
#ifdef LCM_EXPORTS
#define LCM_API __attribute__((visibility("default")))
#else //LCM_EXPORTS
#define LCM_API
#endif // LCM_EXPORTS
#elif defined(CFG_ENABLE_LOADER_TYPE)
#define LCM_API
#endif // WIN32
#define QUEUE(x,y) x->Functions_p->QueueFunctions_p->y
#define TIMER(x,y) x->Functions_p->TimerFunctions_p->y
#define BUFFER(x,y) x->Functions_p->BufferFunctions_p->y
#define OBJECT_BUFFER(x) x->Functions_p->BufferFunctions_p->Object_p
#define OBJECT_TIMER(x) x->Functions_p->TimerFunctions_p->Object_p
#define OBJECT_QUEUE(x) x->Functions_p->QueueFunctions_p->Object_p
#define OBJECT_HASH(x) x->HashDevice_p->Object_p
#define OBJECT_CEH_CALL(x) x->Object_p
extern Communication_t *GlobalCommunication_p;
extern Communication_t DebugCommunication;
/*******************************************************************************
* Declaration of functions
******************************************************************************/
#ifdef __cplusplus
extern "C"
{
#endif // #ifdef __cplusplus
/**
* Initialize an instance of the communication module.
*
* Given the initial family, already initialized hash device descriptor
* and communication device descriptor, a new instance of the
* communication module is created and bound to use the provided devices.
*
* @param [in] Object_p Instance which will use initialized communication.
* @param [in,out] Communication_pp Communication module context.
* @param [in] Family Initial protocol family.
* @param [in] HashDevice_p The device to use for checksum
* calculations and verifications.
* @param [in] CommunicationDevice_p The device to use for network
* transmission.
* @param [in] CommandCallback_p Collback function for command handling.
* @param [in] Buffers_p Pointer to buffer handling functions.
* @param [in] Timers_p Pointer to timers handling functions.
* @param [in] Queue_p Pointer to queue handling functions.
*
* @retval E_SUCCESS If the module instance is successfully
* initialized. A protocol family dependant error
* code otherwise.
*/
LCM_API ErrorCode_e Do_Communication_Initialize(void *Object_p, Communication_t **Communication_pp, Family_t Family, HashDevice_t *HashDevice_p, CommunicationDevice_t *CommunicationDevice_p, Do_CEH_Call_t CommandCallback_p, BuffersInterface_t *Buffers_p, TimersInterface_t *Timers_p, QueueInterface_t *Queue_p);
/**
* Shutdown an instance of the communication module.
*
* Shutdown the initialized protocol family, cancel current transmission and
* receiving data thru the communication device and shutdown the transport and
* network layer.
*
* @param [in,out] Communication_pp Communication module context.
*
* @retval E_SUCCESS If the module instance is successfully
* shut down. A protocol family dependant error
* code otherwise.
*/
LCM_API ErrorCode_e Do_Communication_Shutdown(Communication_t **Communication_pp);
/**
* Poll the network for inbound packets.
*
* When a packet is received it is put on the inbound queue. This
* function should be called whenever there is time to handle a new
* packet. It passes all the elements in the queue to the family
* specific polling function, one by one.
*
* @param [in] Communication_p Communication module context.
*
*
* @retval E_SUCCESS If all packets are successfully handled. A
* protocol family dependant error code otherwise.
*/
LCM_API ErrorCode_e Do_Communication_Poll(Communication_t *Communication_p);
/**
* Change the current protocol family.
*
* Shuts down the old protocol family and initializes the new one.
*
* @param [in] Communication_p Communication module context.
* @param [in] Family New protocol family identifier.
* @param [in] CEHCallback Callback that will handle the commands.
*
* @retval E_SUCCESS If the family is successfully changed. A
* protocol family dependant error code otherwise.
*/
LCM_API ErrorCode_e Do_Communication_SetFamily(Communication_t *Communication_p, Family_t Family, Do_CEH_Call_t CEHCallback);
/**
* Function for sending packet.
*
* @param [in] Communication_p Communication module context.
* @param [in] InputData_p Pointer to the data for tranmission.
*
* @retval E_SUCCESS After successful execution.
* @retval E_FAILED_TO_ALLOCATE_COMM_BUFFER Failed to allocate communication
* buffer.
*/
LCM_API ErrorCode_e Do_Communication_Send(Communication_t *Communication_p, void *InputData_p);
/**
* Function for setting the timeouts in the protocols.
*
* Timeouts that should be set depend of the protocol family. Some protocol
* family do not have timeouts.
*
* @param [in] Communication_p Communication module context.
* @param [in] TimeoutData_p Pointer to the data with all timeouts.
*
* @retval E_SUCCESS After successful execution.
*/
LCM_API ErrorCode_e Do_Communication_SetProtocolTimeouts(Communication_t *Communication_p, void *TimeoutData_p);
/**
* Function for getting the timeouts in the protocols.
*
* Timeouts that should be get depend of the protocol family. Some protocol
* family do not have timeouts.
*
* @param [in] Communication_p Communication module context.
* @param [out] TimeoutData_p Return data with all timeouts.
*
* @retval E_SUCCESS After successful execution.
*/
LCM_API ErrorCode_e Do_Communication_GetProtocolTimeouts(Communication_t *Communication_p, void *TimeoutData_p);
/**
* Function for getting the communication device for the given LCM instance.
*
* If communication is Singleton the function can be called with NULL
* pointer for Communication_p.
*
* @param [in] Communication_p Communication module context.
* @param [out] CommunicationDevice_pp Pointer to the initialized communication
* device for the given LCM context.
*
* @retval E_SUCCESS After successful execution.
* @retval E_INVALID_INPUT_PARAMTERS In case when communicaiton is not Singleton
* and Communication_p is NULL pointer.
*/
LCM_API ErrorCode_e Do_Communication_GetCommunicationDevice(Communication_t *Communication_p, CommunicationDevice_t **CommunicationDevice_pp);
/**
* Function for setting the communication device for the given LCM instance.
*
* If communication is Singleton the function can be called with NULL
* pointer for Communication_p.
*
* @param [in] Communication_p Communication module context.
* @param [out] CommunicationDevice_p Pointer to the initialized communication
* device to be set for the given LCM context.
*
* @retval E_SUCCESS After successful execution.
* @retval E_INVALID_INPUT_PARAMTERS In case when communicaiton is not Singleton
* and Communication_p is NULL pointer.
*/
LCM_API ErrorCode_e Do_Communication_SetCommunicationDevice(Communication_t *Communication_p, CommunicationDevice_t *CommunicationDevice_p);
/*
* Cancel Receiving new packets
*
* @param [in] Communication_p Communication module context.
* @param [in] PacketsBeforeReceiverStop Number of packets to be send before stopping the receiver.
*
* @retval E_SUCCESS If all packets are successfully handled. A
* protocol family dependant error code otherwise.
*/
LCM_API ErrorCode_e Do_Communication_Cancel_Receiver(Communication_t *Communication_p, uint8 PacketsBeforeReceiverStop);
/**
* Function used to get the LCM version.
*
* LCM version string for the current version is placed in lcm_version.c file
*
* @retval char LCM_CurrentVersion[] After successful execution.
*/
LCM_API char *Do_Communication_GetVersion();
#ifdef __cplusplus
};
#endif // #ifdef __cplusplus
/**
*
*/
void Do_CommunicationInternalErrorHandler(const ErrorCode_e IntError);
/** @} */
#endif // _INCLUSION_GUARD_R_COMMUNICATION_SERVICE_H_
|
