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

  \brief EDScan header file.

  \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:
    2007-06-14 S. Vladykin - Created.
    2008-12-10 M. Gekk     - Reduction of the used RAM.
    2009-03-15 M. Gekk     - Refactoring.
   Last change:
    $Id: nwkEDScan.h 17448 2011-06-09 13:53:59Z ataradov $
 *****************************************************************************/
#if !defined _NWK_EDSCAN_H
#define _NWK_EDSCAN_H

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

/*****************************************************************************
                              Types section
 *****************************************************************************/
/** Internal states of NLME-ED-SCAN component */
typedef enum _NwkEDScanState_t
{
  NWK_EDSCAN_IDLE_STATE = 0x13,
  NWK_EDSCAN_FIRST_STATE = 0xE7,
  NWK_EDSCAN_BEGIN_STATE = NWK_EDSCAN_FIRST_STATE,
  NWK_EDSCAN_MAC_SCAN_STATE = 0xE8,
  NWK_EDSCAN_CONFIRM_STATE = 0xE9,
  NWK_EDSCAN_LAST_STATE
} NwkEDScanState_t;

/** Internal parameters of NLME-ED-SCAN */
typedef struct _NwkEDScan_t
{
  QueueDescriptor_t queue; /**< Queue of requests from upper layer */
  NwkEDScanState_t state; /**< finite-state machine */
  NwkState_t savedStateMachine;
} NwkEDScan_t;

/*****************************************************************************
                             Prototypes section
 *****************************************************************************/
/*************************************************************************//**
  \brief Reset NLME-ED-SCAN component.
 *****************************************************************************/
NWK_PRIVATE void nwkResetEDScan(void);

/******************************************************************************
  \brief nwkEDScan idle checking.

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

/*************************************************************************//**
  \brief Main task handler of NLME-ED-SCAN
 *****************************************************************************/
NWK_PRIVATE void nwkEDScanTaskHandler(void);

#endif /* _NWK_EDSCAN_H */
/** eof nwkEDScan.h */