]> git.proxmox.com Git - mirror_edk2.git/blob - EdkModulePkg/Universal/Network/PxeBc/Dxe/dhcp.h
projects / mirror_edk2.git / blob
? search:


102d30b8c0415031a6ff4eae4362dbf418dc553f
[mirror_edk2.git] / EdkModulePkg / Universal / Network / PxeBc / Dxe / dhcp.h
1 /*++
2
3 Copyright (c) 2006, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
8
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
11
12 --*/
13
14 #ifndef _DHCP_H
15 #define _DHCP_H
16
17 //
18 // Definitions for DHCP version 4 UDP packet.
19 // The field names in this structure are defined and described in RFC 2131.
20 //
21 #pragma pack(1)
22
23 typedef struct {
24 UINT8 op;
25 #define BOOTP_REQUEST 1
26 #define BOOTP_REPLY 2
27
28 UINT8 htype;
29 UINT8 hlen;
30 UINT8 hops;
31 UINT32 xid;
32 UINT16 secs;
33 UINT16 flags;
34 #define DHCP_BROADCAST_FLAG 0x8000
35
36 UINT32 ciaddr;
37 UINT32 yiaddr;
38 UINT32 siaddr;
39 UINT32 giaddr;
40 UINT8 chaddr[16];
41 UINT8 sname[64];
42 UINT8 file[128];
43 UINT8 options[312];
44 #define OP_PAD 0
45 #define OP_END 255
46 #define OP_SUBNET_MASK 1
47 #define OP_TIME_OFFSET 2
48 #define OP_ROUTER_LIST 3
49 #define OP_TIME_SERVERS 4
50 #define OP_NAME_SERVERS 5
51 #define OP_DNS_SERVERS 6
52 #define OP_LOG_SERVERS 7
53 #define OP_COOKIE_SERVERS 8
54 #define OP_LPR_SREVERS 9
55 #define OP_IMPRESS_SERVERS 10
56 #define OP_RES_LOC_SERVERS 11
57 #define OP_HOST_NAME 12
58 #define OP_BOOT_FILE_SZ 13
59 #define OP_DUMP_FILE 14
60 #define OP_DOMAIN_NAME 15
61 #define OP_SWAP_SERVER 16
62 #define OP_ROOT_PATH 17
63 #define OP_EXTENSION_PATH 18
64 #define OP_IP_FORWARDING 19
65 #define OP_NON_LOCAL_SRC_RTE 20
66 #define OP_POLICY_FILTER 21
67 #define OP_MAX_DATAGRAM_SZ 22
68 #define OP_DEFAULT_TTL 23
69 #define OP_MTU_AGING_TIMEOUT 24
70 #define OP_MTU_SIZES 25
71 #define OP_MTU_TO_USE 26
72 #define OP_ALL_SUBNETS_LOCAL 27
73 #define OP_BROADCAST_ADD 28
74 #define OP_PERFORM_MASK_DISCOVERY 29
75 #define OP_RESPOND_TO_MASK_REQ 30
76 #define OP_PERFORM_ROUTER_DISCOVERY 31
77 #define OP_ROUTER_SOLICIT_ADDRESS 32
78 #define OP_STATIC_ROUTER_LIST 33
79 #define OP_USE_ARP_TRAILERS 34
80 #define OP_ARP_CACHE_TIMEOUT 35
81 #define OP_ETHERNET_ENCAPSULATION 36
82 #define OP_TCP_DEFAULT_TTL 37
83 #define OP_TCP_KEEP_ALIVE_INT 38
84 #define OP_KEEP_ALIVE_GARBAGE 39
85 #define OP_NIS_DOMAIN_NAME 40
86 #define OP_NIS_SERVERS 41
87 #define OP_NTP_SERVERS 42
88 #define OP_VENDOR_SPECIFIC 43
89 #define VEND_PXE_MTFTP_IP 1
90 #define VEND_PXE_MTFTP_CPORT 2
91 #define VEND_PXE_MTFTP_SPORT 3
92 #define VEND_PXE_MTFTP_TMOUT 4
93 #define VEND_PXE_MTFTP_DELAY 5
94 #define VEND_PXE_DISCOVERY_CONTROL 6
95 #define VEND_PXE_DISCOVERY_MCAST_ADDR 7
96 #define VEND_PXE_BOOT_SERVERS 8
97 #define VEND_PXE_BOOT_MENU 9
98 #define VEND_PXE_BOOT_PROMPT 10
99 #define VEND_PXE_MCAST_ADDRS_ALLOC 11
100 #define VEND_PXE_CREDENTIAL_TYPES 12
101 #define VEND_PXE_BOOT_ITEM 71
102 #define OP_NBNS_SERVERS 44
103 #define OP_NBDD_SERVERS 45
104 #define OP_NETBIOS_NODE_TYPE 46
105 #define OP_NETBIOS_SCOPE 47
106 #define OP_XWINDOW_SYSTEM_FONT_SERVERS 48
107 #define OP_XWINDOW_SYSTEM_DISPLAY_MANAGERS 49
108 #define OP_DHCP_REQ_IP_ADD 50
109 #define OP_DHCP_LEASE_TIME 51
110 #define OP_DHCP_OPTION_OVERLOAD 52
111 #define OVLD_FILE 1
112 #define OVLD_SRVR_NAME 2
113 #define OP_DHCP_MESSAGE_TYPE 53
114 #define DHCPDISCOVER 1
115 #define DHCPOFFER 2
116 #define DHCPREQUEST 3
117 #define DHCPDECLINE 4
118 #define DHCPACK 5
119 #define DHCPNAK 6
120 #define DHCPRELEASE 7
121 #define DHCPINFORM 8
122 #define OP_DHCP_SERVER_IP 54
123 #define OP_DHCP_PARM_REQ_LIST 55
124 #define OP_DHCP_ERROR_MESSAGE 56
125 #define OP_DHCP_MAX_MESSAGE_SZ 57
126 #define OP_DHCP_RENEWAL_TIME 58
127 #define OP_DHCP_REBINDING_TIME 59
128 #define OP_DHCP_CLASS_IDENTIFIER 60
129 #define OP_DHCP_CLIENT_IDENTIFIER 61
130 #define OP_NISPLUS_DOMAIN_NAME 64
131 #define OP_NISPLUS_SERVERS 65
132 #define OP_DHCP_TFTP_SERVER_NAME 66
133 #define OP_DHCP_BOOTFILE 67
134 #define OP_MOBILE_IP_HOME_AGENTS 68
135 #define OP_SMPT_SERVERS 69
136 #define OP_POP3_SERVERS 70
137 #define OP_NNTP_SERVERS 71
138 #define OP_WWW_SERVERS 72
139 #define OP_FINGER_SERVERS 73
140 #define OP_IRC_SERVERS 74
141 #define OP_STREET_TALK_SERVERS 75
142 #define OP_STREET_TALK_DIR_ASSIST_SERVERS 76
143 #define OP_NDS_SERVERS 85
144 #define OP_NDS_TREE_NAME 86
145 #define OP_NDS_CONTEXT 87
146 #define OP_DHCP_SYSTEM_ARCH 93
147 #define OP_DHCP_NETWORK_ARCH 94
148 #define OP_DHCP_PLATFORM_ID 97
149 } DHCPV4_STRUCT;
150
151 //
152 // DHCPv4 option header
153 //
154 typedef struct {
155 UINT8 OpCode;
156 UINT8 Length;
157 //
158 // followed by Data[]
159 //
160 } DHCPV4_OP_HEADER;
161
162 //
163 // Generic DHCPv4 option (header followed by data)
164 //
165 typedef struct {
166 DHCPV4_OP_HEADER Header;
167 UINT8 Data[1];
168 } DHCPV4_OP_STRUCT;
169
170 //
171 // Maximum DHCP packet size on ethernet
172 //
173 #define MAX_DHCP_MSG_SZ (MAX_ENET_DATA_SIZE - sizeof (IPV4_HEADER) - sizeof (UDPV4_HEADER))
174
175 //
176 // Macros used in pxe_bc_dhcp.c and pxe_loadfile.c
177 //
178 #define DHCPV4_TRANSMIT_BUFFER (*(DHCPV4_STRUCT *) (Private->TransmitBuffer))
179 #define DHCPV4_OPTIONS_BUFFER (*(struct optionsstr *) DHCPV4_TRANSMIT_BUFFER.options)
180
181 #define DHCPV4_ACK_INDEX 0
182 #define PXE_BINL_INDEX 1
183 #define PXE_OFFER_INDEX 1
184 #define PXE_ACK_INDEX 2
185 #define PXE_BIS_INDEX 3
186
187 #define DHCPV4_ACK_BUFFER ((struct DhcpReceiveBufferStruct *) Private->DhcpPacketBuffer)[DHCPV4_ACK_INDEX]
188 #define PXE_BINL_BUFFER ((struct DhcpReceiveBufferStruct *) Private->DhcpPacketBuffer)[PXE_BINL_INDEX]
189 #define PXE_OFFER_BUFFER ((struct DhcpReceiveBufferStruct *) Private->DhcpPacketBuffer)[PXE_OFFER_INDEX]
190 #define PXE_ACK_BUFFER ((struct DhcpReceiveBufferStruct *) Private->DhcpPacketBuffer)[PXE_ACK_INDEX]
191 #define PXE_BIS_BUFFER ((struct DhcpReceiveBufferStruct *) Private->DhcpPacketBuffer)[PXE_BIS_INDEX]
192
193 #define DHCPV4_ACK_PACKET DHCPV4_ACK_BUFFER.u.Dhcpv4
194 #define PXE_BINL_PACKET PXE_BINL_BUFFER.u.Dhcpv4
195 #define PXE_OFFER_PACKET PXE_OFFER_BUFFER.u.Dhcpv4
196 #define PXE_ACK_PACKET PXE_ACK_BUFFER.u.Dhcpv4
197 #define PXE_BIS_PACKET PXE_BIS_BUFFER.u.Dhcpv4
198
199 //
200 // network structure definitions
201 //
202 //
203 // some option definitions
204 //
205 #define DHCPV4_OPTION_LENGTH(type) (sizeof (type) - sizeof (DHCPV4_OP_HEADER))
206
207 typedef struct {
208 DHCPV4_OP_HEADER Header;
209 UINT8 Type;
210 } DHCPV4_OP_MESSAGE_TYPE;
211
212 typedef struct {
213 DHCPV4_OP_HEADER Header;
214 UINT8 Overload;
215 } DHCPV4_OP_OVERLOAD;
216
217 //
218 // boot server list structure
219 // one or more contained in a pxe boot servers structure
220 //
221 typedef struct {
222 UINT8 IpCount;
223 EFI_IPv4_ADDRESS IpList[1]; // IP count of IPs
224 } PXEV4_SERVER_LIST;
225
226 typedef struct {
227 UINT8 IpCount;
228 EFI_IPv6_ADDRESS IpList[1]; // IP count of IPs
229 } PXEV6_SERVER_LIST;
230
231 typedef union {
232 PXEV4_SERVER_LIST Ipv4List;
233 PXEV6_SERVER_LIST Ipv6List;
234 } PXE_SERVER_LISTS;
235
236 typedef struct {
237 UINT16 Type;
238 PXE_SERVER_LISTS u;
239 } PXE_SERVER_LIST;
240
241 //
242 // pxe boot servers structure
243 //
244 typedef struct {
245 DHCPV4_OP_HEADER Header;
246 PXE_SERVER_LIST ServerList[1]; // one or more
247 } PXE_OP_SERVER_LIST;
248
249 //
250 // pxe boot item structure
251 //
252 typedef struct {
253 DHCPV4_OP_HEADER Header;
254 UINT16 Type;
255 UINT16 Layer;
256 } PXE_OP_BOOT_ITEM;
257
258 //
259 // pxe boot menu item structure
260 //
261 typedef struct {
262 UINT16 Type;
263 UINT8 DataLen;
264 UINT8 Data[1];
265 } PXE_BOOT_MENU_ENTRY;
266
267 //
268 // pxe boot menu structure
269 //
270 typedef struct {
271 DHCPV4_OP_HEADER Header;
272 PXE_BOOT_MENU_ENTRY MenuItem[1];
273 } PXE_OP_BOOT_MENU;
274
275 //
276 // pxe boot prompt structure
277 //
278 typedef struct {
279 DHCPV4_OP_HEADER Header;
280 UINT8 Timeout;
281 UINT8 Prompt[1];
282 } PXE_OP_BOOT_PROMPT;
283
284 #define PXE_BOOT_PROMPT_AUTO_SELECT 0
285 #define PXE_BOOT_PROMPT_NO_TIMEOUT 255
286
287 typedef struct {
288 DHCPV4_OP_HEADER Header;
289 UINT8 Class[1];
290 } DHCPV4_OP_CLASS;
291
292 typedef struct {
293 DHCPV4_OP_HEADER Header;
294 UINT8 File[1];
295 } DHCPV4_OP_BOOTFILE;
296
297 typedef struct {
298 DHCPV4_OP_HEADER Header;
299 UINT8 VendorOptions[1];
300 } DHCPV4_OP_VENDOR_OPTIONS;
301
302 typedef struct {
303 DHCPV4_OP_HEADER Header;
304 UINT8 MaxSize[2];
305 } DHCPV4_OP_MAX_MESSAGE_SIZE;
306
307 typedef struct {
308 UINT8 _OP_SUBNET_MASK; /* 1 */
309 UINT8 _OP_TIME_OFFSET; /* 2 */
310 UINT8 _OP_ROUTER_LIST; /* 3 */
311 UINT8 _OP_TIME_SERVERS; /* 4 */
312 UINT8 _OP_NAME_SERVERS; /* 5 */
313 UINT8 _OP_DNS_SERVERS; /* 6 */
314 UINT8 _OP_HOST_NAME; /* 12 */
315 UINT8 _OP_BOOT_FILE_SZ; /* 13 */
316 UINT8 _OP_DOMAIN_NAME; /* 15 */
317 UINT8 _OP_ROOT_PATH; /* 17 */
318 UINT8 _OP_EXTENSION_PATH; /* 18 */
319 UINT8 _OP_MAX_DATAGRAM_SZ; /* 22 */
320 UINT8 _OP_DEFAULT_TTL; /* 23 */
321 UINT8 _OP_BROADCAST_ADD; /* 28 */
322 UINT8 _OP_NIS_DOMAIN_NAME; /* 40 */
323 UINT8 _OP_NIS_SERVERS; /* 41 */
324 UINT8 _OP_NTP_SERVERS; /* 42 */
325 UINT8 _OP_VENDOR_SPECIFIC; /* 43 */
326 UINT8 _OP_DHCP_REQ_IP_ADD; /* 50 */
327 UINT8 _OP_DHCP_LEASE_TIME; /* 51 */
328 UINT8 _OP_DHCP_SERVER_IP; /* 54 */
329 UINT8 _OP_DHCP_RENEWAL_TIME; /* 58 */
330 UINT8 _OP_DHCP_REBINDING_TIME; /* 59 */
331 UINT8 _OP_DHCP_CLASS_IDENTIFIER; /* 60 */
332 UINT8 _OP_DHCP_TFTP_SERVER_NAME; /* 66 */
333 UINT8 _OP_DHCP_BOOTFILE; /* 67 */
334 UINT8 _OP_DHCP_PLATFORM_ID; /* 97 */
335 UINT8 VendorOption128; // vendor option 128
336 UINT8 VendorOption129; // vendor option 129
337 UINT8 VendorOption130; // vendor option 130
338 UINT8 VendorOption131; // vendor option 131
339 UINT8 VendorOption132; // vendor option 132
340 UINT8 VendorOption133; // vendor option 133
341 UINT8 VendorOption134; // vendor option 134
342 UINT8 VendorOption135; // vendor option 135
343 } DHCPV4_REQUESTED_OPTIONS_DATA;
344
345 typedef struct {
346 DHCPV4_OP_HEADER Header;
347 DHCPV4_REQUESTED_OPTIONS_DATA Data;
348 } DHCPV4_OP_REQUESTED_OPTIONS;
349
350 typedef struct opipstr {
351 DHCPV4_OP_HEADER Header;
352 EFI_IPv4_ADDRESS Ip;
353 } DHCPV4_OP_IP_ADDRESS;
354
355 //
356 // ip list structure - e.g. router list
357 //
358 typedef struct {
359 DHCPV4_OP_HEADER Header;
360 EFI_IPv4_ADDRESS IpList[1];
361 } DHCPV4_OP_IP_LIST;
362
363 typedef struct {
364 DHCPV4_OP_HEADER Header;
365 UINT8 Type;
366 UINT8 Guid[sizeof (EFI_GUID)];
367 } DHCPV4_OP_CLIENT_ID;
368
369 //
370 // special options start - someday obsolete ???
371 //
372 #define DHCPV4_OP_PLATFORM_ID DHCPV4_OP_CLIENT_ID
373
374 typedef struct {
375 DHCPV4_OP_HEADER Header;
376 UINT8 Type; // SNP = 2
377 UINT8 MajorVersion;
378 UINT8 MinorVersion;
379 } DHCPV4_OP_NETWORK_INTERFACE;
380
381 #define UNDI_TYPE 1
382 #define SNP_TYPE 2
383
384 typedef struct {
385 DHCPV4_OP_HEADER Header;
386 UINT16 Type;
387 } DHCPV4_OP_ARCHITECTURE_TYPE;
388 //
389 // special options end - someday obsolete ???
390 //
391 typedef struct {
392 UINT8 ClassIdentifier[10]; // PXEClient:
393 UINT8 Lit2[5]; // Arch:
394 UINT8 ArchitectureType[5]; // 00000 - 65536
395 UINT8 Lit3[1]; // :
396 UINT8 InterfaceName[4]; // e.g. UNDI
397 UINT8 Lit4[1]; // :
398 UINT8 UndiMajor[3]; // 000 - 255
399 UINT8 UndiMinor[3]; // 000 - 255
400 } DHCPV4_CLASS_ID_DATA;
401
402 typedef struct {
403 DHCPV4_OP_HEADER Header;
404 DHCPV4_CLASS_ID_DATA Data;
405 } DHCPV4_OP_CLASS_ID;
406
407 typedef struct {
408 DHCPV4_OP_HEADER Header;
409 EFI_IPv4_ADDRESS Ip;
410 } DHCPV4_OP_REQUESTED_IP;
411
412 typedef struct {
413 DHCPV4_OP_HEADER Header;
414 EFI_IPv4_ADDRESS Ip;
415 } DHCPV4_OP_SERVER_IP;
416
417 typedef struct {
418 DHCPV4_OP_HEADER Header;
419 EFI_IPv4_ADDRESS Ip;
420 } DHCPV4_OP_SUBNET_MASK;
421
422 typedef struct { // oppxedisctlstr {
423 DHCPV4_OP_HEADER Header;
424 UINT8 ControlBits;
425 } PXE_OP_DISCOVERY_CONTROL;
426
427 #define DISABLE_BCAST (1 << 0)
428 #define DISABLE_MCAST (1 << 1)
429 #define USE_ACCEPT_LIST (1 << 2)
430 #define USE_BOOTFILE (1 << 3)
431
432 #pragma pack()
433 //
434 // definitions of indices to populate option interest array
435 //
436 #define VEND_PXE_MTFTP_IP_IX 1 // multicast IP address of bootfile for MTFTP listen
437 #define VEND_PXE_MTFTP_CPORT_IX 2 // UDP Port to monitor for MTFTP responses - Intel order
438 #define VEND_PXE_MTFTP_SPORT_IX 3 // Server UDP Port for MTFTP open - Intel order
439 #define VEND_PXE_MTFTP_TMOUT_IX 4 // Listen timeout - secs
440 #define VEND_PXE_MTFTP_DELAY_IX 5 // Transmission timeout - secs
441 #define VEND_PXE_DISCOVERY_CONTROL_IX 6 // bit field
442 #define VEND_PXE_DISCOVERY_MCAST_ADDR_IX 7 // boot server discovery multicast address
443 #define VEND_PXE_BOOT_SERVERS_IX 8 // list of boot servers of form tp(2) cnt(1) ips[cnt]
444 #define VEND_PXE_BOOT_MENU_IX 9
445 #define VEND_PXE_BOOT_PROMPT_IX 10
446 #define VEND_PXE_MCAST_ADDRS_ALLOC_IX 0 // not used by PXE client
447 #define VEND_PXE_CREDENTIAL_TYPES_IX 11
448 #define VEND_13_IX 0 // not used by PXE client
449 #define VEND_14_IX 0 // not used by PXE client
450 #define VEND_15_IX 0 // not used by PXE client
451 #define VEND_16_IX 0 // not used by PXE client
452 #define VEND_17_IX 0 // not used by PXE client
453 #define VEND_18_IX 0 // not used by PXE client
454 #define VEND_19_IX 0 // not used by PXE client
455 #define VEND_20_IX 0 // not used by PXE client
456 #define VEND_21_IX 0 // not used by PXE client
457 #define VEND_22_IX 0 // not used by PXE client
458 #define VEND_23_IX 0 // not used by PXE client
459 #define VEND_24_IX 0 // not used by PXE client
460 #define VEND_25_IX 0 // not used by PXE client
461 #define VEND_26_IX 0 // not used by PXE client
462 #define VEND_27_IX 0 // not used by PXE client
463 #define VEND_28_IX 0 // not used by PXE client
464 #define VEND_29_IX 0 // not used by PXE client
465 #define VEND_30_IX 0 // not used by PXE client
466 #define VEND_31_IX 0 // not used by PXE client
467 #define VEND_32_IX 0 // not used by PXE client
468 #define VEND_33_IX 0 // not used by PXE client
469 #define VEND_34_IX 0 // not used by PXE client
470 #define VEND_35_IX 0 // not used by PXE client
471 #define VEND_36_IX 0 // not used by PXE client
472 #define VEND_37_IX 0 // not used by PXE client
473 #define VEND_38_IX 0 // not used by PXE client
474 #define VEND_39_IX 0 // not used by PXE client
475 #define VEND_40_IX 0 // not used by PXE client
476 #define VEND_41_IX 0 // not used by PXE client
477 #define VEND_42_IX 0 // not used by PXE client
478 #define VEND_43_IX 0 // not used by PXE client
479 #define VEND_44_IX 0 // not used by PXE client
480 #define VEND_45_IX 0 // not used by PXE client
481 #define VEND_46_IX 0 // not used by PXE client
482 #define VEND_47_IX 0 // not used by PXE client
483 #define VEND_48_IX 0 // not used by PXE client
484 #define VEND_49_IX 0 // not used by PXE client
485 #define VEND_50_IX 0 // not used by PXE client
486 #define VEND_51_IX 0 // not used by PXE client
487 #define VEND_52_IX 0 // not used by PXE client
488 #define VEND_53_IX 0 // not used by PXE client
489 #define VEND_54_IX 0 // not used by PXE client
490 #define VEND_55_IX 0 // not used by PXE client
491 #define VEND_56_IX 0 // not used by PXE client
492 #define VEND_57_IX 0 // not used by PXE client
493 #define VEND_58_IX 0 // not used by PXE client
494 #define VEND_59_IX 0 // not used by PXE client
495 #define VEND_60_IX 0 // not used by PXE client
496 #define VEND_61_IX 0 // not used by PXE client
497 #define VEND_62_IX 0 // not used by PXE client
498 #define VEND_63_IX 0 // not used by PXE client
499 #define VEND_64_IX 0 // not used by PXE client
500 #define VEND_65_IX 0 // not used by PXE client
501 #define VEND_66_IX 0 // not used by PXE client
502 #define VEND_67_IX 0 // not used by PXE client
503 #define VEND_68_IX 0 // not used by PXE client
504 #define VEND_69_IX 0 // not used by PXE client
505 #define VEND_70_IX 0 // not used by PXE client
506 #define VEND_PXE_BOOT_ITEM_IX 12
507
508 #define MAX_OUR_PXE_OPT VEND_PXE_BOOT_ITEM // largest PXE option in which we are interested
509 #define MAX_OUR_PXE_IX VEND_PXE_BOOT_ITEM_IX // largest PXE option index
510 //
511 // define various types by options that are sent
512 //
513 #define WfM11a_OPTS ((1<<VEND_PXE_MTFTP_IP_IX) | \
514 (1<<VEND_PXE_MTFTP_CPORT_IX) | \
515 (1<<VEND_PXE_MTFTP_SPORT_IX) | \
516 (1<<VEND_PXE_MTFTP_TMOUT_IX) | \
517 (1<<VEND_PXE_MTFTP_DELAY_IX))
518
519 #define DISCOVER_OPTS ((1<<VEND_PXE_DISCOVERY_CONTROL_IX) | \
520 (1<<VEND_PXE_DISCOVERY_MCAST_ADDR_IX) | \
521 (1<<VEND_PXE_BOOT_SERVERS_IX) | \
522 (1<<VEND_PXE_BOOT_MENU_IX) | \
523 (1<<VEND_PXE_BOOT_PROMPT_IX) | \
524 (1<<VEND_PXE_BOOT_ITEM_IX))
525
526 #define CREDENTIALS_OPT (1 << VEND_PXE_CREDENTIAL_TYPES_IX)
527
528 //
529 // definitions of indices to populate option interest array
530 //
531 #define OP_SUBNET_MASK_IX 1
532 #define OP_TIME_OFFSET_IX 0 // not used by PXE client
533 #define OP_ROUTER_LIST_IX 2
534 #define OP_TIME_SERVERS_IX 0 // not used by PXE client
535 #define OP_NAME_SERVERS_IX 0 // not used by PXE client
536 #define OP_DNS_SERVERS_IX 0 // not used by PXE client
537 #define OP_LOG_SERVERS_IX 0 // not used by PXE client
538 #define OP_COOKIE_SERVERS_IX 0 // not used by PXE client
539 #define OP_LPR_SREVERS_IX 0 // not used by PXE client
540 #define OP_IMPRESS_SERVERS_IX 0 // not used by PXE client
541 #define OP_RES_LOC_SERVERS_IX 0 // not used by PXE client
542 #define OP_HOST_NAME_IX 0 // not used by PXE client
543 #define OP_BOOT_FILE_SZ_IX 9
544 #define OP_DUMP_FILE_IX 0 // not used by PXE client
545 #define OP_DOMAIN_NAME_IX 0 // not used by PXE client
546 #define OP_SWAP_SERVER_IX 0 // not used by PXE client
547 #define OP_ROOT_PATH_IX 0 // not used by PXE client
548 #define OP_EXTENSION_PATH_IX 0 // not used by PXE client
549 #define OP_IP_FORWARDING_IX 0 // not used by PXE client
550 #define OP_NON_LOCAL_SRC_RTE_IX 0 // not used by PXE client
551 #define OP_POLICY_FILTER_IX 0 // not used by PXE client
552 #define OP_MAX_DATAGRAM_SZ_IX 0 // not used by PXE client
553 #define OP_DEFAULT_TTL_IX 0 // not used by PXE client
554 #define OP_MTU_AGING_TIMEOUT_IX 0 // not used by PXE client
555 #define OP_MTU_SIZES_IX 0 // not used by PXE client
556 #define OP_MTU_TO_USE_IX 0 // not used by PXE client
557 #define OP_ALL_SUBNETS_LOCAL_IX 0 // not used by PXE client
558 #define OP_BROADCAST_ADD_IX 0 // not used by PXE client
559 #define OP_PERFORM_MASK_DISCOVERY_IX 0 // not used by PXE client
560 #define OP_RESPOND_TO_MASK_REQ_IX 0 // not used by PXE client
561 #define OP_PERFORM_ROUTER_DISCOVERY_IX 0 // not used by PXE client
562 #define OP_ROUTER_SOLICIT_ADDRESS_IX 0 // not used by PXE client
563 #define OP_STATIC_ROUTER_LIST_IX 0 // not used by PXE client
564 #define OP_USE_ARP_TRAILERS_IX 0 // not used by PXE client
565 #define OP_ARP_CACHE_TIMEOUT_IX 0 // not used by PXE client
566 #define OP_ETHERNET_ENCAPSULATION_IX 0 // not used by PXE client
567 #define OP_TCP_DEFAULT_TTL_IX 0 // not used by PXE client
568 #define OP_TCP_KEEP_ALIVE_INT_IX 0 // not used by PXE client
569 #define OP_KEEP_ALIVE_GARBAGE_IX 0 // not used by PXE client
570 #define OP_NIS_DOMAIN_NAME_IX 0 // not used by PXE client
571 #define OP_NIS_SERVERS_IX 0 // not used by PXE client
572 #define OP_NTP_SERVERS_IX 0 // not used by PXE client
573 #define OP_VENDOR_SPECIFIC_IX 3
574 #define OP_NBNS_SERVERS_IX 0 // not used by PXE client
575 #define OP_NBDD_SERVERS_IX 0 // not used by PXE client
576 #define OP_NETBIOS_NODE_TYPE_IX 0 // not used by PXE client
577 #define OP_NETBIOS_SCOPE_IX 0 // not used by PXE client
578 #define OP_XWINDOW_SYSTEM_FONT_SERVERS_IX 0 // not used by PXE client
579 #define OP_XWINDOW_SYSTEM_DISPLAY_MANAGERS_IX 0 // not used by PXE client
580 // DHCP option indices
581 //
582 #define OP_DHCP_REQ_IP_ADD_IX 0 // not used by PXE client
583 #define OP_DHCP_LEASE_TIME_IX 0 // not used by PXE client
584 #define OP_DHCP_OPTION_OVERLOAD_IX 4
585 #define OP_DHCP_MESSAGE_TYPE_IX 5
586 #define OP_DHCP_SERVER_IP_IX 6
587 #define OP_DHCP_PARM_REQ_LIST_IX 0 // not used by PXE client
588 #define OP_DHCP_ERROR_MESSAGE_IX 0 // not used by PXE client
589 #define OP_DHCP_MAX_MESSAGE_SZ_IX 0 // not used by PXE client
590 #define OP_DHCP_RENEWAL_TIME_IX 0 // not used by PXE client
591 #define OP_DHCP_REBINDING_TIME_IX 0 // not used by PXE client
592 #define OP_DHCP_CLASS_IDENTIFIER_IX 7
593 #define OP_DHCP_CLIENT_IDENTIFIER_IX 0 // not used by PXE client
594 #define OP_RESERVED62_IX 0 // not used by PXE client
595 #define OP_RESERVED63_IX 0 // not used by PXE client
596 #define OP_NISPLUS_DOMAIN_NAME_IX 0 // not used by PXE client
597 #define OP_NISPLUS_SERVERS_IX 0 // not used by PXE client
598 #define OP_DHCP_TFTP_SERVER_NAME_IX 0 // not used by PXE client
599 #define OP_DHCP_BOOTFILE_IX 8
600
601 #define MAX_OUR_OPT OP_DHCP_BOOTFILE // largest option in which we are interested
602 #define MAX_OUR_IX OP_BOOT_FILE_SZ_IX
603
604 typedef struct {
605 DHCPV4_OP_STRUCT *PktOptAdds[MAX_OUR_IX];
606 DHCPV4_OP_STRUCT *PxeOptAdds[MAX_OUR_PXE_IX];
607 UINT8 Status;
608 } OPTION_POINTERS;
609
610 typedef struct DhcpReceiveBufferStruct {
611 union {
612 UINT8 ReceiveBuffer[MAX_DHCP_MSG_SZ];
613 DHCPV4_STRUCT Dhcpv4;
614 } u;
615
616 OPTION_POINTERS OpAdds;
617 } DHCP_RECEIVE_BUFFER;
618
619 #define PXE_TYPE (1 << 0)
620 #define WfM11a_TYPE (1 << 1)
621 #define DISCOVER_TYPE (1 << 2)
622 #define CREDENTIALS_TYPE (1 << 3)
623 #define USE_THREE_BYTE (1 << 4)
624
625 VOID
626 OptionsStrucInit (
627 VOID
628 );
629
630 #endif // _DHCP_H
631
632 /* EOF - dhcp.h */
EFI Development Kit II mirror for PVE