Pranav Sawant / EthernetNetIf

12Oct2012MbedLab

Dependents:   Lab3_VoiceMeter

Fork of EthernetNetIf by Donatien Garnier

LPC1768/lwip/include/ipv4/lwip/ip_addr.h@6:22ce63eddd2b, 2012-10-12 (annotated)

Committer:
psawant9
Date:
Fri Oct 12 16:02:00 2012 +0000
Revision:
6:22ce63eddd2b
Parent:
5:bc7df6da7589 
Done

Who changed what in which revision?

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