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