MdePkg/Include/Protocol/PxeBaseCode.h

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