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

api/types/Socket/lwip/ip_addr.h@29:b6af04b77a56, 2014-10-27 (annotated)

Committer:
dan_ackme
Date:
Mon Oct 27 13:42:26 2014 -0700
Revision:
29:b6af04b77a56
refactored library layout

Who changed what in which revision?

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