NetServices -

Users » segundo » Code » NetServices

Dependents: TimeZoneDemo EthernetJackTestCode MMEx_Challenge ntp_mem ... more

lwip/include/ipv4/lwip/ip.h@0:ac1725ba162c, 2010-11-09 (annotated)

Committer:: segundo
Date:: Tue Nov 09 20:54:15 2010 +0000
Revision:: 0:ac1725ba162c

Who changed what in which revision?

User	Revision	Line number	New contents of line
segundo	0:ac1725ba162c	1	/*
segundo	0:ac1725ba162c	2	* Copyright (c) 2001-2004 Swedish Institute of Computer Science.
segundo	0:ac1725ba162c	3	* All rights reserved.
segundo	0:ac1725ba162c	4	*
segundo	0:ac1725ba162c	5	* Redistribution and use in source and binary forms, with or without modification,
segundo	0:ac1725ba162c	6	* are permitted provided that the following conditions are met:
segundo	0:ac1725ba162c	7	*
segundo	0:ac1725ba162c	8	* 1. Redistributions of source code must retain the above copyright notice,
segundo	0:ac1725ba162c	9	* this list of conditions and the following disclaimer.
segundo	0:ac1725ba162c	10	* 2. Redistributions in binary form must reproduce the above copyright notice,
segundo	0:ac1725ba162c	11	* this list of conditions and the following disclaimer in the documentation
segundo	0:ac1725ba162c	12	* and/or other materials provided with the distribution.
segundo	0:ac1725ba162c	13	* 3. The name of the author may not be used to endorse or promote products
segundo	0:ac1725ba162c	14	* derived from this software without specific prior written permission.
segundo	0:ac1725ba162c	15	*
segundo	0:ac1725ba162c	16	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
segundo	0:ac1725ba162c	17	* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
segundo	0:ac1725ba162c	18	* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
segundo	0:ac1725ba162c	19	* SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
segundo	0:ac1725ba162c	20	* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
segundo	0:ac1725ba162c	21	* OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
segundo	0:ac1725ba162c	22	* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
segundo	0:ac1725ba162c	23	* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
segundo	0:ac1725ba162c	24	* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
segundo	0:ac1725ba162c	25	* OF SUCH DAMAGE.
segundo	0:ac1725ba162c	26	*
segundo	0:ac1725ba162c	27	* This file is part of the lwIP TCP/IP stack.
segundo	0:ac1725ba162c	28	*
segundo	0:ac1725ba162c	29	* Author: Adam Dunkels <adam@sics.se>
segundo	0:ac1725ba162c	30	*
segundo	0:ac1725ba162c	31	*/
segundo	0:ac1725ba162c	32	#ifndef __LWIP_IP_H__
segundo	0:ac1725ba162c	33	#define __LWIP_IP_H__
segundo	0:ac1725ba162c	34
segundo	0:ac1725ba162c	35	#include "lwip/opt.h"
segundo	0:ac1725ba162c	36
segundo	0:ac1725ba162c	37	#include "lwip/def.h"
segundo	0:ac1725ba162c	38	#include "lwip/pbuf.h"
segundo	0:ac1725ba162c	39	#include "lwip/ip_addr.h"
segundo	0:ac1725ba162c	40	#include "lwip/err.h"
segundo	0:ac1725ba162c	41	#include "lwip/netif.h"
segundo	0:ac1725ba162c	42
segundo	0:ac1725ba162c	43	#ifdef __cplusplus
segundo	0:ac1725ba162c	44	extern "C" {
segundo	0:ac1725ba162c	45	#endif
segundo	0:ac1725ba162c	46
segundo	0:ac1725ba162c	47	/** Currently, the function ip_output_if_opt() is only used with IGMP */
segundo	0:ac1725ba162c	48	#define IP_OPTIONS_SEND LWIP_IGMP
segundo	0:ac1725ba162c	49
segundo	0:ac1725ba162c	50	#define IP_HLEN 20
segundo	0:ac1725ba162c	51
segundo	0:ac1725ba162c	52	#define IP_PROTO_ICMP 1
segundo	0:ac1725ba162c	53	#define IP_PROTO_IGMP 2
segundo	0:ac1725ba162c	54	#define IP_PROTO_UDP 17
segundo	0:ac1725ba162c	55	#define IP_PROTO_UDPLITE 136
segundo	0:ac1725ba162c	56	#define IP_PROTO_TCP 6
segundo	0:ac1725ba162c	57
segundo	0:ac1725ba162c	58	/* This is passed as the destination address to ip_output_if (not
segundo	0:ac1725ba162c	59	to ip_output), meaning that an IP header already is constructed
segundo	0:ac1725ba162c	60	in the pbuf. This is used when TCP retransmits. */
segundo	0:ac1725ba162c	61	#ifdef IP_HDRINCL
segundo	0:ac1725ba162c	62	#undef IP_HDRINCL
segundo	0:ac1725ba162c	63	#endif /* IP_HDRINCL */
segundo	0:ac1725ba162c	64	#define IP_HDRINCL NULL
segundo	0:ac1725ba162c	65
segundo	0:ac1725ba162c	66	#if LWIP_NETIF_HWADDRHINT
segundo	0:ac1725ba162c	67	#define IP_PCB_ADDRHINT ;u8_t addr_hint
segundo	0:ac1725ba162c	68	#else
segundo	0:ac1725ba162c	69	#define IP_PCB_ADDRHINT
segundo	0:ac1725ba162c	70	#endif /* LWIP_NETIF_HWADDRHINT */
segundo	0:ac1725ba162c	71
segundo	0:ac1725ba162c	72	/* This is the common part of all PCB types. It needs to be at the
segundo	0:ac1725ba162c	73	beginning of a PCB type definition. It is located here so that
segundo	0:ac1725ba162c	74	changes to this common part are made in one location instead of
segundo	0:ac1725ba162c	75	having to change all PCB structs. */
segundo	0:ac1725ba162c	76	#define IP_PCB \
segundo	0:ac1725ba162c	77	/* ip addresses in network byte order */ \
segundo	0:ac1725ba162c	78	ip_addr_t local_ip; \
segundo	0:ac1725ba162c	79	ip_addr_t remote_ip; \
segundo	0:ac1725ba162c	80	/* Socket options */ \
segundo	0:ac1725ba162c	81	u8_t so_options; \
segundo	0:ac1725ba162c	82	/* Type Of Service */ \
segundo	0:ac1725ba162c	83	u8_t tos; \
segundo	0:ac1725ba162c	84	/* Time To Live */ \
segundo	0:ac1725ba162c	85	u8_t ttl \
segundo	0:ac1725ba162c	86	/* link layer address resolution hint */ \
segundo	0:ac1725ba162c	87	IP_PCB_ADDRHINT
segundo	0:ac1725ba162c	88
segundo	0:ac1725ba162c	89	struct ip_pcb {
segundo	0:ac1725ba162c	90	/* Common members of all PCB types */
segundo	0:ac1725ba162c	91	IP_PCB;
segundo	0:ac1725ba162c	92	};
segundo	0:ac1725ba162c	93
segundo	0:ac1725ba162c	94	/*
segundo	0:ac1725ba162c	95	* Option flags per-socket. These are the same like SO_XXX.
segundo	0:ac1725ba162c	96	*/
segundo	0:ac1725ba162c	97	/#define SOF_DEBUG (u8_t)0x01U Unimplemented: turn on debugging info recording /
segundo	0:ac1725ba162c	98	#define SOF_ACCEPTCONN (u8_t)0x02U /* socket has had listen() */
segundo	0:ac1725ba162c	99	#define SOF_REUSEADDR (u8_t)0x04U /* allow local address reuse */
segundo	0:ac1725ba162c	100	#define SOF_KEEPALIVE (u8_t)0x08U /* keep connections alive */
segundo	0:ac1725ba162c	101	/#define SOF_DONTROUTE (u8_t)0x10U Unimplemented: just use interface addresses /
segundo	0:ac1725ba162c	102	#define SOF_BROADCAST (u8_t)0x20U /* permit to send and to receive broadcast messages (see IP_SOF_BROADCAST option) */
segundo	0:ac1725ba162c	103	/#define SOF_USELOOPBACK (u8_t)0x40U Unimplemented: bypass hardware when possible /
segundo	0:ac1725ba162c	104	#define SOF_LINGER (u8_t)0x80U /* linger on close if data present */
segundo	0:ac1725ba162c	105	/#define SOF_OOBINLINE (u16_t)0x0100U Unimplemented: leave received OOB data in line /
segundo	0:ac1725ba162c	106	/#define SOF_REUSEPORT (u16_t)0x0200U Unimplemented: allow local address & port reuse /
segundo	0:ac1725ba162c	107
segundo	0:ac1725ba162c	108	/* These flags are inherited (e.g. from a listen-pcb to a connection-pcb): */
segundo	0:ac1725ba162c	109	#define SOF_INHERITED (SOF_REUSEADDR\|SOF_KEEPALIVE\|SOF_LINGER/\|SOF_DEBUG\|SOF_DONTROUTE\|SOF_OOBINLINE/)
segundo	0:ac1725ba162c	110
segundo	0:ac1725ba162c	111
segundo	0:ac1725ba162c	112	#ifdef PACK_STRUCT_USE_INCLUDES
segundo	0:ac1725ba162c	113	# include "arch/bpstruct.h"
segundo	0:ac1725ba162c	114	#endif
segundo	0:ac1725ba162c	115	PACK_STRUCT_BEGIN
segundo	0:ac1725ba162c	116	struct ip_hdr {
segundo	0:ac1725ba162c	117	/* version / header length / type of service */
segundo	0:ac1725ba162c	118	PACK_STRUCT_FIELD(u16_t _v_hl_tos);
segundo	0:ac1725ba162c	119	/* total length */
segundo	0:ac1725ba162c	120	PACK_STRUCT_FIELD(u16_t _len);
segundo	0:ac1725ba162c	121	/* identification */
segundo	0:ac1725ba162c	122	PACK_STRUCT_FIELD(u16_t _id);
segundo	0:ac1725ba162c	123	/* fragment offset field */
segundo	0:ac1725ba162c	124	PACK_STRUCT_FIELD(u16_t _offset);
segundo	0:ac1725ba162c	125	#define IP_RF 0x8000 /* reserved fragment flag */
segundo	0:ac1725ba162c	126	#define IP_DF 0x4000 /* dont fragment flag */
segundo	0:ac1725ba162c	127	#define IP_MF 0x2000 /* more fragments flag */
segundo	0:ac1725ba162c	128	#define IP_OFFMASK 0x1fff /* mask for fragmenting bits */
segundo	0:ac1725ba162c	129	/* time to live */
segundo	0:ac1725ba162c	130	PACK_STRUCT_FIELD(u8_t _ttl);
segundo	0:ac1725ba162c	131	/* protocol*/
segundo	0:ac1725ba162c	132	PACK_STRUCT_FIELD(u8_t _proto);
segundo	0:ac1725ba162c	133	/* checksum */
segundo	0:ac1725ba162c	134	PACK_STRUCT_FIELD(u16_t _chksum);
segundo	0:ac1725ba162c	135	/* source and destination IP addresses */
segundo	0:ac1725ba162c	136	PACK_STRUCT_FIELD(ip_addr_p_t src);
segundo	0:ac1725ba162c	137	PACK_STRUCT_FIELD(ip_addr_p_t dest);
segundo	0:ac1725ba162c	138	} PACK_STRUCT_STRUCT;
segundo	0:ac1725ba162c	139	PACK_STRUCT_END
segundo	0:ac1725ba162c	140	#ifdef PACK_STRUCT_USE_INCLUDES
segundo	0:ac1725ba162c	141	# include "arch/epstruct.h"
segundo	0:ac1725ba162c	142	#endif
segundo	0:ac1725ba162c	143
segundo	0:ac1725ba162c	144	#define IPH_V(hdr) (ntohs((hdr)->_v_hl_tos) >> 12)
segundo	0:ac1725ba162c	145	#define IPH_HL(hdr) ((ntohs((hdr)->_v_hl_tos) >> 8) & 0x0f)
segundo	0:ac1725ba162c	146	#define IPH_TOS(hdr) (ntohs((hdr)->_v_hl_tos) & 0xff)
segundo	0:ac1725ba162c	147	#define IPH_LEN(hdr) ((hdr)->_len)
segundo	0:ac1725ba162c	148	#define IPH_ID(hdr) ((hdr)->_id)
segundo	0:ac1725ba162c	149	#define IPH_OFFSET(hdr) ((hdr)->_offset)
segundo	0:ac1725ba162c	150	#define IPH_TTL(hdr) ((hdr)->_ttl)
segundo	0:ac1725ba162c	151	#define IPH_PROTO(hdr) ((hdr)->_proto)
segundo	0:ac1725ba162c	152	#define IPH_CHKSUM(hdr) ((hdr)->_chksum)
segundo	0:ac1725ba162c	153
segundo	0:ac1725ba162c	154	#define IPH_VHLTOS_SET(hdr, v, hl, tos) (hdr)->_v_hl_tos = (htons(((v) << 12) \| ((hl) << 8) \| (tos)))
segundo	0:ac1725ba162c	155	#define IPH_LEN_SET(hdr, len) (hdr)->_len = (len)
segundo	0:ac1725ba162c	156	#define IPH_ID_SET(hdr, id) (hdr)->_id = (id)
segundo	0:ac1725ba162c	157	#define IPH_OFFSET_SET(hdr, off) (hdr)->_offset = (off)
segundo	0:ac1725ba162c	158	#define IPH_TTL_SET(hdr, ttl) (hdr)->_ttl = (u8_t)(ttl)
segundo	0:ac1725ba162c	159	#define IPH_PROTO_SET(hdr, proto) (hdr)->_proto = (u8_t)(proto)
segundo	0:ac1725ba162c	160	#define IPH_CHKSUM_SET(hdr, chksum) (hdr)->_chksum = (chksum)
segundo	0:ac1725ba162c	161
segundo	0:ac1725ba162c	162	/** The interface that provided the packet for the current callback invocation. */
segundo	0:ac1725ba162c	163	extern struct netif *current_netif;
segundo	0:ac1725ba162c	164	/** Header of the input packet currently being processed. */
segundo	0:ac1725ba162c	165	extern const struct ip_hdr *current_header;
segundo	0:ac1725ba162c	166	/** Source IP address of current_header */
segundo	0:ac1725ba162c	167	extern ip_addr_t current_iphdr_src;
segundo	0:ac1725ba162c	168	/** Destination IP address of current_header */
segundo	0:ac1725ba162c	169	extern ip_addr_t current_iphdr_dest;
segundo	0:ac1725ba162c	170
segundo	0:ac1725ba162c	171	#define ip_init() /* Compatibility define, not init needed. */
segundo	0:ac1725ba162c	172	struct netif ip_route(ip_addr_t dest);
segundo	0:ac1725ba162c	173	err_t ip_input(struct pbuf p, struct netif inp);
segundo	0:ac1725ba162c	174	err_t ip_output(struct pbuf p, ip_addr_t src, ip_addr_t *dest,
segundo	0:ac1725ba162c	175	u8_t ttl, u8_t tos, u8_t proto);
segundo	0:ac1725ba162c	176	err_t ip_output_if(struct pbuf p, ip_addr_t src, ip_addr_t *dest,
segundo	0:ac1725ba162c	177	u8_t ttl, u8_t tos, u8_t proto,
segundo	0:ac1725ba162c	178	struct netif *netif);
segundo	0:ac1725ba162c	179	#if LWIP_NETIF_HWADDRHINT
segundo	0:ac1725ba162c	180	err_t ip_output_hinted(struct pbuf p, ip_addr_t src, ip_addr_t *dest,
segundo	0:ac1725ba162c	181	u8_t ttl, u8_t tos, u8_t proto, u8_t *addr_hint);
segundo	0:ac1725ba162c	182	#endif /* LWIP_NETIF_HWADDRHINT */
segundo	0:ac1725ba162c	183	#if IP_OPTIONS_SEND
segundo	0:ac1725ba162c	184	err_t ip_output_if_opt(struct pbuf p, ip_addr_t src, ip_addr_t *dest,
segundo	0:ac1725ba162c	185	u8_t ttl, u8_t tos, u8_t proto, struct netif netif, void ip_options,
segundo	0:ac1725ba162c	186	u16_t optlen);
segundo	0:ac1725ba162c	187	#endif /* IP_OPTIONS_SEND */
segundo	0:ac1725ba162c	188	/** Get the interface that received the current packet.
segundo	0:ac1725ba162c	189	* This function must only be called from a receive callback (udp_recv,
segundo	0:ac1725ba162c	190	* raw_recv, tcp_accept). It will return NULL otherwise. */
segundo	0:ac1725ba162c	191	#define ip_current_netif() (current_netif)
segundo	0:ac1725ba162c	192	/** Get the IP header of the current packet.
segundo	0:ac1725ba162c	193	* This function must only be called from a receive callback (udp_recv,
segundo	0:ac1725ba162c	194	* raw_recv, tcp_accept). It will return NULL otherwise. */
segundo	0:ac1725ba162c	195	#define ip_current_header() (current_header)
segundo	0:ac1725ba162c	196	/** Source IP address of current_header */
segundo	0:ac1725ba162c	197	#define ip_current_src_addr() (&current_iphdr_src)
segundo	0:ac1725ba162c	198	/** Destination IP address of current_header */
segundo	0:ac1725ba162c	199	#define ip_current_dest_addr() (&current_iphdr_dest)
segundo	0:ac1725ba162c	200
segundo	0:ac1725ba162c	201	#if IP_DEBUG
segundo	0:ac1725ba162c	202	void ip_debug_print(struct pbuf *p);
segundo	0:ac1725ba162c	203	#else
segundo	0:ac1725ba162c	204	#define ip_debug_print(p)
segundo	0:ac1725ba162c	205	#endif /* IP_DEBUG */
segundo	0:ac1725ba162c	206
segundo	0:ac1725ba162c	207	#ifdef __cplusplus
segundo	0:ac1725ba162c	208	}
segundo	0:ac1725ba162c	209	#endif
segundo	0:ac1725ba162c	210
segundo	0:ac1725ba162c	211	#endif /* __LWIP_IP_H__ */
segundo	0:ac1725ba162c	212
segundo	0:ac1725ba162c	213

Repository toolbox

Export to desktop IDE

Repository details

Type:	Library
Created:	09 Nov 2010
Imports:	3034
Forks:	1
Commits:	8
Dependents:	42
Dependencies:	0
Followers:	27

lwip/include/ipv4/lwip/ip.h@0:ac1725ba162c, 2010-11-09 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning