2 This implementation of EFI_PXE_BASE_CODE_PROTOCOL and EFI_LOAD_FILE_PROTOCOL.
4 Copyright (c) 2007 - 2011, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php.
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.
16 #include "PxeBcImpl.h"
20 Enables the use of the PXE Base Code Protocol functions.
22 This function enables the use of the PXE Base Code Protocol functions. If the
23 Started field of the EFI_PXE_BASE_CODE_MODE structure is already TRUE, then
24 EFI_ALREADY_STARTED will be returned. If UseIpv6 is TRUE, then IPv6 formatted
25 addresses will be used in this session. If UseIpv6 is FALSE, then IPv4 formatted
26 addresses will be used in this session. If UseIpv6 is TRUE, and the Ipv6Supported
27 field of the EFI_PXE_BASE_CODE_MODE structure is FALSE, then EFI_UNSUPPORTED will
28 be returned. If there is not enough memory or other resources to start the PXE
29 Base Code Protocol, then EFI_OUT_OF_RESOURCES will be returned. Otherwise, the
30 PXE Base Code Protocol will be started.
32 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
33 @param[in] UseIpv6 Specifies the type of IP addresses that are to be
34 used during the session that is being started.
35 Set to TRUE for IPv6, and FALSE for IPv4.
37 @retval EFI_SUCCESS The PXE Base Code Protocol was started.
38 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
39 @retval EFI_UNSUPPORTED UseIpv6 is TRUE, but the Ipv6Supported field of the
40 EFI_PXE_BASE_CODE_MODE structure is FALSE.
41 @retval EFI_ALREADY_STARTED The PXE Base Code Protocol is already in the started state.
42 @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid
43 EFI_PXE_BASE_CODE_PROTOCOL structure.
44 @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory or other resources to start the
45 PXE Base Code Protocol.
51 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
55 PXEBC_PRIVATE_DATA
*Private
;
56 EFI_PXE_BASE_CODE_MODE
*Mode
;
61 return EFI_INVALID_PARAMETER
;
64 Private
= PXEBC_PRIVATE_DATA_FROM_PXEBC (This
);
65 Mode
= Private
->PxeBc
.Mode
;
68 return EFI_ALREADY_STARTED
;
72 // Detect whether using IPv6 or not, and set it into mode data.
74 if (UseIpv6
&& Mode
->Ipv6Available
&& Mode
->Ipv6Supported
&& Private
->Ip6Nic
!= NULL
) {
75 Mode
->UsingIpv6
= TRUE
;
76 } else if (!UseIpv6
&& Private
->Ip4Nic
!= NULL
) {
77 Mode
->UsingIpv6
= FALSE
;
79 return EFI_UNSUPPORTED
;
82 if (Mode
->UsingIpv6
) {
83 AsciiPrint ("\n>>Start PXE over IPv6");
85 // Configure block size for TFTP as a default value to handle all link layers.
87 Private
->BlockSize
= (UINTN
) (Private
->Ip6MaxPacketSize
-
88 PXEBC_DEFAULT_UDP_OVERHEAD_SIZE
- PXEBC_DEFAULT_TFTP_OVERHEAD_SIZE
);
91 // PXE over IPv6 starts here, initialize the fields and list header.
93 Private
->Ip6Policy
= PXEBC_IP6_POLICY_MAX
;
94 Private
->ProxyOffer
.Dhcp6
.Packet
.Offer
.Size
= PXEBC_DHCP6_PACKET_MAX_SIZE
;
95 Private
->DhcpAck
.Dhcp6
.Packet
.Ack
.Size
= PXEBC_DHCP6_PACKET_MAX_SIZE
;
96 Private
->PxeReply
.Dhcp6
.Packet
.Ack
.Size
= PXEBC_DHCP6_PACKET_MAX_SIZE
;
98 for (Index
= 0; Index
< PXEBC_OFFER_MAX_NUM
; Index
++) {
99 Private
->OfferBuffer
[Index
].Dhcp6
.Packet
.Offer
.Size
= PXEBC_DHCP6_PACKET_MAX_SIZE
;
103 // Create event and set status for token to capture ICMP6 error message.
105 Private
->Icmp6Token
.Status
= EFI_NOT_READY
;
106 Status
= gBS
->CreateEvent (
109 PxeBcIcmp6ErrorUpdate
,
111 &Private
->Icmp6Token
.Event
113 if (EFI_ERROR (Status
)) {
117 AsciiPrint ("\n>>Start PXE over IPv4");
119 // Configure block size for TFTP as a default value to handle all link layers.
121 Private
->BlockSize
= (UINTN
) (Private
->Ip4MaxPacketSize
-
122 PXEBC_DEFAULT_UDP_OVERHEAD_SIZE
- PXEBC_DEFAULT_TFTP_OVERHEAD_SIZE
);
125 // PXE over IPv4 starts here, initialize the fields.
127 Private
->ProxyOffer
.Dhcp4
.Packet
.Offer
.Size
= PXEBC_DHCP4_PACKET_MAX_SIZE
;
128 Private
->DhcpAck
.Dhcp4
.Packet
.Ack
.Size
= PXEBC_DHCP4_PACKET_MAX_SIZE
;
129 Private
->PxeReply
.Dhcp4
.Packet
.Ack
.Size
= PXEBC_DHCP4_PACKET_MAX_SIZE
;
131 for (Index
= 0; Index
< PXEBC_OFFER_MAX_NUM
; Index
++) {
132 Private
->OfferBuffer
[Index
].Dhcp4
.Packet
.Offer
.Size
= PXEBC_DHCP4_PACKET_MAX_SIZE
;
135 PxeBcSeedDhcp4Packet (&Private
->SeedPacket
, Private
->Udp4Read
);
138 // Create the event for Arp cache update.
140 Status
= gBS
->CreateEvent (
141 EVT_TIMER
| EVT_NOTIFY_SIGNAL
,
145 &Private
->ArpUpdateEvent
147 if (EFI_ERROR (Status
)) {
152 // Start a periodic timer by second to update Arp cache.
154 Status
= gBS
->SetTimer (
155 Private
->ArpUpdateEvent
,
159 if (EFI_ERROR (Status
)) {
164 // Create event and set status for token to capture ICMP error message.
166 Private
->Icmp6Token
.Status
= EFI_NOT_READY
;
167 Status
= gBS
->CreateEvent (
170 PxeBcIcmpErrorUpdate
,
172 &Private
->IcmpToken
.Event
174 if (EFI_ERROR (Status
)) {
180 // If PcdTftpBlockSize is set to non-zero, override the default value.
182 if (PcdGet64 (PcdTftpBlockSize
) != 0) {
183 Private
->BlockSize
= (UINTN
) PcdGet64 (PcdTftpBlockSize
);
187 // Create event for UdpRead/UdpWrite timeout since they are both blocking API.
189 Status
= gBS
->CreateEvent (
194 &Private
->UdpTimeOutEvent
196 if (EFI_ERROR (Status
)) {
200 Private
->IsAddressOk
= FALSE
;
201 Mode
->Started
= TRUE
;
206 if (Mode
->UsingIpv6
) {
207 if (Private
->Icmp6Token
.Event
!= NULL
) {
208 gBS
->CloseEvent (Private
->Icmp6Token
.Event
);
209 Private
->Icmp6Token
.Event
= NULL
;
211 Private
->Udp6Read
->Configure (Private
->Udp6Read
, NULL
);
212 Private
->Ip6
->Configure (Private
->Ip6
, NULL
);
214 if (Private
->ArpUpdateEvent
!= NULL
) {
215 gBS
->CloseEvent (Private
->ArpUpdateEvent
);
216 Private
->ArpUpdateEvent
= NULL
;
218 if (Private
->IcmpToken
.Event
!= NULL
) {
219 gBS
->CloseEvent (Private
->IcmpToken
.Event
);
220 Private
->IcmpToken
.Event
= NULL
;
222 Private
->Udp4Read
->Configure (Private
->Udp4Read
, NULL
);
223 Private
->Ip4
->Configure (Private
->Ip4
, NULL
);
230 Disable the use of the PXE Base Code Protocol functions.
232 This function stops all activity on the network device. All the resources allocated
233 in Start() are released, the Started field of the EFI_PXE_BASE_CODE_MODE structure is
234 set to FALSE, and EFI_SUCCESS is returned. If the Started field of the EFI_PXE_BASE_CODE_MODE
235 structure is already FALSE, then EFI_NOT_STARTED will be returned.
237 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
239 @retval EFI_SUCCESS The PXE Base Code Protocol was stopped.
240 @retval EFI_NOT_STARTED The PXE Base Code Protocol is already in the stopped state.
241 @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid
242 EFI_PXE_BASE_CODE_PROTOCOL structure.
249 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
252 PXEBC_PRIVATE_DATA
*Private
;
253 EFI_PXE_BASE_CODE_MODE
*Mode
;
254 BOOLEAN Ipv6Supported
;
255 BOOLEAN Ipv6Available
;
258 return EFI_INVALID_PARAMETER
;
261 Private
= PXEBC_PRIVATE_DATA_FROM_PXEBC (This
);
262 Mode
= Private
->PxeBc
.Mode
;
263 Ipv6Supported
= Mode
->Ipv6Supported
;
264 Ipv6Available
= Mode
->Ipv6Available
;
266 if (!Mode
->Started
) {
267 return EFI_NOT_STARTED
;
270 if (Mode
->UsingIpv6
) {
272 // Configure all the instances for IPv6 as NULL.
274 ZeroMem (&Private
->Udp6CfgData
.StationAddress
, sizeof (EFI_IPv6_ADDRESS
));
275 ZeroMem (&Private
->Ip6CfgData
.StationAddress
, sizeof (EFI_IPv6_ADDRESS
));
276 Private
->Dhcp6
->Stop (Private
->Dhcp6
);
277 Private
->Dhcp6
->Configure (Private
->Dhcp6
, NULL
);
278 Private
->Udp6Write
->Configure (Private
->Udp6Write
, NULL
);
279 Private
->Udp6Read
->Groups (Private
->Udp6Read
, FALSE
, NULL
);
280 Private
->Udp6Read
->Configure (Private
->Udp6Read
, NULL
);
281 Private
->Ip6
->Cancel (Private
->Ip6
, &Private
->Icmp6Token
);
282 Private
->Ip6
->Configure (Private
->Ip6
, NULL
);
283 PxeBcUnregisterIp6Address (Private
);
284 if (Private
->Icmp6Token
.Event
!= NULL
) {
285 gBS
->CloseEvent (Private
->Icmp6Token
.Event
);
286 Private
->Icmp6Token
.Event
= NULL
;
288 if (Private
->Dhcp6Request
!= NULL
) {
289 FreePool (Private
->Dhcp6Request
);
290 Private
->Dhcp6Request
= NULL
;
292 if (Private
->BootFileName
!= NULL
) {
293 FreePool (Private
->BootFileName
);
294 Private
->BootFileName
= NULL
;
298 // Configure all the instances for IPv4 as NULL.
300 ZeroMem (&Private
->Udp4CfgData
.StationAddress
, sizeof (EFI_IPv4_ADDRESS
));
301 ZeroMem (&Private
->Udp4CfgData
.SubnetMask
, sizeof (EFI_IPv4_ADDRESS
));
302 ZeroMem (&Private
->Ip4CfgData
.StationAddress
, sizeof (EFI_IPv4_ADDRESS
));
303 ZeroMem (&Private
->Ip4CfgData
.SubnetMask
, sizeof (EFI_IPv4_ADDRESS
));
304 Private
->Dhcp4
->Stop (Private
->Dhcp4
);
305 Private
->Dhcp4
->Configure (Private
->Dhcp4
, NULL
);
306 Private
->Udp4Write
->Configure (Private
->Udp4Write
, NULL
);
307 Private
->Udp4Read
->Groups (Private
->Udp4Read
, FALSE
, NULL
);
308 Private
->Udp4Read
->Configure (Private
->Udp4Read
, NULL
);
309 Private
->Ip4
->Cancel (Private
->Ip4
, &Private
->IcmpToken
);
310 Private
->Ip4
->Configure (Private
->Ip4
, NULL
);
311 if (Private
->ArpUpdateEvent
!= NULL
) {
312 gBS
->CloseEvent (Private
->ArpUpdateEvent
);
313 Private
->ArpUpdateEvent
= NULL
;
315 if (Private
->IcmpToken
.Event
!= NULL
) {
316 gBS
->CloseEvent (Private
->IcmpToken
.Event
);
317 Private
->IcmpToken
.Event
= NULL
;
321 gBS
->CloseEvent (Private
->UdpTimeOutEvent
);
322 Private
->CurSrcPort
= 0;
323 Private
->BootFileSize
= 0;
324 Private
->SolicitTimes
= 0;
325 Private
->ElapsedTime
= 0;
328 // Reset the mode data.
330 ZeroMem (Mode
, sizeof (EFI_PXE_BASE_CODE_MODE
));
331 Mode
->Ipv6Available
= Ipv6Available
;
332 Mode
->Ipv6Supported
= Ipv6Supported
;
333 Mode
->AutoArp
= TRUE
;
334 Mode
->TTL
= DEFAULT_TTL
;
335 Mode
->ToS
= DEFAULT_ToS
;
342 Attempts to complete a DHCPv4 D.O.R.A. (discover / offer / request / acknowledge) or DHCPv6
343 S.A.R.R (solicit / advertise / request / reply) sequence.
345 If SortOffers is TRUE, then the cached DHCP offer packets will be sorted before
346 they are tried. If SortOffers is FALSE, then the cached DHCP offer packets will
347 be tried in the order in which they are received. Please see the Preboot Execution
348 Environment (PXE) Specification and Unified Extensible Firmware Interface (UEFI)
349 Specification for additional details on the implementation of DHCP.
350 If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,
351 then the DHCP sequence will be stopped and EFI_ABORTED will be returned.
353 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
354 @param[in] SortOffers TRUE if the offers received should be sorted. Set to FALSE to
355 try the offers in the order that they are received.
357 @retval EFI_SUCCESS Valid DHCP has completed.
358 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
359 @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid
360 EFI_PXE_BASE_CODE_PROTOCOL structure.
361 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
362 @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory to complete the DHCP Protocol.
363 @retval EFI_ABORTED The callback function aborted the DHCP Protocol.
364 @retval EFI_TIMEOUT The DHCP Protocol timed out.
365 @retval EFI_ICMP_ERROR An ICMP error packet was received during the DHCP session.
366 @retval EFI_NO_RESPONSE Valid PXE offer was not received.
372 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
373 IN BOOLEAN SortOffers
376 PXEBC_PRIVATE_DATA
*Private
;
377 EFI_PXE_BASE_CODE_MODE
*Mode
;
379 EFI_PXE_BASE_CODE_IP_FILTER IpFilter
;
382 return EFI_INVALID_PARAMETER
;
385 Status
= EFI_SUCCESS
;
386 Private
= PXEBC_PRIVATE_DATA_FROM_PXEBC (This
);
387 Mode
= Private
->PxeBc
.Mode
;
388 Mode
->IcmpErrorReceived
= FALSE
;
389 Private
->Function
= EFI_PXE_BASE_CODE_FUNCTION_DHCP
;
390 Private
->IsOfferSorted
= SortOffers
;
392 if (!Mode
->Started
) {
393 return EFI_NOT_STARTED
;
396 if (Mode
->UsingIpv6
) {
399 // Stop Udp6Read instance
401 Private
->Udp6Read
->Configure (Private
->Udp6Read
, NULL
);
404 // Start S.A.R.R. process to get a IPv6 address and other boot information.
406 Status
= PxeBcDhcp6Sarr (Private
, Private
->Dhcp6
);
409 // Configure Udp6Read instance
411 Status
= Private
->Udp6Read
->Configure (Private
->Udp6Read
, &Private
->Udp6CfgData
);
415 // Stop Udp4Read instance
417 Private
->Udp4Read
->Configure (Private
->Udp4Read
, NULL
);
420 // Start D.O.R.A. process to get a IPv4 address and other boot information.
422 Status
= PxeBcDhcp4Dora (Private
, Private
->Dhcp4
);
425 // Configure Udp4Read instance
427 Status
= Private
->Udp4Read
->Configure (Private
->Udp4Read
, &Private
->Udp4CfgData
);
431 // Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP
432 // receive filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.
434 ZeroMem(&IpFilter
, sizeof (EFI_PXE_BASE_CODE_IP_FILTER
));
435 IpFilter
.Filters
= EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP
;
436 This
->SetIpFilter (This
, &IpFilter
);
443 Attempts to complete the PXE Boot Server and/or boot image discovery sequence.
445 This function attempts to complete the PXE Boot Server and/or boot image discovery
446 sequence. If this sequence is completed, then EFI_SUCCESS is returned, and the
447 PxeDiscoverValid, PxeDiscover, PxeReplyReceived, and PxeReply fields of the
448 EFI_PXE_BASE_CODE_MODE structure are filled in. If UseBis is TRUE, then the
449 PxeBisReplyReceived and PxeBisReply fields of the EFI_PXE_BASE_CODE_MODE structure
450 will also be filled in. If UseBis is FALSE, then PxeBisReplyValid will be set to FALSE.
451 In the structure referenced by parameter Info, the PXE Boot Server list, SrvList[],
452 has two uses: It is the Boot Server IP address list used for unicast discovery
453 (if the UseUCast field is TRUE), and it is the list used for Boot Server verification
454 (if the MustUseList field is TRUE). Also, if the MustUseList field in that structure
455 is TRUE and the AcceptAnyResponse field in the SrvList[] array is TRUE, any Boot
456 Server reply of that type will be accepted. If the AcceptAnyResponse field is
457 FALSE, only responses from Boot Servers with matching IP addresses will be accepted.
458 This function can take at least 10 seconds to timeout and return control to the
459 caller. If the Discovery sequence does not complete, then EFI_TIMEOUT will be
460 returned. Please see the Preboot Execution Environment (PXE) Specification for
461 additional details on the implementation of the Discovery sequence.
462 If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,
463 then the Discovery sequence is stopped and EFI_ABORTED will be returned.
465 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
466 @param[in] Type The type of bootstrap to perform.
467 @param[in] Layer Pointer to the boot server layer number to discover, which must be
468 PXE_BOOT_LAYER_INITIAL when a new server type is being
470 @param[in] UseBis TRUE if Boot Integrity Services are to be used. FALSE otherwise.
471 @param[in] Info Pointer to a data structure that contains additional information
472 on the type of discovery operation that is to be performed.
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
489 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
493 IN EFI_PXE_BASE_CODE_DISCOVER_INFO
*Info OPTIONAL
496 PXEBC_PRIVATE_DATA
*Private
;
497 EFI_PXE_BASE_CODE_MODE
*Mode
;
498 EFI_PXE_BASE_CODE_DISCOVER_INFO DefaultInfo
;
499 EFI_PXE_BASE_CODE_SRVLIST
*SrvList
;
500 PXEBC_BOOT_SVR_ENTRY
*BootSvrEntry
;
503 EFI_PXE_BASE_CODE_IP_FILTER IpFilter
;
506 return EFI_INVALID_PARAMETER
;
509 Private
= PXEBC_PRIVATE_DATA_FROM_PXEBC (This
);
510 Mode
= Private
->PxeBc
.Mode
;
511 Mode
->IcmpErrorReceived
= FALSE
;
514 Status
= EFI_DEVICE_ERROR
;
515 Private
->Function
= EFI_PXE_BASE_CODE_FUNCTION_DISCOVER
;
517 if (!Mode
->Started
) {
518 return EFI_NOT_STARTED
;
522 // Station address should be ready before do discover.
524 if (!Private
->IsAddressOk
) {
525 return EFI_INVALID_PARAMETER
;
528 if (Mode
->UsingIpv6
) {
531 // Stop Udp6Read instance
533 Private
->Udp6Read
->Configure (Private
->Udp6Read
, NULL
);
537 // Stop Udp4Read instance
539 Private
->Udp4Read
->Configure (Private
->Udp4Read
, NULL
);
543 // There are 3 methods to get the information for discover.
545 if (*Layer
!= EFI_PXE_BASE_CODE_BOOT_LAYER_INITIAL
) {
547 // 1. Take the previous setting as the discover info.
549 if (!Mode
->PxeDiscoverValid
||
550 !Mode
->PxeReplyReceived
||
551 (!Mode
->PxeBisReplyReceived
&& UseBis
)) {
552 Status
= EFI_INVALID_PARAMETER
;
558 Info
->UseUCast
= TRUE
;
559 SrvList
= Info
->SrvList
;
560 SrvList
[0].Type
= Type
;
561 SrvList
[0].AcceptAnyResponse
= FALSE
;
563 CopyMem (&SrvList
->IpAddr
, &Private
->ServerIp
, sizeof (EFI_IP_ADDRESS
));
565 } else if (Info
== NULL
) {
567 // 2. Extract the discover information from the cached packets if unspecified.
570 Status
= PxeBcExtractDiscoverInfo (Private
, Type
, Info
, &BootSvrEntry
, &SrvList
);
571 if (EFI_ERROR (Status
)) {
577 // 3. Take the pass-in information as the discover info, and validate the server list.
579 SrvList
= Info
->SrvList
;
581 if (!SrvList
[0].AcceptAnyResponse
) {
582 for (Index
= 1; Index
< Info
->IpCnt
; Index
++) {
583 if (SrvList
[Index
].AcceptAnyResponse
) {
587 if (Index
!= Info
->IpCnt
) {
589 // It's invalid if the first server doesn't accecpt any response
590 // and meanwhile any of the rest servers accept any reponse.
592 Status
= EFI_INVALID_PARAMETER
;
599 // Info and BootSvrEntry/SrvList are all ready by now, so execute discover by UniCast/BroadCast/MultiCast.
601 if ((!Info
->UseUCast
&& !Info
->UseBCast
&& !Info
->UseMCast
) ||
602 (Info
->MustUseList
&& Info
->IpCnt
== 0)) {
603 Status
= EFI_INVALID_PARAMETER
;
607 Private
->IsDoDiscover
= TRUE
;
609 if (Info
->UseUCast
) {
611 // Do discover by unicast.
613 for (Index
= 0; Index
< Info
->IpCnt
; Index
++) {
614 if (BootSvrEntry
== NULL
) {
615 CopyMem (&Private
->ServerIp
, &SrvList
[Index
].IpAddr
, sizeof (EFI_IP_ADDRESS
));
617 ASSERT (!Mode
->UsingIpv6
);
618 ZeroMem (&Private
->ServerIp
, sizeof (EFI_IP_ADDRESS
));
619 CopyMem (&Private
->ServerIp
, &BootSvrEntry
->IpAddr
[Index
], sizeof (EFI_IPv4_ADDRESS
));
622 Status
= PxeBcDiscoverBootServer (
627 &SrvList
[Index
].IpAddr
,
632 } else if (Info
->UseMCast
) {
634 // Do discover by multicast.
636 Status
= PxeBcDiscoverBootServer (
641 &Info
->ServerMCastIp
,
646 } else if (Info
->UseBCast
) {
648 // Do discover by broadcast, but only valid for IPv4.
650 ASSERT (!Mode
->UsingIpv6
);
651 Status
= PxeBcDiscoverBootServer (
662 if (!EFI_ERROR (Status
)) {
664 // Parse the cached PXE reply packet, and store it into mode data if valid.
666 if (Mode
->UsingIpv6
) {
667 Status
= PxeBcParseDhcp6Packet (&Private
->PxeReply
.Dhcp6
);
668 if (!EFI_ERROR (Status
)) {
670 &Mode
->PxeReply
.Dhcpv6
,
671 &Private
->PxeReply
.Dhcp6
.Packet
.Offer
,
672 Private
->PxeReply
.Dhcp6
.Packet
.Offer
.Length
674 Mode
->PxeReplyReceived
= TRUE
;
675 Mode
->PxeDiscoverValid
= TRUE
;
678 Status
= PxeBcParseDhcp4Packet (&Private
->PxeReply
.Dhcp4
);
679 if (!EFI_ERROR (Status
)) {
681 &Mode
->PxeReply
.Dhcpv4
,
682 &Private
->PxeReply
.Dhcp4
.Packet
.Offer
,
683 Private
->PxeReply
.Dhcp4
.Packet
.Offer
.Length
685 Mode
->PxeReplyReceived
= TRUE
;
686 Mode
->PxeDiscoverValid
= TRUE
;
693 if (Mode
->UsingIpv6
) {
694 Status
= Private
->Udp6Read
->Configure (Private
->Udp6Read
, &Private
->Udp6CfgData
);
696 Status
= Private
->Udp4Read
->Configure (Private
->Udp4Read
, &Private
->Udp4CfgData
);
700 // Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP
701 // receive filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.
703 ZeroMem(&IpFilter
, sizeof (EFI_PXE_BASE_CODE_IP_FILTER
));
704 IpFilter
.Filters
= EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP
;
705 This
->SetIpFilter (This
, &IpFilter
);
712 Used to perform TFTP and MTFTP services.
714 This function is used to perform TFTP and MTFTP services. This includes the
715 TFTP operations to get the size of a file, read a directory, read a file, and
716 write a file. It also includes the MTFTP operations to get the size of a file,
717 read a directory, and read a file. The type of operation is specified by Operation.
718 If the callback function that is invoked during the TFTP/MTFTP operation does
719 not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED will
721 For read operations, the return data will be placed in the buffer specified by
722 BufferPtr. If BufferSize is too small to contain the entire downloaded file,
723 then EFI_BUFFER_TOO_SMALL will be returned and BufferSize will be set to zero,
724 or the size of the requested file. (NOTE: the size of the requested file is only returned
725 if the TFTP server supports TFTP options). If BufferSize is large enough for the
726 read operation, then BufferSize will be set to the size of the downloaded file,
727 and EFI_SUCCESS will be returned. Applications using the PxeBc.Mtftp() services
728 should use the get-file-size operations to determine the size of the downloaded
729 file prior to using the read-file operations-especially when downloading large
730 (greater than 64 MB) files-instead of making two calls to the read-file operation.
731 Following this recommendation will save time if the file is larger than expected
732 and the TFTP server does not support TFTP option extensions. Without TFTP option
733 extension support, the client must download the entire file, counting and discarding
734 the received packets, to determine the file size.
735 For write operations, the data to be sent is in the buffer specified by BufferPtr.
736 BufferSize specifies the number of bytes to send. If the write operation completes
737 successfully, then EFI_SUCCESS will be returned.
738 For TFTP "get file size" operations, the size of the requested file or directory
739 is returned in BufferSize, and EFI_SUCCESS will be returned. If the TFTP server
740 does not support options, the file will be downloaded into a bit bucket and the
741 length of the downloaded file will be returned. For MTFTP "get file size" operations,
742 if the MTFTP server does not support the "get file size" option, EFI_UNSUPPORTED
744 This function can take up to 10 seconds to timeout and return control to the caller.
745 If the TFTP sequence does not complete, EFI_TIMEOUT will be returned.
746 If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,
747 then the TFTP sequence is stopped and EFI_ABORTED will be returned.
749 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
750 @param[in] Operation The type of operation to perform.
751 @param[in, out] BufferPtr A pointer to the data buffer.
752 @param[in] Overwrite Only used on write file operations. TRUE if a file on a remote
753 server can be overwritten.
754 @param[in, out] BufferSize For get-file-size operations, *BufferSize returns the size of the
756 @param[in] BlockSize The requested block size to be used during a TFTP transfer.
757 @param[in] ServerIp The TFTP / MTFTP server IP address.
758 @param[in] Filename A Null-terminated ASCII string that specifies a directory name
760 @param[in] Info Pointer to the MTFTP information.
761 @param[in] DontUseBuffer Set to FALSE for normal TFTP and MTFTP read file operation.
763 @retval EFI_SUCCESS The TFTP/MTFTP operation was completed.
764 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
765 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
766 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
767 @retval EFI_BUFFER_TOO_SMALL The buffer is not large enough to complete the read operation.
768 @retval EFI_ABORTED The callback function aborted the TFTP/MTFTP operation.
769 @retval EFI_TIMEOUT The TFTP/MTFTP operation timed out.
770 @retval EFI_ICMP_ERROR An ICMP error packet was received during the MTFTP session.
771 @retval EFI_TFTP_ERROR A TFTP error packet was received during the MTFTP session.
777 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
778 IN EFI_PXE_BASE_CODE_TFTP_OPCODE Operation
,
779 IN OUT VOID
*BufferPtr OPTIONAL
,
780 IN BOOLEAN Overwrite
,
781 IN OUT UINT64
*BufferSize
,
782 IN UINTN
*BlockSize OPTIONAL
,
783 IN EFI_IP_ADDRESS
*ServerIp
,
785 IN EFI_PXE_BASE_CODE_MTFTP_INFO
*Info OPTIONAL
,
786 IN BOOLEAN DontUseBuffer
789 PXEBC_PRIVATE_DATA
*Private
;
790 EFI_PXE_BASE_CODE_MODE
*Mode
;
791 EFI_MTFTP4_CONFIG_DATA Mtftp4Config
;
792 EFI_MTFTP6_CONFIG_DATA Mtftp6Config
;
795 EFI_PXE_BASE_CODE_IP_FILTER IpFilter
;
798 if ((This
== NULL
) ||
799 (Filename
== NULL
) ||
800 (BufferSize
== NULL
) ||
801 (ServerIp
== NULL
) ||
802 ((BufferPtr
== NULL
) && DontUseBuffer
) ||
803 ((BlockSize
!= NULL
) && (*BlockSize
< PXE_MTFTP_DEFAULT_BLOCK_SIZE
)) ||
804 (!NetIp4IsUnicast (NTOHL (ServerIp
->Addr
[0]), 0) && !NetIp6IsValidUnicast (&ServerIp
->v6
))) {
805 return EFI_INVALID_PARAMETER
;
809 Status
= EFI_DEVICE_ERROR
;
810 Private
= PXEBC_PRIVATE_DATA_FROM_PXEBC (This
);
811 Mode
= Private
->PxeBc
.Mode
;
813 if (Mode
->UsingIpv6
) {
815 // Set configuration data for Mtftp6 instance.
817 ZeroMem (&Mtftp6Config
, sizeof (EFI_MTFTP6_CONFIG_DATA
));
818 Config
= &Mtftp6Config
;
819 Mtftp6Config
.TimeoutValue
= PXEBC_MTFTP_TIMEOUT
;
820 Mtftp6Config
.TryCount
= PXEBC_MTFTP_RETRIES
;
821 CopyMem (&Mtftp6Config
.StationIp
, &Private
->StationIp
.v6
, sizeof (EFI_IPv6_ADDRESS
));
822 CopyMem (&Mtftp6Config
.ServerIp
, &ServerIp
->v6
, sizeof (EFI_IPv6_ADDRESS
));
824 // Stop Udp6Read instance
826 Private
->Udp6Read
->Configure (Private
->Udp6Read
, NULL
);
829 // Set configuration data for Mtftp4 instance.
831 ZeroMem (&Mtftp4Config
, sizeof (EFI_MTFTP4_CONFIG_DATA
));
832 Config
= &Mtftp4Config
;
833 Mtftp4Config
.UseDefaultSetting
= FALSE
;
834 Mtftp4Config
.TimeoutValue
= PXEBC_MTFTP_TIMEOUT
;
835 Mtftp4Config
.TryCount
= PXEBC_MTFTP_RETRIES
;
836 CopyMem (&Mtftp4Config
.StationIp
, &Private
->StationIp
.v4
, sizeof (EFI_IPv4_ADDRESS
));
837 CopyMem (&Mtftp4Config
.SubnetMask
, &Private
->SubnetMask
.v4
, sizeof (EFI_IPv4_ADDRESS
));
838 CopyMem (&Mtftp4Config
.GatewayIp
, &Private
->GatewayIp
.v4
, sizeof (EFI_IPv4_ADDRESS
));
839 CopyMem (&Mtftp4Config
.ServerIp
, &ServerIp
->v4
, sizeof (EFI_IPv4_ADDRESS
));
841 // Stop Udp4Read instance
843 Private
->Udp4Read
->Configure (Private
->Udp4Read
, NULL
);
846 Mode
->TftpErrorReceived
= FALSE
;
847 Mode
->IcmpErrorReceived
= FALSE
;
851 case EFI_PXE_BASE_CODE_TFTP_GET_FILE_SIZE
:
853 // Send TFTP request to get file size.
855 Status
= PxeBcTftpGetFileSize (
865 case EFI_PXE_BASE_CODE_TFTP_READ_FILE
:
867 // Send TFTP request to read file.
869 Status
= PxeBcTftpReadFile (
881 case EFI_PXE_BASE_CODE_TFTP_WRITE_FILE
:
883 // Send TFTP request to write file.
885 Status
= PxeBcTftpWriteFile (
897 case EFI_PXE_BASE_CODE_TFTP_READ_DIRECTORY
:
899 // Send TFTP request to read directory.
901 Status
= PxeBcTftpReadDirectory (
913 case EFI_PXE_BASE_CODE_MTFTP_GET_FILE_SIZE
:
914 case EFI_PXE_BASE_CODE_MTFTP_READ_FILE
:
915 case EFI_PXE_BASE_CODE_MTFTP_READ_DIRECTORY
:
916 Status
= EFI_UNSUPPORTED
;
921 Status
= EFI_INVALID_PARAMETER
;
926 if (Status
== EFI_ICMP_ERROR
) {
927 Mode
->IcmpErrorReceived
= TRUE
;
930 if (Mode
->UsingIpv6
) {
931 Status
= Private
->Udp6Read
->Configure (Private
->Udp6Read
, &Private
->Udp6CfgData
);
933 Status
= Private
->Udp4Read
->Configure (Private
->Udp4Read
, &Private
->Udp4CfgData
);
937 // Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP
938 // receive filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.
940 ZeroMem(&IpFilter
, sizeof (EFI_PXE_BASE_CODE_IP_FILTER
));
941 IpFilter
.Filters
= EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP
;
942 This
->SetIpFilter (This
, &IpFilter
);
949 Writes a UDP packet to the network interface.
951 This function writes a UDP packet specified by the (optional HeaderPtr and)
952 BufferPtr parameters to the network interface. The UDP header is automatically
953 built by this routine. It uses the parameters OpFlags, DestIp, DestPort, GatewayIp,
954 SrcIp, and SrcPort to build this header. If the packet is successfully built and
955 transmitted through the network interface, then EFI_SUCCESS will be returned.
956 If a timeout occurs during the transmission of the packet, then EFI_TIMEOUT will
957 be returned. If an ICMP error occurs during the transmission of the packet, then
958 the IcmpErrorReceived field is set to TRUE, the IcmpError field is filled in and
959 EFI_ICMP_ERROR will be returned. If the Callback Protocol does not return
960 EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED will be returned.
962 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
963 @param[in] OpFlags The UDP operation flags.
964 @param[in] DestIp The destination IP address.
965 @param[in] DestPort The destination UDP port number.
966 @param[in] GatewayIp The gateway IP address.
967 @param[in] SrcIp The source IP address.
968 @param[in, out] SrcPort The source UDP port number.
969 @param[in] HeaderSize An optional field which may be set to the length of a header
970 at HeaderPtr to be prefixed to the data at BufferPtr.
971 @param[in] HeaderPtr If HeaderSize is not NULL, a pointer to a header to be
972 prefixed to the data at BufferPtr.
973 @param[in] BufferSize A pointer to the size of the data at BufferPtr.
974 @param[in] BufferPtr A pointer to the data to be written.
976 @retval EFI_SUCCESS The UDP Write operation completed.
977 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
978 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
979 @retval EFI_BAD_BUFFER_SIZE The buffer is too long to be transmitted.
980 @retval EFI_ABORTED The callback function aborted the UDP Write operation.
981 @retval EFI_TIMEOUT The UDP Write operation timed out.
982 @retval EFI_ICMP_ERROR An ICMP error packet was received during the UDP write session.
988 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
990 IN EFI_IP_ADDRESS
*DestIp
,
991 IN EFI_PXE_BASE_CODE_UDP_PORT
*DestPort
,
992 IN EFI_IP_ADDRESS
*GatewayIp OPTIONAL
,
993 IN EFI_IP_ADDRESS
*SrcIp OPTIONAL
,
994 IN OUT EFI_PXE_BASE_CODE_UDP_PORT
*SrcPort OPTIONAL
,
995 IN UINTN
*HeaderSize OPTIONAL
,
996 IN VOID
*HeaderPtr OPTIONAL
,
997 IN UINTN
*BufferSize
,
1001 PXEBC_PRIVATE_DATA
*Private
;
1002 EFI_PXE_BASE_CODE_MODE
*Mode
;
1003 EFI_UDP4_SESSION_DATA Udp4Session
;
1004 EFI_UDP6_SESSION_DATA Udp6Session
;
1006 BOOLEAN DoNotFragment
;
1008 if (This
== NULL
|| DestIp
== NULL
|| DestPort
== NULL
) {
1009 return EFI_INVALID_PARAMETER
;
1012 Private
= PXEBC_PRIVATE_DATA_FROM_PXEBC (This
);
1013 Mode
= Private
->PxeBc
.Mode
;
1015 if ((OpFlags
& EFI_PXE_BASE_CODE_UDP_OPFLAGS_MAY_FRAGMENT
) != 0) {
1016 DoNotFragment
= FALSE
;
1018 DoNotFragment
= TRUE
;
1021 if (!Mode
->UsingIpv6
&& GatewayIp
!= NULL
&& !NetIp4IsUnicast (NTOHL (GatewayIp
->Addr
[0]), 0)) {
1023 // Gateway is provided but it's not a unicast IPv4 address, while it will be ignored for IPv6.
1025 return EFI_INVALID_PARAMETER
;
1028 if (HeaderSize
!= NULL
&& (*HeaderSize
== 0 || HeaderPtr
== NULL
)) {
1029 return EFI_INVALID_PARAMETER
;
1032 if (BufferSize
== NULL
|| (*BufferSize
!= 0 && BufferPtr
== NULL
)) {
1033 return EFI_INVALID_PARAMETER
;
1036 if (!Mode
->Started
) {
1037 return EFI_NOT_STARTED
;
1040 if (!Private
->IsAddressOk
&& SrcIp
== NULL
) {
1041 return EFI_INVALID_PARAMETER
;
1044 if (Private
->CurSrcPort
== 0 ||
1045 (SrcPort
!= NULL
&& *SrcPort
!= Private
->CurSrcPort
)) {
1047 // Reconfigure UDPv4/UDPv6 for UdpWrite if the source port changed.
1049 if (SrcPort
!= NULL
) {
1050 Private
->CurSrcPort
= *SrcPort
;
1054 if (Mode
->UsingIpv6
) {
1055 Status
= PxeBcConfigUdp6Write (
1057 &Private
->StationIp
.v6
,
1058 &Private
->CurSrcPort
1062 // Configure the UDPv4 instance with gateway information from DHCP server as default.
1064 Status
= PxeBcConfigUdp4Write (
1066 &Private
->StationIp
.v4
,
1067 &Private
->SubnetMask
.v4
,
1068 &Private
->GatewayIp
.v4
,
1069 &Private
->CurSrcPort
,
1074 if (EFI_ERROR (Status
)) {
1075 Private
->CurSrcPort
= 0;
1076 return EFI_INVALID_PARAMETER
;
1077 } else if (SrcPort
!= NULL
) {
1078 *SrcPort
= Private
->CurSrcPort
;
1082 // Start a timer as timeout event for this blocking API.
1084 gBS
->SetTimer (Private
->UdpTimeOutEvent
, TimerRelative
, PXEBC_UDP_TIMEOUT
);
1086 if (Mode
->UsingIpv6
) {
1088 // Construct UDPv6 session data.
1090 ZeroMem (&Udp6Session
, sizeof (EFI_UDP6_SESSION_DATA
));
1091 CopyMem (&Udp6Session
.DestinationAddress
, DestIp
, sizeof (EFI_IPv6_ADDRESS
));
1092 Udp6Session
.DestinationPort
= *DestPort
;
1093 if (SrcIp
!= NULL
) {
1094 CopyMem (&Udp6Session
.SourceAddress
, SrcIp
, sizeof (EFI_IPv6_ADDRESS
));
1096 if (SrcPort
!= NULL
) {
1097 Udp6Session
.SourcePort
= *SrcPort
;
1100 Status
= PxeBcUdp6Write (
1103 Private
->UdpTimeOutEvent
,
1111 // Construct UDPv4 session data.
1113 ZeroMem (&Udp4Session
, sizeof (EFI_UDP4_SESSION_DATA
));
1114 CopyMem (&Udp4Session
.DestinationAddress
, DestIp
, sizeof (EFI_IPv4_ADDRESS
));
1115 Udp4Session
.DestinationPort
= *DestPort
;
1116 if (SrcIp
!= NULL
) {
1117 CopyMem (&Udp4Session
.SourceAddress
, SrcIp
, sizeof (EFI_IPv4_ADDRESS
));
1119 if (SrcPort
!= NULL
) {
1120 Udp4Session
.SourcePort
= *SrcPort
;
1123 // Override the gateway information if user specified.
1125 Status
= PxeBcUdp4Write (
1128 Private
->UdpTimeOutEvent
,
1129 (EFI_IPv4_ADDRESS
*) GatewayIp
,
1137 gBS
->SetTimer (Private
->UdpTimeOutEvent
, TimerCancel
, 0);
1141 // Reset the UdpWrite instance.
1143 if (Mode
->UsingIpv6
) {
1144 Private
->Udp6Write
->Configure (Private
->Udp6Write
, NULL
);
1146 Private
->Udp4Write
->Configure (Private
->Udp4Write
, NULL
);
1154 Reads a UDP packet from the network interface.
1156 This function reads a UDP packet from a network interface. The data contents
1157 are returned in (the optional HeaderPtr and) BufferPtr, and the size of the
1158 buffer received is returned in BufferSize . If the input BufferSize is smaller
1159 than the UDP packet received (less optional HeaderSize), it will be set to the
1160 required size, and EFI_BUFFER_TOO_SMALL will be returned. In this case, the
1161 contents of BufferPtr are undefined, and the packet is lost. If a UDP packet is
1162 successfully received, then EFI_SUCCESS will be returned, and the information
1163 from the UDP header will be returned in DestIp, DestPort, SrcIp, and SrcPort if
1164 they are not NULL. Depending on the values of OpFlags and the DestIp, DestPort,
1165 SrcIp, and SrcPort input values, different types of UDP packet receive filtering
1166 will be performed. The following tables summarize these receive filter operations.
1168 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
1169 @param[in] OpFlags The UDP operation flags.
1170 @param[in, out] DestIp The destination IP address.
1171 @param[in, out] DestPort The destination UDP port number.
1172 @param[in, out] SrcIp The source IP address.
1173 @param[in, out] SrcPort The source UDP port number.
1174 @param[in] HeaderSize An optional field which may be set to the length of a
1175 header at HeaderPtr to be prefixed to the data at BufferPtr.
1176 @param[in] HeaderPtr If HeaderSize is not NULL, a pointer to a header to be
1177 prefixed to the data at BufferPtr.
1178 @param[in, out] BufferSize A pointer to the size of the data at BufferPtr.
1179 @param[in] BufferPtr A pointer to the data to be read.
1181 @retval EFI_SUCCESS The UDP Read operation was completed.
1182 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
1183 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1184 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
1185 @retval EFI_BUFFER_TOO_SMALL The packet is larger than Buffer can hold.
1186 @retval EFI_ABORTED The callback function aborted the UDP Read operation.
1187 @retval EFI_TIMEOUT The UDP Read operation timed out.
1193 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
1195 IN OUT EFI_IP_ADDRESS
*DestIp OPTIONAL
,
1196 IN OUT EFI_PXE_BASE_CODE_UDP_PORT
*DestPort OPTIONAL
,
1197 IN OUT EFI_IP_ADDRESS
*SrcIp OPTIONAL
,
1198 IN OUT EFI_PXE_BASE_CODE_UDP_PORT
*SrcPort OPTIONAL
,
1199 IN UINTN
*HeaderSize OPTIONAL
,
1200 IN VOID
*HeaderPtr OPTIONAL
,
1201 IN OUT UINTN
*BufferSize
,
1205 PXEBC_PRIVATE_DATA
*Private
;
1206 EFI_PXE_BASE_CODE_MODE
*Mode
;
1207 EFI_UDP4_COMPLETION_TOKEN Udp4Token
;
1208 EFI_UDP6_COMPLETION_TOKEN Udp6Token
;
1209 EFI_UDP4_RECEIVE_DATA
*Udp4Rx
;
1210 EFI_UDP6_RECEIVE_DATA
*Udp6Rx
;
1216 if (This
== NULL
|| DestIp
== NULL
|| DestPort
== NULL
) {
1217 return EFI_INVALID_PARAMETER
;
1220 Private
= PXEBC_PRIVATE_DATA_FROM_PXEBC (This
);
1221 Mode
= Private
->PxeBc
.Mode
;
1227 if (((OpFlags
& EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_PORT
) != 0 && DestPort
== NULL
) ||
1228 ((OpFlags
& EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_IP
) != 0 && SrcIp
== NULL
) ||
1229 ((OpFlags
& EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT
) != 0 && SrcPort
== NULL
)) {
1230 return EFI_INVALID_PARAMETER
;
1233 if ((HeaderSize
!= NULL
&& *HeaderSize
== 0) || (HeaderSize
!= NULL
&& HeaderPtr
== NULL
)) {
1234 return EFI_INVALID_PARAMETER
;
1237 if ((BufferSize
== NULL
) || (BufferPtr
== NULL
)) {
1238 return EFI_INVALID_PARAMETER
;
1241 if (!Mode
->Started
) {
1242 return EFI_NOT_STARTED
;
1245 ZeroMem (&Udp6Token
, sizeof (EFI_UDP6_COMPLETION_TOKEN
));
1246 ZeroMem (&Udp4Token
, sizeof (EFI_UDP4_COMPLETION_TOKEN
));
1248 if (Mode
->UsingIpv6
) {
1249 Status
= gBS
->CreateEvent (
1256 if (EFI_ERROR (Status
)) {
1257 return EFI_OUT_OF_RESOURCES
;
1260 Status
= gBS
->CreateEvent (
1267 if (EFI_ERROR (Status
)) {
1268 return EFI_OUT_OF_RESOURCES
;
1273 // Start a timer as timeout event for this blocking API.
1275 gBS
->SetTimer (Private
->UdpTimeOutEvent
, TimerRelative
, PXEBC_UDP_TIMEOUT
);
1276 Mode
->IcmpErrorReceived
= FALSE
;
1279 // Read packet by Udp4Read/Udp6Read until matched or timeout.
1281 while (!IsMatched
&& !EFI_ERROR (Status
)) {
1282 if (Mode
->UsingIpv6
) {
1283 Status
= PxeBcUdp6Read (
1287 Private
->UdpTimeOutEvent
,
1297 Status
= PxeBcUdp4Read (
1301 Private
->UdpTimeOutEvent
,
1313 if (Status
== EFI_ICMP_ERROR
||
1314 Status
== EFI_NETWORK_UNREACHABLE
||
1315 Status
== EFI_HOST_UNREACHABLE
||
1316 Status
== EFI_PROTOCOL_UNREACHABLE
||
1317 Status
== EFI_PORT_UNREACHABLE
) {
1319 // Get different return status for icmp error from Udp, refers to UEFI spec.
1321 Mode
->IcmpErrorReceived
= TRUE
;
1323 gBS
->SetTimer (Private
->UdpTimeOutEvent
, TimerCancel
, 0);
1327 // Copy the rececived packet to user if matched by filter.
1330 if (Mode
->UsingIpv6
) {
1331 Udp6Rx
= Udp6Token
.Packet
.RxData
;
1332 ASSERT (Udp6Rx
!= NULL
);
1334 // Copy the header part of received data.
1336 if (HeaderSize
!= NULL
) {
1337 CopiedLen
= MIN (*HeaderSize
, Udp6Rx
->DataLength
);
1338 *HeaderSize
= CopiedLen
;
1339 CopyMem (HeaderPtr
, Udp6Rx
->FragmentTable
[0].FragmentBuffer
, *HeaderSize
);
1342 // Copy the other part of received data.
1344 if (Udp6Rx
->DataLength
- CopiedLen
> *BufferSize
) {
1345 Status
= EFI_BUFFER_TOO_SMALL
;
1347 *BufferSize
= Udp6Rx
->DataLength
- CopiedLen
;
1348 CopyMem (BufferPtr
, (UINT8
*) Udp6Rx
->FragmentTable
[0].FragmentBuffer
+ CopiedLen
, *BufferSize
);
1351 // Recycle the receiving buffer after copy to user.
1353 gBS
->SignalEvent (Udp6Rx
->RecycleSignal
);
1355 Udp4Rx
= Udp4Token
.Packet
.RxData
;
1356 ASSERT (Udp4Rx
!= NULL
);
1358 // Copy the header part of received data.
1360 if (HeaderSize
!= NULL
) {
1361 CopiedLen
= MIN (*HeaderSize
, Udp4Rx
->DataLength
);
1362 *HeaderSize
= CopiedLen
;
1363 CopyMem (HeaderPtr
, Udp4Rx
->FragmentTable
[0].FragmentBuffer
, *HeaderSize
);
1366 // Copy the other part of received data.
1368 if (Udp4Rx
->DataLength
- CopiedLen
> *BufferSize
) {
1369 Status
= EFI_BUFFER_TOO_SMALL
;
1371 *BufferSize
= Udp4Rx
->DataLength
- CopiedLen
;
1372 CopyMem (BufferPtr
, (UINT8
*) Udp4Rx
->FragmentTable
[0].FragmentBuffer
+ CopiedLen
, *BufferSize
);
1375 // Recycle the receiving buffer after copy to user.
1377 gBS
->SignalEvent (Udp4Rx
->RecycleSignal
);
1381 if (Mode
->UsingIpv6
) {
1382 Private
->Udp6Read
->Cancel (Private
->Udp6Read
, &Udp6Token
);
1383 gBS
->CloseEvent (Udp6Token
.Event
);
1385 Private
->Udp4Read
->Cancel (Private
->Udp4Read
, &Udp4Token
);
1386 gBS
->CloseEvent (Udp4Token
.Event
);
1394 Updates the IP receive filters of a network device and enables software filtering.
1396 The NewFilter field is used to modify the network device's current IP receive
1397 filter settings and to enable a software filter. This function updates the IpFilter
1398 field of the EFI_PXE_BASE_CODE_MODE structure with the contents of NewIpFilter.
1399 The software filter is used when the USE_FILTER in OpFlags is set to UdpRead().
1400 The current hardware filter remains in effect no matter what the settings of OpFlags.
1401 This is so that the meaning of ANY_DEST_IP set in OpFlags to UdpRead() is from those
1402 packets whose reception is enabled in hardware-physical NIC address (unicast),
1403 broadcast address, logical address or addresses (multicast), or all (promiscuous).
1404 UdpRead() does not modify the IP filter settings.
1405 Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP receive
1406 filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.
1407 If an application or driver wishes to preserve the IP receive filter settings,
1408 it will have to preserve the IP receive filter settings before these calls, and
1409 use SetIpFilter() to restore them after the calls. If incompatible filtering is
1410 requested (for example, PROMISCUOUS with anything else), or if the device does not
1411 support a requested filter setting and it cannot be accommodated in software
1412 (for example, PROMISCUOUS not supported), EFI_INVALID_PARAMETER will be returned.
1413 The IPlist field is used to enable IPs other than the StationIP. They may be
1414 multicast or unicast. If IPcnt is set as well as EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP,
1415 then both the StationIP and the IPs from the IPlist will be used.
1417 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
1418 @param[in] NewFilter Pointer to the new set of IP receive filters.
1420 @retval EFI_SUCCESS The IP receive filter settings were updated.
1421 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
1422 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1427 EfiPxeBcSetIpFilter (
1428 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
1429 IN EFI_PXE_BASE_CODE_IP_FILTER
*NewFilter
1433 PXEBC_PRIVATE_DATA
*Private
;
1434 EFI_PXE_BASE_CODE_MODE
*Mode
;
1435 EFI_UDP4_CONFIG_DATA
*Udp4Cfg
;
1436 EFI_UDP6_CONFIG_DATA
*Udp6Cfg
;
1438 BOOLEAN NeedPromiscuous
;
1439 BOOLEAN AcceptPromiscuous
;
1440 BOOLEAN AcceptBroadcast
;
1441 BOOLEAN MultiCastUpdate
;
1443 if (This
== NULL
|| NewFilter
== NULL
) {
1444 return EFI_INVALID_PARAMETER
;
1447 Private
= PXEBC_PRIVATE_DATA_FROM_PXEBC (This
);
1448 Mode
= Private
->PxeBc
.Mode
;
1449 Status
= EFI_SUCCESS
;
1450 NeedPromiscuous
= FALSE
;
1452 if (!Mode
->Started
) {
1453 return EFI_NOT_STARTED
;
1456 for (Index
= 0; Index
< NewFilter
->IpCnt
; Index
++) {
1457 ASSERT (Index
< EFI_PXE_BASE_CODE_MAX_IPCNT
);
1458 if (!Mode
->UsingIpv6
&&
1459 IP4_IS_LOCAL_BROADCAST (EFI_IP4 (NewFilter
->IpList
[Index
].v4
))) {
1461 // IPv4 broadcast address should not be in IP filter.
1463 return EFI_INVALID_PARAMETER
;
1465 if ((NewFilter
->Filters
& EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP
) != 0 &&
1466 (NetIp4IsUnicast (EFI_IP4 (NewFilter
->IpList
[Index
].v4
), 0) ||
1467 NetIp6IsValidUnicast (&NewFilter
->IpList
[Index
].v6
))) {
1469 // If EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP is set and IPv4/IPv6 address
1470 // is in IpList, promiscuous mode is needed.
1472 NeedPromiscuous
= TRUE
;
1476 AcceptPromiscuous
= FALSE
;
1477 AcceptBroadcast
= FALSE
;
1478 MultiCastUpdate
= FALSE
;
1480 if (NeedPromiscuous
||
1481 (NewFilter
->Filters
& EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS
) != 0 ||
1482 (NewFilter
->Filters
& EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS_MULTICAST
) != 0) {
1484 // Configure UDPv4/UDPv6 as promiscuous mode to receive all packets.
1486 AcceptPromiscuous
= TRUE
;
1487 } else if ((NewFilter
->Filters
& EFI_PXE_BASE_CODE_IP_FILTER_BROADCAST
) != 0) {
1489 // Configure UDPv4 to receive all broadcast packets.
1491 AcceptBroadcast
= TRUE
;
1495 // In multicast condition when Promiscuous FALSE and IpCnt no-zero.
1496 // Here check if there is any update of the multicast ip address. If yes,
1497 // we need leave the old multicast group (by Config UDP instance to NULL),
1498 // and join the new multicast group.
1500 if (!AcceptPromiscuous
) {
1501 if ((NewFilter
->Filters
& EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP
) != 0) {
1502 if (Mode
->IpFilter
.IpCnt
!= NewFilter
->IpCnt
) {
1503 MultiCastUpdate
= TRUE
;
1504 } else if (CompareMem (Mode
->IpFilter
.IpList
, NewFilter
->IpList
, NewFilter
->IpCnt
* sizeof (EFI_IP_ADDRESS
)) != 0 ) {
1505 MultiCastUpdate
= TRUE
;
1510 if (!Mode
->UsingIpv6
) {
1512 // Check whether we need reconfigure the UDP4 instance.
1514 Udp4Cfg
= &Private
->Udp4CfgData
;
1515 if ((AcceptPromiscuous
!= Udp4Cfg
->AcceptPromiscuous
) ||
1516 (AcceptBroadcast
!= Udp4Cfg
->AcceptBroadcast
) || MultiCastUpdate
) {
1518 // Clear the UDP4 instance configuration, all joined groups will be left
1519 // during the operation.
1521 Private
->Udp4Read
->Configure (Private
->Udp4Read
, NULL
);
1524 // Configure the UDP instance with the new configuration.
1526 Udp4Cfg
->AcceptPromiscuous
= AcceptPromiscuous
;
1527 Udp4Cfg
->AcceptBroadcast
= AcceptBroadcast
;
1528 Status
= Private
->Udp4Read
->Configure (Private
->Udp4Read
, Udp4Cfg
);
1529 if (EFI_ERROR (Status
)) {
1534 // In not Promiscuous mode, need to join the new multicast group.
1536 if (!AcceptPromiscuous
) {
1537 for (Index
= 0; Index
< NewFilter
->IpCnt
; ++Index
) {
1538 if (IP4_IS_MULTICAST (EFI_NTOHL (NewFilter
->IpList
[Index
].v4
))) {
1540 // Join the mutilcast group.
1542 Status
= Private
->Udp4Read
->Groups (Private
->Udp4Read
, TRUE
, &NewFilter
->IpList
[Index
].v4
);
1543 if (EFI_ERROR (Status
)) {
1552 // Check whether we need reconfigure the UDP6 instance.
1554 Udp6Cfg
= &Private
->Udp6CfgData
;
1555 if ((AcceptPromiscuous
!= Udp6Cfg
->AcceptPromiscuous
) || MultiCastUpdate
) {
1557 // Clear the UDP6 instance configuration, all joined groups will be left
1558 // during the operation.
1560 Private
->Udp6Read
->Configure (Private
->Udp6Read
, NULL
);
1563 // Configure the UDP instance with the new configuration.
1565 Udp6Cfg
->AcceptPromiscuous
= AcceptPromiscuous
;
1566 Status
= Private
->Udp6Read
->Configure (Private
->Udp6Read
, Udp6Cfg
);
1567 if (EFI_ERROR (Status
)) {
1572 // In not Promiscuous mode, need to join the new multicast group.
1574 if (!AcceptPromiscuous
) {
1575 for (Index
= 0; Index
< NewFilter
->IpCnt
; ++Index
) {
1576 if (IP6_IS_MULTICAST (&NewFilter
->IpList
[Index
].v6
)) {
1578 // Join the mutilcast group.
1580 Status
= Private
->Udp6Read
->Groups (Private
->Udp6Read
, TRUE
, &NewFilter
->IpList
[Index
].v6
);
1581 if (EFI_ERROR (Status
)) {
1591 // Save the new IP filter into mode data.
1593 CopyMem (&Mode
->IpFilter
, NewFilter
, sizeof (Mode
->IpFilter
));
1600 Uses the ARP protocol to resolve a MAC address. It is not supported for IPv6.
1602 This function uses the ARP protocol to resolve a MAC address. The IP address specified
1603 by IpAddr is used to resolve a MAC address. If the ARP protocol succeeds in resolving
1604 the specified address, then the ArpCacheEntries and ArpCache fields of the mode data
1605 are updated, and EFI_SUCCESS is returned. If MacAddr is not NULL, the resolved
1606 MAC address is placed there as well. If the PXE Base Code protocol is in the
1607 stopped state, then EFI_NOT_STARTED is returned. If the ARP protocol encounters
1608 a timeout condition while attempting to resolve an address, then EFI_TIMEOUT is
1609 returned. If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,
1610 then EFI_ABORTED is returned.
1612 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
1613 @param[in] IpAddr Pointer to the IP address that is used to resolve a MAC address.
1614 @param[in] MacAddr If not NULL, a pointer to the MAC address that was resolved with the
1617 @retval EFI_SUCCESS The IP or MAC address was resolved.
1618 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
1619 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1620 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
1621 @retval EFI_ICMP_ERROR An error occur with the ICMP packet message.
1627 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
1628 IN EFI_IP_ADDRESS
*IpAddr
,
1629 IN EFI_MAC_ADDRESS
*MacAddr OPTIONAL
1632 PXEBC_PRIVATE_DATA
*Private
;
1633 EFI_PXE_BASE_CODE_MODE
*Mode
;
1634 EFI_EVENT ResolvedEvent
;
1636 EFI_MAC_ADDRESS TempMac
;
1637 EFI_MAC_ADDRESS ZeroMac
;
1640 if (This
== NULL
|| IpAddr
== NULL
) {
1641 return EFI_INVALID_PARAMETER
;
1644 Private
= PXEBC_PRIVATE_DATA_FROM_PXEBC (This
);
1645 Mode
= Private
->PxeBc
.Mode
;
1646 ResolvedEvent
= NULL
;
1647 Status
= EFI_SUCCESS
;
1650 if (!Mode
->Started
) {
1651 return EFI_NOT_STARTED
;
1654 if (Mode
->UsingIpv6
) {
1655 return EFI_UNSUPPORTED
;
1659 // Station address should be ready before do arp.
1661 if (!Private
->IsAddressOk
) {
1662 return EFI_INVALID_PARAMETER
;
1665 Mode
->IcmpErrorReceived
= FALSE
;
1666 ZeroMem (&TempMac
, sizeof (EFI_MAC_ADDRESS
));
1667 ZeroMem (&ZeroMac
, sizeof (EFI_MAC_ADDRESS
));
1669 if (!Mode
->AutoArp
) {
1671 // If AutoArp is FALSE, only search in the current Arp cache.
1673 PxeBcArpCacheUpdate (NULL
, Private
);
1674 if (!PxeBcCheckArpCache (Mode
, &IpAddr
->v4
, &TempMac
)) {
1675 Status
= EFI_DEVICE_ERROR
;
1679 Status
= gBS
->CreateEvent (
1686 if (EFI_ERROR (Status
)) {
1691 // If AutoArp is TRUE, try to send Arp request on initiative.
1693 Status
= Private
->Arp
->Request (Private
->Arp
, &IpAddr
->v4
, ResolvedEvent
, &TempMac
);
1694 if (EFI_ERROR (Status
) && Status
!= EFI_NOT_READY
) {
1698 while (!IsResolved
) {
1699 if (CompareMem (&TempMac
, &ZeroMac
, sizeof (EFI_MAC_ADDRESS
)) != 0) {
1703 if (CompareMem (&TempMac
, &ZeroMac
, sizeof (EFI_MAC_ADDRESS
)) != 0) {
1704 Status
= EFI_SUCCESS
;
1706 Status
= EFI_TIMEOUT
;
1711 // Copy the Mac address to user if needed.
1713 if (MacAddr
!= NULL
&& !EFI_ERROR (Status
)) {
1714 CopyMem (MacAddr
, &TempMac
, sizeof (EFI_MAC_ADDRESS
));
1718 if (ResolvedEvent
!= NULL
) {
1719 gBS
->CloseEvent (ResolvedEvent
);
1726 Updates the parameters that affect the operation of the PXE Base Code Protocol.
1728 This function sets parameters that affect the operation of the PXE Base Code Protocol.
1729 The parameter specified by NewAutoArp is used to control the generation of ARP
1730 protocol packets. If NewAutoArp is TRUE, then ARP Protocol packets will be generated
1731 as required by the PXE Base Code Protocol. If NewAutoArp is FALSE, then no ARP
1732 Protocol packets will be generated. In this case, the only mappings that are
1733 available are those stored in the ArpCache of the EFI_PXE_BASE_CODE_MODE structure.
1734 If there are not enough mappings in the ArpCache to perform a PXE Base Code Protocol
1735 service, then the service will fail. This function updates the AutoArp field of
1736 the EFI_PXE_BASE_CODE_MODE structure to NewAutoArp.
1737 The SetParameters() call must be invoked after a Callback Protocol is installed
1738 to enable the use of callbacks.
1740 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
1741 @param[in] NewAutoArp If not NULL, a pointer to a value that specifies whether to replace the
1742 current value of AutoARP.
1743 @param[in] NewSendGUID If not NULL, a pointer to a value that specifies whether to replace the
1744 current value of SendGUID.
1745 @param[in] NewTTL If not NULL, a pointer to be used in place of the current value of TTL,
1746 the "time to live" field of the IP header.
1747 @param[in] NewToS If not NULL, a pointer to be used in place of the current value of ToS,
1748 the "type of service" field of the IP header.
1749 @param[in] NewMakeCallback If not NULL, a pointer to a value that specifies whether to replace the
1750 current value of the MakeCallback field of the Mode structure.
1752 @retval EFI_SUCCESS The new parameters values were updated.
1753 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
1754 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1759 EfiPxeBcSetParameters (
1760 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
1761 IN BOOLEAN
*NewAutoArp OPTIONAL
,
1762 IN BOOLEAN
*NewSendGUID OPTIONAL
,
1763 IN UINT8
*NewTTL OPTIONAL
,
1764 IN UINT8
*NewToS OPTIONAL
,
1765 IN BOOLEAN
*NewMakeCallback OPTIONAL
1768 PXEBC_PRIVATE_DATA
*Private
;
1769 EFI_PXE_BASE_CODE_MODE
*Mode
;
1770 EFI_GUID SystemGuid
;
1774 return EFI_INVALID_PARAMETER
;
1777 Private
= PXEBC_PRIVATE_DATA_FROM_PXEBC (This
);
1778 Mode
= Private
->PxeBc
.Mode
;
1780 if (!Mode
->Started
) {
1781 return EFI_NOT_STARTED
;
1784 if (NewMakeCallback
!= NULL
) {
1785 if (*NewMakeCallback
) {
1787 // Update the previous PxeBcCallback protocol.
1789 Status
= gBS
->HandleProtocol (
1790 Private
->Controller
,
1791 &gEfiPxeBaseCodeCallbackProtocolGuid
,
1792 (VOID
**) &Private
->PxeBcCallback
1795 if (EFI_ERROR (Status
) || (Private
->PxeBcCallback
->Callback
== NULL
)) {
1796 return EFI_INVALID_PARAMETER
;
1799 Private
->PxeBcCallback
= NULL
;
1801 Mode
->MakeCallbacks
= *NewMakeCallback
;
1804 if (NewSendGUID
!= NULL
) {
1805 if (*NewSendGUID
&& EFI_ERROR (NetLibGetSystemGuid (&SystemGuid
))) {
1806 return EFI_INVALID_PARAMETER
;
1808 Mode
->SendGUID
= *NewSendGUID
;
1811 if (NewAutoArp
!= NULL
) {
1812 Mode
->AutoArp
= *NewAutoArp
;
1815 if (NewTTL
!= NULL
) {
1816 Mode
->TTL
= *NewTTL
;
1819 if (NewToS
!= NULL
) {
1820 Mode
->ToS
= *NewToS
;
1828 Updates the station IP address and/or subnet mask values of a network device.
1830 This function updates the station IP address and/or subnet mask values of a network
1831 device. The NewStationIp field is used to modify the network device's current IP address.
1832 If NewStationIP is NULL, then the current IP address will not be modified. Otherwise,
1833 this function updates the StationIp field of the EFI_PXE_BASE_CODE_MODE structure
1834 with NewStationIp. The NewSubnetMask field is used to modify the network device's current subnet
1835 mask. If NewSubnetMask is NULL, then the current subnet mask will not be modified.
1836 Otherwise, this function updates the SubnetMask field of the EFI_PXE_BASE_CODE_MODE
1837 structure with NewSubnetMask.
1839 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
1840 @param[in] NewStationIp Pointer to the new IP address to be used by the network device.
1841 @param[in] NewSubnetMask Pointer to the new subnet mask to be used by the network device.
1843 @retval EFI_SUCCESS The new station IP address and/or subnet mask were updated.
1844 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
1845 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1850 EfiPxeBcSetStationIP (
1851 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
1852 IN EFI_IP_ADDRESS
*NewStationIp OPTIONAL
,
1853 IN EFI_IP_ADDRESS
*NewSubnetMask OPTIONAL
1857 PXEBC_PRIVATE_DATA
*Private
;
1858 EFI_PXE_BASE_CODE_MODE
*Mode
;
1859 EFI_ARP_CONFIG_DATA ArpConfigData
;
1862 return EFI_INVALID_PARAMETER
;
1865 if (NewStationIp
!= NULL
&&
1866 (!NetIp4IsUnicast (NTOHL (NewStationIp
->Addr
[0]), 0) &&
1867 !NetIp6IsValidUnicast (&NewStationIp
->v6
))) {
1868 return EFI_INVALID_PARAMETER
;
1871 Private
= PXEBC_PRIVATE_DATA_FROM_PXEBC (This
);
1872 Mode
= Private
->PxeBc
.Mode
;
1873 Status
= EFI_SUCCESS
;
1875 if (!Mode
->UsingIpv6
&&
1876 NewSubnetMask
!= NULL
&&
1877 !IP4_IS_VALID_NETMASK (NTOHL (NewSubnetMask
->Addr
[0]))) {
1878 return EFI_INVALID_PARAMETER
;
1881 if (!Mode
->Started
) {
1882 return EFI_NOT_STARTED
;
1885 if (Mode
->UsingIpv6
&& NewStationIp
!= NULL
) {
1887 // Set the IPv6 address by Ip6Config protocol.
1889 Status
= PxeBcRegisterIp6Address (Private
, &NewStationIp
->v6
);
1890 if (EFI_ERROR (Status
)) {
1893 } else if (!Mode
->UsingIpv6
&& NewStationIp
!= NULL
) {
1895 // Configure the corresponding ARP with the IPv4 address.
1897 ZeroMem (&ArpConfigData
, sizeof (EFI_ARP_CONFIG_DATA
));
1899 ArpConfigData
.SwAddressType
= 0x0800;
1900 ArpConfigData
.SwAddressLength
= (UINT8
) sizeof (EFI_IPv4_ADDRESS
);
1901 ArpConfigData
.StationAddress
= &NewStationIp
->v4
;
1903 Private
->Arp
->Configure (Private
->Arp
, NULL
);
1904 Private
->Arp
->Configure (Private
->Arp
, &ArpConfigData
);
1906 if (NewSubnetMask
!= NULL
) {
1907 Mode
->RouteTableEntries
= 1;
1908 Mode
->RouteTable
[0].IpAddr
.Addr
[0] = NewStationIp
->Addr
[0] & NewSubnetMask
->Addr
[0];
1909 Mode
->RouteTable
[0].SubnetMask
.Addr
[0] = NewSubnetMask
->Addr
[0];
1910 Mode
->RouteTable
[0].GwAddr
.Addr
[0] = 0;
1913 Private
->IsAddressOk
= TRUE
;
1916 if (NewStationIp
!= NULL
) {
1917 CopyMem (&Mode
->StationIp
, NewStationIp
, sizeof (EFI_IP_ADDRESS
));
1918 CopyMem (&Private
->StationIp
, NewStationIp
, sizeof (EFI_IP_ADDRESS
));
1921 if (!Mode
->UsingIpv6
&& NewSubnetMask
!= NULL
) {
1922 CopyMem (&Mode
->SubnetMask
, NewSubnetMask
, sizeof (EFI_IP_ADDRESS
));
1923 CopyMem (&Private
->SubnetMask
,NewSubnetMask
, sizeof (EFI_IP_ADDRESS
));
1926 Status
= PxeBcFlushStaionIp (Private
, NewStationIp
, NewSubnetMask
);
1933 Updates the contents of the cached DHCP and Discover packets.
1935 The pointers to the new packets are used to update the contents of the cached
1936 packets in the EFI_PXE_BASE_CODE_MODE structure.
1938 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
1939 @param[in] NewDhcpDiscoverValid Pointer to a value that will replace the current
1940 DhcpDiscoverValid field.
1941 @param[in] NewDhcpAckReceived Pointer to a value that will replace the current
1942 DhcpAckReceived field.
1943 @param[in] NewProxyOfferReceived Pointer to a value that will replace the current
1944 ProxyOfferReceived field.
1945 @param[in] NewPxeDiscoverValid Pointer to a value that will replace the current
1946 ProxyOfferReceived field.
1947 @param[in] NewPxeReplyReceived Pointer to a value that will replace the current
1948 PxeReplyReceived field.
1949 @param[in] NewPxeBisReplyReceived Pointer to a value that will replace the current
1950 PxeBisReplyReceived field.
1951 @param[in] NewDhcpDiscover Pointer to the new cached DHCP Discover packet contents.
1952 @param[in] NewDhcpAck Pointer to the new cached DHCP Ack packet contents.
1953 @param[in] NewProxyOffer Pointer to the new cached Proxy Offer packet contents.
1954 @param[in] NewPxeDiscover Pointer to the new cached PXE Discover packet contents.
1955 @param[in] NewPxeReply Pointer to the new cached PXE Reply packet contents.
1956 @param[in] NewPxeBisReply Pointer to the new cached PXE BIS Reply packet contents.
1958 @retval EFI_SUCCESS The cached packet contents were updated.
1959 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
1960 @retval EFI_INVALID_PARAMETER This is NULL or does not point to a valid
1961 EFI_PXE_BASE_CODE_PROTOCOL structure.
1966 EfiPxeBcSetPackets (
1967 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
1968 IN BOOLEAN
*NewDhcpDiscoverValid OPTIONAL
,
1969 IN BOOLEAN
*NewDhcpAckReceived OPTIONAL
,
1970 IN BOOLEAN
*NewProxyOfferReceived OPTIONAL
,
1971 IN BOOLEAN
*NewPxeDiscoverValid OPTIONAL
,
1972 IN BOOLEAN
*NewPxeReplyReceived OPTIONAL
,
1973 IN BOOLEAN
*NewPxeBisReplyReceived OPTIONAL
,
1974 IN EFI_PXE_BASE_CODE_PACKET
*NewDhcpDiscover OPTIONAL
,
1975 IN EFI_PXE_BASE_CODE_PACKET
*NewDhcpAck OPTIONAL
,
1976 IN EFI_PXE_BASE_CODE_PACKET
*NewProxyOffer OPTIONAL
,
1977 IN EFI_PXE_BASE_CODE_PACKET
*NewPxeDiscover OPTIONAL
,
1978 IN EFI_PXE_BASE_CODE_PACKET
*NewPxeReply OPTIONAL
,
1979 IN EFI_PXE_BASE_CODE_PACKET
*NewPxeBisReply OPTIONAL
1982 PXEBC_PRIVATE_DATA
*Private
;
1983 EFI_PXE_BASE_CODE_MODE
*Mode
;
1986 return EFI_INVALID_PARAMETER
;
1989 Private
= PXEBC_PRIVATE_DATA_FROM_PXEBC (This
);
1990 Mode
= Private
->PxeBc
.Mode
;
1992 if (!Mode
->Started
) {
1993 return EFI_NOT_STARTED
;
1996 if (NewDhcpDiscoverValid
!= NULL
) {
1997 Mode
->DhcpDiscoverValid
= *NewDhcpDiscoverValid
;
2000 if (NewDhcpAckReceived
!= NULL
) {
2001 Mode
->DhcpAckReceived
= *NewDhcpAckReceived
;
2004 if (NewProxyOfferReceived
!= NULL
) {
2005 Mode
->ProxyOfferReceived
= *NewProxyOfferReceived
;
2008 if (NewPxeDiscoverValid
!= NULL
) {
2009 Mode
->PxeDiscoverValid
= *NewPxeDiscoverValid
;
2012 if (NewPxeReplyReceived
!= NULL
) {
2013 Mode
->PxeReplyReceived
= *NewPxeReplyReceived
;
2016 if (NewPxeBisReplyReceived
!= NULL
) {
2017 Mode
->PxeBisReplyReceived
= *NewPxeBisReplyReceived
;
2020 if (NewDhcpDiscover
!= NULL
) {
2021 CopyMem (&Mode
->DhcpDiscover
, NewDhcpDiscover
, sizeof (EFI_PXE_BASE_CODE_PACKET
));
2024 if (NewDhcpAck
!= NULL
) {
2025 CopyMem (&Mode
->DhcpAck
, NewDhcpAck
, sizeof (EFI_PXE_BASE_CODE_PACKET
));
2028 if (NewProxyOffer
!= NULL
) {
2029 CopyMem (&Mode
->ProxyOffer
, NewProxyOffer
, sizeof (EFI_PXE_BASE_CODE_PACKET
));
2032 if (NewPxeDiscover
!= NULL
) {
2033 CopyMem (&Mode
->PxeDiscover
, NewPxeDiscover
, sizeof (EFI_PXE_BASE_CODE_PACKET
));
2036 if (NewPxeReply
!= NULL
) {
2037 CopyMem (&Mode
->PxeReply
, NewPxeReply
, sizeof (EFI_PXE_BASE_CODE_PACKET
));
2040 if (NewPxeBisReply
!= NULL
) {
2041 CopyMem (&Mode
->PxeBisReply
, NewPxeBisReply
, sizeof (EFI_PXE_BASE_CODE_PACKET
));
2047 EFI_PXE_BASE_CODE_PROTOCOL gPxeBcProtocolTemplate
= {
2048 EFI_PXE_BASE_CODE_PROTOCOL_REVISION
,
2056 EfiPxeBcSetIpFilter
,
2058 EfiPxeBcSetParameters
,
2059 EfiPxeBcSetStationIP
,
2066 Callback function that is invoked when the PXE Base Code Protocol is about to transmit, has
2067 received, or is waiting to receive a packet.
2069 This function is invoked when the PXE Base Code Protocol is about to transmit, has received,
2070 or is waiting to receive a packet. Parameters Function and Received specify the type of event.
2071 Parameters PacketLen and Packet specify the packet that generated the event. If these fields
2072 are zero and NULL respectively, then this is a status update callback. If the operation specified
2073 by Function is to continue, then CALLBACK_STATUS_CONTINUE should be returned. If the operation
2074 specified by Function should be aborted, then CALLBACK_STATUS_ABORT should be returned. Due to
2075 the polling nature of UEFI device drivers, a callback function should not execute for more than 5 ms.
2076 The SetParameters() function must be called after a Callback Protocol is installed to enable the
2079 @param[in] This Pointer to the EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL instance.
2080 @param[in] Function The PXE Base Code Protocol function that is waiting for an event.
2081 @param[in] Received TRUE if the callback is being invoked due to a receive event. FALSE if
2082 the callback is being invoked due to a transmit event.
2083 @param[in] PacketLength The length, in bytes, of Packet. This field will have a value of zero if
2084 this is a wait for receive event.
2085 @param[in] PacketPtr If Received is TRUE, a pointer to the packet that was just received;
2086 otherwise a pointer to the packet that is about to be transmitted.
2088 @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE If Function specifies a continue operation.
2089 @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT If Function specifies an abort operation.
2092 EFI_PXE_BASE_CODE_CALLBACK_STATUS
2094 EfiPxeLoadFileCallback (
2095 IN EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL
*This
,
2096 IN EFI_PXE_BASE_CODE_FUNCTION Function
,
2097 IN BOOLEAN Received
,
2098 IN UINT32 PacketLength
,
2099 IN EFI_PXE_BASE_CODE_PACKET
*PacketPtr OPTIONAL
2106 // Catch Ctrl-C or ESC to abort.
2108 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
2110 if (!EFI_ERROR (Status
)) {
2112 if (Key
.ScanCode
== SCAN_ESC
|| Key
.UnicodeChar
== (0x1F & 'c')) {
2114 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT
;
2118 // No print if receive packet
2121 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE
;
2124 // Print only for three functions
2128 case EFI_PXE_BASE_CODE_FUNCTION_MTFTP
:
2130 // Print only for open MTFTP packets, not every MTFTP packets
2132 if (PacketLength
!= 0 && PacketPtr
!= NULL
) {
2133 if (PacketPtr
->Raw
[0x1C] != 0x00 || PacketPtr
->Raw
[0x1D] != 0x01) {
2134 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE
;
2139 case EFI_PXE_BASE_CODE_FUNCTION_DHCP
:
2140 case EFI_PXE_BASE_CODE_FUNCTION_DISCOVER
:
2144 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE
;
2147 if (PacketLength
!= 0 && PacketPtr
!= NULL
) {
2149 // Print '.' when transmit a packet
2154 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE
;
2157 EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL gPxeBcCallBackTemplate
= {
2158 EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION
,
2159 EfiPxeLoadFileCallback
2164 Causes the driver to load a specified file.
2166 @param[in] This Protocol instance pointer.
2167 @param[in] FilePath The device specific path of the file to load.
2168 @param[in] BootPolicy If TRUE, indicates that the request originates from the
2169 boot manager is attempting to load FilePath as a boot
2170 selection. If FALSE, then FilePath must match an exact file
2172 @param[in, out] BufferSize On input the size of Buffer in bytes. On output with a return
2173 code of EFI_SUCCESS, the amount of data transferred to
2174 Buffer. On output with a return code of EFI_BUFFER_TOO_SMALL,
2175 the size of Buffer required to retrieve the requested file.
2176 @param[in] Buffer The memory buffer to transfer the file to. IF Buffer is NULL,
2177 then no the size of the requested file is returned in
2180 @retval EFI_SUCCESS The file was loaded.
2181 @retval EFI_UNSUPPORTED The device does not support the provided BootPolicy.
2182 @retval EFI_INVALID_PARAMETER FilePath is not a valid device path, or
2184 @retval EFI_NO_MEDIA No medium was present to load the file.
2185 @retval EFI_DEVICE_ERROR The file was not loaded due to a device error.
2186 @retval EFI_NO_RESPONSE The remote system did not respond.
2187 @retval EFI_NOT_FOUND The file was not found.
2188 @retval EFI_ABORTED The file load process was manually cancelled.
2194 IN EFI_LOAD_FILE_PROTOCOL
*This
,
2195 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
,
2196 IN BOOLEAN BootPolicy
,
2197 IN OUT UINTN
*BufferSize
,
2198 IN VOID
*Buffer OPTIONAL
2201 PXEBC_PRIVATE_DATA
*Private
;
2202 PXEBC_VIRTUAL_NIC
*VirtualNic
;
2203 EFI_PXE_BASE_CODE_PROTOCOL
*PxeBc
;
2206 BOOLEAN MediaPresent
;
2208 VirtualNic
= PXEBC_VIRTUAL_NIC_FROM_LOADFILE (This
);
2209 Private
= VirtualNic
->Private
;
2210 PxeBc
= &Private
->PxeBc
;
2212 Status
= EFI_DEVICE_ERROR
;
2214 if (This
== NULL
|| BufferSize
== NULL
) {
2215 return EFI_INVALID_PARAMETER
;
2219 // Only support BootPolicy
2222 return EFI_UNSUPPORTED
;
2226 // Check media status before PXE start
2228 MediaPresent
= TRUE
;
2229 NetLibDetectMedia (Private
->Controller
, &MediaPresent
);
2230 if (!MediaPresent
) {
2231 return EFI_NO_MEDIA
;
2235 // Check whether the virtual nic is using IPv6 or not.
2237 if (VirtualNic
== Private
->Ip6Nic
) {
2242 // Start Pxe Base Code to initialize PXE boot.
2244 Status
= PxeBc
->Start (PxeBc
, UsingIpv6
);
2245 if (Status
== EFI_SUCCESS
|| Status
== EFI_ALREADY_STARTED
) {
2246 Status
= PxeBcLoadBootFile (Private
, BufferSize
, Buffer
);
2249 if (Status
!= EFI_SUCCESS
&&
2250 Status
!= EFI_UNSUPPORTED
&&
2251 Status
!= EFI_BUFFER_TOO_SMALL
) {
2253 // There are three cases, which needn't stop pxebc here.
2254 // 1. success to download file.
2255 // 2. success to get file size.
2258 PxeBc
->Stop (PxeBc
);
2264 EFI_LOAD_FILE_PROTOCOL gLoadFileProtocolTemplate
= { EfiPxeLoadFile
};