Travis Geiselbrecht | 1d0df69 | 2008-09-01 02:26:09 -0700 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright (c) 2001-2004 Swedish Institute of Computer Science. |
| 3 | * All rights reserved. |
| 4 | * |
| 5 | * Redistribution and use in source and binary forms, with or without modification, |
| 6 | * are permitted provided that the following conditions are met: |
| 7 | * |
| 8 | * 1. Redistributions of source code must retain the above copyright notice, |
| 9 | * this list of conditions and the following disclaimer. |
| 10 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
| 11 | * this list of conditions and the following disclaimer in the documentation |
| 12 | * and/or other materials provided with the distribution. |
| 13 | * 3. The name of the author may not be used to endorse or promote products |
| 14 | * derived from this software without specific prior written permission. |
| 15 | * |
| 16 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED |
| 17 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
| 18 | * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT |
| 19 | * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
| 20 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT |
| 21 | * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| 22 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| 23 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING |
| 24 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY |
| 25 | * OF SUCH DAMAGE. |
| 26 | * |
| 27 | * This file is part of the lwIP TCP/IP stack. |
| 28 | * |
| 29 | * Author: Adam Dunkels <adam@sics.se> |
| 30 | * |
| 31 | */ |
| 32 | #ifndef __LWIP_IP_H__ |
| 33 | #define __LWIP_IP_H__ |
| 34 | |
| 35 | #include "lwip/arch.h" |
| 36 | |
| 37 | #include "lwip/def.h" |
| 38 | #include "lwip/pbuf.h" |
| 39 | #include "lwip/ip_addr.h" |
| 40 | |
| 41 | #include "lwip/err.h" |
| 42 | |
| 43 | |
| 44 | void ip_init(void); |
| 45 | struct netif *ip_route(struct ip_addr *dest); |
| 46 | err_t ip_input(struct pbuf *p, struct netif *inp); |
| 47 | err_t ip_output(struct pbuf *p, struct ip_addr *src, struct ip_addr *dest, |
| 48 | u8_t ttl, u8_t tos, u8_t proto); |
| 49 | err_t ip_output_if(struct pbuf *p, struct ip_addr *src, struct ip_addr *dest, |
| 50 | u8_t ttl, u8_t tos, u8_t proto, |
| 51 | struct netif *netif); |
| 52 | |
| 53 | #define IP_HLEN 20 |
| 54 | |
| 55 | #define IP_PROTO_ICMP 1 |
| 56 | #define IP_PROTO_UDP 17 |
| 57 | #define IP_PROTO_UDPLITE 170 |
| 58 | #define IP_PROTO_TCP 6 |
| 59 | |
| 60 | /* This is passed as the destination address to ip_output_if (not |
| 61 | to ip_output), meaning that an IP header already is constructed |
| 62 | in the pbuf. This is used when TCP retransmits. */ |
| 63 | #ifdef IP_HDRINCL |
| 64 | #undef IP_HDRINCL |
| 65 | #endif /* IP_HDRINCL */ |
| 66 | #define IP_HDRINCL NULL |
| 67 | |
| 68 | |
| 69 | /* This is the common part of all PCB types. It needs to be at the |
| 70 | beginning of a PCB type definition. It is located here so that |
| 71 | changes to this common part are made in one location instead of |
| 72 | having to change all PCB structs. */ |
| 73 | #define IP_PCB struct ip_addr local_ip; \ |
| 74 | struct ip_addr remote_ip; \ |
| 75 | /* Socket options */ \ |
| 76 | u16_t so_options; \ |
| 77 | /* Type Of Service */ \ |
| 78 | u8_t tos; \ |
| 79 | /* Time To Live */ \ |
| 80 | u8_t ttl |
| 81 | |
| 82 | /* |
| 83 | * Option flags per-socket. These are the same like SO_XXX. |
| 84 | */ |
| 85 | #define SOF_DEBUG (u16_t)0x0001U /* turn on debugging info recording */ |
| 86 | #define SOF_ACCEPTCONN (u16_t)0x0002U /* socket has had listen() */ |
| 87 | #define SOF_REUSEADDR (u16_t)0x0004U /* allow local address reuse */ |
| 88 | #define SOF_KEEPALIVE (u16_t)0x0008U /* keep connections alive */ |
| 89 | #define SOF_DONTROUTE (u16_t)0x0010U /* just use interface addresses */ |
| 90 | #define SOF_BROADCAST (u16_t)0x0020U /* permit sending of broadcast msgs */ |
| 91 | #define SOF_USELOOPBACK (u16_t)0x0040U /* bypass hardware when possible */ |
| 92 | #define SOF_LINGER (u16_t)0x0080U /* linger on close if data present */ |
| 93 | #define SOF_OOBINLINE (u16_t)0x0100U /* leave received OOB data in line */ |
| 94 | #define SOF_REUSEPORT (u16_t)0x0200U /* allow local address & port reuse */ |
| 95 | |
| 96 | |
| 97 | |
| 98 | #ifdef PACK_STRUCT_USE_INCLUDES |
| 99 | # include "arch/bpstruct.h" |
| 100 | #endif |
| 101 | PACK_STRUCT_BEGIN |
| 102 | struct ip_hdr { |
| 103 | /* version / header length / type of service */ |
| 104 | PACK_STRUCT_FIELD(u16_t _v_hl_tos); |
| 105 | /* total length */ |
| 106 | PACK_STRUCT_FIELD(u16_t _len); |
| 107 | /* identification */ |
| 108 | PACK_STRUCT_FIELD(u16_t _id); |
| 109 | /* fragment offset field */ |
| 110 | PACK_STRUCT_FIELD(u16_t _offset); |
| 111 | #define IP_RF 0x8000 /* reserved fragment flag */ |
| 112 | #define IP_DF 0x4000 /* dont fragment flag */ |
| 113 | #define IP_MF 0x2000 /* more fragments flag */ |
| 114 | #define IP_OFFMASK 0x1fff /* mask for fragmenting bits */ |
| 115 | /* time to live / protocol*/ |
| 116 | PACK_STRUCT_FIELD(u16_t _ttl_proto); |
| 117 | /* checksum */ |
| 118 | PACK_STRUCT_FIELD(u16_t _chksum); |
| 119 | /* source and destination IP addresses */ |
| 120 | PACK_STRUCT_FIELD(struct ip_addr src); |
| 121 | PACK_STRUCT_FIELD(struct ip_addr dest); |
| 122 | } PACK_STRUCT_STRUCT; |
| 123 | PACK_STRUCT_END |
| 124 | #ifdef PACK_STRUCT_USE_INCLUDES |
| 125 | # include "arch/epstruct.h" |
| 126 | #endif |
| 127 | |
| 128 | #define IPH_V(hdr) (ntohs((hdr)->_v_hl_tos) >> 12) |
| 129 | #define IPH_HL(hdr) ((ntohs((hdr)->_v_hl_tos) >> 8) & 0x0f) |
| 130 | #define IPH_TOS(hdr) (ntohs((hdr)->_v_hl_tos) & 0xff) |
| 131 | #define IPH_LEN(hdr) ((hdr)->_len) |
| 132 | #define IPH_ID(hdr) ((hdr)->_id) |
| 133 | #define IPH_OFFSET(hdr) ((hdr)->_offset) |
| 134 | #define IPH_TTL(hdr) (ntohs((hdr)->_ttl_proto) >> 8) |
| 135 | #define IPH_PROTO(hdr) (ntohs((hdr)->_ttl_proto) & 0xff) |
| 136 | #define IPH_CHKSUM(hdr) ((hdr)->_chksum) |
| 137 | |
| 138 | #define IPH_VHLTOS_SET(hdr, v, hl, tos) (hdr)->_v_hl_tos = (htons(((v) << 12) | ((hl) << 8) | (tos))) |
| 139 | #define IPH_LEN_SET(hdr, len) (hdr)->_len = (len) |
| 140 | #define IPH_ID_SET(hdr, id) (hdr)->_id = (id) |
| 141 | #define IPH_OFFSET_SET(hdr, off) (hdr)->_offset = (off) |
| 142 | #define IPH_TTL_SET(hdr, ttl) (hdr)->_ttl_proto = (htons(IPH_PROTO(hdr) | ((ttl) << 8))) |
| 143 | #define IPH_PROTO_SET(hdr, proto) (hdr)->_ttl_proto = (htons((proto) | (IPH_TTL(hdr) << 8))) |
| 144 | #define IPH_CHKSUM_SET(hdr, chksum) (hdr)->_chksum = (chksum) |
| 145 | |
| 146 | #if IP_DEBUG |
| 147 | void ip_debug_print(struct pbuf *p); |
| 148 | #else |
| 149 | #define ip_debug_print(p) |
| 150 | #endif /* IP_DEBUG */ |
| 151 | |
| 152 | #endif /* __LWIP_IP_H__ */ |
| 153 | |
| 154 | |