summaryrefslogtreecommitdiffhomepage
path: root/digital/zigbit/bitcloud/stack/Components/MAC_PHY/MAC_ENV/include/macenvPib.h
blob: e1d9e2a9f6b4d2ed6892401e19e4213ae58b6241 (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
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
/**************************************************************************//**
  \file macenvPib.h

  \brief MAC and PHY PIB access function prototypes.

  \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:
      28/09/07 A. Mandychev - Created macphyPibServer.h.
      10/06/08 A. Mandychev - Renamed to macenvPib.h.
      22/12/10 A. Razinkov - Merged with macenvPibOldCs.h
******************************************************************************/

#ifndef _MACENVPIB_H
#define _MACENVPIB_H

/******************************************************************************
                    Includes section
******************************************************************************/
#include <types.h>
#include <macphyPib.h>
#include <macCommon.h>
#include <macMem.h>

/******************************************************************************
                    Define(s) section
******************************************************************************/
#define MS_1000 1000U /* Divider from us to ms. */

/******************************************************************************
                    Types section
******************************************************************************/
//! PIB request's descriptor.
typedef struct
{
  MACPHY_PibId_t   id;
  MACPHY_PibAttr_t attr;
} MacPhyPibReq_t;

/******************************************************************************
                   Constants section
******************************************************************************/

/******************************************************************************
                    External variables section
******************************************************************************/
extern PIB_t csPIB;

/******************************************************************************
                   Prototypes section
******************************************************************************/
/**************************************************************************//**
  \brief Resets MACPHY PIB.
  \param none.
  \return none.
******************************************************************************/
void macenvResetPib(void);

/**************************************************************************//**
  \brief Sets MAC or PHY attribute to PIB.
  \param[in] pibAttr - pointer to attribute structure.
  \return SUCCESS, READ_ONLY, UNSUPPORTED_ATTRIBUTE or INVALID_PARAMETER.
******************************************************************************/
MAC_Status_t macenvSetPibAttr(const MacPhyPibReq_t *pibAttr);

/**************************************************************************//**
  \brief Gets MAC or PHY attribute from PIB.
  \param[inout] pibAttr - pointer to attribute structure.
  \return SUCCESS or UNSUPPORTED_ATTRIBUTE.
******************************************************************************/
MAC_Status_t macenvGetPibAttr(MacPhyPibReq_t *pibAttr);

/**************************************************************************//**
  \brief Calculates  maximum frame total wait time.
  \return maximum frame total wait time.
******************************************************************************/
uint32_t macenvCalculateMaxFrameTotalWaitTimeInMs(void);

/******************************************************************************
  Calculates  MAC response wait time (IEEE standart: macResponseWaitTime).
  Parameters:
    none.
  Return:
    MAC response wait time.
******************************************************************************/
uint32_t macenvCalculateResponceWaitTimeInMs(void);

/**************************************************************************//**
  \brief Detects PHY symbol duration.
  \param none;
  \return PHY symbol duration.
******************************************************************************/
uint8_t macenvGetPhySymbolDuration(void);

#ifdef _FFD_
/**************************************************************************//**
  \brief Calculates MAC transaction persistence time im ms.

  \param[in] MAC transaction persistence time in unit periods.
             IEEE802.15.4_2006, 7.4.2, Table 86, page 166.
  \return time calculated (milliseconds).
******************************************************************************/
uint32_t macenvConvertTransPersistTimeFromUnitsToMs(uint16_t transPersTimeInUnits);
#endif // _FFD_

/**************************************************************************//**
  \brief Gets current value for dsn parameter of PHY&MAC PIB and then increments it.
  \return current dsn value.
******************************************************************************/
INLINE uint8_t macenvGetAndIncDsn(void)
{
  return csPIB.macAttr.dsn++;
}

/**************************************************************************//**
  \brief Gets current value for bsn parameter of PHY&MAC PIB and then increments it.
  \return current bsn value.
******************************************************************************/
#ifdef _FFD_
INLINE uint8_t macenvGetAndIncBsn(void)
{
  return csPIB.macAttr.bsn++;
}
#endif // _FFD_

/**************************************************************************//**
  \brief Gets channel.
  \return current channel.
******************************************************************************/
INLINE uint8_t macenvGetChannel(void)
{
  return csPIB.phyAttr.channel;
}

/**************************************************************************//**
  \brief Gets supported channels.
  \return supported channels.
******************************************************************************/
INLINE uint32_t macenvGetChannelsSupported(void)
{
  return csPIB.phyAttr.channelsSupported;
}

/**************************************************************************//**
  \brief Gets tx power.
  \return current tx power.
******************************************************************************/
INLINE int8_t macenvGetTxPower(void)
{
  return csPIB.phyAttr.transmitPower;
}

/**************************************************************************//**
  \brief Gets CCA mode.
  \return current CCA mode.
******************************************************************************/
INLINE PHY_CcaMode_t macenvGetCcaMode(void)
{
  return csPIB.phyAttr.ccaMode;
}

/**************************************************************************//**
  \brief Gets current page.
  \return current page.
******************************************************************************/
INLINE uint8_t macenvGetCurrentPage(void)
{
  return csPIB.phyAttr.currentPage;
}

/**************************************************************************//**
  \brief Gets max CSMA backoffs.
  \return max CSMA backoffs.
******************************************************************************/
INLINE uint8_t macenvGetMaxCsmaBackoffs(void)
{
  return csPIB.macAttr.maxCsmaBackoffs;
}

/**************************************************************************//**
  \brief Gets PAN ID.
  \return PAN ID.
******************************************************************************/
INLINE PanId_t macenvGetPanId(void)
{
  return csPIB.macAttr.panId;
}

/**************************************************************************//**
  \brief Gets short address.
  \return short address.
******************************************************************************/
INLINE ShortAddr_t macenvGetShortAddr(void)
{
  return csPIB.macAttr.shortAddr;
}

/**************************************************************************//**
  \brief Gets min BE.
  \return min BE.
******************************************************************************/
INLINE uint8_t macenvGetMinBe(void)
{
  return csPIB.macAttr.minBe;
}

/**************************************************************************//**
  \brief Gets max frame retries.
  \return max frame retries.
******************************************************************************/
INLINE uint8_t macenvGetMaxFrameRetries(void)
{
  return csPIB.macAttr.maxFrameRetries;
}

/**************************************************************************//**
  \brief Gets rx on when idle parameter.
  \return rx on when idle parameter.
******************************************************************************/
INLINE bool macenvGetRxOnWhenIdle(void)
{
  return csPIB.macAttr.rxOnWhenIdle;
}

/**************************************************************************//**
  \brief Gets coordinator short address.
  \return coordinator short address.
******************************************************************************/
INLINE ShortAddr_t macenvGetCoordShortAddr(void)
{
  return csPIB.macAttr.coordShortAddr;
}

/**************************************************************************//**
  \brief Gets pointer to coordinator extended address.
  \return pointer to coordinator extended address.
******************************************************************************/
INLINE ExtAddr_t* macenvGetCoordExtAddr(void)
{
  return &csPIB.macAttr.coordExtAddr;
}

/**************************************************************************//**
  \brief Gets response wait time.
  \return response wait time.
******************************************************************************/
INLINE uint8_t macenvGetResponseWaitTime(void)
{
  return csPIB.macAttr.responseWaitTime;
}

/**************************************************************************//**
  \brief Gets PAN coordinator parameter.
  \return PAN coordinator parameter.
******************************************************************************/
INLINE bool macenvGetPanCoordinator(void)
{
  return csPIB.macAttr.panCoordinator;
}

/**************************************************************************//**
  \brief Gets association permit parameter.
  \return association permit parameter.
******************************************************************************/
#ifdef _FFD_
INLINE bool macenvGetAssociationPermit(void)
{
  return csPIB.macAttr.associationPermit;
}
#endif

/**************************************************************************//**
  \brief Gets beacon payload pointer.
  \return beacon payload pointer.
******************************************************************************/
#ifdef _FFD_
INLINE uint8_t* macenvGetBeaconPayload(void)
{
  return csPIB.macAttr.beaconPayload;
}
#endif

/**************************************************************************//**
  \brief Gets beacon payload length.
  \return beacon payload length.
******************************************************************************/
#ifdef _FFD_
INLINE uint8_t macenvGetBeaconPayloadLength(void)
{
  return csPIB.macAttr.beaconPayloadLength;
}
#endif

/**************************************************************************//**
  \brief Gets beacon tx enable parameter.
  \return beacon tx enable parameter.
******************************************************************************/
#ifdef _FFD_
INLINE bool macenvGetBeaconTxEnable(void)
{
  return csPIB.macAttr.beaconTxEnable;
}
#endif

/**************************************************************************//**
  \brief Gets auto request parameter.
  \return auto request parameter.
******************************************************************************/
INLINE bool macenvGetAutoRequest(void)
{
  return csPIB.macAttr.autoRequest;
}

/**************************************************************************//**
  \brief Gets associated PAN coordinator parameter.
  \return associated PAN coordinator parameter.
******************************************************************************/
INLINE bool macenvGetAssociatedPanCoord(void)
{
  return csPIB.macAttr.associatedPanCoord;
}

/**************************************************************************//**
  \brief Sets channel.
  \param channel - channel to set.
  \return none.
******************************************************************************/
INLINE void macenvSetChannel(uint8_t channel)
{
  csPIB.phyAttr.channel = channel;
}

/**************************************************************************//**
  \brief Sets short address.
  \param shortAddr - short address.
  \return none.
******************************************************************************/
INLINE void macenvSetShortAddr(ShortAddr_t shortAddr)
{
  csPIB.macAttr.shortAddr = shortAddr;
}

/**************************************************************************//**
  \brief Sets associated pan coordinator parameter.
  \param associatedPanCoord.
  \return none.
******************************************************************************/
INLINE void macenvSetAssociatedPanCoord(bool associatedPanCoord)
{
  csPIB.macAttr.associatedPanCoord = associatedPanCoord;
}

/**************************************************************************//**
  \brief Sets coordinator short address.
  \param coordShortAddr - coordinator short address.
  \return none.
******************************************************************************/
INLINE void macenvSetCoordShortAddr(ShortAddr_t coordShortAddr)
{
  csPIB.macAttr.coordShortAddr = coordShortAddr;
}

/**************************************************************************//**
  \brief Sets coordinator ext address.
  \param coordExtAddr - coordinator ext address.
  \return none.
******************************************************************************/
INLINE void macenvSetCoordExtAddr(ExtAddr_t* coordExtAddr)
{
  COPY_EXT_ADDR(csPIB.macAttr.coordExtAddr, *coordExtAddr);
}

/**************************************************************************//**
  \brief Sets PAN ID.
  \param panId - PAN ID.
  \return none.
******************************************************************************/
INLINE void macenvSetPanId(PanId_t panId)
{
  csPIB.macAttr.panId = panId;
}

/**************************************************************************//**
  \brief Sets PAN coordinator parameter.
  \param panCoordinator - PAN coordinator parameter.
  \return none.
******************************************************************************/
INLINE void macenvSetPanCoordinator(bool panCoordinator)
{
  csPIB.macAttr.panCoordinator = panCoordinator;
}

/**************************************************************************//**
  \brief Sets beacon payload length.
  \param beaconTxEnable - beacon tx enable parameter.
  \return none.
******************************************************************************/
#ifdef _FFD_
INLINE void macenvSetBeaconTxEnable(bool beaconTxEnable)
{
  csPIB.macAttr.beaconTxEnable = beaconTxEnable;
}
#endif

/******************************************************************************
  \brief Converts time in Microseconds to time in Milliseconds.
  \param[in] time in microseconds.
  \return time in milliseconds
******************************************************************************/
INLINE uint32_t convertTimeFromUsToMs(uint32_t timeInUs)
{
  return (timeInUs / MS_1000);
}

/**************************************************************************//**
  \brief Sets max frame transmission time attribute value.

  \param[in] time - new max frame transmission time value.
  \return None.
 ******************************************************************************/
INLINE void MAC_SetMaxFrameTransmissionTime(const uint8_t time)
{
  csPIB.macAttr.maxFrameTransmissionTime = time;
}

/**************************************************************************//**
  \brief Gets max frame transmission time attribute value.

  \return Max frame transmission time attribute value.
 ******************************************************************************/
INLINE uint8_t MAC_GetMaxFrameTransmissionTime(void)
{
  return csPIB.macAttr.maxFrameTransmissionTime;
}

#endif /* _MACENVPIB_H */

// eof macenvPib.h