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