summaryrefslogtreecommitdiff
path: root/digital/zigbit/bitcloud/stack/Components/NWK/include/nlmeEdScan.h
diff options
context:
space:
mode:
authorFlorent Duchon2012-12-26 17:36:00 +0100
committerFlorent Duchon2013-02-13 21:21:12 +0100
commitb24866225a6301d3a663f874725e83c012dc25d3 (patch)
treeca527a2aab9abcdfbaf244c53ca63f0c531892b0 /digital/zigbit/bitcloud/stack/Components/NWK/include/nlmeEdScan.h
parent2ba279f4eb2f23fa08a7c13465d16ae6ba5d0f96 (diff)
digital/beacon: add bitcloud stack into common directory digital/zigbit
Diffstat (limited to 'digital/zigbit/bitcloud/stack/Components/NWK/include/nlmeEdScan.h')
-rw-r--r--digital/zigbit/bitcloud/stack/Components/NWK/include/nlmeEdScan.h88
1 files changed, 88 insertions, 0 deletions
diff --git a/digital/zigbit/bitcloud/stack/Components/NWK/include/nlmeEdScan.h b/digital/zigbit/bitcloud/stack/Components/NWK/include/nlmeEdScan.h
new file mode 100644
index 00000000..0e5a09bc
--- /dev/null
+++ b/digital/zigbit/bitcloud/stack/Components/NWK/include/nlmeEdScan.h
@@ -0,0 +1,88 @@
+/**************************************************************************//**
+ \file nlmeEdScan.h
+
+ \brief NLME-ED-SCAN 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: nlmeEdScan.h 17448 2011-06-09 13:53:59Z ataradov $
+ ******************************************************************************/
+#if !defined _NLME_ED_SCAN_H
+#define _NLME_ED_SCAN_H
+
+/******************************************************************************
+ Includes section
+ ******************************************************************************/
+#include <appFramework.h>
+#include <nwkCommon.h>
+
+/******************************************************************************
+ Define(s) section
+ ******************************************************************************/
+/** Maximum number of channels which can be scanned for one request. */
+#define MAX_EDSCAN_CHANNEL_AMOUNT 16U
+
+/******************************************************************************
+ Types section
+ ******************************************************************************/
+/**//**
+ * \brief NLME-ED-SCAN confirm primitive's parameters structure declaration.
+ * ZigBee Specification r17, 3.2.2.10 NLME-ED-SCAN.confirm
+ */
+typedef struct _NWK_EDScanConf_t
+{
+ /** The status of the request. */
+ NWK_Status_t status;
+ /** Indicates which channels given in the request were not scanned. */
+ ChannelsMask_t unScannedChannels;
+ /** Size of energyDetectList */
+ uint8_t energyDetectListSize;
+ /** The list of energy measurements */
+ PHY_EnergyLevel_t energyDetectList[MAX_EDSCAN_CHANNEL_AMOUNT];
+} NWK_EDScanConf_t;
+
+/**//**
+ * \brief NLME-ED-SCAN request primitive's parameters structure declaration.
+ * Zigbee Specification r17, 3.2.2.9 NLME-ED-SCAN.request.
+ */
+typedef struct _NWK_EDScanReq_t
+{
+ /** Service fields - for internal needs. */
+ struct
+ {
+ QueueElement_t qelem; /**< link used for queuing */
+ MAC_ScanReq_t macScanReq;
+ } service;
+ /** Bitmask of channels are to be scanned */
+ ChannelsMask_t scanChannels;
+ /** A value used to calculate the length of time to spend
+ * scanning each channel. */
+ ScanDuration_t scanDuration;
+ /** NLME-ED-SCAN confirm callback function's pointer. */
+ void (*NWK_EDScanConf)(NWK_EDScanConf_t *conf);
+ NWK_EDScanConf_t confirm;
+} NWK_EDScanReq_t;
+
+/******************************************************************************
+ Prototypes section
+ ******************************************************************************/
+/**************************************************************************//**
+ \brief NLME-ED-SCAN request primitive's prototype.
+
+ \param[in] req - NLME-ED-SCAN request parameters' structure pointer.
+ \return None.
+ ******************************************************************************/
+void NWK_EDScanReq(NWK_EDScanReq_t *const req);
+
+#endif /* _NLME_ED_SCAN_H */
+/** eof nlmeEdScan.h */
+