2 Functions declaration related with DHCPv4 for UefiPxeBc Driver.
4 Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php.
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #ifndef __EFI_PXEBC_DHCP4_H__
17 #define __EFI_PXEBC_DHCP4_H__
19 #define PXEBC_DHCP4_OPTION_MAX_NUM 16
20 #define PXEBC_DHCP4_OPTION_MAX_SIZE 312
21 #define PXEBC_DHCP4_PACKET_MAX_SIZE (sizeof (EFI_PXE_BASE_CODE_PACKET))
22 #define PXEBC_DHCP4_S_PORT 67
23 #define PXEBC_DHCP4_C_PORT 68
24 #define PXEBC_BS_DOWNLOAD_PORT 69
25 #define PXEBC_BS_DISCOVER_PORT 4011
26 #define PXEBC_DHCP4_OPCODE_REQUEST 1
27 #define PXEBC_DHCP4_OPCODE_REPLY 2
28 #define PXEBC_DHCP4_MSG_TYPE_REQUEST 3
29 #define PXEBC_DHCP4_MAGIC 0x63538263 // network byte order
32 // Sub-Options in Dhcp Vendor Option
34 #define PXEBC_VENDOR_TAG_MTFTP_IP 1
35 #define PXEBC_VENDOR_TAG_MTFTP_CPORT 2
36 #define PXEBC_VENDOR_TAG_MTFTP_SPORT 3
37 #define PXEBC_VENDOR_TAG_MTFTP_TIMEOUT 4
38 #define PXEBC_VENDOR_TAG_MTFTP_DELAY 5
39 #define PXEBC_VENDOR_TAG_DISCOVER_CTRL 6
40 #define PXEBC_VENDOR_TAG_DISCOVER_MCAST 7
41 #define PXEBC_VENDOR_TAG_BOOT_SERVERS 8
42 #define PXEBC_VENDOR_TAG_BOOT_MENU 9
43 #define PXEBC_VENDOR_TAG_MENU_PROMPT 10
44 #define PXEBC_VENDOR_TAG_MCAST_ALLOC 11
45 #define PXEBC_VENDOR_TAG_CREDENTIAL_TYPES 12
46 #define PXEBC_VENDOR_TAG_BOOT_ITEM 71
48 #define PXEBC_BOOT_REQUEST_TIMEOUT 1
49 #define PXEBC_BOOT_REQUEST_RETRIES 4
51 #define PXEBC_DHCP4_OVERLOAD_FILE 1
52 #define PXEBC_DHCP4_OVERLOAD_SERVER_NAME 2
56 // The array index of the DHCP4 option tag interested
58 #define PXEBC_DHCP4_TAG_INDEX_BOOTFILE_LEN 0
59 #define PXEBC_DHCP4_TAG_INDEX_VENDOR 1
60 #define PXEBC_DHCP4_TAG_INDEX_OVERLOAD 2
61 #define PXEBC_DHCP4_TAG_INDEX_MSG_TYPE 3
62 #define PXEBC_DHCP4_TAG_INDEX_SERVER_ID 4
63 #define PXEBC_DHCP4_TAG_INDEX_CLASS_ID 5
64 #define PXEBC_DHCP4_TAG_INDEX_BOOTFILE 6
65 #define PXEBC_DHCP4_TAG_INDEX_MAX 7
68 // Dhcp4 and Dhcp6 share this definition, and corresponding
69 // relatioinship is as follows:
71 // Dhcp4Discover <> Dhcp6Solicit
72 // Dhcp4Offer <> Dhcp6Advertise
73 // Dhcp4Request <> Dhcp6Request
74 // Dhcp4Ack <> DHcp6Reply
78 PxeOfferTypeDhcpPxe10
,
79 PxeOfferTypeDhcpWfm11a
,
81 PxeOfferTypeProxyPxe10
,
82 PxeOfferTypeProxyWfm11a
,
83 PxeOfferTypeProxyBinl
,
88 #define BIT(x) (1 << x)
89 #define CTRL(x) (0x1F & (x))
90 #define DEFAULT_CLASS_ID_DATA "PXEClient:Arch:xxxxx:UNDI:003000"
91 #define DEFAULT_UNDI_TYPE 1
92 #define DEFAULT_UNDI_MAJOR 3
93 #define DEFAULT_UNDI_MINOR 0
95 #define MTFTP_VENDOR_OPTION_BIT_MAP \
96 (BIT (PXEBC_VENDOR_TAG_MTFTP_IP) | \
97 BIT (PXEBC_VENDOR_TAG_MTFTP_CPORT) | \
98 BIT (PXEBC_VENDOR_TAG_MTFTP_SPORT) | \
99 BIT (PXEBC_VENDOR_TAG_MTFTP_TIMEOUT) | \
100 BIT (PXEBC_VENDOR_TAG_MTFTP_DELAY))
102 #define DISCOVER_VENDOR_OPTION_BIT_MAP \
103 (BIT (PXEBC_VENDOR_TAG_DISCOVER_CTRL) | \
104 BIT (PXEBC_VENDOR_TAG_DISCOVER_MCAST) | \
105 BIT (PXEBC_VENDOR_TAG_BOOT_SERVERS) | \
106 BIT (PXEBC_VENDOR_TAG_BOOT_MENU) | \
107 BIT (PXEBC_VENDOR_TAG_MENU_PROMPT))
109 #define IS_VALID_BOOT_SERVERS(x) \
110 ((((x)[0]) & BIT (PXEBC_VENDOR_TAG_BOOT_SERVERS)) \
111 == BIT (PXEBC_VENDOR_TAG_BOOT_SERVERS))
113 #define IS_VALID_BOOT_PROMPT(x) \
114 ((((x)[0]) & BIT (PXEBC_VENDOR_TAG_MENU_PROMPT)) \
115 == BIT (PXEBC_VENDOR_TAG_MENU_PROMPT))
117 #define IS_VALID_BOOT_MENU(x) \
118 ((((x)[0]) & BIT (PXEBC_VENDOR_TAG_BOOT_MENU)) \
119 == BIT (PXEBC_VENDOR_TAG_BOOT_MENU))
121 #define IS_VALID_MTFTP_VENDOR_OPTION(x) \
122 (((UINT32) ((x)[0]) & MTFTP_VENDOR_OPTION_BIT_MAP) \
123 == MTFTP_VENDOR_OPTION_BIT_MAP)
125 #define IS_VALID_DISCOVER_VENDOR_OPTION(x) \
126 (((UINT32) ((x)[0]) & DISCOVER_VENDOR_OPTION_BIT_MAP) != 0)
128 #define IS_VALID_CREDENTIAL_VENDOR_OPTION(x) \
129 (((UINT32) ((x)[0]) & BIT (PXEBC_VENDOR_TAG_CREDENTIAL_TYPES)) \
130 == BIT (PXEBC_VENDOR_TAG_CREDENTIAL_TYPES))
132 #define IS_VALID_BOOTITEM_VENDOR_OPTION(x) \
133 (((UINT32) ((x)[PXEBC_VENDOR_TAG_BOOT_ITEM / 32]) & \
134 BIT (PXEBC_VENDOR_TAG_BOOT_ITEM % 32)) \
135 == BIT (PXEBC_VENDOR_TAG_BOOT_ITEM % 32))
137 #define SET_VENDOR_OPTION_BIT_MAP(x, y) \
138 (*(x + ((y) / 32)) = (UINT32) ((UINT32) ((x)[(y) / 32]) | BIT ((y) % 32)))
140 #define GET_NEXT_DHCP_OPTION(Opt) \
141 (EFI_DHCP4_PACKET_OPTION *) ((UINT8 *) (Opt) + \
142 sizeof (EFI_DHCP4_PACKET_OPTION) + (Opt)->Length - 1)
144 #define GET_OPTION_BUFFER_LEN(Pkt) \
145 ((Pkt)->Length - sizeof (EFI_DHCP4_HEADER) - 4)
147 #define GET_NEXT_BOOT_SVR_ENTRY(Ent) \
148 (PXEBC_BOOT_SVR_ENTRY *) ((UINT8 *) Ent + sizeof (*(Ent)) + \
149 ((Ent)->IpCnt - 1) * sizeof (EFI_IPv4_ADDRESS))
151 #define IS_PROXY_DHCP_OFFER(Offer) \
152 EFI_IP4_EQUAL (&(Offer)->Dhcp4.Header.YourAddr, &mZeroIp4Addr)
154 #define IS_DISABLE_BCAST_DISCOVER(x) \
155 (((x) & BIT (0)) == BIT (0))
157 #define IS_DISABLE_MCAST_DISCOVER(x) \
158 (((x) & BIT (1)) == BIT (1))
160 #define IS_ENABLE_USE_SERVER_LIST(x) \
161 (((x) & BIT (2)) == BIT (2))
163 #define IS_DISABLE_PROMPT_MENU(x) \
164 (((x) & BIT (3)) == BIT (3))
170 } PXEBC_DHCP4_OPTION_PARA
;
174 } PXEBC_DHCP4_OPTION_MAX_MESG_SIZE
;
180 } PXEBC_DHCP4_OPTION_UNDI
;
184 } PXEBC_DHCP4_OPTION_MESG
;
188 } PXEBC_DHCP4_OPTION_ARCH
;
191 UINT8 ClassIdentifier
[10];
192 UINT8 ArchitecturePrefix
[5];
193 UINT8 ArchitectureType
[5];
195 UINT8 InterfaceName
[4];
199 } PXEBC_DHCP4_OPTION_CLID
;
204 } PXEBC_DHCP4_OPTION_UUID
;
209 } PXEBC_OPTION_BOOT_ITEM
;
214 PXEBC_DHCP4_OPTION_PARA
*Para
;
215 PXEBC_DHCP4_OPTION_UNDI
*Undi
;
216 PXEBC_DHCP4_OPTION_ARCH
*Arch
;
217 PXEBC_DHCP4_OPTION_CLID
*Clid
;
218 PXEBC_DHCP4_OPTION_UUID
*Uuid
;
219 PXEBC_DHCP4_OPTION_MESG
*Mesg
;
220 PXEBC_DHCP4_OPTION_MAX_MESG_SIZE
*MaxMesgSize
;
221 } PXEBC_DHCP4_OPTION_ENTRY
;
227 EFI_IPv4_ADDRESS IpAddr
[1];
228 } PXEBC_BOOT_SVR_ENTRY
;
234 } PXEBC_BOOT_MENU_ENTRY
;
244 EFI_IPv4_ADDRESS MtftpIp
;
250 EFI_IPv4_ADDRESS DiscoverMcastIp
;
251 EFI_IPv4_ADDRESS McastIpBase
;
256 PXEBC_BOOT_SVR_ENTRY
*BootSvr
;
258 PXEBC_BOOT_MENU_ENTRY
*BootMenu
;
260 PXEBC_MENU_PROMPT
*MenuPrompt
;
264 } PXEBC_VENDOR_OPTION
;
266 #define PXEBC_CACHED_DHCP4_PACKET_MAX_SIZE (OFFSET_OF (EFI_DHCP4_PACKET, Dhcp4) + PXEBC_DHCP4_PACKET_MAX_SIZE)
269 EFI_DHCP4_PACKET Offer
;
270 EFI_DHCP4_PACKET Ack
;
271 UINT8 Buffer
[PXEBC_CACHED_DHCP4_PACKET_MAX_SIZE
];
272 } PXEBC_DHCP4_PACKET
;
275 PXEBC_DHCP4_PACKET Packet
;
276 PXEBC_OFFER_TYPE OfferType
;
277 EFI_DHCP4_PACKET_OPTION
*OptList
[PXEBC_DHCP4_TAG_INDEX_MAX
];
278 PXEBC_VENDOR_OPTION VendorOpt
;
279 } PXEBC_DHCP4_PACKET_CACHE
;
283 Create a template DHCPv4 packet as a seed.
285 @param[out] Seed Pointer to the seed packet.
286 @param[in] Udp4 Pointer to EFI_UDP4_PROTOCOL.
290 PxeBcSeedDhcp4Packet (
291 OUT EFI_DHCP4_PACKET
*Seed
,
292 IN EFI_UDP4_PROTOCOL
*Udp4
297 Parse the cached DHCPv4 packet, including all the options.
299 @param[in] Cache4 Pointer to cached DHCPv4 packet.
301 @retval EFI_SUCCESS Parsed the DHCPv4 packet successfully.
302 @retval EFI_DEVICE_ERROR Failed to parse and invalid packet.
306 PxeBcParseDhcp4Packet (
307 IN PXEBC_DHCP4_PACKET_CACHE
*Cache4
312 Build and send out the request packet for the bootfile, and parse the reply.
314 @param[in] Private Pointer to PxeBc private data.
315 @param[in] Type PxeBc option boot item type.
316 @param[in] Layer Pointer to option boot item layer.
317 @param[in] UseBis Use BIS or not.
318 @param[in] DestIp Pointer to the server address.
319 @param[in] IpCount The total count of the server address.
320 @param[in] SrvList Pointer to EFI_PXE_BASE_CODE_SRVLIST.
322 @retval EFI_SUCCESS Successfully discovered boot file.
323 @retval EFI_OUT_OF_RESOURCES Failed to allocate resource.
324 @retval EFI_NOT_FOUND Can't get the PXE reply packet.
325 @retval Others Failed to discover boot file.
330 IN PXEBC_PRIVATE_DATA
*Private
,
334 IN EFI_IP_ADDRESS
*DestIp
,
336 IN EFI_PXE_BASE_CODE_SRVLIST
*SrvList
340 Switch the Ip4 policy to static.
342 @param[in] Private The pointer to PXEBC_PRIVATE_DATA.
344 @retval EFI_SUCCESS The policy is already configured to static.
345 @retval Others Other error as indicated..
350 IN PXEBC_PRIVATE_DATA
*Private
355 Start the D.O.R.A DHCPv4 process to acquire the IPv4 address and other PXE boot information.
357 @param[in] Private Pointer to PxeBc private data.
358 @param[in] Dhcp4 Pointer to the EFI_DHCP4_PROTOCOL
360 @retval EFI_SUCCESS The D.O.R.A process successfully finished.
361 @retval Others Failed to finish the D.O.R.A process.
366 IN PXEBC_PRIVATE_DATA
*Private
,
367 IN EFI_DHCP4_PROTOCOL
*Dhcp4