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