mbed official / lwip

Official mbed lwIP library (version 1.4.0)

Dependents:   LwIPNetworking NetServicesMin EthernetInterface EthernetInterface_RSF ... more

Legacy Networking Libraries

This is an mbed 2 networking library. For mbed OS 5, lwip has been integrated with built-in networking interfaces. The networking libraries have been revised to better support additional network stacks and thread safety here.

This library is based on the code of lwIP v1.4.0

Copyright (c) 2001, 2002 Swedish Institute of Computer Science.
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. The name of the author may not be used to endorse or promote products
   derived from this software without specific prior written permission. 

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.

include/ipv4/lwip/ip.h@0:51ac1d130fd4, 2012-06-22 (annotated)

Committer:
mbed_official
Date:
Fri Jun 22 09:25:39 2012 +0000
Revision:
0:51ac1d130fd4
Initial import from lwip-1.4.0: http://download.savannah.gnu.org/releases/lwip/lwip-1.4.0.zip

Who changed what in which revision?

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