ZG2100 Network interface source
lwip/include/ipv4/lwip/ip_addr.h@0:b802fc31f1db, 2010-07-09 (annotated)
- Committer:
- donatien
- Date:
- Fri Jul 09 15:37:23 2010 +0000
- Revision:
- 0:b802fc31f1db
- Child:
- 1:3a7c15057192
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
donatien | 0:b802fc31f1db | 1 | /* |
donatien | 0:b802fc31f1db | 2 | * Copyright (c) 2001-2004 Swedish Institute of Computer Science. |
donatien | 0:b802fc31f1db | 3 | * All rights reserved. |
donatien | 0:b802fc31f1db | 4 | * |
donatien | 0:b802fc31f1db | 5 | * Redistribution and use in source and binary forms, with or without modification, |
donatien | 0:b802fc31f1db | 6 | * are permitted provided that the following conditions are met: |
donatien | 0:b802fc31f1db | 7 | * |
donatien | 0:b802fc31f1db | 8 | * 1. Redistributions of source code must retain the above copyright notice, |
donatien | 0:b802fc31f1db | 9 | * this list of conditions and the following disclaimer. |
donatien | 0:b802fc31f1db | 10 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
donatien | 0:b802fc31f1db | 11 | * this list of conditions and the following disclaimer in the documentation |
donatien | 0:b802fc31f1db | 12 | * and/or other materials provided with the distribution. |
donatien | 0:b802fc31f1db | 13 | * 3. The name of the author may not be used to endorse or promote products |
donatien | 0:b802fc31f1db | 14 | * derived from this software without specific prior written permission. |
donatien | 0:b802fc31f1db | 15 | * |
donatien | 0:b802fc31f1db | 16 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED |
donatien | 0:b802fc31f1db | 17 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
donatien | 0:b802fc31f1db | 18 | * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT |
donatien | 0:b802fc31f1db | 19 | * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
donatien | 0:b802fc31f1db | 20 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT |
donatien | 0:b802fc31f1db | 21 | * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
donatien | 0:b802fc31f1db | 22 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
donatien | 0:b802fc31f1db | 23 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING |
donatien | 0:b802fc31f1db | 24 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY |
donatien | 0:b802fc31f1db | 25 | * OF SUCH DAMAGE. |
donatien | 0:b802fc31f1db | 26 | * |
donatien | 0:b802fc31f1db | 27 | * This file is part of the lwIP TCP/IP stack. |
donatien | 0:b802fc31f1db | 28 | * |
donatien | 0:b802fc31f1db | 29 | * Author: Adam Dunkels <adam@sics.se> |
donatien | 0:b802fc31f1db | 30 | * |
donatien | 0:b802fc31f1db | 31 | */ |
donatien | 0:b802fc31f1db | 32 | #ifndef __LWIP_IP_ADDR_H__ |
donatien | 0:b802fc31f1db | 33 | #define __LWIP_IP_ADDR_H__ |
donatien | 0:b802fc31f1db | 34 | |
donatien | 0:b802fc31f1db | 35 | #include "lwip/opt.h" |
donatien | 0:b802fc31f1db | 36 | #include "lwip/def.h" |
donatien | 0:b802fc31f1db | 37 | |
donatien | 0:b802fc31f1db | 38 | #ifdef __cplusplus |
donatien | 0:b802fc31f1db | 39 | extern "C" { |
donatien | 0:b802fc31f1db | 40 | #endif |
donatien | 0:b802fc31f1db | 41 | |
donatien | 0:b802fc31f1db | 42 | #ifdef PACK_STRUCT_USE_INCLUDES |
donatien | 0:b802fc31f1db | 43 | # include "arch/bpstruct.h" |
donatien | 0:b802fc31f1db | 44 | #endif |
donatien | 0:b802fc31f1db | 45 | PACK_STRUCT_BEGIN |
donatien | 0:b802fc31f1db | 46 | struct _ip_addr { |
donatien | 0:b802fc31f1db | 47 | PACK_STRUCT_FIELD(u32_t addr); |
donatien | 0:b802fc31f1db | 48 | } PACK_STRUCT_STRUCT; |
donatien | 0:b802fc31f1db | 49 | PACK_STRUCT_END |
donatien | 0:b802fc31f1db | 50 | #ifdef PACK_STRUCT_USE_INCLUDES |
donatien | 0:b802fc31f1db | 51 | # include "arch/epstruct.h" |
donatien | 0:b802fc31f1db | 52 | #endif |
donatien | 0:b802fc31f1db | 53 | |
donatien | 0:b802fc31f1db | 54 | typedef struct _ip_addr ip_addr_t; |
donatien | 0:b802fc31f1db | 55 | |
donatien | 0:b802fc31f1db | 56 | /* |
donatien | 0:b802fc31f1db | 57 | * struct ipaddr2 is used in the definition of the ARP packet format in |
donatien | 0:b802fc31f1db | 58 | * order to support compilers that don't have structure packing. |
donatien | 0:b802fc31f1db | 59 | */ |
donatien | 0:b802fc31f1db | 60 | #ifdef PACK_STRUCT_USE_INCLUDES |
donatien | 0:b802fc31f1db | 61 | # include "arch/bpstruct.h" |
donatien | 0:b802fc31f1db | 62 | #endif |
donatien | 0:b802fc31f1db | 63 | PACK_STRUCT_BEGIN |
donatien | 0:b802fc31f1db | 64 | struct ip_addr2 { |
donatien | 0:b802fc31f1db | 65 | PACK_STRUCT_FIELD(u16_t addrw[2]); |
donatien | 0:b802fc31f1db | 66 | } PACK_STRUCT_STRUCT; |
donatien | 0:b802fc31f1db | 67 | PACK_STRUCT_END |
donatien | 0:b802fc31f1db | 68 | #ifdef PACK_STRUCT_USE_INCLUDES |
donatien | 0:b802fc31f1db | 69 | # include "arch/epstruct.h" |
donatien | 0:b802fc31f1db | 70 | #endif |
donatien | 0:b802fc31f1db | 71 | |
donatien | 0:b802fc31f1db | 72 | /* Forward declaration to not include netif.h */ |
donatien | 0:b802fc31f1db | 73 | struct netif; |
donatien | 0:b802fc31f1db | 74 | |
donatien | 0:b802fc31f1db | 75 | extern const ip_addr_t ip_addr_any; |
donatien | 0:b802fc31f1db | 76 | extern const ip_addr_t ip_addr_broadcast; |
donatien | 0:b802fc31f1db | 77 | |
donatien | 0:b802fc31f1db | 78 | /** IP_ADDR_ can be used as a fixed IP address |
donatien | 0:b802fc31f1db | 79 | * for the wildcard and the broadcast address |
donatien | 0:b802fc31f1db | 80 | */ |
donatien | 0:b802fc31f1db | 81 | #define IP_ADDR_ANY ((ip_addr_t *)&ip_addr_any) |
donatien | 0:b802fc31f1db | 82 | #define IP_ADDR_BROADCAST ((ip_addr_t *)&ip_addr_broadcast) |
donatien | 0:b802fc31f1db | 83 | |
donatien | 0:b802fc31f1db | 84 | /** 255.255.255.255 */ |
donatien | 0:b802fc31f1db | 85 | #define IPADDR_NONE ((u32_t)0xffffffffUL) |
donatien | 0:b802fc31f1db | 86 | /** 127.0.0.1 */ |
donatien | 0:b802fc31f1db | 87 | #define IPADDR_LOOPBACK ((u32_t)0x7f000001UL) |
donatien | 0:b802fc31f1db | 88 | /** 0.0.0.0 */ |
donatien | 0:b802fc31f1db | 89 | #define IPADDR_ANY ((u32_t)0x00000000UL) |
donatien | 0:b802fc31f1db | 90 | /** 255.255.255.255 */ |
donatien | 0:b802fc31f1db | 91 | #define IPADDR_BROADCAST ((u32_t)0xffffffffUL) |
donatien | 0:b802fc31f1db | 92 | |
donatien | 0:b802fc31f1db | 93 | /* Definitions of the bits in an Internet address integer. |
donatien | 0:b802fc31f1db | 94 | |
donatien | 0:b802fc31f1db | 95 | On subnets, host and network parts are found according to |
donatien | 0:b802fc31f1db | 96 | the subnet mask, not these masks. */ |
donatien | 0:b802fc31f1db | 97 | #define IP_CLASSA(a) ((((u32_t)(a)) & 0x80000000UL) == 0) |
donatien | 0:b802fc31f1db | 98 | #define IP_CLASSA_NET 0xff000000 |
donatien | 0:b802fc31f1db | 99 | #define IP_CLASSA_NSHIFT 24 |
donatien | 0:b802fc31f1db | 100 | #define IP_CLASSA_HOST (0xffffffff & ~IP_CLASSA_NET) |
donatien | 0:b802fc31f1db | 101 | #define IP_CLASSA_MAX 128 |
donatien | 0:b802fc31f1db | 102 | |
donatien | 0:b802fc31f1db | 103 | #define IP_CLASSB(a) ((((u32_t)(a)) & 0xc0000000UL) == 0x80000000UL) |
donatien | 0:b802fc31f1db | 104 | #define IP_CLASSB_NET 0xffff0000 |
donatien | 0:b802fc31f1db | 105 | #define IP_CLASSB_NSHIFT 16 |
donatien | 0:b802fc31f1db | 106 | #define IP_CLASSB_HOST (0xffffffff & ~IP_CLASSB_NET) |
donatien | 0:b802fc31f1db | 107 | #define IP_CLASSB_MAX 65536 |
donatien | 0:b802fc31f1db | 108 | |
donatien | 0:b802fc31f1db | 109 | #define IP_CLASSC(a) ((((u32_t)(a)) & 0xe0000000UL) == 0xc0000000UL) |
donatien | 0:b802fc31f1db | 110 | #define IP_CLASSC_NET 0xffffff00 |
donatien | 0:b802fc31f1db | 111 | #define IP_CLASSC_NSHIFT 8 |
donatien | 0:b802fc31f1db | 112 | #define IP_CLASSC_HOST (0xffffffff & ~IP_CLASSC_NET) |
donatien | 0:b802fc31f1db | 113 | |
donatien | 0:b802fc31f1db | 114 | #define IP_CLASSD(a) (((u32_t)(a) & 0xf0000000UL) == 0xe0000000UL) |
donatien | 0:b802fc31f1db | 115 | #define IP_CLASSD_NET 0xf0000000 /* These ones aren't really */ |
donatien | 0:b802fc31f1db | 116 | #define IP_CLASSD_NSHIFT 28 /* net and host fields, but */ |
donatien | 0:b802fc31f1db | 117 | #define IP_CLASSD_HOST 0x0fffffff /* routing needn't know. */ |
donatien | 0:b802fc31f1db | 118 | #define IP_MULTICAST(a) IP_CLASSD(a) |
donatien | 0:b802fc31f1db | 119 | |
donatien | 0:b802fc31f1db | 120 | #define IP_EXPERIMENTAL(a) (((u32_t)(a) & 0xf0000000UL) == 0xf0000000UL) |
donatien | 0:b802fc31f1db | 121 | #define IP_BADCLASS(a) (((u32_t)(a) & 0xf0000000UL) == 0xf0000000UL) |
donatien | 0:b802fc31f1db | 122 | |
donatien | 0:b802fc31f1db | 123 | #define IP_LOOPBACKNET 127 /* official! */ |
donatien | 0:b802fc31f1db | 124 | |
donatien | 0:b802fc31f1db | 125 | |
donatien | 0:b802fc31f1db | 126 | #if BYTE_ORDER == BIG_ENDIAN |
donatien | 0:b802fc31f1db | 127 | /** Set an IP address given by the four byte-parts */ |
donatien | 0:b802fc31f1db | 128 | #define IP4_ADDR(ipaddr, a,b,c,d) \ |
donatien | 0:b802fc31f1db | 129 | (ipaddr)->addr = ((u32_t)((a) & 0xff) << 24) | \ |
donatien | 0:b802fc31f1db | 130 | ((u32_t)((b) & 0xff) << 16) | \ |
donatien | 0:b802fc31f1db | 131 | ((u32_t)((c) & 0xff) << 8) | \ |
donatien | 0:b802fc31f1db | 132 | (u32_t)((d) & 0xff) |
donatien | 0:b802fc31f1db | 133 | #else |
donatien | 0:b802fc31f1db | 134 | /** Set an IP address given by the four byte-parts. |
donatien | 0:b802fc31f1db | 135 | Little-endian version that prevents the use of htonl. */ |
donatien | 0:b802fc31f1db | 136 | #define IP4_ADDR(ipaddr, a,b,c,d) \ |
donatien | 0:b802fc31f1db | 137 | (ipaddr)->addr = ((u32_t)((d) & 0xff) << 24) | \ |
donatien | 0:b802fc31f1db | 138 | ((u32_t)((c) & 0xff) << 16) | \ |
donatien | 0:b802fc31f1db | 139 | ((u32_t)((b) & 0xff) << 8) | \ |
donatien | 0:b802fc31f1db | 140 | (u32_t)((a) & 0xff) |
donatien | 0:b802fc31f1db | 141 | #endif |
donatien | 0:b802fc31f1db | 142 | |
donatien | 0:b802fc31f1db | 143 | /** Copy IP address - faster than ip_addr_set: no NULL check */ |
donatien | 0:b802fc31f1db | 144 | #define ip_addr_copy(dest, src) ((dest).addr = (src).addr) |
donatien | 0:b802fc31f1db | 145 | /** Safely copy one IP address to another (src may be NULL) */ |
donatien | 0:b802fc31f1db | 146 | #define ip_addr_set(dest, src) ((dest)->addr = \ |
donatien | 0:b802fc31f1db | 147 | ((src) == NULL ? 0 : \ |
donatien | 0:b802fc31f1db | 148 | (src)->addr)) |
donatien | 0:b802fc31f1db | 149 | /** Set complete address to zero */ |
donatien | 0:b802fc31f1db | 150 | #define ip_addr_set_zero(ipaddr) ((ipaddr)->addr = 0) |
donatien | 0:b802fc31f1db | 151 | /** Set address to IPADDR_ANY (no need for htonl()) */ |
donatien | 0:b802fc31f1db | 152 | #define ip_addr_set_any(ipaddr) ((ipaddr)->addr = IPADDR_ANY) |
donatien | 0:b802fc31f1db | 153 | /** Set address to loopback address */ |
donatien | 0:b802fc31f1db | 154 | #define ip_addr_set_loopback(ipaddr) ((ipaddr)->addr = htonl(IPADDR_LOOPBACK)) |
donatien | 0:b802fc31f1db | 155 | /** Safely copy one IP address to another and change byte order |
donatien | 0:b802fc31f1db | 156 | * from host- to network-order. */ |
donatien | 0:b802fc31f1db | 157 | #define ip_addr_set_hton(dest, src) ((dest)->addr = \ |
donatien | 0:b802fc31f1db | 158 | ((src) == NULL ? 0:\ |
donatien | 0:b802fc31f1db | 159 | htonl((src)->addr))) |
donatien | 0:b802fc31f1db | 160 | /** IPv4 only: set the IP address given as an u32_t */ |
donatien | 0:b802fc31f1db | 161 | #define ip4_addr_set_u32(dest_ipaddr, src_u32) ((dest_ipaddr)->addr = (src_u32)) |
donatien | 0:b802fc31f1db | 162 | /** IPv4 only: get the IP address as an u32_t */ |
donatien | 0:b802fc31f1db | 163 | #define ip4_addr_get_u32(src_ipaddr) ((src_ipaddr)->addr) |
donatien | 0:b802fc31f1db | 164 | |
donatien | 0:b802fc31f1db | 165 | /** Get the network address by combining host address with netmask */ |
donatien | 0:b802fc31f1db | 166 | #define ip_addr_get_network(target, host, netmask) ((target)->addr = ((host)->addr) & ((netmask)->addr)) |
donatien | 0:b802fc31f1db | 167 | |
donatien | 0:b802fc31f1db | 168 | /** |
donatien | 0:b802fc31f1db | 169 | * Determine if two address are on the same network. |
donatien | 0:b802fc31f1db | 170 | * |
donatien | 0:b802fc31f1db | 171 | * @arg addr1 IP address 1 |
donatien | 0:b802fc31f1db | 172 | * @arg addr2 IP address 2 |
donatien | 0:b802fc31f1db | 173 | * @arg mask network identifier mask |
donatien | 0:b802fc31f1db | 174 | * @return !0 if the network identifiers of both address match |
donatien | 0:b802fc31f1db | 175 | */ |
donatien | 0:b802fc31f1db | 176 | #define ip_addr_netcmp(addr1, addr2, mask) (((addr1)->addr & \ |
donatien | 0:b802fc31f1db | 177 | (mask)->addr) == \ |
donatien | 0:b802fc31f1db | 178 | ((addr2)->addr & \ |
donatien | 0:b802fc31f1db | 179 | (mask)->addr)) |
donatien | 0:b802fc31f1db | 180 | #define ip_addr_cmp(addr1, addr2) ((addr1)->addr == (addr2)->addr) |
donatien | 0:b802fc31f1db | 181 | |
donatien | 0:b802fc31f1db | 182 | #define ip_addr_isany(addr1) ((addr1) == NULL || (addr1)->addr == IPADDR_ANY) |
donatien | 0:b802fc31f1db | 183 | |
donatien | 0:b802fc31f1db | 184 | u8_t ip_addr_isbroadcast(ip_addr_t *, struct netif *); |
donatien | 0:b802fc31f1db | 185 | |
donatien | 0:b802fc31f1db | 186 | #define ip_addr_ismulticast(addr1) (((addr1)->addr & ntohl(0xf0000000UL)) == ntohl(0xe0000000UL)) |
donatien | 0:b802fc31f1db | 187 | |
donatien | 0:b802fc31f1db | 188 | #define ip_addr_islinklocal(addr1) (((addr1)->addr & ntohl(0xffff0000UL)) == ntohl(0xa9fe0000UL)) |
donatien | 0:b802fc31f1db | 189 | |
donatien | 0:b802fc31f1db | 190 | #define ip_addr_debug_print(debug, ipaddr) \ |
donatien | 0:b802fc31f1db | 191 | LWIP_DEBUGF(debug, ("%"U16_F".%"U16_F".%"U16_F".%"U16_F, \ |
donatien | 0:b802fc31f1db | 192 | ipaddr != NULL ? ip4_addr1_16(ipaddr) : 0, \ |
donatien | 0:b802fc31f1db | 193 | ipaddr != NULL ? ip4_addr2_16(ipaddr) : 0, \ |
donatien | 0:b802fc31f1db | 194 | ipaddr != NULL ? ip4_addr3_16(ipaddr) : 0, \ |
donatien | 0:b802fc31f1db | 195 | ipaddr != NULL ? ip4_addr4_16(ipaddr) : 0)) |
donatien | 0:b802fc31f1db | 196 | |
donatien | 0:b802fc31f1db | 197 | /* Get one byte from the 4-byte address */ |
donatien | 0:b802fc31f1db | 198 | #define ip4_addr1(ipaddr) (((u8_t*)(ipaddr))[0]) |
donatien | 0:b802fc31f1db | 199 | #define ip4_addr2(ipaddr) (((u8_t*)(ipaddr))[1]) |
donatien | 0:b802fc31f1db | 200 | #define ip4_addr3(ipaddr) (((u8_t*)(ipaddr))[2]) |
donatien | 0:b802fc31f1db | 201 | #define ip4_addr4(ipaddr) (((u8_t*)(ipaddr))[3]) |
donatien | 0:b802fc31f1db | 202 | /* These are cast to u16_t, with the intent that they are often arguments |
donatien | 0:b802fc31f1db | 203 | * to printf using the U16_F format from cc.h. */ |
donatien | 0:b802fc31f1db | 204 | #define ip4_addr1_16(ipaddr) ((u16_t)ip4_addr1(ipaddr)) |
donatien | 0:b802fc31f1db | 205 | #define ip4_addr2_16(ipaddr) ((u16_t)ip4_addr2(ipaddr)) |
donatien | 0:b802fc31f1db | 206 | #define ip4_addr3_16(ipaddr) ((u16_t)ip4_addr3(ipaddr)) |
donatien | 0:b802fc31f1db | 207 | #define ip4_addr4_16(ipaddr) ((u16_t)ip4_addr4(ipaddr)) |
donatien | 0:b802fc31f1db | 208 | |
donatien | 0:b802fc31f1db | 209 | /** For backwards compatibility */ |
donatien | 0:b802fc31f1db | 210 | #define ip_ntoa(ipaddr) ipaddr_ntoa(ipaddr) |
donatien | 0:b802fc31f1db | 211 | |
donatien | 0:b802fc31f1db | 212 | u32_t ipaddr_addr(const char *cp); |
donatien | 0:b802fc31f1db | 213 | int ipaddr_aton(const char *cp, ip_addr_t *addr); |
donatien | 0:b802fc31f1db | 214 | /** returns ptr to static buffer; not reentrant! */ |
donatien | 0:b802fc31f1db | 215 | char *ipaddr_ntoa(ip_addr_t *addr); |
donatien | 0:b802fc31f1db | 216 | char *ipaddr_ntoa_r(ip_addr_t *addr, char *buf, int buflen); |
donatien | 0:b802fc31f1db | 217 | |
donatien | 0:b802fc31f1db | 218 | #ifdef __cplusplus |
donatien | 0:b802fc31f1db | 219 | } |
donatien | 0:b802fc31f1db | 220 | #endif |
donatien | 0:b802fc31f1db | 221 | |
donatien | 0:b802fc31f1db | 222 | #endif /* __LWIP_IP_ADDR_H__ */ |