summaryrefslogtreecommitdiff
path: root/lcmodule/source/cnh1606344_ldr_communication_module/source/z_family.c
blob: d27a8b880858f596f744a465123fe71b78b36ba0 (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
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
/*******************************************************************************
 * Copyright (C) ST-Ericsson SA 2011
 * License terms: 3-clause BSD license
 ******************************************************************************/
/**
 * @addtogroup ldr_communication_serv
 * @{
 *    @addtogroup Z_family
 *    @{
 *      @addtogroup Z_protocol
 *      @{
 */


/*******************************************************************************
 * Includes
 ******************************************************************************/
#include <stdlib.h>
#include <string.h>

#include "r_z_family.h"
#include "r_z_protocol.h"
#include "r_z_network.h"
#include "r_z_transport.h"
#include "r_debug_macro.h"

/*******************************************************************************
 * File scope types, constants and variables
 ******************************************************************************/

/*******************************************************************************
 * Definition of external functions
 ******************************************************************************/

/*
 * Z family protocols initialization.
 *
 * Z transport and Z network layer will be initialized.
 *
 * @param [in] Communication_p Communication module context.
 *
 * @retval  E_SUCCESS                   After successful execution.
 * @retval  E_INVALID_INPUT_PARAMETERS  Invalid input parameter.
 */
ErrorCode_e Z_Family_Init(Communication_t *Communication_p)
{
    ErrorCode_e ReturnValue = E_INVALID_INPUT_PARAMETERS;

    if (NULL == Communication_p) {
        return E_INVALID_INPUT_PARAMETERS;
    }

    if (NULL != Communication_p->BackupCommBuffer_p) {
        free(Communication_p->BackupCommBuffer_p);
        Communication_p->BackupCommBuffer_p = NULL;
    }

    Communication_p->BackupCommBufferSize = 0;

    Communication_p->FamilyContext_p = malloc(sizeof(Z_FamilyContext_t));

    if (NULL == Communication_p->FamilyContext_p) {
        return E_ALLOCATE_FAILED;
    }

    Communication_p->CurrentFamilyHash = HASH_NONE;
    Z_NETWORK(Communication_p)->Inbound.StopTransfer = FALSE;

    ReturnValue = Z_Transport_Initialize(Communication_p);
    VERIFY(E_SUCCESS == ReturnValue, ReturnValue);

    ReturnValue = Z_Network_Initialize(Communication_p);

ErrorExit:
    return ReturnValue;
}

/*
 * Z family protocols shutdown.
 *
 * Z transport and Z network layer will be shutdown.
 *
 * @param [in] Communication_p Communication module context.
 *
 * @retval  E_SUCCESS                   After successful execution.
 * @retval  E_INVALID_INPUT_PARAMETERS  Invalid input parameter.
 */
ErrorCode_e Z_Family_Shutdown(Communication_t *Communication_p)
{
    ErrorCode_e ReturnValue = E_INVALID_INPUT_PARAMETERS;

    if (NULL == Communication_p) {
        return E_INVALID_INPUT_PARAMETERS;
    }

    ReturnValue = Z_Transport_Shutdown(Communication_p);
    VERIFY(E_SUCCESS == ReturnValue, ReturnValue);

    ReturnValue = Z_Network_Shutdown(Communication_p);
    VERIFY(E_SUCCESS == ReturnValue, ReturnValue);
    free(Communication_p->FamilyContext_p);
    Communication_p->FamilyContext_p = NULL;

    if (NULL != Communication_p->BackupCommBuffer_p) {
        free(Communication_p->BackupCommBuffer_p);
        Communication_p->BackupCommBuffer_p = NULL;
    }

    Communication_p->BackupCommBufferSize = 0;
    Communication_p->CurrentFamilyHash = HASH_NONE;

ErrorExit:

    return ReturnValue;
}

/*
 * Z family Cancel Transmission.
 *
 * @param [in] Communication_p Communication module context.
 * @param [in] PacketsBeforeTransferStop Number of packets that will be transmitted before stopping the transmission.
 *
 * @retval  E_SUCCESS                   After successful execution.
 * @retval  E_INVALID_INPUT_PARAMETERS  Invalid input parameter.
 */
ErrorCode_e Z_CancelReceiver(Communication_t *Communication_p, uint8 PacketsBeforeReceiverStop)
{
    ErrorCode_e ReturnValue = E_SUCCESS;

    VERIFY(NULL != Communication_p, E_INVALID_INPUT_PARAMETERS);

    Z_NETWORK(Communication_p)->Inbound.PacketsBeforeReceiverStop = PacketsBeforeReceiverStop;
    Z_NETWORK(Communication_p)->Inbound.StopTransfer = TRUE;

ErrorExit:
    A_(printf("protrom_family.c(%d) ErrorCode=%d\n", __LINE__, ReturnValue);)
    return ReturnValue;
}

/**         @} */
/**     @} */
/** @} */