summaryrefslogtreecommitdiffhomepage
path: root/digital/zigbit/bitcloud/stack/Components/NWK/include/nwk.h
blob: 94f82a6cf124be5013e474976318d10d7a84d2cf (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
/**************************************************************************//**
  \file nwk.h

  \brief Interface of NWK layer.

  \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: nwk.h 17448 2011-06-09 13:53:59Z ataradov $
 ******************************************************************************/
#if !defined _NWK_H
#define _NWK_H

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

#include <nldeData.h>
#include <nlmeDirectJoin.h>
#include <nlmeEdScan.h>
#include <nlmeJoin.h>
#include <nlmeLeave.h>
#include <nlmeNetworkDiscovery.h>
#include <nlmeNetworkFormation.h>
#include <nlmeNwkStatus.h>
#include <nlmePermitJoining.h>
#include <nlmeReset.h>
#include <nlmeRouteDiscovery.h>
#include <nlmeStartRouter.h>
#include <nlmeSync.h>
#include <nlmeSyncLoss.h>

/** Extra network headers */
#include <nwkAttributes.h>
#include <nwkSecurity.h>
#include <nwkAddressResolv.h>
#include <nwkNeighbor.h>
#include <nwkRouteInfo.h>
#include <nwkGroup.h>

/******************************************************************************
                              Prototypes section
 ******************************************************************************/
/**************************************************************************//**
  \brief NWK_Init shall be called only by APS and only once at startup.

  \return None.
 ******************************************************************************/
void NWK_Init(void);

/**************************************************************************//**
  \brief The stack don't sleep if this function return 'true'.

  \return 'true' if the network layer if active otherwise 'false'.
 ******************************************************************************/
bool NWK_IsActiveTransaction(void);

/**************************************************************************//**
  \brief NWK layer activities launching
 ******************************************************************************/
void NWK_LaunchActivities(void);

/**************************************************************************//**
  \brief NWK layer activities stopping
 ******************************************************************************/
void NWK_StopActivities(void);

/**************************************************************************//**
  \brief Determine if node has all the parameters required to operate in network.

  \return True, if node has all the parameters required to operate in network;
          false - otherwise.
 ******************************************************************************/
bool NWK_DeviceIsAbleToOperateInNetwork(void);

#endif  /* _NWK_H */
/** eof nwk.h */