EthernetNetIf -

Users » mamezu » Code » EthernetNetIf

Dependents: SNMPAgent HTTPServer think_speak_a cyassl-client ... more

LPC1768/lwip/include/ipv4/lwip/ip_addr.h@0:0f6c82fcde82, 2010-12-09 (annotated)

Committer:: mamezu
Date:: Thu Dec 09 01:33:56 2010 +0000
Revision:: 0:0f6c82fcde82

Who changed what in which revision?

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

Repository toolbox

Export to desktop IDE

Repository details

Type:	Library
Created:	09 Dec 2010
Imports:	5699
Forks:	0
Commits:	1
Dependents:	36
Dependencies:	0
Followers:	117

LPC1768/lwip/include/ipv4/lwip/ip_addr.h@0:0f6c82fcde82, 2010-12-09 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning