266 lines
8.7 KiB
C
266 lines
8.7 KiB
C
|
/**************************************************************************************************
|
|||
|
|
Filename: rtg.h
|
|||
|
|
Revised: $Date: 2010-10-19 12:38:16 -0700 (Tue, 19 Oct 2010) $
|
|||
|
|
Revision: $Revision: 24150 $
|
|||
|
|
|
|||
|
|
Description: Interface to mesh routing functions
|
|||
|
|
|
|||
|
|
|
|||
|
|
Copyright 2004-2010 Texas Instruments Incorporated. All rights reserved.
|
|||
|
|
|
|||
|
|
IMPORTANT: Your use of this Software is limited to those specific rights
|
|||
|
|
granted under the terms of a software license agreement between the user
|
|||
|
|
who downloaded the software, his/her employer (which must be your employer)
|
|||
|
|
and Texas Instruments Incorporated (the "License"). You may not use this
|
|||
|
|
Software unless you agree to abide by the terms of the License. The License
|
|||
|
|
limits your use, and you acknowledge, that the Software may not be modified,
|
|||
|
|
copied or distributed unless embedded on a Texas Instruments microcontroller
|
|||
|
|
or used solely and exclusively in conjunction with a Texas Instruments radio
|
|||
|
|
frequency transceiver, which is integrated into your product. Other than for
|
|||
|
|
the foregoing purpose, you may not use, reproduce, copy, prepare derivative
|
|||
|
|
works of, modify, distribute, perform, display or sell this Software and/or
|
|||
|
|
its documentation for any purpose.
|
|||
|
|
|
|||
|
|
YOU FURTHER ACKNOWLEDGE AND AGREE THAT THE SOFTWARE AND DOCUMENTATION ARE
|
|||
|
|
PROVIDED <EFBFBD>AS IS<EFBFBD> WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,
|
|||
|
|
INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY, TITLE,
|
|||
|
|
NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL
|
|||
|
|
TEXAS INSTRUMENTS OR ITS LICENSORS BE LIABLE OR OBLIGATED UNDER CONTRACT,
|
|||
|
|
NEGLIGENCE, STRICT LIABILITY, CONTRIBUTION, BREACH OF WARRANTY, OR OTHER
|
|||
|
|
LEGAL EQUITABLE THEORY ANY DIRECT OR INDIRECT DAMAGES OR EXPENSES
|
|||
|
|
INCLUDING BUT NOT LIMITED TO ANY INCIDENTAL, SPECIAL, INDIRECT, PUNITIVE
|
|||
|
|
OR CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA, COST OF PROCUREMENT
|
|||
|
|
OF SUBSTITUTE GOODS, TECHNOLOGY, SERVICES, OR ANY CLAIMS BY THIRD PARTIES
|
|||
|
|
(INCLUDING BUT NOT LIMITED TO ANY DEFENSE THEREOF), OR OTHER SIMILAR COSTS.
|
|||
|
|
|
|||
|
|
Should you have any questions regarding your right to use this Software,
|
|||
|
|
contact Texas Instruments Incorporated at www.TI.com.
|
|||
|
|
**************************************************************************************************/
|
|||
|
|
|
|||
|
|
#ifndef RTG_H
|
|||
|
|
#define RTG_H
|
|||
|
|
|
|||
|
|
#ifdef __cplusplus
|
|||
|
|
extern "C"
|
|||
|
|
{
|
|||
|
|
#endif
|
|||
|
|
|
|||
|
|
/*********************************************************************
|
|||
|
|
* INCLUDES
|
|||
|
|
*/
|
|||
|
|
|
|||
|
|
#include "ZComDef.h"
|
|||
|
|
#include "nwk_util.h"
|
|||
|
|
#include "nwk_bufs.h"
|
|||
|
|
#include "ZGlobals.h"
|
|||
|
|
|
|||
|
|
/*********************************************************************
|
|||
|
|
* MACROS
|
|||
|
|
*/
|
|||
|
|
|
|||
|
|
/*********************************************************************
|
|||
|
|
* CONSTANTS
|
|||
|
|
*/
|
|||
|
|
|
|||
|
|
#define RTG_TIMER_INTERVAL 1000
|
|||
|
|
|
|||
|
|
//Route request command option
|
|||
|
|
#define MTO_ROUTE 0x01 // Used in option of NLME_RouteDiscoveryRequest() and rtgTable[]
|
|||
|
|
#define NO_ROUTE_CACHE 0x02 // Used in option of NLME_RouteDiscoveryRequest() and rtgTable[]
|
|||
|
|
#define RTG_RECORD 0x04 // Used in option of rtgTable[]
|
|||
|
|
#define MTO_ROUTE_RC 0x08 // Sender has route cache. Used in option of rtgTable[]
|
|||
|
|
#define MTO_ROUTE_NRC 0x10 // Sender doesn't have route cache. Used in option of rtgTable[]
|
|||
|
|
#define DEST_IEEE_ADDR 0x20 // Used in option of route request command frame
|
|||
|
|
#define MULTICAST_ROUTE 0x40 // Ued in all three places
|
|||
|
|
#define RREQ_OPTIONS_MASK 0x78 // b'0111,1000 0-2, 7 are reserved bits
|
|||
|
|
|
|||
|
|
#define RTG_MTO_DEST_ADDRESS NWK_BROADCAST_SHORTADDR_DEVZCZR //0xFFFC
|
|||
|
|
|
|||
|
|
#define RREP_ORI_IEEE 0x10
|
|||
|
|
#define RREP_RES_IEEE 0x20
|
|||
|
|
#define RREP_MULTICAST 0x40
|
|||
|
|
#define RREP_OPTIONS_MASK (RREP_ORI_IEEE | RREP_RES_IEEE | RREP_MULTICAST)
|
|||
|
|
|
|||
|
|
#define RTG_END_DEVICE_ADDR_TYPE 0
|
|||
|
|
#define RTG_ROUTER_ADDR_TYPE 1
|
|||
|
|
|
|||
|
|
#define RTG_NO_EXPIRY_TIME 0xFF
|
|||
|
|
|
|||
|
|
/*********************************************************************
|
|||
|
|
* TYPEDEFS
|
|||
|
|
*/
|
|||
|
|
|
|||
|
|
typedef enum
|
|||
|
|
{
|
|||
|
|
RTG_SUCCESS,
|
|||
|
|
RTG_FAIL,
|
|||
|
|
RTG_TBL_FULL,
|
|||
|
|
RTG_HIGHER_COST,
|
|||
|
|
RTG_NO_ENTRY,
|
|||
|
|
RTG_INVALID_PATH,
|
|||
|
|
RTG_INVALID_PARAM,
|
|||
|
|
RTG_SRC_TBL_FULL
|
|||
|
|
} RTG_Status_t;
|
|||
|
|
|
|||
|
|
// status values for routing entries
|
|||
|
|
#define RT_INIT 0
|
|||
|
|
#define RT_ACTIVE 1
|
|||
|
|
#define RT_DISC 2
|
|||
|
|
#define RT_LINK_FAIL 3
|
|||
|
|
#define RT_REPAIR 4
|
|||
|
|
|
|||
|
|
// Routing table entry
|
|||
|
|
// Notice, if you change this structure, you must also change
|
|||
|
|
// rtgItem_t in ZDProfile.h
|
|||
|
|
typedef struct
|
|||
|
|
{
|
|||
|
|
uint16 dstAddress;
|
|||
|
|
uint16 nextHopAddress;
|
|||
|
|
byte expiryTime;
|
|||
|
|
byte status;
|
|||
|
|
uint8 options;
|
|||
|
|
} rtgEntry_t;
|
|||
|
|
|
|||
|
|
// Route discovery table entry
|
|||
|
|
typedef struct
|
|||
|
|
{
|
|||
|
|
byte rreqId;
|
|||
|
|
uint16 srcAddress;
|
|||
|
|
uint16 previousNode;
|
|||
|
|
byte forwardCost;
|
|||
|
|
byte residualCost;
|
|||
|
|
byte expiryTime;
|
|||
|
|
} rtDiscEntry_t;
|
|||
|
|
|
|||
|
|
// Broadcast table entry.
|
|||
|
|
typedef struct
|
|||
|
|
{
|
|||
|
|
uint16 srcAddr;
|
|||
|
|
uint8 bdt; // broadcast delivery time
|
|||
|
|
uint8 pat; // passive ack timeout
|
|||
|
|
uint8 mbr; // max broadcast retries
|
|||
|
|
uint8 handle;
|
|||
|
|
// Count of non-sleeping neighbors and router children.
|
|||
|
|
uint8 ackCnt;
|
|||
|
|
uint8 id;
|
|||
|
|
} bcastEntry_t;
|
|||
|
|
|
|||
|
|
// Source routing table
|
|||
|
|
typedef struct
|
|||
|
|
{
|
|||
|
|
uint8 expiryTime;
|
|||
|
|
uint8 relayCount;
|
|||
|
|
uint16 dstAddress;
|
|||
|
|
uint16* relayList;
|
|||
|
|
} rtgSrcEntry_t;
|
|||
|
|
/*********************************************************************
|
|||
|
|
* GLOBAL VARIABLES
|
|||
|
|
*/
|
|||
|
|
|
|||
|
|
extern rtgEntry_t rtgTable[];
|
|||
|
|
extern rtDiscEntry_t rtDiscTable[];
|
|||
|
|
|
|||
|
|
extern rtgSrcEntry_t rtgSrcTable[];
|
|||
|
|
|
|||
|
|
/*********************************************************************
|
|||
|
|
* FUNCTIONS
|
|||
|
|
*/
|
|||
|
|
|
|||
|
|
extern void RTG_Init( void );
|
|||
|
|
|
|||
|
|
extern rtgEntry_t *RTG_GetRtgEntry( uint16 DstAddress, uint8 options);
|
|||
|
|
|
|||
|
|
extern RTG_Status_t RTG_RemoveRtgEntry( uint16 DstAddress, uint8 options );
|
|||
|
|
|
|||
|
|
extern uint16 RTG_GetNextHop( uint16 DstAddress, uint16 avoidAddr,
|
|||
|
|
uint16 avoidAddr2, uint16 avoidAddr3, uint8 options );
|
|||
|
|
|
|||
|
|
extern byte RTG_ProcessRreq(
|
|||
|
|
NLDE_FrameFormat_t *ff, uint16 macSrcAddress, uint16 *nextHopAddr );
|
|||
|
|
|
|||
|
|
extern void RTG_ProcessRrep( NLDE_FrameFormat_t *ff, uint16 macSrcAddress );
|
|||
|
|
|
|||
|
|
extern void RTG_ProcessRrec( NLDE_FrameFormat_t *ff );
|
|||
|
|
|
|||
|
|
extern uint8 RTG_ProcessRErr( NLDE_FrameFormat_t *ff );
|
|||
|
|
extern void RTG_TimerEvent( void );
|
|||
|
|
|
|||
|
|
extern uint16 RTG_AllocNewAddress( byte deviceType );
|
|||
|
|
|
|||
|
|
extern void RTG_DeAllocTreeAddress( uint16 shortAddr );
|
|||
|
|
|
|||
|
|
extern void RTG_DeAllocStochasticAddress( uint16 shortAddr );
|
|||
|
|
|
|||
|
|
extern void RTG_BcastTimerHandler( void );
|
|||
|
|
|
|||
|
|
extern byte RTG_BcastChk( NLDE_FrameFormat_t *ff, uint16 macSrcAddr );
|
|||
|
|
|
|||
|
|
extern byte RTG_BcastAdd(NLDE_FrameFormat_t*ff, uint16 macSrcAddr, byte handle);
|
|||
|
|
|
|||
|
|
extern void RTG_BcastDel( byte handle );
|
|||
|
|
|
|||
|
|
extern void RTG_DataReq( osal_event_hdr_t *inMsg );
|
|||
|
|
|
|||
|
|
extern byte RTG_PoolAdd( NLDE_FrameFormat_t *ff );
|
|||
|
|
|
|||
|
|
extern uint16 RTG_GetTreeRoute( uint16 dstAddress );
|
|||
|
|
|
|||
|
|
extern uint16 RTG_SrcGetNextHop( uint8 rtgIndex, uint16* rtgList);
|
|||
|
|
|
|||
|
|
extern uint8 RTG_ValidateSrcRtg(uint8 relayCnt, uint8 relayIdx, uint16* relayList );
|
|||
|
|
|
|||
|
|
extern uint8 RTG_RtgRecordInitiation( uint16 DstAddress, uint16 SrcAddress, uint8 options);
|
|||
|
|
|
|||
|
|
extern RTG_Status_t RTG_GetRtgSrcEntry( uint16 dstAddr, uint8* pRelayCnt, uint16** ppRelayList);
|
|||
|
|
extern RTG_Status_t RTG_CheckRtStatus( uint16 DstAddress, byte RtStatus, uint8 options );
|
|||
|
|
|
|||
|
|
extern uint8 RTG_ProcessRtDiscBits( uint8 rtDiscFlag, uint16 dstAddress, uint8* pSrcRtgSet, uint8 options );
|
|||
|
|
|
|||
|
|
extern uint8 RTG_RouteMaintanence( uint16 DstAddress, uint16 SrcAddress, uint8 options );
|
|||
|
|
|
|||
|
|
extern void RTG_FillCSkipTable( byte *children, byte *routers,
|
|||
|
|
byte depth, uint16 *pTbl );
|
|||
|
|
|
|||
|
|
|
|||
|
|
extern uint8 RTG_IsAncestor( uint16 deviceAddress );
|
|||
|
|
|
|||
|
|
extern void RTG_SendBrokenRoute( uint16 nwkSrcAddr, uint16 nwkDstAddr,
|
|||
|
|
uint8 srcRouteSet, uint16 macSrcAddr, uint16 macDstAddr );
|
|||
|
|
|
|||
|
|
extern uint16 RTG_CalcTreeAddress( byte deviceType );
|
|||
|
|
|
|||
|
|
extern uint16 RTG_GetStochastic( byte deviceType );
|
|||
|
|
|
|||
|
|
extern uint16 RTG_GetNextTreeHop( uint16 dstAddress );
|
|||
|
|
|
|||
|
|
extern uint16 RTG_ChildGetNextHop( uint16 DstAddr );
|
|||
|
|
|
|||
|
|
extern uint8 RTG_GetAncestors( uint16 dstAddr, uint16 ancestorAddr, uint16 *pRtgDst );
|
|||
|
|
|
|||
|
|
extern void RTG_nextHopIsBad( uint16 nextHop );
|
|||
|
|
|
|||
|
|
extern ZStatus_t RTG_SendRErr( uint16 SrcAddress, uint16 DstAddress, byte ErrorCode );
|
|||
|
|
|
|||
|
|
|
|||
|
|
extern RTG_Status_t RTG_AddSrcRtgEntry_Guaranteed( uint16 srcAddr, uint8 relayCnt, uint16* pRelayList );
|
|||
|
|
|
|||
|
|
// Functions pointers for addressing schemes
|
|||
|
|
extern uint16 (*pRTG_FinishGetNextHop)( uint16 DstAddress );
|
|||
|
|
extern uint16 (*pRTG_GetNextTreeHop)( uint16 dstAddress );
|
|||
|
|
extern uint16 (*pRTG_CalcAddress)( byte deviceType );
|
|||
|
|
extern uint16 (*pRTG_GetTreeRoute)(uint16 dstAddress );
|
|||
|
|
extern void (*pRTG_DeAllocAddress)( uint16 shortAddr );
|
|||
|
|
extern uint8 (*pRTG_GetAncestors)( uint16 dstAddr, uint16 ancestorAddr, uint16 *pRtgDst );
|
|||
|
|
|
|||
|
|
extern void RTG_initRtgTable( void );
|
|||
|
|
|
|||
|
|
extern void RTG_MTORouteReq(void);
|
|||
|
|
|
|||
|
|
/*********************************************************************
|
|||
|
|
*********************************************************************/
|
|||
|
|
#ifdef __cplusplus
|
|||
|
|
}
|
|||
|
|
#endif
|
|||
|
|
|
|||
|
|
#endif /* RTG_H */
|