1 /** 2 * @file 3 * IPv4 API 4 */ 5 6 /* 7 * Copyright (c) 2001-2004 Swedish Institute of Computer Science. 8 * All rights reserved. 9 * 10 * Redistribution and use in source and binary forms, with or without modification, 11 * are permitted provided that the following conditions are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright notice, 14 * this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright notice, 16 * this list of conditions and the following disclaimer in the documentation 17 * and/or other materials provided with the distribution. 18 * 3. The name of the author may not be used to endorse or promote products 19 * derived from this software without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 22 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 23 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 24 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 26 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 29 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 30 * OF SUCH DAMAGE. 31 * 32 * This file is part of the lwIP TCP/IP stack. 33 * 34 * Author: Adam Dunkels <adam@sics.se> 35 * 36 */ 37 #ifndef LWIP_HDR_IP4_H 38 #define LWIP_HDR_IP4_H 39 40 #include "lwip/opt.h" 41 42 #if LWIP_IPV4 43 44 #include "lwip/def.h" 45 #include "lwip/pbuf.h" 46 #include "lwip/ip4_addr.h" 47 #include "lwip/err.h" 48 #include "lwip/prot/ip4.h" 49 50 #if defined (__cplusplus) && __cplusplus 51 extern "C" { 52 #endif 53 54 #define IP_PROTO_VERSION_4 4 55 56 #ifdef LWIP_HOOK_IP4_ROUTE_SRC 57 #define LWIP_IPV4_SRC_ROUTING 1 58 #else 59 #define LWIP_IPV4_SRC_ROUTING 0 60 #endif 61 62 /** Currently, the function ip_output_if_opt() is only used with IGMP */ 63 #define IP_OPTIONS_SEND (LWIP_IPV4 && LWIP_IGMP) 64 struct netif; 65 66 void ip_init(void); /* Compatibility define, no init needed. */ 67 68 #if LWIP_SO_DONTROUTE 69 struct netif *ip4_route(const ip4_addr_t *dest, rt_scope_t scope); 70 #if LWIP_IPV4_SRC_ROUTING 71 struct netif *ip4_route_src(const ip4_addr_t *src, const ip4_addr_t *dest, rt_scope_t scope); 72 #else /* LWIP_IPV4_SRC_ROUTING */ 73 #define ip4_route_src(src, dest, scope) ip4_route(dest, scope) 74 #endif /* LWIP_IPV4_SRC_ROUTING */ 75 #else 76 struct netif *ip4_route(const ip4_addr_t *dest); 77 #if LWIP_IPV4_SRC_ROUTING 78 struct netif *ip4_route_src(const ip4_addr_t *src, const ip4_addr_t *dest); 79 #else /* LWIP_IPV4_SRC_ROUTING */ 80 #define ip4_route_src(src, dest) ip4_route(dest) 81 #endif /* LWIP_IPV4_SRC_ROUTING */ 82 83 #endif 84 struct ip_pcb; 85 err_t ip4_input(struct pbuf *p, struct netif *inp); 86 #if LWIP_API_RICH 87 err_t ip4_output(struct pbuf *p, const ip4_addr_t *src, const ip4_addr_t *dest, 88 u8_t ttl, u8_t tos, u8_t proto, struct ip_pcb *pcb); 89 #endif /* LWIP_API_RICH */ 90 err_t ip4_output_if(struct pbuf *p, const ip4_addr_t *src, const ip4_addr_t *dest, 91 u8_t ttl, u8_t tos, u8_t proto, struct netif *netif); 92 err_t ip4_output_if_src(struct pbuf *p, const ip4_addr_t *src, const ip4_addr_t *dest, 93 u8_t ttl, u8_t tos, u8_t proto, struct netif *netif); 94 #if LWIP_NETIF_USE_HINTS 95 err_t ip4_output_hinted(struct pbuf *p, const ip4_addr_t *src, const ip4_addr_t *dest, 96 u8_t ttl, u8_t tos, u8_t proto, struct netif_hint *netif_hint, struct ip_pcb *pcb); 97 #endif /* LWIP_NETIF_USE_HINTS */ 98 #if IP_OPTIONS_SEND 99 err_t ip4_output_if_opt(struct pbuf *p, const ip4_addr_t *src, const ip4_addr_t *dest, 100 u8_t ttl, u8_t tos, u8_t proto, struct netif *netif, void *ip_options, 101 u16_t optlen); 102 err_t ip4_output_if_opt_src(struct pbuf *p, const ip4_addr_t *src, const ip4_addr_t *dest, 103 u8_t ttl, u8_t tos, u8_t proto, struct netif *netif, void *ip_options, 104 u16_t optlen); 105 #endif /* IP_OPTIONS_SEND */ 106 107 #if LWIP_MULTICAST_TX_OPTIONS 108 void ip4_set_default_multicast_netif(struct netif *default_multicast_netif); 109 #endif /* LWIP_MULTICAST_TX_OPTIONS */ 110 111 #define ip4_netif_get_local_ip(netif) (((netif) != NULL) ? netif_ip_addr4(netif) : NULL) 112 113 #if IP_DEBUG 114 void ip4_debug_print(struct pbuf *p); 115 #else 116 #define ip4_debug_print(p) (void)0 117 #endif /* IP_DEBUG */ 118 119 #if LWIP_NAT64 120 err_t ip4_iphdr_chksum(struct ip_hdr *iphdr, struct netif *netif, u16_t *chksum); 121 #endif /* LWIP_NAT64 */ 122 123 #if defined (__cplusplus) && __cplusplus 124 } 125 #endif 126 127 #endif /* LWIP_IPV4 */ 128 129 #endif /* LWIP_HDR_IP_H */ 130 131 132