Dependencies:   mbed

Dependents:   TCP

Committer:
slowness
Date:
Tue Sep 06 18:05:46 2011 +0000
Revision:
0:58c3d014a4e7

        

Who changed what in which revision?

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