summaryrefslogtreecommitdiff
path: root/digital/zigbit/bitcloud/stack/Components/NWK/include/private/nwkTxDelay.h
blob: fb84144503d3d5e82aa4a836eb30df9b33faf2b5 (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
/**************************************************************************//**
  \file nwkTxDelay.h

  \brief Interface of transmission delays.

  \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-09-20 Max Gekk - Created.
   Last change:
    $Id: nwkTxDelay.h 18167 2011-08-08 11:26:31Z mgekk $
 ******************************************************************************/
#if !defined _NWK_TX_DELAY_H
#define _NWK_TX_DELAY_H

/******************************************************************************
                                Includes section
 ******************************************************************************/
#include <nwkConfig.h>
#include <appTimer.h>
#include <queue.h>
#include <nldeData.h>

/******************************************************************************
                                 Types section
 ******************************************************************************/
/** Internal variables of delay component. */
typedef struct _NwkTxDelay_t
{
  bool isTimerStarted;
  HAL_AppTimer_t timer;
  QueueDescriptor_t queue;
} NwkTxDelay_t;

/******************************************************************************
                              Prototypes section
 ******************************************************************************/
/**************************************************************************//**
  \brief Transmission delay request.

  \param[in] delayReq - pointer to delay request's parameters.
  \param[in] macStatus - pointer to MAC status of MLDE-DATA.confirm or NULL if
    it is first transmission.
  \return further behavior.
 ******************************************************************************/
NWK_PRIVATE NwkTxDelayStatus_t nwkTxDelayReq(NwkTxDelayReq_t *const delayReq,
  MAC_Status_t *const macStatus);

/**************************************************************************//**
  \brief The transmission delay has expired.

  \param[in] delayReq - pointer to delay request's parameters.
  \param[in] status - status of further behavior.
  \return None.
 ******************************************************************************/
NWK_PRIVATE void nwkTxDelayConf(NwkTxDelayReq_t *const delayReq,
  const NwkTxDelayStatus_t status);

/**************************************************************************//**
  \brief Flush all delays.
 ******************************************************************************/
NWK_PRIVATE void nwkFlushTxDelays(void);

/**************************************************************************//**
  \brief Reset delay component.
 ******************************************************************************/
NWK_PRIVATE void nwkResetTxDelays(void);

/******************************************************************************
  \brief nwkTxDelay idle checking.

  \return true, if nwkTxDelay performs no activity, false - otherwise.
 ******************************************************************************/
NWK_PRIVATE bool nwkTxDelayIsIdle(void);

/**************************************************************************//**
  \brief Delivery time of broadcast data transmission on a network.

  \return Current value of broadcast delivery time in milliseconds.
 ******************************************************************************/
NWK_PRIVATE uint32_t nwkGetBroadcastDeliveryTime(void);

#if defined _NWK_PASSIVE_ACK_ && (defined _ROUTER_ || defined _COORDINATOR_)
/**************************************************************************//**
  \brief All expected passive acks are received, confirm the passive ack req.

  \param[in] delayReq - pointer to delay request's parameters.
  \return None.
 ******************************************************************************/
NWK_PRIVATE void nwkPassiveAckConf(NwkTxDelayReq_t *const delayReq);
#endif /* _NWK_PASSIVE_ACK_ */

#endif /* _NWK_TX_DELAY_H */
/** eof nwkTxDelay.h */