summaryrefslogtreecommitdiff
path: root/digital/beacon/src/Bitcloud_stack/Components/NWK/include/nwkRouteInfo.h
diff options
context:
space:
mode:
Diffstat (limited to 'digital/beacon/src/Bitcloud_stack/Components/NWK/include/nwkRouteInfo.h')
-rw-r--r--digital/beacon/src/Bitcloud_stack/Components/NWK/include/nwkRouteInfo.h124
1 files changed, 0 insertions, 124 deletions
diff --git a/digital/beacon/src/Bitcloud_stack/Components/NWK/include/nwkRouteInfo.h b/digital/beacon/src/Bitcloud_stack/Components/NWK/include/nwkRouteInfo.h
deleted file mode 100644
index 679d393d..00000000
--- a/digital/beacon/src/Bitcloud_stack/Components/NWK/include/nwkRouteInfo.h
+++ /dev/null
@@ -1,124 +0,0 @@
-/**************************************************************************//**
- \file nwkRouteInfo.h
-
- \brief Public route information.
-
- \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:
- 2010-05-07 Max Gekk - Created.
- Last change:
- $Id: nwkRouteInfo.h 17448 2011-06-09 13:53:59Z ataradov $
- ******************************************************************************/
-#if !defined _NWK_ROUTE_INFO_H
-#define _NWK_ROUTE_INFO_H
-
-/******************************************************************************
- Includes section
- ******************************************************************************/
-#include <appFramework.h>
-
-/******************************************************************************
- Definitions section
- ******************************************************************************/
-/* Invalid concentrator descriptor. */
-#define NWK_INVALID_CONCENTRATOR (UINT8_MAX)
-/* Macro return true if concentrator descriptor is valid. */
-#define IS_VALID_CONCENTRATOR(descr) (NWK_INVALID_CONCENTRATOR != (descr))
-
-/******************************************************************************
- Types section
- ******************************************************************************/
-/* Type of concentrator descriptor. */
-typedef uint8_t NWK_Concentrator_t;
-
-/* Type of concentrator indication structure. */
-typedef struct _NWK_ConcentratorInd_t
-{
- /** Service fields - for internal needs. */
- struct
- {
- QueueElement_t qelem; /**< link used for queuing */
- } service;
- /* This function is called when new concentrator is found. */
- void (* NWK_ConcentratorInd)(NWK_Concentrator_t concentrator);
-} NWK_ConcentratorInd_t;
-
-/******************************************************************************
- Prototypes section
- ******************************************************************************/
-/**************************************************************************//**
- \brief This function return the 16-bit network address of the next hop on
- the way to the destination.
-
- \return The network address of the next hop.
- ******************************************************************************/
-ShortAddr_t NWK_GetNextHop(ShortAddr_t dstAddr);
-
-/**************************************************************************//**
- \brief Get descriptor of next concentrator.
-
- Example:
- NWK_Concentrator_t c = NWK_INVALID_CONCENTRATOR;
-
- while (IS_VALID_CONCENTRATOR(c = NWK_NextConcentrator(c)))
- {
- cAddr = NWK_ShortAddrOfConcentrator(c);
- if (MASTER_CONCENTRATOR_ADDR == cAddr)
- ...
- ...
- }
-
- \param[in] prevConcentrator - descriptor of previous concentrator or
- NWK_INVALID_CONCENTRATOR if it's initial call.
-
- \return if next concentrator is found then return valid descriptor otherwise
- return NWK_INVALID_CONCENTRATOR.
- ******************************************************************************/
-NWK_Concentrator_t NWK_NextConcentrator(const NWK_Concentrator_t prevConcentrator);
-
-/**************************************************************************//**
- \brief Get short address of given concentrator.
-
- Note: Call this function and NWK_NextConcentrator() in same task.
-
- \param[in] concentrator - descriptor of concentrator (see NWK_NextConcentrator).
- \return Short address of concentrator.
- ******************************************************************************/
-ShortAddr_t NWK_ShortAddrOfConcentrator(const NWK_Concentrator_t concentrator);
-
-/**************************************************************************//**
- \brief Get short address of next hop node for given concentrator.
-
- Note: Call this function and NWK_NextConcentrator() in same task.
-
- \param[in] concentrator - descriptor of concentrator (see NWK_NextConcentrator).
- \return Short address of next hop.
- ******************************************************************************/
-ShortAddr_t NWK_NextHopToConcentrator(const NWK_Concentrator_t concentrator);
-
-/**************************************************************************//**
- \brief Subscribe to indication about new concentrators.
-
- \param[in] ind - pointer to concentrator indication structure.
- \return None.
- ******************************************************************************/
-void NWK_SubscribeToConcentratorInfo(NWK_ConcentratorInd_t *const ind);
-
-/**************************************************************************//**
- \brief Unsubscribe from indication about new concentrators.
-
- \param[in] ind - pointer to concentrator indication structure.
- \return None.
- ******************************************************************************/
-void NWK_UnsubscribeFromConcentratorInfo(NWK_ConcentratorInd_t *const ind);
-
-#endif /* _NWK_ROUTE_INFO_H */
-/** eof nwkRouteInfo.h */
-