ACKme / WiConnect

Host library for controlling a WiConnect enabled Wi-Fi module.

Dependents:   wiconnect-ota_example wiconnect-web_setup_example wiconnect-test-console wiconnect-tcp_server_example ... more

sdk/mbed/types/Socket/lwip/ip_addr.h@17:7268f365676b, 2014-08-23 (annotated)

Committer:
dan_ackme
Date:
Sat Aug 23 05:39:17 2014 -0700
Revision:
17:7268f365676b
Fixes and documentation updates

Who changed what in which revision?

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