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 \r
- All rights reserved. This program and the accompanying materials \r
- are licensed and made available under the terms and conditions of the BSD License \r
- which accompanies this distribution. 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
+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
+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
\r
@par Revision Reference: \r
- This Protocol is introduced in EFI Specification 1.10 \r
+ This Protocol is introduced in EFI Specification 1.10. \r
\r
**/\r
#ifndef __PXE_BASE_CODE_PROTOCOL_H__\r
#define __PXE_BASE_CODE_PROTOCOL_H__\r
\r
///\r
-/// PXE Base Code protocol\r
+/// PXE Base Code protocol.\r
///\r
#define EFI_PXE_BASE_CODE_PROTOCOL_GUID \\r
{ \\r
#define DEFAULT_ToS 0\r
\r
///\r
-/// ICMP error format\r
+/// ICMP error format.\r
///\r
typedef struct {\r
UINT8 Type;\r
} EFI_PXE_BASE_CODE_ICMP_ERROR;\r
\r
///\r
-/// TFTP error format\r
+/// TFTP error format.\r
///\r
typedef struct {\r
UINT8 ErrorCode;\r
} EFI_PXE_BASE_CODE_TFTP_ERROR;\r
\r
///\r
-/// IP Receive Filter definitions\r
+/// IP Receive Filter definitions.\r
///\r
#define EFI_PXE_BASE_CODE_MAX_IPCNT 8\r
\r
///\r
-/// IP Receive Filter structure\r
+/// IP Receive Filter structure.\r
///\r
typedef struct {\r
UINT8 Filters;\r
#define EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS_MULTICAST 0x0008\r
\r
///\r
-/// ARP cache entries\r
+/// ARP cache entries.\r
///\r
typedef struct {\r
EFI_IP_ADDRESS IpAddr;\r
} EFI_PXE_BASE_CODE_ARP_ENTRY;\r
\r
///\r
-/// ARP route table entries\r
+/// ARP route table entries.\r
///\r
typedef struct {\r
EFI_IP_ADDRESS IpAddr;\r
} EFI_PXE_BASE_CODE_DISCOVER_INFO;\r
\r
///\r
-/// TFTP opcode definitions\r
+/// TFTP opcode definitions.\r
///\r
typedef enum {\r
EFI_PXE_BASE_CODE_TFTP_FIRST,\r
} EFI_PXE_BASE_CODE_MTFTP_INFO;\r
\r
///\r
-/// DHCPV4 Packet structure\r
+/// DHCPV4 Packet structure.\r
///\r
typedef struct {\r
UINT8 BootpOpcode;\r
} EFI_PXE_BASE_CODE_DHCPV6_PACKET;\r
\r
///\r
-/// Packet structure\r
+/// Packet structure.\r
///\r
typedef union {\r
UINT8 Raw[1472];\r
#define EFI_PXE_BASE_CODE_MAX_ROUTE_ENTRIES 8\r
\r
///\r
-/// EFI_PXE_BASE_CODE_MODE\r
+/// EFI_PXE_BASE_CODE_MODE.\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
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
- @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\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
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
- @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
+ @param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\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
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
- @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\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
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
- @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\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 Pointer to the boot server layer number to discover, which must be\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
- @param Info Pointer to a data structure that contains additional information on the\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
@retval EFI_SUCCESS The Discovery sequence has been completed.\r
entry is itself null-terminated, so that the final information string is terminated\r
with two null octets.\r
\r
- @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\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 Overwrite Only used on write file operations. TRUE if a file on a remote server can\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
- @param Info Pointer to the MTFTP information.\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
@retval EFI_SUCCESS The TFTP/MTFTP operation was completed.\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
- @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
+ @param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
@param OpFlags The UDP operation flags. \r
@param DestIp The destination IP address.\r
@param DestPort The destination UDP port number. \r
\r
This function reads a UDP packet from a network interface. The data contents\r
are returned in (the optional HeaderPtr and) BufferPtr, and the size of the\r
- buffer received is returned in BufferSize . If the input BufferSize is smaller\r
+ buffer received is returned in BufferSize. If the input BufferSize is smaller\r
than the UDP packet received (less optional HeaderSize), it will be set to the\r
required size, and EFI_BUFFER_TOO_SMALL will be returned. In this case, the\r
contents of BufferPtr are undefined, and the packet is lost. If a UDP packet is\r
input values, different types of UDP packet receive filtering will be performed.\r
The following tables summarize these receive filter operations.\r
\r
- @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
+ @param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
@param OpFlags The UDP operation flags. \r
@param DestIp The destination IP address.\r
@param DestPort The destination UDP port number.\r
If an application or driver wishes to preserve the IP receive filter settings,\r
it will have to preserve the IP receive filter settings before these calls, and\r
use SetIpFilter() to restore them after the calls. If incompatible filtering is\r
- requested (for example, PROMISCUOUS with anything else) or if the device does not\r
+ requested (for example, PROMISCUOUS with anything else), or if the device does not\r
support a requested filter setting and it cannot be accommodated in software\r
(for example, PROMISCUOUS not supported), EFI_INVALID_PARAMETER will be returned.\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
- @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
- @param NewFilter Pointer to the new set of IP receive filters.\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
@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
does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED is\r
returned.\r
\r
- @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
- @param IpAddr Pointer to the IP address that is used to resolve a MAC address.\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
The SetParameters() call must be invoked after a Callback Protocol is installed\r
to enable the use of callbacks.\r
\r
- @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\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
@param NewSendGUID If not NULL, a pointer to a value that specifies whether to replace the\r
Otherwise, this function updates the SubnetMask field of the EFI_PXE_BASE_CODE_MODE\r
structure with NewSubnetMask.\r
\r
- @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
- @param NewStationIp Pointer to the new IP address to be used by the network device. \r
- @param NewSubnetMask Pointer to the new subnet mask to be used by the network device. \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
@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
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
- @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
- @param NewDhcpDiscoverValid Pointer to a value that will replace the current\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
- @param NewDhcpAckReceived Pointer to a value that will replace the current\r
+ @param NewDhcpAckReceived The pointer to a value that will replace the current\r
DhcpAckReceived field. \r
- @param NewProxyOfferReceived Pointer to a value that will replace the current\r
+ @param NewProxyOfferReceived The pointer to a value that will replace the current\r
ProxyOfferReceived field. \r
- @param NewPxeDiscoverValid Pointer to a value that will replace the current \r
+ @param NewPxeDiscoverValid The pointer to a value that will replace the current \r
ProxyOfferReceived field. \r
- @param NewPxeReplyReceived Pointer to a value that will replace the current\r
+ @param NewPxeReplyReceived The pointer to a value that will replace the current\r
PxeReplyReceived field. \r
- @param NewPxeBisReplyReceived Pointer to a value that will replace the current\r
+ @param NewPxeBisReplyReceived The pointer to a value that will replace the current\r
PxeBisReplyReceived field. \r
- @param NewDhcpDiscover Pointer to the new cached DHCP Discover packet contents. \r
- @param NewDhcpAck Pointer to the new cached DHCP Ack packet contents.\r
- @param NewProxyOffer Pointer to the new cached Proxy Offer packet contents.\r
- @param NewPxeDiscover Pointer to the new cached PXE Discover packet contents.\r
- @param NewPxeReply Pointer to the new cached PXE Reply packet contents.\r
- @param NewPxeBisReply Pointer to the new cached PXE BIS Reply packet contents.\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
@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
EFI_PXE_BASE_CODE_SET_STATION_IP SetStationIp;\r
EFI_PXE_BASE_CODE_SET_PACKETS SetPackets;\r
///\r
- /// Pointer to the EFI_PXE_BASE_CODE_MODE data for this device.\r
+ /// The pointer to the EFI_PXE_BASE_CODE_MODE data for this device.\r
///\r
EFI_PXE_BASE_CODE_MODE *Mode;\r
};\r
projects / mirror_edk2.git / blobdiff