summaryrefslogtreecommitdiffhomepage
path: root/digital/zigbit/bitcloud/stack/Components/NWK/include/nwkCommon.h
blob: e17fd64b821026219b96f0a90423345958b00900 (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
341
342
343
344
345
346
347
348
349
350
351
352
353
/**************************************************************************//**
  \file nwkCommon.h

  \brief Declarations of common NWK layer constants and types.

  \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
   History:
    2009-04-13 Max Gekk - Created.
   Last change:
    $Id: nwkCommon.h 17470 2011-06-10 11:31:00Z mgekk $
 ******************************************************************************/
#if !defined _NWK_COMMON_H
#define _NWK_COMMON_H

/******************************************************************************
                                Includes section
 ******************************************************************************/
#include <types.h>
#include <queue.h>

/******************************************************************************
                               Definitions section
 ******************************************************************************/
/** Base NWK header length of data packet:
 * - frame control field (2 octets),
 * - destination address (2 octets),
 * - source address (2 octets),
 * - radius (1 octet),
 * - sequence number (1 octet),
 * - multicast control field (1 octet). */
#define NWK_DATA_FRAME_HEADER_LENGTH 9U
/** Length of auxiliary frame header. See ZigBee spec r18, Figure 4.3. */
#if defined _SECURITY_
  #define NWK_AUXILIARY_HEADER_SIZE 14U
  #define NWK_MAX_DATA_FRAME_FOOTER_LENGTH 4U
#else
  #define NWK_AUXILIARY_HEADER_SIZE 0U
  #define NWK_MAX_DATA_FRAME_FOOTER_LENGTH 0U
#endif /* _SECURITY_ */

/** The hop count radius for concentrator route discoveries.
 * ZigBee spec r18, Table 3.44, page 348. */
#define NWK_CONCENTRATOR_RADIUS 8U /* hop */
/** The maximum number of hops in a source route. ZigBee spec r18, Table 3.44.
 **/
#define NWK_MAX_SOURCE_ROUTE (NWK_CONCENTRATOR_RADIUS)
/** Maximum length of the source route subframe:
 * - relay count field (1 octet),
 * - relay index field (1 octet),
 * - relay list (NWK_MAX_SOURCE_ROUTE * size of short address).
 * See ZigBee spec r18, 3.3.1.9, page 316. */
#if defined _NWK_SOURCE_ROUTING_
  #define NWK_MAX_SOURCE_ROUTE_SUBFRAME_LENGTH (2U+(2U*NWK_MAX_SOURCE_ROUTE))
#else
  #define NWK_MAX_SOURCE_ROUTE_SUBFRAME_LENGTH 0U
#endif /* _NWK_SOURCE_ROUTING_ */

/** Maximum lenght of NWK header. */
#define NWK_MAX_UNSECURE_HEADER_LEHGTH \
  (NWK_DATA_FRAME_HEADER_LENGTH + NWK_MAX_SOURCE_ROUTE_SUBFRAME_LENGTH)
#define NWK_MAX_DATA_FRAME_HEADER_LEHGTH \
  (NWK_MAX_UNSECURE_HEADER_LEHGTH + NWK_AUXILIARY_HEADER_SIZE)

/** Length of the reserved part in the data frame. */
#define NWK_AFFIX_LENGTH (MAC_AFFIX_LENGTH + \
   NWK_MAX_DATA_FRAME_HEADER_LEHGTH + NWK_MAX_DATA_FRAME_FOOTER_LENGTH)

/** Length of the reserved header in the data frame. */
#define NWK_NSDU_OFFSET (MAC_MSDU_OFFSET + NWK_MAX_DATA_FRAME_HEADER_LEHGTH)

/** Maximum lenght of NWK payload. */
#define NWK_MAX_NSDU_SIZE (MAC_MAX_MSDU_SIZE \
   - NWK_MAX_DATA_FRAME_HEADER_LEHGTH - NWK_MAX_DATA_FRAME_FOOTER_LENGTH)

/** Valid broadcast addresses. See ZigBee spec r18, Table 3.54, page 411. */
#define IS_BROADCAST_ADDR(A) (LE16_TO_CPU(A) >= 0xFFF8U)
#define IS_CORRECT_SHORT_ADDR(A) (LE16_TO_CPU(A) < 0xFFF8U)

/** Low power routers only. */
#define LOW_POWER_ROUT_ADDR CCPU_TO_LE16(0xFFFBU)
#define BROADCAST_ADDR_LOWPOWER_ROUTERS LOW_POWER_ROUT_ADDR

/** All routers and coordinator in a network. */
#define ALL_ROUT_AND_COORD_ADDR CCPU_TO_LE16(0xFFFCU)
#define BROADCAST_ADDR_ROUTERS ALL_ROUT_AND_COORD_ADDR

/** All devices with MAC attribute macRxOnWhenIdle = TRUE. */
#define RX_ON_WHEN_IDLE_ADDR CCPU_TO_LE16(0xFFFDU)
#define BROADCAST_ADDR_RX_ON_WHEN_IDLE RX_ON_WHEN_IDLE_ADDR

/** All devices in PAN. */
#define ALL_DEVICES_IN_PAN_ADDR 0xFFFFU
#define BROADCAST_ADDR_ALL ALL_DEVICES_IN_PAN_ADDR

/** The value of the nwkNetworkAddress attribute of its NIB has
 * a value of 0xffff indicating that it is not currently joined to a network. */
#define NWK_NO_SHORT_ADDR 0xFFFFU

/** The maximum broadcast jitter time measured in number of octets.
 *  ZigBee spec r18, Table 3.43. */
#define NWKC_MAX_BROADCAST_JITTER 2000U /*<! ~0x40 milliseconds in 2.4GHz */

/* Maximum radius for non-member mode multicast frame. */
#define NWK_MAX_NON_MEMBER_MULTICAST_RADIUS 7U

/** The value of the extendedPanId attribute in NIB has
 * a value of 0x0000000000000000 indicating that the device is not (or wasn't)
 * currently joined to a network. */
#define NWK_NO_EXT_PANID 0ULL

/******************************************************************************
                                 Types section
 ******************************************************************************/
/** NWK primitives' return codes. ZigBee spec r17, 3.7, page 417. */
typedef enum _NWK_Status
{
  /** A request has been executed successfully. */
  NWK_SUCCESS_STATUS                 = 0x00,
  /** The MAC requested operation was completed successfully. */
  NWK_MAC_SUCCESS_STATUS             = 0x00,
  /** IEEE 802.15.4-2006, Table 83.
   * Valid values of the Association Status field. */
  NWK_MAC_PAN_AT_CAPACITY_STATUS     = 0x01,
  NWK_MAC_PAN_ACCESS_DENIED_STATUS   = 0x02,
  /** An invalid or out-of-range parameter has been passed to a primitive from
   * the next higher layer. */
  NWK_INVALID_PARAMETERS_STATUS      = 0xC1,
  /** The next higher layer has issued a request that is invalid or cannot be
   * executed given the current state of the NWK layer. */
  NWK_INVALID_REQUEST_STATUS         = 0xC2,
  /** An NLME-JOIN.request has been disallowed. */
  NWK_NOT_PERMITTED_STATUS           = 0xC3,
  /** An NLME-NETWORK-FORMATION.request has failed to start a network. */
  NWK_STARTUP_FAILURE_STATUS         = 0xC4,
  /** A device with the address supplied to the NLMEDIRECT-JOIN.request is
   * already present in the neighbor table of the device on which
   * the NLME-DIRECT-JOIN.request was issued. */
  NWK_ALREADY_PRESENT_STATUS         = 0xC5,
  /** Used to indicate that an NLME-SYNC.request has failed at the MAC layer. */
  NWK_SYNC_FAILURE_STATUS            = 0xC6,
  /** An NLME-JOIN-DIRECTLY.request has failed because there is no more room in
   * the neighbor table. */
  NWK_NEIGHBOR_TABLE_FULL_STATUS     = 0xC7,
  /** An NLME-LEAVE.request has failed because the device addressed in
   * the parameter list is not in the neighbor table of the issuing device. */
  NWK_UNKNOWN_DEVICE_STATUS          = 0xC8,
  /** An NLME-GET.request or NLME-SET.request has been issued with
   * an unknown attribute identifier. */
  NWK_UNSUPPORTED_ATTRIBUTE_STATUS   = 0xC9,
  /** An NLME-JOIN.request has been issued in an environment
   * where no networks are detectable. */
  NWK_NO_NETWORKS_STATUS             = 0xCA,
  /** Security processing has been attempted on an outgoing frame,
   * and has failed because the frame counter has reached its maximum value. */
  NWK_MAX_FRM_COUNTER_STATUS         = 0xCC,
  /** Security processing has been attempted on an outgoing frame,
   * and has failed because no key was available with which to process it. */
  NWK_NO_KEY_STATUS                  = 0xCD,
  /** Security processing has been attempted on an outgoing frame,
   * and has failed because the security engine produced erroneous output. */
  NWK_BAD_CCM_OUTPUT_STATUS          = 0xCE,
  /** An attempt to discover a route has failed due to a lack of routing table
   * or discovery table capacity. */
  NWK_NO_ROUTING_CAPACITY_STATUS     = 0xCF,
  /** An attempt to discover a route has failed due to a reason other
   * than a lack of routing capacity. */
  NWK_ROUTE_DISCOVERY_FAILED_STATUS  = 0xD0,
  /** An NLDE-DATA.request has failed due to a routing
   * failure on the sending device. */
  NWK_ROUTE_ERROR_STATUS             = 0xD1,
  /** An attempt to send a broadcast frame or member mode multicast has failed
   * due to the fact that there is no room in the BTT. */
  NWK_BT_TABLE_FULL_STATUS           = 0xD2,
  /** An NLDE-DATA.request has failed due to insufficient buffering available.
   **/
  NWK_FRAME_NOT_BUFFERED_STATUS      = 0xD3,
  /** IEEE 802.15.4-2006, Table 78 MAC enumerations description. */
  /** The frame counter purportedly applied by the originator of the
   * received frame is invalid. */
  NWK_MAC_COUNTER_ERROR_STATUS       = 0xDB,
  /** The key purportedly applied by the originator of the received frame is
   * not allowed to be used with that frame type according to the key usage
   * policy of the recipient. */
  NWK_MAC_IMPROPER_KEY_TYPE_STATUS   = 0xDC,
  /** The security level purportedly applied by the originator of the received
   * frame does not meet the minimum security level required/expected by
   * the recipient for that frame type. */
  NWK_MAC_IMPROPER_SECURITY_LEVEL_STATUS = 0xDD,
  /** The received frame was purportedly secured using security based on
   * IEEE Std 802.15.4-2003, and such security is not supported by this standard.
   **/
  NWK_MAC_UNSUPPORTED_LEGACY_STATUS   = 0xDE,
  /** The security purportedly applied by the originator of the received frame
   * is not supported. */
  NWK_MAC_UNSUPPORTED_SECURITY_STATUS = 0xDF,
  /** The beacon was lost following a synchronization request. */
  NWK_MAC_BEACON_LOSS_STATUS          = 0xE0,
  /** A transmission could not take place due to activity on the channel,
   * i.e., the CSMA-CA mechanism has failed. */
  NWK_MAC_CHANNEL_ACCESS_FAILURE_STATUS = 0xE1,
  /** The GTS request has been denied by the PAN coordinator. */
  NWK_MAC_DENIED_STATUS               = 0xE2,
  /** The attempt to disable the transceiver has failed. */
  NWK_MAC_DISABLE_TRX_FAILURE_STATUS  = 0xE3,
  /** Either a frame resulting from processing has a length that is
   * greater than aMaxPHYPacketSize or a requested transaction is
   * too large to fit in the CAP or GTS. */
  NWK_MAC_FRAME_TOO_LONG_STATUS       = 0xE5,
  /** The requested GTS transmission failed because the specified
   * GTS either did not have a transmit GTS direction or was not defined. */
  NWK_MAC_INVALID_GTS_STATUS          = 0xE6,
  /** A request to purge an MSDU from the transaction queue was made using
   * an MSDU handle that was not found in the transaction table. */
  NWK_MAC_INVALID_HANDLE_STATUS       = 0xE7,
  /** A parameter in the primitive is either not supported or is out of
   * the valid range. */
  NWK_MAC_INVALID_PARAMETER_STATUS    = 0xE8,
  /** No acknowledgment was received after macMaxFrameRetries. */
  NWK_MAC_NO_ACK_STATUS               = 0xE9,
  /** A scan operation failed to find any network beacons. */
  NWK_MAC_NO_BEACON_STATUS            = 0xEA,
  /** No response data were available following a request. */
  NWK_MAC_NO_DATA_STATUS              = 0xEB,
  /** The operation failed because a 16-bit short address was not allocated. */
  NWK_MAC_NO_SHORT_ADDRESS_STATUS     = 0xEC,
  /** A receiver enable request was unsuccessful because it could not be
   * completed within the CAP. */
  NWK_MAC_OUT_OF_CAP_STATUS           = 0xED,
  /** A PAN identifier conflict has been detected and communicated
   * to the PAN coordinator. */
  NWK_MAC_PAN_ID_CONFLICT_STATUS      = 0xEE,
  /** A coordinator realignment command has been received. */
  NWK_MAC_REALIGNMENT_STATUS          = 0xEF,
  /** The transaction has expired and its information was discarded. */
  NWK_MAC_TRANSACTION_EXPIRED_STATUS  = 0xF0,
  /** There is no capacity to store the transaction. */
  NWK_MAC_TRANSACTION_OVERFLOW_STATUS = 0xF1,
  /** The transceiver was in the transmitter enabled state when the receiver
   * was requested to be enabled. */
  NWK_MAC_TX_ACTIVE_STATUS            = 0xF2,
  /** The key purportedly used by the originator of the received frame is
   * not available or, if available, the originating device is not known
   * or is blacklisted with that particular key. */
  NWK_MAC_UNAVAILABLE_KEY_STATUS      = 0xF3,
  /** A SET/GET request was issued with the identifier of a PIB
   * attribute that is not supported. */
  NWK_MAC_UNSUPPORTED_ATTRIBUTE_STATUS = 0xF4,
  /** A request to send data was unsuccessful because neither the source address
   * parameters nor the destination address parameters were present. */
  NWK_MAC_INVALID_ADDRESS_STATUS      = 0xF5,
  /** A receiver enable request was unsuccessful because it specified a number
   * of symbols that was longer than the beacon interval. */
  NWK_MAC_ON_TIME_TOO_LONG_STATUS     = 0xF6,
  /** A receiver enable request was unsuccessful because it could not be
   * completed within the current superframe and was not permitted to be
   * deferred until the next superframe. */
  NWK_MAC_PAST_TIME_STATUS            = 0xF7,
  /** The device was instructed to start sending beacons based on the
   * timing of the beacon transmissions of its coordinator, but the device
   * is not currently tracking the beacon of its coordinator. */
  NWK_MAC_TRACKING_OFF_STATUS         = 0xF8,
  /** An attempt to write to a MAC PIB attribute that is in a table failed
   * because the specified table index was out of range. */
  NWK_MAC_INVALID_INDEX_STATUS        = 0xF9,
  /** There are some unscanned channels yet, but there is no memory */
  NWK_MAC_LIMIT_REACHED_STATUS        = 0xFA,
  /** A SET/GET request was issued with the identifier of an attribute
   * that is read only. */
  NWK_MAC_READ_ONLY_STATUS            = 0xFB,
  /** A request to perform a scan operation failed because the MLME was
   * in the process of performing a previously initiated scan operation. */
  NWK_MAC_SCAN_IN_PROGRESS_STATUS     = 0xFC,
  /** The device was instructed to start sending beacons based on the timing of
   * the beacon transmissions of its coordinator, but the instructed start time
   * overlapped the transmission time of the beacon of its coordinator. */
  NWK_MAC_SUPERFRAME_OVERLAP_STATUS   = 0xFD
} NWK_Status_t;

/** Type of the 64-bit PAN identifier of the network.*/
typedef uint64_t ExtPanId_t;

/** Type of channels mask. */
typedef uint32_t ChannelsMask_t;

/** Type of MAC channel number. */
typedef uint8_t Channel_t;

/** Type of update identifier. The value identifying a snapshot of the network
 * settings with which this node is operating with.*/
typedef uint8_t NwkUpdateId_t;

/** Type of sequence number of NWK packets. */
typedef uint8_t NwkSequenceNumber_t;

typedef uint8_t BeaconOrder_t;
typedef BeaconOrder_t ScanDuration_t;

/** Type of link quality indicator. */
typedef uint8_t Lqi_t;
/** Type of received signal strength indication. */
typedef int8_t Rssi_t;

/** Type of link cost. */
typedef uint8_t NwkLinkCost_t;
/** Type of route path cost. */
typedef uint8_t NwkPathCost_t;

/** Length of any NWK data: header, payload and etc. */
typedef uint8_t NwkLength_t;

/** Type of children counters. */
typedef uint8_t NwkChildCount_t;

typedef uint8_t NwkDepth_t;
typedef NwkDepth_t NwkRadius_t;

/** The kind of destination address*/
typedef enum _NWK_DstAddrMode_t
{
  NWK_DSTADDRMODE_NOADDR    = 0, /**< No destination address. */
  /** 16-bit network address of a multicast group. */
  NWK_DSTADDRMODE_MULTICAST = 1,
  /** 16-bit network address of an individual device or a broadcast address. */
  NWK_DSTADDRMODE_SHORT     = 2
} NWK_DstAddrMode_t;

/** The method used to assign addresses. */
typedef enum _NWK_AddrAlloc_t
{
  NWK_ADDR_ALLOC_DISTRIBUTED = 0, /**< Use distributed address allocation. */
  NWK_ADDR_ALLOC_RESERVED    = 1,
  NWK_ADDR_ALLOC_STOCHASTIC  = 2, /**< Use stochastic address allocation. */
  NWK_ADDR_ALLOC_FROM_UID    = 3  /**< Use 2 octet from IEEE extended address. */
} NWK_AddrAlloc_t;

/** Type of initial route request identifier. */
typedef uint8_t NwkRouteRequestId_t;

/** Global state of the network layer. */
typedef uint8_t NwkState_t;

typedef  BitField_t  NwkBitField_t;

#endif /* _NWK_COMMON_H */
/** eof nwkCommon.h */