hirifumi mikage / EthernetNetIf

EthernetNetIf

Dependents:   XBee_WiFi_EA_LPC4088

lwip/include/ipv4/lwip/ip.h@0:62580107d20c, 2014-11-19 (annotated)

Committer:
hmike
Date:
Wed Nov 19 12:00:42 2014 +0000
Revision:
0:62580107d20c
EthernetNetIf

Who changed what in which revision?

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