Darran Shepherd
/
AutoIpNetStack
Net stack with AutoIP enabled
Embed:
(wiki syntax)
Show/hide line numbers
ip.h
00001 /* 00002 * Copyright (c) 2001-2004 Swedish Institute of Computer Science. 00003 * All rights reserved. 00004 * 00005 * Redistribution and use in source and binary forms, with or without modification, 00006 * are permitted provided that the following conditions are met: 00007 * 00008 * 1. Redistributions of source code must retain the above copyright notice, 00009 * this list of conditions and the following disclaimer. 00010 * 2. Redistributions in binary form must reproduce the above copyright notice, 00011 * this list of conditions and the following disclaimer in the documentation 00012 * and/or other materials provided with the distribution. 00013 * 3. The name of the author may not be used to endorse or promote products 00014 * derived from this software without specific prior written permission. 00015 * 00016 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 00017 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 00018 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 00019 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 00020 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 00021 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 00022 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 00023 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 00024 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 00025 * OF SUCH DAMAGE. 00026 * 00027 * This file is part of the lwIP TCP/IP stack. 00028 * 00029 * Author: Adam Dunkels <adam@sics.se> 00030 * 00031 */ 00032 #ifndef __LWIP_IP_H__ 00033 #define __LWIP_IP_H__ 00034 00035 #include "lwip/opt.h" 00036 00037 #include "lwip/def.h" 00038 #include "lwip/pbuf.h" 00039 #include "lwip/ip_addr.h" 00040 #include "lwip/err.h" 00041 #include "lwip/netif.h" 00042 00043 #ifdef __cplusplus 00044 extern "C" { 00045 #endif 00046 00047 /** Currently, the function ip_output_if_opt() is only used with IGMP */ 00048 #define IP_OPTIONS_SEND LWIP_IGMP 00049 00050 #define IP_HLEN 20 00051 00052 #define IP_PROTO_ICMP 1 00053 #define IP_PROTO_IGMP 2 00054 #define IP_PROTO_UDP 17 00055 #define IP_PROTO_UDPLITE 136 00056 #define IP_PROTO_TCP 6 00057 00058 /* This is passed as the destination address to ip_output_if (not 00059 to ip_output), meaning that an IP header already is constructed 00060 in the pbuf. This is used when TCP retransmits. */ 00061 #ifdef IP_HDRINCL 00062 #undef IP_HDRINCL 00063 #endif /* IP_HDRINCL */ 00064 #define IP_HDRINCL NULL 00065 00066 #if LWIP_NETIF_HWADDRHINT 00067 #define IP_PCB_ADDRHINT ;u8_t addr_hint 00068 #else 00069 #define IP_PCB_ADDRHINT 00070 #endif /* LWIP_NETIF_HWADDRHINT */ 00071 00072 /* This is the common part of all PCB types. It needs to be at the 00073 beginning of a PCB type definition. It is located here so that 00074 changes to this common part are made in one location instead of 00075 having to change all PCB structs. */ 00076 #define IP_PCB \ 00077 /* ip addresses in network byte order */ \ 00078 ip_addr_t local_ip; \ 00079 ip_addr_t remote_ip; \ 00080 /* Socket options */ \ 00081 u16_t so_options; \ 00082 /* Type Of Service */ \ 00083 u8_t tos; \ 00084 /* Time To Live */ \ 00085 u8_t ttl \ 00086 /* link layer address resolution hint */ \ 00087 IP_PCB_ADDRHINT 00088 00089 struct ip_pcb { 00090 /* Common members of all PCB types */ 00091 IP_PCB; 00092 }; 00093 00094 /* 00095 * Option flags per-socket. These are the same like SO_XXX. 00096 */ 00097 #define SOF_DEBUG (u16_t)0x0001U /* turn on debugging info recording */ 00098 #define SOF_ACCEPTCONN (u16_t)0x0002U /* socket has had listen() */ 00099 #define SOF_REUSEADDR (u16_t)0x0004U /* allow local address reuse */ 00100 #define SOF_KEEPALIVE (u16_t)0x0008U /* keep connections alive */ 00101 #define SOF_DONTROUTE (u16_t)0x0010U /* just use interface addresses */ 00102 #define SOF_BROADCAST (u16_t)0x0020U /* permit to send and to receive broadcast messages (see IP_SOF_BROADCAST option) */ 00103 #define SOF_USELOOPBACK (u16_t)0x0040U /* bypass hardware when possible */ 00104 #define SOF_LINGER (u16_t)0x0080U /* linger on close if data present */ 00105 #define SOF_OOBINLINE (u16_t)0x0100U /* leave received OOB data in line */ 00106 #define SOF_REUSEPORT (u16_t)0x0200U /* allow local address & port reuse */ 00107 00108 00109 #ifdef PACK_STRUCT_USE_INCLUDES 00110 # include "arch/bpstruct.h" 00111 #endif 00112 PACK_STRUCT_BEGIN 00113 struct ip_hdr { 00114 /* version / header length / type of service */ 00115 PACK_STRUCT_FIELD(u16_t _v_hl_tos); 00116 /* total length */ 00117 PACK_STRUCT_FIELD(u16_t _len); 00118 /* identification */ 00119 PACK_STRUCT_FIELD(u16_t _id); 00120 /* fragment offset field */ 00121 PACK_STRUCT_FIELD(u16_t _offset); 00122 #define IP_RF 0x8000 /* reserved fragment flag */ 00123 #define IP_DF 0x4000 /* dont fragment flag */ 00124 #define IP_MF 0x2000 /* more fragments flag */ 00125 #define IP_OFFMASK 0x1fff /* mask for fragmenting bits */ 00126 /* time to live */ 00127 PACK_STRUCT_FIELD(u8_t _ttl); 00128 /* protocol*/ 00129 PACK_STRUCT_FIELD(u8_t _proto); 00130 /* checksum */ 00131 PACK_STRUCT_FIELD(u16_t _chksum); 00132 /* source and destination IP addresses */ 00133 PACK_STRUCT_FIELD(ip_addr_t src); 00134 PACK_STRUCT_FIELD(ip_addr_t dest); 00135 } PACK_STRUCT_STRUCT; 00136 PACK_STRUCT_END 00137 #ifdef PACK_STRUCT_USE_INCLUDES 00138 # include "arch/epstruct.h" 00139 #endif 00140 00141 #define IPH_V(hdr) (ntohs((hdr)->_v_hl_tos) >> 12) 00142 #define IPH_HL(hdr) ((ntohs((hdr)->_v_hl_tos) >> 8) & 0x0f) 00143 #define IPH_TOS(hdr) (ntohs((hdr)->_v_hl_tos) & 0xff) 00144 #define IPH_LEN(hdr) ((hdr)->_len) 00145 #define IPH_ID(hdr) ((hdr)->_id) 00146 #define IPH_OFFSET(hdr) ((hdr)->_offset) 00147 #define IPH_TTL(hdr) ((hdr)->_ttl) 00148 #define IPH_PROTO(hdr) ((hdr)->_proto) 00149 #define IPH_CHKSUM(hdr) ((hdr)->_chksum) 00150 00151 #define IPH_VHLTOS_SET(hdr, v, hl, tos) (hdr)->_v_hl_tos = (htons(((v) << 12) | ((hl) << 8) | (tos))) 00152 #define IPH_LEN_SET(hdr, len) (hdr)->_len = (len) 00153 #define IPH_ID_SET(hdr, id) (hdr)->_id = (id) 00154 #define IPH_OFFSET_SET(hdr, off) (hdr)->_offset = (off) 00155 #define IPH_TTL_SET(hdr, ttl) (hdr)->_ttl = (u8_t)(ttl) 00156 #define IPH_PROTO_SET(hdr, proto) (hdr)->_proto = (u8_t)(proto) 00157 #define IPH_CHKSUM_SET(hdr, chksum) (hdr)->_chksum = (chksum) 00158 00159 /** The interface that provided the packet for the current callback invocation. */ 00160 extern struct netif *current_netif; 00161 /** Header of the input packet currently being processed. */ 00162 extern const struct ip_hdr *current_header; 00163 00164 #define ip_init() /* Compatibility define, not init needed. */ 00165 struct netif *ip_route(ip_addr_t *dest); 00166 err_t ip_input(struct pbuf *p, struct netif *inp); 00167 err_t ip_output(struct pbuf *p, ip_addr_t *src, ip_addr_t *dest, 00168 u8_t ttl, u8_t tos, u8_t proto); 00169 err_t ip_output_if(struct pbuf *p, ip_addr_t *src, ip_addr_t *dest, 00170 u8_t ttl, u8_t tos, u8_t proto, 00171 struct netif *netif); 00172 #if LWIP_NETIF_HWADDRHINT 00173 err_t ip_output_hinted(struct pbuf *p, ip_addr_t *src, ip_addr_t *dest, 00174 u8_t ttl, u8_t tos, u8_t proto, u8_t *addr_hint); 00175 #endif /* LWIP_NETIF_HWADDRHINT */ 00176 #if IP_OPTIONS_SEND 00177 err_t ip_output_if_opt(struct pbuf *p, ip_addr_t *src, ip_addr_t *dest, 00178 u8_t ttl, u8_t tos, u8_t proto, struct netif *netif, void *ip_options, 00179 u16_t optlen); 00180 #endif /* IP_OPTIONS_SEND */ 00181 /** Get the interface that received the current packet. 00182 * This function must only be called from a receive callback (udp_recv, 00183 * raw_recv, tcp_accept). It will return NULL otherwise. */ 00184 #define ip_current_netif() (current_netif) 00185 /** Get the IP header of the current packet. 00186 * This function must only be called from a receive callback (udp_recv, 00187 * raw_recv, tcp_accept). It will return NULL otherwise. */ 00188 #define ip_current_header() (current_header) 00189 #if IP_DEBUG 00190 void ip_debug_print(struct pbuf *p); 00191 #else 00192 #define ip_debug_print(p) 00193 #endif /* IP_DEBUG */ 00194 00195 #ifdef __cplusplus 00196 } 00197 #endif 00198 00199 #endif /* __LWIP_IP_H__ */ 00200 00201
Generated on Tue Jul 12 2022 15:37:04 by 1.7.2