git.sur5r.net Git - freertos/blob - Demo/Common/ethernet/lwIP_130/src/include/ipv4/lwip/ip.h

   1 /*\r
   2  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.\r
   3  * All rights reserved.\r
   4  *\r
   5  * Redistribution and use in source and binary forms, with or without modification,\r
   6  * are permitted provided that the following conditions are met:\r
   7  *\r
   8  * 1. Redistributions of source code must retain the above copyright notice,\r
   9  *    this list of conditions and the following disclaimer.\r
  10  * 2. Redistributions in binary form must reproduce the above copyright notice,\r
  11  *    this list of conditions and the following disclaimer in the documentation\r
  12  *    and/or other materials provided with the distribution.\r
  13  * 3. The name of the author may not be used to endorse or promote products\r
  14  *    derived from this software without specific prior written permission.\r
  15  *\r
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED\r
  17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\r
  18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT\r
  19  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\r
  20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT\r
  21  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS\r
  22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN\r
  23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING\r
  24  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY\r
  25  * OF SUCH DAMAGE.\r
  26  *\r
  27  * This file is part of the lwIP TCP/IP stack.\r
  28  *\r
  29  * Author: Adam Dunkels <adam@sics.se>\r
  30  *\r
  31  */\r
  32 #ifndef __LWIP_IP_H__\r
  33 #define __LWIP_IP_H__\r
  34 \r
  35 #include "lwip/opt.h"\r
  36 \r
  37 #include "lwip/def.h"\r
  38 #include "lwip/pbuf.h"\r
  39 #include "lwip/ip_addr.h"\r
  40 #include "lwip/err.h"\r
  41 \r
  42 #ifdef __cplusplus\r
  43 extern "C" {\r
  44 #endif\r
  45 \r
  46 #define ip_init() /* Compatibility define, not init needed. */\r
  47 struct netif *ip_route(struct ip_addr *dest);\r
  48 err_t ip_input(struct pbuf *p, struct netif *inp);\r
  49 err_t ip_output(struct pbuf *p, struct ip_addr *src, struct ip_addr *dest,\r
  50     u8_t ttl, u8_t tos, u8_t proto);\r
  51 err_t ip_output_if(struct pbuf *p, struct ip_addr *src, struct ip_addr *dest,\r
  52        u8_t ttl, u8_t tos, u8_t proto,\r
  53        struct netif *netif);\r
  54 \r
  55 #define IP_HLEN 20\r
  56 \r
  57 #define IP_PROTO_ICMP    1\r
  58 #define IP_PROTO_UDP     17\r
  59 #define IP_PROTO_UDPLITE 136\r
  60 #define IP_PROTO_TCP     6\r
  61 \r
  62 /* This is passed as the destination address to ip_output_if (not\r
  63    to ip_output), meaning that an IP header already is constructed\r
  64    in the pbuf. This is used when TCP retransmits. */\r
  65 #ifdef IP_HDRINCL\r
  66 #undef IP_HDRINCL\r
  67 #endif /* IP_HDRINCL */\r
  68 #define IP_HDRINCL  NULL\r
  69 \r
  70 #if LWIP_NETIF_HWADDRHINT\r
  71 #define IP_PCB_ADDRHINT ;u8_t addr_hint\r
  72 #else\r
  73 #define IP_PCB_ADDRHINT\r
  74 #endif /* LWIP_NETIF_HWADDRHINT */\r
  75 \r
  76 /* This is the common part of all PCB types. It needs to be at the\r
  77    beginning of a PCB type definition. It is located here so that\r
  78    changes to this common part are made in one location instead of\r
  79    having to change all PCB structs. */\r
  80 #define IP_PCB \\r
  81   /* ip addresses in network byte order */ \\r
  82   struct ip_addr local_ip; \\r
  83   struct ip_addr remote_ip; \\r
  84    /* Socket options */  \\r
  85   u16_t so_options;      \\r
  86    /* Type Of Service */ \\r
  87   u8_t tos;              \\r
  88   /* Time To Live */     \\r
  89   u8_t ttl               \\r
  90   /* link layer address resolution hint */ \\r
  91   IP_PCB_ADDRHINT\r
  92 \r
  93 struct ip_pcb {\r
  94 /* Common members of all PCB types */\r
  95   IP_PCB;\r
  96 };\r
  97 \r
  98 /*\r
  99  * Option flags per-socket. These are the same like SO_XXX.\r
 100  */\r
 101 #define SOF_DEBUG       (u16_t)0x0001U    /* turn on debugging info recording */\r
 102 #define SOF_ACCEPTCONN  (u16_t)0x0002U    /* socket has had listen() */\r
 103 #define SOF_REUSEADDR   (u16_t)0x0004U    /* allow local address reuse */\r
 104 #define SOF_KEEPALIVE   (u16_t)0x0008U    /* keep connections alive */\r
 105 #define SOF_DONTROUTE   (u16_t)0x0010U    /* just use interface addresses */\r
 106 #define SOF_BROADCAST   (u16_t)0x0020U    /* permit sending of broadcast msgs */\r
 107 #define SOF_USELOOPBACK (u16_t)0x0040U    /* bypass hardware when possible */\r
 108 #define SOF_LINGER      (u16_t)0x0080U    /* linger on close if data present */\r
 109 #define SOF_OOBINLINE   (u16_t)0x0100U    /* leave received OOB data in line */\r
 110 #define SOF_REUSEPORT   (u16_t)0x0200U    /* allow local address & port reuse */\r
 111 \r
 112 \r
 113 #ifdef PACK_STRUCT_USE_INCLUDES\r
 114 #  include "arch/bpstruct.h"\r
 115 #endif\r
 116 PACK_STRUCT_BEGIN\r
 117 struct ip_hdr {\r
 118   /* version / header length / type of service */\r
 119   PACK_STRUCT_FIELD(u16_t _v_hl_tos);\r
 120   /* total length */\r
 121   PACK_STRUCT_FIELD(u16_t _len);\r
 122   /* identification */\r
 123   PACK_STRUCT_FIELD(u16_t _id);\r
 124   /* fragment offset field */\r
 125   PACK_STRUCT_FIELD(u16_t _offset);\r
 126 #define IP_RF 0x8000        /* reserved fragment flag */\r
 127 #define IP_DF 0x4000        /* dont fragment flag */\r
 128 #define IP_MF 0x2000        /* more fragments flag */\r
 129 #define IP_OFFMASK 0x1fff   /* mask for fragmenting bits */\r
 130   /* time to live / protocol*/\r
 131   PACK_STRUCT_FIELD(u16_t _ttl_proto);\r
 132   /* checksum */\r
 133   PACK_STRUCT_FIELD(u16_t _chksum);\r
 134   /* source and destination IP addresses */\r
 135   PACK_STRUCT_FIELD(struct ip_addr src);\r
 136   PACK_STRUCT_FIELD(struct ip_addr dest);\r
 137 } PACK_STRUCT_STRUCT;\r
 138 PACK_STRUCT_END\r
 139 #ifdef PACK_STRUCT_USE_INCLUDES\r
 140 #  include "arch/epstruct.h"\r
 141 #endif\r
 142 \r
 143 #define IPH_V(hdr)  (ntohs((hdr)->_v_hl_tos) >> 12)\r
 144 #define IPH_HL(hdr) ((ntohs((hdr)->_v_hl_tos) >> 8) & 0x0f)\r
 145 #define IPH_TOS(hdr) (ntohs((hdr)->_v_hl_tos) & 0xff)\r
 146 #define IPH_LEN(hdr) ((hdr)->_len)\r
 147 #define IPH_ID(hdr) ((hdr)->_id)\r
 148 #define IPH_OFFSET(hdr) ((hdr)->_offset)\r
 149 #define IPH_TTL(hdr) (ntohs((hdr)->_ttl_proto) >> 8)\r
 150 #define IPH_PROTO(hdr) (ntohs((hdr)->_ttl_proto) & 0xff)\r
 151 #define IPH_CHKSUM(hdr) ((hdr)->_chksum)\r
 152 \r
 153 #define IPH_VHLTOS_SET(hdr, v, hl, tos) (hdr)->_v_hl_tos = (htons(((v) << 12) | ((hl) << 8) | (tos)))\r
 154 #define IPH_LEN_SET(hdr, len) (hdr)->_len = (len)\r
 155 #define IPH_ID_SET(hdr, id) (hdr)->_id = (id)\r
 156 #define IPH_OFFSET_SET(hdr, off) (hdr)->_offset = (off)\r
 157 #define IPH_TTL_SET(hdr, ttl) (hdr)->_ttl_proto = (htons(IPH_PROTO(hdr) | ((u16_t)(ttl) << 8)))\r
 158 #define IPH_PROTO_SET(hdr, proto) (hdr)->_ttl_proto = (htons((proto) | (IPH_TTL(hdr) << 8)))\r
 159 #define IPH_CHKSUM_SET(hdr, chksum) (hdr)->_chksum = (chksum)\r
 160 \r
 161 #if IP_DEBUG\r
 162 void ip_debug_print(struct pbuf *p);\r
 163 #else\r
 164 #define ip_debug_print(p)\r
 165 #endif /* IP_DEBUG */\r
 166 \r
 167 #ifdef __cplusplus\r
 168 }\r
 169 #endif\r
 170 \r
 171 #endif /* __LWIP_IP_H__ */\r
 172 \r
 173 \r