]> git.proxmox.com Git - mirror_edk2.git/blame - MdePkg/Include/Protocol/PxeBaseCode.h
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Add PXE Tag Definitions for IA32/X64/Arm/IPF architectures.
[mirror_edk2.git] / MdePkg / Include / Protocol / PxeBaseCode.h
CommitLineData
d1f95000 1/** @file\r
4ca9b6c4
LG		 2 EFI PXE Base Code Protocol definitions, which is used to access PXE-compatible \r
3 devices for network access and network booting.\r
d1f95000 4\r
6e19836f 5 Copyright (c) 2006 - 2010, Intel Corporation \r
d1f95000 6 All rights reserved. This program and the accompanying materials \r
7 are licensed and made available under the terms and conditions of the BSD License \r
8 which accompanies this distribution. The full text of the license may be found at \r
9 http://opensource.org/licenses/bsd-license.php \r
10\r
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
5899caf0 12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
13\r
14 @par Revision Reference: \r
15 This Protocol is introduced in EFI Specification 1.10 \r
d1f95000 16\r
d1f95000 17**/\r
18#ifndef __PXE_BASE_CODE_PROTOCOL_H__\r
19#define __PXE_BASE_CODE_PROTOCOL_H__\r
20\r
99e8ed21 21///\r
22/// PXE Base Code protocol\r
23///\r
d1f95000 24#define EFI_PXE_BASE_CODE_PROTOCOL_GUID \\r
25 { \\r
26 0x03c4e603, 0xac28, 0x11d3, {0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \\r
27 }\r
28\r
a6508c05 29typedef struct _EFI_PXE_BASE_CODE_PROTOCOL EFI_PXE_BASE_CODE_PROTOCOL;\r
30\r
99e8ed21 31///\r
32/// Protocol defined in EFI1.1.\r
33/// \r
a6508c05 34typedef EFI_PXE_BASE_CODE_PROTOCOL EFI_PXE_BASE_CODE;\r
d1f95000 35\r
99e8ed21 36///\r
37/// Default IP TTL and ToS.\r
38///\r
d1f95000 39#define DEFAULT_TTL 16\r
40#define DEFAULT_ToS 0\r
41\r
99e8ed21 42///\r
43/// ICMP error format\r
44///\r
d1f95000 45typedef struct {\r
46 UINT8 Type;\r
47 UINT8 Code;\r
48 UINT16 Checksum;\r
49 union {\r
50 UINT32 reserved;\r
51 UINT32 Mtu;\r
52 UINT32 Pointer;\r
53 struct {\r
54 UINT16 Identifier;\r
55 UINT16 Sequence;\r
56 } Echo;\r
57 } u;\r
58 UINT8 Data[494];\r
59} EFI_PXE_BASE_CODE_ICMP_ERROR;\r
60\r
99e8ed21 61///\r
62/// TFTP error format\r
63///\r
d1f95000 64typedef struct {\r
65 UINT8 ErrorCode;\r
66 CHAR8 ErrorString[127];\r
67} EFI_PXE_BASE_CODE_TFTP_ERROR;\r
68\r
99e8ed21 69///\r
70/// IP Receive Filter definitions\r
71///\r
d1f95000 72#define EFI_PXE_BASE_CODE_MAX_IPCNT 8\r
73\r
9319d2c2
LG		 74///\r
75/// IP Receive Filter structure\r
76///\r
d1f95000 77typedef struct {\r
78 UINT8 Filters;\r
79 UINT8 IpCnt;\r
80 UINT16 reserved;\r
81 EFI_IP_ADDRESS IpList[EFI_PXE_BASE_CODE_MAX_IPCNT];\r
82} EFI_PXE_BASE_CODE_IP_FILTER;\r
83\r
84#define EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP 0x0001\r
85#define EFI_PXE_BASE_CODE_IP_FILTER_BROADCAST 0x0002\r
86#define EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS 0x0004\r
87#define EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS_MULTICAST 0x0008\r
88\r
99e8ed21 89///\r
9319d2c2 90/// ARP cache entries\r
99e8ed21 91///\r
d1f95000 92typedef struct {\r
93 EFI_IP_ADDRESS IpAddr;\r
94 EFI_MAC_ADDRESS MacAddr;\r
95} EFI_PXE_BASE_CODE_ARP_ENTRY;\r
96\r
9319d2c2
LG		 97///\r
98/// ARP route table entries\r
99///\r
d1f95000 100typedef struct {\r
101 EFI_IP_ADDRESS IpAddr;\r
102 EFI_IP_ADDRESS SubnetMask;\r
103 EFI_IP_ADDRESS GwAddr;\r
104} EFI_PXE_BASE_CODE_ROUTE_ENTRY;\r
105\r
106//\r
107// UDP definitions\r
108//\r
109typedef UINT16 EFI_PXE_BASE_CODE_UDP_PORT;\r
110\r
111#define EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_IP 0x0001\r
112#define EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT 0x0002\r
113#define EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_IP 0x0004\r
114#define EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_PORT 0x0008\r
115#define EFI_PXE_BASE_CODE_UDP_OPFLAGS_USE_FILTER 0x0010\r
116#define EFI_PXE_BASE_CODE_UDP_OPFLAGS_MAY_FRAGMENT 0x0020\r
117\r
118//\r
119// Discover() definitions\r
120//\r
121#define EFI_PXE_BASE_CODE_BOOT_TYPE_BOOTSTRAP 0\r
122#define EFI_PXE_BASE_CODE_BOOT_TYPE_MS_WINNT_RIS 1\r
123#define EFI_PXE_BASE_CODE_BOOT_TYPE_INTEL_LCM 2\r
124#define EFI_PXE_BASE_CODE_BOOT_TYPE_DOSUNDI 3\r
125#define EFI_PXE_BASE_CODE_BOOT_TYPE_NEC_ESMPRO 4\r
126#define EFI_PXE_BASE_CODE_BOOT_TYPE_IBM_WSoD 5\r
127#define EFI_PXE_BASE_CODE_BOOT_TYPE_IBM_LCCM 6\r
128#define EFI_PXE_BASE_CODE_BOOT_TYPE_CA_UNICENTER_TNG 7\r
129#define EFI_PXE_BASE_CODE_BOOT_TYPE_HP_OPENVIEW 8\r
130#define EFI_PXE_BASE_CODE_BOOT_TYPE_ALTIRIS_9 9\r
131#define EFI_PXE_BASE_CODE_BOOT_TYPE_ALTIRIS_10 10\r
132#define EFI_PXE_BASE_CODE_BOOT_TYPE_ALTIRIS_11 11\r
133#define EFI_PXE_BASE_CODE_BOOT_TYPE_NOT_USED_12 12\r
134#define EFI_PXE_BASE_CODE_BOOT_TYPE_REDHAT_INSTALL 13\r
135#define EFI_PXE_BASE_CODE_BOOT_TYPE_REDHAT_BOOT 14\r
136#define EFI_PXE_BASE_CODE_BOOT_TYPE_REMBO 15\r
137#define EFI_PXE_BASE_CODE_BOOT_TYPE_BEOBOOT 16\r
138//\r
139// 17 through 32767 are reserved\r
140// 32768 through 65279 are for vendor use\r
141// 65280 through 65534 are reserved\r
142//\r
143#define EFI_PXE_BASE_CODE_BOOT_TYPE_PXETEST 65535\r
144\r
145#define EFI_PXE_BASE_CODE_BOOT_LAYER_MASK 0x7FFF\r
146#define EFI_PXE_BASE_CODE_BOOT_LAYER_INITIAL 0x0000\r
147\r
5fb89a0b 148//\r
149// PXE Tag definition that identifies the processor \r
150// and programming environment of the client system.\r
151//\r
152#if defined (MDE_CPU_IA32)\r
153#define EFI_PXE_CLIENT_SYSTEM_ARCHITECTURE 0x0006\r
154#elif defined (MDE_CPU_IPF) \r
155#define EFI_PXE_CLIENT_SYSTEM_ARCHITECTURE 0x0002\r
156#elif defined (MDE_CPU_X64)\r
157#define EFI_PXE_CLIENT_SYSTEM_ARCHITECTURE 0x0007\r
158#elif defined (MDE_CPU_ARM)\r
159#define EFI_PXE_CLIENT_SYSTEM_ARCHITECTURE 0x000A\r
160#endif\r
161\r
162\r
99e8ed21 163///\r
164/// Discover() server list structure.\r
165///\r
d1f95000 166typedef struct {\r
167 UINT16 Type;\r
168 BOOLEAN AcceptAnyResponse;\r
169 UINT8 Reserved;\r
170 EFI_IP_ADDRESS IpAddr;\r
171} EFI_PXE_BASE_CODE_SRVLIST;\r
172\r
99e8ed21 173///\r
174/// Discover() information override structure.\r
175///\r
d1f95000 176typedef struct {\r
177 BOOLEAN UseMCast;\r
178 BOOLEAN UseBCast;\r
179 BOOLEAN UseUCast;\r
180 BOOLEAN MustUseList;\r
181 EFI_IP_ADDRESS ServerMCastIp;\r
182 UINT16 IpCnt;\r
183 EFI_PXE_BASE_CODE_SRVLIST SrvList[1];\r
184} EFI_PXE_BASE_CODE_DISCOVER_INFO;\r
185\r
99e8ed21 186///\r
9319d2c2 187/// TFTP opcode definitions\r
99e8ed21 188///\r
d1f95000 189typedef enum {\r
190 EFI_PXE_BASE_CODE_TFTP_FIRST,\r
191 EFI_PXE_BASE_CODE_TFTP_GET_FILE_SIZE,\r
192 EFI_PXE_BASE_CODE_TFTP_READ_FILE,\r
193 EFI_PXE_BASE_CODE_TFTP_WRITE_FILE,\r
194 EFI_PXE_BASE_CODE_TFTP_READ_DIRECTORY,\r
195 EFI_PXE_BASE_CODE_MTFTP_GET_FILE_SIZE,\r
196 EFI_PXE_BASE_CODE_MTFTP_READ_FILE,\r
197 EFI_PXE_BASE_CODE_MTFTP_READ_DIRECTORY,\r
198 EFI_PXE_BASE_CODE_MTFTP_LAST\r
199} EFI_PXE_BASE_CODE_TFTP_OPCODE;\r
200\r
9319d2c2
LG		 201///\r
202/// MTFTP information. This information is required\r
203/// to start or join a multicast TFTP session. It is also required to\r
204/// perform the "get file size" and "read directory" operations of MTFTP.\r
205///\r
d1f95000 206typedef struct {\r
207 EFI_IP_ADDRESS MCastIp;\r
208 EFI_PXE_BASE_CODE_UDP_PORT CPort;\r
209 EFI_PXE_BASE_CODE_UDP_PORT SPort;\r
210 UINT16 ListenTimeout;\r
211 UINT16 TransmitTimeout;\r
212} EFI_PXE_BASE_CODE_MTFTP_INFO;\r
213\r
3ed785e9 214///\r
9319d2c2 215/// DHCPV4 Packet structure\r
3ed785e9 216///\r
217typedef struct {\r
218 UINT8 BootpOpcode;\r
219 UINT8 BootpHwType;\r
220 UINT8 BootpHwAddrLen;\r
221 UINT8 BootpGateHops;\r
222 UINT32 BootpIdent;\r
223 UINT16 BootpSeconds;\r
224 UINT16 BootpFlags;\r
225 UINT8 BootpCiAddr[4];\r
226 UINT8 BootpYiAddr[4];\r
227 UINT8 BootpSiAddr[4];\r
228 UINT8 BootpGiAddr[4];\r
229 UINT8 BootpHwAddr[16];\r
230 UINT8 BootpSrvName[64];\r
231 UINT8 BootpBootFile[128];\r
232 UINT32 DhcpMagik;\r
233 UINT8 DhcpOptions[56];\r
234} EFI_PXE_BASE_CODE_DHCPV4_PACKET;\r
235\r
6e19836f 236///\r
237/// Note: EFI_PXE_BASE_CODE_DHCPV6_PACKET and EFI_PXE_BASE_CODE_PACKET are not\r
238/// consistent with the current UEFI2.3 specification. It's supposed that\r
239/// they will be consistent in the next version.\r
240///\r
241\r
242///\r
243/// DHCPV6 Packet structure.\r
244///\r
245typedef struct {\r
246 UINT32 MessageType:8;\r
247 UINT32 TransactionId:24;\r
248 UINT8 DhcpOptions[1024];\r
249} EFI_PXE_BASE_CODE_DHCPV6_PACKET;\r
250\r
9319d2c2
LG		 251///\r
252/// Packet structure\r
253///\r
3ed785e9 254typedef union {\r
255 UINT8 Raw[1472];\r
256 EFI_PXE_BASE_CODE_DHCPV4_PACKET Dhcpv4;\r
6e19836f 257 EFI_PXE_BASE_CODE_DHCPV6_PACKET Dhcpv6;\r
3ed785e9 258} EFI_PXE_BASE_CODE_PACKET;\r
259\r
d1f95000 260//\r
261// PXE Base Code Mode structure\r
262//\r
263#define EFI_PXE_BASE_CODE_MAX_ARP_ENTRIES 8\r
264#define EFI_PXE_BASE_CODE_MAX_ROUTE_ENTRIES 8\r
265\r
9319d2c2
LG		 266///\r
267/// EFI_PXE_BASE_CODE_MODE\r
268/// The data values in this structure are read-only and \r
269/// are updated by the code that produces the\r
270/// EFI_PXE_BASE_CODE_PROTOCOL functions.\r
271///\r
d1f95000 272typedef struct {\r
273 BOOLEAN Started;\r
274 BOOLEAN Ipv6Available;\r
275 BOOLEAN Ipv6Supported;\r
276 BOOLEAN UsingIpv6;\r
277 BOOLEAN BisSupported;\r
278 BOOLEAN BisDetected;\r
279 BOOLEAN AutoArp;\r
280 BOOLEAN SendGUID;\r
281 BOOLEAN DhcpDiscoverValid;\r
282 BOOLEAN DhcpAckReceived;\r
283 BOOLEAN ProxyOfferReceived;\r
284 BOOLEAN PxeDiscoverValid;\r
285 BOOLEAN PxeReplyReceived;\r
286 BOOLEAN PxeBisReplyReceived;\r
287 BOOLEAN IcmpErrorReceived;\r
288 BOOLEAN TftpErrorReceived;\r
289 BOOLEAN MakeCallbacks;\r
290 UINT8 TTL;\r
291 UINT8 ToS;\r
292 EFI_IP_ADDRESS StationIp;\r
293 EFI_IP_ADDRESS SubnetMask;\r
294 EFI_PXE_BASE_CODE_PACKET DhcpDiscover;\r
295 EFI_PXE_BASE_CODE_PACKET DhcpAck;\r
296 EFI_PXE_BASE_CODE_PACKET ProxyOffer;\r
297 EFI_PXE_BASE_CODE_PACKET PxeDiscover;\r
298 EFI_PXE_BASE_CODE_PACKET PxeReply;\r
299 EFI_PXE_BASE_CODE_PACKET PxeBisReply;\r
300 EFI_PXE_BASE_CODE_IP_FILTER IpFilter;\r
301 UINT32 ArpCacheEntries;\r
302 EFI_PXE_BASE_CODE_ARP_ENTRY ArpCache[EFI_PXE_BASE_CODE_MAX_ARP_ENTRIES];\r
303 UINT32 RouteTableEntries;\r
304 EFI_PXE_BASE_CODE_ROUTE_ENTRY RouteTable[EFI_PXE_BASE_CODE_MAX_ROUTE_ENTRIES];\r
305 EFI_PXE_BASE_CODE_ICMP_ERROR IcmpError;\r
306 EFI_PXE_BASE_CODE_TFTP_ERROR TftpError;\r
307} EFI_PXE_BASE_CODE_MODE;\r
308\r
309//\r
310// PXE Base Code Interface Function definitions\r
311//\r
312\r
313/** \r
314 Enables the use of the PXE Base Code Protocol functions.\r
f737cfb9 315\r
316 This function enables the use of the PXE Base Code Protocol functions. If the\r
317 Started field of the EFI_PXE_BASE_CODE_MODE structure is already TRUE, then\r
318 EFI_ALREADY_STARTED will be returned. If UseIpv6 is TRUE, then IPv6 formatted\r
319 addresses will be used in this session. If UseIpv6 is FALSE, then IPv4 formatted\r
320 addresses will be used in this session. If UseIpv6 is TRUE, and the Ipv6Supported\r
321 field of the EFI_PXE_BASE_CODE_MODE structure is FALSE, then EFI_UNSUPPORTED will\r
322 be returned. If there is not enough memory or other resources to start the PXE\r
323 Base Code Protocol, then EFI_OUT_OF_RESOURCES will be returned. Otherwise, the\r
324 PXE Base Code Protocol will be started, and all of the fields of the EFI_PXE_BASE_CODE_MODE\r
325 structure will be initialized as follows:\r
326 StartedSet to TRUE.\r
327 Ipv6SupportedUnchanged.\r
328 Ipv6AvailableUnchanged.\r
329 UsingIpv6Set to UseIpv6.\r
330 BisSupportedUnchanged.\r
331 BisDetectedUnchanged.\r
332 AutoArpSet to TRUE.\r
333 SendGUIDSet to FALSE.\r
334 TTLSet to DEFAULT_TTL.\r
335 ToSSet to DEFAULT_ToS.\r
336 DhcpCompletedSet to FALSE.\r
337 ProxyOfferReceivedSet to FALSE.\r
338 StationIpSet to an address of all zeros.\r
339 SubnetMaskSet to a subnet mask of all zeros.\r
340 DhcpDiscoverZero-filled.\r
341 DhcpAckZero-filled.\r
342 ProxyOfferZero-filled.\r
343 PxeDiscoverValidSet to FALSE.\r
344 PxeDiscoverZero-filled.\r
345 PxeReplyValidSet to FALSE.\r
346 PxeReplyZero-filled.\r
347 PxeBisReplyValidSet to FALSE.\r
348 PxeBisReplyZero-filled.\r
349 IpFilterSet the Filters field to 0 and the IpCnt field to 0.\r
350 ArpCacheEntriesSet to 0.\r
351 ArpCacheZero-filled.\r
352 RouteTableEntriesSet to 0.\r
353 RouteTableZero-filled.\r
354 IcmpErrorReceivedSet to FALSE.\r
355 IcmpErrorZero-filled.\r
356 TftpErroReceivedSet to FALSE.\r
357 TftpErrorZero-filled.\r
358 MakeCallbacksSet to TRUE if the PXE Base Code Callback Protocol is available.\r
359 Set to FALSE if the PXE Base Code Callback Protocol is not available.\r
d1f95000 360 \r
361 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
362 @param UseIpv6 Specifies the type of IP addresses that are to be used during the session\r
363 that is being started. Set to TRUE for IPv6 addresses, and FALSE for \r
364 IPv4 addresses. \r
365 \r
366 @retval EFI_SUCCESS The PXE Base Code Protocol was started.\r
367 @retval EFI_DEVICE_ERROR The network device encountered an error during this oper \r
368 @retval EFI_UNSUPPORTED UseIpv6 is TRUE, but the Ipv6Supported field of the\r
369 EFI_PXE_BASE_CODE_MODE structure is FALSE. \r
370 @retval EFI_ALREADY_STARTED The PXE Base Code Protocol is already in the started state. \r
371 @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid\r
372 EFI_PXE_BASE_CODE_PROTOCOL structure. \r
373 @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory or other resources to start the \r
374 PXE Base Code Protocol. \r
375 \r
376**/\r
377typedef\r
378EFI_STATUS\r
8b13229b 379(EFIAPI *EFI_PXE_BASE_CODE_START)(\r
d1f95000 380 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
381 IN BOOLEAN UseIpv6\r
382 );\r
383\r
384/** \r
385 Disables the use of the PXE Base Code Protocol functions.\r
f737cfb9 386\r
387 This function stops all activity on the network device. All the resources allocated\r
388 in Start() are released, the Started field of the EFI_PXE_BASE_CODE_MODE structure is\r
389 set to FALSE and EFI_SUCCESS is returned. If the Started field of the EFI_PXE_BASE_CODE_MODE\r
390 structure is already FALSE, then EFI_NOT_STARTED will be returned.\r
391 \r
d1f95000 392 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
393 \r
394 @retval EFI_SUCCESS The PXE Base Code Protocol was stopped.\r
395 @retval EFI_NOT_STARTED The PXE Base Code Protocol is already in the stopped state. \r
396 @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid\r
397 EFI_PXE_BASE_CODE_PROTOCOL structure. \r
398 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation. \r
399 \r
400**/\r
401typedef\r
402EFI_STATUS\r
8b13229b 403(EFIAPI *EFI_PXE_BASE_CODE_STOP)(\r
d1f95000 404 IN EFI_PXE_BASE_CODE_PROTOCOL *This\r
405 );\r
406\r
407/** \r
408 Attempts to complete a DHCPv4 D.O.R.A. (discover / offer / request / acknowledge) or DHCPv6\r
409 S.A.R.R (solicit / advertise / request / reply) sequence.\r
f737cfb9 410\r
411 This function attempts to complete the DHCP sequence. If this sequence is completed,\r
412 then EFI_SUCCESS is returned, and the DhcpCompleted, ProxyOfferReceived, StationIp,\r
413 SubnetMask, DhcpDiscover, DhcpAck, and ProxyOffer fields of the EFI_PXE_BASE_CODE_MODE\r
414 structure are filled in.\r
415 If SortOffers is TRUE, then the cached DHCP offer packets will be sorted before\r
416 they are tried. If SortOffers is FALSE, then the cached DHCP offer packets will\r
417 be tried in the order in which they are received. Please see the Preboot Execution\r
418 Environment (PXE) Specification for additional details on the implementation of DHCP.\r
419 This function can take at least 31 seconds to timeout and return control to the\r
420 caller. If the DHCP sequence does not complete, then EFI_TIMEOUT will be returned.\r
421 If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,\r
422 then the DHCP sequence will be stopped and EFI_ABORTED will be returned.\r
d1f95000 423 \r
424 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
425 @param SortOffers TRUE if the offers received should be sorted. Set to FALSE to try the\r
426 offers in the order that they are received. \r
427 \r
428 @retval EFI_SUCCESS Valid DHCP has completed.\r
429 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
430 @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid\r
431 EFI_PXE_BASE_CODE_PROTOCOL structure. \r
432 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation. \r
433 @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory to complete the DHCP Protocol.\r
434 @retval EFI_ABORTED The callback function aborted the DHCP Protocol.\r
435 @retval EFI_TIMEOUT The DHCP Protocol timed out.\r
436 @retval EFI_ICMP_ERROR An ICMP error packet was received during the DHCP session.\r
437 @retval EFI_NO_RESPONSE Valid PXE offer was not received.\r
438 \r
439**/\r
440typedef\r
441EFI_STATUS\r
8b13229b 442(EFIAPI *EFI_PXE_BASE_CODE_DHCP)(\r
d1f95000 443 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
444 IN BOOLEAN SortOffers\r
445 );\r
446\r
447/** \r
448 Attempts to complete the PXE Boot Server and/or boot image discovery sequence.\r
f737cfb9 449\r
450 This function attempts to complete the PXE Boot Server and/or boot image discovery\r
451 sequence. If this sequence is completed, then EFI_SUCCESS is returned, and the\r
452 PxeDiscoverValid, PxeDiscover, PxeReplyReceived, and PxeReply fields of the\r
453 EFI_PXE_BASE_CODE_MODE structure are filled in. If UseBis is TRUE, then the\r
454 PxeBisReplyReceived and PxeBisReply fields of the EFI_PXE_BASE_CODE_MODE structure\r
455 will also be filled in. If UseBis is FALSE, then PxeBisReplyValid will be set to FALSE.\r
456 In the structure referenced by parameter Info, the PXE Boot Server list, SrvList[],\r
457 has two uses: It is the Boot Server IP address list used for unicast discovery\r
458 (if the UseUCast field is TRUE), and it is the list used for Boot Server verification\r
459 (if the MustUseList field is TRUE). Also, if the MustUseList field in that structure\r
460 is TRUE and the AcceptAnyResponse field in the SrvList[] array is TRUE, any Boot\r
461 Server reply of that type will be accepted. If the AcceptAnyResponse field is\r
462 FALSE, only responses from Boot Servers with matching IP addresses will be accepted.\r
463 This function can take at least 10 seconds to timeout and return control to the\r
464 caller. If the Discovery sequence does not complete, then EFI_TIMEOUT will be\r
465 returned. Please see the Preboot Execution Environment (PXE) Specification for\r
466 additional details on the implementation of the Discovery sequence.\r
467 If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,\r
468 then the Discovery sequence is stopped and EFI_ABORTED will be returned.\r
d1f95000 469 \r
470 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
471 @param Type The type of bootstrap to perform.\r
472 @param Layer Pointer to the boot server layer number to discover, which must be\r
473 PXE_BOOT_LAYER_INITIAL when a new server type is being \r
474 discovered. \r
475 @param UseBis TRUE if Boot Integrity Services are to be used. FALSE otherwise. \r
476 @param Info Pointer to a data structure that contains additional information on the\r
477 type of discovery operation that is to be performed. \r
478 \r
479 @retval EFI_SUCCESS The Discovery sequence has been completed.\r
480 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
481 @retval EFI_INVALID_PARAMETER One or more parameters are invalid. \r
482 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation. \r
483 @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory to complete Discovery.\r
484 @retval EFI_ABORTED The callback function aborted the Discovery sequence.\r
485 @retval EFI_TIMEOUT The Discovery sequence timed out.\r
486 @retval EFI_ICMP_ERROR An ICMP error packet was received during the PXE discovery\r
487 session. \r
488 \r
489**/\r
490typedef\r
491EFI_STATUS\r
8b13229b 492(EFIAPI *EFI_PXE_BASE_CODE_DISCOVER)(\r
d1f95000 493 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
494 IN UINT16 Type,\r
495 IN UINT16 *Layer,\r
496 IN BOOLEAN UseBis,\r
497 IN EFI_PXE_BASE_CODE_DISCOVER_INFO *Info OPTIONAL\r
498 );\r
499\r
500/** \r
501 Used to perform TFTP and MTFTP services.\r
f737cfb9 502\r
503 This function is used to perform TFTP and MTFTP services. This includes the\r
504 TFTP operations to get the size of a file, read a directory, read a file, and\r
505 write a file. It also includes the MTFTP operations to get the size of a file,\r
506 read a directory, and read a file. The type of operation is specified by Operation.\r
507 If the callback function that is invoked during the TFTP/MTFTP operation does\r
508 not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED will\r
509 be returned.\r
510 For read operations, the return data will be placed in the buffer specified by\r
511 BufferPtr. If BufferSize is too small to contain the entire downloaded file,\r
512 then EFI_BUFFER_TOO_SMALL will be returned and BufferSize will be set to zero\r
513 or the size of the requested file (the size of the requested file is only returned\r
514 if the TFTP server supports TFTP options). If BufferSize is large enough for the\r
515 read operation, then BufferSize will be set to the size of the downloaded file,\r
516 and EFI_SUCCESS will be returned. Applications using the PxeBc.Mtftp() services\r
517 should use the get-file-size operations to determine the size of the downloaded\r
518 file prior to using the read-file operations--especially when downloading large\r
519 (greater than 64 MB) files--instead of making two calls to the read-file operation.\r
520 Following this recommendation will save time if the file is larger than expected\r
521 and the TFTP server does not support TFTP option extensions. Without TFTP option\r
522 extension support, the client has to download the entire file, counting and discarding\r
523 the received packets, to determine the file size.\r
524 For write operations, the data to be sent is in the buffer specified by BufferPtr.\r
525 BufferSize specifies the number of bytes to send. If the write operation completes\r
526 successfully, then EFI_SUCCESS will be returned.\r
2f5c655a 527 For TFTP "get file size" operations, the size of the requested file or directory\r
f737cfb9 528 is returned in BufferSize, and EFI_SUCCESS will be returned. If the TFTP server\r
529 does not support options, the file will be downloaded into a bit bucket and the\r
2f5c655a 530 length of the downloaded file will be returned. For MTFTP "get file size" operations,\r
531 if the MTFTP server does not support the "get file size" option, EFI_UNSUPPORTED\r
f737cfb9 532 will be returned.\r
533 This function can take up to 10 seconds to timeout and return control to the caller.\r
534 If the TFTP sequence does not complete, EFI_TIMEOUT will be returned.\r
535 If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,\r
536 then the TFTP sequence is stopped and EFI_ABORTED will be returned.\r
537 The format of the data returned from a TFTP read directory operation is a null-terminated\r
538 filename followed by a null-terminated information string, of the form\r
2f5c655a 539 "size year-month-day hour:minute:second" (i.e. %d %d-%d-%d %d:%d:%f - note that\r
f737cfb9 540 the seconds field can be a decimal number), where the date and time are UTC. For\r
541 an MTFTP read directory command, there is additionally a null-terminated multicast\r
542 IP address preceding the filename of the form %d.%d.%d.%d for IP v4. The final\r
543 entry is itself null-terminated, so that the final information string is terminated\r
544 with two null octets.\r
d1f95000 545 \r
546 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
547 @param Operation The type of operation to perform.\r
548 @param BufferPtr A pointer to the data buffer. \r
549 @param Overwrite Only used on write file operations. TRUE if a file on a remote server can\r
550 be overwritten. \r
551 @param BufferSize For get-file-size operations, *BufferSize returns the size of the\r
552 requested file. \r
553 @param BlockSize The requested block size to be used during a TFTP transfer.\r
554 @param ServerIp The TFTP / MTFTP server IP address.\r
555 @param Filename A Null-terminated ASCII string that specifies a directory name or a file\r
556 name. \r
557 @param Info Pointer to the MTFTP information.\r
558 @param DontUseBuffer Set to FALSE for normal TFTP and MTFTP read file operation. \r
559 \r
560 @retval EFI_SUCCESS The TFTP/MTFTP operation was completed.\r
561 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
562 @retval EFI_INVALID_PARAMETER One or more parameters are invalid. \r
563 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation. \r
564 @retval EFI_BUFFER_TOO_SMALL The buffer is not large enough to complete the read operation. \r
565 @retval EFI_ABORTED The callback function aborted the TFTP/MTFTP operation.\r
566 @retval EFI_TIMEOUT The TFTP/MTFTP operation timed out.\r
567 @retval EFI_ICMP_ERROR An ICMP error packet was received during the MTFTP session.\r
568 @retval EFI_TFTP_ERROR A TFTP error packet was received during the MTFTP session.\r
569 \r
570**/\r
571typedef\r
572EFI_STATUS\r
8b13229b 573(EFIAPI *EFI_PXE_BASE_CODE_MTFTP)(\r
d1f95000 574 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
575 IN EFI_PXE_BASE_CODE_TFTP_OPCODE Operation,\r
576 IN OUT VOID *BufferPtr OPTIONAL,\r
577 IN BOOLEAN Overwrite,\r
578 IN OUT UINT64 *BufferSize,\r
579 IN UINTN *BlockSize OPTIONAL,\r
580 IN EFI_IP_ADDRESS *ServerIp,\r
581 IN UINT8 *Filename OPTIONAL,\r
582 IN EFI_PXE_BASE_CODE_MTFTP_INFO *Info OPTIONAL,\r
583 IN BOOLEAN DontUseBuffer\r
584 );\r
585\r
586/** \r
587 Writes a UDP packet to the network interface.\r
f737cfb9 588\r
589 This function writes a UDP packet specified by the (optional HeaderPtr and)\r
590 BufferPtr parameters to the network interface. The UDP header is automatically\r
591 built by this routine. It uses the parameters OpFlags, DestIp, DestPort, GatewayIp,\r
592 SrcIp, and SrcPort to build this header. If the packet is successfully built and\r
593 transmitted through the network interface, then EFI_SUCCESS will be returned.\r
594 If a timeout occurs during the transmission of the packet, then EFI_TIMEOUT will\r
595 be returned. If an ICMP error occurs during the transmission of the packet, then\r
596 the IcmpErrorReceived field is set to TRUE, the IcmpError field is filled in and\r
597 EFI_ICMP_ERROR will be returned. If the Callback Protocol does not return\r
598 EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED will be returned.\r
d1f95000 599 \r
600 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
601 @param OpFlags The UDP operation flags. \r
602 @param DestIp The destination IP address.\r
603 @param DestPort The destination UDP port number. \r
604 @param GatewayIp The gateway IP address. \r
605 @param SrcIp The source IP address.\r
606 @param SrcPort The source UDP port number.\r
607 @param HeaderSize An optional field which may be set to the length of a header at\r
608 HeaderPtr to be prefixed to the data at BufferPtr. \r
609 @param HeaderPtr If HeaderSize is not NULL, a pointer to a header to be prefixed to the\r
610 data at BufferPtr. \r
611 @param BufferSize A pointer to the size of the data at BufferPtr.\r
612 @param BufferPtr A pointer to the data to be written.\r
613 \r
614 @retval EFI_SUCCESS The UDP Write operation was completed.\r
615 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
616 @retval EFI_INVALID_PARAMETER One or more parameters are invalid. \r
617 @retval EFI_BAD_BUFFER_SIZE The buffer is too long to be transmitted. \r
618 @retval EFI_ABORTED The callback function aborted the UDP Write operation.\r
619 @retval EFI_TIMEOUT The UDP Write operation timed out.\r
620 @retval EFI_ICMP_ERROR An ICMP error packet was received during the UDP write session. \r
621 \r
622**/\r
623typedef\r
624EFI_STATUS\r
8b13229b 625(EFIAPI *EFI_PXE_BASE_CODE_UDP_WRITE)(\r
d1f95000 626 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
627 IN UINT16 OpFlags,\r
628 IN EFI_IP_ADDRESS *DestIp,\r
629 IN EFI_PXE_BASE_CODE_UDP_PORT *DestPort,\r
630 IN EFI_IP_ADDRESS *GatewayIp, OPTIONAL\r
631 IN EFI_IP_ADDRESS *SrcIp, OPTIONAL\r
632 IN OUT EFI_PXE_BASE_CODE_UDP_PORT *SrcPort, OPTIONAL\r
633 IN UINTN *HeaderSize, OPTIONAL\r
634 IN VOID *HeaderPtr, OPTIONAL\r
635 IN UINTN *BufferSize,\r
636 IN VOID *BufferPtr\r
637 );\r
638\r
639/** \r
640 Reads a UDP packet from the network interface.\r
f737cfb9 641\r
642 This function reads a UDP packet from a network interface. The data contents\r
643 are returned in (the optional HeaderPtr and) BufferPtr, and the size of the\r
644 buffer received is returned in BufferSize . If the input BufferSize is smaller\r
645 than the UDP packet received (less optional HeaderSize), it will be set to the\r
646 required size, and EFI_BUFFER_TOO_SMALL will be returned. In this case, the\r
647 contents of BufferPtr are undefined, and the packet is lost. If a UDP packet is\r
648 successfully received, then EFI_SUCCESS will be returned, and the information\r
649 from the UDP header will be returned in DestIp, DestPort, SrcIp, and SrcPort if\r
650 they are not NULL.\r
651 Depending on the values of OpFlags and the DestIp, DestPort, SrcIp, and SrcPort\r
652 input values, different types of UDP packet receive filtering will be performed.\r
653 The following tables summarize these receive filter operations.\r
d1f95000 654 \r
655 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
656 @param OpFlags The UDP operation flags. \r
657 @param DestIp The destination IP address.\r
f737cfb9 658 @param DestPort The destination UDP port number.\r
d1f95000 659 @param SrcIp The source IP address.\r
660 @param SrcPort The source UDP port number.\r
661 @param HeaderSize An optional field which may be set to the length of a header at\r
662 HeaderPtr to be prefixed to the data at BufferPtr. \r
663 @param HeaderPtr If HeaderSize is not NULL, a pointer to a header to be prefixed to the\r
664 data at BufferPtr. \r
665 @param BufferSize A pointer to the size of the data at BufferPtr.\r
666 @param BufferPtr A pointer to the data to be read.\r
667 \r
f737cfb9 668 @retval EFI_SUCCESS The UDP Read operation was completed.\r
d1f95000 669 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
670 @retval EFI_INVALID_PARAMETER One or more parameters are invalid. \r
671 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r
672 @retval EFI_BUFFER_TOO_SMALL The packet is larger than Buffer can hold.\r
673 @retval EFI_ABORTED The callback function aborted the UDP Read operation.\r
674 @retval EFI_TIMEOUT The UDP Read operation timed out. \r
675 \r
676**/\r
677typedef\r
678EFI_STATUS\r
8b13229b 679(EFIAPI *EFI_PXE_BASE_CODE_UDP_READ)(\r
d1f95000 680 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
681 IN UINT16 OpFlags,\r
682 IN OUT EFI_IP_ADDRESS *DestIp, OPTIONAL\r
683 IN OUT EFI_PXE_BASE_CODE_UDP_PORT *DestPort, OPTIONAL\r
684 IN OUT EFI_IP_ADDRESS *SrcIp, OPTIONAL\r
685 IN OUT EFI_PXE_BASE_CODE_UDP_PORT *SrcPort, OPTIONAL\r
686 IN UINTN *HeaderSize, OPTIONAL\r
687 IN VOID *HeaderPtr, OPTIONAL\r
688 IN OUT UINTN *BufferSize,\r
689 IN VOID *BufferPtr\r
690 );\r
691\r
692/** \r
693 Updates the IP receive filters of a network device and enables software filtering.\r
f737cfb9 694 \r
695 The NewFilter field is used to modify the network device's current IP receive\r
696 filter settings and to enable a software filter. This function updates the IpFilter\r
697 field of the EFI_PXE_BASE_CODE_MODE structure with the contents of NewIpFilter.\r
698 The software filter is used when the USE_FILTER in OpFlags is set to UdpRead().\r
699 The current hardware filter remains in effect no matter what the settings of OpFlags\r
700 are, so that the meaning of ANY_DEST_IP set in OpFlags to UdpRead() is from those\r
2f5c655a 701 packets whose reception is enabled in hardware - physical NIC address (unicast),\r
f737cfb9 702 broadcast address, logical address or addresses (multicast), or all (promiscuous).\r
703 UdpRead() does not modify the IP filter settings.\r
704 Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP receive\r
705 filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.\r
706 If an application or driver wishes to preserve the IP receive filter settings,\r
707 it will have to preserve the IP receive filter settings before these calls, and\r
708 use SetIpFilter() to restore them after the calls. If incompatible filtering is\r
709 requested (for example, PROMISCUOUS with anything else) or if the device does not\r
710 support a requested filter setting and it cannot be accommodated in software\r
711 (for example, PROMISCUOUS not supported), EFI_INVALID_PARAMETER will be returned.\r
712 The IPlist field is used to enable IPs other than the StationIP. They may be\r
713 multicast or unicast. If IPcnt is set as well as EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP,\r
714 then both the StationIP and the IPs from the IPlist will be used.\r
d1f95000 715 \r
716 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
717 @param NewFilter Pointer to the new set of IP receive filters.\r
718 \r
719 @retval EFI_SUCCESS The IP receive filter settings were updated.\r
720 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
721 @retval EFI_INVALID_PARAMETER One or more parameters are invalid. \r
722 \r
723**/\r
724typedef\r
725EFI_STATUS\r
8b13229b 726(EFIAPI *EFI_PXE_BASE_CODE_SET_IP_FILTER)(\r
d1f95000 727 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
728 IN EFI_PXE_BASE_CODE_IP_FILTER *NewFilter\r
729 );\r
730\r
731/** \r
732 Uses the ARP protocol to resolve a MAC address.\r
f737cfb9 733 \r
734 This function uses the ARP protocol to resolve a MAC address. The UsingIpv6 field\r
735 of the EFI_PXE_BASE_CODE_MODE structure is used to determine if IPv4 or IPv6\r
736 addresses are being used. The IP address specified by IpAddr is used to resolve\r
737 a MAC address. If the ARP protocol succeeds in resolving the specified address,\r
738 then the ArpCacheEntries and ArpCache fields of the EFI_PXE_BASE_CODE_MODE structure\r
739 are updated, and EFI_SUCCESS is returned. If MacAddr is not NULL, the resolved\r
740 MAC address is placed there as well.\r
741 If the PXE Base Code protocol is in the stopped state, then EFI_NOT_STARTED is\r
742 returned. If the ARP protocol encounters a timeout condition while attempting\r
743 to resolve an address, then EFI_TIMEOUT is returned. If the Callback Protocol\r
744 does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED is\r
745 returned.\r
d1f95000 746 \r
747 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
748 @param IpAddr Pointer to the IP address that is used to resolve a MAC address.\r
749 @param MacAddr If not NULL, a pointer to the MAC address that was resolved with the\r
750 ARP protocol. \r
751 \r
752 @retval EFI_SUCCESS The IP or MAC address was resolved.\r
753 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
754 @retval EFI_INVALID_PARAMETER One or more parameters are invalid. \r
755 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation. \r
756 @retval EFI_ABORTED The callback function aborted the ARP Protocol.\r
757 @retval EFI_TIMEOUT The ARP Protocol encountered a timeout condition.\r
758 \r
759**/\r
760typedef\r
761EFI_STATUS\r
8b13229b 762(EFIAPI *EFI_PXE_BASE_CODE_ARP)(\r
d1f95000 763 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
764 IN EFI_IP_ADDRESS *IpAddr,\r
765 IN EFI_MAC_ADDRESS *MacAddr OPTIONAL\r
766 );\r
767\r
768/** \r
769 Updates the parameters that affect the operation of the PXE Base Code Protocol.\r
f737cfb9 770 \r
771 This function sets parameters that affect the operation of the PXE Base Code Protocol.\r
772 The parameter specified by NewAutoArp is used to control the generation of ARP\r
773 protocol packets. If NewAutoArp is TRUE, then ARP Protocol packets will be generated\r
774 as required by the PXE Base Code Protocol. If NewAutoArp is FALSE, then no ARP\r
775 Protocol packets will be generated. In this case, the only mappings that are\r
776 available are those stored in the ArpCache of the EFI_PXE_BASE_CODE_MODE structure.\r
777 If there are not enough mappings in the ArpCache to perform a PXE Base Code Protocol\r
778 service, then the service will fail. This function updates the AutoArp field of\r
779 the EFI_PXE_BASE_CODE_MODE structure to NewAutoArp.\r
780 The SetParameters() call must be invoked after a Callback Protocol is installed\r
781 to enable the use of callbacks.\r
d1f95000 782 \r
783 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
784 @param NewAutoArp If not NULL, a pointer to a value that specifies whether to replace the\r
785 current value of AutoARP. \r
786 @param NewSendGUID If not NULL, a pointer to a value that specifies whether to replace the\r
787 current value of SendGUID. \r
788 @param NewTTL If not NULL, a pointer to be used in place of the current value of TTL,\r
789 the "time to live" field of the IP header. \r
790 @param NewToS If not NULL, a pointer to be used in place of the current value of ToS,\r
791 the "type of service" field of the IP header. \r
792 @param NewMakeCallback If not NULL, a pointer to a value that specifies whether to replace the\r
793 current value of the MakeCallback field of the Mode structure. \r
794 \r
795 @retval EFI_SUCCESS The new parameters values were updated.\r
796 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
797 @retval EFI_INVALID_PARAMETER One or more parameters are invalid. \r
798 \r
799**/\r
800typedef\r
801EFI_STATUS\r
8b13229b 802(EFIAPI *EFI_PXE_BASE_CODE_SET_PARAMETERS)(\r
d1f95000 803 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
804 IN BOOLEAN *NewAutoArp, OPTIONAL\r
805 IN BOOLEAN *NewSendGUID, OPTIONAL\r
806 IN UINT8 *NewTTL, OPTIONAL\r
807 IN UINT8 *NewToS, OPTIONAL\r
808 IN BOOLEAN *NewMakeCallback OPTIONAL\r
809 );\r
810\r
811/** \r
812 Updates the station IP address and/or subnet mask values of a network device.\r
f737cfb9 813 \r
814 This function updates the station IP address and/or subnet mask values of a network\r
815 device.\r
816 The NewStationIp field is used to modify the network device's current IP address.\r
817 If NewStationIP is NULL, then the current IP address will not be modified. Otherwise,\r
818 this function updates the StationIp field of the EFI_PXE_BASE_CODE_MODE structure\r
819 with NewStationIp.\r
820 The NewSubnetMask field is used to modify the network device's current subnet\r
821 mask. If NewSubnetMask is NULL, then the current subnet mask will not be modified.\r
822 Otherwise, this function updates the SubnetMask field of the EFI_PXE_BASE_CODE_MODE\r
823 structure with NewSubnetMask.\r
d1f95000 824 \r
825 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
826 @param NewStationIp Pointer to the new IP address to be used by the network device. \r
827 @param NewSubnetMask Pointer to the new subnet mask to be used by the network device. \r
828 \r
829 @retval EFI_SUCCESS The new station IP address and/or subnet mask were updated.\r
830 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
831 @retval EFI_INVALID_PARAMETER One or more parameters are invalid. \r
832 \r
833**/\r
834typedef\r
835EFI_STATUS\r
8b13229b 836(EFIAPI *EFI_PXE_BASE_CODE_SET_STATION_IP)(\r
d1f95000 837 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
838 IN EFI_IP_ADDRESS *NewStationIp, OPTIONAL\r
839 IN EFI_IP_ADDRESS *NewSubnetMask OPTIONAL\r
840 );\r
841\r
842/** \r
843 Updates the contents of the cached DHCP and Discover packets.\r
f737cfb9 844 \r
845 The pointers to the new packets are used to update the contents of the cached\r
846 packets in the EFI_PXE_BASE_CODE_MODE structure.\r
d1f95000 847 \r
848 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
849 @param NewDhcpDiscoverValid Pointer to a value that will replace the current\r
850 DhcpDiscoverValid field. \r
851 @param NewDhcpAckReceived Pointer to a value that will replace the current\r
852 DhcpAckReceived field. \r
853 @param NewProxyOfferReceived Pointer to a value that will replace the current\r
854 ProxyOfferReceived field. \r
855 @param NewPxeDiscoverValid Pointer to a value that will replace the current \r
856 ProxyOfferReceived field. \r
857 @param NewPxeReplyReceived Pointer to a value that will replace the current\r
858 PxeReplyReceived field. \r
859 @param NewPxeBisReplyReceived Pointer to a value that will replace the current\r
860 PxeBisReplyReceived field. \r
861 @param NewDhcpDiscover Pointer to the new cached DHCP Discover packet contents. \r
862 @param NewDhcpAck Pointer to the new cached DHCP Ack packet contents.\r
863 @param NewProxyOffer Pointer to the new cached Proxy Offer packet contents.\r
864 @param NewPxeDiscover Pointer to the new cached PXE Discover packet contents.\r
865 @param NewPxeReply Pointer to the new cached PXE Reply packet contents.\r
866 @param NewPxeBisReply Pointer to the new cached PXE BIS Reply packet contents.\r
867 \r
868 @retval EFI_SUCCESS The cached packet contents were updated.\r
869 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
870 @retval EFI_INVALID_PARAMETER This is NULL or not point to a valid EFI_PXE_BASE_CODE_PROTOCOL structure.\r
871 \r
872**/\r
873typedef\r
874EFI_STATUS\r
8b13229b 875(EFIAPI *EFI_PXE_BASE_CODE_SET_PACKETS)(\r
d1f95000 876 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
877 BOOLEAN *NewDhcpDiscoverValid, OPTIONAL\r
878 BOOLEAN *NewDhcpAckReceived, OPTIONAL\r
879 BOOLEAN *NewProxyOfferReceived, OPTIONAL\r
880 BOOLEAN *NewPxeDiscoverValid, OPTIONAL\r
881 BOOLEAN *NewPxeReplyReceived, OPTIONAL\r
882 BOOLEAN *NewPxeBisReplyReceived, OPTIONAL\r
883 IN EFI_PXE_BASE_CODE_PACKET *NewDhcpDiscover, OPTIONAL\r
884 IN EFI_PXE_BASE_CODE_PACKET *NewDhcpAck, OPTIONAL\r
885 IN EFI_PXE_BASE_CODE_PACKET *NewProxyOffer, OPTIONAL\r
886 IN EFI_PXE_BASE_CODE_PACKET *NewPxeDiscover, OPTIONAL\r
887 IN EFI_PXE_BASE_CODE_PACKET *NewPxeReply, OPTIONAL\r
888 IN EFI_PXE_BASE_CODE_PACKET *NewPxeBisReply OPTIONAL\r
889 );\r
890\r
891//\r
892// PXE Base Code Protocol structure\r
893//\r
a6508c05 894#define EFI_PXE_BASE_CODE_PROTOCOL_REVISION 0x00010000\r
895\r
896//\r
897// Revision defined in EFI1.1\r
898// \r
899#define EFI_PXE_BASE_CODE_INTERFACE_REVISION EFI_PXE_BASE_CODE_PROTOCOL_REVISION\r
d1f95000 900\r
44717a39 901///\r
902/// The EFI_PXE_BASE_CODE_PROTOCOL is used to control PXE-compatible devices.\r
903/// An EFI_PXE_BASE_CODE_PROTOCOL will be layered on top of an\r
904/// EFI_MANAGED_NETWORK_PROTOCOL protocol in order to perform packet level transactions.\r
905/// The EFI_PXE_BASE_CODE_PROTOCOL handle also supports the\r
906/// EFI_LOAD_FILE_PROTOCOL protocol. This provides a clean way to obtain control from the\r
907/// boot manager if the boot path is from the remote device.\r
908///\r
d1f95000 909struct _EFI_PXE_BASE_CODE_PROTOCOL {\r
1f08a159 910 ///\r
911 /// The revision of the EFI_PXE_BASE_CODE_PROTOCOL. All future revisions must \r
912 /// be backwards compatible. If a future version is not backwards compatible \r
913 /// it is not the same GUID.\r
914 ///\r
d1f95000 915 UINT64 Revision;\r
916 EFI_PXE_BASE_CODE_START Start;\r
917 EFI_PXE_BASE_CODE_STOP Stop;\r
918 EFI_PXE_BASE_CODE_DHCP Dhcp;\r
919 EFI_PXE_BASE_CODE_DISCOVER Discover;\r
920 EFI_PXE_BASE_CODE_MTFTP Mtftp;\r
921 EFI_PXE_BASE_CODE_UDP_WRITE UdpWrite;\r
922 EFI_PXE_BASE_CODE_UDP_READ UdpRead;\r
923 EFI_PXE_BASE_CODE_SET_IP_FILTER SetIpFilter;\r
924 EFI_PXE_BASE_CODE_ARP Arp;\r
925 EFI_PXE_BASE_CODE_SET_PARAMETERS SetParameters;\r
926 EFI_PXE_BASE_CODE_SET_STATION_IP SetStationIp;\r
927 EFI_PXE_BASE_CODE_SET_PACKETS SetPackets;\r
44717a39 928 ///\r
929 /// Pointer to the EFI_PXE_BASE_CODE_MODE data for this device.\r
930 ///\r
d1f95000 931 EFI_PXE_BASE_CODE_MODE *Mode;\r
932};\r
933\r
934extern EFI_GUID gEfiPxeBaseCodeProtocolGuid;\r
935\r
936#endif \r
EFI Development Kit II mirror for PVE