E:/fip/workspaces/fip/source/corenet/fip_nd6_ds6.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010, FIP AUTHORS
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1) Redistributions of source code must retain the above copyright notice,
 *      this list of conditions and the following disclaimer.
 *
 *   2) Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *
 *   3) Neither the name of the FIP AUTHORS nor the names of its contributors
 *       may be used to endorse or promote products derived from this software
 *       without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */
/**
 * @addtogroup fip_nd6_ds6
 * @{
 */
/**
 * @file
 *         Header for private data structures accessed by fip_nd6.c file.
 *
 * @author
 *         Colin O'Flynn
 */


#ifndef FIP_ND6_DS_H_
#define FIP_ND6_DS_H_

#include <stddef.h>
#include "fip_ds6.h"

/** Inherit size from generic data structures */
typedef fip_ds6_index_t         fip_nd6_index_t;
/** Inherit size from generic data structures */
typedef fip_ds6_searchStatus_t  fip_nd6_searchStatus_t;

/** State a neighbour can be in */
typedef enum {
    NS_UNUSED = 0,
    NS_STALE,
    NS_INCOMPLETE,
    NS_PROBE,
    NS_REACHABLE
} fip_nd6_nbrstate_t ;


/** Entry of a neighbour cache */
typedef struct {
    fip_nd6_nbrstate_t  state;          /**< State of entry */
    unsigned char   isRouter: 1;        /**< Is device a router? */
    unsigned char   numEvents: 7;       /**< Number of events left */
    uint32_t        nextEventTime32ms;  /**< Time of next event */
    fip_ip6addr_t   ipaddr;             /**< IP Address of entry */
    fip_lladdr_t    lladdr;             /**< LL Address of entry */
} fip_nd6_neighbourCache_t;


/** Set the state of a neighbour cache entry */
#define fip_nd6_neighbourCache_getState(ifnum, index)  fip_neighbourCache[ifnum][index].state

#define fip_nd6_neighbourCache_setState(ifnum, index, newstate)  \
        fip_neighbourCache[ifnum][index].state = newstate

#define fip_nd6_neighbourCache_getPtr(ifnum) fip_neighbourCache[ifnum]

#define fip_nd6_neighbourCache_setLLAddr(ifnum, index, thislladdr, thislen) { \
        fip_memcpy_ucharLen(fip_neighbourCache[ifnum][index].lladdr.addr, thislladdr, thislen); \
        fip_neighbourCache[ifnum][index].lladdr.len = thislen; }

#define fip_nd6_neighbourCache_getLLAddrPtr(ifnum, index)   fip_neighbourCache[ifnum][index].lladdr.addr
#define fip_nd6_neighbourCache_getLLAddrLen(ifnum, index)   fip_neighbourCache[ifnum][index].lladdr.len

#define fip_nd6_neighbourCache_setIPAddr(ifnum, index, thisipaddr) \
        fip_memcpy_ucharLen(fip_neighbourCache[ifnum][index].ipaddr.addr, (thisipaddr), 16)

#define fip_nd6_neighbourCache_getIPAddr(ifnum, index) fip_neighbourCache[ifnum][index].ipaddr


#define fip_nd6_neighbourCache_setIsRouter(ifnum, index, flag)\
        fip_neighbourCache[ifnum][index].isRouter = flag

#define fip_nd6_neighbourCache_setNumEvents(ifnum, index, num) \
        fip_neighbourCache[ifnum][index].numEvents = num

#define fip_nd6_neighbourCache_getNumEvents(ifnum, index) fip_neighbourCache[ifnum][index].numEvents

#define fip_nd6_neighbourCache_setEventTime32ms(ifnum, index, time) \
        fip_neighbourCache[ifnum][index].nextEventTime32ms = time

#define fip_nd6_neighbourCache_getEventTime32ms(ifnum, index) \
        fip_neighbourCache[ifnum][index].nextEventTime32ms

fip_nd6_searchStatus_t fip_nd6_neighbourCache_lookupByIp(fip_ifnum_t ifnum, const fip_ip6addr_t * const address);
void fip_nd6_neighbourCache_removeByIndex(fip_ifnum_t ifnum, unsigned char index);
fip_nd6_index_t fip_nd6_neighbourCache_makeRoom(fip_ifnum_t ifnum);
void fip_nd6_neighbourCache_updateLL(fip_ifnum_t ifnum, fip_nd6_index_t index, fip_llptraddr_t lladdr);

extern fip_nd6_neighbourCache_t fip_neighbourCache[FIP_CONF_MAX_INTERFACES][FIP_CONF_ND6_MAX_NEIGHBOURS];


/** Maximum options that can be attached to one ND ICMPv6 Message. */
#define MAX_ICMPV6_OPTIONS 10

/** Generic option type structure for processing. Holds option type, length, and offset. */
typedef struct
{
    unsigned char     type;     /**< Option type */
    unsigned char     length;   /**< Option length in bytes */
    unsigned char     offset;   /**< Offset of option from start of ICMPv6 */
} fip_nd6_option_t;

/** Holds all the options processed */
typedef struct
{
    fip_nd6_option_t  options[MAX_ICMPV6_OPTIONS]; /**< Information about each option */
    unsigned char     numOpts;  /**< Total number of options processed */
} fip_nd6_optionStruct_t ;


#endif /* FIP_ND6_DS_H_ */

/** @} */

---