blob: 61690223f8742f91abca38d510a4e7cea76efe36 (
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
|
/*******************************************************************************
* Copyright (C) ST-Ericsson SA 2011
* License terms: 3-clause BSD license
******************************************************************************/
#ifndef INCLUSION_GUARD_R_Z_TRANSPORT_LAYER_H
#define INCLUSION_GUARD_R_Z_TRANSPORT_LAYER_H
/**
* @addtogroup ldr_communication_serv
* @{
* @addtogroup z_family
* @{
* @addtogroup ldr_z_transport_layer Z Transport layer
* TI functionalities for sending Z packets, Initialization and
* polling receiver and transmitter.
*
* @{
*/
/*******************************************************************************
* Includes
******************************************************************************/
#include "t_communication_service.h"
#include "error_codes.h"
/*******************************************************************************
* Declaration of functions
******************************************************************************/
/**
* Initializes the transport layer for Z protocol family.
*
* @param [in] Communication_p Communication module context.
*
* @retval E_SUCCESS After successful execution.
* @retval E_FAILED_TO_INIT_TL unsuccessful initialization.
* @retval E_ALLOCATE_FAILED failed to allocate memory space.
*/
ErrorCode_e Z_Transport_Initialize(const Communication_t *const Communication_p);
/**
* Shut Down the transport layer for Z protocol family.
*
* @param [in] Communication_p Communication module context.
*
* @retval E_SUCCESS After successful execution.
*/
ErrorCode_e Z_Transport_Shutdown(const Communication_t *const Communication_p);
/**
* Handles all registered TL processes for Z protocol family.
*
* @param [in] Communication_p Communication module context.
*
* @retval E_SUCCESS After successful execution.
*/
ErrorCode_e Z_Transport_Poll(Communication_t *Communication_p);
/**
* Function for sending packet in Z protocol family.
*
* @param [in] Communication_p Communication module context.
* @param [in] InputData_p Pointer to the input data.
*
* @retval E_SUCCESS After successful execution.
* @retval E_FAILED_TO_ALLOCATE_COMM_BUFFER Failed to allocate communication
* buffer.
*/
ErrorCode_e Z_Transport_Send(Communication_t *Communication_p, void *InputData_p);
/** @} */
/** @} */
/** @} */
#endif // INCLUSION_GUARD_R_Z_TRANSPORT_LAYER_H
|
