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