EthernetNetIf -

Users » mamezu » Code » EthernetNetIf

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

LPC2368/lwip/include/ipv4/lwip/ip.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_H__
mamezu	0:0f6c82fcde82	33	#define __LWIP_IP_H__
mamezu	0:0f6c82fcde82	34
mamezu	0:0f6c82fcde82	35	#include "lwip/opt.h"
mamezu	0:0f6c82fcde82	36
mamezu	0:0f6c82fcde82	37	#include "lwip/def.h"
mamezu	0:0f6c82fcde82	38	#include "lwip/pbuf.h"
mamezu	0:0f6c82fcde82	39	#include "lwip/ip_addr.h"
mamezu	0:0f6c82fcde82	40	#include "lwip/err.h"
mamezu	0:0f6c82fcde82	41	#include "lwip/netif.h"
mamezu	0:0f6c82fcde82	42
mamezu	0:0f6c82fcde82	43	#ifdef __cplusplus
mamezu	0:0f6c82fcde82	44	extern "C" {
mamezu	0:0f6c82fcde82	45	#endif
mamezu	0:0f6c82fcde82	46
mamezu	0:0f6c82fcde82	47	/** Currently, the function ip_output_if_opt() is only used with IGMP */
mamezu	0:0f6c82fcde82	48	#define IP_OPTIONS_SEND LWIP_IGMP
mamezu	0:0f6c82fcde82	49
mamezu	0:0f6c82fcde82	50	#define IP_HLEN 20
mamezu	0:0f6c82fcde82	51
mamezu	0:0f6c82fcde82	52	#define IP_PROTO_ICMP 1
mamezu	0:0f6c82fcde82	53	#define IP_PROTO_IGMP 2
mamezu	0:0f6c82fcde82	54	#define IP_PROTO_UDP 17
mamezu	0:0f6c82fcde82	55	#define IP_PROTO_UDPLITE 136
mamezu	0:0f6c82fcde82	56	#define IP_PROTO_TCP 6
mamezu	0:0f6c82fcde82	57
mamezu	0:0f6c82fcde82	58	/* This is passed as the destination address to ip_output_if (not
mamezu	0:0f6c82fcde82	59	to ip_output), meaning that an IP header already is constructed
mamezu	0:0f6c82fcde82	60	in the pbuf. This is used when TCP retransmits. */
mamezu	0:0f6c82fcde82	61	#ifdef IP_HDRINCL
mamezu	0:0f6c82fcde82	62	#undef IP_HDRINCL
mamezu	0:0f6c82fcde82	63	#endif /* IP_HDRINCL */
mamezu	0:0f6c82fcde82	64	#define IP_HDRINCL NULL
mamezu	0:0f6c82fcde82	65
mamezu	0:0f6c82fcde82	66	#if LWIP_NETIF_HWADDRHINT
mamezu	0:0f6c82fcde82	67	#define IP_PCB_ADDRHINT ;u8_t addr_hint
mamezu	0:0f6c82fcde82	68	#else
mamezu	0:0f6c82fcde82	69	#define IP_PCB_ADDRHINT
mamezu	0:0f6c82fcde82	70	#endif /* LWIP_NETIF_HWADDRHINT */
mamezu	0:0f6c82fcde82	71
mamezu	0:0f6c82fcde82	72	/* This is the common part of all PCB types. It needs to be at the
mamezu	0:0f6c82fcde82	73	beginning of a PCB type definition. It is located here so that
mamezu	0:0f6c82fcde82	74	changes to this common part are made in one location instead of
mamezu	0:0f6c82fcde82	75	having to change all PCB structs. */
mamezu	0:0f6c82fcde82	76	#define IP_PCB \
mamezu	0:0f6c82fcde82	77	/* ip addresses in network byte order */ \
mamezu	0:0f6c82fcde82	78	ip_addr_t local_ip; \
mamezu	0:0f6c82fcde82	79	ip_addr_t remote_ip; \
mamezu	0:0f6c82fcde82	80	/* Socket options */ \
mamezu	0:0f6c82fcde82	81	u8_t so_options; \
mamezu	0:0f6c82fcde82	82	/* Type Of Service */ \
mamezu	0:0f6c82fcde82	83	u8_t tos; \
mamezu	0:0f6c82fcde82	84	/* Time To Live */ \
mamezu	0:0f6c82fcde82	85	u8_t ttl \
mamezu	0:0f6c82fcde82	86	/* link layer address resolution hint */ \
mamezu	0:0f6c82fcde82	87	IP_PCB_ADDRHINT
mamezu	0:0f6c82fcde82	88
mamezu	0:0f6c82fcde82	89	struct ip_pcb {
mamezu	0:0f6c82fcde82	90	/* Common members of all PCB types */
mamezu	0:0f6c82fcde82	91	IP_PCB;
mamezu	0:0f6c82fcde82	92	};
mamezu	0:0f6c82fcde82	93
mamezu	0:0f6c82fcde82	94	/*
mamezu	0:0f6c82fcde82	95	* Option flags per-socket. These are the same like SO_XXX.
mamezu	0:0f6c82fcde82	96	*/
mamezu	0:0f6c82fcde82	97	/#define SOF_DEBUG (u8_t)0x01U Unimplemented: turn on debugging info recording /
mamezu	0:0f6c82fcde82	98	#define SOF_ACCEPTCONN (u8_t)0x02U /* socket has had listen() */
mamezu	0:0f6c82fcde82	99	#define SOF_REUSEADDR (u8_t)0x04U /* allow local address reuse */
mamezu	0:0f6c82fcde82	100	#define SOF_KEEPALIVE (u8_t)0x08U /* keep connections alive */
mamezu	0:0f6c82fcde82	101	/#define SOF_DONTROUTE (u8_t)0x10U Unimplemented: just use interface addresses /
mamezu	0:0f6c82fcde82	102	#define SOF_BROADCAST (u8_t)0x20U /* permit to send and to receive broadcast messages (see IP_SOF_BROADCAST option) */
mamezu	0:0f6c82fcde82	103	/#define SOF_USELOOPBACK (u8_t)0x40U Unimplemented: bypass hardware when possible /
mamezu	0:0f6c82fcde82	104	#define SOF_LINGER (u8_t)0x80U /* linger on close if data present */
mamezu	0:0f6c82fcde82	105	/#define SOF_OOBINLINE (u16_t)0x0100U Unimplemented: leave received OOB data in line /
mamezu	0:0f6c82fcde82	106	/#define SOF_REUSEPORT (u16_t)0x0200U Unimplemented: allow local address & port reuse /
mamezu	0:0f6c82fcde82	107
mamezu	0:0f6c82fcde82	108	/* These flags are inherited (e.g. from a listen-pcb to a connection-pcb): */
mamezu	0:0f6c82fcde82	109	#define SOF_INHERITED (SOF_REUSEADDR\|SOF_KEEPALIVE\|SOF_LINGER/\|SOF_DEBUG\|SOF_DONTROUTE\|SOF_OOBINLINE/)
mamezu	0:0f6c82fcde82	110
mamezu	0:0f6c82fcde82	111
mamezu	0:0f6c82fcde82	112	#ifdef PACK_STRUCT_USE_INCLUDES
mamezu	0:0f6c82fcde82	113	# include "arch/bpstruct.h"
mamezu	0:0f6c82fcde82	114	#endif
mamezu	0:0f6c82fcde82	115	PACK_STRUCT_BEGIN
mamezu	0:0f6c82fcde82	116	struct ip_hdr {
mamezu	0:0f6c82fcde82	117	/* version / header length / type of service */
mamezu	0:0f6c82fcde82	118	PACK_STRUCT_FIELD(u16_t _v_hl_tos);
mamezu	0:0f6c82fcde82	119	/* total length */
mamezu	0:0f6c82fcde82	120	PACK_STRUCT_FIELD(u16_t _len);
mamezu	0:0f6c82fcde82	121	/* identification */
mamezu	0:0f6c82fcde82	122	PACK_STRUCT_FIELD(u16_t _id);
mamezu	0:0f6c82fcde82	123	/* fragment offset field */
mamezu	0:0f6c82fcde82	124	PACK_STRUCT_FIELD(u16_t _offset);
mamezu	0:0f6c82fcde82	125	#define IP_RF 0x8000 /* reserved fragment flag */
mamezu	0:0f6c82fcde82	126	#define IP_DF 0x4000 /* dont fragment flag */
mamezu	0:0f6c82fcde82	127	#define IP_MF 0x2000 /* more fragments flag */
mamezu	0:0f6c82fcde82	128	#define IP_OFFMASK 0x1fff /* mask for fragmenting bits */
mamezu	0:0f6c82fcde82	129	/* time to live */
mamezu	0:0f6c82fcde82	130	PACK_STRUCT_FIELD(u8_t _ttl);
mamezu	0:0f6c82fcde82	131	/* protocol*/
mamezu	0:0f6c82fcde82	132	PACK_STRUCT_FIELD(u8_t _proto);
mamezu	0:0f6c82fcde82	133	/* checksum */
mamezu	0:0f6c82fcde82	134	PACK_STRUCT_FIELD(u16_t _chksum);
mamezu	0:0f6c82fcde82	135	/* source and destination IP addresses */
mamezu	0:0f6c82fcde82	136	PACK_STRUCT_FIELD(ip_addr_p_t src);
mamezu	0:0f6c82fcde82	137	PACK_STRUCT_FIELD(ip_addr_p_t dest);
mamezu	0:0f6c82fcde82	138	} PACK_STRUCT_STRUCT;
mamezu	0:0f6c82fcde82	139	PACK_STRUCT_END
mamezu	0:0f6c82fcde82	140	#ifdef PACK_STRUCT_USE_INCLUDES
mamezu	0:0f6c82fcde82	141	# include "arch/epstruct.h"
mamezu	0:0f6c82fcde82	142	#endif
mamezu	0:0f6c82fcde82	143
mamezu	0:0f6c82fcde82	144	#define IPH_V(hdr) (ntohs((hdr)->_v_hl_tos) >> 12)
mamezu	0:0f6c82fcde82	145	#define IPH_HL(hdr) ((ntohs((hdr)->_v_hl_tos) >> 8) & 0x0f)
mamezu	0:0f6c82fcde82	146	#define IPH_TOS(hdr) (ntohs((hdr)->_v_hl_tos) & 0xff)
mamezu	0:0f6c82fcde82	147	#define IPH_LEN(hdr) ((hdr)->_len)
mamezu	0:0f6c82fcde82	148	#define IPH_ID(hdr) ((hdr)->_id)
mamezu	0:0f6c82fcde82	149	#define IPH_OFFSET(hdr) ((hdr)->_offset)
mamezu	0:0f6c82fcde82	150	#define IPH_TTL(hdr) ((hdr)->_ttl)
mamezu	0:0f6c82fcde82	151	#define IPH_PROTO(hdr) ((hdr)->_proto)
mamezu	0:0f6c82fcde82	152	#define IPH_CHKSUM(hdr) ((hdr)->_chksum)
mamezu	0:0f6c82fcde82	153
mamezu	0:0f6c82fcde82	154	#define IPH_VHLTOS_SET(hdr, v, hl, tos) (hdr)->_v_hl_tos = (htons(((v) << 12) \| ((hl) << 8) \| (tos)))
mamezu	0:0f6c82fcde82	155	#define IPH_LEN_SET(hdr, len) (hdr)->_len = (len)
mamezu	0:0f6c82fcde82	156	#define IPH_ID_SET(hdr, id) (hdr)->_id = (id)
mamezu	0:0f6c82fcde82	157	#define IPH_OFFSET_SET(hdr, off) (hdr)->_offset = (off)
mamezu	0:0f6c82fcde82	158	#define IPH_TTL_SET(hdr, ttl) (hdr)->_ttl = (u8_t)(ttl)
mamezu	0:0f6c82fcde82	159	#define IPH_PROTO_SET(hdr, proto) (hdr)->_proto = (u8_t)(proto)
mamezu	0:0f6c82fcde82	160	#define IPH_CHKSUM_SET(hdr, chksum) (hdr)->_chksum = (chksum)
mamezu	0:0f6c82fcde82	161
mamezu	0:0f6c82fcde82	162	/** The interface that provided the packet for the current callback invocation. */
mamezu	0:0f6c82fcde82	163	extern struct netif *current_netif;
mamezu	0:0f6c82fcde82	164	/** Header of the input packet currently being processed. */
mamezu	0:0f6c82fcde82	165	extern const struct ip_hdr *current_header;
mamezu	0:0f6c82fcde82	166	/** Source IP address of current_header */
mamezu	0:0f6c82fcde82	167	extern ip_addr_t current_iphdr_src;
mamezu	0:0f6c82fcde82	168	/** Destination IP address of current_header */
mamezu	0:0f6c82fcde82	169	extern ip_addr_t current_iphdr_dest;
mamezu	0:0f6c82fcde82	170
mamezu	0:0f6c82fcde82	171	#define ip_init() /* Compatibility define, not init needed. */
mamezu	0:0f6c82fcde82	172	struct netif ip_route(ip_addr_t dest);
mamezu	0:0f6c82fcde82	173	err_t ip_input(struct pbuf p, struct netif inp);
mamezu	0:0f6c82fcde82	174	err_t ip_output(struct pbuf p, ip_addr_t src, ip_addr_t *dest,
mamezu	0:0f6c82fcde82	175	u8_t ttl, u8_t tos, u8_t proto);
mamezu	0:0f6c82fcde82	176	err_t ip_output_if(struct pbuf p, ip_addr_t src, ip_addr_t *dest,
mamezu	0:0f6c82fcde82	177	u8_t ttl, u8_t tos, u8_t proto,
mamezu	0:0f6c82fcde82	178	struct netif *netif);
mamezu	0:0f6c82fcde82	179	#if LWIP_NETIF_HWADDRHINT
mamezu	0:0f6c82fcde82	180	err_t ip_output_hinted(struct pbuf p, ip_addr_t src, ip_addr_t *dest,
mamezu	0:0f6c82fcde82	181	u8_t ttl, u8_t tos, u8_t proto, u8_t *addr_hint);
mamezu	0:0f6c82fcde82	182	#endif /* LWIP_NETIF_HWADDRHINT */
mamezu	0:0f6c82fcde82	183	#if IP_OPTIONS_SEND
mamezu	0:0f6c82fcde82	184	err_t ip_output_if_opt(struct pbuf p, ip_addr_t src, ip_addr_t *dest,
mamezu	0:0f6c82fcde82	185	u8_t ttl, u8_t tos, u8_t proto, struct netif netif, void ip_options,
mamezu	0:0f6c82fcde82	186	u16_t optlen);
mamezu	0:0f6c82fcde82	187	#endif /* IP_OPTIONS_SEND */
mamezu	0:0f6c82fcde82	188	/** Get the interface that received the current packet.
mamezu	0:0f6c82fcde82	189	* This function must only be called from a receive callback (udp_recv,
mamezu	0:0f6c82fcde82	190	* raw_recv, tcp_accept). It will return NULL otherwise. */
mamezu	0:0f6c82fcde82	191	#define ip_current_netif() (current_netif)
mamezu	0:0f6c82fcde82	192	/** Get the IP header of the current packet.
mamezu	0:0f6c82fcde82	193	* This function must only be called from a receive callback (udp_recv,
mamezu	0:0f6c82fcde82	194	* raw_recv, tcp_accept). It will return NULL otherwise. */
mamezu	0:0f6c82fcde82	195	#define ip_current_header() (current_header)
mamezu	0:0f6c82fcde82	196	/** Source IP address of current_header */
mamezu	0:0f6c82fcde82	197	#define ip_current_src_addr() (&current_iphdr_src)
mamezu	0:0f6c82fcde82	198	/** Destination IP address of current_header */
mamezu	0:0f6c82fcde82	199	#define ip_current_dest_addr() (&current_iphdr_dest)
mamezu	0:0f6c82fcde82	200
mamezu	0:0f6c82fcde82	201	#if IP_DEBUG
mamezu	0:0f6c82fcde82	202	void ip_debug_print(struct pbuf *p);
mamezu	0:0f6c82fcde82	203	#else
mamezu	0:0f6c82fcde82	204	#define ip_debug_print(p)
mamezu	0:0f6c82fcde82	205	#endif /* IP_DEBUG */
mamezu	0:0f6c82fcde82	206
mamezu	0:0f6c82fcde82	207	#ifdef __cplusplus
mamezu	0:0f6c82fcde82	208	}
mamezu	0:0f6c82fcde82	209	#endif
mamezu	0:0f6c82fcde82	210
mamezu	0:0f6c82fcde82	211	#endif /* __LWIP_IP_H__ */
mamezu	0:0f6c82fcde82	212
mamezu	0:0f6c82fcde82	213

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

LPC2368/lwip/include/ipv4/lwip/ip.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