[retry] Added configurable timeouts to retry timer
[people/mcb30/gpxe.git] / src / include / gpxe / dhcp.h
1 #ifndef _GPXE_DHCP_H
2 #define _GPXE_DHCP_H
3
4 /** @file
5  *
6  * Dynamic Host Configuration Protocol
7  *
8  */
9
10 #include <stdint.h>
11 #include <gpxe/in.h>
12 #include <gpxe/list.h>
13 #include <gpxe/refcnt.h>
14 #include <gpxe/tables.h>
15
16 struct net_device;
17 struct job_interface;
18 struct dhcp_options;
19 struct dhcp_packet;
20
21 /** BOOTP/DHCP server port */
22 #define BOOTPS_PORT 67
23
24 /** BOOTP/DHCP client port */
25 #define BOOTPC_PORT 68
26
27 /** ProxyDHCP server port */
28 #define PROXYDHCP_PORT 4011
29
30 /** Construct a tag value for an encapsulated option
31  *
32  * This tag value can be passed to Etherboot functions when searching
33  * for DHCP options in order to search for a tag within an
34  * encapsulated options block.
35  */
36 #define DHCP_ENCAP_OPT( encapsulator, encapsulated ) \
37         ( ( (encapsulator) << 8 ) | (encapsulated) )
38 /** Extract encapsulating option block tag from encapsulated tag value */
39 #define DHCP_ENCAPSULATOR( encap_opt ) ( (encap_opt) >> 8 )
40 /** Extract encapsulated option tag from encapsulated tag value */
41 #define DHCP_ENCAPSULATED( encap_opt ) ( (encap_opt) & 0xff )
42 /** Option is encapsulated */
43 #define DHCP_IS_ENCAP_OPT( opt ) DHCP_ENCAPSULATOR( opt )
44
45 /**
46  * @defgroup dhcpopts DHCP option tags
47  * @{
48  */
49
50 /** Padding
51  *
52  * This tag does not have a length field; it is always only a single
53  * byte in length.
54  */
55 #define DHCP_PAD 0
56
57 /** Minimum normal DHCP option */
58 #define DHCP_MIN_OPTION 1
59
60 /** Subnet mask */
61 #define DHCP_SUBNET_MASK 1
62
63 /** Routers */
64 #define DHCP_ROUTERS 3
65
66 /** DNS servers */
67 #define DHCP_DNS_SERVERS 6
68
69 /** Syslog servers */
70 #define DHCP_LOG_SERVERS 7
71
72 /** Host name */
73 #define DHCP_HOST_NAME 12
74
75 /** Domain name */
76 #define DHCP_DOMAIN_NAME 15
77
78 /** Root path */
79 #define DHCP_ROOT_PATH 17
80
81 /** Vendor encapsulated options */
82 #define DHCP_VENDOR_ENCAP 43
83
84 /** Requested IP address */
85 #define DHCP_REQUESTED_ADDRESS 50
86
87 /** Lease time */
88 #define DHCP_LEASE_TIME 51
89
90 /** Option overloading
91  *
92  * The value of this option is the bitwise-OR of zero or more
93  * DHCP_OPTION_OVERLOAD_XXX constants.
94  */
95 #define DHCP_OPTION_OVERLOAD 52
96
97 /** The "file" field is overloaded to contain extra DHCP options */
98 #define DHCP_OPTION_OVERLOAD_FILE 1
99
100 /** The "sname" field is overloaded to contain extra DHCP options */
101 #define DHCP_OPTION_OVERLOAD_SNAME 2
102
103 /** DHCP message type */
104 #define DHCP_MESSAGE_TYPE 53
105 #define DHCPDISCOVER 1
106 #define DHCPOFFER 2
107 #define DHCPREQUEST 3
108 #define DHCPDECLINE 4
109 #define DHCPACK 5
110 #define DHCPNAK 6
111 #define DHCPRELEASE 7
112 #define DHCPINFORM 8
113
114 /** DHCP server identifier */
115 #define DHCP_SERVER_IDENTIFIER 54
116
117 /** Parameter request list */
118 #define DHCP_PARAMETER_REQUEST_LIST 55
119
120 /** Maximum DHCP message size */
121 #define DHCP_MAX_MESSAGE_SIZE 57
122
123 /** Vendor class identifier */
124 #define DHCP_VENDOR_CLASS_ID 60
125
126 /** Client identifier */
127 #define DHCP_CLIENT_ID 61
128
129 /** TFTP server name
130  *
131  * This option replaces the fixed "sname" field, when that field is
132  * used to contain overloaded options.
133  */
134 #define DHCP_TFTP_SERVER_NAME 66
135
136 /** Bootfile name
137  *
138  * This option replaces the fixed "file" field, when that field is
139  * used to contain overloaded options.
140  */
141 #define DHCP_BOOTFILE_NAME 67
142
143 /** Client system architecture */
144 #define DHCP_CLIENT_ARCHITECTURE 93
145
146 /** Client network device interface */
147 #define DHCP_CLIENT_NDI 94
148
149 /** UUID client identifier */
150 #define DHCP_CLIENT_UUID 97
151
152 /** Etherboot-specific encapsulated options
153  *
154  * This encapsulated options field is used to contain all options
155  * specific to Etherboot (i.e. not assigned by IANA or other standards
156  * bodies).
157  */
158 #define DHCP_EB_ENCAP 175
159
160 /** Priority of this options block
161  *
162  * This is a signed 8-bit integer field indicating the priority of
163  * this block of options.  It can be used to specify the relative
164  * priority of multiple option blocks (e.g. options from non-volatile
165  * storage versus options from a DHCP server).
166  */
167 #define DHCP_EB_PRIORITY DHCP_ENCAP_OPT ( DHCP_EB_ENCAP, 0x01 )
168
169 /** "Your" IP address
170  *
171  * This option is used internally to contain the value of the "yiaddr"
172  * field, in order to provide a consistent approach to storing and
173  * processing options.  It should never be present in a DHCP packet.
174  */
175 #define DHCP_EB_YIADDR DHCP_ENCAP_OPT ( DHCP_EB_ENCAP, 0x02 )
176
177 /** "Server" IP address
178  *
179  * This option is used internally to contain the value of the "siaddr"
180  * field, in order to provide a consistent approach to storing and
181  * processing options.  It should never be present in a DHCP packet.
182  */
183 #define DHCP_EB_SIADDR DHCP_ENCAP_OPT ( DHCP_EB_ENCAP, 0x03 )
184
185 /** Keep SAN drive registered
186  *
187  * If set to a non-zero value, gPXE will not detach any SAN drive
188  * after failing to boot from it.  (This option is required in order
189  * to perform a Windows Server 2008 installation direct to an iSCSI
190  * target.)
191  */
192 #define DHCP_EB_KEEP_SAN DHCP_ENCAP_OPT ( DHCP_EB_ENCAP, 0x08 )
193
194 /*
195  * Tags in the range 0x10-0x7f are reserved for feature markers
196  *
197  */
198
199 /** Ignore ProxyDHCP
200  *
201  * If set to a non-zero value, gPXE will not wait for ProxyDHCP offers
202  * and will ignore any ProxyDHCP offers that it receives.
203  */
204 #define DHCP_EB_NO_PROXYDHCP DHCP_ENCAP_OPT ( DHCP_EB_ENCAP, 0xb0 )
205
206 /** Network device descriptor
207  *
208  * Byte 0 is the bus type ID; remaining bytes depend on the bus type.
209  *
210  * PCI devices:
211  * Byte 0 : 1 (PCI)
212  * Byte 1 : PCI vendor ID MSB
213  * Byte 2 : PCI vendor ID LSB
214  * Byte 3 : PCI device ID MSB
215  * Byte 4 : PCI device ID LSB
216  */
217 #define DHCP_EB_BUS_ID DHCP_ENCAP_OPT ( DHCP_EB_ENCAP, 0xb1 )
218
219 /** BIOS drive number
220  *
221  * This is the drive number for a drive emulated via INT 13.  0x80 is
222  * the first hard disk, 0x81 is the second hard disk, etc.
223  */
224 #define DHCP_EB_BIOS_DRIVE DHCP_ENCAP_OPT ( DHCP_EB_ENCAP, 0xbd )
225
226 /** Username
227  *
228  * This will be used as the username for any required authentication.
229  * It is expected that this option's value will be held in
230  * non-volatile storage, rather than transmitted as part of a DHCP
231  * packet.
232  */
233 #define DHCP_EB_USERNAME DHCP_ENCAP_OPT ( DHCP_EB_ENCAP, 0xbe )
234
235 /** Password
236  *
237  * This will be used as the password for any required authentication.
238  * It is expected that this option's value will be held in
239  * non-volatile storage, rather than transmitted as part of a DHCP
240  * packet.
241  */
242 #define DHCP_EB_PASSWORD DHCP_ENCAP_OPT ( DHCP_EB_ENCAP, 0xbf )
243
244 /** Reverse username
245  *
246  * This will be used as the reverse username (i.e. the username
247  * provided by the server) for any required authentication.  It is
248  * expected that this option's value will be held in non-volatile
249  * storage, rather than transmitted as part of a DHCP packet.
250  */
251 #define DHCP_EB_REVERSE_USERNAME DHCP_ENCAP_OPT ( DHCP_EB_ENCAP, 0xc0 )
252
253 /** Reverse password
254  *
255  * This will be used as the reverse password (i.e. the password
256  * provided by the server) for any required authentication.  It is
257  * expected that this option's value will be held in non-volatile
258  * storage, rather than transmitted as part of a DHCP packet.
259  */
260 #define DHCP_EB_REVERSE_PASSWORD DHCP_ENCAP_OPT ( DHCP_EB_ENCAP, 0xc1 )
261
262 /** iSCSI primary target IQN */
263 #define DHCP_ISCSI_PRIMARY_TARGET_IQN 201
264
265 /** iSCSI secondary target IQN */
266 #define DHCP_ISCSI_SECONDARY_TARGET_IQN 202
267
268 /** iSCSI initiator IQN */
269 #define DHCP_ISCSI_INITIATOR_IQN 203
270
271 /** Maximum normal DHCP option */
272 #define DHCP_MAX_OPTION 254
273
274 /** End of options
275  *
276  * This tag does not have a length field; it is always only a single
277  * byte in length.
278  */
279 #define DHCP_END 255
280
281 /** @} */
282
283 /**
284  * Count number of arguments to a variadic macro
285  *
286  * This rather neat, non-iterative solution is courtesy of Laurent
287  * Deniau.
288  *
289  */
290 #define _VA_ARG_COUNT(  _1,  _2,  _3,  _4,  _5,  _6,  _7,  _8,          \
291                         _9, _10, _11, _12, _13, _14, _15, _16,          \
292                        _17, _18, _19, _20, _21, _22, _23, _24,          \
293                        _25, _26, _27, _28, _29, _30, _31, _32,          \
294                        _33, _34, _35, _36, _37, _38, _39, _40,          \
295                        _41, _42, _43, _44, _45, _46, _47, _48,          \
296                        _49, _50, _51, _52, _53, _54, _55, _56,          \
297                        _57, _58, _59, _60, _61, _62, _63,   N, ... ) N
298 #define VA_ARG_COUNT( ... )                                             \
299         _VA_ARG_COUNT ( __VA_ARGS__,                                    \
300                         63, 62, 61, 60, 59, 58, 57, 56,                 \
301                         55, 54, 53, 52, 51, 50, 49, 48,                 \
302                         47, 46, 45, 44, 43, 42, 41, 40,                 \
303                         39, 38, 37, 36, 35, 34, 33, 32,                 \
304                         31, 30, 29, 28, 27, 26, 25, 24,                 \
305                         23, 22, 21, 20, 19, 18, 17, 16,                 \
306                         15, 14, 13, 12, 11, 10,  9,  8,                 \
307                          7,  6,  5,  4,  3,  2,  1,  0 )
308
309 /** Construct a DHCP option from a list of bytes */
310 #define DHCP_OPTION( ... ) VA_ARG_COUNT ( __VA_ARGS__ ), __VA_ARGS__
311
312 /** Construct a DHCP option from a list of characters */
313 #define DHCP_STRING( ... ) DHCP_OPTION ( __VA_ARGS__ )
314
315 /** Construct a byte-valued DHCP option */
316 #define DHCP_BYTE( value ) DHCP_OPTION ( value )
317
318 /** Construct a word-valued DHCP option */
319 #define DHCP_WORD( value ) DHCP_OPTION ( ( ( (value) >> 8 ) & 0xff ),   \
320                                          ( ( (value) >> 0 ) & 0xff ) )
321
322 /** Construct a dword-valued DHCP option */
323 #define DHCP_DWORD( value ) DHCP_OPTION ( ( ( (value) >> 24 ) & 0xff ), \
324                                           ( ( (value) >> 16 ) & 0xff ), \
325                                           ( ( (value) >> 8  ) & 0xff ), \
326                                           ( ( (value) >> 0  ) & 0xff ) )
327
328 /** Construct a DHCP encapsulated options field */
329 #define DHCP_ENCAP( ... ) DHCP_OPTION ( __VA_ARGS__, DHCP_END )
330
331 /**
332  * A DHCP option
333  *
334  * DHCP options consist of a mandatory tag, a length field that is
335  * mandatory for all options except @c DHCP_PAD and @c DHCP_END, and a
336  * payload.  
337  */
338 struct dhcp_option {
339         /** Tag
340          *
341          * Must be a @c DHCP_XXX value.
342          */
343         uint8_t tag;
344         /** Length
345          *
346          * This is the length of the data field (i.e. excluding the
347          * tag and length fields).  For the two tags @c DHCP_PAD and
348          * @c DHCP_END, the length field is implicitly zero and is
349          * also missing, i.e. these DHCP options are only a single
350          * byte in length.
351          */
352         uint8_t len;
353         /** Option data */
354         uint8_t data[0];
355 } __attribute__ (( packed ));
356
357 /**
358  * Length of a DHCP option header
359  *
360  * The header is the portion excluding the data, i.e. the tag and the
361  * length.
362  */
363 #define DHCP_OPTION_HEADER_LEN ( offsetof ( struct dhcp_option, data ) )
364
365 /** Maximum length for a single DHCP option */
366 #define DHCP_MAX_LEN 0xff
367
368 /**
369  * A DHCP header
370  *
371  */
372 struct dhcphdr {
373         /** Operation
374          *
375          * This must be either @c BOOTP_REQUEST or @c BOOTP_REPLY.
376          */
377         uint8_t op;
378         /** Hardware address type
379          *
380          * This is an ARPHRD_XXX constant.  Note that ARPHRD_XXX
381          * constants are nominally 16 bits wide; this could be
382          * considered to be a bug in the BOOTP/DHCP specification.
383          */
384         uint8_t htype;
385         /** Hardware address length */
386         uint8_t hlen;
387         /** Number of hops from server */
388         uint8_t hops;
389         /** Transaction ID */
390         uint32_t xid;
391         /** Seconds since start of acquisition */
392         uint16_t secs;
393         /** Flags */
394         uint16_t flags;
395         /** "Client" IP address
396          *
397          * This is filled in if the client already has an IP address
398          * assigned and can respond to ARP requests.
399          */
400         struct in_addr ciaddr;
401         /** "Your" IP address
402          *
403          * This is the IP address assigned by the server to the client.
404          */
405         struct in_addr yiaddr;
406         /** "Server" IP address
407          *
408          * This is the IP address of the next server to be used in the
409          * boot process.
410          */
411         struct in_addr siaddr;
412         /** "Gateway" IP address
413          *
414          * This is the IP address of the DHCP relay agent, if any.
415          */
416         struct in_addr giaddr;
417         /** Client hardware address */
418         uint8_t chaddr[16];
419         /** Server host name (null terminated)
420          *
421          * This field may be overridden and contain DHCP options
422          */
423         char sname[64];
424         /** Boot file name (null terminated)
425          *
426          * This field may be overridden and contain DHCP options
427          */
428         char file[128];
429         /** DHCP magic cookie
430          *
431          * Must have the value @c DHCP_MAGIC_COOKIE.
432          */
433         uint32_t magic;
434         /** DHCP options
435          *
436          * Variable length; extends to the end of the packet.  Minimum
437          * length (for the sake of sanity) is 1, to allow for a single
438          * @c DHCP_END tag.
439          */
440         uint8_t options[0];
441 };
442
443 /** Opcode for a request from client to server */
444 #define BOOTP_REQUEST 1
445
446 /** Opcode for a reply from server to client */
447 #define BOOTP_REPLY 2
448
449 /** BOOTP reply must be broadcast
450  *
451  * Clients that cannot accept unicast BOOTP replies must set this
452  * flag.
453  */
454 #define BOOTP_FL_BROADCAST 0x8000
455
456 /** DHCP magic cookie */
457 #define DHCP_MAGIC_COOKIE 0x63825363UL
458
459 /** DHCP minimum packet length
460  *
461  * This is the mandated minimum packet length that a DHCP participant
462  * must be prepared to receive.
463  */
464 #define DHCP_MIN_LEN 552
465
466 /** Maximum time that we will wait for ProxyDHCP responses */
467 #define PROXYDHCP_WAIT_TIME ( TICKS_PER_SEC * 1 )
468
469 /** Timeouts for sending DHCP packets */
470 #define DHCP_MIN_TIMEOUT ( 1 * TICKS_PER_SEC )
471 #define DHCP_MAX_TIMEOUT ( 10 * TICKS_PER_SEC )
472
473 /** Settings block name used for DHCP responses */
474 #define DHCP_SETTINGS_NAME "dhcp"
475
476 /** Settings block name used for ProxyDHCP responses */
477 #define PROXYDHCP_SETTINGS_NAME "proxydhcp"
478
479 extern int dhcp_create_packet ( struct dhcp_packet *dhcppkt,
480                                 struct net_device *netdev, uint8_t msgtype,
481                                 struct dhcp_options *options, 
482                                 void *data, size_t max_len );
483 extern int dhcp_create_request ( struct dhcp_packet *dhcppkt,
484                                  struct net_device *netdev,
485                                  struct in_addr ciaddr,
486                                  struct dhcp_packet *dhcpoffer,
487                                  void *data, size_t max_len );
488 extern int start_dhcp ( struct job_interface *job, struct net_device *netdev );
489
490 #endif /* _GPXE_DHCP_H */