Net - | Mbed

Users » mbed714 » Code » Net

lwip/include/lwip/dhcp.h@0:d616ece2d859, 2010-09-18 (annotated)

Committer:: mbed714
Date:: Sat Sep 18 23:05:49 2010 +0000
Revision:: 0:d616ece2d859

Who changed what in which revision?

User	Revision	Line number	New contents of line
mbed714	0:d616ece2d859	1	/** @file
mbed714	0:d616ece2d859	2	*/
mbed714	0:d616ece2d859	3
mbed714	0:d616ece2d859	4	#ifndef __LWIP_DHCP_H__
mbed714	0:d616ece2d859	5	#define __LWIP_DHCP_H__
mbed714	0:d616ece2d859	6
mbed714	0:d616ece2d859	7	#include "lwip/opt.h"
mbed714	0:d616ece2d859	8
mbed714	0:d616ece2d859	9	#if LWIP_DHCP /* don't build if not configured for use in lwipopts.h */
mbed714	0:d616ece2d859	10
mbed714	0:d616ece2d859	11	#include "lwip/netif.h"
mbed714	0:d616ece2d859	12	#include "lwip/udp.h"
mbed714	0:d616ece2d859	13
mbed714	0:d616ece2d859	14	#ifdef __cplusplus
mbed714	0:d616ece2d859	15	extern "C" {
mbed714	0:d616ece2d859	16	#endif
mbed714	0:d616ece2d859	17
mbed714	0:d616ece2d859	18	/** period (in seconds) of the application calling dhcp_coarse_tmr() */
mbed714	0:d616ece2d859	19	#define DHCP_COARSE_TIMER_SECS 60
mbed714	0:d616ece2d859	20	/** period (in milliseconds) of the application calling dhcp_coarse_tmr() */
mbed714	0:d616ece2d859	21	#define DHCP_COARSE_TIMER_MSECS (DHCP_COARSE_TIMER_SECS * 1000UL)
mbed714	0:d616ece2d859	22	/** period (in milliseconds) of the application calling dhcp_fine_tmr() */
mbed714	0:d616ece2d859	23	#define DHCP_FINE_TIMER_MSECS 500
mbed714	0:d616ece2d859	24
mbed714	0:d616ece2d859	25	#define DHCP_CHADDR_LEN 16U
mbed714	0:d616ece2d859	26	#define DHCP_SNAME_LEN 64U
mbed714	0:d616ece2d859	27	#define DHCP_FILE_LEN 128U
mbed714	0:d616ece2d859	28
mbed714	0:d616ece2d859	29	struct dhcp
mbed714	0:d616ece2d859	30	{
mbed714	0:d616ece2d859	31	/** transaction identifier of last sent request */
mbed714	0:d616ece2d859	32	u32_t xid;
mbed714	0:d616ece2d859	33	/** our connection to the DHCP server */
mbed714	0:d616ece2d859	34	struct udp_pcb *pcb;
mbed714	0:d616ece2d859	35	/** incoming msg */
mbed714	0:d616ece2d859	36	struct dhcp_msg *msg_in;
mbed714	0:d616ece2d859	37	/** current DHCP state machine state */
mbed714	0:d616ece2d859	38	u8_t state;
mbed714	0:d616ece2d859	39	/** retries of current request */
mbed714	0:d616ece2d859	40	u8_t tries;
mbed714	0:d616ece2d859	41	#if LWIP_DHCP_AUTOIP_COOP
mbed714	0:d616ece2d859	42	u8_t autoip_coop_state;
mbed714	0:d616ece2d859	43	#endif
mbed714	0:d616ece2d859	44	u8_t subnet_mask_given;
mbed714	0:d616ece2d859	45
mbed714	0:d616ece2d859	46	struct pbuf p_out; / pbuf of outcoming msg */
mbed714	0:d616ece2d859	47	struct dhcp_msg msg_out; / outgoing msg */
mbed714	0:d616ece2d859	48	u16_t options_out_len; /* outgoing msg options length */
mbed714	0:d616ece2d859	49	u16_t request_timeout; /* #ticks with period DHCP_FINE_TIMER_SECS for request timeout */
mbed714	0:d616ece2d859	50	u16_t t1_timeout; /* #ticks with period DHCP_COARSE_TIMER_SECS for renewal time */
mbed714	0:d616ece2d859	51	u16_t t2_timeout; /* #ticks with period DHCP_COARSE_TIMER_SECS for rebind time */
mbed714	0:d616ece2d859	52	ip_addr_t server_ip_addr; /* dhcp server address that offered this lease */
mbed714	0:d616ece2d859	53	ip_addr_t offered_ip_addr;
mbed714	0:d616ece2d859	54	ip_addr_t offered_sn_mask;
mbed714	0:d616ece2d859	55	ip_addr_t offered_gw_addr;
mbed714	0:d616ece2d859	56
mbed714	0:d616ece2d859	57	u32_t offered_t0_lease; /* lease period (in seconds) */
mbed714	0:d616ece2d859	58	u32_t offered_t1_renew; /* recommended renew time (usually 50% of lease period) */
mbed714	0:d616ece2d859	59	u32_t offered_t2_rebind; /* recommended rebind time (usually 66% of lease period) */
mbed714	0:d616ece2d859	60	/* @todo: LWIP_DHCP_BOOTP_FILE configuration option?
mbed714	0:d616ece2d859	61	integrate with possible TFTP-client for booting? */
mbed714	0:d616ece2d859	62	#if LWIP_DHCP_BOOTP_FILE
mbed714	0:d616ece2d859	63	ip_addr_t offered_si_addr;
mbed714	0:d616ece2d859	64	char boot_file_name[DHCP_FILE_LEN];
mbed714	0:d616ece2d859	65	#endif /* LWIP_DHCP_BOOTPFILE */
mbed714	0:d616ece2d859	66	};
mbed714	0:d616ece2d859	67
mbed714	0:d616ece2d859	68	/* MUST be compiled with "pack structs" or equivalent! */
mbed714	0:d616ece2d859	69	#ifdef PACK_STRUCT_USE_INCLUDES
mbed714	0:d616ece2d859	70	# include "arch/bpstruct.h"
mbed714	0:d616ece2d859	71	#endif
mbed714	0:d616ece2d859	72	PACK_STRUCT_BEGIN
mbed714	0:d616ece2d859	73	/** minimum set of fields of any DHCP message */
mbed714	0:d616ece2d859	74	struct dhcp_msg
mbed714	0:d616ece2d859	75	{
mbed714	0:d616ece2d859	76	PACK_STRUCT_FIELD(u8_t op);
mbed714	0:d616ece2d859	77	PACK_STRUCT_FIELD(u8_t htype);
mbed714	0:d616ece2d859	78	PACK_STRUCT_FIELD(u8_t hlen);
mbed714	0:d616ece2d859	79	PACK_STRUCT_FIELD(u8_t hops);
mbed714	0:d616ece2d859	80	PACK_STRUCT_FIELD(u32_t xid);
mbed714	0:d616ece2d859	81	PACK_STRUCT_FIELD(u16_t secs);
mbed714	0:d616ece2d859	82	PACK_STRUCT_FIELD(u16_t flags);
mbed714	0:d616ece2d859	83	PACK_STRUCT_FIELD(ip_addr_p_t ciaddr);
mbed714	0:d616ece2d859	84	PACK_STRUCT_FIELD(ip_addr_p_t yiaddr);
mbed714	0:d616ece2d859	85	PACK_STRUCT_FIELD(ip_addr_p_t siaddr);
mbed714	0:d616ece2d859	86	PACK_STRUCT_FIELD(ip_addr_p_t giaddr);
mbed714	0:d616ece2d859	87	PACK_STRUCT_FIELD(u8_t chaddr[DHCP_CHADDR_LEN]);
mbed714	0:d616ece2d859	88	PACK_STRUCT_FIELD(u8_t sname[DHCP_SNAME_LEN]);
mbed714	0:d616ece2d859	89	PACK_STRUCT_FIELD(u8_t file[DHCP_FILE_LEN]);
mbed714	0:d616ece2d859	90	PACK_STRUCT_FIELD(u32_t cookie);
mbed714	0:d616ece2d859	91	#define DHCP_MIN_OPTIONS_LEN 68U
mbed714	0:d616ece2d859	92	/** make sure user does not configure this too small */
mbed714	0:d616ece2d859	93	#if ((defined(DHCP_OPTIONS_LEN)) && (DHCP_OPTIONS_LEN < DHCP_MIN_OPTIONS_LEN))
mbed714	0:d616ece2d859	94	# undef DHCP_OPTIONS_LEN
mbed714	0:d616ece2d859	95	#endif
mbed714	0:d616ece2d859	96	/** allow this to be configured in lwipopts.h, but not too small */
mbed714	0:d616ece2d859	97	#if (!defined(DHCP_OPTIONS_LEN))
mbed714	0:d616ece2d859	98	/** set this to be sufficient for your options in outgoing DHCP msgs */
mbed714	0:d616ece2d859	99	# define DHCP_OPTIONS_LEN DHCP_MIN_OPTIONS_LEN
mbed714	0:d616ece2d859	100	#endif
mbed714	0:d616ece2d859	101	PACK_STRUCT_FIELD(u8_t options[DHCP_OPTIONS_LEN]);
mbed714	0:d616ece2d859	102	} PACK_STRUCT_STRUCT;
mbed714	0:d616ece2d859	103	PACK_STRUCT_END
mbed714	0:d616ece2d859	104	#ifdef PACK_STRUCT_USE_INCLUDES
mbed714	0:d616ece2d859	105	# include "arch/epstruct.h"
mbed714	0:d616ece2d859	106	#endif
mbed714	0:d616ece2d859	107
mbed714	0:d616ece2d859	108	void dhcp_set_struct(struct netif netif, struct dhcp dhcp);
mbed714	0:d616ece2d859	109	/** start DHCP configuration */
mbed714	0:d616ece2d859	110	err_t dhcp_start(struct netif *netif);
mbed714	0:d616ece2d859	111	/** enforce early lease renewal (not needed normally)*/
mbed714	0:d616ece2d859	112	err_t dhcp_renew(struct netif *netif);
mbed714	0:d616ece2d859	113	/** release the DHCP lease, usually called before dhcp_stop()*/
mbed714	0:d616ece2d859	114	err_t dhcp_release(struct netif *netif);
mbed714	0:d616ece2d859	115	/** stop DHCP configuration */
mbed714	0:d616ece2d859	116	void dhcp_stop(struct netif *netif);
mbed714	0:d616ece2d859	117	/** inform server of our manual IP address */
mbed714	0:d616ece2d859	118	void dhcp_inform(struct netif *netif);
mbed714	0:d616ece2d859	119	/** Handle a possible change in the network configuration */
mbed714	0:d616ece2d859	120	void dhcp_network_changed(struct netif *netif);
mbed714	0:d616ece2d859	121
mbed714	0:d616ece2d859	122	/** if enabled, check whether the offered IP address is not in use, using ARP */
mbed714	0:d616ece2d859	123	#if DHCP_DOES_ARP_CHECK
mbed714	0:d616ece2d859	124	void dhcp_arp_reply(struct netif netif, ip_addr_t addr);
mbed714	0:d616ece2d859	125	#endif
mbed714	0:d616ece2d859	126
mbed714	0:d616ece2d859	127	/** to be called every minute */
mbed714	0:d616ece2d859	128	void dhcp_coarse_tmr(void);
mbed714	0:d616ece2d859	129	/** to be called every half second */
mbed714	0:d616ece2d859	130	void dhcp_fine_tmr(void);
mbed714	0:d616ece2d859	131
mbed714	0:d616ece2d859	132	/** DHCP message item offsets and length */
mbed714	0:d616ece2d859	133	#define DHCP_OP_OFS 0
mbed714	0:d616ece2d859	134	#define DHCP_HTYPE_OFS 1
mbed714	0:d616ece2d859	135	#define DHCP_HLEN_OFS 2
mbed714	0:d616ece2d859	136	#define DHCP_HOPS_OFS 3
mbed714	0:d616ece2d859	137	#define DHCP_XID_OFS 4
mbed714	0:d616ece2d859	138	#define DHCP_SECS_OFS 8
mbed714	0:d616ece2d859	139	#define DHCP_FLAGS_OFS 10
mbed714	0:d616ece2d859	140	#define DHCP_CIADDR_OFS 12
mbed714	0:d616ece2d859	141	#define DHCP_YIADDR_OFS 16
mbed714	0:d616ece2d859	142	#define DHCP_SIADDR_OFS 20
mbed714	0:d616ece2d859	143	#define DHCP_GIADDR_OFS 24
mbed714	0:d616ece2d859	144	#define DHCP_CHADDR_OFS 28
mbed714	0:d616ece2d859	145	#define DHCP_SNAME_OFS 44
mbed714	0:d616ece2d859	146	#define DHCP_FILE_OFS 108
mbed714	0:d616ece2d859	147	#define DHCP_MSG_LEN 236
mbed714	0:d616ece2d859	148
mbed714	0:d616ece2d859	149	#define DHCP_COOKIE_OFS DHCP_MSG_LEN
mbed714	0:d616ece2d859	150	#define DHCP_OPTIONS_OFS (DHCP_MSG_LEN + 4)
mbed714	0:d616ece2d859	151
mbed714	0:d616ece2d859	152	#define DHCP_CLIENT_PORT 68
mbed714	0:d616ece2d859	153	#define DHCP_SERVER_PORT 67
mbed714	0:d616ece2d859	154
mbed714	0:d616ece2d859	155	/** DHCP client states */
mbed714	0:d616ece2d859	156	#define DHCP_OFF 0
mbed714	0:d616ece2d859	157	#define DHCP_REQUESTING 1
mbed714	0:d616ece2d859	158	#define DHCP_INIT 2
mbed714	0:d616ece2d859	159	#define DHCP_REBOOTING 3
mbed714	0:d616ece2d859	160	#define DHCP_REBINDING 4
mbed714	0:d616ece2d859	161	#define DHCP_RENEWING 5
mbed714	0:d616ece2d859	162	#define DHCP_SELECTING 6
mbed714	0:d616ece2d859	163	#define DHCP_INFORMING 7
mbed714	0:d616ece2d859	164	#define DHCP_CHECKING 8
mbed714	0:d616ece2d859	165	#define DHCP_PERMANENT 9
mbed714	0:d616ece2d859	166	#define DHCP_BOUND 10
mbed714	0:d616ece2d859	167	/** not yet implemented #define DHCP_RELEASING 11 */
mbed714	0:d616ece2d859	168	#define DHCP_BACKING_OFF 12
mbed714	0:d616ece2d859	169
mbed714	0:d616ece2d859	170	/** AUTOIP cooperatation flags */
mbed714	0:d616ece2d859	171	#define DHCP_AUTOIP_COOP_STATE_OFF 0
mbed714	0:d616ece2d859	172	#define DHCP_AUTOIP_COOP_STATE_ON 1
mbed714	0:d616ece2d859	173
mbed714	0:d616ece2d859	174	#define DHCP_BOOTREQUEST 1
mbed714	0:d616ece2d859	175	#define DHCP_BOOTREPLY 2
mbed714	0:d616ece2d859	176
mbed714	0:d616ece2d859	177	/** DHCP message types */
mbed714	0:d616ece2d859	178	#define DHCP_DISCOVER 1
mbed714	0:d616ece2d859	179	#define DHCP_OFFER 2
mbed714	0:d616ece2d859	180	#define DHCP_REQUEST 3
mbed714	0:d616ece2d859	181	#define DHCP_DECLINE 4
mbed714	0:d616ece2d859	182	#define DHCP_ACK 5
mbed714	0:d616ece2d859	183	#define DHCP_NAK 6
mbed714	0:d616ece2d859	184	#define DHCP_RELEASE 7
mbed714	0:d616ece2d859	185	#define DHCP_INFORM 8
mbed714	0:d616ece2d859	186
mbed714	0:d616ece2d859	187	/** DHCP hardware type, currently only ethernet is supported */
mbed714	0:d616ece2d859	188	#define DHCP_HTYPE_ETH 1
mbed714	0:d616ece2d859	189
mbed714	0:d616ece2d859	190	#define DHCP_MAGIC_COOKIE 0x63825363UL
mbed714	0:d616ece2d859	191
mbed714	0:d616ece2d859	192	/* This is a list of options for BOOTP and DHCP, see RFC 2132 for descriptions */
mbed714	0:d616ece2d859	193
mbed714	0:d616ece2d859	194	/** BootP options */
mbed714	0:d616ece2d859	195	#define DHCP_OPTION_PAD 0
mbed714	0:d616ece2d859	196	#define DHCP_OPTION_SUBNET_MASK 1 /* RFC 2132 3.3 */
mbed714	0:d616ece2d859	197	#define DHCP_OPTION_ROUTER 3
mbed714	0:d616ece2d859	198	#define DHCP_OPTION_DNS_SERVER 6
mbed714	0:d616ece2d859	199	#define DHCP_OPTION_HOSTNAME 12
mbed714	0:d616ece2d859	200	#define DHCP_OPTION_IP_TTL 23
mbed714	0:d616ece2d859	201	#define DHCP_OPTION_MTU 26
mbed714	0:d616ece2d859	202	#define DHCP_OPTION_BROADCAST 28
mbed714	0:d616ece2d859	203	#define DHCP_OPTION_TCP_TTL 37
mbed714	0:d616ece2d859	204	#define DHCP_OPTION_END 255
mbed714	0:d616ece2d859	205
mbed714	0:d616ece2d859	206	/** DHCP options */
mbed714	0:d616ece2d859	207	#define DHCP_OPTION_REQUESTED_IP 50 /* RFC 2132 9.1, requested IP address */
mbed714	0:d616ece2d859	208	#define DHCP_OPTION_LEASE_TIME 51 /* RFC 2132 9.2, time in seconds, in 4 bytes */
mbed714	0:d616ece2d859	209	#define DHCP_OPTION_OVERLOAD 52 /* RFC2132 9.3, use file and/or sname field for options */
mbed714	0:d616ece2d859	210
mbed714	0:d616ece2d859	211	#define DHCP_OPTION_MESSAGE_TYPE 53 /* RFC 2132 9.6, important for DHCP */
mbed714	0:d616ece2d859	212	#define DHCP_OPTION_MESSAGE_TYPE_LEN 1
mbed714	0:d616ece2d859	213
mbed714	0:d616ece2d859	214	#define DHCP_OPTION_SERVER_ID 54 /* RFC 2132 9.7, server IP address */
mbed714	0:d616ece2d859	215	#define DHCP_OPTION_PARAMETER_REQUEST_LIST 55 /* RFC 2132 9.8, requested option types */
mbed714	0:d616ece2d859	216
mbed714	0:d616ece2d859	217	#define DHCP_OPTION_MAX_MSG_SIZE 57 /* RFC 2132 9.10, message size accepted >= 576 */
mbed714	0:d616ece2d859	218	#define DHCP_OPTION_MAX_MSG_SIZE_LEN 2
mbed714	0:d616ece2d859	219
mbed714	0:d616ece2d859	220	#define DHCP_OPTION_T1 58 /* T1 renewal time */
mbed714	0:d616ece2d859	221	#define DHCP_OPTION_T2 59 /* T2 rebinding time */
mbed714	0:d616ece2d859	222	#define DHCP_OPTION_US 60
mbed714	0:d616ece2d859	223	#define DHCP_OPTION_CLIENT_ID 61
mbed714	0:d616ece2d859	224	#define DHCP_OPTION_TFTP_SERVERNAME 66
mbed714	0:d616ece2d859	225	#define DHCP_OPTION_BOOTFILE 67
mbed714	0:d616ece2d859	226
mbed714	0:d616ece2d859	227	/** possible combinations of overloading the file and sname fields with options */
mbed714	0:d616ece2d859	228	#define DHCP_OVERLOAD_NONE 0
mbed714	0:d616ece2d859	229	#define DHCP_OVERLOAD_FILE 1
mbed714	0:d616ece2d859	230	#define DHCP_OVERLOAD_SNAME 2
mbed714	0:d616ece2d859	231	#define DHCP_OVERLOAD_SNAME_FILE 3
mbed714	0:d616ece2d859	232
mbed714	0:d616ece2d859	233	#ifdef __cplusplus
mbed714	0:d616ece2d859	234	}
mbed714	0:d616ece2d859	235	#endif
mbed714	0:d616ece2d859	236
mbed714	0:d616ece2d859	237	#endif /* LWIP_DHCP */
mbed714	0:d616ece2d859	238
mbed714	0:d616ece2d859	239	#endif /__LWIP_DHCP_H__/

Repository toolbox

Export to desktop IDE

Repository details

Type:	Library
Created:	18 Sep 2010
Imports:	1
Forks:	0
Commits:	1
Dependents:	0
Dependencies:	0
Followers:	1

This repository is Public (Unlisted).

lwip/include/lwip/dhcp.h@0:d616ece2d859, 2010-09-18 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning