VirtualBox

source: vbox/trunk/src/VBox/Devices/EFI/Firmware/NetworkPkg/UefiPxeBcDxe/PxeBcDhcp4.h@ 81913

Last change on this file since 81913 was 80721, checked in by vboxsync, 5 years ago

Devices/EFI/FirmwareNew: Start upgrade process to edk2-stable201908 (compiles on Windows and works to some extent), bugref:4643

  • Property svn:eol-style set to native
File size: 10.4 KB
Line 
1/** @file
2 Functions declaration related with DHCPv4 for UefiPxeBc Driver.
3
4 Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>
5
6 SPDX-License-Identifier: BSD-2-Clause-Patent
7
8**/
9
10#ifndef __EFI_PXEBC_DHCP4_H__
11#define __EFI_PXEBC_DHCP4_H__
12
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
24
25//
26// Sub-Options in Dhcp Vendor Option
27//
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
41
42#define PXEBC_BOOT_REQUEST_TIMEOUT 1
43#define PXEBC_BOOT_REQUEST_RETRIES 4
44
45#define PXEBC_DHCP4_OVERLOAD_FILE 1
46#define PXEBC_DHCP4_OVERLOAD_SERVER_NAME 2
47
48
49//
50// The array index of the DHCP4 option tag interested
51//
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
60
61//
62// Dhcp4 and Dhcp6 share this definition, and corresponding
63// relatioinship is as follows:
64//
65// Dhcp4Discover <> Dhcp6Solicit
66// Dhcp4Offer <> Dhcp6Advertise
67// Dhcp4Request <> Dhcp6Request
68// Dhcp4Ack <> DHcp6Reply
69//
70typedef enum {
71 PxeOfferTypeDhcpOnly,
72 PxeOfferTypeDhcpPxe10,
73 PxeOfferTypeDhcpWfm11a,
74 PxeOfferTypeDhcpBinl,
75 PxeOfferTypeProxyPxe10,
76 PxeOfferTypeProxyWfm11a,
77 PxeOfferTypeProxyBinl,
78 PxeOfferTypeBootp,
79 PxeOfferTypeMax
80} PXEBC_OFFER_TYPE;
81
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
88
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))
95
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))
102
103#define IS_VALID_BOOT_SERVERS(x) \
104 ((((x)[0]) & BIT (PXEBC_VENDOR_TAG_BOOT_SERVERS)) \
105 == BIT (PXEBC_VENDOR_TAG_BOOT_SERVERS))
106
107#define IS_VALID_BOOT_PROMPT(x) \
108 ((((x)[0]) & BIT (PXEBC_VENDOR_TAG_MENU_PROMPT)) \
109 == BIT (PXEBC_VENDOR_TAG_MENU_PROMPT))
110
111#define IS_VALID_BOOT_MENU(x) \
112 ((((x)[0]) & BIT (PXEBC_VENDOR_TAG_BOOT_MENU)) \
113 == BIT (PXEBC_VENDOR_TAG_BOOT_MENU))
114
115#define IS_VALID_MTFTP_VENDOR_OPTION(x) \
116 (((UINT32) ((x)[0]) & MTFTP_VENDOR_OPTION_BIT_MAP) \
117 == MTFTP_VENDOR_OPTION_BIT_MAP)
118
119#define IS_VALID_DISCOVER_VENDOR_OPTION(x) \
120 (((UINT32) ((x)[0]) & DISCOVER_VENDOR_OPTION_BIT_MAP) != 0)
121
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))
125
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))
130
131#define SET_VENDOR_OPTION_BIT_MAP(x, y) \
132 (*(x + ((y) / 32)) = (UINT32) ((UINT32) ((x)[(y) / 32]) | BIT ((y) % 32)))
133
134#define GET_NEXT_DHCP_OPTION(Opt) \
135 (EFI_DHCP4_PACKET_OPTION *) ((UINT8 *) (Opt) + \
136 sizeof (EFI_DHCP4_PACKET_OPTION) + (Opt)->Length - 1)
137
138#define GET_OPTION_BUFFER_LEN(Pkt) \
139 ((Pkt)->Length - sizeof (EFI_DHCP4_HEADER) - 4)
140
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))
144
145#define IS_PROXY_DHCP_OFFER(Offer) \
146 EFI_IP4_EQUAL (&(Offer)->Dhcp4.Header.YourAddr, &mZeroIp4Addr)
147
148#define IS_DISABLE_BCAST_DISCOVER(x) \
149 (((x) & BIT (0)) == BIT (0))
150
151#define IS_DISABLE_MCAST_DISCOVER(x) \
152 (((x) & BIT (1)) == BIT (1))
153
154#define IS_ENABLE_USE_SERVER_LIST(x) \
155 (((x) & BIT (2)) == BIT (2))
156
157#define IS_DISABLE_PROMPT_MENU(x) \
158 (((x) & BIT (3)) == BIT (3))
159
160
161#pragma pack(1)
162typedef struct {
163 UINT8 ParaList[135];
164} PXEBC_DHCP4_OPTION_PARA;
165
166typedef struct {
167 UINT16 Size;
168} PXEBC_DHCP4_OPTION_MAX_MESG_SIZE;
169
170typedef struct {
171 UINT8 Type;
172 UINT8 MajorVer;
173 UINT8 MinorVer;
174} PXEBC_DHCP4_OPTION_UNDI;
175
176typedef struct {
177 UINT8 Type;
178} PXEBC_DHCP4_OPTION_MESG;
179
180typedef struct {
181 UINT16 Type;
182} PXEBC_DHCP4_OPTION_ARCH;
183
184typedef struct {
185 UINT8 ClassIdentifier[10];
186 UINT8 ArchitecturePrefix[5];
187 UINT8 ArchitectureType[5];
188 UINT8 Lit3[1];
189 UINT8 InterfaceName[4];
190 UINT8 Lit4[1];
191 UINT8 UndiMajor[3];
192 UINT8 UndiMinor[3];
193} PXEBC_DHCP4_OPTION_CLID;
194
195typedef struct {
196 UINT8 Type;
197 UINT8 Guid[16];
198} PXEBC_DHCP4_OPTION_UUID;
199
200typedef struct {
201 UINT16 Type;
202 UINT16 Layer;
203} PXEBC_OPTION_BOOT_ITEM;
204
205#pragma pack()
206
207typedef union {
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;
216
217#pragma pack(1)
218typedef struct {
219 UINT16 Type;
220 UINT8 IpCnt;
221 EFI_IPv4_ADDRESS IpAddr[1];
222} PXEBC_BOOT_SVR_ENTRY;
223
224typedef struct {
225 UINT16 Type;
226 UINT8 DescLen;
227 UINT8 DescStr[1];
228} PXEBC_BOOT_MENU_ENTRY;
229
230typedef struct {
231 UINT8 Timeout;
232 UINT8 Prompt[1];
233} PXEBC_MENU_PROMPT;
234#pragma pack()
235
236typedef struct {
237 UINT32 BitMap[8];
238 EFI_IPv4_ADDRESS MtftpIp;
239 UINT16 MtftpCPort;
240 UINT16 MtftpSPort;
241 UINT8 MtftpTimeout;
242 UINT8 MtftpDelay;
243 UINT8 DiscoverCtrl;
244 EFI_IPv4_ADDRESS DiscoverMcastIp;
245 EFI_IPv4_ADDRESS McastIpBase;
246 UINT16 McastIpBlock;
247 UINT16 McastIpRange;
248 UINT16 BootSrvType;
249 UINT16 BootSrvLayer;
250 PXEBC_BOOT_SVR_ENTRY *BootSvr;
251 UINT8 BootSvrLen;
252 PXEBC_BOOT_MENU_ENTRY *BootMenu;
253 UINT8 BootMenuLen;
254 PXEBC_MENU_PROMPT *MenuPrompt;
255 UINT8 MenuPromptLen;
256 UINT32 *CredType;
257 UINT8 CredTypeLen;
258} PXEBC_VENDOR_OPTION;
259
260#define PXEBC_CACHED_DHCP4_PACKET_MAX_SIZE (OFFSET_OF (EFI_DHCP4_PACKET, Dhcp4) + PXEBC_DHCP4_PACKET_MAX_SIZE)
261
262typedef union {
263 EFI_DHCP4_PACKET Offer;
264 EFI_DHCP4_PACKET Ack;
265 UINT8 Buffer[PXEBC_CACHED_DHCP4_PACKET_MAX_SIZE];
266} PXEBC_DHCP4_PACKET;
267
268typedef struct {
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;
274
275
276/**
277 Create a template DHCPv4 packet as a seed.
278
279 @param[out] Seed Pointer to the seed packet.
280 @param[in] Udp4 Pointer to EFI_UDP4_PROTOCOL.
281
282**/
283VOID
284PxeBcSeedDhcp4Packet (
285 OUT EFI_DHCP4_PACKET *Seed,
286 IN EFI_UDP4_PROTOCOL *Udp4
287 );
288
289
290/**
291 Parse the cached DHCPv4 packet, including all the options.
292
293 @param[in] Cache4 Pointer to cached DHCPv4 packet.
294
295 @retval EFI_SUCCESS Parsed the DHCPv4 packet successfully.
296 @retval EFI_DEVICE_ERROR Failed to parse and invalid packet.
297
298**/
299EFI_STATUS
300PxeBcParseDhcp4Packet (
301 IN PXEBC_DHCP4_PACKET_CACHE *Cache4
302 );
303
304
305/**
306 Build and send out the request packet for the bootfile, and parse the reply.
307
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.
315
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.
320
321**/
322EFI_STATUS
323PxeBcDhcp4Discover (
324 IN PXEBC_PRIVATE_DATA *Private,
325 IN UINT16 Type,
326 IN UINT16 *Layer,
327 IN BOOLEAN UseBis,
328 IN EFI_IP_ADDRESS *DestIp,
329 IN UINT16 IpCount,
330 IN EFI_PXE_BASE_CODE_SRVLIST *SrvList
331 );
332
333/**
334 Switch the Ip4 policy to static.
335
336 @param[in] Private The pointer to PXEBC_PRIVATE_DATA.
337
338 @retval EFI_SUCCESS The policy is already configured to static.
339 @retval Others Other error as indicated..
340
341**/
342EFI_STATUS
343PxeBcSetIp4Policy (
344 IN PXEBC_PRIVATE_DATA *Private
345 );
346
347
348/**
349 Start the D.O.R.A DHCPv4 process to acquire the IPv4 address and other PXE boot information.
350
351 @param[in] Private Pointer to PxeBc private data.
352 @param[in] Dhcp4 Pointer to the EFI_DHCP4_PROTOCOL
353
354 @retval EFI_SUCCESS The D.O.R.A process successfully finished.
355 @retval Others Failed to finish the D.O.R.A process.
356
357**/
358EFI_STATUS
359PxeBcDhcp4Dora (
360 IN PXEBC_PRIVATE_DATA *Private,
361 IN EFI_DHCP4_PROTOCOL *Dhcp4
362 );
363
364#endif
365
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette