2 EFI PXE Base Code Protocol definitions, which is used to access PXE-compatible
3 devices for network access and network booting.
5 Copyright (c) 2006 - 2010, Intel Corporation
6 All rights reserved. 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.
14 @par Revision Reference:
15 This Protocol is introduced in EFI Specification 1.10
18 #ifndef __PXE_BASE_CODE_PROTOCOL_H__
19 #define __PXE_BASE_CODE_PROTOCOL_H__
22 /// PXE Base Code protocol
24 #define EFI_PXE_BASE_CODE_PROTOCOL_GUID \
26 0x03c4e603, 0xac28, 0x11d3, {0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \
29 typedef struct _EFI_PXE_BASE_CODE_PROTOCOL EFI_PXE_BASE_CODE_PROTOCOL
;
32 /// Protocol defined in EFI1.1.
34 typedef EFI_PXE_BASE_CODE_PROTOCOL EFI_PXE_BASE_CODE
;
37 /// Default IP TTL and ToS.
39 #define DEFAULT_TTL 16
59 } EFI_PXE_BASE_CODE_ICMP_ERROR
;
66 CHAR8 ErrorString
[127];
67 } EFI_PXE_BASE_CODE_TFTP_ERROR
;
70 /// IP Receive Filter definitions
72 #define EFI_PXE_BASE_CODE_MAX_IPCNT 8
75 /// IP Receive Filter structure
81 EFI_IP_ADDRESS IpList
[EFI_PXE_BASE_CODE_MAX_IPCNT
];
82 } EFI_PXE_BASE_CODE_IP_FILTER
;
84 #define EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP 0x0001
85 #define EFI_PXE_BASE_CODE_IP_FILTER_BROADCAST 0x0002
86 #define EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS 0x0004
87 #define EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS_MULTICAST 0x0008
93 EFI_IP_ADDRESS IpAddr
;
94 EFI_MAC_ADDRESS MacAddr
;
95 } EFI_PXE_BASE_CODE_ARP_ENTRY
;
98 /// ARP route table entries
101 EFI_IP_ADDRESS IpAddr
;
102 EFI_IP_ADDRESS SubnetMask
;
103 EFI_IP_ADDRESS GwAddr
;
104 } EFI_PXE_BASE_CODE_ROUTE_ENTRY
;
109 typedef UINT16 EFI_PXE_BASE_CODE_UDP_PORT
;
111 #define EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_IP 0x0001
112 #define EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT 0x0002
113 #define EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_IP 0x0004
114 #define EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_PORT 0x0008
115 #define EFI_PXE_BASE_CODE_UDP_OPFLAGS_USE_FILTER 0x0010
116 #define EFI_PXE_BASE_CODE_UDP_OPFLAGS_MAY_FRAGMENT 0x0020
119 // Discover() definitions
121 #define EFI_PXE_BASE_CODE_BOOT_TYPE_BOOTSTRAP 0
122 #define EFI_PXE_BASE_CODE_BOOT_TYPE_MS_WINNT_RIS 1
123 #define EFI_PXE_BASE_CODE_BOOT_TYPE_INTEL_LCM 2
124 #define EFI_PXE_BASE_CODE_BOOT_TYPE_DOSUNDI 3
125 #define EFI_PXE_BASE_CODE_BOOT_TYPE_NEC_ESMPRO 4
126 #define EFI_PXE_BASE_CODE_BOOT_TYPE_IBM_WSoD 5
127 #define EFI_PXE_BASE_CODE_BOOT_TYPE_IBM_LCCM 6
128 #define EFI_PXE_BASE_CODE_BOOT_TYPE_CA_UNICENTER_TNG 7
129 #define EFI_PXE_BASE_CODE_BOOT_TYPE_HP_OPENVIEW 8
130 #define EFI_PXE_BASE_CODE_BOOT_TYPE_ALTIRIS_9 9
131 #define EFI_PXE_BASE_CODE_BOOT_TYPE_ALTIRIS_10 10
132 #define EFI_PXE_BASE_CODE_BOOT_TYPE_ALTIRIS_11 11
133 #define EFI_PXE_BASE_CODE_BOOT_TYPE_NOT_USED_12 12
134 #define EFI_PXE_BASE_CODE_BOOT_TYPE_REDHAT_INSTALL 13
135 #define EFI_PXE_BASE_CODE_BOOT_TYPE_REDHAT_BOOT 14
136 #define EFI_PXE_BASE_CODE_BOOT_TYPE_REMBO 15
137 #define EFI_PXE_BASE_CODE_BOOT_TYPE_BEOBOOT 16
139 // 17 through 32767 are reserved
140 // 32768 through 65279 are for vendor use
141 // 65280 through 65534 are reserved
143 #define EFI_PXE_BASE_CODE_BOOT_TYPE_PXETEST 65535
145 #define EFI_PXE_BASE_CODE_BOOT_LAYER_MASK 0x7FFF
146 #define EFI_PXE_BASE_CODE_BOOT_LAYER_INITIAL 0x0000
149 // PXE Tag definition that identifies the processor
150 // and programming environment of the client system.
152 #if defined (MDE_CPU_IA32)
153 #define EFI_PXE_CLIENT_SYSTEM_ARCHITECTURE 0x0006
154 #elif defined (MDE_CPU_IPF)
155 #define EFI_PXE_CLIENT_SYSTEM_ARCHITECTURE 0x0002
156 #elif defined (MDE_CPU_X64)
157 #define EFI_PXE_CLIENT_SYSTEM_ARCHITECTURE 0x0007
158 #elif defined (MDE_CPU_ARM)
159 #define EFI_PXE_CLIENT_SYSTEM_ARCHITECTURE 0x000A
164 /// Discover() server list structure.
168 BOOLEAN AcceptAnyResponse
;
170 EFI_IP_ADDRESS IpAddr
;
171 } EFI_PXE_BASE_CODE_SRVLIST
;
174 /// Discover() information override structure.
181 EFI_IP_ADDRESS ServerMCastIp
;
183 EFI_PXE_BASE_CODE_SRVLIST SrvList
[1];
184 } EFI_PXE_BASE_CODE_DISCOVER_INFO
;
187 /// TFTP opcode definitions
190 EFI_PXE_BASE_CODE_TFTP_FIRST
,
191 EFI_PXE_BASE_CODE_TFTP_GET_FILE_SIZE
,
192 EFI_PXE_BASE_CODE_TFTP_READ_FILE
,
193 EFI_PXE_BASE_CODE_TFTP_WRITE_FILE
,
194 EFI_PXE_BASE_CODE_TFTP_READ_DIRECTORY
,
195 EFI_PXE_BASE_CODE_MTFTP_GET_FILE_SIZE
,
196 EFI_PXE_BASE_CODE_MTFTP_READ_FILE
,
197 EFI_PXE_BASE_CODE_MTFTP_READ_DIRECTORY
,
198 EFI_PXE_BASE_CODE_MTFTP_LAST
199 } EFI_PXE_BASE_CODE_TFTP_OPCODE
;
202 /// MTFTP information. This information is required
203 /// to start or join a multicast TFTP session. It is also required to
204 /// perform the "get file size" and "read directory" operations of MTFTP.
207 EFI_IP_ADDRESS MCastIp
;
208 EFI_PXE_BASE_CODE_UDP_PORT CPort
;
209 EFI_PXE_BASE_CODE_UDP_PORT SPort
;
210 UINT16 ListenTimeout
;
211 UINT16 TransmitTimeout
;
212 } EFI_PXE_BASE_CODE_MTFTP_INFO
;
215 /// DHCPV4 Packet structure
220 UINT8 BootpHwAddrLen
;
225 UINT8 BootpCiAddr
[4];
226 UINT8 BootpYiAddr
[4];
227 UINT8 BootpSiAddr
[4];
228 UINT8 BootpGiAddr
[4];
229 UINT8 BootpHwAddr
[16];
230 UINT8 BootpSrvName
[64];
231 UINT8 BootpBootFile
[128];
233 UINT8 DhcpOptions
[56];
234 } EFI_PXE_BASE_CODE_DHCPV4_PACKET
;
237 /// Note: EFI_PXE_BASE_CODE_DHCPV6_PACKET and EFI_PXE_BASE_CODE_PACKET are not
238 /// consistent with the current UEFI2.3 specification. It's supposed that
239 /// they will be consistent in the next version.
243 /// DHCPV6 Packet structure.
246 UINT32 MessageType
:8;
247 UINT32 TransactionId
:24;
248 UINT8 DhcpOptions
[1024];
249 } EFI_PXE_BASE_CODE_DHCPV6_PACKET
;
256 EFI_PXE_BASE_CODE_DHCPV4_PACKET Dhcpv4
;
257 EFI_PXE_BASE_CODE_DHCPV6_PACKET Dhcpv6
;
258 } EFI_PXE_BASE_CODE_PACKET
;
261 // PXE Base Code Mode structure
263 #define EFI_PXE_BASE_CODE_MAX_ARP_ENTRIES 8
264 #define EFI_PXE_BASE_CODE_MAX_ROUTE_ENTRIES 8
267 /// EFI_PXE_BASE_CODE_MODE
268 /// The data values in this structure are read-only and
269 /// are updated by the code that produces the
270 /// EFI_PXE_BASE_CODE_PROTOCOL functions.
274 BOOLEAN Ipv6Available
;
275 BOOLEAN Ipv6Supported
;
277 BOOLEAN BisSupported
;
281 BOOLEAN DhcpDiscoverValid
;
282 BOOLEAN DhcpAckReceived
;
283 BOOLEAN ProxyOfferReceived
;
284 BOOLEAN PxeDiscoverValid
;
285 BOOLEAN PxeReplyReceived
;
286 BOOLEAN PxeBisReplyReceived
;
287 BOOLEAN IcmpErrorReceived
;
288 BOOLEAN TftpErrorReceived
;
289 BOOLEAN MakeCallbacks
;
292 EFI_IP_ADDRESS StationIp
;
293 EFI_IP_ADDRESS SubnetMask
;
294 EFI_PXE_BASE_CODE_PACKET DhcpDiscover
;
295 EFI_PXE_BASE_CODE_PACKET DhcpAck
;
296 EFI_PXE_BASE_CODE_PACKET ProxyOffer
;
297 EFI_PXE_BASE_CODE_PACKET PxeDiscover
;
298 EFI_PXE_BASE_CODE_PACKET PxeReply
;
299 EFI_PXE_BASE_CODE_PACKET PxeBisReply
;
300 EFI_PXE_BASE_CODE_IP_FILTER IpFilter
;
301 UINT32 ArpCacheEntries
;
302 EFI_PXE_BASE_CODE_ARP_ENTRY ArpCache
[EFI_PXE_BASE_CODE_MAX_ARP_ENTRIES
];
303 UINT32 RouteTableEntries
;
304 EFI_PXE_BASE_CODE_ROUTE_ENTRY RouteTable
[EFI_PXE_BASE_CODE_MAX_ROUTE_ENTRIES
];
305 EFI_PXE_BASE_CODE_ICMP_ERROR IcmpError
;
306 EFI_PXE_BASE_CODE_TFTP_ERROR TftpError
;
307 } EFI_PXE_BASE_CODE_MODE
;
310 // PXE Base Code Interface Function definitions
314 Enables the use of the PXE Base Code Protocol functions.
316 This function enables the use of the PXE Base Code Protocol functions. If the
317 Started field of the EFI_PXE_BASE_CODE_MODE structure is already TRUE, then
318 EFI_ALREADY_STARTED will be returned. If UseIpv6 is TRUE, then IPv6 formatted
319 addresses will be used in this session. If UseIpv6 is FALSE, then IPv4 formatted
320 addresses will be used in this session. If UseIpv6 is TRUE, and the Ipv6Supported
321 field of the EFI_PXE_BASE_CODE_MODE structure is FALSE, then EFI_UNSUPPORTED will
322 be returned. If there is not enough memory or other resources to start the PXE
323 Base Code Protocol, then EFI_OUT_OF_RESOURCES will be returned. Otherwise, the
324 PXE Base Code Protocol will be started, and all of the fields of the EFI_PXE_BASE_CODE_MODE
325 structure will be initialized as follows:
327 Ipv6SupportedUnchanged.
328 Ipv6AvailableUnchanged.
329 UsingIpv6Set to UseIpv6.
330 BisSupportedUnchanged.
331 BisDetectedUnchanged.
333 SendGUIDSet to FALSE.
334 TTLSet to DEFAULT_TTL.
335 ToSSet to DEFAULT_ToS.
336 DhcpCompletedSet to FALSE.
337 ProxyOfferReceivedSet to FALSE.
338 StationIpSet to an address of all zeros.
339 SubnetMaskSet to a subnet mask of all zeros.
340 DhcpDiscoverZero-filled.
342 ProxyOfferZero-filled.
343 PxeDiscoverValidSet to FALSE.
344 PxeDiscoverZero-filled.
345 PxeReplyValidSet to FALSE.
347 PxeBisReplyValidSet to FALSE.
348 PxeBisReplyZero-filled.
349 IpFilterSet the Filters field to 0 and the IpCnt field to 0.
350 ArpCacheEntriesSet to 0.
352 RouteTableEntriesSet to 0.
353 RouteTableZero-filled.
354 IcmpErrorReceivedSet to FALSE.
355 IcmpErrorZero-filled.
356 TftpErroReceivedSet to FALSE.
357 TftpErrorZero-filled.
358 MakeCallbacksSet to TRUE if the PXE Base Code Callback Protocol is available.
359 Set to FALSE if the PXE Base Code Callback Protocol is not available.
361 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
362 @param UseIpv6 Specifies the type of IP addresses that are to be used during the session
363 that is being started. Set to TRUE for IPv6 addresses, and FALSE for
366 @retval EFI_SUCCESS The PXE Base Code Protocol was started.
367 @retval EFI_DEVICE_ERROR The network device encountered an error during this oper
368 @retval EFI_UNSUPPORTED UseIpv6 is TRUE, but the Ipv6Supported field of the
369 EFI_PXE_BASE_CODE_MODE structure is FALSE.
370 @retval EFI_ALREADY_STARTED The PXE Base Code Protocol is already in the started state.
371 @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid
372 EFI_PXE_BASE_CODE_PROTOCOL structure.
373 @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory or other resources to start the
374 PXE Base Code Protocol.
379 (EFIAPI
*EFI_PXE_BASE_CODE_START
)(
380 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
385 Disables the use of the PXE Base Code Protocol functions.
387 This function stops all activity on the network device. All the resources allocated
388 in Start() are released, the Started field of the EFI_PXE_BASE_CODE_MODE structure is
389 set to FALSE and EFI_SUCCESS is returned. If the Started field of the EFI_PXE_BASE_CODE_MODE
390 structure is already FALSE, then EFI_NOT_STARTED will be returned.
392 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
394 @retval EFI_SUCCESS The PXE Base Code Protocol was stopped.
395 @retval EFI_NOT_STARTED The PXE Base Code Protocol is already in the stopped state.
396 @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid
397 EFI_PXE_BASE_CODE_PROTOCOL structure.
398 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
403 (EFIAPI
*EFI_PXE_BASE_CODE_STOP
)(
404 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
408 Attempts to complete a DHCPv4 D.O.R.A. (discover / offer / request / acknowledge) or DHCPv6
409 S.A.R.R (solicit / advertise / request / reply) sequence.
411 This function attempts to complete the DHCP sequence. If this sequence is completed,
412 then EFI_SUCCESS is returned, and the DhcpCompleted, ProxyOfferReceived, StationIp,
413 SubnetMask, DhcpDiscover, DhcpAck, and ProxyOffer fields of the EFI_PXE_BASE_CODE_MODE
414 structure are filled in.
415 If SortOffers is TRUE, then the cached DHCP offer packets will be sorted before
416 they are tried. If SortOffers is FALSE, then the cached DHCP offer packets will
417 be tried in the order in which they are received. Please see the Preboot Execution
418 Environment (PXE) Specification for additional details on the implementation of DHCP.
419 This function can take at least 31 seconds to timeout and return control to the
420 caller. If the DHCP sequence does not complete, then EFI_TIMEOUT will be returned.
421 If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,
422 then the DHCP sequence will be stopped and EFI_ABORTED will be returned.
424 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
425 @param SortOffers TRUE if the offers received should be sorted. Set to FALSE to try the
426 offers in the order that they are received.
428 @retval EFI_SUCCESS Valid DHCP has completed.
429 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
430 @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid
431 EFI_PXE_BASE_CODE_PROTOCOL structure.
432 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
433 @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory to complete the DHCP Protocol.
434 @retval EFI_ABORTED The callback function aborted the DHCP Protocol.
435 @retval EFI_TIMEOUT The DHCP Protocol timed out.
436 @retval EFI_ICMP_ERROR An ICMP error packet was received during the DHCP session.
437 @retval EFI_NO_RESPONSE Valid PXE offer was not received.
442 (EFIAPI
*EFI_PXE_BASE_CODE_DHCP
)(
443 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
444 IN BOOLEAN SortOffers
448 Attempts to complete the PXE Boot Server and/or boot image discovery sequence.
450 This function attempts to complete the PXE Boot Server and/or boot image discovery
451 sequence. If this sequence is completed, then EFI_SUCCESS is returned, and the
452 PxeDiscoverValid, PxeDiscover, PxeReplyReceived, and PxeReply fields of the
453 EFI_PXE_BASE_CODE_MODE structure are filled in. If UseBis is TRUE, then the
454 PxeBisReplyReceived and PxeBisReply fields of the EFI_PXE_BASE_CODE_MODE structure
455 will also be filled in. If UseBis is FALSE, then PxeBisReplyValid will be set to FALSE.
456 In the structure referenced by parameter Info, the PXE Boot Server list, SrvList[],
457 has two uses: It is the Boot Server IP address list used for unicast discovery
458 (if the UseUCast field is TRUE), and it is the list used for Boot Server verification
459 (if the MustUseList field is TRUE). Also, if the MustUseList field in that structure
460 is TRUE and the AcceptAnyResponse field in the SrvList[] array is TRUE, any Boot
461 Server reply of that type will be accepted. If the AcceptAnyResponse field is
462 FALSE, only responses from Boot Servers with matching IP addresses will be accepted.
463 This function can take at least 10 seconds to timeout and return control to the
464 caller. If the Discovery sequence does not complete, then EFI_TIMEOUT will be
465 returned. Please see the Preboot Execution Environment (PXE) Specification for
466 additional details on the implementation of the Discovery sequence.
467 If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,
468 then the Discovery sequence is stopped and EFI_ABORTED will be returned.
470 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
471 @param Type The type of bootstrap to perform.
472 @param Layer Pointer to the boot server layer number to discover, which must be
473 PXE_BOOT_LAYER_INITIAL when a new server type is being
475 @param UseBis TRUE if Boot Integrity Services are to be used. FALSE otherwise.
476 @param Info Pointer to a data structure that contains additional information on the
477 type of discovery operation that is to be performed.
479 @retval EFI_SUCCESS The Discovery sequence has been completed.
480 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
481 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
482 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
483 @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory to complete Discovery.
484 @retval EFI_ABORTED The callback function aborted the Discovery sequence.
485 @retval EFI_TIMEOUT The Discovery sequence timed out.
486 @retval EFI_ICMP_ERROR An ICMP error packet was received during the PXE discovery
492 (EFIAPI
*EFI_PXE_BASE_CODE_DISCOVER
)(
493 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
497 IN EFI_PXE_BASE_CODE_DISCOVER_INFO
*Info OPTIONAL
501 Used to perform TFTP and MTFTP services.
503 This function is used to perform TFTP and MTFTP services. This includes the
504 TFTP operations to get the size of a file, read a directory, read a file, and
505 write a file. It also includes the MTFTP operations to get the size of a file,
506 read a directory, and read a file. The type of operation is specified by Operation.
507 If the callback function that is invoked during the TFTP/MTFTP operation does
508 not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED will
510 For read operations, the return data will be placed in the buffer specified by
511 BufferPtr. If BufferSize is too small to contain the entire downloaded file,
512 then EFI_BUFFER_TOO_SMALL will be returned and BufferSize will be set to zero
513 or the size of the requested file (the size of the requested file is only returned
514 if the TFTP server supports TFTP options). If BufferSize is large enough for the
515 read operation, then BufferSize will be set to the size of the downloaded file,
516 and EFI_SUCCESS will be returned. Applications using the PxeBc.Mtftp() services
517 should use the get-file-size operations to determine the size of the downloaded
518 file prior to using the read-file operations--especially when downloading large
519 (greater than 64 MB) files--instead of making two calls to the read-file operation.
520 Following this recommendation will save time if the file is larger than expected
521 and the TFTP server does not support TFTP option extensions. Without TFTP option
522 extension support, the client has to download the entire file, counting and discarding
523 the received packets, to determine the file size.
524 For write operations, the data to be sent is in the buffer specified by BufferPtr.
525 BufferSize specifies the number of bytes to send. If the write operation completes
526 successfully, then EFI_SUCCESS will be returned.
527 For TFTP "get file size" operations, the size of the requested file or directory
528 is returned in BufferSize, and EFI_SUCCESS will be returned. If the TFTP server
529 does not support options, the file will be downloaded into a bit bucket and the
530 length of the downloaded file will be returned. For MTFTP "get file size" operations,
531 if the MTFTP server does not support the "get file size" option, EFI_UNSUPPORTED
533 This function can take up to 10 seconds to timeout and return control to the caller.
534 If the TFTP sequence does not complete, EFI_TIMEOUT will be returned.
535 If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,
536 then the TFTP sequence is stopped and EFI_ABORTED will be returned.
537 The format of the data returned from a TFTP read directory operation is a null-terminated
538 filename followed by a null-terminated information string, of the form
539 "size year-month-day hour:minute:second" (i.e. %d %d-%d-%d %d:%d:%f - note that
540 the seconds field can be a decimal number), where the date and time are UTC. For
541 an MTFTP read directory command, there is additionally a null-terminated multicast
542 IP address preceding the filename of the form %d.%d.%d.%d for IP v4. The final
543 entry is itself null-terminated, so that the final information string is terminated
544 with two null octets.
546 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
547 @param Operation The type of operation to perform.
548 @param BufferPtr A pointer to the data buffer.
549 @param Overwrite Only used on write file operations. TRUE if a file on a remote server can
551 @param BufferSize For get-file-size operations, *BufferSize returns the size of the
553 @param BlockSize The requested block size to be used during a TFTP transfer.
554 @param ServerIp The TFTP / MTFTP server IP address.
555 @param Filename A Null-terminated ASCII string that specifies a directory name or a file
557 @param Info Pointer to the MTFTP information.
558 @param DontUseBuffer Set to FALSE for normal TFTP and MTFTP read file operation.
560 @retval EFI_SUCCESS The TFTP/MTFTP operation was completed.
561 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
562 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
563 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
564 @retval EFI_BUFFER_TOO_SMALL The buffer is not large enough to complete the read operation.
565 @retval EFI_ABORTED The callback function aborted the TFTP/MTFTP operation.
566 @retval EFI_TIMEOUT The TFTP/MTFTP operation timed out.
567 @retval EFI_ICMP_ERROR An ICMP error packet was received during the MTFTP session.
568 @retval EFI_TFTP_ERROR A TFTP error packet was received during the MTFTP session.
573 (EFIAPI
*EFI_PXE_BASE_CODE_MTFTP
)(
574 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
575 IN EFI_PXE_BASE_CODE_TFTP_OPCODE Operation
,
576 IN OUT VOID
*BufferPtr OPTIONAL
,
577 IN BOOLEAN Overwrite
,
578 IN OUT UINT64
*BufferSize
,
579 IN UINTN
*BlockSize OPTIONAL
,
580 IN EFI_IP_ADDRESS
*ServerIp
,
581 IN UINT8
*Filename OPTIONAL
,
582 IN EFI_PXE_BASE_CODE_MTFTP_INFO
*Info OPTIONAL
,
583 IN BOOLEAN DontUseBuffer
587 Writes a UDP packet to the network interface.
589 This function writes a UDP packet specified by the (optional HeaderPtr and)
590 BufferPtr parameters to the network interface. The UDP header is automatically
591 built by this routine. It uses the parameters OpFlags, DestIp, DestPort, GatewayIp,
592 SrcIp, and SrcPort to build this header. If the packet is successfully built and
593 transmitted through the network interface, then EFI_SUCCESS will be returned.
594 If a timeout occurs during the transmission of the packet, then EFI_TIMEOUT will
595 be returned. If an ICMP error occurs during the transmission of the packet, then
596 the IcmpErrorReceived field is set to TRUE, the IcmpError field is filled in and
597 EFI_ICMP_ERROR will be returned. If the Callback Protocol does not return
598 EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED will be returned.
600 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
601 @param OpFlags The UDP operation flags.
602 @param DestIp The destination IP address.
603 @param DestPort The destination UDP port number.
604 @param GatewayIp The gateway IP address.
605 @param SrcIp The source IP address.
606 @param SrcPort The source UDP port number.
607 @param HeaderSize An optional field which may be set to the length of a header at
608 HeaderPtr to be prefixed to the data at BufferPtr.
609 @param HeaderPtr If HeaderSize is not NULL, a pointer to a header to be prefixed to the
611 @param BufferSize A pointer to the size of the data at BufferPtr.
612 @param BufferPtr A pointer to the data to be written.
614 @retval EFI_SUCCESS The UDP Write operation was completed.
615 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
616 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
617 @retval EFI_BAD_BUFFER_SIZE The buffer is too long to be transmitted.
618 @retval EFI_ABORTED The callback function aborted the UDP Write operation.
619 @retval EFI_TIMEOUT The UDP Write operation timed out.
620 @retval EFI_ICMP_ERROR An ICMP error packet was received during the UDP write session.
625 (EFIAPI
*EFI_PXE_BASE_CODE_UDP_WRITE
)(
626 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
628 IN EFI_IP_ADDRESS
*DestIp
,
629 IN EFI_PXE_BASE_CODE_UDP_PORT
*DestPort
,
630 IN EFI_IP_ADDRESS
*GatewayIp
, OPTIONAL
631 IN EFI_IP_ADDRESS
*SrcIp
, OPTIONAL
632 IN OUT EFI_PXE_BASE_CODE_UDP_PORT
*SrcPort
, OPTIONAL
633 IN UINTN
*HeaderSize
, OPTIONAL
634 IN VOID
*HeaderPtr
, OPTIONAL
635 IN UINTN
*BufferSize
,
640 Reads a UDP packet from the network interface.
642 This function reads a UDP packet from a network interface. The data contents
643 are returned in (the optional HeaderPtr and) BufferPtr, and the size of the
644 buffer received is returned in BufferSize . If the input BufferSize is smaller
645 than the UDP packet received (less optional HeaderSize), it will be set to the
646 required size, and EFI_BUFFER_TOO_SMALL will be returned. In this case, the
647 contents of BufferPtr are undefined, and the packet is lost. If a UDP packet is
648 successfully received, then EFI_SUCCESS will be returned, and the information
649 from the UDP header will be returned in DestIp, DestPort, SrcIp, and SrcPort if
651 Depending on the values of OpFlags and the DestIp, DestPort, SrcIp, and SrcPort
652 input values, different types of UDP packet receive filtering will be performed.
653 The following tables summarize these receive filter operations.
655 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
656 @param OpFlags The UDP operation flags.
657 @param DestIp The destination IP address.
658 @param DestPort The destination UDP port number.
659 @param SrcIp The source IP address.
660 @param SrcPort The source UDP port number.
661 @param HeaderSize An optional field which may be set to the length of a header at
662 HeaderPtr to be prefixed to the data at BufferPtr.
663 @param HeaderPtr If HeaderSize is not NULL, a pointer to a header to be prefixed to the
665 @param BufferSize A pointer to the size of the data at BufferPtr.
666 @param BufferPtr A pointer to the data to be read.
668 @retval EFI_SUCCESS The UDP Read operation was completed.
669 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
670 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
671 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
672 @retval EFI_BUFFER_TOO_SMALL The packet is larger than Buffer can hold.
673 @retval EFI_ABORTED The callback function aborted the UDP Read operation.
674 @retval EFI_TIMEOUT The UDP Read operation timed out.
679 (EFIAPI
*EFI_PXE_BASE_CODE_UDP_READ
)(
680 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
682 IN OUT EFI_IP_ADDRESS
*DestIp
, OPTIONAL
683 IN OUT EFI_PXE_BASE_CODE_UDP_PORT
*DestPort
, OPTIONAL
684 IN OUT EFI_IP_ADDRESS
*SrcIp
, OPTIONAL
685 IN OUT EFI_PXE_BASE_CODE_UDP_PORT
*SrcPort
, OPTIONAL
686 IN UINTN
*HeaderSize
, OPTIONAL
687 IN VOID
*HeaderPtr
, OPTIONAL
688 IN OUT UINTN
*BufferSize
,
693 Updates the IP receive filters of a network device and enables software filtering.
695 The NewFilter field is used to modify the network device's current IP receive
696 filter settings and to enable a software filter. This function updates the IpFilter
697 field of the EFI_PXE_BASE_CODE_MODE structure with the contents of NewIpFilter.
698 The software filter is used when the USE_FILTER in OpFlags is set to UdpRead().
699 The current hardware filter remains in effect no matter what the settings of OpFlags
700 are, so that the meaning of ANY_DEST_IP set in OpFlags to UdpRead() is from those
701 packets whose reception is enabled in hardware - physical NIC address (unicast),
702 broadcast address, logical address or addresses (multicast), or all (promiscuous).
703 UdpRead() does not modify the IP filter settings.
704 Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP receive
705 filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.
706 If an application or driver wishes to preserve the IP receive filter settings,
707 it will have to preserve the IP receive filter settings before these calls, and
708 use SetIpFilter() to restore them after the calls. If incompatible filtering is
709 requested (for example, PROMISCUOUS with anything else) or if the device does not
710 support a requested filter setting and it cannot be accommodated in software
711 (for example, PROMISCUOUS not supported), EFI_INVALID_PARAMETER will be returned.
712 The IPlist field is used to enable IPs other than the StationIP. They may be
713 multicast or unicast. If IPcnt is set as well as EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP,
714 then both the StationIP and the IPs from the IPlist will be used.
716 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
717 @param NewFilter Pointer to the new set of IP receive filters.
719 @retval EFI_SUCCESS The IP receive filter settings were updated.
720 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
721 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
726 (EFIAPI
*EFI_PXE_BASE_CODE_SET_IP_FILTER
)(
727 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
728 IN EFI_PXE_BASE_CODE_IP_FILTER
*NewFilter
732 Uses the ARP protocol to resolve a MAC address.
734 This function uses the ARP protocol to resolve a MAC address. The UsingIpv6 field
735 of the EFI_PXE_BASE_CODE_MODE structure is used to determine if IPv4 or IPv6
736 addresses are being used. The IP address specified by IpAddr is used to resolve
737 a MAC address. If the ARP protocol succeeds in resolving the specified address,
738 then the ArpCacheEntries and ArpCache fields of the EFI_PXE_BASE_CODE_MODE structure
739 are updated, and EFI_SUCCESS is returned. If MacAddr is not NULL, the resolved
740 MAC address is placed there as well.
741 If the PXE Base Code protocol is in the stopped state, then EFI_NOT_STARTED is
742 returned. If the ARP protocol encounters a timeout condition while attempting
743 to resolve an address, then EFI_TIMEOUT is returned. If the Callback Protocol
744 does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED is
747 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
748 @param IpAddr Pointer to the IP address that is used to resolve a MAC address.
749 @param MacAddr If not NULL, a pointer to the MAC address that was resolved with the
752 @retval EFI_SUCCESS The IP or MAC address was resolved.
753 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
754 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
755 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
756 @retval EFI_ABORTED The callback function aborted the ARP Protocol.
757 @retval EFI_TIMEOUT The ARP Protocol encountered a timeout condition.
762 (EFIAPI
*EFI_PXE_BASE_CODE_ARP
)(
763 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
764 IN EFI_IP_ADDRESS
*IpAddr
,
765 IN EFI_MAC_ADDRESS
*MacAddr OPTIONAL
769 Updates the parameters that affect the operation of the PXE Base Code Protocol.
771 This function sets parameters that affect the operation of the PXE Base Code Protocol.
772 The parameter specified by NewAutoArp is used to control the generation of ARP
773 protocol packets. If NewAutoArp is TRUE, then ARP Protocol packets will be generated
774 as required by the PXE Base Code Protocol. If NewAutoArp is FALSE, then no ARP
775 Protocol packets will be generated. In this case, the only mappings that are
776 available are those stored in the ArpCache of the EFI_PXE_BASE_CODE_MODE structure.
777 If there are not enough mappings in the ArpCache to perform a PXE Base Code Protocol
778 service, then the service will fail. This function updates the AutoArp field of
779 the EFI_PXE_BASE_CODE_MODE structure to NewAutoArp.
780 The SetParameters() call must be invoked after a Callback Protocol is installed
781 to enable the use of callbacks.
783 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
784 @param NewAutoArp If not NULL, a pointer to a value that specifies whether to replace the
785 current value of AutoARP.
786 @param NewSendGUID If not NULL, a pointer to a value that specifies whether to replace the
787 current value of SendGUID.
788 @param NewTTL If not NULL, a pointer to be used in place of the current value of TTL,
789 the "time to live" field of the IP header.
790 @param NewToS If not NULL, a pointer to be used in place of the current value of ToS,
791 the "type of service" field of the IP header.
792 @param NewMakeCallback If not NULL, a pointer to a value that specifies whether to replace the
793 current value of the MakeCallback field of the Mode structure.
795 @retval EFI_SUCCESS The new parameters values were updated.
796 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
797 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
802 (EFIAPI
*EFI_PXE_BASE_CODE_SET_PARAMETERS
)(
803 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
804 IN BOOLEAN
*NewAutoArp
, OPTIONAL
805 IN BOOLEAN
*NewSendGUID
, OPTIONAL
806 IN UINT8
*NewTTL
, OPTIONAL
807 IN UINT8
*NewToS
, OPTIONAL
808 IN BOOLEAN
*NewMakeCallback OPTIONAL
812 Updates the station IP address and/or subnet mask values of a network device.
814 This function updates the station IP address and/or subnet mask values of a network
816 The NewStationIp field is used to modify the network device's current IP address.
817 If NewStationIP is NULL, then the current IP address will not be modified. Otherwise,
818 this function updates the StationIp field of the EFI_PXE_BASE_CODE_MODE structure
820 The NewSubnetMask field is used to modify the network device's current subnet
821 mask. If NewSubnetMask is NULL, then the current subnet mask will not be modified.
822 Otherwise, this function updates the SubnetMask field of the EFI_PXE_BASE_CODE_MODE
823 structure with NewSubnetMask.
825 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
826 @param NewStationIp Pointer to the new IP address to be used by the network device.
827 @param NewSubnetMask Pointer to the new subnet mask to be used by the network device.
829 @retval EFI_SUCCESS The new station IP address and/or subnet mask were updated.
830 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
831 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
836 (EFIAPI
*EFI_PXE_BASE_CODE_SET_STATION_IP
)(
837 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
838 IN EFI_IP_ADDRESS
*NewStationIp
, OPTIONAL
839 IN EFI_IP_ADDRESS
*NewSubnetMask OPTIONAL
843 Updates the contents of the cached DHCP and Discover packets.
845 The pointers to the new packets are used to update the contents of the cached
846 packets in the EFI_PXE_BASE_CODE_MODE structure.
848 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
849 @param NewDhcpDiscoverValid Pointer to a value that will replace the current
850 DhcpDiscoverValid field.
851 @param NewDhcpAckReceived Pointer to a value that will replace the current
852 DhcpAckReceived field.
853 @param NewProxyOfferReceived Pointer to a value that will replace the current
854 ProxyOfferReceived field.
855 @param NewPxeDiscoverValid Pointer to a value that will replace the current
856 ProxyOfferReceived field.
857 @param NewPxeReplyReceived Pointer to a value that will replace the current
858 PxeReplyReceived field.
859 @param NewPxeBisReplyReceived Pointer to a value that will replace the current
860 PxeBisReplyReceived field.
861 @param NewDhcpDiscover Pointer to the new cached DHCP Discover packet contents.
862 @param NewDhcpAck Pointer to the new cached DHCP Ack packet contents.
863 @param NewProxyOffer Pointer to the new cached Proxy Offer packet contents.
864 @param NewPxeDiscover Pointer to the new cached PXE Discover packet contents.
865 @param NewPxeReply Pointer to the new cached PXE Reply packet contents.
866 @param NewPxeBisReply Pointer to the new cached PXE BIS Reply packet contents.
868 @retval EFI_SUCCESS The cached packet contents were updated.
869 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
870 @retval EFI_INVALID_PARAMETER This is NULL or not point to a valid EFI_PXE_BASE_CODE_PROTOCOL structure.
875 (EFIAPI
*EFI_PXE_BASE_CODE_SET_PACKETS
)(
876 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
877 BOOLEAN
*NewDhcpDiscoverValid
, OPTIONAL
878 BOOLEAN
*NewDhcpAckReceived
, OPTIONAL
879 BOOLEAN
*NewProxyOfferReceived
, OPTIONAL
880 BOOLEAN
*NewPxeDiscoverValid
, OPTIONAL
881 BOOLEAN
*NewPxeReplyReceived
, OPTIONAL
882 BOOLEAN
*NewPxeBisReplyReceived
, OPTIONAL
883 IN EFI_PXE_BASE_CODE_PACKET
*NewDhcpDiscover
, OPTIONAL
884 IN EFI_PXE_BASE_CODE_PACKET
*NewDhcpAck
, OPTIONAL
885 IN EFI_PXE_BASE_CODE_PACKET
*NewProxyOffer
, OPTIONAL
886 IN EFI_PXE_BASE_CODE_PACKET
*NewPxeDiscover
, OPTIONAL
887 IN EFI_PXE_BASE_CODE_PACKET
*NewPxeReply
, OPTIONAL
888 IN EFI_PXE_BASE_CODE_PACKET
*NewPxeBisReply OPTIONAL
892 // PXE Base Code Protocol structure
894 #define EFI_PXE_BASE_CODE_PROTOCOL_REVISION 0x00010000
897 // Revision defined in EFI1.1
899 #define EFI_PXE_BASE_CODE_INTERFACE_REVISION EFI_PXE_BASE_CODE_PROTOCOL_REVISION
902 /// The EFI_PXE_BASE_CODE_PROTOCOL is used to control PXE-compatible devices.
903 /// An EFI_PXE_BASE_CODE_PROTOCOL will be layered on top of an
904 /// EFI_MANAGED_NETWORK_PROTOCOL protocol in order to perform packet level transactions.
905 /// The EFI_PXE_BASE_CODE_PROTOCOL handle also supports the
906 /// EFI_LOAD_FILE_PROTOCOL protocol. This provides a clean way to obtain control from the
907 /// boot manager if the boot path is from the remote device.
909 struct _EFI_PXE_BASE_CODE_PROTOCOL
{
911 /// The revision of the EFI_PXE_BASE_CODE_PROTOCOL. All future revisions must
912 /// be backwards compatible. If a future version is not backwards compatible
913 /// it is not the same GUID.
916 EFI_PXE_BASE_CODE_START Start
;
917 EFI_PXE_BASE_CODE_STOP Stop
;
918 EFI_PXE_BASE_CODE_DHCP Dhcp
;
919 EFI_PXE_BASE_CODE_DISCOVER Discover
;
920 EFI_PXE_BASE_CODE_MTFTP Mtftp
;
921 EFI_PXE_BASE_CODE_UDP_WRITE UdpWrite
;
922 EFI_PXE_BASE_CODE_UDP_READ UdpRead
;
923 EFI_PXE_BASE_CODE_SET_IP_FILTER SetIpFilter
;
924 EFI_PXE_BASE_CODE_ARP Arp
;
925 EFI_PXE_BASE_CODE_SET_PARAMETERS SetParameters
;
926 EFI_PXE_BASE_CODE_SET_STATION_IP SetStationIp
;
927 EFI_PXE_BASE_CODE_SET_PACKETS SetPackets
;
929 /// Pointer to the EFI_PXE_BASE_CODE_MODE data for this device.
931 EFI_PXE_BASE_CODE_MODE
*Mode
;
934 extern EFI_GUID gEfiPxeBaseCodeProtocolGuid
;