NetServices Stack source

Dependents:   HelloWorld ServoInterfaceBoardExample1 4180_Lab4

Committer:
donatien
Date:
Tue Jul 27 15:59:42 2010 +0000
Revision:
5:dd63a1e02b1b
Parent:
0:632c9925f013

        

Who changed what in which revision?

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