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