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

  \brief NLME-START-ROUTER interface

  \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-11 Max Gekk - Created.
   Last change:
    $Id: nlmeStartRouter.h 17448 2011-06-09 13:53:59Z ataradov $
 ******************************************************************************/
#if !defined _NLME_START_ROUTER_H
#define _NLME_START_ROUTER_H

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

/******************************************************************************
                               Types section
 ******************************************************************************/
/**//**
 * \brief NLME-START-ROUTER confirm primitive's parameters structure declaration.
 * ZigBee Specification r17, 3.2.2.7 NLME-START-ROUTER.confirm
 */
typedef struct _NWK_StartRouterConf_t
{
  /** The result of the attempt to initialize a ZigBee router.
   * Valid range: NWK_INVALID_REQUEST_STATUS or any status value returned from
   * the MAC_StartConf callback.*/
  NWK_Status_t status;
} NWK_StartRouterConf_t;

/**//**
 * \brief NLME-START-ROUTER request primitive's parameters structure declaration.
 * Zigbee Specification r17, 3.2.2.8 NLME-START-ROUTER.request.
 */
typedef struct _NWK_StartRouterReq_t
{
  /** Service fields - for internal needs. */
  struct
  {
    QueueElement_t qelem; /**< link used for queuing */
    MAC_StartReq_t macStart;
  } service;
  /** The beacon order of the network that the higher layers wish to form. */
  /* NwkBeaconOrder_t beaconOrder; */
  /* The superframe order of the network that the higher layers wish to form. */
  /* NwkBeaconOrder_t superFrameOrder; */
  /* Supporting battery life extension mode. This parameter is ignored if the
   * BeaconOrder parameter has a value of 15. */
  /* bool batteryLifeExtention; */
  /* NLME-START-ROUTER confirm callback function's pointer. */
  void (*NWK_StartRouterConf)(NWK_StartRouterConf_t *conf);
  /** NLME-START-ROUTER confirm primitive's parameters */
  NWK_StartRouterConf_t confirm;
} NWK_StartRouterReq_t;

/******************************************************************************
                              Prototypes section
 ******************************************************************************/
/**************************************************************************//**
  \brief NLME-START-ROUTER request primitive's prototype.

  \param[in] req - NLME-START-ROUTER request parameters' structure pointer.
  \return None.
 ******************************************************************************/
void NWK_StartRouterReq(NWK_StartRouterReq_t *const req);

#endif /* _NLME_START_ROUTER_H */
/** eof nlmeStartRouter.h */