summaryrefslogtreecommitdiff
path: root/lcmodule/source/cnh1605204_ldr_transport_layer/include/r_command_protocol.h
blob: d93fb9e89dc4a2e878bbdb976168c75086dc8300 (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
/*******************************************************************************
 * Copyright (C) ST-Ericsson SA 2011
 * License terms: 3-clause BSD license
 ******************************************************************************/
#ifndef _R_COMMAND_PROTOCOL_H_
#define _R_COMMAND_PROTOCOL_H_
/**
 *  @addtogroup ldr_communication_serv
 *  @{
 *    @addtogroup r15_family
 *    @{
 *      @addtogroup command_protocol Command Protocol
 *      Functionalities for handling command protocol. Receiving/Sending
 *      commands with command protocol.
 *
 *      @{
 */

/*******************************************************************************
 * Includes
 ******************************************************************************/
#include "t_command_protocol.h"
#include "t_r15_network_layer.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

/***********************************************************************
 * Declaration of functions
 **********************************************************************/

#ifdef __cplusplus
extern "C"
{
#endif // #ifdef __cplusplus
    /**
     * Reset the Session counters.
     *
     * @param [in]  Communication_p Communication module context.
     *
     * @retval  E_SUCCESS After successful execution.
     */
    LCM_API ErrorCode_e Do_R15_Command_ResetSessionCounters(const Communication_t *const Communication_p);

    /**
     * Sends command packet with command protocol.
     *
     * @param [in] Communication_p Communication module context.
     * @param [in] CmdData_p       Pointer to the command data.
     *
     * @retval  E_SUCCESS                  After successful execution.
     * @retval  E_INVALID_INPUT_PARAMETERS If CmdData_p is NULL.
     */
    LCM_API ErrorCode_e Do_R15_Command_Send(Communication_t *Communication_p, CommandData_t *CmdData_p);
#ifdef __cplusplus
};
#endif // #ifdef __cplusplus

/**
 * Decode received command.
 *
 * @param [in] Communication_p Communication module context.
 * @param [in] Packet_p        Pointer to the received buffer.
 *
 * @retval E_SUCCESS                  After successful execution.
 * @retval E_INVALID_INPUT_PARAMETERS if Packet_p is NULL.
 */
ErrorCode_e R15_Command_Process(Communication_t *Communication_p, PacketMeta_t *Packet_p);

/** @} */
/** @} */
/** @} */
#endif /* _R_COMMAND_PROTOCOL_H_*/