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