2 Interface routines for PxeBc.
4 Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #include "PxeBcImpl.h"
18 UINT32 mPxeDhcpTimeout
[4] = { 4, 8, 16, 32 };
21 Get and record the arp cache.
23 @param This Pointer to EFI_PXE_BC_PROTOCOL
25 @retval EFI_SUCCESS Arp cache updated successfully
26 @retval others If error occurs when getting arp cache
31 IN EFI_PXE_BASE_CODE_PROTOCOL
* This
34 PXEBC_PRIVATE_DATA
*Private
;
35 EFI_PXE_BASE_CODE_MODE
*Mode
;
39 EFI_ARP_FIND_DATA
*Entries
;
42 Private
= PXEBC_PRIVATE_DATA_FROM_PXEBC (This
);
43 Mode
= Private
->PxeBc
.Mode
;
45 Status
= Private
->Arp
->Find (
54 if (EFI_ERROR (Status
)) {
58 Mode
->ArpCacheEntries
= MIN (
60 EFI_PXE_BASE_CODE_MAX_ARP_ENTRIES
62 for (Index
= 0; Index
< Mode
->ArpCacheEntries
; Index
++) {
64 &Mode
->ArpCache
[Index
].IpAddr
,
66 Entries
->SwAddressLength
69 &Mode
->ArpCache
[Index
].MacAddr
,
70 (UINT8
*) (Entries
+ 1) + Entries
->SwAddressLength
,
71 Entries
->HwAddressLength
74 // Slip to the next FindData.
76 Entries
= (EFI_ARP_FIND_DATA
*) ((UINT8
*) Entries
+ EntryLength
);
83 Timeout routine to update arp cache.
85 @param Event Pointer to EFI_PXE_BC_PROTOCOL
86 @param Context Context of the timer event
91 ArpCacheUpdateTimeout (
96 UpdateArpCache ((EFI_PXE_BASE_CODE_PROTOCOL
*) Context
);
100 Do arp resolution from arp cache in PxeBcMode.
102 @param PxeBcMode The PXE BC mode to look into.
103 @param Ip4Addr The Ip4 address for resolution.
104 @param MacAddress The resoluted MAC address if the resolution is successful.
105 The value is undefined if resolution fails.
107 @retval TRUE The resolution is successful.
108 @retval FALSE Otherwise.
113 IN EFI_PXE_BASE_CODE_MODE
*PxeBcMode
,
114 IN EFI_IPv4_ADDRESS
*Ip4Addr
,
115 OUT EFI_MAC_ADDRESS
*MacAddress
120 for (Index
= 0; Index
< PxeBcMode
->ArpCacheEntries
; Index
++) {
121 if (EFI_IP4_EQUAL (&PxeBcMode
->ArpCache
[Index
].IpAddr
.v4
, Ip4Addr
)) {
124 &PxeBcMode
->ArpCache
[Index
].MacAddr
,
125 sizeof (EFI_MAC_ADDRESS
)
135 Notify function for the ICMP receive token, used to process
136 the received ICMP packets.
138 @param Context The PXEBC private data.
143 IcmpErrorListenHandlerDpc (
148 EFI_IP4_RECEIVE_DATA
*RxData
;
149 EFI_IP4_PROTOCOL
*Ip4
;
150 PXEBC_PRIVATE_DATA
*Private
;
151 EFI_PXE_BASE_CODE_MODE
*Mode
;
154 UINT8
*CopiedPointer
;
156 Private
= (PXEBC_PRIVATE_DATA
*) Context
;
157 Mode
= &Private
->Mode
;
158 Status
= Private
->IcmpErrorRcvToken
.Status
;
159 RxData
= Private
->IcmpErrorRcvToken
.Packet
.RxData
;
162 if (Status
== EFI_ABORTED
) {
164 // The reception is actively aborted by the consumer, directly return.
169 if (EFI_ERROR (Status
) || (RxData
== NULL
)) {
171 // Only process the normal packets and the icmp error packets, if RxData is NULL
172 // with Status == EFI_SUCCESS or EFI_ICMP_ERROR, just resume the receive although
173 // this should be a bug of the low layer (IP).
178 if (EFI_IP4 (RxData
->Header
->SourceAddress
) != 0 &&
179 !NetIp4IsUnicast (EFI_NTOHL (RxData
->Header
->SourceAddress
), 0)) {
181 // The source address is not zero and it's not a unicast IP address, discard it.
186 if (!EFI_IP4_EQUAL (&RxData
->Header
->DestinationAddress
, &Mode
->StationIp
.v4
)) {
188 // The dest address is not equal to Station Ip address, discard it.
194 // Constructor ICMP error packet
197 CopiedPointer
= (UINT8
*) &Mode
->IcmpError
;
199 for (Index
= 0; Index
< RxData
->FragmentCount
; Index
++) {
200 CopiedLen
+= RxData
->FragmentTable
[Index
].FragmentLength
;
201 if (CopiedLen
<= sizeof (EFI_PXE_BASE_CODE_ICMP_ERROR
)) {
204 RxData
->FragmentTable
[Index
].FragmentBuffer
,
205 RxData
->FragmentTable
[Index
].FragmentLength
210 RxData
->FragmentTable
[Index
].FragmentBuffer
,
211 CopiedLen
- sizeof (EFI_PXE_BASE_CODE_ICMP_ERROR
)
214 CopiedPointer
+= CopiedLen
;
220 gBS
->SignalEvent (RxData
->RecycleSignal
);
223 Ip4
->Receive (Ip4
, &(Private
->IcmpErrorRcvToken
));
227 Request IcmpErrorListenHandlerDpc as a DPC at TPL_CALLBACK
229 @param Event The event signaled.
230 @param Context The context passed in by the event notifier.
235 IcmpErrorListenHandler (
241 // Request IpIoListenHandlerDpc as a DPC at TPL_CALLBACK
243 QueueDpc (TPL_CALLBACK
, IcmpErrorListenHandlerDpc
, Context
);
247 Enables the use of the PXE Base Code Protocol functions.
249 This function enables the use of the PXE Base Code Protocol functions. If the
250 Started field of the EFI_PXE_BASE_CODE_MODE structure is already TRUE, then
251 EFI_ALREADY_STARTED will be returned. If UseIpv6 is TRUE, then IPv6 formatted
252 addresses will be used in this session. If UseIpv6 is FALSE, then IPv4 formatted
253 addresses will be used in this session. If UseIpv6 is TRUE, and the Ipv6Supported
254 field of the EFI_PXE_BASE_CODE_MODE structure is FALSE, then EFI_UNSUPPORTED will
255 be returned. If there is not enough memory or other resources to start the PXE
256 Base Code Protocol, then EFI_OUT_OF_RESOURCES will be returned. Otherwise, the
257 PXE Base Code Protocol will be started, and all of the fields of the EFI_PXE_BASE_CODE_MODE
258 structure will be initialized as follows:
260 Ipv6SupportedUnchanged.
261 Ipv6AvailableUnchanged.
262 UsingIpv6Set to UseIpv6.
263 BisSupportedUnchanged.
264 BisDetectedUnchanged.
266 SendGUIDSet to FALSE.
267 TTLSet to DEFAULT_TTL.
268 ToSSet to DEFAULT_ToS.
269 DhcpCompletedSet to FALSE.
270 ProxyOfferReceivedSet to FALSE.
271 StationIpSet to an address of all zeros.
272 SubnetMaskSet to a subnet mask of all zeros.
273 DhcpDiscoverZero-filled.
275 ProxyOfferZero-filled.
276 PxeDiscoverValidSet to FALSE.
277 PxeDiscoverZero-filled.
278 PxeReplyValidSet to FALSE.
280 PxeBisReplyValidSet to FALSE.
281 PxeBisReplyZero-filled.
282 IpFilterSet the Filters field to 0 and the IpCnt field to 0.
283 ArpCacheEntriesSet to 0.
285 RouteTableEntriesSet to 0.
286 RouteTableZero-filled.
287 IcmpErrorReceivedSet to FALSE.
288 IcmpErrorZero-filled.
289 TftpErroReceivedSet to FALSE.
290 TftpErrorZero-filled.
291 MakeCallbacksSet to TRUE if the PXE Base Code Callback Protocol is available.
292 Set to FALSE if the PXE Base Code Callback Protocol is not available.
294 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
295 @param UseIpv6 Specifies the type of IP addresses that are to be used during the session
296 that is being started. Set to TRUE for IPv6 addresses, and FALSE for
299 @retval EFI_SUCCESS The PXE Base Code Protocol was started.
300 @retval EFI_DEVICE_ERROR The network device encountered an error during this oper
301 @retval EFI_UNSUPPORTED UseIpv6 is TRUE, but the Ipv6Supported field of the
302 EFI_PXE_BASE_CODE_MODE structure is FALSE.
303 @retval EFI_ALREADY_STARTED The PXE Base Code Protocol is already in the started state.
304 @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid
305 EFI_PXE_BASE_CODE_PROTOCOL structure.
306 @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory or other resources to start the
307 PXE Base Code Protocol.
313 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
317 PXEBC_PRIVATE_DATA
*Private
;
318 EFI_PXE_BASE_CODE_MODE
*Mode
;
322 return EFI_INVALID_PARAMETER
;
325 Private
= PXEBC_PRIVATE_DATA_FROM_PXEBC (This
);
326 Mode
= Private
->PxeBc
.Mode
;
329 return EFI_ALREADY_STARTED
;
334 // IPv6 is not supported now.
336 return EFI_UNSUPPORTED
;
340 // Configure the udp4 instance to let it receive data
342 Status
= Private
->Udp4Read
->Configure (
344 &Private
->Udp4CfgData
346 if (EFI_ERROR (Status
)) {
352 // Configure block size for TFTP as a default value to handle all link layers.
354 Private
->BlockSize
= (UINTN
) (MIN (Private
->Ip4MaxPacketSize
, PXEBC_DEFAULT_PACKET_SIZE
) -
355 PXEBC_DEFAULT_UDP_OVERHEAD_SIZE
- PXEBC_DEFAULT_TFTP_OVERHEAD_SIZE
);
357 // If PcdTftpBlockSize is set to non-zero, override the default value.
359 if (PcdGet64 (PcdTftpBlockSize
) != 0) {
360 Private
->BlockSize
= (UINTN
) PcdGet64 (PcdTftpBlockSize
);
363 Private
->AddressIsOk
= FALSE
;
365 ZeroMem (Mode
, sizeof (EFI_PXE_BASE_CODE_MODE
));
367 Mode
->Started
= TRUE
;
368 Mode
->TTL
= DEFAULT_TTL
;
369 Mode
->ToS
= DEFAULT_ToS
;
370 Mode
->AutoArp
= TRUE
;
373 // Create the event for Arp Cache checking.
375 Status
= gBS
->CreateEvent (
376 EVT_TIMER
| EVT_NOTIFY_SIGNAL
,
378 ArpCacheUpdateTimeout
,
380 &Private
->GetArpCacheEvent
382 if (EFI_ERROR (Status
)) {
387 // Start the timeout timer event.
389 Status
= gBS
->SetTimer (
390 Private
->GetArpCacheEvent
,
395 if (EFI_ERROR (Status
)) {
400 // Create ICMP error receiving event
402 Status
= gBS
->CreateEvent (
405 IcmpErrorListenHandler
,
407 &(Private
->IcmpErrorRcvToken
.Event
)
409 if (EFI_ERROR (Status
)) {
413 Status
= Private
->Ip4
->Configure (Private
->Ip4
, &Private
->Ip4ConfigData
);
414 if (EFI_ERROR (Status
)) {
419 // start to listen incoming packet
421 Status
= Private
->Ip4
->Receive (Private
->Ip4
, &Private
->IcmpErrorRcvToken
);
422 if (!EFI_ERROR (Status
)) {
427 Private
->Ip4
->Configure (Private
->Ip4
, NULL
);
429 if (Private
->IcmpErrorRcvToken
.Event
!= NULL
) {
430 gBS
->CloseEvent (Private
->IcmpErrorRcvToken
.Event
);
433 if (Private
->GetArpCacheEvent
!= NULL
) {
434 gBS
->SetTimer (Private
->GetArpCacheEvent
, TimerCancel
, 0);
435 gBS
->CloseEvent (Private
->GetArpCacheEvent
);
438 Mode
->Started
= FALSE
;
441 Mode
->AutoArp
= FALSE
;
448 Disables the use of the PXE Base Code Protocol functions.
450 This function stops all activity on the network device. All the resources allocated
451 in Start() are released, the Started field of the EFI_PXE_BASE_CODE_MODE structure is
452 set to FALSE and EFI_SUCCESS is returned. If the Started field of the EFI_PXE_BASE_CODE_MODE
453 structure is already FALSE, then EFI_NOT_STARTED will be returned.
455 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
457 @retval EFI_SUCCESS The PXE Base Code Protocol was stopped.
458 @retval EFI_NOT_STARTED The PXE Base Code Protocol is already in the stopped state.
459 @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid
460 EFI_PXE_BASE_CODE_PROTOCOL structure.
461 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
467 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
470 PXEBC_PRIVATE_DATA
*Private
;
471 EFI_PXE_BASE_CODE_MODE
*Mode
;
474 return EFI_INVALID_PARAMETER
;
477 Private
= PXEBC_PRIVATE_DATA_FROM_PXEBC (This
);
478 Mode
= Private
->PxeBc
.Mode
;
480 if (!Mode
->Started
) {
481 return EFI_NOT_STARTED
;
484 Private
->Ip4
->Cancel (Private
->Ip4
, NULL
);
486 // Dispatch the DPCs queued by the NotifyFunction of the canceled rx token's
491 Private
->Ip4
->Configure (Private
->Ip4
, NULL
);
494 // Close the ICMP error receiving event.
496 gBS
->CloseEvent (Private
->IcmpErrorRcvToken
.Event
);
499 // Cancel the TimeoutEvent timer.
501 gBS
->SetTimer (Private
->GetArpCacheEvent
, TimerCancel
, 0);
504 // Close the TimeoutEvent event.
506 gBS
->CloseEvent (Private
->GetArpCacheEvent
);
508 Mode
->Started
= FALSE
;
510 Private
->CurrentUdpSrcPort
= 0;
511 Private
->Udp4Write
->Configure (Private
->Udp4Write
, NULL
);
512 Private
->Udp4Read
->Groups (Private
->Udp4Read
, FALSE
, NULL
);
513 Private
->Udp4Read
->Configure (Private
->Udp4Read
, NULL
);
515 Private
->Dhcp4
->Stop (Private
->Dhcp4
);
516 Private
->Dhcp4
->Configure (Private
->Dhcp4
, NULL
);
518 Private
->FileSize
= 0;
525 Attempts to complete a DHCPv4 D.O.R.A. (discover / offer / request / acknowledge) or DHCPv6
526 S.A.R.R (solicit / advertise / request / reply) sequence.
528 This function attempts to complete the DHCP sequence. If this sequence is completed,
529 then EFI_SUCCESS is returned, and the DhcpCompleted, ProxyOfferReceived, StationIp,
530 SubnetMask, DhcpDiscover, DhcpAck, and ProxyOffer fields of the EFI_PXE_BASE_CODE_MODE
531 structure are filled in.
532 If SortOffers is TRUE, then the cached DHCP offer packets will be sorted before
533 they are tried. If SortOffers is FALSE, then the cached DHCP offer packets will
534 be tried in the order in which they are received. Please see the Preboot Execution
535 Environment (PXE) Specification for additional details on the implementation of DHCP.
536 This function can take at least 31 seconds to timeout and return control to the
537 caller. If the DHCP sequence does not complete, then EFI_TIMEOUT will be returned.
538 If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,
539 then the DHCP sequence will be stopped and EFI_ABORTED will be returned.
541 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
542 @param SortOffers TRUE if the offers received should be sorted. Set to FALSE to try the
543 offers in the order that they are received.
545 @retval EFI_SUCCESS Valid DHCP has completed.
546 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
547 @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid
548 EFI_PXE_BASE_CODE_PROTOCOL structure.
549 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
550 @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory to complete the DHCP Protocol.
551 @retval EFI_ABORTED The callback function aborted the DHCP Protocol.
552 @retval EFI_TIMEOUT The DHCP Protocol timed out.
553 @retval EFI_ICMP_ERROR An ICMP error packet was received during the DHCP session.
554 @retval EFI_NO_RESPONSE Valid PXE offer was not received.
560 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
561 IN BOOLEAN SortOffers
564 PXEBC_PRIVATE_DATA
*Private
;
565 EFI_PXE_BASE_CODE_MODE
*Mode
;
566 EFI_DHCP4_PROTOCOL
*Dhcp4
;
567 EFI_DHCP4_CONFIG_DATA Dhcp4CfgData
;
568 EFI_DHCP4_MODE_DATA Dhcp4Mode
;
569 EFI_DHCP4_PACKET_OPTION
*OptList
[PXEBC_DHCP4_MAX_OPTION_NUM
];
572 EFI_ARP_CONFIG_DATA ArpConfigData
;
573 EFI_PXE_BASE_CODE_IP_FILTER IpFilter
;
576 return EFI_INVALID_PARAMETER
;
579 Status
= EFI_SUCCESS
;
580 Private
= PXEBC_PRIVATE_DATA_FROM_PXEBC (This
);
581 Mode
= Private
->PxeBc
.Mode
;
582 Dhcp4
= Private
->Dhcp4
;
583 Private
->Function
= EFI_PXE_BASE_CODE_FUNCTION_DHCP
;
584 Private
->SortOffers
= SortOffers
;
586 if (!Mode
->Started
) {
587 return EFI_NOT_STARTED
;
590 Mode
->IcmpErrorReceived
= FALSE
;
593 // Stop Udp4Read instance
595 Private
->Udp4Read
->Configure (Private
->Udp4Read
, NULL
);
598 // Initialize the DHCP options and build the option list
600 OptCount
= PxeBcBuildDhcpOptions (Private
, OptList
, TRUE
);
603 // Set the DHCP4 config data.
604 // The four discovery timeouts are 4, 8, 16, 32 seconds respectively.
606 ZeroMem (&Dhcp4CfgData
, sizeof (EFI_DHCP4_CONFIG_DATA
));
607 Dhcp4CfgData
.OptionCount
= OptCount
;
608 Dhcp4CfgData
.OptionList
= OptList
;
609 Dhcp4CfgData
.Dhcp4Callback
= PxeBcDhcpCallBack
;
610 Dhcp4CfgData
.CallbackContext
= Private
;
611 Dhcp4CfgData
.DiscoverTryCount
= 4;
612 Dhcp4CfgData
.DiscoverTimeout
= mPxeDhcpTimeout
;
614 Status
= Dhcp4
->Configure (Dhcp4
, &Dhcp4CfgData
);
615 if (EFI_ERROR (Status
)) {
620 // Zero those arrays to record the varies numbers of DHCP OFFERS.
622 Private
->GotProxyOffer
= FALSE
;
623 Private
->NumOffers
= 0;
624 Private
->BootpIndex
= 0;
625 ZeroMem (Private
->ServerCount
, sizeof (Private
->ServerCount
));
626 ZeroMem (Private
->ProxyIndex
, sizeof (Private
->ProxyIndex
));
628 Status
= Dhcp4
->Start (Dhcp4
, NULL
);
629 if (EFI_ERROR (Status
)) {
630 if (Status
== EFI_ICMP_ERROR
) {
631 Mode
->IcmpErrorReceived
= TRUE
;
636 Status
= Dhcp4
->GetModeData (Dhcp4
, &Dhcp4Mode
);
637 if (EFI_ERROR (Status
)) {
641 ASSERT (Dhcp4Mode
.State
== Dhcp4Bound
);
643 CopyMem (&Private
->StationIp
, &Dhcp4Mode
.ClientAddress
, sizeof (EFI_IPv4_ADDRESS
));
644 CopyMem (&Private
->SubnetMask
, &Dhcp4Mode
.SubnetMask
, sizeof (EFI_IPv4_ADDRESS
));
645 CopyMem (&Private
->GatewayIp
, &Dhcp4Mode
.RouterAddress
, sizeof (EFI_IPv4_ADDRESS
));
647 CopyMem (&Mode
->StationIp
, &Private
->StationIp
, sizeof (EFI_IPv4_ADDRESS
));
648 CopyMem (&Mode
->SubnetMask
, &Private
->SubnetMask
, sizeof (EFI_IPv4_ADDRESS
));
651 // Check the selected offer to see whether BINL is required, if no or BINL is
652 // finished, set the various Mode members.
654 Status
= PxeBcCheckSelectedOffer (Private
);
655 if (!EFI_ERROR (Status
)) {
660 if (EFI_ERROR (Status
)) {
662 Dhcp4
->Configure (Dhcp4
, NULL
);
665 // Remove the previously configured option list and callback function
667 ZeroMem (&Dhcp4CfgData
, sizeof (EFI_DHCP4_CONFIG_DATA
));
668 Dhcp4
->Configure (Dhcp4
, &Dhcp4CfgData
);
670 Private
->AddressIsOk
= TRUE
;
672 if (!Mode
->UsingIpv6
) {
674 // If in IPv4 mode, configure the corresponding ARP with this new
675 // station IP address.
677 ZeroMem (&ArpConfigData
, sizeof (EFI_ARP_CONFIG_DATA
));
679 ArpConfigData
.SwAddressType
= 0x0800;
680 ArpConfigData
.SwAddressLength
= sizeof (EFI_IPv4_ADDRESS
);
681 ArpConfigData
.StationAddress
= &Private
->StationIp
.v4
;
683 Private
->Arp
->Configure (Private
->Arp
, NULL
);
684 Private
->Arp
->Configure (Private
->Arp
, &ArpConfigData
);
687 // Updated the route table. Fill the first entry.
689 Mode
->RouteTableEntries
= 1;
690 Mode
->RouteTable
[0].IpAddr
.Addr
[0] = Private
->StationIp
.Addr
[0] & Private
->SubnetMask
.Addr
[0];
691 Mode
->RouteTable
[0].SubnetMask
.Addr
[0] = Private
->SubnetMask
.Addr
[0];
692 Mode
->RouteTable
[0].GwAddr
.Addr
[0] = 0;
695 // Create the default route entry if there is a default router.
697 if (Private
->GatewayIp
.Addr
[0] != 0) {
698 Mode
->RouteTableEntries
= 2;
699 Mode
->RouteTable
[1].IpAddr
.Addr
[0] = 0;
700 Mode
->RouteTable
[1].SubnetMask
.Addr
[0] = 0;
701 Mode
->RouteTable
[1].GwAddr
.Addr
[0] = Private
->GatewayIp
.Addr
[0];
705 // Flush new station IP address into Udp4CfgData and Ip4ConfigData
707 CopyMem (&Private
->Udp4CfgData
.StationAddress
, &Private
->StationIp
, sizeof (EFI_IPv4_ADDRESS
));
708 CopyMem (&Private
->Udp4CfgData
.SubnetMask
, &Private
->SubnetMask
, sizeof (EFI_IPv4_ADDRESS
));
709 CopyMem (&Private
->Ip4ConfigData
.StationAddress
, &Private
->StationIp
, sizeof (EFI_IPv4_ADDRESS
));
710 CopyMem (&Private
->Ip4ConfigData
.SubnetMask
, &Private
->SubnetMask
, sizeof (EFI_IPv4_ADDRESS
));
713 // Reconfigure the Ip4 instance to capture background ICMP packets with new station Ip address.
715 Private
->Ip4
->Cancel (Private
->Ip4
, &Private
->IcmpErrorRcvToken
);
716 Private
->Ip4
->Configure (Private
->Ip4
, NULL
);
718 Status
= Private
->Ip4
->Configure (Private
->Ip4
, &Private
->Ip4ConfigData
);
719 if (EFI_ERROR (Status
)) {
723 Status
= Private
->Ip4
->Receive (Private
->Ip4
, &Private
->IcmpErrorRcvToken
);
724 if (EFI_ERROR (Status
)) {
731 // Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP
732 // receive filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.
734 ZeroMem(&IpFilter
, sizeof (EFI_PXE_BASE_CODE_IP_FILTER
));
735 IpFilter
.Filters
= EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP
;
736 This
->SetIpFilter (This
, &IpFilter
);
743 Attempts to complete the PXE Boot Server and/or boot image discovery sequence.
745 This function attempts to complete the PXE Boot Server and/or boot image discovery
746 sequence. If this sequence is completed, then EFI_SUCCESS is returned, and the
747 PxeDiscoverValid, PxeDiscover, PxeReplyReceived, and PxeReply fields of the
748 EFI_PXE_BASE_CODE_MODE structure are filled in. If UseBis is TRUE, then the
749 PxeBisReplyReceived and PxeBisReply fields of the EFI_PXE_BASE_CODE_MODE structure
750 will also be filled in. If UseBis is FALSE, then PxeBisReplyValid will be set to FALSE.
751 In the structure referenced by parameter Info, the PXE Boot Server list, SrvList[],
752 has two uses: It is the Boot Server IP address list used for unicast discovery
753 (if the UseUCast field is TRUE), and it is the list used for Boot Server verification
754 (if the MustUseList field is TRUE). Also, if the MustUseList field in that structure
755 is TRUE and the AcceptAnyResponse field in the SrvList[] array is TRUE, any Boot
756 Server reply of that type will be accepted. If the AcceptAnyResponse field is
757 FALSE, only responses from Boot Servers with matching IP addresses will be accepted.
758 This function can take at least 10 seconds to timeout and return control to the
759 caller. If the Discovery sequence does not complete, then EFI_TIMEOUT will be
760 returned. Please see the Preboot Execution Environment (PXE) Specification for
761 additional details on the implementation of the Discovery sequence.
762 If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,
763 then the Discovery sequence is stopped and EFI_ABORTED will be returned.
765 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
766 @param Type The type of bootstrap to perform.
767 @param Layer Pointer to the boot server layer number to discover, which must be
768 PXE_BOOT_LAYER_INITIAL when a new server type is being
770 @param UseBis TRUE if Boot Integrity Services are to be used. FALSE otherwise.
771 @param Info Pointer to a data structure that contains additional information on the
772 type of discovery operation that is to be performed.
774 @retval EFI_SUCCESS The Discovery sequence has been completed.
775 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
776 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
777 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
778 @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory to complete Discovery.
779 @retval EFI_ABORTED The callback function aborted the Discovery sequence.
780 @retval EFI_TIMEOUT The Discovery sequence timed out.
781 @retval EFI_ICMP_ERROR An ICMP error packet was received during the PXE discovery
788 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
792 IN EFI_PXE_BASE_CODE_DISCOVER_INFO
*Info OPTIONAL
795 PXEBC_PRIVATE_DATA
*Private
;
796 EFI_PXE_BASE_CODE_MODE
*Mode
;
797 EFI_PXE_BASE_CODE_DISCOVER_INFO DefaultInfo
;
798 EFI_PXE_BASE_CODE_DISCOVER_INFO
*CreatedInfo
;
799 EFI_PXE_BASE_CODE_SRVLIST
*SrvList
;
800 EFI_PXE_BASE_CODE_SRVLIST DefaultSrvList
;
801 PXEBC_CACHED_DHCP4_PACKET
*Packet
;
802 PXEBC_VENDOR_OPTION
*VendorOpt
;
805 PXEBC_BOOT_SVR_ENTRY
*BootSvrEntry
;
806 EFI_PXE_BASE_CODE_IP_FILTER IpFilter
;
809 return EFI_INVALID_PARAMETER
;
812 Private
= PXEBC_PRIVATE_DATA_FROM_PXEBC (This
);
813 Mode
= Private
->PxeBc
.Mode
;
817 Status
= EFI_DEVICE_ERROR
;
818 Private
->Function
= EFI_PXE_BASE_CODE_FUNCTION_DISCOVER
;
820 if (!Private
->AddressIsOk
) {
821 return EFI_INVALID_PARAMETER
;
824 if (!Mode
->Started
) {
825 return EFI_NOT_STARTED
;
829 // Stop Udp4Read instance
831 Private
->Udp4Read
->Configure (Private
->Udp4Read
, NULL
);
833 Mode
->IcmpErrorReceived
= FALSE
;
836 // If layer isn't EFI_PXE_BASE_CODE_BOOT_LAYER_INITIAL,
837 // use the previous setting;
838 // If info isn't offered,
839 // use the cached DhcpAck and ProxyOffer packets.
841 if (*Layer
!= EFI_PXE_BASE_CODE_BOOT_LAYER_INITIAL
) {
843 if (!Mode
->PxeDiscoverValid
|| !Mode
->PxeReplyReceived
|| (!Mode
->PxeBisReplyReceived
&& UseBis
)) {
845 Status
= EFI_INVALID_PARAMETER
;
849 DefaultInfo
.IpCnt
= 1;
850 DefaultInfo
.UseUCast
= TRUE
;
852 DefaultSrvList
.Type
= Type
;
853 DefaultSrvList
.AcceptAnyResponse
= FALSE
;
854 DefaultSrvList
.IpAddr
.Addr
[0] = Private
->ServerIp
.Addr
[0];
856 SrvList
= &DefaultSrvList
;
858 } else if (Info
== NULL
) {
860 // Create info by the cached packet before
862 Packet
= (Mode
->ProxyOfferReceived
) ? &Private
->ProxyOffer
: &Private
->Dhcp4Ack
;
863 VendorOpt
= &Packet
->PxeVendorOption
;
865 if (!Mode
->DhcpAckReceived
|| !IS_VALID_DISCOVER_VENDOR_OPTION (VendorOpt
->BitMap
)) {
867 // Address is not acquired or no discovery options.
869 Status
= EFI_INVALID_PARAMETER
;
873 DefaultInfo
.UseMCast
= (BOOLEAN
)!IS_DISABLE_MCAST_DISCOVER (VendorOpt
->DiscoverCtrl
);
874 DefaultInfo
.UseBCast
= (BOOLEAN
)!IS_DISABLE_BCAST_DISCOVER (VendorOpt
->DiscoverCtrl
);
875 DefaultInfo
.MustUseList
= (BOOLEAN
) IS_ENABLE_USE_SERVER_LIST (VendorOpt
->DiscoverCtrl
);
876 DefaultInfo
.UseUCast
= DefaultInfo
.MustUseList
;
878 if (DefaultInfo
.UseMCast
) {
880 // Get the multicast discover ip address from vendor option.
883 &DefaultInfo
.ServerMCastIp
.Addr
,
884 &VendorOpt
->DiscoverMcastIp
,
885 sizeof (EFI_IPv4_ADDRESS
)
889 DefaultInfo
.IpCnt
= 0;
891 SrvList
= Info
->SrvList
;
893 if (DefaultInfo
.MustUseList
) {
894 BootSvrEntry
= VendorOpt
->BootSvr
;
895 Status
= EFI_INVALID_PARAMETER
;
897 while (((UINT8
) (BootSvrEntry
- VendorOpt
->BootSvr
)) < VendorOpt
->BootSvrLen
) {
899 if (BootSvrEntry
->Type
== HTONS (Type
)) {
900 Status
= EFI_SUCCESS
;
904 BootSvrEntry
= GET_NEXT_BOOT_SVR_ENTRY (BootSvrEntry
);
907 if (EFI_ERROR (Status
)) {
911 DefaultInfo
.IpCnt
= BootSvrEntry
->IpCnt
;
913 if (DefaultInfo
.IpCnt
>= 1) {
914 CreatedInfo
= AllocatePool (sizeof (DefaultInfo
) + (DefaultInfo
.IpCnt
- 1) * sizeof (*SrvList
));
915 if (CreatedInfo
== NULL
) {
916 Status
= EFI_OUT_OF_RESOURCES
;
921 CopyMem (CreatedInfo
, &DefaultInfo
, sizeof (DefaultInfo
));
923 SrvList
= Info
->SrvList
;
926 for (Index
= 0; Index
< DefaultInfo
.IpCnt
; Index
++) {
927 CopyMem (&SrvList
[Index
].IpAddr
, &BootSvrEntry
->IpAddr
[Index
], sizeof (EFI_IPv4_ADDRESS
));
928 SrvList
[Index
].AcceptAnyResponse
= FALSE
;
929 SrvList
[Index
].Type
= BootSvrEntry
->Type
;
935 SrvList
= Info
->SrvList
;
937 if (!SrvList
[0].AcceptAnyResponse
) {
939 for (Index
= 1; Index
< Info
->IpCnt
; Index
++) {
940 if (SrvList
[Index
].AcceptAnyResponse
) {
945 if (Index
!= Info
->IpCnt
) {
946 Status
= EFI_INVALID_PARAMETER
;
952 if ((!Info
->UseUCast
&& !Info
->UseBCast
&& !Info
->UseMCast
) || (Info
->MustUseList
&& Info
->IpCnt
== 0)) {
954 Status
= EFI_INVALID_PARAMETER
;
958 // Execute discover by UniCast/BroadCast/MultiCast
960 if (Info
->UseUCast
) {
962 for (Index
= 0; Index
< Info
->IpCnt
; Index
++) {
964 if (BootSvrEntry
== NULL
) {
965 Private
->ServerIp
.Addr
[0] = SrvList
[Index
].IpAddr
.Addr
[0];
969 &BootSvrEntry
->IpAddr
[Index
],
970 sizeof (EFI_IPv4_ADDRESS
)
974 Status
= PxeBcDiscvBootService (
979 &SrvList
[Index
].IpAddr
,
983 &Private
->PxeReply
.Packet
.Ack
985 if (!EFI_ERROR (Status
)) {
990 } else if (Info
->UseMCast
) {
992 Status
= PxeBcDiscvBootService (
997 &Info
->ServerMCastIp
,
1001 &Private
->PxeReply
.Packet
.Ack
1004 } else if (Info
->UseBCast
) {
1006 Status
= PxeBcDiscvBootService (
1015 &Private
->PxeReply
.Packet
.Ack
1019 if (EFI_ERROR (Status
) || !Mode
->PxeReplyReceived
|| (!Mode
->PxeBisReplyReceived
&& UseBis
)) {
1020 if (Status
== EFI_ICMP_ERROR
) {
1021 Mode
->IcmpErrorReceived
= TRUE
;
1023 Status
= EFI_DEVICE_ERROR
;
1026 PxeBcParseCachedDhcpPacket (&Private
->PxeReply
);
1029 if (Mode
->PxeBisReplyReceived
) {
1032 &Mode
->PxeReply
.Dhcpv4
.BootpSiAddr
,
1033 sizeof (EFI_IPv4_ADDRESS
)
1037 if (CreatedInfo
!= NULL
) {
1038 FreePool (CreatedInfo
);
1044 // Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP
1045 // receive filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.
1047 ZeroMem(&IpFilter
, sizeof (EFI_PXE_BASE_CODE_IP_FILTER
));
1048 IpFilter
.Filters
= EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP
;
1049 This
->SetIpFilter (This
, &IpFilter
);
1056 Used to perform TFTP and MTFTP services.
1058 This function is used to perform TFTP and MTFTP services. This includes the
1059 TFTP operations to get the size of a file, read a directory, read a file, and
1060 write a file. It also includes the MTFTP operations to get the size of a file,
1061 read a directory, and read a file. The type of operation is specified by Operation.
1062 If the callback function that is invoked during the TFTP/MTFTP operation does
1063 not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED will
1065 For read operations, the return data will be placed in the buffer specified by
1066 BufferPtr. If BufferSize is too small to contain the entire downloaded file,
1067 then EFI_BUFFER_TOO_SMALL will be returned and BufferSize will be set to zero
1068 or the size of the requested file (the size of the requested file is only returned
1069 if the TFTP server supports TFTP options). If BufferSize is large enough for the
1070 read operation, then BufferSize will be set to the size of the downloaded file,
1071 and EFI_SUCCESS will be returned. Applications using the PxeBc.Mtftp() services
1072 should use the get-file-size operations to determine the size of the downloaded
1073 file prior to using the read-file operations-especially when downloading large
1074 (greater than 64 MB) files-instead of making two calls to the read-file operation.
1075 Following this recommendation will save time if the file is larger than expected
1076 and the TFTP server does not support TFTP option extensions. Without TFTP option
1077 extension support, the client has to download the entire file, counting and discarding
1078 the received packets, to determine the file size.
1079 For write operations, the data to be sent is in the buffer specified by BufferPtr.
1080 BufferSize specifies the number of bytes to send. If the write operation completes
1081 successfully, then EFI_SUCCESS will be returned.
1082 For TFTP "get file size" operations, the size of the requested file or directory
1083 is returned in BufferSize, and EFI_SUCCESS will be returned. If the TFTP server
1084 does not support options, the file will be downloaded into a bit bucket and the
1085 length of the downloaded file will be returned. For MTFTP "get file size" operations,
1086 if the MTFTP server does not support the "get file size" option, EFI_UNSUPPORTED
1088 This function can take up to 10 seconds to timeout and return control to the caller.
1089 If the TFTP sequence does not complete, EFI_TIMEOUT will be returned.
1090 If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,
1091 then the TFTP sequence is stopped and EFI_ABORTED will be returned.
1092 The format of the data returned from a TFTP read directory operation is a null-terminated
1093 filename followed by a null-terminated information string, of the form
1094 "size year-month-day hour:minute:second" (i.e. %d %d-%d-%d %d:%d:%f - note that
1095 the seconds field can be a decimal number), where the date and time are UTC. For
1096 an MTFTP read directory command, there is additionally a null-terminated multicast
1097 IP address preceding the filename of the form %d.%d.%d.%d for IP v4. The final
1098 entry is itself null-terminated, so that the final information string is terminated
1099 with two null octets.
1101 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
1102 @param Operation The type of operation to perform.
1103 @param BufferPtr A pointer to the data buffer.
1104 @param Overwrite Only used on write file operations. TRUE if a file on a remote server can
1106 @param BufferSize For get-file-size operations, *BufferSize returns the size of the
1108 @param BlockSize The requested block size to be used during a TFTP transfer.
1109 @param ServerIp The TFTP / MTFTP server IP address.
1110 @param Filename A Null-terminated ASCII string that specifies a directory name or a file
1112 @param Info Pointer to the MTFTP information.
1113 @param DontUseBuffer Set to FALSE for normal TFTP and MTFTP read file operation.
1115 @retval EFI_SUCCESS The TFTP/MTFTP operation was completed.
1116 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
1117 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1118 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
1119 @retval EFI_BUFFER_TOO_SMALL The buffer is not large enough to complete the read operation.
1120 @retval EFI_ABORTED The callback function aborted the TFTP/MTFTP operation.
1121 @retval EFI_TIMEOUT The TFTP/MTFTP operation timed out.
1122 @retval EFI_ICMP_ERROR An ICMP error packet was received during the MTFTP session.
1123 @retval EFI_TFTP_ERROR A TFTP error packet was received during the MTFTP session.
1129 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
1130 IN EFI_PXE_BASE_CODE_TFTP_OPCODE Operation
,
1131 IN OUT VOID
*BufferPtr
,
1132 IN BOOLEAN Overwrite
,
1133 IN OUT UINT64
*BufferSize
,
1134 IN UINTN
*BlockSize OPTIONAL
,
1135 IN EFI_IP_ADDRESS
*ServerIp
,
1137 IN EFI_PXE_BASE_CODE_MTFTP_INFO
*Info OPTIONAL
,
1138 IN BOOLEAN DontUseBuffer
1141 PXEBC_PRIVATE_DATA
*Private
;
1142 EFI_MTFTP4_CONFIG_DATA Mtftp4Config
;
1144 EFI_PXE_BASE_CODE_MODE
*Mode
;
1145 EFI_MAC_ADDRESS TempMacAddr
;
1146 EFI_PXE_BASE_CODE_IP_FILTER IpFilter
;
1148 if ((This
== NULL
) ||
1149 (Filename
== NULL
) ||
1150 (BufferSize
== NULL
) ||
1151 ((ServerIp
== NULL
) || !NetIp4IsUnicast (NTOHL (ServerIp
->Addr
[0]), 0)) ||
1152 ((BufferPtr
== NULL
) && DontUseBuffer
) ||
1153 ((BlockSize
!= NULL
) && (*BlockSize
< 512))) {
1155 return EFI_INVALID_PARAMETER
;
1158 Status
= EFI_DEVICE_ERROR
;
1159 Private
= PXEBC_PRIVATE_DATA_FROM_PXEBC (This
);
1160 Mode
= &Private
->Mode
;
1162 if (!Mode
->AutoArp
) {
1164 // If AutoArp is set false, check arp cache
1166 UpdateArpCache (This
);
1167 if (!FindInArpCache (Mode
, &ServerIp
->v4
, &TempMacAddr
)) {
1168 return EFI_DEVICE_ERROR
;
1173 // Stop Udp4Read instance
1175 Private
->Udp4Read
->Configure (Private
->Udp4Read
, NULL
);
1177 Mode
->TftpErrorReceived
= FALSE
;
1178 Mode
->IcmpErrorReceived
= FALSE
;
1180 Mtftp4Config
.UseDefaultSetting
= FALSE
;
1181 Mtftp4Config
.TimeoutValue
= PXEBC_MTFTP_TIMEOUT
;
1182 Mtftp4Config
.TryCount
= PXEBC_MTFTP_RETRIES
;
1185 &Mtftp4Config
.StationIp
,
1186 &Private
->StationIp
,
1187 sizeof (EFI_IPv4_ADDRESS
)
1190 &Mtftp4Config
.SubnetMask
,
1191 &Private
->SubnetMask
,
1192 sizeof (EFI_IPv4_ADDRESS
)
1195 &Mtftp4Config
.GatewayIp
,
1196 &Private
->GatewayIp
,
1197 sizeof (EFI_IPv4_ADDRESS
)
1200 &Mtftp4Config
.ServerIp
,
1202 sizeof (EFI_IPv4_ADDRESS
)
1205 switch (Operation
) {
1207 case EFI_PXE_BASE_CODE_TFTP_GET_FILE_SIZE
:
1209 Status
= PxeBcTftpGetFileSize (
1219 case EFI_PXE_BASE_CODE_TFTP_READ_FILE
:
1221 Status
= PxeBcTftpReadFile (
1233 case EFI_PXE_BASE_CODE_TFTP_WRITE_FILE
:
1235 Status
= PxeBcTftpWriteFile (
1247 case EFI_PXE_BASE_CODE_TFTP_READ_DIRECTORY
:
1249 Status
= PxeBcTftpReadDirectory (
1261 case EFI_PXE_BASE_CODE_MTFTP_GET_FILE_SIZE
:
1262 case EFI_PXE_BASE_CODE_MTFTP_READ_FILE
:
1263 case EFI_PXE_BASE_CODE_MTFTP_READ_DIRECTORY
:
1264 Status
= EFI_UNSUPPORTED
;
1269 Status
= EFI_INVALID_PARAMETER
;
1273 if (Status
== EFI_ICMP_ERROR
) {
1274 Mode
->IcmpErrorReceived
= TRUE
;
1278 // Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP
1279 // receive filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.
1281 ZeroMem(&IpFilter
, sizeof (EFI_PXE_BASE_CODE_IP_FILTER
));
1282 IpFilter
.Filters
= EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP
;
1283 This
->SetIpFilter (This
, &IpFilter
);
1290 Writes a UDP packet to the network interface.
1292 This function writes a UDP packet specified by the (optional HeaderPtr and)
1293 BufferPtr parameters to the network interface. The UDP header is automatically
1294 built by this routine. It uses the parameters OpFlags, DestIp, DestPort, GatewayIp,
1295 SrcIp, and SrcPort to build this header. If the packet is successfully built and
1296 transmitted through the network interface, then EFI_SUCCESS will be returned.
1297 If a timeout occurs during the transmission of the packet, then EFI_TIMEOUT will
1298 be returned. If an ICMP error occurs during the transmission of the packet, then
1299 the IcmpErrorReceived field is set to TRUE, the IcmpError field is filled in and
1300 EFI_ICMP_ERROR will be returned. If the Callback Protocol does not return
1301 EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED will be returned.
1303 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
1304 @param OpFlags The UDP operation flags.
1305 @param DestIp The destination IP address.
1306 @param DestPort The destination UDP port number.
1307 @param GatewayIp The gateway IP address.
1308 @param SrcIp The source IP address.
1309 @param SrcPort The source UDP port number.
1310 @param HeaderSize An optional field which may be set to the length of a header at
1311 HeaderPtr to be prefixed to the data at BufferPtr.
1312 @param HeaderPtr If HeaderSize is not NULL, a pointer to a header to be prefixed to the
1314 @param BufferSize A pointer to the size of the data at BufferPtr.
1315 @param BufferPtr A pointer to the data to be written.
1317 @retval EFI_SUCCESS The UDP Write operation was completed.
1318 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
1319 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1320 @retval EFI_BAD_BUFFER_SIZE The buffer is too long to be transmitted.
1321 @retval EFI_ABORTED The callback function aborted the UDP Write operation.
1322 @retval EFI_TIMEOUT The UDP Write operation timed out.
1323 @retval EFI_ICMP_ERROR An ICMP error packet was received during the UDP write session.
1329 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
1331 IN EFI_IP_ADDRESS
*DestIp
,
1332 IN EFI_PXE_BASE_CODE_UDP_PORT
*DestPort
,
1333 IN EFI_IP_ADDRESS
*GatewayIp OPTIONAL
,
1334 IN EFI_IP_ADDRESS
*SrcIp OPTIONAL
,
1335 IN OUT EFI_PXE_BASE_CODE_UDP_PORT
*SrcPort OPTIONAL
,
1336 IN UINTN
*HeaderSize OPTIONAL
,
1337 IN VOID
*HeaderPtr OPTIONAL
,
1338 IN UINTN
*BufferSize
,
1342 PXEBC_PRIVATE_DATA
*Private
;
1343 EFI_UDP4_PROTOCOL
*Udp4
;
1344 EFI_UDP4_COMPLETION_TOKEN Token
;
1345 EFI_UDP4_TRANSMIT_DATA
*Udp4TxData
;
1348 EFI_UDP4_SESSION_DATA Udp4Session
;
1351 EFI_PXE_BASE_CODE_MODE
*Mode
;
1352 EFI_MAC_ADDRESS TempMacAddr
;
1356 if ((This
== NULL
) || (DestIp
== NULL
) || (DestPort
== NULL
)) {
1357 return EFI_INVALID_PARAMETER
;
1360 if ((GatewayIp
!= NULL
) && !NetIp4IsUnicast (NTOHL (GatewayIp
->Addr
[0]), 0)) {
1362 // Gateway is provided but it's not a unicast IP address.
1364 return EFI_INVALID_PARAMETER
;
1367 if ((HeaderSize
!= NULL
) && ((*HeaderSize
== 0) || (HeaderPtr
== NULL
))) {
1369 // The HeaderSize ptr isn't NULL and: 1. the value is zero; or 2. the HeaderPtr
1372 return EFI_INVALID_PARAMETER
;
1375 if ((BufferSize
== NULL
) || ((*BufferSize
!= 0) && (BufferPtr
== NULL
))) {
1376 return EFI_INVALID_PARAMETER
;
1379 Private
= PXEBC_PRIVATE_DATA_FROM_PXEBC (This
);
1380 Udp4
= Private
->Udp4Write
;
1381 Mode
= &Private
->Mode
;
1382 if (!Mode
->Started
) {
1383 return EFI_NOT_STARTED
;
1386 if (!Private
->AddressIsOk
&& (SrcIp
== NULL
)) {
1387 return EFI_INVALID_PARAMETER
;
1390 if (!Mode
->AutoArp
) {
1392 // If AutoArp is set false, check arp cache
1394 UpdateArpCache (This
);
1395 if (!FindInArpCache (Mode
, &DestIp
->v4
, &TempMacAddr
)) {
1396 return EFI_DEVICE_ERROR
;
1400 Mode
->IcmpErrorReceived
= FALSE
;
1402 if ((Private
->CurrentUdpSrcPort
== 0) ||
1403 ((SrcPort
!= NULL
) && (*SrcPort
!= Private
->CurrentUdpSrcPort
))) {
1405 // Port is changed, (re)configure the Udp4Write instance
1407 if (SrcPort
!= NULL
) {
1408 Private
->CurrentUdpSrcPort
= *SrcPort
;
1411 Status
= PxeBcConfigureUdpWriteInstance (
1413 &Private
->StationIp
.v4
,
1414 &Private
->SubnetMask
.v4
,
1415 &Private
->GatewayIp
.v4
,
1416 &Private
->CurrentUdpSrcPort
1418 if (EFI_ERROR (Status
)) {
1419 Private
->CurrentUdpSrcPort
= 0;
1420 return EFI_INVALID_PARAMETER
;
1424 ZeroMem (&Token
, sizeof (EFI_UDP4_COMPLETION_TOKEN
));
1425 ZeroMem (&Udp4Session
, sizeof (EFI_UDP4_SESSION_DATA
));
1427 CopyMem (&Udp4Session
.DestinationAddress
, DestIp
, sizeof (EFI_IPv4_ADDRESS
));
1428 Udp4Session
.DestinationPort
= *DestPort
;
1429 if (SrcIp
!= NULL
) {
1430 CopyMem (&Udp4Session
.SourceAddress
, SrcIp
, sizeof (EFI_IPv4_ADDRESS
));
1432 if (SrcPort
!= NULL
) {
1433 Udp4Session
.SourcePort
= *SrcPort
;
1436 FragCount
= (HeaderSize
!= NULL
) ? 2 : 1;
1437 Udp4TxData
= (EFI_UDP4_TRANSMIT_DATA
*) AllocateZeroPool (sizeof (EFI_UDP4_TRANSMIT_DATA
) + (FragCount
- 1) * sizeof (EFI_UDP4_FRAGMENT_DATA
));
1438 if (Udp4TxData
== NULL
) {
1439 return EFI_OUT_OF_RESOURCES
;
1442 Udp4TxData
->FragmentCount
= FragCount
;
1443 Udp4TxData
->FragmentTable
[FragCount
- 1].FragmentLength
= (UINT32
) *BufferSize
;
1444 Udp4TxData
->FragmentTable
[FragCount
- 1].FragmentBuffer
= BufferPtr
;
1445 DataLength
= (UINT32
) *BufferSize
;
1447 if (FragCount
== 2) {
1449 Udp4TxData
->FragmentTable
[0].FragmentLength
= (UINT32
) *HeaderSize
;
1450 Udp4TxData
->FragmentTable
[0].FragmentBuffer
= HeaderPtr
;
1451 DataLength
+= (UINT32
) *HeaderSize
;
1454 if (GatewayIp
!= NULL
) {
1455 Udp4TxData
->GatewayAddress
= (EFI_IPv4_ADDRESS
*) GatewayIp
;
1457 Udp4TxData
->UdpSessionData
= &Udp4Session
;
1458 Udp4TxData
->DataLength
= DataLength
;
1459 Token
.Packet
.TxData
= Udp4TxData
;
1461 Status
= gBS
->CreateEvent (
1468 if (EFI_ERROR (Status
)) {
1472 Status
= Udp4
->Transmit (Udp4
, &Token
);
1473 if (EFI_ERROR (Status
)) {
1474 if (Status
== EFI_ICMP_ERROR
) {
1475 Mode
->IcmpErrorReceived
= TRUE
;
1485 Status
= Token
.Status
;
1489 if (Token
.Event
!= NULL
) {
1490 gBS
->CloseEvent (Token
.Event
);
1493 FreePool (Udp4TxData
);
1499 Decide whether the incoming UDP packet is acceptable per IP filter settings
1500 in provided PxeBcMode.
1502 @param PxeBcMode Pointer to EFI_PXE_BASE_CODE_MODE.
1503 @param Session Received UDP session.
1505 @retval TRUE The UDP package matches IP filters.
1506 @retval FALSE The UDP package doesn't matches IP filters.
1511 IN EFI_PXE_BASE_CODE_MODE
*PxeBcMode
,
1512 IN EFI_UDP4_SESSION_DATA
*Session
1516 EFI_IPv4_ADDRESS Ip4Address
;
1517 EFI_IPv4_ADDRESS DestIp4Address
;
1519 if ((PxeBcMode
->IpFilter
.Filters
& EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS
) != 0) {
1523 CopyMem (&DestIp4Address
, &Session
->DestinationAddress
, sizeof (DestIp4Address
));
1524 if (((PxeBcMode
->IpFilter
.Filters
& EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS_MULTICAST
) != 0) &&
1525 IP4_IS_MULTICAST (EFI_NTOHL (DestIp4Address
))
1530 if (((PxeBcMode
->IpFilter
.Filters
& EFI_PXE_BASE_CODE_IP_FILTER_BROADCAST
) != 0) &&
1531 IP4_IS_LOCAL_BROADCAST (EFI_NTOHL (DestIp4Address
))
1536 CopyMem (&Ip4Address
, &PxeBcMode
->StationIp
.v4
, sizeof (Ip4Address
));
1537 if (((PxeBcMode
->IpFilter
.Filters
& EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP
) != 0) &&
1538 EFI_IP4_EQUAL (&Ip4Address
, &DestIp4Address
)
1543 ASSERT (PxeBcMode
->IpFilter
.IpCnt
< EFI_PXE_BASE_CODE_MAX_IPCNT
);
1545 for (Index
= 0; Index
< PxeBcMode
->IpFilter
.IpCnt
; Index
++) {
1548 &PxeBcMode
->IpFilter
.IpList
[Index
].v4
,
1551 if (EFI_IP4_EQUAL (&Ip4Address
, &DestIp4Address
)) {
1560 Reads a UDP packet from the network interface.
1562 This function reads a UDP packet from a network interface. The data contents
1563 are returned in (the optional HeaderPtr and) BufferPtr, and the size of the
1564 buffer received is returned in BufferSize . If the input BufferSize is smaller
1565 than the UDP packet received (less optional HeaderSize), it will be set to the
1566 required size, and EFI_BUFFER_TOO_SMALL will be returned. In this case, the
1567 contents of BufferPtr are undefined, and the packet is lost. If a UDP packet is
1568 successfully received, then EFI_SUCCESS will be returned, and the information
1569 from the UDP header will be returned in DestIp, DestPort, SrcIp, and SrcPort if
1570 they are not NULL. Depending on the values of OpFlags and the DestIp, DestPort,
1571 SrcIp, and SrcPort input values, different types of UDP packet receive filtering
1572 will be performed. The following tables summarize these receive filter operations.
1574 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
1575 @param OpFlags The UDP operation flags.
1576 @param DestIp The destination IP address.
1577 @param DestPort The destination UDP port number.
1578 @param SrcIp The source IP address.
1579 @param SrcPort The source UDP port number.
1580 @param HeaderSize An optional field which may be set to the length of a header at
1581 HeaderPtr to be prefixed to the data at BufferPtr.
1582 @param HeaderPtr If HeaderSize is not NULL, a pointer to a header to be prefixed to the
1584 @param BufferSize A pointer to the size of the data at BufferPtr.
1585 @param BufferPtr A pointer to the data to be read.
1587 @retval EFI_SUCCESS The UDP Read operation was completed.
1588 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
1589 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1590 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
1591 @retval EFI_BUFFER_TOO_SMALL The packet is larger than Buffer can hold.
1592 @retval EFI_ABORTED The callback function aborted the UDP Read operation.
1593 @retval EFI_TIMEOUT The UDP Read operation timed out.
1599 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
1601 IN OUT EFI_IP_ADDRESS
*DestIp OPTIONAL
,
1602 IN OUT EFI_PXE_BASE_CODE_UDP_PORT
*DestPort OPTIONAL
,
1603 IN OUT EFI_IP_ADDRESS
*SrcIp OPTIONAL
,
1604 IN OUT EFI_PXE_BASE_CODE_UDP_PORT
*SrcPort OPTIONAL
,
1605 IN UINTN
*HeaderSize OPTIONAL
,
1606 IN VOID
*HeaderPtr OPTIONAL
,
1607 IN OUT UINTN
*BufferSize
,
1611 PXEBC_PRIVATE_DATA
*Private
;
1612 EFI_PXE_BASE_CODE_MODE
*Mode
;
1613 EFI_UDP4_PROTOCOL
*Udp4
;
1614 EFI_UDP4_COMPLETION_TOKEN Token
;
1615 EFI_UDP4_RECEIVE_DATA
*RxData
;
1616 EFI_UDP4_SESSION_DATA
*Session
;
1622 if (This
== NULL
|| DestIp
== NULL
|| DestPort
== NULL
) {
1623 return EFI_INVALID_PARAMETER
;
1626 if (((OpFlags
& EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_PORT
) == 0 && (DestPort
== NULL
)) ||
1627 ((OpFlags
& EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_PORT
) == 0 && (SrcIp
== NULL
)) ||
1628 ((OpFlags
& EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT
) == 0 && (SrcPort
== NULL
))) {
1629 return EFI_INVALID_PARAMETER
;
1632 if (((HeaderSize
!= NULL
) && (*HeaderSize
== 0)) || ((HeaderSize
!= NULL
) && (HeaderPtr
== NULL
))) {
1633 return EFI_INVALID_PARAMETER
;
1636 if ((BufferSize
== NULL
) || (BufferPtr
== NULL
)) {
1637 return EFI_INVALID_PARAMETER
;
1640 Private
= PXEBC_PRIVATE_DATA_FROM_PXEBC (This
);
1641 Mode
= Private
->PxeBc
.Mode
;
1642 Udp4
= Private
->Udp4Read
;
1644 if (!Mode
->Started
) {
1645 return EFI_NOT_STARTED
;
1648 Mode
->IcmpErrorReceived
= FALSE
;
1650 Status
= gBS
->CreateEvent (
1657 if (EFI_ERROR (Status
)) {
1658 return EFI_OUT_OF_RESOURCES
;
1664 Status
= Udp4
->Receive (Udp4
, &Token
);
1665 if (EFI_ERROR (Status
)) {
1666 if (Status
== EFI_ICMP_ERROR
) {
1667 Mode
->IcmpErrorReceived
= TRUE
;
1675 Status
= EFI_TIMEOUT
;
1679 // check whether this packet matches the filters
1681 if (EFI_ERROR (Token
.Status
)){
1685 RxData
= Token
.Packet
.RxData
;
1686 Session
= &RxData
->UdpSession
;
1690 if ((OpFlags
& EFI_PXE_BASE_CODE_UDP_OPFLAGS_USE_FILTER
) != 0) {
1693 // Check UDP package by IP filter settings
1695 if (CheckIpByFilter (Mode
, Session
)) {
1704 // Match the destination ip of the received udp dgram
1706 if ((OpFlags
& EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_IP
) != 0) {
1709 if (DestIp
!= NULL
) {
1710 CopyMem (DestIp
, &Session
->DestinationAddress
, sizeof (EFI_IPv4_ADDRESS
));
1713 if (DestIp
!= NULL
) {
1714 if (EFI_IP4_EQUAL (DestIp
, &Session
->DestinationAddress
)) {
1718 if (EFI_IP4_EQUAL (&Private
->StationIp
, &Session
->DestinationAddress
)) {
1727 // Match the destination port of the received udp dgram
1729 if ((OpFlags
& EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_PORT
) != 0) {
1731 if (DestPort
!= NULL
) {
1732 *DestPort
= Session
->DestinationPort
;
1736 if (*DestPort
!= Session
->DestinationPort
) {
1744 // Match the source ip of the received udp dgram
1746 if ((OpFlags
& EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_IP
) != 0) {
1748 if (SrcIp
!= NULL
) {
1749 CopyMem (SrcIp
, &Session
->SourceAddress
, sizeof (EFI_IPv4_ADDRESS
));
1753 if (!EFI_IP4_EQUAL (SrcIp
, &Session
->SourceAddress
)) {
1761 // Match the source port of the received udp dgram
1763 if ((OpFlags
& EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT
) != 0) {
1765 if (SrcPort
!= NULL
) {
1766 *SrcPort
= Session
->SourcePort
;
1770 if (*SrcPort
!= Session
->SourcePort
) {
1780 if (HeaderSize
!= NULL
) {
1781 CopyLen
= MIN (*HeaderSize
, RxData
->DataLength
);
1782 CopyMem (HeaderPtr
, RxData
->FragmentTable
[0].FragmentBuffer
, CopyLen
);
1783 *HeaderSize
= CopyLen
;
1786 if (RxData
->DataLength
- CopyLen
> *BufferSize
) {
1788 Status
= EFI_BUFFER_TOO_SMALL
;
1791 *BufferSize
= RxData
->DataLength
- CopyLen
;
1794 (UINT8
*) RxData
->FragmentTable
[0].FragmentBuffer
+ CopyLen
,
1800 Status
= EFI_TIMEOUT
;
1804 // Recycle the RxData
1806 gBS
->SignalEvent (RxData
->RecycleSignal
);
1815 Udp4
->Cancel (Udp4
, &Token
);
1817 gBS
->CloseEvent (Token
.Event
);
1823 Updates the IP receive filters of a network device and enables software filtering.
1825 The NewFilter field is used to modify the network device's current IP receive
1826 filter settings and to enable a software filter. This function updates the IpFilter
1827 field of the EFI_PXE_BASE_CODE_MODE structure with the contents of NewIpFilter.
1828 The software filter is used when the USE_FILTER in OpFlags is set to UdpRead().
1829 The current hardware filter remains in effect no matter what the settings of OpFlags
1830 are, so that the meaning of ANY_DEST_IP set in OpFlags to UdpRead() is from those
1831 packets whose reception is enabled in hardware-physical NIC address (unicast),
1832 broadcast address, logical address or addresses (multicast), or all (promiscuous).
1833 UdpRead() does not modify the IP filter settings.
1834 Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP receive
1835 filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.
1836 If an application or driver wishes to preserve the IP receive filter settings,
1837 it will have to preserve the IP receive filter settings before these calls, and
1838 use SetIpFilter() to restore them after the calls. If incompatible filtering is
1839 requested (for example, PROMISCUOUS with anything else) or if the device does not
1840 support a requested filter setting and it cannot be accommodated in software
1841 (for example, PROMISCUOUS not supported), EFI_INVALID_PARAMETER will be returned.
1842 The IPlist field is used to enable IPs other than the StationIP. They may be
1843 multicast or unicast. If IPcnt is set as well as EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP,
1844 then both the StationIP and the IPs from the IPlist will be used.
1846 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
1847 @param NewFilter Pointer to the new set of IP receive filters.
1849 @retval EFI_SUCCESS The IP receive filter settings were updated.
1850 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
1851 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1856 EfiPxeBcSetIpFilter (
1857 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
1858 IN EFI_PXE_BASE_CODE_IP_FILTER
*NewFilter
1862 PXEBC_PRIVATE_DATA
*Private
;
1863 EFI_PXE_BASE_CODE_MODE
*Mode
;
1865 BOOLEAN PromiscuousNeed
;
1868 DEBUG ((EFI_D_ERROR
, "This == NULL.\n"));
1869 return EFI_INVALID_PARAMETER
;
1872 Private
= PXEBC_PRIVATE_DATA_FROM_PXEBC (This
);
1873 Mode
= Private
->PxeBc
.Mode
;
1875 if (NewFilter
== NULL
) {
1876 DEBUG ((EFI_D_ERROR
, "NewFilter == NULL.\n"));
1877 return EFI_INVALID_PARAMETER
;
1880 if (NewFilter
->IpCnt
> EFI_PXE_BASE_CODE_MAX_IPCNT
) {
1881 DEBUG ((EFI_D_ERROR
, "NewFilter->IpCnt > %d.\n", EFI_PXE_BASE_CODE_MAX_IPCNT
));
1882 return EFI_INVALID_PARAMETER
;
1885 if (!Mode
->Started
) {
1886 DEBUG ((EFI_D_ERROR
, "BC was not started.\n"));
1887 return EFI_NOT_STARTED
;
1890 PromiscuousNeed
= FALSE
;
1892 for (Index
= 0; Index
< NewFilter
->IpCnt
; ++Index
) {
1893 if (IP4_IS_LOCAL_BROADCAST (EFI_IP4 (NewFilter
->IpList
[Index
].v4
))) {
1895 // The IP is a broadcast address.
1897 DEBUG ((EFI_D_ERROR
, "There is broadcast address in NewFilter.\n"));
1898 return EFI_INVALID_PARAMETER
;
1900 if (NetIp4IsUnicast (EFI_IP4 (NewFilter
->IpList
[Index
].v4
), 0) &&
1901 ((NewFilter
->Filters
& EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP
) != 0)
1904 // If EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP is set and IP4 address is in IpList,
1905 // promiscuous mode is needed.
1907 PromiscuousNeed
= TRUE
;
1912 // Clear the UDP instance configuration, all joined groups will be left
1913 // during the operation.
1915 Private
->Udp4Read
->Configure (Private
->Udp4Read
, NULL
);
1916 Private
->Udp4CfgData
.AcceptPromiscuous
= FALSE
;
1917 Private
->Udp4CfgData
.AcceptBroadcast
= FALSE
;
1919 if (PromiscuousNeed
||
1920 ((NewFilter
->Filters
& EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS
) != 0) ||
1921 ((NewFilter
->Filters
& EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS_MULTICAST
) != 0)
1924 // Configure the udp4 filter to receive all packages
1926 Private
->Udp4CfgData
.AcceptPromiscuous
= TRUE
;
1929 // Configure the UDP instance with the new configuration.
1931 Status
= Private
->Udp4Read
->Configure (Private
->Udp4Read
, &Private
->Udp4CfgData
);
1932 if (EFI_ERROR (Status
)) {
1938 if ((NewFilter
->Filters
& EFI_PXE_BASE_CODE_IP_FILTER_BROADCAST
) != 0) {
1940 // Configure the udp4 filter to receive all broadcast packages
1942 Private
->Udp4CfgData
.AcceptBroadcast
= TRUE
;
1946 // Configure the UDP instance with the new configuration.
1948 Status
= Private
->Udp4Read
->Configure (Private
->Udp4Read
, &Private
->Udp4CfgData
);
1949 if (EFI_ERROR (Status
)) {
1953 if ((NewFilter
->Filters
& EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP
) != 0) {
1955 for (Index
= 0; Index
< NewFilter
->IpCnt
; ++Index
) {
1956 if (IP4_IS_MULTICAST (EFI_NTOHL (NewFilter
->IpList
[Index
].v4
))) {
1958 // Join the mutilcast group
1960 Status
= Private
->Udp4Read
->Groups (Private
->Udp4Read
, TRUE
, &NewFilter
->IpList
[Index
].v4
);
1961 if (EFI_ERROR (Status
)) {
1971 // Save the new filter.
1973 CopyMem (&Mode
->IpFilter
, NewFilter
, sizeof (Mode
->IpFilter
));
1980 Uses the ARP protocol to resolve a MAC address.
1982 This function uses the ARP protocol to resolve a MAC address. The UsingIpv6 field
1983 of the EFI_PXE_BASE_CODE_MODE structure is used to determine if IPv4 or IPv6
1984 addresses are being used. The IP address specified by IpAddr is used to resolve
1985 a MAC address. If the ARP protocol succeeds in resolving the specified address,
1986 then the ArpCacheEntries and ArpCache fields of the EFI_PXE_BASE_CODE_MODE structure
1987 are updated, and EFI_SUCCESS is returned. If MacAddr is not NULL, the resolved
1988 MAC address is placed there as well. If the PXE Base Code protocol is in the
1989 stopped state, then EFI_NOT_STARTED is returned. If the ARP protocol encounters
1990 a timeout condition while attempting to resolve an address, then EFI_TIMEOUT is
1991 returned. If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,
1992 then EFI_ABORTED is returned.
1994 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
1995 @param IpAddr Pointer to the IP address that is used to resolve a MAC address.
1996 @param MacAddr If not NULL, a pointer to the MAC address that was resolved with the
1999 @retval EFI_SUCCESS The IP or MAC address was resolved.
2000 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
2001 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
2002 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
2003 @retval EFI_ICMP_ERROR Something error occur with the ICMP packet message.
2009 IN EFI_PXE_BASE_CODE_PROTOCOL
* This
,
2010 IN EFI_IP_ADDRESS
* IpAddr
,
2011 IN EFI_MAC_ADDRESS
* MacAddr OPTIONAL
2014 PXEBC_PRIVATE_DATA
*Private
;
2015 EFI_PXE_BASE_CODE_MODE
*Mode
;
2017 EFI_MAC_ADDRESS TempMacAddr
;
2019 if (This
== NULL
|| IpAddr
== NULL
) {
2020 return EFI_INVALID_PARAMETER
;
2023 Private
= PXEBC_PRIVATE_DATA_FROM_PXEBC (This
);
2024 Mode
= Private
->PxeBc
.Mode
;
2026 if (!Mode
->Started
) {
2027 return EFI_NOT_STARTED
;
2030 if (!Private
->AddressIsOk
|| Mode
->UsingIpv6
) {
2032 // We can't resolve the IP address if we don't have a local address now.
2033 // Don't have ARP for IPv6.
2035 return EFI_INVALID_PARAMETER
;
2038 Mode
->IcmpErrorReceived
= FALSE
;
2040 if (!Mode
->AutoArp
) {
2042 // If AutoArp is set false, check arp cache
2044 UpdateArpCache (This
);
2045 if (!FindInArpCache (Mode
, &IpAddr
->v4
, &TempMacAddr
)) {
2046 return EFI_DEVICE_ERROR
;
2049 Status
= Private
->Arp
->Request (Private
->Arp
, &IpAddr
->v4
, NULL
, &TempMacAddr
);
2050 if (EFI_ERROR (Status
)) {
2051 if (Status
== EFI_ICMP_ERROR
) {
2052 Mode
->IcmpErrorReceived
= TRUE
;
2058 if (MacAddr
!= NULL
) {
2059 CopyMem (MacAddr
, &TempMacAddr
, sizeof (EFI_MAC_ADDRESS
));
2066 Updates the parameters that affect the operation of the PXE Base Code Protocol.
2068 This function sets parameters that affect the operation of the PXE Base Code Protocol.
2069 The parameter specified by NewAutoArp is used to control the generation of ARP
2070 protocol packets. If NewAutoArp is TRUE, then ARP Protocol packets will be generated
2071 as required by the PXE Base Code Protocol. If NewAutoArp is FALSE, then no ARP
2072 Protocol packets will be generated. In this case, the only mappings that are
2073 available are those stored in the ArpCache of the EFI_PXE_BASE_CODE_MODE structure.
2074 If there are not enough mappings in the ArpCache to perform a PXE Base Code Protocol
2075 service, then the service will fail. This function updates the AutoArp field of
2076 the EFI_PXE_BASE_CODE_MODE structure to NewAutoArp.
2077 The SetParameters() call must be invoked after a Callback Protocol is installed
2078 to enable the use of callbacks.
2080 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
2081 @param NewAutoArp If not NULL, a pointer to a value that specifies whether to replace the
2082 current value of AutoARP.
2083 @param NewSendGUID If not NULL, a pointer to a value that specifies whether to replace the
2084 current value of SendGUID.
2085 @param NewTTL If not NULL, a pointer to be used in place of the current value of TTL,
2086 the "time to live" field of the IP header.
2087 @param NewToS If not NULL, a pointer to be used in place of the current value of ToS,
2088 the "type of service" field of the IP header.
2089 @param NewMakeCallback If not NULL, a pointer to a value that specifies whether to replace the
2090 current value of the MakeCallback field of the Mode structure.
2092 @retval EFI_SUCCESS The new parameters values were updated.
2093 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
2094 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
2099 EfiPxeBcSetParameters (
2100 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
2101 IN BOOLEAN
*NewAutoArp OPTIONAL
,
2102 IN BOOLEAN
*NewSendGUID OPTIONAL
,
2103 IN UINT8
*NewTTL OPTIONAL
,
2104 IN UINT8
*NewToS OPTIONAL
,
2105 IN BOOLEAN
*NewMakeCallback
// OPTIONAL
2108 PXEBC_PRIVATE_DATA
*Private
;
2109 EFI_PXE_BASE_CODE_MODE
*Mode
;
2112 Status
= EFI_SUCCESS
;
2115 Status
= EFI_INVALID_PARAMETER
;
2119 Private
= PXEBC_PRIVATE_DATA_FROM_PXEBC (This
);
2120 Mode
= Private
->PxeBc
.Mode
;
2122 if (NewSendGUID
!= NULL
&& *NewSendGUID
) {
2124 // FixMe, cann't locate SendGuid
2128 if (NewMakeCallback
!= NULL
&& *NewMakeCallback
) {
2130 Status
= gBS
->HandleProtocol (
2131 Private
->Controller
,
2132 &gEfiPxeBaseCodeCallbackProtocolGuid
,
2133 (VOID
**) &Private
->PxeBcCallback
2135 if (EFI_ERROR (Status
) || (Private
->PxeBcCallback
->Callback
== NULL
)) {
2137 Status
= EFI_INVALID_PARAMETER
;
2142 if (!Mode
->Started
) {
2143 Status
= EFI_NOT_STARTED
;
2147 if (NewMakeCallback
!= NULL
) {
2149 if (*NewMakeCallback
) {
2151 // Update the Callback protocol.
2153 Status
= gBS
->HandleProtocol (
2154 Private
->Controller
,
2155 &gEfiPxeBaseCodeCallbackProtocolGuid
,
2156 (VOID
**) &Private
->PxeBcCallback
2159 if (EFI_ERROR (Status
) || (Private
->PxeBcCallback
->Callback
== NULL
)) {
2160 Status
= EFI_INVALID_PARAMETER
;
2164 Private
->PxeBcCallback
= NULL
;
2167 Mode
->MakeCallbacks
= *NewMakeCallback
;
2170 if (NewAutoArp
!= NULL
) {
2171 Mode
->AutoArp
= *NewAutoArp
;
2174 if (NewSendGUID
!= NULL
) {
2175 Mode
->SendGUID
= *NewSendGUID
;
2178 if (NewTTL
!= NULL
) {
2179 Mode
->TTL
= *NewTTL
;
2182 if (NewToS
!= NULL
) {
2183 Mode
->ToS
= *NewToS
;
2191 Updates the station IP address and/or subnet mask values of a network device.
2193 This function updates the station IP address and/or subnet mask values of a network
2194 device. The NewStationIp field is used to modify the network device's current IP address.
2195 If NewStationIP is NULL, then the current IP address will not be modified. Otherwise,
2196 this function updates the StationIp field of the EFI_PXE_BASE_CODE_MODE structure
2197 with NewStationIp. The NewSubnetMask field is used to modify the network device's current subnet
2198 mask. If NewSubnetMask is NULL, then the current subnet mask will not be modified.
2199 Otherwise, this function updates the SubnetMask field of the EFI_PXE_BASE_CODE_MODE
2200 structure with NewSubnetMask.
2202 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
2203 @param NewStationIp Pointer to the new IP address to be used by the network device.
2204 @param NewSubnetMask Pointer to the new subnet mask to be used by the network device.
2206 @retval EFI_SUCCESS The new station IP address and/or subnet mask were updated.
2207 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
2208 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
2213 EfiPxeBcSetStationIP (
2214 IN EFI_PXE_BASE_CODE_PROTOCOL
* This
,
2215 IN EFI_IP_ADDRESS
* NewStationIp OPTIONAL
,
2216 IN EFI_IP_ADDRESS
* NewSubnetMask OPTIONAL
2219 PXEBC_PRIVATE_DATA
*Private
;
2220 EFI_PXE_BASE_CODE_MODE
*Mode
;
2221 EFI_ARP_CONFIG_DATA ArpConfigData
;
2224 return EFI_INVALID_PARAMETER
;
2227 if (NewStationIp
!= NULL
&& !NetIp4IsUnicast (NTOHL (NewStationIp
->Addr
[0]), 0)) {
2228 return EFI_INVALID_PARAMETER
;
2231 if (NewSubnetMask
!= NULL
&& !IP4_IS_VALID_NETMASK (NTOHL (NewSubnetMask
->Addr
[0]))) {
2232 return EFI_INVALID_PARAMETER
;
2235 Private
= PXEBC_PRIVATE_DATA_FROM_PXEBC (This
);
2236 Mode
= Private
->PxeBc
.Mode
;
2238 if (!Mode
->Started
) {
2239 return EFI_NOT_STARTED
;
2242 if (NewStationIp
!= NULL
) {
2243 CopyMem (&Mode
->StationIp
, NewStationIp
, sizeof (EFI_IP_ADDRESS
));
2244 CopyMem (&Private
->StationIp
, NewStationIp
, sizeof (EFI_IP_ADDRESS
));
2247 if (NewSubnetMask
!= NULL
) {
2248 CopyMem (&Mode
->SubnetMask
, NewSubnetMask
, sizeof (EFI_IP_ADDRESS
));
2249 CopyMem (&Private
->SubnetMask
,NewSubnetMask
, sizeof (EFI_IP_ADDRESS
));
2252 Private
->AddressIsOk
= TRUE
;
2254 if (!Mode
->UsingIpv6
) {
2256 // If in IPv4 mode, configure the corresponding ARP with this new
2257 // station IP address.
2259 ZeroMem (&ArpConfigData
, sizeof (EFI_ARP_CONFIG_DATA
));
2261 ArpConfigData
.SwAddressType
= 0x0800;
2262 ArpConfigData
.SwAddressLength
= sizeof (EFI_IPv4_ADDRESS
);
2263 ArpConfigData
.StationAddress
= &Private
->StationIp
.v4
;
2265 Private
->Arp
->Configure (Private
->Arp
, NULL
);
2266 Private
->Arp
->Configure (Private
->Arp
, &ArpConfigData
);
2269 // Update the route table.
2271 Mode
->RouteTableEntries
= 1;
2272 Mode
->RouteTable
[0].IpAddr
.Addr
[0] = Private
->StationIp
.Addr
[0] & Private
->SubnetMask
.Addr
[0];
2273 Mode
->RouteTable
[0].SubnetMask
.Addr
[0] = Private
->SubnetMask
.Addr
[0];
2274 Mode
->RouteTable
[0].GwAddr
.Addr
[0] = 0;
2281 Updates the contents of the cached DHCP and Discover packets.
2283 The pointers to the new packets are used to update the contents of the cached
2284 packets in the EFI_PXE_BASE_CODE_MODE structure.
2286 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
2287 @param NewDhcpDiscoverValid Pointer to a value that will replace the current
2288 DhcpDiscoverValid field.
2289 @param NewDhcpAckReceived Pointer to a value that will replace the current
2290 DhcpAckReceived field.
2291 @param NewProxyOfferReceived Pointer to a value that will replace the current
2292 ProxyOfferReceived field.
2293 @param NewPxeDiscoverValid Pointer to a value that will replace the current
2294 ProxyOfferReceived field.
2295 @param NewPxeReplyReceived Pointer to a value that will replace the current
2296 PxeReplyReceived field.
2297 @param NewPxeBisReplyReceived Pointer to a value that will replace the current
2298 PxeBisReplyReceived field.
2299 @param NewDhcpDiscover Pointer to the new cached DHCP Discover packet contents.
2300 @param NewDhcpAck Pointer to the new cached DHCP Ack packet contents.
2301 @param NewProxyOffer Pointer to the new cached Proxy Offer packet contents.
2302 @param NewPxeDiscover Pointer to the new cached PXE Discover packet contents.
2303 @param NewPxeReply Pointer to the new cached PXE Reply packet contents.
2304 @param NewPxeBisReply Pointer to the new cached PXE BIS Reply packet contents.
2306 @retval EFI_SUCCESS The cached packet contents were updated.
2307 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
2308 @retval EFI_INVALID_PARAMETER This is NULL or not point to a valid EFI_PXE_BASE_CODE_PROTOCOL structure.
2313 EfiPxeBcSetPackets (
2314 IN EFI_PXE_BASE_CODE_PROTOCOL
* This
,
2315 IN BOOLEAN
* NewDhcpDiscoverValid OPTIONAL
,
2316 IN BOOLEAN
* NewDhcpAckReceived OPTIONAL
,
2317 IN BOOLEAN
* NewProxyOfferReceived OPTIONAL
,
2318 IN BOOLEAN
* NewPxeDiscoverValid OPTIONAL
,
2319 IN BOOLEAN
* NewPxeReplyReceived OPTIONAL
,
2320 IN BOOLEAN
* NewPxeBisReplyReceived OPTIONAL
,
2321 IN EFI_PXE_BASE_CODE_PACKET
* NewDhcpDiscover OPTIONAL
,
2322 IN EFI_PXE_BASE_CODE_PACKET
* NewDhcpAck OPTIONAL
,
2323 IN EFI_PXE_BASE_CODE_PACKET
* NewProxyOffer OPTIONAL
,
2324 IN EFI_PXE_BASE_CODE_PACKET
* NewPxeDiscover OPTIONAL
,
2325 IN EFI_PXE_BASE_CODE_PACKET
* NewPxeReply OPTIONAL
,
2326 IN EFI_PXE_BASE_CODE_PACKET
* NewPxeBisReply OPTIONAL
2329 PXEBC_PRIVATE_DATA
*Private
;
2330 EFI_PXE_BASE_CODE_MODE
*Mode
;
2333 return EFI_INVALID_PARAMETER
;
2336 Private
= PXEBC_PRIVATE_DATA_FROM_PXEBC (This
);
2337 Mode
= Private
->PxeBc
.Mode
;
2339 if (!Mode
->Started
) {
2340 return EFI_NOT_STARTED
;
2343 if (NewDhcpDiscoverValid
!= NULL
) {
2344 Mode
->DhcpDiscoverValid
= *NewDhcpDiscoverValid
;
2347 if (NewDhcpAckReceived
!= NULL
) {
2348 Mode
->DhcpAckReceived
= *NewDhcpAckReceived
;
2351 if (NewProxyOfferReceived
!= NULL
) {
2352 Mode
->ProxyOfferReceived
= *NewProxyOfferReceived
;
2355 if (NewPxeDiscoverValid
!= NULL
) {
2356 Mode
->PxeDiscoverValid
= *NewPxeDiscoverValid
;
2359 if (NewPxeReplyReceived
!= NULL
) {
2360 Mode
->PxeReplyReceived
= *NewPxeReplyReceived
;
2363 if (NewPxeBisReplyReceived
!= NULL
) {
2364 Mode
->PxeBisReplyReceived
= *NewPxeBisReplyReceived
;
2367 if (NewDhcpDiscover
!= NULL
) {
2368 CopyMem (&Mode
->DhcpDiscover
, NewDhcpDiscover
, sizeof (EFI_PXE_BASE_CODE_PACKET
));
2371 if (NewDhcpAck
!= NULL
) {
2372 CopyMem (&Mode
->DhcpAck
, NewDhcpAck
, sizeof (EFI_PXE_BASE_CODE_PACKET
));
2375 if (NewProxyOffer
!= NULL
) {
2376 CopyMem (&Mode
->ProxyOffer
, NewProxyOffer
, sizeof (EFI_PXE_BASE_CODE_PACKET
));
2379 if (NewPxeDiscover
!= NULL
) {
2380 CopyMem (&Mode
->PxeDiscover
, NewPxeDiscover
, sizeof (EFI_PXE_BASE_CODE_PACKET
));
2383 if (NewPxeReply
!= NULL
) {
2384 CopyMem (&Mode
->PxeReply
, NewPxeReply
, sizeof (EFI_PXE_BASE_CODE_PACKET
));
2387 if (NewPxeBisReply
!= NULL
) {
2388 CopyMem (&Mode
->PxeBisReply
, NewPxeBisReply
, sizeof (EFI_PXE_BASE_CODE_PACKET
));
2394 EFI_PXE_BASE_CODE_PROTOCOL mPxeBcProtocolTemplate
= {
2395 EFI_PXE_BASE_CODE_PROTOCOL_REVISION
,
2403 EfiPxeBcSetIpFilter
,
2405 EfiPxeBcSetParameters
,
2406 EfiPxeBcSetStationIP
,
2412 Callback function that is invoked when the PXE Base Code Protocol is about to transmit, has
2413 received, or is waiting to receive a packet.
2415 This function is invoked when the PXE Base Code Protocol is about to transmit, has received,
2416 or is waiting to receive a packet. Parameters Function and Received specify the type of event.
2417 Parameters PacketLen and Packet specify the packet that generated the event. If these fields
2418 are zero and NULL respectively, then this is a status update callback. If the operation specified
2419 by Function is to continue, then CALLBACK_STATUS_CONTINUE should be returned. If the operation
2420 specified by Function should be aborted, then CALLBACK_STATUS_ABORT should be returned. Due to
2421 the polling nature of UEFI device drivers, a callback function should not execute for more than 5 ms.
2422 The SetParameters() function must be called after a Callback Protocol is installed to enable the
2425 @param This Pointer to the EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL instance.
2426 @param Function The PXE Base Code Protocol function that is waiting for an event.
2427 @param Received TRUE if the callback is being invoked due to a receive event. FALSE if
2428 the callback is being invoked due to a transmit event.
2429 @param PacketLength The length, in bytes, of Packet. This field will have a value of zero if
2430 this is a wait for receive event.
2431 @param PacketPtr If Received is TRUE, a pointer to the packet that was just received;
2432 otherwise a pointer to the packet that is about to be transmitted.
2434 @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE if Function specifies a continue operation
2435 @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT if Function specifies an abort operation
2438 EFI_PXE_BASE_CODE_CALLBACK_STATUS
2440 EfiPxeLoadFileCallback (
2441 IN EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL
* This
,
2442 IN EFI_PXE_BASE_CODE_FUNCTION Function
,
2443 IN BOOLEAN Received
,
2444 IN UINT32 PacketLength
,
2445 IN EFI_PXE_BASE_CODE_PACKET
* PacketPtr OPTIONAL
2452 // Catch Ctrl-C or ESC to abort.
2454 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
2456 if (!EFI_ERROR (Status
)) {
2458 if (Key
.ScanCode
== SCAN_ESC
|| Key
.UnicodeChar
== (0x1F & 'c')) {
2460 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT
;
2464 // No print if receive packet
2467 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE
;
2470 // Print only for three functions
2474 case EFI_PXE_BASE_CODE_FUNCTION_MTFTP
:
2476 // Print only for open MTFTP packets, not every MTFTP packets
2478 if (PacketLength
!= 0 && PacketPtr
!= NULL
) {
2479 if (PacketPtr
->Raw
[0x1C] != 0x00 || PacketPtr
->Raw
[0x1D] != 0x01) {
2480 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE
;
2485 case EFI_PXE_BASE_CODE_FUNCTION_DHCP
:
2486 case EFI_PXE_BASE_CODE_FUNCTION_DISCOVER
:
2490 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE
;
2493 if (PacketLength
!= 0 && PacketPtr
!= NULL
) {
2495 // Print '.' when transmit a packet
2501 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE
;
2504 EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL mPxeBcCallBackTemplate
= {
2505 EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION
,
2506 EfiPxeLoadFileCallback
2513 @param Private Pointer to PxeBc private data.
2514 @param BufferSize Pointer to buffer size.
2515 @param Buffer Pointer to buffer.
2517 @retval EFI_SUCCESS Discover the boot file successfully.
2518 @retval EFI_TIMEOUT The TFTP/MTFTP operation timed out.
2519 @retval EFI_ABORTED PXE bootstrap server, so local boot need abort.
2520 @retval EFI_BUFFER_TOO_SMALL The buffer is too small to load the boot file.
2525 IN PXEBC_PRIVATE_DATA
*Private
,
2526 IN OUT UINT64
*BufferSize
,
2530 EFI_PXE_BASE_CODE_PROTOCOL
*PxeBc
;
2531 EFI_PXE_BASE_CODE_MODE
*Mode
;
2536 PXEBC_CACHED_DHCP4_PACKET
*Packet
;
2539 PxeBc
= &Private
->PxeBc
;
2541 Type
= EFI_PXE_BASE_CODE_BOOT_TYPE_BOOTSTRAP
;
2542 Layer
= EFI_PXE_BASE_CODE_BOOT_LAYER_INITIAL
;
2547 Status
= PxeBc
->Dhcp (PxeBc
, TRUE
);
2548 if (EFI_ERROR (Status
)) {
2553 // Select a boot server
2555 Status
= PxeBcSelectBootPrompt (Private
);
2557 if (Status
== EFI_SUCCESS
) {
2558 Status
= PxeBcSelectBootMenu (Private
, &Type
, TRUE
);
2559 } else if (Status
== EFI_TIMEOUT
) {
2560 Status
= PxeBcSelectBootMenu (Private
, &Type
, FALSE
);
2563 if (!EFI_ERROR (Status
)) {
2565 if (Type
== EFI_PXE_BASE_CODE_BOOT_TYPE_BOOTSTRAP
) {
2567 // Local boot(PXE bootstrap server) need abort
2572 UseBis
= (BOOLEAN
) (Mode
->BisSupported
&& Mode
->BisDetected
);
2573 Status
= PxeBc
->Discover (PxeBc
, Type
, &Layer
, UseBis
, NULL
);
2574 if (EFI_ERROR (Status
)) {
2582 // Get bootfile name and (m)tftp server ip addresss
2584 if (Mode
->PxeReplyReceived
) {
2585 Packet
= &Private
->PxeReply
;
2586 } else if (Mode
->ProxyOfferReceived
) {
2587 Packet
= &Private
->ProxyOffer
;
2589 Packet
= &Private
->Dhcp4Ack
;
2593 // Use siaddr(next server) in DHCPOFFER packet header, if zero, use option 54(server identifier)
2594 // in DHCPOFFER packet.
2595 // (It does not comply with PXE Spec, Ver2.1)
2597 if (EFI_IP4_EQUAL (&Packet
->Packet
.Offer
.Dhcp4
.Header
.ServerAddr
, &mZeroIp4Addr
)) {
2600 Packet
->Dhcp4Option
[PXEBC_DHCP4_TAG_INDEX_SERVER_ID
]->Data
,
2601 sizeof (EFI_IPv4_ADDRESS
)
2606 &Packet
->Packet
.Offer
.Dhcp4
.Header
.ServerAddr
,
2607 sizeof (EFI_IPv4_ADDRESS
)
2610 if (Private
->ServerIp
.Addr
[0] == 0) {
2611 return EFI_DEVICE_ERROR
;
2614 ASSERT (Packet
->Dhcp4Option
[PXEBC_DHCP4_TAG_INDEX_BOOTFILE
] != NULL
);
2619 Private
->BootFileName
= (CHAR8
*) (Packet
->Dhcp4Option
[PXEBC_DHCP4_TAG_INDEX_BOOTFILE
]->Data
);
2621 if (Packet
->Dhcp4Option
[PXEBC_DHCP4_TAG_INDEX_BOOTFILE_LEN
] != NULL
) {
2623 // Already have the bootfile length option, compute the file size
2625 CopyMem (&Value
, Packet
->Dhcp4Option
[PXEBC_DHCP4_TAG_INDEX_BOOTFILE_LEN
]->Data
, sizeof (Value
));
2626 Value
= NTOHS (Value
);
2627 *BufferSize
= 512 * Value
;
2628 Status
= EFI_BUFFER_TOO_SMALL
;
2631 // Get the bootfile size from tftp
2633 Status
= PxeBc
->Mtftp (
2635 EFI_PXE_BASE_CODE_TFTP_GET_FILE_SIZE
,
2639 &Private
->BlockSize
,
2641 (UINT8
*) Private
->BootFileName
,
2647 Private
->FileSize
= (UINTN
) *BufferSize
;
2653 Causes the driver to load a specified file.
2655 @param This Protocol instance pointer.
2656 @param FilePath The device specific path of the file to load.
2657 @param BootPolicy If TRUE, indicates that the request originates from the
2658 boot manager is attempting to load FilePath as a boot
2659 selection. If FALSE, then FilePath must match as exact file
2661 @param BufferSize On input the size of Buffer in bytes. On output with a return
2662 code of EFI_SUCCESS, the amount of data transferred to
2663 Buffer. On output with a return code of EFI_BUFFER_TOO_SMALL,
2664 the size of Buffer required to retrieve the requested file.
2665 @param Buffer The memory buffer to transfer the file to. IF Buffer is NULL,
2666 then no the size of the requested file is returned in
2669 @retval EFI_SUCCESS The file was loaded.
2670 @retval EFI_UNSUPPORTED The device does not support the provided BootPolicy
2671 @retval EFI_INVALID_PARAMETER FilePath is not a valid device path, or
2673 @retval EFI_NO_MEDIA No medium was present to load the file.
2674 @retval EFI_DEVICE_ERROR The file was not loaded due to a device error.
2675 @retval EFI_NO_RESPONSE The remote system did not respond.
2676 @retval EFI_NOT_FOUND The file was not found.
2677 @retval EFI_ABORTED The file load process was manually cancelled.
2683 IN EFI_LOAD_FILE_PROTOCOL
* This
,
2684 IN EFI_DEVICE_PATH_PROTOCOL
* FilePath
,
2685 IN BOOLEAN BootPolicy
,
2686 IN OUT UINTN
*BufferSize
,
2687 IN VOID
*Buffer OPTIONAL
2690 PXEBC_PRIVATE_DATA
*Private
;
2691 EFI_PXE_BASE_CODE_PROTOCOL
*PxeBc
;
2692 BOOLEAN NewMakeCallback
;
2695 BOOLEAN MediaPresent
;
2697 Private
= PXEBC_PRIVATE_DATA_FROM_LOADFILE (This
);
2698 PxeBc
= &Private
->PxeBc
;
2699 NewMakeCallback
= FALSE
;
2700 Status
= EFI_DEVICE_ERROR
;
2702 if (This
== NULL
|| BufferSize
== NULL
) {
2704 return EFI_INVALID_PARAMETER
;
2708 // Only support BootPolicy
2711 return EFI_UNSUPPORTED
;
2715 // Check media status before PXE start
2717 MediaPresent
= TRUE
;
2718 NetLibDetectMedia (Private
->Controller
, &MediaPresent
);
2719 if (!MediaPresent
) {
2720 return EFI_NO_MEDIA
;
2723 Status
= PxeBc
->Start (PxeBc
, FALSE
);
2724 if (EFI_ERROR (Status
) && (Status
!= EFI_ALREADY_STARTED
)) {
2728 Status
= gBS
->HandleProtocol (
2729 Private
->Controller
,
2730 &gEfiPxeBaseCodeCallbackProtocolGuid
,
2731 (VOID
**) &Private
->PxeBcCallback
2733 if (Status
== EFI_UNSUPPORTED
) {
2735 CopyMem (&Private
->LoadFileCallback
, &mPxeBcCallBackTemplate
, sizeof (Private
->LoadFileCallback
));
2737 Status
= gBS
->InstallProtocolInterface (
2738 &Private
->Controller
,
2739 &gEfiPxeBaseCodeCallbackProtocolGuid
,
2740 EFI_NATIVE_INTERFACE
,
2741 &Private
->LoadFileCallback
2744 NewMakeCallback
= (BOOLEAN
) (Status
== EFI_SUCCESS
);
2746 Status
= PxeBc
->SetParameters (PxeBc
, NULL
, NULL
, NULL
, NULL
, &NewMakeCallback
);
2747 if (EFI_ERROR (Status
)) {
2748 PxeBc
->Stop (PxeBc
);
2753 if (Private
->FileSize
== 0) {
2755 Status
= DiscoverBootFile (Private
, &TmpBufSize
, Buffer
);
2757 if (sizeof (UINTN
) < sizeof (UINT64
) && (TmpBufSize
> 0xFFFFFFFF)) {
2758 Status
= EFI_DEVICE_ERROR
;
2759 } else if (TmpBufSize
> 0 && *BufferSize
>= (UINTN
) TmpBufSize
&& Buffer
!= NULL
) {
2760 *BufferSize
= (UINTN
) TmpBufSize
;
2761 Status
= PxeBc
->Mtftp (
2763 EFI_PXE_BASE_CODE_TFTP_READ_FILE
,
2767 &Private
->BlockSize
,
2769 (UINT8
*) Private
->BootFileName
,
2773 } else if (TmpBufSize
> 0) {
2774 *BufferSize
= (UINTN
) TmpBufSize
;
2775 Status
= EFI_BUFFER_TOO_SMALL
;
2777 } else if (Buffer
== NULL
|| Private
->FileSize
> *BufferSize
) {
2778 *BufferSize
= Private
->FileSize
;
2779 Status
= EFI_BUFFER_TOO_SMALL
;
2782 // Download the file.
2784 TmpBufSize
= (UINT64
) (*BufferSize
);
2785 Status
= PxeBc
->Mtftp (
2787 EFI_PXE_BASE_CODE_TFTP_READ_FILE
,
2791 &Private
->BlockSize
,
2793 (UINT8
*) Private
->BootFileName
,
2799 // If we added a callback protocol, now is the time to remove it.
2801 if (NewMakeCallback
) {
2803 NewMakeCallback
= FALSE
;
2805 PxeBc
->SetParameters (PxeBc
, NULL
, NULL
, NULL
, NULL
, &NewMakeCallback
);
2807 gBS
->UninstallProtocolInterface (
2808 Private
->Controller
,
2809 &gEfiPxeBaseCodeCallbackProtocolGuid
,
2810 &Private
->LoadFileCallback
2815 // Check download status
2817 if (Status
== EFI_SUCCESS
) {
2819 // The functionality of PXE Base Code protocol will not be stopped,
2820 // when downloading is successfully.
2824 } else if (Status
== EFI_BUFFER_TOO_SMALL
) {
2825 if (Buffer
!= NULL
) {
2826 AsciiPrint ("PXE-E05: Download buffer is smaller than requested file.\n");
2829 // The functionality of PXE Base Code protocol will not be stopped.
2834 } else if (Status
== EFI_DEVICE_ERROR
) {
2835 AsciiPrint ("PXE-E07: Network device error.\n");
2837 } else if (Status
== EFI_OUT_OF_RESOURCES
) {
2838 AsciiPrint ("PXE-E09: Could not allocate I/O buffers.\n");
2840 } else if (Status
== EFI_NO_MEDIA
) {
2841 AsciiPrint ("PXE-E12: Could not detect network connection.\n");
2843 } else if (Status
== EFI_NO_RESPONSE
) {
2844 AsciiPrint ("PXE-E16: No offer received.\n");
2846 } else if (Status
== EFI_TIMEOUT
) {
2847 AsciiPrint ("PXE-E18: Server response timeout.\n");
2849 } else if (Status
== EFI_ABORTED
) {
2850 AsciiPrint ("PXE-E21: Remote boot cancelled.\n");
2852 } else if (Status
== EFI_ICMP_ERROR
) {
2853 AsciiPrint ("PXE-E22: Client received ICMP error from server.\n");
2855 } else if (Status
== EFI_TFTP_ERROR
) {
2856 AsciiPrint ("PXE-E23: Client received TFTP error from server.\n");
2859 AsciiPrint ("PXE-E99: Unexpected network error.\n");
2862 PxeBc
->Stop (PxeBc
);
2867 EFI_LOAD_FILE_PROTOCOL mLoadFileProtocolTemplate
= { EfiPxeLoadFile
};