summaryrefslogtreecommitdiff
path: root/digital/beacon/src/Bitcloud_stack/Components/APS/include/private/apsMemoryManager.h
blob: 6206ca226f636c1a381c4f206308b16262841327 (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
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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
/*************************************************************************//**
  \file apsMemoryManager.h

  \brief The header file describes APS memory manager primitive.

  \author
    Atmel Corporation: http://www.atmel.com \n
    Support email: avr@atmel.com

  Copyright (c) 2008-2011, Atmel Corporation. All rights reserved.
  Licensed under Atmel's Limited License Agreement (BitCloudTM).

  \internal

*****************************************************************************/

#ifndef APSMEMORYMANAGER_H_
#define APSMEMORYMANAGER_H_

/******************************************************************************
                   Includes section
******************************************************************************/
#include <queue.h>
#include <aps.h>
#include <nwk.h>
#include <appTimer.h>
#include <apsmeBind.h>
#include <apsFrames.h>
#include <sspSfp.h>
#include <sspAuthentic.h>

/******************************************************************************
                   Types section
******************************************************************************/
typedef enum
{
  APS_DM_DATA_BUFFER_TYPE,
  APS_DM_ACK_DATA_BUFFER_TYPE,
  APS_SM_FREE_BUFFER_TYPE,
  APS_SM_AUR_SSP_AUTH_BUFFER_TYPE,
  APS_SM_AUR_CHALLENGE_COMMAND_BUFFER_TYPE,
  APS_SM_AUR_MAC_DATA_COMMAND_TYPE,
  APS_SM_AUI_SSP_AUTH_BUFFER_TYPE,
  APS_SM_AUI_CHALLENGE_COMMAND_BUFFER_TYPE,
  APS_SM_AUI_MAC_COMMAND_BUFFER_TYPE,
  APS_SM_SSPD_BUFFER_TYPE,
  APS_SM_UDR_COMMAND_BUFFER_TYPE,             //UpdateDevice command
  APS_SM_RDR_COMMAND_BUFFER_TYPE,             //RemoveDevice command
  APS_SM_RKR_COMMAND_BUFFER_TYPE,             //RequestKey command
  APS_SM_SKR_COMMAND_BUFFER_TYPE,             //RequestKey command
  APS_SM_TKR_COMMAND_BUFFER_TYPE,             //TransportKey command
  APS_SM_TKI_COMMAND_BUFFER_TYPE,
  APS_SM_COMMAND_IND_BUFFER_TYPE,
  APS_TUNNEL_COMMAND_BUFFER_TYPE
} ApsBufferType_t;

typedef enum {
  APS_DEFAULT_STATE,
  APS_NLDE_DATA_CONF_WAIT_STATE,
  APS_ACK_WAIT_STATE,
  APS_ACK_RECEIVED_STATE,
  APS_RETRANSMISSION_STATE,
  APS_TIMEOUT_STATE,
} ApsDataDescriptorState_t ;

typedef enum
{
  APS_NLDE_DATA_REQ_BUFFER_TYPE,          //Request for data transmission without ack waiting
  APS_NLDE_DATA_REQ_WITH_ACK_BUFFER_TYPE, //Request for data transmission with ack waiting
  APS_NLDE_DATA_REQ_ACK_BUFFER_TYPE,      //Request for APS ACK transmission
  APS_NLDE_DATA_REQ_BLOCK_BUFFER_TYPE,    //Request for part of fragmented data transmission
} ApsNldeDataReqType_t;

typedef struct
{
#ifdef _SECURITY_
#ifdef _LINK_SECURITY_ 
  uint8_t headerLength;
  QueueElement_t queueElement;
  APS_Status_t securityStatus;
  APS_KeyHandle_t keyHandle;
#endif // _LINK_SECURITY_ 
#endif //_SECURITY_

  uint8_t busy:1;
  ApsNldeDataReqType_t entryType:7;
  ApsDataDescriptorState_t state:4;
  //if request with ack requested data frame then it is a retries counter
  uint8_t retriesCounter:4;

  NWK_DataReq_t nwkDataReq; //NLDE-DATA.request primitive

#ifdef _BINDING_
  ApsBindingEntry_t *bindEntry;
#endif
} ApsDataDescriptor_t;

typedef struct
{
  APS_DataReq_t *link; // request pointer
  ApsBufferType_t type;
  uint32_t timeout;
  ApsDataDescriptor_t dataDescriptor;
} ApsDataBuffer_t ;

/*
  APS Acknowledge buffer declaration
*/
typedef struct
{
  /* Current buffer status */
  bool busy;
  /* Determines type of encryption to be used for ack */
  APS_Status_t securityStatus;
  /* Link to relative NWK_DataInd entity */
  NWK_DataInd_t *dataIndLink;

  BEGIN_PACK
  TOP_GUARD
  struct PACK
  {
    uint8_t lowLevelHeader[NWK_NSDU_OFFSET];
#ifdef _LINK_SECURITY_ 
    uint8_t apsSecHeader[APS_AUXILIARY_HEADER_LENGTH];
#endif /* _LINK_SECURITY_ */

    union  PACK
    {
      ApduAcknowledgementFrame_t dataAck; //Acknowledgement frame for data
      ApduCommandAcknowledgementFrame_t commandAck; //Acknowledgement frame for command
    } frame;
#ifdef _LINK_SECURITY_ 
    uint8_t apsSecFooter[APS_MAX_DATA_FRAME_FOOTER_LENGTH];
#endif /* _LINK_SECURITY_ */

#if (NWK_AFFIX_LENGTH - NWK_NSDU_OFFSET)
    uint8_t lowLevelFooter[NWK_AFFIX_LENGTH - NWK_NSDU_OFFSET];
#endif
  };
  BOTTOM_GUARD
  END_PACK
} ApsAckBuffer_t;

typedef struct
{
  uint8_t buffersAmount;
  ApsAckBuffer_t *buffers;
} ApsAckBuffersPool_t;

typedef struct
{
  uint8_t buffersAmount;
  uint8_t maxAckCounter;
  uint8_t maxReqCounter;
  uint8_t ackCounter;
  uint8_t reqCounter;
  ApsDataBuffer_t *buffers;
} ApsDataReqBuffersPool_t;

#ifdef _APS_FRAGMENTATION_
typedef struct
{
  uint8_t state;
  uint8_t *buffers;
  uint8_t *bufferLengths;
  uint8_t maxBlocksAmount;
  uint16_t blockSize;
  uint32_t timeout;
  uint8_t blocksAmount;
  uint8_t currentWindowStartBlockNumber;
  uint8_t ackBitfield;
  uint16_t srcAddress;
  uint8_t dstEndpoint;
  uint16_t clusterId;
  uint16_t profileId;
  uint8_t srcEndpoint;
  uint8_t apsCounter;
  ApsDataBuffer_t apsBuffer;
  ApsAckBuffer_t apsAckBuffer;
  APS_Status_t securityStatus;
} ApsFragmRxDescr_t;

typedef struct
{
  uint8_t blockNumber;
  uint8_t ackBlockNumber; // block number that expect ack, also it is first block number in the window
  uint8_t blocksToTransmit; // block in window requires to  transmit. 1 required transmission
  uint8_t blocksCount;
  uint8_t apsCounter;
  uint8_t retryCounter;
  HAL_AppTimer_t sendTimer; // timer that send frame per apsInterframeDelay
  ApsDataBuffer_t *block; // memory for block
  uint8_t *buffer;
} ApsFragmTxDescr_t;
#endif // _APS_FRAGMENTATION_

/*
 * APS sublayer memory structure.
 */
typedef struct
{
  ApsDataReqBuffersPool_t dataReqBuffersPool; // Buffers to execute APS Data requests
  ApsAckBuffersPool_t ackBuffersPool; // Buffers to generate APS acknowledgements
#ifdef _APS_FRAGMENTATION_
  ApsFragmRxDescr_t apsFragmRxDescr;
  ApsFragmTxDescr_t apsFragmTxDescr;
#endif // _APS_FRAGMENTATION_
} ApsMem_t;


/******************************************************************************
                   Extern variables section
******************************************************************************/
extern ApsMem_t apsMem;

/******************************************************************************
                   Prototypes section
******************************************************************************/
/*****************************************************************************
  \brief Make a reset of APS Memory Manager

  \param fullReset - reset all internal variables of APS-layer or not.
  \retur none
*****************************************************************************/
APS_PRIVATE void apsResetMemoryManager(void);

/***************************************************************************//**
  \brief Allocates memory buffer for NLDE-DATA.request primitive specified by
  parameter primitiveType.

  \param primitiveType - type of buffer which will be allocated
    APS_NLDE_DATA_REQ_BUFFER_TYPE - NLDE-DATA.request without frame
    APS_NLDE_DATA_REQ_WITH_ACK_BUFFER_TYPE - NLDE-DATA.request with ack
      required flag in APDU
    APS_NLDE_DATA_REQ_ACK_BUFFER_TYPE - NLDE-DATA.request with ack frame
  \return nonNULL buffer pointer if memory was allocated successfully
          NULL - no free buffers available.
*******************************************************************************/
APS_PRIVATE ApsDataBuffer_t *apsGetBuffer(uint8_t primitiveType);

/***************************************************************************//**
  \brief Deallocate memory buffer

  \param buffer - pointer to buffer to be freed.
  \return None
*******************************************************************************/
APS_PRIVATE void apsFreeBuffer(void *buffer);

/***************************************************************************//**
  \brief Check memory availability for NLDE-DATA.request primitive to generate
  APS acknowledge.

  \param  None
  \return true - memory is available
          false - in other case
*******************************************************************************/
APS_PRIVATE bool apsIsBufferAvailableForAck(void);

/******************************************************************************
                   Inline functions section
******************************************************************************/
/*****************************************************************************
  \brief Gives pointer to APS layer memory pool.

  \param none
  \retur pointer to APS memory pool.
*****************************************************************************/
INLINE ApsDataReqBuffersPool_t *apsGetDataReqBuffersMem(void)
{
  return &apsMem.dataReqBuffersPool;
}

/*****************************************************************************
  \brief Gives pointer to APS layer acknowledgements memory pool.

  \param none
  \retur pointer to APS acknowledgements memory pool.
*****************************************************************************/
INLINE ApsAckBuffersPool_t *apsGetAckBuffersMem(void)
{
  return &apsMem.ackBuffersPool;
}

#ifdef _APS_FRAGMENTATION_
/*****************************************************************************
  \brief Gives pointer to APS layer fragmentation feature memory (Rx).

  \param none
  \retur pointer to fragmentation feature memory (Rx).
*****************************************************************************/
INLINE ApsFragmRxDescr_t *apsGetFragmRxDescrMem(void)
{
  return &apsMem.apsFragmRxDescr;
}

/*****************************************************************************
  \brief Gives pointer to APS layer fragmentation feature memory (Tx).

  \param none
  \retur pointer to fragmentation feature memory (Tx).
*****************************************************************************/
INLINE ApsFragmTxDescr_t *apsGetFragmTxDescrMem(void)
{
  return &apsMem.apsFragmTxDescr;
}

/*****************************************************************************
  \brief Resets structure which controls fragmented data receiption procedure.

  \param none
  \retur none
*****************************************************************************/
INLINE void apsResetFragmRxDescr(void)
{
  ApsFragmRxDescr_t *apsFragmRxDescr = apsGetFragmRxDescrMem();

  apsFragmRxDescr->ackBitfield = 0;
  apsFragmRxDescr->apsCounter = 0;
  apsFragmRxDescr->blocksAmount = 0;
  apsFragmRxDescr->clusterId = 0;
  apsFragmRxDescr->currentWindowStartBlockNumber = 0;
  apsFragmRxDescr->dstEndpoint = 0;
  apsFragmRxDescr->profileId = 0;
  apsFragmRxDescr->srcAddress = 0;
  apsFragmRxDescr->srcEndpoint = 0;
  apsFragmRxDescr->state = 0;
  apsFragmRxDescr->timeout = 0;

  memset(&apsFragmRxDescr->apsBuffer, 0, sizeof(apsFragmRxDescr->apsBuffer));
  memset(&apsFragmRxDescr->apsAckBuffer, 0, sizeof(apsFragmRxDescr->apsAckBuffer));
  memset(apsFragmRxDescr->buffers, 0,
    apsFragmRxDescr->maxBlocksAmount * apsFragmRxDescr->blockSize + apsFragmRxDescr->maxBlocksAmount);

  apsFragmRxDescr->apsBuffer.dataDescriptor.nwkDataReq.nsdu = (uint8_t *)&apsFragmRxDescr->apsAckBuffer.frame;
}

#endif // ifdef _APS_FRAGMENTATION_
#endif /*APSMEMORYMANAGER_H_*/

//eof apsMemoryManager.h