summaryrefslogtreecommitdiffhomepage
path: root/digital/zigbit/bitcloud/stack/Components/ZCL/include/zclZllInterPan.h
blob: 471f8a481f119a34e286e1f5cbe89b477f353eb0 (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
/**************************************************************************//**
  \file zclZllInterPan.h

  \brief
    ZLL Inter-PAN operation 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:
    17.03.10 A. Taradov - Created.
******************************************************************************/
#ifndef _ZCLZLLINTERPAN_H
#define	_ZCLZLLINTERPAN_H

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

/******************************************************************************
                    Definitions section
******************************************************************************/

/******************************************************************************
                    Types section
******************************************************************************/
typedef struct _ZCL_ZllInterPanStartConf_t
{
  ZCL_ZllStatus_t         status;
} ZCL_ZllInterPanStartConf_t;

typedef struct _ZCL_ZllInterPanStartReq_t
{
  ZCL_ZllInterPanStartConf_t confirm;
  void (*ZCL_ZllInterPanStartConf)(ZCL_ZllInterPanStartConf_t *conf);
} ZCL_ZllInterPanStartReq_t;

/******************************************************************************
                        Prototypes section
******************************************************************************/

/**************************************************************************//**
\brief Reset ZLL Inter-PAN module
******************************************************************************/
void ZCL_ZllInterPanReset(void);

/**************************************************************************//**
\brief Prepare stack for Inter-PAN operation

The function prepares the device for Inter-PAN communication. It is required 
for starting network scan (invoked by the ZCL_ZllScanReq() function).

The function is executed asynchronously. Invocation of the callback function
provided in the \c req->ZCL_ZllInterPanStartConf field indicates request
completion. If the request has been successful (the reported status equals
::ZCL_ZLL_SUCCESS_STATUS) ZigBee network features become unavailable.

To restore normal stack operation, when Inter-PAN data exchange has finished, 
call the ZDO_ResetNetworkReq() function.
******************************************************************************/
void ZCL_ZllInterPanStartReq(ZCL_ZllInterPanStartReq_t *req);

#endif // _ZCLZLLINTERPAN_H

// eof zclZllInterPan.h