/** @file\r
- EFI PXE Base Code Protocol definitions, which is used to access PXE-compatible \r
+ EFI PXE Base Code Protocol definitions, which is used to access PXE-compatible\r
devices for network access and network booting.\r
\r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php. \r
- \r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+http://opensource.org/licenses/bsd-license.php.\r
\r
- @par Revision Reference: \r
- This Protocol is introduced in EFI Specification 1.10. \r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+ @par Revision Reference:\r
+ This Protocol is introduced in EFI Specification 1.10.\r
\r
**/\r
#ifndef __PXE_BASE_CODE_PROTOCOL_H__\r
\r
///\r
/// Protocol defined in EFI1.1.\r
-/// \r
+///\r
typedef EFI_PXE_BASE_CODE_PROTOCOL EFI_PXE_BASE_CODE;\r
\r
///\r
#define EFI_PXE_BASE_CODE_BOOT_LAYER_INITIAL 0x0000\r
\r
//\r
-// PXE Tag definition that identifies the processor \r
+// PXE Tag definition that identifies the processor\r
// and programming environment of the client system.\r
// These identifiers are defined by IETF:\r
// http://www.ietf.org/assignments/dhcpv6-parameters/dhcpv6-parameters.xml\r
//\r
#if defined (MDE_CPU_IA32)\r
#define EFI_PXE_CLIENT_SYSTEM_ARCHITECTURE 0x0006\r
-#elif defined (MDE_CPU_IPF) \r
+#elif defined (MDE_CPU_IPF)\r
#define EFI_PXE_CLIENT_SYSTEM_ARCHITECTURE 0x0002\r
#elif defined (MDE_CPU_X64)\r
#define EFI_PXE_CLIENT_SYSTEM_ARCHITECTURE 0x0007\r
\r
///\r
/// EFI_PXE_BASE_CODE_MODE.\r
-/// The data values in this structure are read-only and \r
+/// The data values in this structure are read-only and\r
/// are updated by the code that produces the\r
/// EFI_PXE_BASE_CODE_PROTOCOL functions.\r
///\r
// PXE Base Code Interface Function definitions\r
//\r
\r
-/** \r
+/**\r
Enables the use of the PXE Base Code Protocol functions.\r
\r
This function enables the use of the PXE Base Code Protocol functions. If the\r
TftpErrorZero-filled.\r
MakeCallbacksSet to TRUE if the PXE Base Code Callback Protocol is available.\r
Set to FALSE if the PXE Base Code Callback Protocol is not available.\r
- \r
+\r
@param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
@param UseIpv6 Specifies the type of IP addresses that are to be used during the session\r
- that is being started. Set to TRUE for IPv6 addresses, and FALSE for \r
- IPv4 addresses. \r
- \r
+ that is being started. Set to TRUE for IPv6 addresses, and FALSE for\r
+ IPv4 addresses.\r
+\r
@retval EFI_SUCCESS The PXE Base Code Protocol was started.\r
- @retval EFI_DEVICE_ERROR The network device encountered an error during this oper \r
+ @retval EFI_DEVICE_ERROR The network device encountered an error during this oper\r
@retval EFI_UNSUPPORTED UseIpv6 is TRUE, but the Ipv6Supported field of the\r
- EFI_PXE_BASE_CODE_MODE structure is FALSE. \r
- @retval EFI_ALREADY_STARTED The PXE Base Code Protocol is already in the started state. \r
+ EFI_PXE_BASE_CODE_MODE structure is FALSE.\r
+ @retval EFI_ALREADY_STARTED The PXE Base Code Protocol is already in the started state.\r
@retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid\r
- EFI_PXE_BASE_CODE_PROTOCOL structure. \r
- @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory or other resources to start the \r
- PXE Base Code Protocol. \r
- \r
+ EFI_PXE_BASE_CODE_PROTOCOL structure.\r
+ @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory or other resources to start the\r
+ PXE Base Code Protocol.\r
+\r
**/\r
typedef\r
EFI_STATUS\r
IN BOOLEAN UseIpv6\r
);\r
\r
-/** \r
+/**\r
Disables the use of the PXE Base Code Protocol functions.\r
\r
This function stops all activity on the network device. All the resources allocated\r
in Start() are released, the Started field of the EFI_PXE_BASE_CODE_MODE structure is\r
set to FALSE and EFI_SUCCESS is returned. If the Started field of the EFI_PXE_BASE_CODE_MODE\r
structure is already FALSE, then EFI_NOT_STARTED will be returned.\r
- \r
+\r
@param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
- \r
+\r
@retval EFI_SUCCESS The PXE Base Code Protocol was stopped.\r
- @retval EFI_NOT_STARTED The PXE Base Code Protocol is already in the stopped state. \r
+ @retval EFI_NOT_STARTED The PXE Base Code Protocol is already in the stopped state.\r
@retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid\r
- EFI_PXE_BASE_CODE_PROTOCOL structure. \r
- @retval EFI_DEVICE_ERROR The network device encountered an error during this operation. \r
- \r
+ EFI_PXE_BASE_CODE_PROTOCOL structure.\r
+ @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r
+\r
**/\r
typedef\r
EFI_STATUS\r
IN EFI_PXE_BASE_CODE_PROTOCOL *This\r
);\r
\r
-/** \r
+/**\r
Attempts to complete a DHCPv4 D.O.R.A. (discover / offer / request / acknowledge) or DHCPv6\r
S.A.R.R (solicit / advertise / request / reply) sequence.\r
\r
caller. If the DHCP sequence does not complete, then EFI_TIMEOUT will be returned.\r
If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,\r
then the DHCP sequence will be stopped and EFI_ABORTED will be returned.\r
- \r
+\r
@param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
@param SortOffers TRUE if the offers received should be sorted. Set to FALSE to try the\r
- offers in the order that they are received. \r
- \r
+ offers in the order that they are received.\r
+\r
@retval EFI_SUCCESS Valid DHCP has completed.\r
@retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
@retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid\r
- EFI_PXE_BASE_CODE_PROTOCOL structure. \r
- @retval EFI_DEVICE_ERROR The network device encountered an error during this operation. \r
+ EFI_PXE_BASE_CODE_PROTOCOL structure.\r
+ @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r
@retval EFI_OUT_OF_RESOURCES Could not allocate enough memory to complete the DHCP Protocol.\r
@retval EFI_ABORTED The callback function aborted the DHCP Protocol.\r
@retval EFI_TIMEOUT The DHCP Protocol timed out.\r
@retval EFI_ICMP_ERROR An ICMP error packet was received during the DHCP session.\r
@retval EFI_NO_RESPONSE Valid PXE offer was not received.\r
- \r
+\r
**/\r
typedef\r
EFI_STATUS\r
IN BOOLEAN SortOffers\r
);\r
\r
-/** \r
+/**\r
Attempts to complete the PXE Boot Server and/or boot image discovery sequence.\r
\r
This function attempts to complete the PXE Boot Server and/or boot image discovery\r
additional details on the implementation of the Discovery sequence.\r
If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,\r
then the Discovery sequence is stopped and EFI_ABORTED will be returned.\r
- \r
+\r
@param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
@param Type The type of bootstrap to perform.\r
@param Layer The pointer to the boot server layer number to discover, which must be\r
- PXE_BOOT_LAYER_INITIAL when a new server type is being \r
- discovered. \r
- @param UseBis TRUE if Boot Integrity Services are to be used. FALSE otherwise. \r
+ PXE_BOOT_LAYER_INITIAL when a new server type is being\r
+ discovered.\r
+ @param UseBis TRUE if Boot Integrity Services are to be used. FALSE otherwise.\r
@param Info The pointer to a data structure that contains additional information on the\r
- type of discovery operation that is to be performed. \r
- \r
+ type of discovery operation that is to be performed.\r
+\r
@retval EFI_SUCCESS The Discovery sequence has been completed.\r
@retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
- @retval EFI_INVALID_PARAMETER One or more parameters are invalid. \r
- @retval EFI_DEVICE_ERROR The network device encountered an error during this operation. \r
+ @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
+ @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r
@retval EFI_OUT_OF_RESOURCES Could not allocate enough memory to complete Discovery.\r
@retval EFI_ABORTED The callback function aborted the Discovery sequence.\r
@retval EFI_TIMEOUT The Discovery sequence timed out.\r
@retval EFI_ICMP_ERROR An ICMP error packet was received during the PXE discovery\r
- session. \r
- \r
+ session.\r
+\r
**/\r
typedef\r
EFI_STATUS\r
IN EFI_PXE_BASE_CODE_DISCOVER_INFO *Info OPTIONAL\r
);\r
\r
-/** \r
+/**\r
Used to perform TFTP and MTFTP services.\r
\r
This function is used to perform TFTP and MTFTP services. This includes the\r
IP address preceding the filename of the form %d.%d.%d.%d for IP v4. The final\r
entry is itself null-terminated, so that the final information string is terminated\r
with two null octets.\r
- \r
+\r
@param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
@param Operation The type of operation to perform.\r
- @param BufferPtr A pointer to the data buffer. \r
+ @param BufferPtr A pointer to the data buffer.\r
@param Overwrite Only used on write file operations. TRUE if a file on a remote server can\r
- be overwritten. \r
+ be overwritten.\r
@param BufferSize For get-file-size operations, *BufferSize returns the size of the\r
- requested file. \r
+ requested file.\r
@param BlockSize The requested block size to be used during a TFTP transfer.\r
@param ServerIp The TFTP / MTFTP server IP address.\r
@param Filename A Null-terminated ASCII string that specifies a directory name or a file\r
- name. \r
+ name.\r
@param Info The pointer to the MTFTP information.\r
- @param DontUseBuffer Set to FALSE for normal TFTP and MTFTP read file operation. \r
- \r
+ @param DontUseBuffer Set to FALSE for normal TFTP and MTFTP read file operation.\r
+\r
@retval EFI_SUCCESS The TFTP/MTFTP operation was completed.\r
@retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
- @retval EFI_INVALID_PARAMETER One or more parameters are invalid. \r
- @retval EFI_DEVICE_ERROR The network device encountered an error during this operation. \r
- @retval EFI_BUFFER_TOO_SMALL The buffer is not large enough to complete the read operation. \r
+ @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
+ @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r
+ @retval EFI_BUFFER_TOO_SMALL The buffer is not large enough to complete the read operation.\r
@retval EFI_ABORTED The callback function aborted the TFTP/MTFTP operation.\r
@retval EFI_TIMEOUT The TFTP/MTFTP operation timed out.\r
@retval EFI_ICMP_ERROR An ICMP error packet was received during the MTFTP session.\r
@retval EFI_TFTP_ERROR A TFTP error packet was received during the MTFTP session.\r
- \r
+\r
**/\r
typedef\r
EFI_STATUS\r
IN BOOLEAN DontUseBuffer\r
);\r
\r
-/** \r
+/**\r
Writes a UDP packet to the network interface.\r
\r
This function writes a UDP packet specified by the (optional HeaderPtr and)\r
the IcmpErrorReceived field is set to TRUE, the IcmpError field is filled in and\r
EFI_ICMP_ERROR will be returned. If the Callback Protocol does not return\r
EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED will be returned.\r
- \r
+\r
@param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
- @param OpFlags The UDP operation flags. \r
+ @param OpFlags The UDP operation flags.\r
@param DestIp The destination IP address.\r
- @param DestPort The destination UDP port number. \r
- @param GatewayIp The gateway IP address. \r
+ @param DestPort The destination UDP port number.\r
+ @param GatewayIp The gateway IP address.\r
@param SrcIp The source IP address.\r
@param SrcPort The source UDP port number.\r
@param HeaderSize An optional field which may be set to the length of a header at\r
- HeaderPtr to be prefixed to the data at BufferPtr. \r
+ HeaderPtr to be prefixed to the data at BufferPtr.\r
@param HeaderPtr If HeaderSize is not NULL, a pointer to a header to be prefixed to the\r
- data at BufferPtr. \r
+ data at BufferPtr.\r
@param BufferSize A pointer to the size of the data at BufferPtr.\r
@param BufferPtr A pointer to the data to be written.\r
- \r
+\r
@retval EFI_SUCCESS The UDP Write operation was completed.\r
@retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
- @retval EFI_INVALID_PARAMETER One or more parameters are invalid. \r
- @retval EFI_BAD_BUFFER_SIZE The buffer is too long to be transmitted. \r
+ @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
+ @retval EFI_BAD_BUFFER_SIZE The buffer is too long to be transmitted.\r
@retval EFI_ABORTED The callback function aborted the UDP Write operation.\r
@retval EFI_TIMEOUT The UDP Write operation timed out.\r
- @retval EFI_ICMP_ERROR An ICMP error packet was received during the UDP write session. \r
- \r
+ @retval EFI_ICMP_ERROR An ICMP error packet was received during the UDP write session.\r
+\r
**/\r
typedef\r
EFI_STATUS\r
IN VOID *BufferPtr\r
);\r
\r
-/** \r
+/**\r
Reads a UDP packet from the network interface.\r
\r
This function reads a UDP packet from a network interface. The data contents\r
Depending on the values of OpFlags and the DestIp, DestPort, SrcIp, and SrcPort\r
input values, different types of UDP packet receive filtering will be performed.\r
The following tables summarize these receive filter operations.\r
- \r
+\r
@param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
- @param OpFlags The UDP operation flags. \r
+ @param OpFlags The UDP operation flags.\r
@param DestIp The destination IP address.\r
@param DestPort The destination UDP port number.\r
@param SrcIp The source IP address.\r
@param SrcPort The source UDP port number.\r
@param HeaderSize An optional field which may be set to the length of a header at\r
- HeaderPtr to be prefixed to the data at BufferPtr. \r
+ HeaderPtr to be prefixed to the data at BufferPtr.\r
@param HeaderPtr If HeaderSize is not NULL, a pointer to a header to be prefixed to the\r
- data at BufferPtr. \r
+ data at BufferPtr.\r
@param BufferSize A pointer to the size of the data at BufferPtr.\r
@param BufferPtr A pointer to the data to be read.\r
- \r
+\r
@retval EFI_SUCCESS The UDP Read operation was completed.\r
@retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
- @retval EFI_INVALID_PARAMETER One or more parameters are invalid. \r
+ @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
@retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r
@retval EFI_BUFFER_TOO_SMALL The packet is larger than Buffer can hold.\r
@retval EFI_ABORTED The callback function aborted the UDP Read operation.\r
- @retval EFI_TIMEOUT The UDP Read operation timed out. \r
- \r
+ @retval EFI_TIMEOUT The UDP Read operation timed out.\r
+\r
**/\r
typedef\r
EFI_STATUS\r
IN VOID *BufferPtr\r
);\r
\r
-/** \r
+/**\r
Updates the IP receive filters of a network device and enables software filtering.\r
- \r
+\r
The NewFilter field is used to modify the network device's current IP receive\r
filter settings and to enable a software filter. This function updates the IpFilter\r
field of the EFI_PXE_BASE_CODE_MODE structure with the contents of NewIpFilter.\r
The IPlist field is used to enable IPs other than the StationIP. They may be\r
multicast or unicast. If IPcnt is set as well as EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP,\r
then both the StationIP and the IPs from the IPlist will be used.\r
- \r
+\r
@param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
@param NewFilter The pointer to the new set of IP receive filters.\r
- \r
+\r
@retval EFI_SUCCESS The IP receive filter settings were updated.\r
@retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
- @retval EFI_INVALID_PARAMETER One or more parameters are invalid. \r
- \r
+ @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
+\r
**/\r
typedef\r
EFI_STATUS\r
IN EFI_PXE_BASE_CODE_IP_FILTER *NewFilter\r
);\r
\r
-/** \r
+/**\r
Uses the ARP protocol to resolve a MAC address.\r
- \r
+\r
This function uses the ARP protocol to resolve a MAC address. The UsingIpv6 field\r
of the EFI_PXE_BASE_CODE_MODE structure is used to determine if IPv4 or IPv6\r
addresses are being used. The IP address specified by IpAddr is used to resolve\r
to resolve an address, then EFI_TIMEOUT is returned. If the Callback Protocol\r
does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED is\r
returned.\r
- \r
+\r
@param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
@param IpAddr The pointer to the IP address that is used to resolve a MAC address.\r
@param MacAddr If not NULL, a pointer to the MAC address that was resolved with the\r
- ARP protocol. \r
- \r
+ ARP protocol.\r
+\r
@retval EFI_SUCCESS The IP or MAC address was resolved.\r
@retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
- @retval EFI_INVALID_PARAMETER One or more parameters are invalid. \r
- @retval EFI_DEVICE_ERROR The network device encountered an error during this operation. \r
+ @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
+ @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r
@retval EFI_ABORTED The callback function aborted the ARP Protocol.\r
@retval EFI_TIMEOUT The ARP Protocol encountered a timeout condition.\r
- \r
+\r
**/\r
typedef\r
EFI_STATUS\r
IN EFI_MAC_ADDRESS *MacAddr OPTIONAL\r
);\r
\r
-/** \r
+/**\r
Updates the parameters that affect the operation of the PXE Base Code Protocol.\r
- \r
+\r
This function sets parameters that affect the operation of the PXE Base Code Protocol.\r
The parameter specified by NewAutoArp is used to control the generation of ARP\r
protocol packets. If NewAutoArp is TRUE, then ARP Protocol packets will be generated\r
the EFI_PXE_BASE_CODE_MODE structure to NewAutoArp.\r
The SetParameters() call must be invoked after a Callback Protocol is installed\r
to enable the use of callbacks.\r
- \r
+\r
@param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
@param NewAutoArp If not NULL, a pointer to a value that specifies whether to replace the\r
- current value of AutoARP. \r
+ current value of AutoARP.\r
@param NewSendGUID If not NULL, a pointer to a value that specifies whether to replace the\r
- current value of SendGUID. \r
+ current value of SendGUID.\r
@param NewTTL If not NULL, a pointer to be used in place of the current value of TTL,\r
- the "time to live" field of the IP header. \r
+ the "time to live" field of the IP header.\r
@param NewToS If not NULL, a pointer to be used in place of the current value of ToS,\r
- the "type of service" field of the IP header. \r
+ the "type of service" field of the IP header.\r
@param NewMakeCallback If not NULL, a pointer to a value that specifies whether to replace the\r
- current value of the MakeCallback field of the Mode structure. \r
- \r
+ current value of the MakeCallback field of the Mode structure.\r
+\r
@retval EFI_SUCCESS The new parameters values were updated.\r
@retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
- @retval EFI_INVALID_PARAMETER One or more parameters are invalid. \r
- \r
+ @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
+\r
**/\r
typedef\r
EFI_STATUS\r
IN BOOLEAN *NewMakeCallback OPTIONAL\r
);\r
\r
-/** \r
+/**\r
Updates the station IP address and/or subnet mask values of a network device.\r
- \r
+\r
This function updates the station IP address and/or subnet mask values of a network\r
device.\r
The NewStationIp field is used to modify the network device's current IP address.\r
mask. If NewSubnetMask is NULL, then the current subnet mask will not be modified.\r
Otherwise, this function updates the SubnetMask field of the EFI_PXE_BASE_CODE_MODE\r
structure with NewSubnetMask.\r
- \r
+\r
@param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
- @param NewStationIp The pointer to the new IP address to be used by the network device. \r
- @param NewSubnetMask The pointer to the new subnet mask to be used by the network device. \r
- \r
+ @param NewStationIp The pointer to the new IP address to be used by the network device.\r
+ @param NewSubnetMask The pointer to the new subnet mask to be used by the network device.\r
+\r
@retval EFI_SUCCESS The new station IP address and/or subnet mask were updated.\r
@retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
- @retval EFI_INVALID_PARAMETER One or more parameters are invalid. \r
- \r
+ @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
+\r
**/\r
typedef\r
EFI_STATUS\r
IN EFI_IP_ADDRESS *NewSubnetMask OPTIONAL\r
);\r
\r
-/** \r
+/**\r
Updates the contents of the cached DHCP and Discover packets.\r
- \r
+\r
The pointers to the new packets are used to update the contents of the cached\r
packets in the EFI_PXE_BASE_CODE_MODE structure.\r
- \r
+\r
@param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
@param NewDhcpDiscoverValid The pointer to a value that will replace the current\r
- DhcpDiscoverValid field. \r
+ DhcpDiscoverValid field.\r
@param NewDhcpAckReceived The pointer to a value that will replace the current\r
- DhcpAckReceived field. \r
+ DhcpAckReceived field.\r
@param NewProxyOfferReceived The pointer to a value that will replace the current\r
- ProxyOfferReceived field. \r
- @param NewPxeDiscoverValid The pointer to a value that will replace the current \r
- ProxyOfferReceived field. \r
+ ProxyOfferReceived field.\r
+ @param NewPxeDiscoverValid The pointer to a value that will replace the current\r
+ ProxyOfferReceived field.\r
@param NewPxeReplyReceived The pointer to a value that will replace the current\r
- PxeReplyReceived field. \r
+ PxeReplyReceived field.\r
@param NewPxeBisReplyReceived The pointer to a value that will replace the current\r
- PxeBisReplyReceived field. \r
- @param NewDhcpDiscover The pointer to the new cached DHCP Discover packet contents. \r
+ PxeBisReplyReceived field.\r
+ @param NewDhcpDiscover The pointer to the new cached DHCP Discover packet contents.\r
@param NewDhcpAck The pointer to the new cached DHCP Ack packet contents.\r
@param NewProxyOffer The pointer to the new cached Proxy Offer packet contents.\r
@param NewPxeDiscover The pointer to the new cached PXE Discover packet contents.\r
@param NewPxeReply The pointer to the new cached PXE Reply packet contents.\r
@param NewPxeBisReply The pointer to the new cached PXE BIS Reply packet contents.\r
- \r
+\r
@retval EFI_SUCCESS The cached packet contents were updated.\r
@retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
@retval EFI_INVALID_PARAMETER This is NULL or not point to a valid EFI_PXE_BASE_CODE_PROTOCOL structure.\r
- \r
+\r
**/\r
typedef\r
EFI_STATUS\r
\r
//\r
// Revision defined in EFI1.1\r
-// \r
+//\r
#define EFI_PXE_BASE_CODE_INTERFACE_REVISION EFI_PXE_BASE_CODE_PROTOCOL_REVISION\r
\r
///\r
///\r
struct _EFI_PXE_BASE_CODE_PROTOCOL {\r
///\r
- /// The revision of the EFI_PXE_BASE_CODE_PROTOCOL. All future revisions must \r
- /// be backwards compatible. If a future version is not backwards compatible \r
+ /// The revision of the EFI_PXE_BASE_CODE_PROTOCOL. All future revisions must\r
+ /// be backwards compatible. If a future version is not backwards compatible\r
/// it is not the same GUID.\r
///\r
UINT64 Revision;\r
\r
extern EFI_GUID gEfiPxeBaseCodeProtocolGuid;\r
\r
-#endif \r
+#endif\r
projects / mirror_edk2.git / blobdiff