Ethernet - | Mbed

Users » slowness » Code » Ethernet

bruno LARNAUDIE / Mbed 2 deprecated Ethernet

LPC1768/lwip/include/ipv4/lwip/ip_addr.h@0:cd4c47744fa1, 2011-09-06 (annotated)

Committer:: slowness
Date:: Tue Sep 06 18:10:36 2011 +0000
Revision:: 0:cd4c47744fa1

Who changed what in which revision?

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

Repository toolbox

Export to desktop IDE

Build repository

Repository details

Type:	Program
Mbed OS support:	Mbed 2 deprecated
Created:	06 Sep 2011
Imports:	38
Forks:	0
Commits:	1
Dependents:	0
Dependencies:	1
Followers:	2

LPC1768/lwip/include/ipv4/lwip/ip_addr.h@0:cd4c47744fa1, 2011-09-06 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning