source: arduino-1-6-7/trunk/fuentes/arduino-ide-amd64/hardware/arduino/avr/firmwares/wifishield/wifiHD/src/SOFTWARE_FRAMEWORK/SERVICES/LWIP/lwip-1.3.2/src/include/lwip/dhcp.h @ 4837

Last change on this file since 4837 was 4837, checked in by daduve, 2 years ago

Adding new version

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