E:/fip/workspaces/fip/source/fip.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.
 */
/**
 * @file
 *          This file contains definitions and macros which are used
 *          within both fip and the user application which uses fip.
 *
 * @author
 *         Colin O'Flynn
 */

#ifndef FIP_H_
#define FIP_H_

#include <stdint.h>
#include "fip_config.h"
#include "fip_compiler.h"
#include "fip_timer.h"
#include "fip_trace.h"
#include <string.h>

/* ################################## FIP DEFINES ############################# */

#define FIP_IPHDR_V6                0x60
#define FIP_IPHDR_V6_ZEROTCFLOW     0x60000000
#define FIP_IPHDR_V4                0x40
#define FIP_IPV6_HDR_LEN            40

/* From: http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xml */
#define FIP_IPHDR_PROTO_TCP         6
#define FIP_IPHDR_PROTO_UDP         17
#define FIP_IPHDR_PROTO_ICMP6       58
#define FIP_IPHDR_PROTO_NONEXT6     59
#define FIP_IPHDR_PROTO_EXT_HOPBYHOP 0
#define FIP_IPHDR_PROTO_EXT_ROUTING 43
#define FIP_IPHDR_PROTO_EXT_FRAG    44
#define FIP_IPHDR_PROTO_EXT_ESP     50
#define FIP_IPHDR_PROTO_EXT_AH      51
#define FIP_IPHDR_PROTO_EXT_DEST    60

/* From RFC2460 */
#define FIP_EXTHDR_OPT_ACTIONMASK     0xC0
/** skip over this option and continue processing the header.*/
#define FIP_EXTHDR_OPT_ACTIONSKIP    (0<<6)

/**<  discard the packet. */
#define FIP_EXTHDR_OPT_ACTIONDROP    (1<<6)

/**<  discard the packet and, regardless of whether or not the
      packet's Destination Address was a multicast address, send an
      ICMP Parameter Problem, Code 2, message to the packet's
      Source Address, pointing to the unrecognized Option Type. */
#define FIP_EXTHDR_OPT_ACTIONFORCE   (2<<6)

/**<  discard the packet and, only if the packet's Destination
      Address was not a multicast address, send an ICMP Parameter
      Problem, Code 2, message to the packet's Source Address,
      pointing to the unrecognized Option Type. */
#define FIP_EXTHDR_OPT_ACTIONERROR   (3<<6)

#define DELAY_FIRST_PROBE_TIME 5000
#define FIP_IPFRAG_EXPIRETIME 60

/* From RFC4443 */
#define FIP_ICMPV6_TYPE_ECHOREQUEST 128
#define FIP_ICMPV6_TYPE_ECHOREPLY   129

#define FIP_ICMPV6_TYPE_ERRORREACH    1
#define FIP_ICMPV6_CODE_ERRORROUTE    0 /**< Dest Unreachable: No route to dest */
#define FIP_ICMPV6_CODE_ERRORPROHIBIT 1 /**< Dest Unreachable: Administratively Prohibited*/
#define FIP_ICMPV6_CODE_ERRORSCOPE    2 /**< Dest Unreachable: Beyond scope of source address */
#define FIP_ICMPV6_CODE_ERRORADDR     3 /**< Dest Unreachable: Address unreachable */
#define FIP_ICMPV6_CODE_ERRORPORT     4 /**< Dest Unreachable: Port unreachable */
#define FIP_ICMPV6_CODE_ERRORPOLICY   5 /**< Dest Unreachable: Source address failed ingress/egress policy */
#define FIP_ICMPV6_CODE_ERRORREJECT   6 /**< Dest Unreachable: Reject route to destination */

#define FIP_ICMPV6_TYPE_ERRORBIG     2

#define FIP_ICMPV6_TYPE_ERRORTIME    3
#define FIP_ICMPV6_CODE_ERRORTTL     0 /**< Time Exceeded: Hop limit exceeded in transit */
#define FIP_ICMPV6_CODE_ERRORFRAG    1 /**< Time Exceeded: Fragment reassembly time exceeded */

#define FIP_ICMPV6_TYPE_ERRORPARAM   4
#define FIP_ICMPV6_CODE_ERRORGENERAL 0 /**< Parameter Problem: Erroneous header field encountered */
#define FIP_ICMPV6_CODE_ERRORNH      1 /**< Parameter Problem: Unrecognized Next Header type encountered */
#define FIP_ICMPV6_CODE_ERROROPT     2 /**< Parameter Problem: Unrecognized IPv6 option encountered */


/* ################################## FIP TYPES ############################### */
/**
 * @addtogroup fip_types
 * @{
 */

/** The return value used when functions are only returning a status, and nothing else. */
typedef enum
{
    RV_OK = 0,                          /**< Everything was OK */                                                               //!< RV_OK
    RV_UNKNOWN_ERROR,                   /**< An unknown error occurred */                                                       //!< RV_UNKNOWN_ERROR
    RV_MEMORY_ERROR,                    /**< A dynamic memory allocation error occurred, such as malloc failing */              //!< RV_MEMORY_ERROR
    RV_PARAMETER_ERROR,                 /**< Parameter passed was invalid */                                                    //!< RV_PARAMETER_ERROR
    RV_UNHANDLED,                       /**< Function could not handle request */                                               //!< RV_UNHANDLED
    RV_ND6_INVALID_STATE,               /**< ND Specific: Invalid State */                                                      //!< RV_ND6_INVALID_STATE
    RV_ND6_NOENTRY,                     /**< ND Specific: No Entry */                                                           //!< RV_ND6_NOENTRY
    RV_RH4_SEGMENT_LEFT_ERROR,          /**< There was a problem with the segments left */                                      //!< RV_RH4_SEGMENT_LEFT_ERROR
    RV_RH4_HOPS_EXCEEDED,               /**< Hop limit exceeded. */                                                             //!< RV_RH4_HOPS_EXCEEDED
    RV_RH4_ADDRESS_OFF_LINK,            /**< An address in the source route was not on link. */                                 //!< RV_RH4_ADDRESS_OFF_LINK
    RV_RH4_PROCESS_NEXT_HEADER,         /**< draft-hui-6man-rpl-routing-header-02, page 9, packet has arrived at destination. *///!< RV_RH4_PROCESS_NEXT_HEADER
    RV_HBH_RPL_INSTANCE_ERROR,          /**< Cannot forward packet due to unknown RPL instance ID. */                           //!< RV_HBH_RPL_INSTANCE_ERROR
    RV_HBH_RANK_ERROR                   /**< Rank error detected, packet dropped. */                                            //!< RV_HBH_RANK_ERROR

} fip_return_t;

typedef enum
{
    IPV4,
    IPV6
} fip_ipversion_t;

/* If your compiler isn't C99, use this:
 * typedef enum {
 * false = 0,
 * true
 * } fip_bool_t;
 */
#include <stdbool.h>
/** Typedef the C99 bool type. Done in a typedef in case your compiler is not C99 compliant */
typedef bool fip_bool_t;

typedef enum
{
    tribool_untested,
    tribool_false,
    tribool_true
} fip_tribool_t;

typedef unsigned char fip_ifnum_t;

typedef unsigned char fip_ipnum_t;
#define FIP_IPNUM_UNKNOWN 0xFF

/** Address life-times */
typedef uint32_t fip_vlifetime_t;

/** Address types. Note these correspond to uIP's ADDR_ANYTYPE, ADDR_AUTCONF,
 * ADDR_DHCP, and ADDR_MANUAL. Thus you can cast between code using fip_addrtype_t and
 * code using uint8_t with uIP's defines. */
typedef enum
{
    ADDR_UNKNOWN = 0,                   /**< Unknown address type */
    ADDR_AUTOCONF = 1,                  /**< Autoconfigured address type */
    ADDR_STATEFUL = 2,                  /**< Statefully assigned (ie: DHCP) */
    ADDR_MANUAL = 3,                    /**< Manually assigned */
    ADDR_MULTICAST                      /**< Multicast */
}fip_addrtype_t;

/** State of prefix in use on an interface */
typedef enum
{
    PREFIX_UNUSED = 0,                  /**< Prefix not used */
    PREFIX_USED                         /**< Prefix used */
}fip_prefixstate_t;

/** State of route in use on an interface */
typedef enum
{
    ROUTE_UNUSED = 0,                  /**< Route not used */
    ROUTE_USED                         /**< Route used */
}fip_routestate_t;

/** State of address in use on an interface. Note this does NOT map directly to
 * uIP's address states (ADDR_TENATIVE, etc) as this enumeration adds an 'unused'
 * state. */
typedef enum
{
    ADDR_UNUSED = 0,                    /**< Adddress not used */
    ADDR_NEW,                           /**< New address, DAD may be required before can be used */
    ADDR_TENATIVE,                      /**< Address tenative, waiting for DAD to finish */
    ADDR_OPTIMISTIC,                    /**< Address has optimistically been assigned */
    ADDR_PREFERRED,                     /**< Preferred address to use */
    ADDR_DEPRECATED,                    /**< Address deprecated, probably as it expired */
    ADDR_DUPLICATE,                     /**< Duplicate address, do not use */
    ADDR_DELETE                         /**< Address being deleted */
} fip_addrstate_t;

typedef struct
{
    uint8_t addr[FIP_CONF_LLADDR_LEN];  /**< The address */
    unsigned char   len;                /**< Length of address */
} fip_lladdr_t;

typedef struct
{
    fip_lladdr_t    lladdr;             /**< The link-layer address */
    fip_bool_t      validForGPAuto;     /**< Valid for IPv6 Global Prefix auto-configuration */
} fip_mylladdr_t;

typedef struct
{
    uint8_t       * addr;               /**< Pointer to the address */
    unsigned char   len;                /**< Length of address */
} fip_llptraddr_t;

/** Holds flags with additional information about any addresses. If you add/modify this
 * definition (to add new flags), you must modify the @ref fip_packet_resetAddrFlags
 * macro as well. */
typedef struct
{
    fip_tribool_t   isMySolicitedNode;  /**< Is address my solicited node? */
    fip_tribool_t   isUnspecified;      /**< Is address unspecified? */
    fip_tribool_t   isLinkLocal;        /**< Is this address a link-local (fe80::) address? */
    fip_tribool_t   isOnLink;           /**< Is this address on-link? */
} fip_ip6addr_flags_t;

/** IPv6 address, held as an array of 16 bytes */
typedef struct
{
    uint8_t         addr[16];
} fip_ip6addr_t;

/** IPv6 address with additional state */
typedef struct
{
    fip_addrstate_t state;              /**< Address state (unused, new, etc) */
    fip_addrtype_t  type;               /**< Address type (autoconf, manual, etc) */
    fip_ip6addr_t   addr;               /**< IPv6 Address */
    fip_vlifetime_t vlifetime;          /**< IPv6 Lifetime */
    unsigned char   hasSolicitedMulticast:1;    /**< Flag to indicate should base a multicast on this */
    unsigned char   hasPreferredLLIndex:1;      /**< Flag to indicate there is a preferred LL address */
    unsigned char   preferredLLIndex;   /**< Index to preferred LL address to use */
    unsigned char   dupAddrDetectLeft;  /**< Number of DAD Transmissions left */
    fip_timer32mS_t retransExpire32mS;  /**< Timer for DAD */
} fip_myip6addr_t;

/** IPv6 Prefix with additional state */
typedef struct
{
    fip_prefixstate_t   state;          /**< Prefix state (unused, new, etc) */
    unsigned char       length;         /**< Prefix length in bits */
    unsigned char       advPrefix : 1;  /**< For routers, flag that indicates if we advertise this prefix */
    unsigned char       isOnLink : 1;   /**< Is prefix known to be on-link? */
    fip_vlifetime_t     validLifetime;  /**< How long the prefix is valid for, used when advertising the prefix */
    fip_vlifetime_t     validUntil;     /**< When in seconds since system start the address expires, 0 = Never */
    fip_ip6addr_t       prefix;         /**< Prefix itself */
} fip_myip6prefix_t;

/** IPv6 Default Router with additional state */
typedef struct
{
    fip_routestate_t    state;          /**< State (unused, new, etc) */
    fip_vlifetime_t     validUntil32S;  /**< When in seconds since system start this defrouter expires, 0 = Never */
    fip_ip6addr_t       router;         /**< Router itself */
} fip_mydefrouter_t;

/** Scratchpad for IPv6 Fragmentation */
typedef struct
{
    uint32_t            fragId;         /**< FragID of this packet */
    unsigned int        receivedBytes;  /**< Received unfragmented size, used to detect end & overlapping */
    unsigned int        expectedBytes;  /**< Expected unfragmented size */
    unsigned int        unfragmentSize; /**< Size of unfragmentable data */
    unsigned char       firstFrag : 1;  /**< Offset = 0 fragment has been received */
    unsigned char       lastFrag : 1;   /**< M = 0 fragment has been received */
    uint8_t *           nhPointer;      /**< Pointer to the next header */
    uint16_t            expireTime16s;  /**< When the fragment times out */
}fip_ip6frag_attr_t;

/**
 * @} fip_types
 */

/* ################################## FIP MISC STUFF ########################## */

/** Act on Configuration */
#if FIP_CONF_FIXED_LLADDR_LEN
    /* Fixed LL Address Length */
    #define fip_ll_addrLenInvalid(x)                    (x != FIP_CONF_LLADDR_LEN)
#else
    /* Variable LL Address Length */
    #define fip_ll_addrLenInvalid(x)                    (x > FIP_CONF_LLADDR_LEN)
#endif

/* ################################## FIP FUNCTIONS ########################### */

/**** FIP Functions ****/
void fip_init(void);
void fip_task(void);
fip_bool_t fip_memcmp_ucharLen(const unsigned char * a, const unsigned char * b, unsigned char len);
fip_bool_t fip_memcmp_uintLen(const unsigned char * a, const unsigned char * b, uint16_t len);
unsigned char fip_memmatch_ucharLen(const unsigned char * a, const unsigned char * b, unsigned char len);
void fip_memclr_ucharLen(unsigned char * dest, unsigned char length);
fip_bool_t fip_ismemclr(const unsigned char * dest, unsigned char length);
fip_return_t fip_ipUtils_generateAutoconfIID(unsigned char result[], const unsigned char llAddrPtr[], unsigned char llAddrLen);
#include "fip_packet.h"
#include "fip_nd6.h"
#include "fip_sixlowpan.h"

/**** IF Functions ****/
#include "fip_if.h"

/**** IP Functions ****/
void fip_ip_process(void);
void fip_ip_send(void);
uint16_t fip_ipUtils_checksum(uint16_t startingValue, uint8_t data[], unsigned int number);
uint16_t fip_ipUtils_checksum_tl(void);
uint16_t fip_ipUtils_checksum_pseudo6hdr(uint16_t startingValue, uint8_t type);
void fip_ipUtils_IP6toString(char * s, uint8_t * ipaddr);
fip_return_t fip_ipUtils_stringToIP6(const char * s, uint8_t * ipaddr);
fip_bool_t fip_isSrcUnspecified(void);
fip_bool_t fip_isDestUnspecified(void);

#include "fip_route6.h"

/**** TCP Functions ****/

/**** UDP Functions ****/
#include "fip_udp.h"

/**** ICMP Functions ****/
void fip_icmp6_process(void);
fip_return_t fip_nd6_process(void);
void fip_icmp6_finalize(void);
void fip_icmp6_generateEchoRequest(fip_ifnum_t ifnum, fip_ip6addr_t * destAddr, unsigned int length);
void fip_icmp6_generateError(uint8_t type, uint8_t code, uint32_t parameter);

/**** Link-Layer Functions Functions ****/
void
fip_llgeneric_init(fip_ifnum_t ifnum, fip_llptraddr_t lladdr, char * name, void(*ifProcess)(void));
void fip_llgeneric_input(const uint8_t * srcAddr,
        unsigned char   srcAddrLen,
        const uint8_t * destAddr,
        unsigned char   destAddrLen,
        const uint8_t * data,
        unsigned int    dataLen);


/* ################################## HOST INTERFACE FUNCTIONS ########################### */

/**
 * @addtogroup fip_hostInterface
 * @{
 */

/**
 * Host interface function. Get seconds since system boot in 32-bit unsigned integer.
 */
uint32_t fip_hostInterface_getSeconds32(void);

/**
 * Host interface function. Get seconds since system boot in 16-bit unsigned integer.
 */
uint16_t fip_hostInterface_getSeconds16(void);

/**
 * Host interface function. Get milliseconds since system boot in 32-bit unsigned integer.
 */
uint32_t fip_hostInterface_getMiliSeconds32(void);

/**
 * Host interface function. Get milliseconds since system boot in 16-bit unsigned integer.
 */
uint16_t fip_hostInterface_getMiliSeconds16(void);

/**
 * Host interface function. Get random number from hardware generator, used to
 * seed fip's pseudorandom generator. Returns a different value for each call
 * to this function, even when the program is restarted. Does not need to be
 * actually a random distribution, as it's only used as a seed for the PRNG.
 */
uint32_t fip_hostInterface_getRandom32(void);

/**
 * @}
 */



#endif /* FIP_H_ */

---