2 Functions declaration related with DHCPv4 for UefiPxeBc Driver.
4 Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>
6 SPDX-License-Identifier: BSD-2-Clause-Patent
10 #ifndef __EFI_PXEBC_DHCP4_H__
11 #define __EFI_PXEBC_DHCP4_H__
13 #define PXEBC_DHCP4_OPTION_MAX_NUM 16
14 #define PXEBC_DHCP4_OPTION_MAX_SIZE 312
15 #define PXEBC_DHCP4_PACKET_MAX_SIZE (sizeof (EFI_PXE_BASE_CODE_PACKET))
16 #define PXEBC_DHCP4_S_PORT 67
17 #define PXEBC_DHCP4_C_PORT 68
18 #define PXEBC_BS_DOWNLOAD_PORT 69
19 #define PXEBC_BS_DISCOVER_PORT 4011
20 #define PXEBC_DHCP4_OPCODE_REQUEST 1
21 #define PXEBC_DHCP4_OPCODE_REPLY 2
22 #define PXEBC_DHCP4_MSG_TYPE_REQUEST 3
23 #define PXEBC_DHCP4_MAGIC 0x63538263 // network byte order
26 // Sub-Options in Dhcp Vendor Option
28 #define PXEBC_VENDOR_TAG_MTFTP_IP 1
29 #define PXEBC_VENDOR_TAG_MTFTP_CPORT 2
30 #define PXEBC_VENDOR_TAG_MTFTP_SPORT 3
31 #define PXEBC_VENDOR_TAG_MTFTP_TIMEOUT 4
32 #define PXEBC_VENDOR_TAG_MTFTP_DELAY 5
33 #define PXEBC_VENDOR_TAG_DISCOVER_CTRL 6
34 #define PXEBC_VENDOR_TAG_DISCOVER_MCAST 7
35 #define PXEBC_VENDOR_TAG_BOOT_SERVERS 8
36 #define PXEBC_VENDOR_TAG_BOOT_MENU 9
37 #define PXEBC_VENDOR_TAG_MENU_PROMPT 10
38 #define PXEBC_VENDOR_TAG_MCAST_ALLOC 11
39 #define PXEBC_VENDOR_TAG_CREDENTIAL_TYPES 12
40 #define PXEBC_VENDOR_TAG_BOOT_ITEM 71
42 #define PXEBC_BOOT_REQUEST_TIMEOUT 1
43 #define PXEBC_BOOT_REQUEST_RETRIES 4
45 #define PXEBC_DHCP4_OVERLOAD_FILE 1
46 #define PXEBC_DHCP4_OVERLOAD_SERVER_NAME 2
50 // The array index of the DHCP4 option tag interested
52 #define PXEBC_DHCP4_TAG_INDEX_BOOTFILE_LEN 0
53 #define PXEBC_DHCP4_TAG_INDEX_VENDOR 1
54 #define PXEBC_DHCP4_TAG_INDEX_OVERLOAD 2
55 #define PXEBC_DHCP4_TAG_INDEX_MSG_TYPE 3
56 #define PXEBC_DHCP4_TAG_INDEX_SERVER_ID 4
57 #define PXEBC_DHCP4_TAG_INDEX_CLASS_ID 5
58 #define PXEBC_DHCP4_TAG_INDEX_BOOTFILE 6
59 #define PXEBC_DHCP4_TAG_INDEX_MAX 7
62 // Dhcp4 and Dhcp6 share this definition, and corresponding
63 // relatioinship is as follows:
65 // Dhcp4Discover <> Dhcp6Solicit
66 // Dhcp4Offer <> Dhcp6Advertise
67 // Dhcp4Request <> Dhcp6Request
68 // Dhcp4Ack <> DHcp6Reply
72 PxeOfferTypeDhcpPxe10
,
73 PxeOfferTypeDhcpWfm11a
,
75 PxeOfferTypeProxyPxe10
,
76 PxeOfferTypeProxyWfm11a
,
77 PxeOfferTypeProxyBinl
,
82 #define BIT(x) (1 << x)
83 #define CTRL(x) (0x1F & (x))
84 #define DEFAULT_CLASS_ID_DATA "PXEClient:Arch:xxxxx:UNDI:003000"
85 #define DEFAULT_UNDI_TYPE 1
86 #define DEFAULT_UNDI_MAJOR 3
87 #define DEFAULT_UNDI_MINOR 0
89 #define MTFTP_VENDOR_OPTION_BIT_MAP \
90 (BIT (PXEBC_VENDOR_TAG_MTFTP_IP) | \
91 BIT (PXEBC_VENDOR_TAG_MTFTP_CPORT) | \
92 BIT (PXEBC_VENDOR_TAG_MTFTP_SPORT) | \
93 BIT (PXEBC_VENDOR_TAG_MTFTP_TIMEOUT) | \
94 BIT (PXEBC_VENDOR_TAG_MTFTP_DELAY))
96 #define DISCOVER_VENDOR_OPTION_BIT_MAP \
97 (BIT (PXEBC_VENDOR_TAG_DISCOVER_CTRL) | \
98 BIT (PXEBC_VENDOR_TAG_DISCOVER_MCAST) | \
99 BIT (PXEBC_VENDOR_TAG_BOOT_SERVERS) | \
100 BIT (PXEBC_VENDOR_TAG_BOOT_MENU) | \
101 BIT (PXEBC_VENDOR_TAG_MENU_PROMPT))
103 #define IS_VALID_BOOT_SERVERS(x) \
104 ((((x)[0]) & BIT (PXEBC_VENDOR_TAG_BOOT_SERVERS)) \
105 == BIT (PXEBC_VENDOR_TAG_BOOT_SERVERS))
107 #define IS_VALID_BOOT_PROMPT(x) \
108 ((((x)[0]) & BIT (PXEBC_VENDOR_TAG_MENU_PROMPT)) \
109 == BIT (PXEBC_VENDOR_TAG_MENU_PROMPT))
111 #define IS_VALID_BOOT_MENU(x) \
112 ((((x)[0]) & BIT (PXEBC_VENDOR_TAG_BOOT_MENU)) \
113 == BIT (PXEBC_VENDOR_TAG_BOOT_MENU))
115 #define IS_VALID_MTFTP_VENDOR_OPTION(x) \
116 (((UINT32) ((x)[0]) & MTFTP_VENDOR_OPTION_BIT_MAP) \
117 == MTFTP_VENDOR_OPTION_BIT_MAP)
119 #define IS_VALID_DISCOVER_VENDOR_OPTION(x) \
120 (((UINT32) ((x)[0]) & DISCOVER_VENDOR_OPTION_BIT_MAP) != 0)
122 #define IS_VALID_CREDENTIAL_VENDOR_OPTION(x) \
123 (((UINT32) ((x)[0]) & BIT (PXEBC_VENDOR_TAG_CREDENTIAL_TYPES)) \
124 == BIT (PXEBC_VENDOR_TAG_CREDENTIAL_TYPES))
126 #define IS_VALID_BOOTITEM_VENDOR_OPTION(x) \
127 (((UINT32) ((x)[PXEBC_VENDOR_TAG_BOOT_ITEM / 32]) & \
128 BIT (PXEBC_VENDOR_TAG_BOOT_ITEM % 32)) \
129 == BIT (PXEBC_VENDOR_TAG_BOOT_ITEM % 32))
131 #define SET_VENDOR_OPTION_BIT_MAP(x, y) \
132 (*(x + ((y) / 32)) = (UINT32) ((UINT32) ((x)[(y) / 32]) | BIT ((y) % 32)))
134 #define GET_NEXT_DHCP_OPTION(Opt) \
135 (EFI_DHCP4_PACKET_OPTION *) ((UINT8 *) (Opt) + \
136 sizeof (EFI_DHCP4_PACKET_OPTION) + (Opt)->Length - 1)
138 #define GET_OPTION_BUFFER_LEN(Pkt) \
139 ((Pkt)->Length - sizeof (EFI_DHCP4_HEADER) - 4)
141 #define GET_NEXT_BOOT_SVR_ENTRY(Ent) \
142 (PXEBC_BOOT_SVR_ENTRY *) ((UINT8 *) Ent + sizeof (*(Ent)) + \
143 ((Ent)->IpCnt - 1) * sizeof (EFI_IPv4_ADDRESS))
145 #define IS_PROXY_DHCP_OFFER(Offer) \
146 EFI_IP4_EQUAL (&(Offer)->Dhcp4.Header.YourAddr, &mZeroIp4Addr)
148 #define IS_DISABLE_BCAST_DISCOVER(x) \
149 (((x) & BIT (0)) == BIT (0))
151 #define IS_DISABLE_MCAST_DISCOVER(x) \
152 (((x) & BIT (1)) == BIT (1))
154 #define IS_ENABLE_USE_SERVER_LIST(x) \
155 (((x) & BIT (2)) == BIT (2))
157 #define IS_DISABLE_PROMPT_MENU(x) \
158 (((x) & BIT (3)) == BIT (3))
164 } PXEBC_DHCP4_OPTION_PARA
;
168 } PXEBC_DHCP4_OPTION_MAX_MESG_SIZE
;
174 } PXEBC_DHCP4_OPTION_UNDI
;
178 } PXEBC_DHCP4_OPTION_MESG
;
182 } PXEBC_DHCP4_OPTION_ARCH
;
185 UINT8 ClassIdentifier
[10];
186 UINT8 ArchitecturePrefix
[5];
187 UINT8 ArchitectureType
[5];
189 UINT8 InterfaceName
[4];
193 } PXEBC_DHCP4_OPTION_CLID
;
198 } PXEBC_DHCP4_OPTION_UUID
;
203 } PXEBC_OPTION_BOOT_ITEM
;
208 PXEBC_DHCP4_OPTION_PARA
*Para
;
209 PXEBC_DHCP4_OPTION_UNDI
*Undi
;
210 PXEBC_DHCP4_OPTION_ARCH
*Arch
;
211 PXEBC_DHCP4_OPTION_CLID
*Clid
;
212 PXEBC_DHCP4_OPTION_UUID
*Uuid
;
213 PXEBC_DHCP4_OPTION_MESG
*Mesg
;
214 PXEBC_DHCP4_OPTION_MAX_MESG_SIZE
*MaxMesgSize
;
215 } PXEBC_DHCP4_OPTION_ENTRY
;
221 EFI_IPv4_ADDRESS IpAddr
[1];
222 } PXEBC_BOOT_SVR_ENTRY
;
228 } PXEBC_BOOT_MENU_ENTRY
;
238 EFI_IPv4_ADDRESS MtftpIp
;
244 EFI_IPv4_ADDRESS DiscoverMcastIp
;
245 EFI_IPv4_ADDRESS McastIpBase
;
250 PXEBC_BOOT_SVR_ENTRY
*BootSvr
;
252 PXEBC_BOOT_MENU_ENTRY
*BootMenu
;
254 PXEBC_MENU_PROMPT
*MenuPrompt
;
258 } PXEBC_VENDOR_OPTION
;
260 #define PXEBC_CACHED_DHCP4_PACKET_MAX_SIZE (OFFSET_OF (EFI_DHCP4_PACKET, Dhcp4) + PXEBC_DHCP4_PACKET_MAX_SIZE)
263 EFI_DHCP4_PACKET Offer
;
264 EFI_DHCP4_PACKET Ack
;
265 UINT8 Buffer
[PXEBC_CACHED_DHCP4_PACKET_MAX_SIZE
];
266 } PXEBC_DHCP4_PACKET
;
269 PXEBC_DHCP4_PACKET Packet
;
270 PXEBC_OFFER_TYPE OfferType
;
271 EFI_DHCP4_PACKET_OPTION
*OptList
[PXEBC_DHCP4_TAG_INDEX_MAX
];
272 PXEBC_VENDOR_OPTION VendorOpt
;
273 } PXEBC_DHCP4_PACKET_CACHE
;
277 Create a template DHCPv4 packet as a seed.
279 @param[out] Seed Pointer to the seed packet.
280 @param[in] Udp4 Pointer to EFI_UDP4_PROTOCOL.
284 PxeBcSeedDhcp4Packet (
285 OUT EFI_DHCP4_PACKET
*Seed
,
286 IN EFI_UDP4_PROTOCOL
*Udp4
291 Parse the cached DHCPv4 packet, including all the options.
293 @param[in] Cache4 Pointer to cached DHCPv4 packet.
295 @retval EFI_SUCCESS Parsed the DHCPv4 packet successfully.
296 @retval EFI_DEVICE_ERROR Failed to parse and invalid packet.
300 PxeBcParseDhcp4Packet (
301 IN PXEBC_DHCP4_PACKET_CACHE
*Cache4
306 Build and send out the request packet for the bootfile, and parse the reply.
308 @param[in] Private Pointer to PxeBc private data.
309 @param[in] Type PxeBc option boot item type.
310 @param[in] Layer Pointer to option boot item layer.
311 @param[in] UseBis Use BIS or not.
312 @param[in] DestIp Pointer to the server address.
313 @param[in] IpCount The total count of the server address.
314 @param[in] SrvList Pointer to EFI_PXE_BASE_CODE_SRVLIST.
316 @retval EFI_SUCCESS Successfully discovered boot file.
317 @retval EFI_OUT_OF_RESOURCES Failed to allocate resource.
318 @retval EFI_NOT_FOUND Can't get the PXE reply packet.
319 @retval Others Failed to discover boot file.
324 IN PXEBC_PRIVATE_DATA
*Private
,
328 IN EFI_IP_ADDRESS
*DestIp
,
330 IN EFI_PXE_BASE_CODE_SRVLIST
*SrvList
334 Switch the Ip4 policy to static.
336 @param[in] Private The pointer to PXEBC_PRIVATE_DATA.
338 @retval EFI_SUCCESS The policy is already configured to static.
339 @retval Others Other error as indicated..
344 IN PXEBC_PRIVATE_DATA
*Private
349 Start the D.O.R.A DHCPv4 process to acquire the IPv4 address and other PXE boot information.
351 @param[in] Private Pointer to PxeBc private data.
352 @param[in] Dhcp4 Pointer to the EFI_DHCP4_PROTOCOL
354 @retval EFI_SUCCESS The D.O.R.A process successfully finished.
355 @retval Others Failed to finish the D.O.R.A process.
360 IN PXEBC_PRIVATE_DATA
*Private
,
361 IN EFI_DHCP4_PROTOCOL
*Dhcp4