2 Support functions implementation for UefiPxeBc Driver.
4 Copyright (c) 2007 - 2017, 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 Flush the previous configration using the new station Ip address.
22 @param[in] Private The pointer to the PxeBc private data.
23 @param[in] StationIp The pointer to the station Ip address.
24 @param[in] SubnetMask The pointer to the subnet mask address for v4.
26 @retval EFI_SUCCESS Successfully flushed the previous configuration.
27 @retval Others Failed to flush using the new station Ip.
32 PXEBC_PRIVATE_DATA
*Private
,
33 EFI_IP_ADDRESS
*StationIp
,
34 EFI_IP_ADDRESS
*SubnetMask OPTIONAL
37 EFI_PXE_BASE_CODE_MODE
*Mode
;
40 ASSERT (StationIp
!= NULL
);
42 Mode
= Private
->PxeBc
.Mode
;
45 if (Mode
->UsingIpv6
) {
47 CopyMem (&Private
->Udp6CfgData
.StationAddress
, StationIp
, sizeof (EFI_IPv6_ADDRESS
));
48 CopyMem (&Private
->Ip6CfgData
.StationAddress
, StationIp
, sizeof (EFI_IPv6_ADDRESS
));
51 // Reconfigure the Ip6 instance to capture background ICMP6 packets with new station Ip address.
53 Private
->Ip6
->Cancel (Private
->Ip6
, &Private
->Icmp6Token
);
54 Private
->Ip6
->Configure (Private
->Ip6
, NULL
);
56 Status
= Private
->Ip6
->Configure (Private
->Ip6
, &Private
->Ip6CfgData
);
57 if (EFI_ERROR (Status
)) {
61 Status
= Private
->Ip6
->Receive (Private
->Ip6
, &Private
->Icmp6Token
);
63 ASSERT (SubnetMask
!= NULL
);
64 CopyMem (&Private
->Udp4CfgData
.StationAddress
, StationIp
, sizeof (EFI_IPv4_ADDRESS
));
65 CopyMem (&Private
->Udp4CfgData
.SubnetMask
, SubnetMask
, sizeof (EFI_IPv4_ADDRESS
));
66 CopyMem (&Private
->Ip4CfgData
.StationAddress
, StationIp
, sizeof (EFI_IPv4_ADDRESS
));
67 CopyMem (&Private
->Ip4CfgData
.SubnetMask
, SubnetMask
, sizeof (EFI_IPv4_ADDRESS
));
70 // Reconfigure the Ip4 instance to capture background ICMP packets with new station Ip address.
72 Private
->Ip4
->Cancel (Private
->Ip4
, &Private
->IcmpToken
);
73 Private
->Ip4
->Configure (Private
->Ip4
, NULL
);
75 Status
= Private
->Ip4
->Configure (Private
->Ip4
, &Private
->Ip4CfgData
);
76 if (EFI_ERROR (Status
)) {
80 Status
= Private
->Ip4
->Receive (Private
->Ip4
, &Private
->IcmpToken
);
89 Notify the callback function when an event is triggered.
91 @param[in] Event The triggered event.
92 @param[in] Context The opaque parameter to the function.
102 *((BOOLEAN
*) Context
) = TRUE
;
107 Do arp resolution from arp cache in PxeBcMode.
109 @param Mode The pointer to EFI_PXE_BASE_CODE_MODE.
110 @param Ip4Addr The Ip4 address for resolution.
111 @param MacAddress The resoluted MAC address if the resolution is successful.
112 The value is undefined if the resolution fails.
114 @retval TRUE Found an matched entry.
115 @retval FALSE Did not find a matched entry.
120 IN EFI_PXE_BASE_CODE_MODE
*Mode
,
121 IN EFI_IPv4_ADDRESS
*Ip4Addr
,
122 OUT EFI_MAC_ADDRESS
*MacAddress
127 ASSERT (!Mode
->UsingIpv6
);
130 // Check whether the current Arp cache in mode data contains this information or not.
132 for (Index
= 0; Index
< Mode
->ArpCacheEntries
; Index
++) {
133 if (EFI_IP4_EQUAL (&Mode
->ArpCache
[Index
].IpAddr
.v4
, Ip4Addr
)) {
136 &Mode
->ArpCache
[Index
].MacAddr
,
137 sizeof (EFI_MAC_ADDRESS
)
148 Update the arp cache periodically.
150 @param Event The pointer to EFI_PXE_BC_PROTOCOL.
151 @param Context Context of the timer event.
156 PxeBcArpCacheUpdate (
161 PXEBC_PRIVATE_DATA
*Private
;
162 EFI_PXE_BASE_CODE_MODE
*Mode
;
163 EFI_ARP_FIND_DATA
*ArpEntry
;
169 Private
= (PXEBC_PRIVATE_DATA
*) Context
;
170 Mode
= Private
->PxeBc
.Mode
;
172 ASSERT (!Mode
->UsingIpv6
);
175 // Get the current Arp cache from Arp driver.
177 Status
= Private
->Arp
->Find (
186 if (EFI_ERROR (Status
)) {
191 // Update the Arp cache in mode data.
193 Mode
->ArpCacheEntries
= MIN (EntryCount
, EFI_PXE_BASE_CODE_MAX_ARP_ENTRIES
);
195 for (Index
= 0; Index
< Mode
->ArpCacheEntries
; Index
++) {
197 &Mode
->ArpCache
[Index
].IpAddr
,
199 ArpEntry
->SwAddressLength
202 &Mode
->ArpCache
[Index
].MacAddr
,
203 (UINT8
*) (ArpEntry
+ 1) + ArpEntry
->SwAddressLength
,
204 ArpEntry
->HwAddressLength
206 ArpEntry
= (EFI_ARP_FIND_DATA
*) ((UINT8
*) ArpEntry
+ EntryLength
);
212 Notify function to handle the received ICMP message in DPC.
214 @param Context The PXEBC private data.
219 PxeBcIcmpErrorDpcHandle (
224 EFI_IP4_RECEIVE_DATA
*RxData
;
225 EFI_IP4_PROTOCOL
*Ip4
;
226 PXEBC_PRIVATE_DATA
*Private
;
227 EFI_PXE_BASE_CODE_MODE
*Mode
;
233 Private
= (PXEBC_PRIVATE_DATA
*) Context
;
234 Mode
= &Private
->Mode
;
235 Status
= Private
->IcmpToken
.Status
;
236 RxData
= Private
->IcmpToken
.Packet
.RxData
;
239 ASSERT (!Mode
->UsingIpv6
);
241 if (Status
== EFI_ABORTED
) {
243 // It's triggered by user cancellation.
248 if (RxData
== NULL
) {
252 if (Status
!= EFI_ICMP_ERROR
) {
254 // The return status should be recognized as EFI_ICMP_ERROR.
256 gBS
->SignalEvent (RxData
->RecycleSignal
);
260 if (EFI_IP4 (RxData
->Header
->SourceAddress
) != 0 &&
261 (NTOHL (Mode
->SubnetMask
.Addr
[0]) != 0) &&
262 IP4_NET_EQUAL (NTOHL(Mode
->StationIp
.Addr
[0]), EFI_NTOHL (RxData
->Header
->SourceAddress
), NTOHL (Mode
->SubnetMask
.Addr
[0])) &&
263 !NetIp4IsUnicast (EFI_NTOHL (RxData
->Header
->SourceAddress
), NTOHL (Mode
->SubnetMask
.Addr
[0]))) {
265 // The source address of the received packet should be a valid unicast address.
267 gBS
->SignalEvent (RxData
->RecycleSignal
);
271 if (!EFI_IP4_EQUAL (&RxData
->Header
->DestinationAddress
, &Mode
->StationIp
.v4
)) {
273 // The destination address of the received packet should be equal to the host address.
275 gBS
->SignalEvent (RxData
->RecycleSignal
);
279 if (RxData
->Header
->Protocol
!= EFI_IP_PROTO_ICMP
) {
281 // The protocol value in the header of the receveid packet should be EFI_IP_PROTO_ICMP.
283 gBS
->SignalEvent (RxData
->RecycleSignal
);
287 Type
= *((UINT8
*) RxData
->FragmentTable
[0].FragmentBuffer
);
289 if (Type
!= ICMP_DEST_UNREACHABLE
&&
290 Type
!= ICMP_SOURCE_QUENCH
&&
291 Type
!= ICMP_REDIRECT
&&
292 Type
!= ICMP_TIME_EXCEEDED
&&
293 Type
!= ICMP_PARAMETER_PROBLEM
) {
295 // The type of the receveid ICMP message should be ICMP_ERROR_MESSAGE.
297 gBS
->SignalEvent (RxData
->RecycleSignal
);
302 // Copy the right ICMP error message into mode data.
305 IcmpError
= (UINT8
*) &Mode
->IcmpError
;
307 for (Index
= 0; Index
< RxData
->FragmentCount
; Index
++) {
308 CopiedLen
+= RxData
->FragmentTable
[Index
].FragmentLength
;
309 if (CopiedLen
<= sizeof (EFI_PXE_BASE_CODE_ICMP_ERROR
)) {
312 RxData
->FragmentTable
[Index
].FragmentBuffer
,
313 RxData
->FragmentTable
[Index
].FragmentLength
318 RxData
->FragmentTable
[Index
].FragmentBuffer
,
319 CopiedLen
- sizeof (EFI_PXE_BASE_CODE_ICMP_ERROR
)
322 IcmpError
+= CopiedLen
;
326 Private
->IcmpToken
.Status
= EFI_NOT_READY
;
327 Ip4
->Receive (Ip4
, &Private
->IcmpToken
);
332 Callback function to update the latest ICMP6 error message.
334 @param Event The event signalled.
335 @param Context The context passed in using the event notifier.
340 PxeBcIcmpErrorUpdate (
345 QueueDpc (TPL_CALLBACK
, PxeBcIcmpErrorDpcHandle
, Context
);
350 Notify function to handle the received ICMP6 message in DPC.
352 @param Context The PXEBC private data.
357 PxeBcIcmp6ErrorDpcHandle (
361 PXEBC_PRIVATE_DATA
*Private
;
362 EFI_IP6_RECEIVE_DATA
*RxData
;
363 EFI_IP6_PROTOCOL
*Ip6
;
364 EFI_PXE_BASE_CODE_MODE
*Mode
;
371 Private
= (PXEBC_PRIVATE_DATA
*) Context
;
372 Mode
= &Private
->Mode
;
373 Status
= Private
->Icmp6Token
.Status
;
374 RxData
= Private
->Icmp6Token
.Packet
.RxData
;
377 ASSERT (Mode
->UsingIpv6
);
379 if (Status
== EFI_ABORTED
) {
381 // It's triggered by user cancellation.
386 if (RxData
== NULL
) {
390 if (Status
!= EFI_ICMP_ERROR
) {
392 // The return status should be recognized as EFI_ICMP_ERROR.
394 gBS
->SignalEvent (RxData
->RecycleSignal
);
398 if (!NetIp6IsValidUnicast (&RxData
->Header
->SourceAddress
)) {
400 // The source address of the received packet should be a valid unicast address.
402 gBS
->SignalEvent (RxData
->RecycleSignal
);
406 if (!NetIp6IsUnspecifiedAddr (&Mode
->StationIp
.v6
) &&
407 !EFI_IP6_EQUAL (&RxData
->Header
->DestinationAddress
, &Mode
->StationIp
.v6
)) {
409 // The destination address of the received packet should be equal to the host address.
411 gBS
->SignalEvent (RxData
->RecycleSignal
);
415 if (RxData
->Header
->NextHeader
!= IP6_ICMP
) {
417 // The nextheader in the header of the receveid packet should be IP6_ICMP.
419 gBS
->SignalEvent (RxData
->RecycleSignal
);
423 Type
= *((UINT8
*) RxData
->FragmentTable
[0].FragmentBuffer
);
425 if (Type
!= ICMP_V6_DEST_UNREACHABLE
&&
426 Type
!= ICMP_V6_PACKET_TOO_BIG
&&
427 Type
!= ICMP_V6_TIME_EXCEEDED
&&
428 Type
!= ICMP_V6_PARAMETER_PROBLEM
) {
430 // The type of the receveid packet should be an ICMP6 error message.
432 gBS
->SignalEvent (RxData
->RecycleSignal
);
437 // Copy the right ICMP6 error message into mode data.
440 Icmp6Error
= (UINT8
*) &Mode
->IcmpError
;
442 for (Index
= 0; Index
< RxData
->FragmentCount
; Index
++) {
443 CopiedLen
+= RxData
->FragmentTable
[Index
].FragmentLength
;
444 if (CopiedLen
<= sizeof (EFI_PXE_BASE_CODE_ICMP_ERROR
)) {
447 RxData
->FragmentTable
[Index
].FragmentBuffer
,
448 RxData
->FragmentTable
[Index
].FragmentLength
453 RxData
->FragmentTable
[Index
].FragmentBuffer
,
454 CopiedLen
- sizeof (EFI_PXE_BASE_CODE_ICMP_ERROR
)
457 Icmp6Error
+= CopiedLen
;
461 Private
->Icmp6Token
.Status
= EFI_NOT_READY
;
462 Ip6
->Receive (Ip6
, &Private
->Icmp6Token
);
467 Callback function to update the latest ICMP6 error message.
469 @param Event The event signalled.
470 @param Context The context passed in using the event notifier.
475 PxeBcIcmp6ErrorUpdate (
480 QueueDpc (TPL_CALLBACK
, PxeBcIcmp6ErrorDpcHandle
, Context
);
485 This function is to configure a UDPv4 instance for UdpWrite.
487 @param[in] Udp4 The pointer to EFI_UDP4_PROTOCOL.
488 @param[in] StationIp The pointer to the station address.
489 @param[in] SubnetMask The pointer to the subnet mask.
490 @param[in] Gateway The pointer to the gateway address.
491 @param[in, out] SrcPort The pointer to the source port.
492 @param[in] DoNotFragment If TRUE, fragment is not enabled.
493 Otherwise, fragment is enabled.
494 @param[in] Ttl The time to live field of the IP header.
495 @param[in] ToS The type of service field of the IP header.
497 @retval EFI_SUCCESS Successfully configured this instance.
498 @retval Others Failed to configure this instance.
502 PxeBcConfigUdp4Write (
503 IN EFI_UDP4_PROTOCOL
*Udp4
,
504 IN EFI_IPv4_ADDRESS
*StationIp
,
505 IN EFI_IPv4_ADDRESS
*SubnetMask
,
506 IN EFI_IPv4_ADDRESS
*Gateway
,
507 IN OUT UINT16
*SrcPort
,
508 IN BOOLEAN DoNotFragment
,
513 EFI_UDP4_CONFIG_DATA Udp4CfgData
;
516 ZeroMem (&Udp4CfgData
, sizeof (Udp4CfgData
));
518 Udp4CfgData
.TransmitTimeout
= PXEBC_DEFAULT_LIFETIME
;
519 Udp4CfgData
.ReceiveTimeout
= PXEBC_DEFAULT_LIFETIME
;
520 Udp4CfgData
.TypeOfService
= ToS
;
521 Udp4CfgData
.TimeToLive
= Ttl
;
522 Udp4CfgData
.AllowDuplicatePort
= TRUE
;
523 Udp4CfgData
.DoNotFragment
= DoNotFragment
;
525 CopyMem (&Udp4CfgData
.StationAddress
, StationIp
, sizeof (*StationIp
));
526 CopyMem (&Udp4CfgData
.SubnetMask
, SubnetMask
, sizeof (*SubnetMask
));
528 Udp4CfgData
.StationPort
= *SrcPort
;
531 // Reset the UDPv4 instance.
533 Udp4
->Configure (Udp4
, NULL
);
535 Status
= Udp4
->Configure (Udp4
, &Udp4CfgData
);
536 if (!EFI_ERROR (Status
) && !EFI_IP4_EQUAL (Gateway
, &mZeroIp4Addr
)) {
538 // The basic configuration is OK, need to add the default route entry
540 Status
= Udp4
->Routes (Udp4
, FALSE
, &mZeroIp4Addr
, &mZeroIp4Addr
, Gateway
);
541 if (EFI_ERROR (Status
)) {
542 Udp4
->Configure (Udp4
, NULL
);
546 if (!EFI_ERROR (Status
) && *SrcPort
== 0) {
547 Udp4
->GetModeData (Udp4
, &Udp4CfgData
, NULL
, NULL
, NULL
);
548 *SrcPort
= Udp4CfgData
.StationPort
;
556 This function is to configure a UDPv6 instance for UdpWrite.
558 @param[in] Udp6 The pointer to EFI_UDP6_PROTOCOL.
559 @param[in] StationIp The pointer to the station address.
560 @param[in, out] SrcPort The pointer to the source port.
562 @retval EFI_SUCCESS Successfully configured this instance.
563 @retval Others Failed to configure this instance.
567 PxeBcConfigUdp6Write (
568 IN EFI_UDP6_PROTOCOL
*Udp6
,
569 IN EFI_IPv6_ADDRESS
*StationIp
,
570 IN OUT UINT16
*SrcPort
573 EFI_UDP6_CONFIG_DATA CfgData
;
576 ZeroMem (&CfgData
, sizeof (EFI_UDP6_CONFIG_DATA
));
578 CfgData
.ReceiveTimeout
= PXEBC_DEFAULT_LIFETIME
;
579 CfgData
.TransmitTimeout
= PXEBC_DEFAULT_LIFETIME
;
580 CfgData
.HopLimit
= PXEBC_DEFAULT_HOPLIMIT
;
581 CfgData
.AllowDuplicatePort
= TRUE
;
582 CfgData
.StationPort
= *SrcPort
;
584 CopyMem (&CfgData
.StationAddress
, StationIp
, sizeof (EFI_IPv6_ADDRESS
));
587 // Reset the UDPv6 instance.
589 Udp6
->Configure (Udp6
, NULL
);
591 Status
= Udp6
->Configure (Udp6
, &CfgData
);
592 if (EFI_ERROR (Status
)) {
596 if (!EFI_ERROR (Status
) && *SrcPort
== 0) {
597 Udp6
->GetModeData (Udp6
, &CfgData
, NULL
, NULL
, NULL
);
598 *SrcPort
= CfgData
.StationPort
;
606 This function is to configure a UDPv4 instance for UdpWrite.
608 @param[in] Udp4 The pointer to EFI_UDP4_PROTOCOL.
609 @param[in] Session The pointer to the UDP4 session data.
610 @param[in] TimeoutEvent The event for timeout.
611 @param[in] Gateway The pointer to the gateway address.
612 @param[in] HeaderSize An optional field which may be set to the length of a header
613 at HeaderPtr to be prefixed to the data at BufferPtr.
614 @param[in] HeaderPtr If HeaderSize is not NULL, a pointer to a header to be
615 prefixed to the data at BufferPtr.
616 @param[in] BufferSize A pointer to the size of the data at BufferPtr.
617 @param[in] BufferPtr A pointer to the data to be written.
619 @retval EFI_SUCCESS Successfully send out data using Udp4Write.
620 @retval Others Failed to send out data.
625 IN EFI_UDP4_PROTOCOL
*Udp4
,
626 IN EFI_UDP4_SESSION_DATA
*Session
,
627 IN EFI_EVENT TimeoutEvent
,
628 IN EFI_IPv4_ADDRESS
*Gateway OPTIONAL
,
629 IN UINTN
*HeaderSize OPTIONAL
,
630 IN VOID
*HeaderPtr OPTIONAL
,
631 IN UINTN
*BufferSize
,
635 EFI_UDP4_COMPLETION_TOKEN Token
;
636 EFI_UDP4_TRANSMIT_DATA
*TxData
;
644 // Arrange one fragment buffer for data, and another fragment buffer for header if has.
646 FragCount
= (HeaderSize
!= NULL
) ? 2 : 1;
647 TxLength
= sizeof (EFI_UDP4_TRANSMIT_DATA
) + (FragCount
- 1) * sizeof (EFI_UDP4_FRAGMENT_DATA
);
648 TxData
= (EFI_UDP4_TRANSMIT_DATA
*) AllocateZeroPool (TxLength
);
649 if (TxData
== NULL
) {
650 return EFI_OUT_OF_RESOURCES
;
653 TxData
->FragmentCount
= FragCount
;
654 TxData
->FragmentTable
[FragCount
- 1].FragmentLength
= (UINT32
) *BufferSize
;
655 TxData
->FragmentTable
[FragCount
- 1].FragmentBuffer
= BufferPtr
;
656 DataLength
= (UINT32
) *BufferSize
;
658 if (HeaderSize
!= NULL
) {
659 TxData
->FragmentTable
[0].FragmentLength
= (UINT32
) *HeaderSize
;
660 TxData
->FragmentTable
[0].FragmentBuffer
= HeaderPtr
;
661 DataLength
+= (UINT32
) *HeaderSize
;
664 if (Gateway
!= NULL
) {
665 TxData
->GatewayAddress
= Gateway
;
668 TxData
->UdpSessionData
= Session
;
669 TxData
->DataLength
= DataLength
;
670 Token
.Packet
.TxData
= TxData
;
671 Token
.Status
= EFI_NOT_READY
;
674 Status
= gBS
->CreateEvent (
681 if (EFI_ERROR (Status
)) {
685 Status
= Udp4
->Transmit (Udp4
, &Token
);
686 if (EFI_ERROR (Status
)) {
691 // Poll the UDPv6 read instance if no packet received and no timeout triggered.
694 Token
.Status
== EFI_NOT_READY
&&
695 EFI_ERROR (gBS
->CheckEvent (TimeoutEvent
))) {
699 Status
= (Token
.Status
== EFI_NOT_READY
) ? EFI_TIMEOUT
: Token
.Status
;
702 if (Token
.Event
!= NULL
) {
703 gBS
->CloseEvent (Token
.Event
);
712 This function is to configure a UDPv4 instance for UdpWrite.
714 @param[in] Udp6 The pointer to EFI_UDP6_PROTOCOL.
715 @param[in] Session The pointer to the UDP6 session data.
716 @param[in] TimeoutEvent The event for timeout.
717 @param[in] HeaderSize An optional field which may be set to the length of a header
718 at HeaderPtr to be prefixed to the data at BufferPtr.
719 @param[in] HeaderPtr If HeaderSize is not NULL, a pointer to a header to be
720 prefixed to the data at BufferPtr.
721 @param[in] BufferSize A pointer to the size of the data at BufferPtr.
722 @param[in] BufferPtr A pointer to the data to be written.
724 @retval EFI_SUCCESS Successfully sent out data using Udp6Write.
725 @retval Others Failed to send out data.
730 IN EFI_UDP6_PROTOCOL
*Udp6
,
731 IN EFI_UDP6_SESSION_DATA
*Session
,
732 IN EFI_EVENT TimeoutEvent
,
733 IN UINTN
*HeaderSize OPTIONAL
,
734 IN VOID
*HeaderPtr OPTIONAL
,
735 IN UINTN
*BufferSize
,
739 EFI_UDP6_COMPLETION_TOKEN Token
;
740 EFI_UDP6_TRANSMIT_DATA
*TxData
;
748 // Arrange one fragment buffer for data, and another fragment buffer for header if has.
750 FragCount
= (HeaderSize
!= NULL
) ? 2 : 1;
751 TxLength
= sizeof (EFI_UDP6_TRANSMIT_DATA
) + (FragCount
- 1) * sizeof (EFI_UDP6_FRAGMENT_DATA
);
752 TxData
= (EFI_UDP6_TRANSMIT_DATA
*) AllocateZeroPool (TxLength
);
753 if (TxData
== NULL
) {
754 return EFI_OUT_OF_RESOURCES
;
757 TxData
->FragmentCount
= FragCount
;
758 TxData
->FragmentTable
[FragCount
- 1].FragmentLength
= (UINT32
) *BufferSize
;
759 TxData
->FragmentTable
[FragCount
- 1].FragmentBuffer
= BufferPtr
;
760 DataLength
= (UINT32
) *BufferSize
;
762 if (HeaderSize
!= NULL
) {
763 TxData
->FragmentTable
[0].FragmentLength
= (UINT32
) *HeaderSize
;
764 TxData
->FragmentTable
[0].FragmentBuffer
= HeaderPtr
;
765 DataLength
+= (UINT32
) *HeaderSize
;
768 TxData
->UdpSessionData
= Session
;
769 TxData
->DataLength
= DataLength
;
770 Token
.Packet
.TxData
= TxData
;
771 Token
.Status
= EFI_NOT_READY
;
774 Status
= gBS
->CreateEvent (
781 if (EFI_ERROR (Status
)) {
785 Status
= Udp6
->Transmit (Udp6
, &Token
);
786 if (EFI_ERROR (Status
)) {
791 // Poll the UDPv6 read instance if no packet received and no timeout triggered.
794 Token
.Status
== EFI_NOT_READY
&&
795 EFI_ERROR (gBS
->CheckEvent (TimeoutEvent
))) {
799 Status
= (Token
.Status
== EFI_NOT_READY
) ? EFI_TIMEOUT
: Token
.Status
;
802 if (Token
.Event
!= NULL
) {
803 gBS
->CloseEvent (Token
.Event
);
812 Check the received packet using the Ip filter.
814 @param[in] Mode The pointer to the mode data of PxeBc.
815 @param[in] Session The pointer to the current UDPv4 session.
816 @param[in] OpFlags Operation flag for UdpRead/UdpWrite.
818 @retval TRUE Passed the Ip filter successfully.
819 @retval FALSE Failed to pass the Ip filter.
823 PxeBcCheckByIpFilter (
824 IN EFI_PXE_BASE_CODE_MODE
*Mode
,
829 EFI_IP_ADDRESS DestinationIp
;
832 if ((OpFlags
& EFI_PXE_BASE_CODE_UDP_OPFLAGS_USE_FILTER
) == 0) {
836 if ((Mode
->IpFilter
.Filters
& EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS
) != 0) {
841 // Convert the destination address in session data to host order.
843 if (Mode
->UsingIpv6
) {
846 &((EFI_UDP6_SESSION_DATA
*) Session
)->DestinationAddress
,
847 sizeof (EFI_IPv6_ADDRESS
)
849 NTOHLLL (&DestinationIp
.v6
);
851 ZeroMem (&DestinationIp
, sizeof (EFI_IP_ADDRESS
));
854 &((EFI_UDP4_SESSION_DATA
*) Session
)->DestinationAddress
,
855 sizeof (EFI_IPv4_ADDRESS
)
857 EFI_NTOHL (DestinationIp
);
860 if ((Mode
->IpFilter
.Filters
& EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS_MULTICAST
) != 0 &&
861 (IP4_IS_MULTICAST (DestinationIp
.Addr
[0]) ||
862 IP6_IS_MULTICAST (&DestinationIp
))) {
866 if ((Mode
->IpFilter
.Filters
& EFI_PXE_BASE_CODE_IP_FILTER_BROADCAST
) != 0 &&
867 IP4_IS_LOCAL_BROADCAST (DestinationIp
.Addr
[0])) {
868 ASSERT (!Mode
->UsingIpv6
);
872 if ((Mode
->IpFilter
.Filters
& EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP
) != 0 &&
873 (EFI_IP4_EQUAL (&Mode
->StationIp
.v4
, &DestinationIp
) ||
874 EFI_IP6_EQUAL (&Mode
->StationIp
.v6
, &DestinationIp
))) {
876 // Matched if the dest address is equal to the station address.
881 for (Index
= 0; Index
< Mode
->IpFilter
.IpCnt
; Index
++) {
882 ASSERT (Index
< EFI_PXE_BASE_CODE_MAX_IPCNT
);
883 if (EFI_IP4_EQUAL (&Mode
->IpFilter
.IpList
[Index
].v4
, &DestinationIp
) ||
884 EFI_IP6_EQUAL (&Mode
->IpFilter
.IpList
[Index
].v6
, &DestinationIp
)) {
886 // Matched if the dest address is equal to any of address in the filter list.
897 Filter the received packet using the destination Ip.
899 @param[in] Mode The pointer to the mode data of PxeBc.
900 @param[in] Session The pointer to the current UDPv4 session.
901 @param[in, out] DestIp The pointer to the destination Ip address.
902 @param[in] OpFlags Operation flag for UdpRead/UdpWrite.
904 @retval TRUE Passed the IPv4 filter successfully.
905 @retval FALSE Failed to pass the IPv4 filter.
910 IN EFI_PXE_BASE_CODE_MODE
*Mode
,
912 IN OUT EFI_IP_ADDRESS
*DestIp
,
916 if ((OpFlags
& EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_IP
) != 0) {
918 // Copy the destination address from the received packet if accept any.
920 if (DestIp
!= NULL
) {
921 if (Mode
->UsingIpv6
) {
924 &((EFI_UDP6_SESSION_DATA
*)Session
)->DestinationAddress
,
925 sizeof (EFI_IPv6_ADDRESS
)
928 ZeroMem (DestIp
, sizeof (EFI_IP_ADDRESS
));
931 &((EFI_UDP4_SESSION_DATA
*)Session
)->DestinationAddress
,
932 sizeof (EFI_IPv4_ADDRESS
)
938 } else if (DestIp
!= NULL
&&
939 (EFI_IP4_EQUAL (DestIp
, &((EFI_UDP4_SESSION_DATA
*)Session
)->DestinationAddress
) ||
940 EFI_IP6_EQUAL (DestIp
, &((EFI_UDP6_SESSION_DATA
*)Session
)->DestinationAddress
))) {
942 // The destination address in the received packet is matched if present.
945 } else if (EFI_IP4_EQUAL (&Mode
->StationIp
, &((EFI_UDP4_SESSION_DATA
*)Session
)->DestinationAddress
) ||
946 EFI_IP6_EQUAL (&Mode
->StationIp
, &((EFI_UDP6_SESSION_DATA
*)Session
)->DestinationAddress
)) {
948 // The destination address in the received packet is equal to the host address.
958 Check the received packet using the destination port.
960 @param[in] Mode The pointer to the mode data of PxeBc.
961 @param[in] Session The pointer to the current UDPv4 session.
962 @param[in, out] DestPort The pointer to the destination port.
963 @param[in] OpFlags Operation flag for UdpRead/UdpWrite.
965 @retval TRUE Passed the IPv4 filter successfully.
966 @retval FALSE Failed to pass the IPv4 filter.
970 PxeBcCheckByDestPort (
971 IN EFI_PXE_BASE_CODE_MODE
*Mode
,
973 IN OUT UINT16
*DestPort
,
979 if (Mode
->UsingIpv6
) {
980 Port
= ((EFI_UDP6_SESSION_DATA
*) Session
)->DestinationPort
;
982 Port
= ((EFI_UDP4_SESSION_DATA
*) Session
)->DestinationPort
;
985 if ((OpFlags
& EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_PORT
) != 0) {
987 // Return the destination port in the received packet if accept any.
989 if (DestPort
!= NULL
) {
993 } else if (DestPort
!= NULL
&& *DestPort
== Port
) {
995 // The destination port in the received packet is matched if present.
1005 Filter the received packet using the source Ip.
1007 @param[in] Mode The pointer to the mode data of PxeBc.
1008 @param[in] Session The pointer to the current UDPv4 session.
1009 @param[in, out] SrcIp The pointer to the source Ip address.
1010 @param[in] OpFlags Operation flag for UdpRead/UdpWrite.
1012 @retval TRUE Passed the IPv4 filter successfully.
1013 @retval FALSE Failed to pass the IPv4 filter.
1017 PxeBcFilterBySrcIp (
1018 IN EFI_PXE_BASE_CODE_MODE
*Mode
,
1020 IN OUT EFI_IP_ADDRESS
*SrcIp
,
1024 if ((OpFlags
& EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_IP
) != 0) {
1026 // Copy the source address from the received packet if accept any.
1028 if (SrcIp
!= NULL
) {
1029 if (Mode
->UsingIpv6
) {
1032 &((EFI_UDP6_SESSION_DATA
*)Session
)->SourceAddress
,
1033 sizeof (EFI_IPv6_ADDRESS
)
1036 ZeroMem (SrcIp
, sizeof (EFI_IP_ADDRESS
));
1039 &((EFI_UDP4_SESSION_DATA
*)Session
)->SourceAddress
,
1040 sizeof (EFI_IPv4_ADDRESS
)
1046 } else if (SrcIp
!= NULL
&&
1047 (EFI_IP4_EQUAL (SrcIp
, &((EFI_UDP4_SESSION_DATA
*)Session
)->SourceAddress
) ||
1048 EFI_IP6_EQUAL (SrcIp
, &((EFI_UDP6_SESSION_DATA
*)Session
)->SourceAddress
))) {
1050 // The source address in the received packet is matched if present.
1060 Filter the received packet using the source port.
1062 @param[in] Mode The pointer to the mode data of PxeBc.
1063 @param[in] Session The pointer to the current UDPv4 session.
1064 @param[in, out] SrcPort The pointer to the source port.
1065 @param[in] OpFlags Operation flag for UdpRead/UdpWrite.
1067 @retval TRUE Passed the IPv4 filter successfully.
1068 @retval FALSE Failed to pass the IPv4 filter.
1072 PxeBcFilterBySrcPort (
1073 IN EFI_PXE_BASE_CODE_MODE
*Mode
,
1075 IN OUT UINT16
*SrcPort
,
1081 if (Mode
->UsingIpv6
) {
1082 Port
= ((EFI_UDP6_SESSION_DATA
*) Session
)->SourcePort
;
1084 Port
= ((EFI_UDP4_SESSION_DATA
*) Session
)->SourcePort
;
1087 if ((OpFlags
& EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT
) != 0) {
1089 // Return the source port in the received packet if accept any.
1091 if (SrcPort
!= NULL
) {
1095 } else if (SrcPort
!= NULL
&& *SrcPort
== Port
) {
1097 // The source port in the received packet is matched if present.
1107 This function is to receive packet using Udp4Read.
1109 @param[in] Udp4 The pointer to EFI_UDP4_PROTOCOL.
1110 @param[in] Token The pointer to EFI_UDP4_COMPLETION_TOKEN.
1111 @param[in] Mode The pointer to EFI_PXE_BASE_CODE_MODE.
1112 @param[in] TimeoutEvent The event for timeout.
1113 @param[in] OpFlags The UDP operation flags.
1114 @param[in] IsDone The pointer to the IsDone flag.
1115 @param[out] IsMatched The pointer to the IsMatched flag.
1116 @param[in, out] DestIp The pointer to the destination address.
1117 @param[in, out] DestPort The pointer to the destination port.
1118 @param[in, out] SrcIp The pointer to the source address.
1119 @param[in, out] SrcPort The pointer to the source port.
1121 @retval EFI_SUCCESS Successfully read the data using Udp4.
1122 @retval Others Failed to send out data.
1127 IN EFI_UDP4_PROTOCOL
*Udp4
,
1128 IN EFI_UDP4_COMPLETION_TOKEN
*Token
,
1129 IN EFI_PXE_BASE_CODE_MODE
*Mode
,
1130 IN EFI_EVENT TimeoutEvent
,
1133 OUT BOOLEAN
*IsMatched
,
1134 IN OUT EFI_IP_ADDRESS
*DestIp OPTIONAL
,
1135 IN OUT EFI_PXE_BASE_CODE_UDP_PORT
*DestPort OPTIONAL
,
1136 IN OUT EFI_IP_ADDRESS
*SrcIp OPTIONAL
,
1137 IN OUT EFI_PXE_BASE_CODE_UDP_PORT
*SrcPort OPTIONAL
1140 EFI_UDP4_RECEIVE_DATA
*RxData
;
1141 EFI_UDP4_SESSION_DATA
*Session
;
1144 Token
->Status
= EFI_NOT_READY
;
1147 Status
= Udp4
->Receive (Udp4
, Token
);
1148 if (EFI_ERROR (Status
)) {
1153 // Poll the UDPv6 read instance if no packet received and no timeout triggered.
1155 while (!(*IsDone
) &&
1156 Token
->Status
== EFI_NOT_READY
&&
1157 EFI_ERROR (gBS
->CheckEvent (TimeoutEvent
))) {
1159 // Poll the token utill reply/ICMPv6 error message received or timeout.
1162 if (Token
->Status
== EFI_ICMP_ERROR
||
1163 Token
->Status
== EFI_NETWORK_UNREACHABLE
||
1164 Token
->Status
== EFI_HOST_UNREACHABLE
||
1165 Token
->Status
== EFI_PROTOCOL_UNREACHABLE
||
1166 Token
->Status
== EFI_PORT_UNREACHABLE
) {
1171 Status
= (Token
->Status
== EFI_NOT_READY
) ? EFI_TIMEOUT
: Token
->Status
;
1173 if (!EFI_ERROR (Status
)) {
1175 // check whether this packet matches the filters
1177 RxData
= Token
->Packet
.RxData
;
1178 Session
= &RxData
->UdpSession
;
1180 *IsMatched
= PxeBcCheckByIpFilter (Mode
, Session
, OpFlags
);
1183 *IsMatched
= PxeBcCheckByDestIp (Mode
, Session
, DestIp
, OpFlags
);
1187 *IsMatched
= PxeBcCheckByDestPort (Mode
, Session
, DestPort
, OpFlags
);
1191 *IsMatched
= PxeBcFilterBySrcIp (Mode
, Session
, SrcIp
, OpFlags
);
1195 *IsMatched
= PxeBcFilterBySrcPort (Mode
, Session
, SrcPort
, OpFlags
);
1198 if (!(*IsMatched
)) {
1200 // Recycle the receiving buffer if not matched.
1202 gBS
->SignalEvent (RxData
->RecycleSignal
);
1211 This function is to receive packets using Udp6Read.
1213 @param[in] Udp6 The pointer to EFI_UDP6_PROTOCOL.
1214 @param[in] Token The pointer to EFI_UDP6_COMPLETION_TOKEN.
1215 @param[in] Mode The pointer to EFI_PXE_BASE_CODE_MODE.
1216 @param[in] TimeoutEvent The event for timeout.
1217 @param[in] OpFlags The UDP operation flags.
1218 @param[in] IsDone The pointer to the IsDone flag.
1219 @param[out] IsMatched The pointer to the IsMatched flag.
1220 @param[in, out] DestIp The pointer to the destination address.
1221 @param[in, out] DestPort The pointer to the destination port.
1222 @param[in, out] SrcIp The pointer to the source address.
1223 @param[in, out] SrcPort The pointer to the source port.
1225 @retval EFI_SUCCESS Successfully read data using Udp6.
1226 @retval Others Failed to send out data.
1231 IN EFI_UDP6_PROTOCOL
*Udp6
,
1232 IN EFI_UDP6_COMPLETION_TOKEN
*Token
,
1233 IN EFI_PXE_BASE_CODE_MODE
*Mode
,
1234 IN EFI_EVENT TimeoutEvent
,
1237 OUT BOOLEAN
*IsMatched
,
1238 IN OUT EFI_IP_ADDRESS
*DestIp OPTIONAL
,
1239 IN OUT EFI_PXE_BASE_CODE_UDP_PORT
*DestPort OPTIONAL
,
1240 IN OUT EFI_IP_ADDRESS
*SrcIp OPTIONAL
,
1241 IN OUT EFI_PXE_BASE_CODE_UDP_PORT
*SrcPort OPTIONAL
1244 EFI_UDP6_RECEIVE_DATA
*RxData
;
1245 EFI_UDP6_SESSION_DATA
*Session
;
1248 Token
->Status
= EFI_NOT_READY
;
1251 Status
= Udp6
->Receive (Udp6
, Token
);
1252 if (EFI_ERROR (Status
)) {
1257 // Poll the UDPv6 read instance if no packet received and no timeout triggered.
1259 while (!(*IsDone
) &&
1260 Token
->Status
== EFI_NOT_READY
&&
1261 EFI_ERROR (gBS
->CheckEvent (TimeoutEvent
))) {
1263 // Poll the token utill reply/ICMPv6 error message received or timeout.
1266 if (Token
->Status
== EFI_ICMP_ERROR
||
1267 Token
->Status
== EFI_NETWORK_UNREACHABLE
||
1268 Token
->Status
== EFI_HOST_UNREACHABLE
||
1269 Token
->Status
== EFI_PROTOCOL_UNREACHABLE
||
1270 Token
->Status
== EFI_PORT_UNREACHABLE
) {
1275 Status
= (Token
->Status
== EFI_NOT_READY
) ? EFI_TIMEOUT
: Token
->Status
;
1277 if (!EFI_ERROR (Status
)) {
1279 // check whether this packet matches the filters
1281 RxData
= Token
->Packet
.RxData
;
1282 Session
= &RxData
->UdpSession
;
1284 *IsMatched
= PxeBcCheckByIpFilter (Mode
, Session
, OpFlags
);
1287 *IsMatched
= PxeBcCheckByDestIp (Mode
, Session
, DestIp
, OpFlags
);
1291 *IsMatched
= PxeBcCheckByDestPort (Mode
, Session
, DestPort
, OpFlags
);
1295 *IsMatched
= PxeBcFilterBySrcIp (Mode
, Session
, SrcIp
, OpFlags
);
1299 *IsMatched
= PxeBcFilterBySrcPort (Mode
, Session
, SrcPort
, OpFlags
);
1302 if (!(*IsMatched
)) {
1304 // Recycle the receiving buffer if not matched.
1306 gBS
->SignalEvent (RxData
->RecycleSignal
);
1315 This function is to display the IPv4 address.
1317 @param[in] Ip The pointer to the IPv4 address.
1322 IN EFI_IPv4_ADDRESS
*Ip
1327 for (Index
= 0; Index
< 4; Index
++) {
1328 AsciiPrint ("%d", Ip
->Addr
[Index
]);
1337 This function is to display the IPv6 address.
1339 @param[in] Ip The pointer to the IPv6 address.
1344 IN EFI_IPv6_ADDRESS
*Ip
1349 for (Index
= 0; Index
< 16; Index
++) {
1351 if (Ip
->Addr
[Index
] != 0) {
1352 AsciiPrint ("%x", Ip
->Addr
[Index
]);
1358 if (((Ip
->Addr
[Index
] & 0xf0) == 0) && (Ip
->Addr
[Index
- 1] != 0)) {
1361 AsciiPrint ("%x", Ip
->Addr
[Index
]);
1370 This function is to convert UINTN to ASCII string with the required formatting.
1372 @param[in] Number Numeric value to be converted.
1373 @param[in] Buffer The pointer to the buffer for ASCII string.
1374 @param[in] Length The length of the required format.
1378 PxeBcUintnToAscDecWithFormat (
1386 for (; Length
> 0; Length
--) {
1387 Remainder
= Number
% 10;
1389 Buffer
[Length
- 1] = (UINT8
) ('0' + Remainder
);
1395 This function is to convert a UINTN to a ASCII string, and return the
1396 actual length of the buffer.
1398 @param[in] Number Numeric value to be converted.
1399 @param[in] Buffer The pointer to the buffer for ASCII string.
1400 @param[in] BufferSize The maxsize of the buffer.
1402 @return Length The actual length of the ASCII string.
1406 PxeBcUintnToAscDec (
1421 TempStr
[Index
] = (CHAR8
) ('0' + (Number
% 10));
1422 Number
= (UINTN
) (Number
/ 10);
1423 } while (Number
!= 0);
1425 AsciiStrCpyS ((CHAR8
*) Buffer
, BufferSize
, &TempStr
[Index
]);
1427 Length
= AsciiStrLen ((CHAR8
*) Buffer
);
1434 This function is to convert unicode hex number to a UINT8.
1436 @param[out] Digit The converted UINT8 for output.
1437 @param[in] Char The unicode hex number to be converted.
1439 @retval EFI_SUCCESS Successfully converted the unicode hex.
1440 @retval EFI_INVALID_PARAMETER Failed to convert the unicode hex.
1444 PxeBcUniHexToUint8 (
1449 if ((Char
>= L
'0') && (Char
<= L
'9')) {
1450 *Digit
= (UINT8
) (Char
- L
'0');
1454 if ((Char
>= L
'A') && (Char
<= L
'F')) {
1455 *Digit
= (UINT8
) (Char
- L
'A' + 0x0A);
1459 if ((Char
>= L
'a') && (Char
<= L
'f')) {
1460 *Digit
= (UINT8
) (Char
- L
'a' + 0x0A);
1464 return EFI_INVALID_PARAMETER
;
1468 Calculate the elapsed time.
1470 @param[in] Private The pointer to PXE private data
1475 IN PXEBC_PRIVATE_DATA
*Private
1479 UINT64 CurrentStamp
;
1480 UINT64 ElapsedTimeValue
;
1483 // Generate a time stamp of the centiseconds from 1900/1/1, assume 30day/month.
1485 ZeroMem (&Time
, sizeof (EFI_TIME
));
1486 gRT
->GetTime (&Time
, NULL
);
1487 CurrentStamp
= (UINT64
)
1489 ((((((Time
.Year
- 1900) * 360 +
1490 (Time
.Month
- 1)) * 30 +
1491 (Time
.Day
- 1)) * 24 + Time
.Hour
) * 60 +
1492 Time
.Minute
) * 60 + Time
.Second
) * 100
1493 + DivU64x32(Time
.Nanosecond
, 10000000)
1497 // Sentinel value of 0 means that this is the first DHCP packet that we are
1498 // sending and that we need to initialize the value. First DHCP Solicit
1499 // gets 0 elapsed-time. Otherwise, calculate based on StartTime.
1501 if (Private
->ElapsedTime
== 0) {
1502 Private
->ElapsedTime
= CurrentStamp
;
1504 ElapsedTimeValue
= CurrentStamp
- Private
->ElapsedTime
;
1507 // If elapsed time cannot fit in two bytes, set it to 0xffff.
1509 if (ElapsedTimeValue
> 0xffff) {
1510 ElapsedTimeValue
= 0xffff;
1513 // Save the elapsed time
1515 Private
->ElapsedTime
= ElapsedTimeValue
;