iPXE
Data Structures | Defines | Typedefs | Enumerations | Functions | Variables
PxeBaseCode.h File Reference

EFI PXE Base Code Protocol definitions, which is used to access PXE-compatible devices for network access and network booting. More...

Go to the source code of this file.

Data Structures

struct  EFI_PXE_BASE_CODE_ICMP_ERROR
 ICMP error format. More...
struct  EFI_PXE_BASE_CODE_TFTP_ERROR
 TFTP error format. More...
struct  EFI_PXE_BASE_CODE_IP_FILTER
 IP Receive Filter structure. More...
struct  EFI_PXE_BASE_CODE_ARP_ENTRY
 ARP cache entries. More...
struct  EFI_PXE_BASE_CODE_ROUTE_ENTRY
 ARP route table entries. More...
struct  EFI_PXE_BASE_CODE_SRVLIST
 Discover() server list structure. More...
struct  EFI_PXE_BASE_CODE_DISCOVER_INFO
 Discover() information override structure. More...
struct  EFI_PXE_BASE_CODE_MTFTP_INFO
 MTFTP information. More...
struct  EFI_PXE_BASE_CODE_DHCPV4_PACKET
 DHCPV4 Packet structure. More...
struct  EFI_PXE_BASE_CODE_DHCPV6_PACKET
 DHCPV6 Packet structure. More...
union  EFI_PXE_BASE_CODE_PACKET
 Packet structure. More...
struct  EFI_PXE_BASE_CODE_MODE
 EFI_PXE_BASE_CODE_MODE. More...
struct  _EFI_PXE_BASE_CODE_PROTOCOL
 The EFI_PXE_BASE_CODE_PROTOCOL is used to control PXE-compatible devices. More...

Defines

#define EFI_PXE_BASE_CODE_PROTOCOL_GUID
 PXE Base Code protocol.
#define DEFAULT_TTL   16
 Default IP TTL and ToS.
#define DEFAULT_ToS   0
#define EFI_PXE_BASE_CODE_MAX_IPCNT   8
 IP Receive Filter definitions.
#define EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP   0x0001
#define EFI_PXE_BASE_CODE_IP_FILTER_BROADCAST   0x0002
#define EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS   0x0004
#define EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS_MULTICAST   0x0008
#define EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_IP   0x0001
#define EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT   0x0002
#define EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_IP   0x0004
#define EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_PORT   0x0008
#define EFI_PXE_BASE_CODE_UDP_OPFLAGS_USE_FILTER   0x0010
#define EFI_PXE_BASE_CODE_UDP_OPFLAGS_MAY_FRAGMENT   0x0020
#define EFI_PXE_BASE_CODE_BOOT_TYPE_BOOTSTRAP   0
#define EFI_PXE_BASE_CODE_BOOT_TYPE_MS_WINNT_RIS   1
#define EFI_PXE_BASE_CODE_BOOT_TYPE_INTEL_LCM   2
#define EFI_PXE_BASE_CODE_BOOT_TYPE_DOSUNDI   3
#define EFI_PXE_BASE_CODE_BOOT_TYPE_NEC_ESMPRO   4
#define EFI_PXE_BASE_CODE_BOOT_TYPE_IBM_WSoD   5
#define EFI_PXE_BASE_CODE_BOOT_TYPE_IBM_LCCM   6
#define EFI_PXE_BASE_CODE_BOOT_TYPE_CA_UNICENTER_TNG   7
#define EFI_PXE_BASE_CODE_BOOT_TYPE_HP_OPENVIEW   8
#define EFI_PXE_BASE_CODE_BOOT_TYPE_ALTIRIS_9   9
#define EFI_PXE_BASE_CODE_BOOT_TYPE_ALTIRIS_10   10
#define EFI_PXE_BASE_CODE_BOOT_TYPE_ALTIRIS_11   11
#define EFI_PXE_BASE_CODE_BOOT_TYPE_NOT_USED_12   12
#define EFI_PXE_BASE_CODE_BOOT_TYPE_REDHAT_INSTALL   13
#define EFI_PXE_BASE_CODE_BOOT_TYPE_REDHAT_BOOT   14
#define EFI_PXE_BASE_CODE_BOOT_TYPE_REMBO   15
#define EFI_PXE_BASE_CODE_BOOT_TYPE_BEOBOOT   16
#define EFI_PXE_BASE_CODE_BOOT_TYPE_PXETEST   65535
#define EFI_PXE_BASE_CODE_BOOT_LAYER_MASK   0x7FFF
#define EFI_PXE_BASE_CODE_BOOT_LAYER_INITIAL   0x0000
#define EFI_PXE_BASE_CODE_MAX_ARP_ENTRIES   8
#define EFI_PXE_BASE_CODE_MAX_ROUTE_ENTRIES   8
#define EFI_PXE_BASE_CODE_PROTOCOL_REVISION   0x00010000
#define EFI_PXE_BASE_CODE_INTERFACE_REVISION   EFI_PXE_BASE_CODE_PROTOCOL_REVISION

Typedefs

typedef struct
_EFI_PXE_BASE_CODE_PROTOCOL 
EFI_PXE_BASE_CODE_PROTOCOL
typedef EFI_PXE_BASE_CODE_PROTOCOL EFI_PXE_BASE_CODE
 Protocol defined in EFI1.1.
typedef UINT16 EFI_PXE_BASE_CODE_UDP_PORT
typedef EFI_STATUS(EFIAPIEFI_PXE_BASE_CODE_START )(IN EFI_PXE_BASE_CODE_PROTOCOL *This, IN BOOLEAN UseIpv6)
 Enables the use of the PXE Base Code Protocol functions.
typedef EFI_STATUS(EFIAPIEFI_PXE_BASE_CODE_STOP )(IN EFI_PXE_BASE_CODE_PROTOCOL *This)
 Disables the use of the PXE Base Code Protocol functions.
typedef EFI_STATUS(EFIAPIEFI_PXE_BASE_CODE_DHCP )(IN EFI_PXE_BASE_CODE_PROTOCOL *This, IN BOOLEAN SortOffers)
 Attempts to complete a DHCPv4 D.O.R.A.
typedef EFI_STATUS(EFIAPIEFI_PXE_BASE_CODE_DISCOVER )(IN EFI_PXE_BASE_CODE_PROTOCOL *This, IN UINT16 Type, IN UINT16 *Layer, IN BOOLEAN UseBis, IN EFI_PXE_BASE_CODE_DISCOVER_INFO *Info OPTIONAL)
 Attempts to complete the PXE Boot Server and/or boot image discovery sequence.
typedef EFI_STATUS(EFIAPIEFI_PXE_BASE_CODE_MTFTP )(IN EFI_PXE_BASE_CODE_PROTOCOL *This, IN EFI_PXE_BASE_CODE_TFTP_OPCODE Operation, IN OUT VOID *BufferPtr OPTIONAL, IN BOOLEAN Overwrite, IN OUT UINT64 *BufferSize, IN UINTN *BlockSize OPTIONAL, IN EFI_IP_ADDRESS *ServerIp, IN UINT8 *Filename OPTIONAL, IN EFI_PXE_BASE_CODE_MTFTP_INFO *Info OPTIONAL, IN BOOLEAN DontUseBuffer)
 Used to perform TFTP and MTFTP services.
typedef EFI_STATUS(EFIAPIEFI_PXE_BASE_CODE_UDP_WRITE )(IN EFI_PXE_BASE_CODE_PROTOCOL *This, IN UINT16 OpFlags, IN EFI_IP_ADDRESS *DestIp, IN EFI_PXE_BASE_CODE_UDP_PORT *DestPort, IN EFI_IP_ADDRESS *GatewayIp, OPTIONAL IN EFI_IP_ADDRESS *SrcIp, OPTIONAL IN OUT EFI_PXE_BASE_CODE_UDP_PORT *SrcPort, OPTIONAL IN UINTN *HeaderSize, OPTIONAL IN VOID *HeaderPtr, OPTIONAL IN UINTN *BufferSize, IN VOID *BufferPtr)
 Writes a UDP packet to the network interface.
typedef EFI_STATUS(EFIAPIEFI_PXE_BASE_CODE_UDP_READ )(IN EFI_PXE_BASE_CODE_PROTOCOL *This, IN UINT16 OpFlags, IN OUT EFI_IP_ADDRESS *DestIp, OPTIONAL IN OUT EFI_PXE_BASE_CODE_UDP_PORT *DestPort, OPTIONAL IN OUT EFI_IP_ADDRESS *SrcIp, OPTIONAL IN OUT EFI_PXE_BASE_CODE_UDP_PORT *SrcPort, OPTIONAL IN UINTN *HeaderSize, OPTIONAL IN VOID *HeaderPtr, OPTIONAL IN OUT UINTN *BufferSize, IN VOID *BufferPtr)
 Reads a UDP packet from the network interface.
typedef EFI_STATUS(EFIAPIEFI_PXE_BASE_CODE_SET_IP_FILTER )(IN EFI_PXE_BASE_CODE_PROTOCOL *This, IN EFI_PXE_BASE_CODE_IP_FILTER *NewFilter)
 Updates the IP receive filters of a network device and enables software filtering.
typedef EFI_STATUS(EFIAPIEFI_PXE_BASE_CODE_ARP )(IN EFI_PXE_BASE_CODE_PROTOCOL *This, IN EFI_IP_ADDRESS *IpAddr, IN EFI_MAC_ADDRESS *MacAddr OPTIONAL)
 Uses the ARP protocol to resolve a MAC address.
typedef EFI_STATUS(EFIAPIEFI_PXE_BASE_CODE_SET_PARAMETERS )(IN EFI_PXE_BASE_CODE_PROTOCOL *This, IN BOOLEAN *NewAutoArp, OPTIONAL IN BOOLEAN *NewSendGUID, OPTIONAL IN UINT8 *NewTTL, OPTIONAL IN UINT8 *NewToS, OPTIONAL IN BOOLEAN *NewMakeCallback OPTIONAL)
 Updates the parameters that affect the operation of the PXE Base Code Protocol.
typedef EFI_STATUS(EFIAPIEFI_PXE_BASE_CODE_SET_STATION_IP )(IN EFI_PXE_BASE_CODE_PROTOCOL *This, IN EFI_IP_ADDRESS *NewStationIp, OPTIONAL IN EFI_IP_ADDRESS *NewSubnetMask OPTIONAL)
 Updates the station IP address and/or subnet mask values of a network device.
typedef EFI_STATUS(EFIAPIEFI_PXE_BASE_CODE_SET_PACKETS )(IN EFI_PXE_BASE_CODE_PROTOCOL *This, BOOLEAN *NewDhcpDiscoverValid, OPTIONAL BOOLEAN *NewDhcpAckReceived, OPTIONAL BOOLEAN *NewProxyOfferReceived, OPTIONAL BOOLEAN *NewPxeDiscoverValid, OPTIONAL BOOLEAN *NewPxeReplyReceived, OPTIONAL BOOLEAN *NewPxeBisReplyReceived, OPTIONAL IN EFI_PXE_BASE_CODE_PACKET *NewDhcpDiscover, OPTIONAL IN EFI_PXE_BASE_CODE_PACKET *NewDhcpAck, OPTIONAL IN EFI_PXE_BASE_CODE_PACKET *NewProxyOffer, OPTIONAL IN EFI_PXE_BASE_CODE_PACKET *NewPxeDiscover, OPTIONAL IN EFI_PXE_BASE_CODE_PACKET *NewPxeReply, OPTIONAL IN EFI_PXE_BASE_CODE_PACKET *NewPxeBisReply OPTIONAL)
 Updates the contents of the cached DHCP and Discover packets.

Enumerations

enum  EFI_PXE_BASE_CODE_TFTP_OPCODE {
  EFI_PXE_BASE_CODE_TFTP_FIRST, EFI_PXE_BASE_CODE_TFTP_GET_FILE_SIZE, EFI_PXE_BASE_CODE_TFTP_READ_FILE, EFI_PXE_BASE_CODE_TFTP_WRITE_FILE,
  EFI_PXE_BASE_CODE_TFTP_READ_DIRECTORY, EFI_PXE_BASE_CODE_MTFTP_GET_FILE_SIZE, EFI_PXE_BASE_CODE_MTFTP_READ_FILE, EFI_PXE_BASE_CODE_MTFTP_READ_DIRECTORY,
  EFI_PXE_BASE_CODE_MTFTP_LAST
}
 TFTP opcode definitions. More...

Functions

 FILE_LICENCE (BSD3)

Variables

EFI_GUID gEfiPxeBaseCodeProtocolGuid

Detailed Description

EFI PXE Base Code Protocol definitions, which is used to access PXE-compatible devices for network access and network booting.

Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Revision Reference:
This Protocol is introduced in EFI Specification 1.10.

Definition in file PxeBaseCode.h.


Define Documentation

Value:
{ \
    0x03c4e603, 0xac28, 0x11d3, {0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \
  }

PXE Base Code protocol.

Definition at line 26 of file PxeBaseCode.h.

#define DEFAULT_TTL   16

Default IP TTL and ToS.

Definition at line 41 of file PxeBaseCode.h.

Referenced by efi_pxe_start().

#define DEFAULT_ToS   0

Definition at line 42 of file PxeBaseCode.h.

Referenced by efi_pxe_start().

IP Receive Filter definitions.

Definition at line 74 of file PxeBaseCode.h.

Definition at line 86 of file PxeBaseCode.h.

Referenced by efi_pxe_ip_filter(), and efi_pxe_start().

Definition at line 87 of file PxeBaseCode.h.

Referenced by efi_pxe_ip_filter(), and efi_pxe_start().

Definition at line 88 of file PxeBaseCode.h.

Referenced by efi_pxe_ip_filter(), and efi_pxe_start().

Definition at line 89 of file PxeBaseCode.h.

Referenced by efi_pxe_ip_filter(), and efi_pxe_start().

Definition at line 113 of file PxeBaseCode.h.

Referenced by efi_pxe_udp_read().

Definition at line 114 of file PxeBaseCode.h.

Referenced by efi_pxe_udp_read(), and efi_pxe_udp_write().

Definition at line 115 of file PxeBaseCode.h.

Referenced by efi_pxe_udp_read().

Definition at line 116 of file PxeBaseCode.h.

Referenced by efi_pxe_udp_read().

Definition at line 117 of file PxeBaseCode.h.

Referenced by efi_pxe_udp_read().

Definition at line 118 of file PxeBaseCode.h.

Referenced by efi_pxe_udp_write().

Definition at line 123 of file PxeBaseCode.h.

Definition at line 124 of file PxeBaseCode.h.

Definition at line 125 of file PxeBaseCode.h.

Definition at line 126 of file PxeBaseCode.h.

Definition at line 127 of file PxeBaseCode.h.

Definition at line 128 of file PxeBaseCode.h.

Definition at line 129 of file PxeBaseCode.h.

Definition at line 130 of file PxeBaseCode.h.

Definition at line 131 of file PxeBaseCode.h.

Definition at line 132 of file PxeBaseCode.h.

Definition at line 133 of file PxeBaseCode.h.

Definition at line 134 of file PxeBaseCode.h.

Definition at line 135 of file PxeBaseCode.h.

Definition at line 136 of file PxeBaseCode.h.

Definition at line 137 of file PxeBaseCode.h.

Definition at line 138 of file PxeBaseCode.h.

Definition at line 139 of file PxeBaseCode.h.

Definition at line 145 of file PxeBaseCode.h.

#define EFI_PXE_BASE_CODE_BOOT_LAYER_MASK   0x7FFF

Definition at line 147 of file PxeBaseCode.h.

Definition at line 148 of file PxeBaseCode.h.

Definition at line 263 of file PxeBaseCode.h.

Definition at line 264 of file PxeBaseCode.h.

#define EFI_PXE_BASE_CODE_PROTOCOL_REVISION   0x00010000

Definition at line 894 of file PxeBaseCode.h.

Definition at line 899 of file PxeBaseCode.h.


Typedef Documentation

Definition at line 31 of file PxeBaseCode.h.

Protocol defined in EFI1.1.

Definition at line 36 of file PxeBaseCode.h.

Definition at line 111 of file PxeBaseCode.h.

Enables the use of the PXE Base Code Protocol functions.

This function enables the use of the PXE Base Code Protocol functions. If the Started field of the EFI_PXE_BASE_CODE_MODE structure is already TRUE, then EFI_ALREADY_STARTED will be returned. If UseIpv6 is TRUE, then IPv6 formatted addresses will be used in this session. If UseIpv6 is FALSE, then IPv4 formatted addresses will be used in this session. If UseIpv6 is TRUE, and the Ipv6Supported field of the EFI_PXE_BASE_CODE_MODE structure is FALSE, then EFI_UNSUPPORTED will be returned. If there is not enough memory or other resources to start the PXE Base Code Protocol, then EFI_OUT_OF_RESOURCES will be returned. Otherwise, the PXE Base Code Protocol will be started, and all of the fields of the EFI_PXE_BASE_CODE_MODE structure will be initialized as follows: StartedSet to TRUE. Ipv6SupportedUnchanged. Ipv6AvailableUnchanged. UsingIpv6Set to UseIpv6. BisSupportedUnchanged. BisDetectedUnchanged. AutoArpSet to TRUE. SendGUIDSet to FALSE. TTLSet to DEFAULT_TTL. ToSSet to DEFAULT_ToS. DhcpCompletedSet to FALSE. ProxyOfferReceivedSet to FALSE. StationIpSet to an address of all zeros. SubnetMaskSet to a subnet mask of all zeros. DhcpDiscoverZero-filled. DhcpAckZero-filled. ProxyOfferZero-filled. PxeDiscoverValidSet to FALSE. PxeDiscoverZero-filled. PxeReplyValidSet to FALSE. PxeReplyZero-filled. PxeBisReplyValidSet to FALSE. PxeBisReplyZero-filled. IpFilterSet the Filters field to 0 and the IpCnt field to 0. ArpCacheEntriesSet to 0. ArpCacheZero-filled. RouteTableEntriesSet to 0. RouteTableZero-filled. IcmpErrorReceivedSet to FALSE. IcmpErrorZero-filled. TftpErroReceivedSet to FALSE. TftpErrorZero-filled. MakeCallbacksSet to TRUE if the PXE Base Code Callback Protocol is available. Set to FALSE if the PXE Base Code Callback Protocol is not available.

Parameters:
ThisThe pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
UseIpv6Specifies the type of IP addresses that are to be used during the session that is being started. Set to TRUE for IPv6 addresses, and FALSE for IPv4 addresses.
Return values:
EFI_SUCCESSThe PXE Base Code Protocol was started.
EFI_DEVICE_ERRORThe network device encountered an error during this oper
EFI_UNSUPPORTEDUseIpv6 is TRUE, but the Ipv6Supported field of the EFI_PXE_BASE_CODE_MODE structure is FALSE.
EFI_ALREADY_STARTEDThe PXE Base Code Protocol is already in the started state.
EFI_INVALID_PARAMETERThe This parameter is NULL or does not point to a valid EFI_PXE_BASE_CODE_PROTOCOL structure.
EFI_OUT_OF_RESOURCESCould not allocate enough memory or other resources to start the PXE Base Code Protocol.

Definition at line 379 of file PxeBaseCode.h.

Disables the use of the PXE Base Code Protocol functions.

This function stops all activity on the network device. All the resources allocated in Start() are released, the Started field of the EFI_PXE_BASE_CODE_MODE structure is set to FALSE and EFI_SUCCESS is returned. If the Started field of the EFI_PXE_BASE_CODE_MODE structure is already FALSE, then EFI_NOT_STARTED will be returned.

Parameters:
ThisThe pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
Return values:
EFI_SUCCESSThe PXE Base Code Protocol was stopped.
EFI_NOT_STARTEDThe PXE Base Code Protocol is already in the stopped state.
EFI_INVALID_PARAMETERThe This parameter is NULL or does not point to a valid EFI_PXE_BASE_CODE_PROTOCOL structure.
EFI_DEVICE_ERRORThe network device encountered an error during this operation.

Definition at line 403 of file PxeBaseCode.h.

Attempts to complete a DHCPv4 D.O.R.A.

(discover / offer / request / acknowledge) or DHCPv6 S.A.R.R (solicit / advertise / request / reply) sequence.

This function attempts to complete the DHCP sequence. If this sequence is completed, then EFI_SUCCESS is returned, and the DhcpCompleted, ProxyOfferReceived, StationIp, SubnetMask, DhcpDiscover, DhcpAck, and ProxyOffer fields of the EFI_PXE_BASE_CODE_MODE structure are filled in. If SortOffers is TRUE, then the cached DHCP offer packets will be sorted before they are tried. If SortOffers is FALSE, then the cached DHCP offer packets will be tried in the order in which they are received. Please see the Preboot Execution Environment (PXE) Specification for additional details on the implementation of DHCP. This function can take at least 31 seconds to timeout and return control to the caller. If the DHCP sequence does not complete, then EFI_TIMEOUT will be returned. If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then the DHCP sequence will be stopped and EFI_ABORTED will be returned.

Parameters:
ThisThe pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
SortOffersTRUE if the offers received should be sorted. Set to FALSE to try the offers in the order that they are received.
Return values:
EFI_SUCCESSValid DHCP has completed.
EFI_NOT_STARTEDThe PXE Base Code Protocol is in the stopped state.
EFI_INVALID_PARAMETERThe This parameter is NULL or does not point to a valid EFI_PXE_BASE_CODE_PROTOCOL structure.
EFI_DEVICE_ERRORThe network device encountered an error during this operation.
EFI_OUT_OF_RESOURCESCould not allocate enough memory to complete the DHCP Protocol.
EFI_ABORTEDThe callback function aborted the DHCP Protocol.
EFI_TIMEOUTThe DHCP Protocol timed out.
EFI_ICMP_ERRORAn ICMP error packet was received during the DHCP session.
EFI_NO_RESPONSEValid PXE offer was not received.

Definition at line 442 of file PxeBaseCode.h.

Attempts to complete the PXE Boot Server and/or boot image discovery sequence.

This function attempts to complete the PXE Boot Server and/or boot image discovery sequence. If this sequence is completed, then EFI_SUCCESS is returned, and the PxeDiscoverValid, PxeDiscover, PxeReplyReceived, and PxeReply fields of the EFI_PXE_BASE_CODE_MODE structure are filled in. If UseBis is TRUE, then the PxeBisReplyReceived and PxeBisReply fields of the EFI_PXE_BASE_CODE_MODE structure will also be filled in. If UseBis is FALSE, then PxeBisReplyValid will be set to FALSE. In the structure referenced by parameter Info, the PXE Boot Server list, SrvList[], has two uses: It is the Boot Server IP address list used for unicast discovery (if the UseUCast field is TRUE), and it is the list used for Boot Server verification (if the MustUseList field is TRUE). Also, if the MustUseList field in that structure is TRUE and the AcceptAnyResponse field in the SrvList[] array is TRUE, any Boot Server reply of that type will be accepted. If the AcceptAnyResponse field is FALSE, only responses from Boot Servers with matching IP addresses will be accepted. This function can take at least 10 seconds to timeout and return control to the caller. If the Discovery sequence does not complete, then EFI_TIMEOUT will be returned. Please see the Preboot Execution Environment (PXE) Specification for additional details on the implementation of the Discovery sequence. If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then the Discovery sequence is stopped and EFI_ABORTED will be returned.

Parameters:
ThisThe pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
TypeThe type of bootstrap to perform.
LayerThe pointer to the boot server layer number to discover, which must be PXE_BOOT_LAYER_INITIAL when a new server type is being discovered.
UseBisTRUE if Boot Integrity Services are to be used. FALSE otherwise.
InfoThe pointer to a data structure that contains additional information on the type of discovery operation that is to be performed.
Return values:
EFI_SUCCESSThe Discovery sequence has been completed.
EFI_NOT_STARTEDThe PXE Base Code Protocol is in the stopped state.
EFI_INVALID_PARAMETEROne or more parameters are invalid.
EFI_DEVICE_ERRORThe network device encountered an error during this operation.
EFI_OUT_OF_RESOURCESCould not allocate enough memory to complete Discovery.
EFI_ABORTEDThe callback function aborted the Discovery sequence.
EFI_TIMEOUTThe Discovery sequence timed out.
EFI_ICMP_ERRORAn ICMP error packet was received during the PXE discovery session.

Definition at line 492 of file PxeBaseCode.h.

Used to perform TFTP and MTFTP services.

This function is used to perform TFTP and MTFTP services. This includes the TFTP operations to get the size of a file, read a directory, read a file, and write a file. It also includes the MTFTP operations to get the size of a file, read a directory, and read a file. The type of operation is specified by Operation. If the callback function that is invoked during the TFTP/MTFTP operation does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED will be returned. For read operations, the return data will be placed in the buffer specified by BufferPtr. If BufferSize is too small to contain the entire downloaded file, then EFI_BUFFER_TOO_SMALL will be returned and BufferSize will be set to zero or the size of the requested file (the size of the requested file is only returned if the TFTP server supports TFTP options). If BufferSize is large enough for the read operation, then BufferSize will be set to the size of the downloaded file, and EFI_SUCCESS will be returned. Applications using the PxeBc.Mtftp() services should use the get-file-size operations to determine the size of the downloaded file prior to using the read-file operations--especially when downloading large (greater than 64 MB) files--instead of making two calls to the read-file operation. Following this recommendation will save time if the file is larger than expected and the TFTP server does not support TFTP option extensions. Without TFTP option extension support, the client has to download the entire file, counting and discarding the received packets, to determine the file size. For write operations, the data to be sent is in the buffer specified by BufferPtr. BufferSize specifies the number of bytes to send. If the write operation completes successfully, then EFI_SUCCESS will be returned. For TFTP "get file size" operations, the size of the requested file or directory is returned in BufferSize, and EFI_SUCCESS will be returned. If the TFTP server does not support options, the file will be downloaded into a bit bucket and the length of the downloaded file will be returned. For MTFTP "get file size" operations, if the MTFTP server does not support the "get file size" option, EFI_UNSUPPORTED will be returned. This function can take up to 10 seconds to timeout and return control to the caller. If the TFTP sequence does not complete, EFI_TIMEOUT will be returned. If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then the TFTP sequence is stopped and EFI_ABORTED will be returned. The format of the data returned from a TFTP read directory operation is a null-terminated filename followed by a null-terminated information string, of the form "size year-month-day hour:minute:second" (i.e. d d-d-d d:d:f - note that the seconds field can be a decimal number), where the date and time are UTC. For an MTFTP read directory command, there is additionally a null-terminated multicast IP address preceding the filename of the form d.d.d.d for IP v4. The final entry is itself null-terminated, so that the final information string is terminated with two null octets.

Parameters:
ThisThe pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
OperationThe type of operation to perform.
BufferPtrA pointer to the data buffer.
OverwriteOnly used on write file operations. TRUE if a file on a remote server can be overwritten.
BufferSizeFor get-file-size operations, *BufferSize returns the size of the requested file.
BlockSizeThe requested block size to be used during a TFTP transfer.
ServerIpThe TFTP / MTFTP server IP address.
FilenameA Null-terminated ASCII string that specifies a directory name or a file name.
InfoThe pointer to the MTFTP information.
DontUseBufferSet to FALSE for normal TFTP and MTFTP read file operation.
Return values:
EFI_SUCCESSThe TFTP/MTFTP operation was completed.
EFI_NOT_STARTEDThe PXE Base Code Protocol is in the stopped state.
EFI_INVALID_PARAMETEROne or more parameters are invalid.
EFI_DEVICE_ERRORThe network device encountered an error during this operation.
EFI_BUFFER_TOO_SMALLThe buffer is not large enough to complete the read operation.
EFI_ABORTEDThe callback function aborted the TFTP/MTFTP operation.
EFI_TIMEOUTThe TFTP/MTFTP operation timed out.
EFI_ICMP_ERRORAn ICMP error packet was received during the MTFTP session.
EFI_TFTP_ERRORA TFTP error packet was received during the MTFTP session.

Definition at line 573 of file PxeBaseCode.h.

Writes a UDP packet to the network interface.

This function writes a UDP packet specified by the (optional HeaderPtr and) BufferPtr parameters to the network interface. The UDP header is automatically built by this routine. It uses the parameters OpFlags, DestIp, DestPort, GatewayIp, SrcIp, and SrcPort to build this header. If the packet is successfully built and transmitted through the network interface, then EFI_SUCCESS will be returned. If a timeout occurs during the transmission of the packet, then EFI_TIMEOUT will be returned. If an ICMP error occurs during the transmission of the packet, then the IcmpErrorReceived field is set to TRUE, the IcmpError field is filled in and EFI_ICMP_ERROR will be returned. If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED will be returned.

Parameters:
ThisThe pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
OpFlagsThe UDP operation flags.
DestIpThe destination IP address.
DestPortThe destination UDP port number.
GatewayIpThe gateway IP address.
SrcIpThe source IP address.
SrcPortThe source UDP port number.
HeaderSizeAn optional field which may be set to the length of a header at HeaderPtr to be prefixed to the data at BufferPtr.
HeaderPtrIf HeaderSize is not NULL, a pointer to a header to be prefixed to the data at BufferPtr.
BufferSizeA pointer to the size of the data at BufferPtr.
BufferPtrA pointer to the data to be written.
Return values:
EFI_SUCCESSThe UDP Write operation was completed.
EFI_NOT_STARTEDThe PXE Base Code Protocol is in the stopped state.
EFI_INVALID_PARAMETEROne or more parameters are invalid.
EFI_BAD_BUFFER_SIZEThe buffer is too long to be transmitted.
EFI_ABORTEDThe callback function aborted the UDP Write operation.
EFI_TIMEOUTThe UDP Write operation timed out.
EFI_ICMP_ERRORAn ICMP error packet was received during the UDP write session.

Definition at line 625 of file PxeBaseCode.h.

Reads a UDP packet from the network interface.

This function reads a UDP packet from a network interface. The data contents are returned in (the optional HeaderPtr and) BufferPtr, and the size of the buffer received is returned in BufferSize. If the input BufferSize is smaller than the UDP packet received (less optional HeaderSize), it will be set to the required size, and EFI_BUFFER_TOO_SMALL will be returned. In this case, the contents of BufferPtr are undefined, and the packet is lost. If a UDP packet is successfully received, then EFI_SUCCESS will be returned, and the information from the UDP header will be returned in DestIp, DestPort, SrcIp, and SrcPort if they are not NULL. Depending on the values of OpFlags and the DestIp, DestPort, SrcIp, and SrcPort input values, different types of UDP packet receive filtering will be performed. The following tables summarize these receive filter operations.

Parameters:
ThisThe pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
OpFlagsThe UDP operation flags.
DestIpThe destination IP address.
DestPortThe destination UDP port number.
SrcIpThe source IP address.
SrcPortThe source UDP port number.
HeaderSizeAn optional field which may be set to the length of a header at HeaderPtr to be prefixed to the data at BufferPtr.
HeaderPtrIf HeaderSize is not NULL, a pointer to a header to be prefixed to the data at BufferPtr.
BufferSizeA pointer to the size of the data at BufferPtr.
BufferPtrA pointer to the data to be read.
Return values:
EFI_SUCCESSThe UDP Read operation was completed.
EFI_NOT_STARTEDThe PXE Base Code Protocol is in the stopped state.
EFI_INVALID_PARAMETEROne or more parameters are invalid.
EFI_DEVICE_ERRORThe network device encountered an error during this operation.
EFI_BUFFER_TOO_SMALLThe packet is larger than Buffer can hold.
EFI_ABORTEDThe callback function aborted the UDP Read operation.
EFI_TIMEOUTThe UDP Read operation timed out.

Definition at line 679 of file PxeBaseCode.h.

Updates the IP receive filters of a network device and enables software filtering.

The NewFilter field is used to modify the network device's current IP receive filter settings and to enable a software filter. This function updates the IpFilter field of the EFI_PXE_BASE_CODE_MODE structure with the contents of NewIpFilter. The software filter is used when the USE_FILTER in OpFlags is set to UdpRead(). The current hardware filter remains in effect no matter what the settings of OpFlags are, so that the meaning of ANY_DEST_IP set in OpFlags to UdpRead() is from those packets whose reception is enabled in hardware - physical NIC address (unicast), broadcast address, logical address or addresses (multicast), or all (promiscuous). UdpRead() does not modify the IP filter settings. Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP receive filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP. If an application or driver wishes to preserve the IP receive filter settings, it will have to preserve the IP receive filter settings before these calls, and use SetIpFilter() to restore them after the calls. If incompatible filtering is requested (for example, PROMISCUOUS with anything else), or if the device does not support a requested filter setting and it cannot be accommodated in software (for example, PROMISCUOUS not supported), EFI_INVALID_PARAMETER will be returned. The IPlist field is used to enable IPs other than the StationIP. They may be multicast or unicast. If IPcnt is set as well as EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP, then both the StationIP and the IPs from the IPlist will be used.

Parameters:
ThisThe pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
NewFilterThe pointer to the new set of IP receive filters.
Return values:
EFI_SUCCESSThe IP receive filter settings were updated.
EFI_NOT_STARTEDThe PXE Base Code Protocol is in the stopped state.
EFI_INVALID_PARAMETEROne or more parameters are invalid.

Definition at line 726 of file PxeBaseCode.h.

Uses the ARP protocol to resolve a MAC address.

This function uses the ARP protocol to resolve a MAC address. The UsingIpv6 field of the EFI_PXE_BASE_CODE_MODE structure is used to determine if IPv4 or IPv6 addresses are being used. The IP address specified by IpAddr is used to resolve a MAC address. If the ARP protocol succeeds in resolving the specified address, then the ArpCacheEntries and ArpCache fields of the EFI_PXE_BASE_CODE_MODE structure are updated, and EFI_SUCCESS is returned. If MacAddr is not NULL, the resolved MAC address is placed there as well. If the PXE Base Code protocol is in the stopped state, then EFI_NOT_STARTED is returned. If the ARP protocol encounters a timeout condition while attempting to resolve an address, then EFI_TIMEOUT is returned. If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED is returned.

Parameters:
ThisThe pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
IpAddrThe pointer to the IP address that is used to resolve a MAC address.
MacAddrIf not NULL, a pointer to the MAC address that was resolved with the ARP protocol.
Return values:
EFI_SUCCESSThe IP or MAC address was resolved.
EFI_NOT_STARTEDThe PXE Base Code Protocol is in the stopped state.
EFI_INVALID_PARAMETEROne or more parameters are invalid.
EFI_DEVICE_ERRORThe network device encountered an error during this operation.
EFI_ABORTEDThe callback function aborted the ARP Protocol.
EFI_TIMEOUTThe ARP Protocol encountered a timeout condition.

Definition at line 762 of file PxeBaseCode.h.

Updates the parameters that affect the operation of the PXE Base Code Protocol.

This function sets parameters that affect the operation of the PXE Base Code Protocol. The parameter specified by NewAutoArp is used to control the generation of ARP protocol packets. If NewAutoArp is TRUE, then ARP Protocol packets will be generated as required by the PXE Base Code Protocol. If NewAutoArp is FALSE, then no ARP Protocol packets will be generated. In this case, the only mappings that are available are those stored in the ArpCache of the EFI_PXE_BASE_CODE_MODE structure. If there are not enough mappings in the ArpCache to perform a PXE Base Code Protocol service, then the service will fail. This function updates the AutoArp field of the EFI_PXE_BASE_CODE_MODE structure to NewAutoArp. The SetParameters() call must be invoked after a Callback Protocol is installed to enable the use of callbacks.

Parameters:
ThisThe pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
NewAutoArpIf not NULL, a pointer to a value that specifies whether to replace the current value of AutoARP.
NewSendGUIDIf not NULL, a pointer to a value that specifies whether to replace the current value of SendGUID.
NewTTLIf not NULL, a pointer to be used in place of the current value of TTL, the "time to live" field of the IP header.
NewToSIf not NULL, a pointer to be used in place of the current value of ToS, the "type of service" field of the IP header.
NewMakeCallbackIf not NULL, a pointer to a value that specifies whether to replace the current value of the MakeCallback field of the Mode structure.
Return values:
EFI_SUCCESSThe new parameters values were updated.
EFI_NOT_STARTEDThe PXE Base Code Protocol is in the stopped state.
EFI_INVALID_PARAMETEROne or more parameters are invalid.

Definition at line 802 of file PxeBaseCode.h.

Updates the station IP address and/or subnet mask values of a network device.

This function updates the station IP address and/or subnet mask values of a network device. The NewStationIp field is used to modify the network device's current IP address. If NewStationIP is NULL, then the current IP address will not be modified. Otherwise, this function updates the StationIp field of the EFI_PXE_BASE_CODE_MODE structure with NewStationIp. The NewSubnetMask field is used to modify the network device's current subnet mask. If NewSubnetMask is NULL, then the current subnet mask will not be modified. Otherwise, this function updates the SubnetMask field of the EFI_PXE_BASE_CODE_MODE structure with NewSubnetMask.

Parameters:
ThisThe pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
NewStationIpThe pointer to the new IP address to be used by the network device.
NewSubnetMaskThe pointer to the new subnet mask to be used by the network device.
Return values:
EFI_SUCCESSThe new station IP address and/or subnet mask were updated.
EFI_NOT_STARTEDThe PXE Base Code Protocol is in the stopped state.
EFI_INVALID_PARAMETEROne or more parameters are invalid.

Definition at line 836 of file PxeBaseCode.h.

typedef EFI_STATUS(EFIAPI * EFI_PXE_BASE_CODE_SET_PACKETS)(IN EFI_PXE_BASE_CODE_PROTOCOL *This, BOOLEAN *NewDhcpDiscoverValid, OPTIONAL BOOLEAN *NewDhcpAckReceived, OPTIONAL BOOLEAN *NewProxyOfferReceived, OPTIONAL BOOLEAN *NewPxeDiscoverValid, OPTIONAL BOOLEAN *NewPxeReplyReceived, OPTIONAL BOOLEAN *NewPxeBisReplyReceived, OPTIONAL IN EFI_PXE_BASE_CODE_PACKET *NewDhcpDiscover, OPTIONAL IN EFI_PXE_BASE_CODE_PACKET *NewDhcpAck, OPTIONAL IN EFI_PXE_BASE_CODE_PACKET *NewProxyOffer, OPTIONAL IN EFI_PXE_BASE_CODE_PACKET *NewPxeDiscover, OPTIONAL IN EFI_PXE_BASE_CODE_PACKET *NewPxeReply, OPTIONAL IN EFI_PXE_BASE_CODE_PACKET *NewPxeBisReply OPTIONAL)

Updates the contents of the cached DHCP and Discover packets.

The pointers to the new packets are used to update the contents of the cached packets in the EFI_PXE_BASE_CODE_MODE structure.

Parameters:
ThisThe pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
NewDhcpDiscoverValidThe pointer to a value that will replace the current DhcpDiscoverValid field.
NewDhcpAckReceivedThe pointer to a value that will replace the current DhcpAckReceived field.
NewProxyOfferReceivedThe pointer to a value that will replace the current ProxyOfferReceived field.
NewPxeDiscoverValidThe pointer to a value that will replace the current ProxyOfferReceived field.
NewPxeReplyReceivedThe pointer to a value that will replace the current PxeReplyReceived field.
NewPxeBisReplyReceivedThe pointer to a value that will replace the current PxeBisReplyReceived field.
NewDhcpDiscoverThe pointer to the new cached DHCP Discover packet contents.
NewDhcpAckThe pointer to the new cached DHCP Ack packet contents.
NewProxyOfferThe pointer to the new cached Proxy Offer packet contents.
NewPxeDiscoverThe pointer to the new cached PXE Discover packet contents.
NewPxeReplyThe pointer to the new cached PXE Reply packet contents.
NewPxeBisReplyThe pointer to the new cached PXE BIS Reply packet contents.
Return values:
EFI_SUCCESSThe cached packet contents were updated.
EFI_NOT_STARTEDThe PXE Base Code Protocol is in the stopped state.
EFI_INVALID_PARAMETERThis is NULL or not point to a valid EFI_PXE_BASE_CODE_PROTOCOL structure.

Definition at line 875 of file PxeBaseCode.h.


Enumeration Type Documentation

TFTP opcode definitions.

Enumerator:
EFI_PXE_BASE_CODE_TFTP_FIRST 
EFI_PXE_BASE_CODE_TFTP_GET_FILE_SIZE 
EFI_PXE_BASE_CODE_TFTP_READ_FILE 
EFI_PXE_BASE_CODE_TFTP_WRITE_FILE 
EFI_PXE_BASE_CODE_TFTP_READ_DIRECTORY 
EFI_PXE_BASE_CODE_MTFTP_GET_FILE_SIZE 
EFI_PXE_BASE_CODE_MTFTP_READ_FILE 
EFI_PXE_BASE_CODE_MTFTP_READ_DIRECTORY 
EFI_PXE_BASE_CODE_MTFTP_LAST 

Definition at line 195 of file PxeBaseCode.h.


Function Documentation

FILE_LICENCE ( BSD3  )

Variable Documentation