ndp_router_adv.h

Go to the documentation of this file.

 
#ifndef _NDP_ROUTER_ADV_H
#define _NDP_ROUTER_ADV_H
 
//Dependencies
#include "core/net.h"
#include "ipv6/ipv6.h"
 
//RA service support
#ifndef NDP_ROUTER_ADV_SUPPORT
   #define NDP_ROUTER_ADV_SUPPORT DISABLED
#elif (NDP_ROUTER_ADV_SUPPORT != ENABLED && NDP_ROUTER_ADV_SUPPORT != DISABLED)
   #error NDP_ROUTER_ADV_SUPPORT parameter is not valid
#endif
 
//RA service tick interval
#ifndef NDP_ROUTER_ADV_TICK_INTERVAL
   #define NDP_ROUTER_ADV_TICK_INTERVAL 100
#elif (NDP_ROUTER_ADV_TICK_INTERVAL < 10)
   #error NDP_ROUTER_ADV_TICK_INTERVAL parameter is not valid
#endif
 
//Application specific context
#ifndef NDP_ROUTER_ADV_PRIVATE_CONTEXT
   #define NDP_ROUTER_ADV_PRIVATE_CONTEXT
#endif
 
//Forward declaration of NdpRouterAdvContext structure
struct _NdpRouterAdvContext;
#define NdpRouterAdvContext struct _NdpRouterAdvContext
 
//C++ guard
#ifdef __cplusplus
extern "C" {
#endif
 
 
typedef void (*NdpRouterAddOptionsCallback)(NdpRouterAdvContext *context,
   NdpRouterAdvMessage *message, size_t *length);
 
 
typedef struct
{
   Ipv6Addr prefix;
   uint8_t length;
   bool_t onLinkFlag;
   bool_t autonomousFlag;
   uint32_t validLifetime;
   uint32_t preferredLifetime;
} NdpRouterAdvPrefixInfo;
 
 
typedef struct
{
   Ipv6Addr prefix;
   uint8_t length;
   uint8_t preference;
   uint32_t routeLifetime;
} NdpRouterAdvRouteInfo;
 
 
typedef struct
{
   uint8_t cid;
   Ipv6Addr prefix;
   uint8_t length;
   bool_t compression;
   uint16_t validLifetime;
} NdpRouterAdvContextInfo;
 
 
typedef struct
{
   NetInterface *interface;                        
   systime_t maxRtrAdvInterval;                    
   systime_t minRtrAdvInterval;                    
   uint8_t curHopLimit;                            
   bool_t managedFlag;                             
   bool_t otherConfigFlag;                         
   bool_t homeAgentFlag;                           
   uint8_t preference;                             
   bool_t proxyFlag;                               
   uint16_t defaultLifetime;                       
   uint32_t reachableTime;                         
   uint32_t retransTimer;                          
   uint32_t linkMtu;                               
   NdpRouterAdvPrefixInfo *prefixList;             
   uint_t prefixListLength;                        
   NdpRouterAdvRouteInfo *routeList;               
   uint_t routeListLength;                         
   NdpRouterAdvContextInfo *contextList;           
   uint_t contextListLength;                       
   NdpRouterAddOptionsCallback addOptionsCallback; 
} NdpRouterAdvSettings;
 
 
struct _NdpRouterAdvContext
{
   NdpRouterAdvSettings settings; 
   bool_t running;                
   systime_t timestamp;           
   systime_t timeout;             
   uint_t routerAdvCount;         
   NDP_ROUTER_ADV_PRIVATE_CONTEXT 
};
 
 
//Tick counter to handle periodic operations
extern systime_t ndpRouterAdvTickCounter;
 
//RA service related functions
void ndpRouterAdvGetDefaultSettings(NdpRouterAdvSettings *settings);
 
error_t ndpRouterAdvInit(NdpRouterAdvContext *context,
   const NdpRouterAdvSettings *settings);
 
error_t ndpRouterAdvStart(NdpRouterAdvContext *context);
error_t ndpRouterAdvStop(NdpRouterAdvContext *context);
 
//C++ guard
#ifdef __cplusplus
}
#endif
 
#endif