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