summaryrefslogtreecommitdiffhomepage
path: root/digital/zigbit/bitcloud/stack/Components/NWK/include/nlmeRouteDiscovery.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/nlmeRouteDiscovery.h
parent2ba279f4eb2f23fa08a7c13465d16ae6ba5d0f96 (diff)
digital/beacon: add bitcloud stack into common directory digital/zigbit
Diffstat (limited to 'digital/zigbit/bitcloud/stack/Components/NWK/include/nlmeRouteDiscovery.h')
-rw-r--r--digital/zigbit/bitcloud/stack/Components/NWK/include/nlmeRouteDiscovery.h88
1 files changed, 88 insertions, 0 deletions
diff --git a/digital/zigbit/bitcloud/stack/Components/NWK/include/nlmeRouteDiscovery.h b/digital/zigbit/bitcloud/stack/Components/NWK/include/nlmeRouteDiscovery.h
new file mode 100644
index 00000000..381dcb57
--- /dev/null
+++ b/digital/zigbit/bitcloud/stack/Components/NWK/include/nlmeRouteDiscovery.h
@@ -0,0 +1,88 @@
+/**************************************************************************//**
+ \file nlmeRouteDiscovery.h
+
+ \brief NLME-ROUTE-DISCOVERY 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-13 Max Gekk - Created.
+ Last change:
+ $Id: nlmeRouteDiscovery.h 17448 2011-06-09 13:53:59Z ataradov $
+ ******************************************************************************/
+#if !defined _NLME_ROUTE_DISCOVERY_H
+#define _NLME_ROUTE_DISCOVERY_H
+
+/******************************************************************************
+ Includes section
+ ******************************************************************************/
+#include <appFramework.h>
+#include <nlmeNwkStatus.h>
+#include <nwkCommon.h>
+
+/******************************************************************************
+ Types section
+ ******************************************************************************/
+/**//**
+ * \brief NLME-ROUTE-DISCOVERY confirm primitive's parameters structure.
+ * ZigBee Specification r17, 3.2.2.32 NLME-NETWORK-FORMATION.confirm, page 306.
+ */
+typedef struct _NWK_RouteDiscoveryConf_t
+{
+ /** The status of an attempt to initiate route discovery. */
+ NWK_Status_t status;
+ /** In the case where the Status parameter has a value of ROUTE_ERROR,
+ * this code gives further information about the kind of error that occurred.
+ * Otherwise, it should be ignored. ZigBee spec r17, Table 3.35. */
+ NWK_StatusIndErrorCodes_t networkStatusCode;
+ ShortAddr_t nextHop;
+} NWK_RouteDiscoveryConf_t;
+
+/**//**
+ * \brief NLME-ROUTE-DISCOVERY request primitive's parameters structure.
+ * Zigbee Specification r17, 3.2.2.31 NLME-ROUTE-DISCOVERY.request.
+ */
+typedef struct _NWK_RouteDiscoveryReq_t
+{
+ /** Service fields - for internal needs. */
+ struct
+ {
+ QueueElement_t qelem; /**< link used for queuing */
+ } service;
+ /** A parameter specifying the kind of destination address provided. */
+ NWK_DstAddrMode_t dstAddrMode;
+ /** The destination of the route discovery. */
+ ShortAddr_t dstAddr;
+ /** This optional parameter describes the number of hops that the route
+ * request will travel through the network. */
+ NwkRadius_t radius;
+ /** In the case where DstAddrMode has a value of zero, indicating many-to-one
+ * route discovery, this flag determines whether the NWK should establish
+ * a route record table. TRUE = no route record table should be established,
+ * FALSE = establish a route record table */
+ bool noRouteCache;
+ /** NLME-ROUTE-DISCOVERY confirm callback function's pointer. */
+ void (*NWK_RouteDiscoveryConf)(NWK_RouteDiscoveryConf_t *conf);
+ NWK_RouteDiscoveryConf_t confirm;
+} NWK_RouteDiscoveryReq_t;
+
+/******************************************************************************
+ Prototypes section
+ ******************************************************************************/
+/**************************************************************************//**
+ \brief NLME-ROUTE-DISCOVERY request primitive's prototype.
+
+ \param[in] req - NLME-ROUTE-DISCOVERY request parameters' structure pointer.
+ \return None.
+ ******************************************************************************/
+void NWK_RouteDiscoveryReq(NWK_RouteDiscoveryReq_t *const req);
+
+#endif /* _NLME_ROUTE_DISCOVERY_H */
+/** eof nlmeRouteDiscovery.h */
+