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
, OPTIONAL
34 EFI_IP_ADDRESS
*SubnetMask OPTIONAL
37 EFI_PXE_BASE_CODE_MODE
*Mode
;
40 Mode
= Private
->PxeBc
.Mode
;
43 if (Mode
->UsingIpv6
) {
45 if (StationIp
!= NULL
) {
46 CopyMem (&Private
->Udp6CfgData
.StationAddress
, StationIp
, sizeof (EFI_IPv6_ADDRESS
));
47 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 if (StationIp
!= NULL
) {
64 CopyMem (&Private
->Udp4CfgData
.StationAddress
, StationIp
, sizeof (EFI_IPv4_ADDRESS
));
65 CopyMem (&Private
->Ip4CfgData
.StationAddress
, StationIp
, sizeof (EFI_IPv4_ADDRESS
));
68 if (SubnetMask
!= NULL
) {
69 CopyMem (&Private
->Udp4CfgData
.SubnetMask
, SubnetMask
, sizeof (EFI_IPv4_ADDRESS
));
70 CopyMem (&Private
->Ip4CfgData
.SubnetMask
, SubnetMask
, sizeof (EFI_IPv4_ADDRESS
));
74 // Reconfigure the Ip4 instance to capture background ICMP packets with new station Ip address.
76 Private
->Ip4
->Cancel (Private
->Ip4
, &Private
->IcmpToken
);
77 Private
->Ip4
->Configure (Private
->Ip4
, NULL
);
79 Status
= Private
->Ip4
->Configure (Private
->Ip4
, &Private
->Ip4CfgData
);
80 if (EFI_ERROR (Status
)) {
84 Status
= Private
->Ip4
->Receive (Private
->Ip4
, &Private
->IcmpToken
);
93 Notify the callback function when an event is triggered.
95 @param[in] Event The triggered event.
96 @param[in] Context The opaque parameter to the function.
106 *((BOOLEAN
*) Context
) = TRUE
;
111 Do arp resolution from arp cache in PxeBcMode.
113 @param Mode The pointer to EFI_PXE_BASE_CODE_MODE.
114 @param Ip4Addr The Ip4 address for resolution.
115 @param MacAddress The resoluted MAC address if the resolution is successful.
116 The value is undefined if the resolution fails.
118 @retval TRUE Found an matched entry.
119 @retval FALSE Did not find a matched entry.
124 IN EFI_PXE_BASE_CODE_MODE
*Mode
,
125 IN EFI_IPv4_ADDRESS
*Ip4Addr
,
126 OUT EFI_MAC_ADDRESS
*MacAddress
131 ASSERT (!Mode
->UsingIpv6
);
134 // Check whether the current Arp cache in mode data contains this information or not.
136 for (Index
= 0; Index
< Mode
->ArpCacheEntries
; Index
++) {
137 if (EFI_IP4_EQUAL (&Mode
->ArpCache
[Index
].IpAddr
.v4
, Ip4Addr
)) {
140 &Mode
->ArpCache
[Index
].MacAddr
,
141 sizeof (EFI_MAC_ADDRESS
)
152 Update the arp cache periodically.
154 @param Event The pointer to EFI_PXE_BC_PROTOCOL.
155 @param Context Context of the timer event.
160 PxeBcArpCacheUpdate (
165 PXEBC_PRIVATE_DATA
*Private
;
166 EFI_PXE_BASE_CODE_MODE
*Mode
;
167 EFI_ARP_FIND_DATA
*ArpEntry
;
173 Private
= (PXEBC_PRIVATE_DATA
*) Context
;
174 Mode
= Private
->PxeBc
.Mode
;
176 ASSERT (!Mode
->UsingIpv6
);
179 // Get the current Arp cache from Arp driver.
181 Status
= Private
->Arp
->Find (
190 if (EFI_ERROR (Status
)) {
195 // Update the Arp cache in mode data.
197 Mode
->ArpCacheEntries
= MIN (EntryCount
, EFI_PXE_BASE_CODE_MAX_ARP_ENTRIES
);
199 for (Index
= 0; Index
< Mode
->ArpCacheEntries
; Index
++) {
201 &Mode
->ArpCache
[Index
].IpAddr
,
203 ArpEntry
->SwAddressLength
206 &Mode
->ArpCache
[Index
].MacAddr
,
207 (UINT8
*) (ArpEntry
+ 1) + ArpEntry
->SwAddressLength
,
208 ArpEntry
->HwAddressLength
210 ArpEntry
= (EFI_ARP_FIND_DATA
*) ((UINT8
*) ArpEntry
+ EntryLength
);
216 Notify function to handle the received ICMP message in DPC.
218 @param Context The PXEBC private data.
223 PxeBcIcmpErrorDpcHandle (
228 EFI_IP4_RECEIVE_DATA
*RxData
;
229 EFI_IP4_PROTOCOL
*Ip4
;
230 PXEBC_PRIVATE_DATA
*Private
;
231 EFI_PXE_BASE_CODE_MODE
*Mode
;
237 Private
= (PXEBC_PRIVATE_DATA
*) Context
;
238 Mode
= &Private
->Mode
;
239 Status
= Private
->IcmpToken
.Status
;
240 RxData
= Private
->IcmpToken
.Packet
.RxData
;
243 ASSERT (!Mode
->UsingIpv6
);
245 if (Status
== EFI_ABORTED
) {
247 // It's triggered by user cancellation.
252 if (RxData
== NULL
) {
256 if (Status
!= EFI_ICMP_ERROR
) {
258 // The return status should be recognized as EFI_ICMP_ERROR.
263 if (EFI_IP4 (RxData
->Header
->SourceAddress
) != 0 &&
264 (NTOHL (Mode
->SubnetMask
.Addr
[0]) != 0) &&
265 IP4_NET_EQUAL (NTOHL(Mode
->StationIp
.Addr
[0]), EFI_NTOHL (RxData
->Header
->SourceAddress
), NTOHL (Mode
->SubnetMask
.Addr
[0])) &&
266 !NetIp4IsUnicast (EFI_NTOHL (RxData
->Header
->SourceAddress
), NTOHL (Mode
->SubnetMask
.Addr
[0]))) {
268 // The source address of the received packet should be a valid unicast address.
273 if (!EFI_IP4_EQUAL (&RxData
->Header
->DestinationAddress
, &Mode
->StationIp
.v4
)) {
275 // The destination address of the received packet should be equal to the host address.
281 // The protocol has been configured to only receive ICMP packet.
283 ASSERT (RxData
->Header
->Protocol
== EFI_IP_PROTO_ICMP
);
285 Type
= *((UINT8
*) RxData
->FragmentTable
[0].FragmentBuffer
);
287 if (Type
!= ICMP_DEST_UNREACHABLE
&&
288 Type
!= ICMP_SOURCE_QUENCH
&&
289 Type
!= ICMP_REDIRECT
&&
290 Type
!= ICMP_TIME_EXCEEDED
&&
291 Type
!= ICMP_PARAMETER_PROBLEM
) {
293 // The type of the receveid ICMP message should be ICMP_ERROR_MESSAGE.
299 // Copy the right ICMP error message into mode data.
302 IcmpError
= (UINT8
*) &Mode
->IcmpError
;
304 for (Index
= 0; Index
< RxData
->FragmentCount
; Index
++) {
305 CopiedLen
+= RxData
->FragmentTable
[Index
].FragmentLength
;
306 if (CopiedLen
<= sizeof (EFI_PXE_BASE_CODE_ICMP_ERROR
)) {
309 RxData
->FragmentTable
[Index
].FragmentBuffer
,
310 RxData
->FragmentTable
[Index
].FragmentLength
315 RxData
->FragmentTable
[Index
].FragmentBuffer
,
316 CopiedLen
- sizeof (EFI_PXE_BASE_CODE_ICMP_ERROR
)
319 IcmpError
+= CopiedLen
;
323 gBS
->SignalEvent (RxData
->RecycleSignal
);
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.
397 if (!NetIp6IsValidUnicast (&RxData
->Header
->SourceAddress
)) {
399 // The source address of the received packet should be a valid unicast address.
404 if (!NetIp6IsUnspecifiedAddr (&Mode
->StationIp
.v6
) &&
405 !EFI_IP6_EQUAL (&RxData
->Header
->DestinationAddress
, &Mode
->StationIp
.v6
)) {
407 // The destination address of the received packet should be equal to the host address.
413 // The protocol has been configured to only receive ICMP packet.
415 ASSERT (RxData
->Header
->NextHeader
== IP6_ICMP
);
417 Type
= *((UINT8
*) RxData
->FragmentTable
[0].FragmentBuffer
);
419 if (Type
!= ICMP_V6_DEST_UNREACHABLE
&&
420 Type
!= ICMP_V6_PACKET_TOO_BIG
&&
421 Type
!= ICMP_V6_TIME_EXCEEDED
&&
422 Type
!= ICMP_V6_PARAMETER_PROBLEM
) {
424 // The type of the receveid packet should be an ICMP6 error message.
430 // Copy the right ICMP6 error message into mode data.
433 Icmp6Error
= (UINT8
*) &Mode
->IcmpError
;
435 for (Index
= 0; Index
< RxData
->FragmentCount
; Index
++) {
436 CopiedLen
+= RxData
->FragmentTable
[Index
].FragmentLength
;
437 if (CopiedLen
<= sizeof (EFI_PXE_BASE_CODE_ICMP_ERROR
)) {
440 RxData
->FragmentTable
[Index
].FragmentBuffer
,
441 RxData
->FragmentTable
[Index
].FragmentLength
446 RxData
->FragmentTable
[Index
].FragmentBuffer
,
447 CopiedLen
- sizeof (EFI_PXE_BASE_CODE_ICMP_ERROR
)
450 Icmp6Error
+= CopiedLen
;
454 gBS
->SignalEvent (RxData
->RecycleSignal
);
457 Private
->Icmp6Token
.Status
= EFI_NOT_READY
;
458 Ip6
->Receive (Ip6
, &Private
->Icmp6Token
);
463 Callback function to update the latest ICMP6 error message.
465 @param Event The event signalled.
466 @param Context The context passed in using the event notifier.
471 PxeBcIcmp6ErrorUpdate (
476 QueueDpc (TPL_CALLBACK
, PxeBcIcmp6ErrorDpcHandle
, Context
);
481 This function is to configure a UDPv4 instance for UdpWrite.
483 @param[in] Udp4 The pointer to EFI_UDP4_PROTOCOL.
484 @param[in] StationIp The pointer to the station address.
485 @param[in] SubnetMask The pointer to the subnet mask.
486 @param[in] Gateway The pointer to the gateway address.
487 @param[in, out] SrcPort The pointer to the source port.
488 @param[in] DoNotFragment If TRUE, fragment is not enabled.
489 Otherwise, fragment is enabled.
490 @param[in] Ttl The time to live field of the IP header.
491 @param[in] ToS The type of service field of the IP header.
493 @retval EFI_SUCCESS Successfully configured this instance.
494 @retval Others Failed to configure this instance.
498 PxeBcConfigUdp4Write (
499 IN EFI_UDP4_PROTOCOL
*Udp4
,
500 IN EFI_IPv4_ADDRESS
*StationIp
,
501 IN EFI_IPv4_ADDRESS
*SubnetMask
,
502 IN EFI_IPv4_ADDRESS
*Gateway
,
503 IN OUT UINT16
*SrcPort
,
504 IN BOOLEAN DoNotFragment
,
509 EFI_UDP4_CONFIG_DATA Udp4CfgData
;
512 ZeroMem (&Udp4CfgData
, sizeof (Udp4CfgData
));
514 Udp4CfgData
.TransmitTimeout
= PXEBC_DEFAULT_LIFETIME
;
515 Udp4CfgData
.ReceiveTimeout
= PXEBC_DEFAULT_LIFETIME
;
516 Udp4CfgData
.TypeOfService
= ToS
;
517 Udp4CfgData
.TimeToLive
= Ttl
;
518 Udp4CfgData
.AllowDuplicatePort
= TRUE
;
519 Udp4CfgData
.DoNotFragment
= DoNotFragment
;
521 CopyMem (&Udp4CfgData
.StationAddress
, StationIp
, sizeof (*StationIp
));
522 CopyMem (&Udp4CfgData
.SubnetMask
, SubnetMask
, sizeof (*SubnetMask
));
524 Udp4CfgData
.StationPort
= *SrcPort
;
527 // Reset the UDPv4 instance.
529 Udp4
->Configure (Udp4
, NULL
);
531 Status
= Udp4
->Configure (Udp4
, &Udp4CfgData
);
532 if (!EFI_ERROR (Status
) && !EFI_IP4_EQUAL (Gateway
, &mZeroIp4Addr
)) {
534 // The basic configuration is OK, need to add the default route entry
536 Status
= Udp4
->Routes (Udp4
, FALSE
, &mZeroIp4Addr
, &mZeroIp4Addr
, Gateway
);
537 if (EFI_ERROR (Status
)) {
538 Udp4
->Configure (Udp4
, NULL
);
542 if (!EFI_ERROR (Status
) && *SrcPort
== 0) {
543 Udp4
->GetModeData (Udp4
, &Udp4CfgData
, NULL
, NULL
, NULL
);
544 *SrcPort
= Udp4CfgData
.StationPort
;
552 This function is to configure a UDPv6 instance for UdpWrite.
554 @param[in] Udp6 The pointer to EFI_UDP6_PROTOCOL.
555 @param[in] StationIp The pointer to the station address.
556 @param[in, out] SrcPort The pointer to the source port.
558 @retval EFI_SUCCESS Successfully configured this instance.
559 @retval Others Failed to configure this instance.
563 PxeBcConfigUdp6Write (
564 IN EFI_UDP6_PROTOCOL
*Udp6
,
565 IN EFI_IPv6_ADDRESS
*StationIp
,
566 IN OUT UINT16
*SrcPort
569 EFI_UDP6_CONFIG_DATA CfgData
;
572 ZeroMem (&CfgData
, sizeof (EFI_UDP6_CONFIG_DATA
));
574 CfgData
.ReceiveTimeout
= PXEBC_DEFAULT_LIFETIME
;
575 CfgData
.TransmitTimeout
= PXEBC_DEFAULT_LIFETIME
;
576 CfgData
.HopLimit
= PXEBC_DEFAULT_HOPLIMIT
;
577 CfgData
.AllowDuplicatePort
= TRUE
;
578 CfgData
.StationPort
= *SrcPort
;
580 CopyMem (&CfgData
.StationAddress
, StationIp
, sizeof (EFI_IPv6_ADDRESS
));
583 // Reset the UDPv6 instance.
585 Udp6
->Configure (Udp6
, NULL
);
587 Status
= Udp6
->Configure (Udp6
, &CfgData
);
588 if (EFI_ERROR (Status
)) {
592 if (!EFI_ERROR (Status
) && *SrcPort
== 0) {
593 Udp6
->GetModeData (Udp6
, &CfgData
, NULL
, NULL
, NULL
);
594 *SrcPort
= CfgData
.StationPort
;
602 This function is to configure a UDPv4 instance for UdpWrite.
604 @param[in] Udp4 The pointer to EFI_UDP4_PROTOCOL.
605 @param[in] Session The pointer to the UDP4 session data.
606 @param[in] TimeoutEvent The event for timeout.
607 @param[in] Gateway The pointer to the gateway address.
608 @param[in] HeaderSize An optional field which may be set to the length of a header
609 at HeaderPtr to be prefixed to the data at BufferPtr.
610 @param[in] HeaderPtr If HeaderSize is not NULL, a pointer to a header to be
611 prefixed to the data at BufferPtr.
612 @param[in] BufferSize A pointer to the size of the data at BufferPtr.
613 @param[in] BufferPtr A pointer to the data to be written.
615 @retval EFI_SUCCESS Successfully send out data using Udp4Write.
616 @retval Others Failed to send out data.
621 IN EFI_UDP4_PROTOCOL
*Udp4
,
622 IN EFI_UDP4_SESSION_DATA
*Session
,
623 IN EFI_EVENT TimeoutEvent
,
624 IN EFI_IPv4_ADDRESS
*Gateway OPTIONAL
,
625 IN UINTN
*HeaderSize OPTIONAL
,
626 IN VOID
*HeaderPtr OPTIONAL
,
627 IN UINTN
*BufferSize
,
631 EFI_UDP4_COMPLETION_TOKEN Token
;
632 EFI_UDP4_TRANSMIT_DATA
*TxData
;
640 // Arrange one fragment buffer for data, and another fragment buffer for header if has.
642 FragCount
= (HeaderSize
!= NULL
) ? 2 : 1;
643 TxLength
= sizeof (EFI_UDP4_TRANSMIT_DATA
) + (FragCount
- 1) * sizeof (EFI_UDP4_FRAGMENT_DATA
);
644 TxData
= (EFI_UDP4_TRANSMIT_DATA
*) AllocateZeroPool (TxLength
);
645 if (TxData
== NULL
) {
646 return EFI_OUT_OF_RESOURCES
;
649 TxData
->FragmentCount
= FragCount
;
650 TxData
->FragmentTable
[FragCount
- 1].FragmentLength
= (UINT32
) *BufferSize
;
651 TxData
->FragmentTable
[FragCount
- 1].FragmentBuffer
= BufferPtr
;
652 DataLength
= (UINT32
) *BufferSize
;
654 if (HeaderSize
!= NULL
) {
655 TxData
->FragmentTable
[0].FragmentLength
= (UINT32
) *HeaderSize
;
656 TxData
->FragmentTable
[0].FragmentBuffer
= HeaderPtr
;
657 DataLength
+= (UINT32
) *HeaderSize
;
660 if (Gateway
!= NULL
) {
661 TxData
->GatewayAddress
= Gateway
;
664 TxData
->UdpSessionData
= Session
;
665 TxData
->DataLength
= DataLength
;
666 Token
.Packet
.TxData
= TxData
;
667 Token
.Status
= EFI_NOT_READY
;
670 Status
= gBS
->CreateEvent (
677 if (EFI_ERROR (Status
)) {
681 Status
= Udp4
->Transmit (Udp4
, &Token
);
682 if (EFI_ERROR (Status
)) {
687 // Poll the UDPv6 read instance if no packet received and no timeout triggered.
690 Token
.Status
== EFI_NOT_READY
&&
691 EFI_ERROR (gBS
->CheckEvent (TimeoutEvent
))) {
695 Status
= (Token
.Status
== EFI_NOT_READY
) ? EFI_TIMEOUT
: Token
.Status
;
698 if (Token
.Event
!= NULL
) {
699 gBS
->CloseEvent (Token
.Event
);
708 This function is to configure a UDPv4 instance for UdpWrite.
710 @param[in] Udp6 The pointer to EFI_UDP6_PROTOCOL.
711 @param[in] Session The pointer to the UDP6 session data.
712 @param[in] TimeoutEvent The event for timeout.
713 @param[in] HeaderSize An optional field which may be set to the length of a header
714 at HeaderPtr to be prefixed to the data at BufferPtr.
715 @param[in] HeaderPtr If HeaderSize is not NULL, a pointer to a header to be
716 prefixed to the data at BufferPtr.
717 @param[in] BufferSize A pointer to the size of the data at BufferPtr.
718 @param[in] BufferPtr A pointer to the data to be written.
720 @retval EFI_SUCCESS Successfully sent out data using Udp6Write.
721 @retval Others Failed to send out data.
726 IN EFI_UDP6_PROTOCOL
*Udp6
,
727 IN EFI_UDP6_SESSION_DATA
*Session
,
728 IN EFI_EVENT TimeoutEvent
,
729 IN UINTN
*HeaderSize OPTIONAL
,
730 IN VOID
*HeaderPtr OPTIONAL
,
731 IN UINTN
*BufferSize
,
735 EFI_UDP6_COMPLETION_TOKEN Token
;
736 EFI_UDP6_TRANSMIT_DATA
*TxData
;
744 // Arrange one fragment buffer for data, and another fragment buffer for header if has.
746 FragCount
= (HeaderSize
!= NULL
) ? 2 : 1;
747 TxLength
= sizeof (EFI_UDP6_TRANSMIT_DATA
) + (FragCount
- 1) * sizeof (EFI_UDP6_FRAGMENT_DATA
);
748 TxData
= (EFI_UDP6_TRANSMIT_DATA
*) AllocateZeroPool (TxLength
);
749 if (TxData
== NULL
) {
750 return EFI_OUT_OF_RESOURCES
;
753 TxData
->FragmentCount
= FragCount
;
754 TxData
->FragmentTable
[FragCount
- 1].FragmentLength
= (UINT32
) *BufferSize
;
755 TxData
->FragmentTable
[FragCount
- 1].FragmentBuffer
= BufferPtr
;
756 DataLength
= (UINT32
) *BufferSize
;
758 if (HeaderSize
!= NULL
) {
759 TxData
->FragmentTable
[0].FragmentLength
= (UINT32
) *HeaderSize
;
760 TxData
->FragmentTable
[0].FragmentBuffer
= HeaderPtr
;
761 DataLength
+= (UINT32
) *HeaderSize
;
764 TxData
->UdpSessionData
= Session
;
765 TxData
->DataLength
= DataLength
;
766 Token
.Packet
.TxData
= TxData
;
767 Token
.Status
= EFI_NOT_READY
;
770 Status
= gBS
->CreateEvent (
777 if (EFI_ERROR (Status
)) {
781 Status
= Udp6
->Transmit (Udp6
, &Token
);
782 if (EFI_ERROR (Status
)) {
787 // Poll the UDPv6 read instance if no packet received and no timeout triggered.
790 Token
.Status
== EFI_NOT_READY
&&
791 EFI_ERROR (gBS
->CheckEvent (TimeoutEvent
))) {
795 Status
= (Token
.Status
== EFI_NOT_READY
) ? EFI_TIMEOUT
: Token
.Status
;
798 if (Token
.Event
!= NULL
) {
799 gBS
->CloseEvent (Token
.Event
);
808 Check the received packet using the Ip filter.
810 @param[in] Mode The pointer to the mode data of PxeBc.
811 @param[in] Session The pointer to the current UDPv4 session.
812 @param[in] OpFlags Operation flag for UdpRead/UdpWrite.
814 @retval TRUE Passed the Ip filter successfully.
815 @retval FALSE Failed to pass the Ip filter.
819 PxeBcCheckByIpFilter (
820 IN EFI_PXE_BASE_CODE_MODE
*Mode
,
825 EFI_IP_ADDRESS DestinationIp
;
828 if ((OpFlags
& EFI_PXE_BASE_CODE_UDP_OPFLAGS_USE_FILTER
) == 0) {
832 if ((Mode
->IpFilter
.Filters
& EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS
) != 0) {
837 // Convert the destination address in session data to host order.
839 if (Mode
->UsingIpv6
) {
842 &((EFI_UDP6_SESSION_DATA
*) Session
)->DestinationAddress
,
843 sizeof (EFI_IPv6_ADDRESS
)
845 NTOHLLL (&DestinationIp
.v6
);
847 ZeroMem (&DestinationIp
, sizeof (EFI_IP_ADDRESS
));
850 &((EFI_UDP4_SESSION_DATA
*) Session
)->DestinationAddress
,
851 sizeof (EFI_IPv4_ADDRESS
)
853 EFI_NTOHL (DestinationIp
);
856 if ((Mode
->IpFilter
.Filters
& EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS_MULTICAST
) != 0 &&
857 (IP4_IS_MULTICAST (DestinationIp
.Addr
[0]) ||
858 IP6_IS_MULTICAST (&DestinationIp
))) {
862 if ((Mode
->IpFilter
.Filters
& EFI_PXE_BASE_CODE_IP_FILTER_BROADCAST
) != 0 &&
863 IP4_IS_LOCAL_BROADCAST (DestinationIp
.Addr
[0])) {
864 ASSERT (!Mode
->UsingIpv6
);
868 if ((Mode
->IpFilter
.Filters
& EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP
) != 0 &&
869 (EFI_IP4_EQUAL (&Mode
->StationIp
.v4
, &DestinationIp
) ||
870 EFI_IP6_EQUAL (&Mode
->StationIp
.v6
, &DestinationIp
))) {
872 // Matched if the dest address is equal to the station address.
877 for (Index
= 0; Index
< Mode
->IpFilter
.IpCnt
; Index
++) {
878 ASSERT (Index
< EFI_PXE_BASE_CODE_MAX_IPCNT
);
879 if (EFI_IP4_EQUAL (&Mode
->IpFilter
.IpList
[Index
].v4
, &DestinationIp
) ||
880 EFI_IP6_EQUAL (&Mode
->IpFilter
.IpList
[Index
].v6
, &DestinationIp
)) {
882 // Matched if the dest address is equal to any of address in the filter list.
893 Filter the received packet using the destination Ip.
895 @param[in] Mode The pointer to the mode data of PxeBc.
896 @param[in] Session The pointer to the current UDPv4 session.
897 @param[in, out] DestIp The pointer to the destination Ip address.
898 @param[in] OpFlags Operation flag for UdpRead/UdpWrite.
900 @retval TRUE Passed the IPv4 filter successfully.
901 @retval FALSE Failed to pass the IPv4 filter.
906 IN EFI_PXE_BASE_CODE_MODE
*Mode
,
908 IN OUT EFI_IP_ADDRESS
*DestIp
,
912 if ((OpFlags
& EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_IP
) != 0) {
914 // Copy the destination address from the received packet if accept any.
916 if (DestIp
!= NULL
) {
917 if (Mode
->UsingIpv6
) {
920 &((EFI_UDP6_SESSION_DATA
*)Session
)->DestinationAddress
,
921 sizeof (EFI_IPv6_ADDRESS
)
924 ZeroMem (DestIp
, sizeof (EFI_IP_ADDRESS
));
927 &((EFI_UDP4_SESSION_DATA
*)Session
)->DestinationAddress
,
928 sizeof (EFI_IPv4_ADDRESS
)
934 } else if (DestIp
!= NULL
&&
935 (EFI_IP4_EQUAL (DestIp
, &((EFI_UDP4_SESSION_DATA
*)Session
)->DestinationAddress
) ||
936 EFI_IP6_EQUAL (DestIp
, &((EFI_UDP6_SESSION_DATA
*)Session
)->DestinationAddress
))) {
938 // The destination address in the received packet is matched if present.
941 } else if (EFI_IP4_EQUAL (&Mode
->StationIp
, &((EFI_UDP4_SESSION_DATA
*)Session
)->DestinationAddress
) ||
942 EFI_IP6_EQUAL (&Mode
->StationIp
, &((EFI_UDP6_SESSION_DATA
*)Session
)->DestinationAddress
)) {
944 // The destination address in the received packet is equal to the host address.
954 Check the received packet using the destination port.
956 @param[in] Mode The pointer to the mode data of PxeBc.
957 @param[in] Session The pointer to the current UDPv4 session.
958 @param[in, out] DestPort The pointer to the destination port.
959 @param[in] OpFlags Operation flag for UdpRead/UdpWrite.
961 @retval TRUE Passed the IPv4 filter successfully.
962 @retval FALSE Failed to pass the IPv4 filter.
966 PxeBcCheckByDestPort (
967 IN EFI_PXE_BASE_CODE_MODE
*Mode
,
969 IN OUT UINT16
*DestPort
,
975 if (Mode
->UsingIpv6
) {
976 Port
= ((EFI_UDP6_SESSION_DATA
*) Session
)->DestinationPort
;
978 Port
= ((EFI_UDP4_SESSION_DATA
*) Session
)->DestinationPort
;
981 if ((OpFlags
& EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_PORT
) != 0) {
983 // Return the destination port in the received packet if accept any.
985 if (DestPort
!= NULL
) {
989 } else if (DestPort
!= NULL
&& *DestPort
== Port
) {
991 // The destination port in the received packet is matched if present.
1001 Filter the received packet using the source Ip.
1003 @param[in] Mode The pointer to the mode data of PxeBc.
1004 @param[in] Session The pointer to the current UDPv4 session.
1005 @param[in, out] SrcIp The pointer to the source Ip address.
1006 @param[in] OpFlags Operation flag for UdpRead/UdpWrite.
1008 @retval TRUE Passed the IPv4 filter successfully.
1009 @retval FALSE Failed to pass the IPv4 filter.
1013 PxeBcFilterBySrcIp (
1014 IN EFI_PXE_BASE_CODE_MODE
*Mode
,
1016 IN OUT EFI_IP_ADDRESS
*SrcIp
,
1020 if ((OpFlags
& EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_IP
) != 0) {
1022 // Copy the source address from the received packet if accept any.
1024 if (SrcIp
!= NULL
) {
1025 if (Mode
->UsingIpv6
) {
1028 &((EFI_UDP6_SESSION_DATA
*)Session
)->SourceAddress
,
1029 sizeof (EFI_IPv6_ADDRESS
)
1032 ZeroMem (SrcIp
, sizeof (EFI_IP_ADDRESS
));
1035 &((EFI_UDP4_SESSION_DATA
*)Session
)->SourceAddress
,
1036 sizeof (EFI_IPv4_ADDRESS
)
1042 } else if (SrcIp
!= NULL
&&
1043 (EFI_IP4_EQUAL (SrcIp
, &((EFI_UDP4_SESSION_DATA
*)Session
)->SourceAddress
) ||
1044 EFI_IP6_EQUAL (SrcIp
, &((EFI_UDP6_SESSION_DATA
*)Session
)->SourceAddress
))) {
1046 // The source address in the received packet is matched if present.
1056 Filter the received packet using the source port.
1058 @param[in] Mode The pointer to the mode data of PxeBc.
1059 @param[in] Session The pointer to the current UDPv4 session.
1060 @param[in, out] SrcPort The pointer to the source port.
1061 @param[in] OpFlags Operation flag for UdpRead/UdpWrite.
1063 @retval TRUE Passed the IPv4 filter successfully.
1064 @retval FALSE Failed to pass the IPv4 filter.
1068 PxeBcFilterBySrcPort (
1069 IN EFI_PXE_BASE_CODE_MODE
*Mode
,
1071 IN OUT UINT16
*SrcPort
,
1077 if (Mode
->UsingIpv6
) {
1078 Port
= ((EFI_UDP6_SESSION_DATA
*) Session
)->SourcePort
;
1080 Port
= ((EFI_UDP4_SESSION_DATA
*) Session
)->SourcePort
;
1083 if ((OpFlags
& EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT
) != 0) {
1085 // Return the source port in the received packet if accept any.
1087 if (SrcPort
!= NULL
) {
1091 } else if (SrcPort
!= NULL
&& *SrcPort
== Port
) {
1093 // The source port in the received packet is matched if present.
1103 This function is to receive packet using Udp4Read.
1105 @param[in] Udp4 The pointer to EFI_UDP4_PROTOCOL.
1106 @param[in] Token The pointer to EFI_UDP4_COMPLETION_TOKEN.
1107 @param[in] Mode The pointer to EFI_PXE_BASE_CODE_MODE.
1108 @param[in] TimeoutEvent The event for timeout.
1109 @param[in] OpFlags The UDP operation flags.
1110 @param[in] IsDone The pointer to the IsDone flag.
1111 @param[out] IsMatched The pointer to the IsMatched flag.
1112 @param[in, out] DestIp The pointer to the destination address.
1113 @param[in, out] DestPort The pointer to the destination port.
1114 @param[in, out] SrcIp The pointer to the source address.
1115 @param[in, out] SrcPort The pointer to the source port.
1117 @retval EFI_SUCCESS Successfully read the data using Udp4.
1118 @retval Others Failed to send out data.
1123 IN EFI_UDP4_PROTOCOL
*Udp4
,
1124 IN EFI_UDP4_COMPLETION_TOKEN
*Token
,
1125 IN EFI_PXE_BASE_CODE_MODE
*Mode
,
1126 IN EFI_EVENT TimeoutEvent
,
1129 OUT BOOLEAN
*IsMatched
,
1130 IN OUT EFI_IP_ADDRESS
*DestIp OPTIONAL
,
1131 IN OUT EFI_PXE_BASE_CODE_UDP_PORT
*DestPort OPTIONAL
,
1132 IN OUT EFI_IP_ADDRESS
*SrcIp OPTIONAL
,
1133 IN OUT EFI_PXE_BASE_CODE_UDP_PORT
*SrcPort OPTIONAL
1136 EFI_UDP4_RECEIVE_DATA
*RxData
;
1137 EFI_UDP4_SESSION_DATA
*Session
;
1140 Token
->Status
= EFI_NOT_READY
;
1143 Status
= Udp4
->Receive (Udp4
, Token
);
1144 if (EFI_ERROR (Status
)) {
1149 // Poll the UDPv6 read instance if no packet received and no timeout triggered.
1151 while (!(*IsDone
) &&
1152 Token
->Status
== EFI_NOT_READY
&&
1153 EFI_ERROR (gBS
->CheckEvent (TimeoutEvent
))) {
1155 // Poll the token utill reply/ICMPv6 error message received or timeout.
1158 if (Token
->Status
== EFI_ICMP_ERROR
||
1159 Token
->Status
== EFI_NETWORK_UNREACHABLE
||
1160 Token
->Status
== EFI_HOST_UNREACHABLE
||
1161 Token
->Status
== EFI_PROTOCOL_UNREACHABLE
||
1162 Token
->Status
== EFI_PORT_UNREACHABLE
) {
1167 Status
= (Token
->Status
== EFI_NOT_READY
) ? EFI_TIMEOUT
: Token
->Status
;
1169 if (!EFI_ERROR (Status
)) {
1171 // check whether this packet matches the filters
1173 RxData
= Token
->Packet
.RxData
;
1174 Session
= &RxData
->UdpSession
;
1176 *IsMatched
= PxeBcCheckByIpFilter (Mode
, Session
, OpFlags
);
1179 *IsMatched
= PxeBcCheckByDestIp (Mode
, Session
, DestIp
, OpFlags
);
1183 *IsMatched
= PxeBcCheckByDestPort (Mode
, Session
, DestPort
, OpFlags
);
1187 *IsMatched
= PxeBcFilterBySrcIp (Mode
, Session
, SrcIp
, OpFlags
);
1191 *IsMatched
= PxeBcFilterBySrcPort (Mode
, Session
, SrcPort
, OpFlags
);
1194 if (!(*IsMatched
)) {
1196 // Recycle the receiving buffer if not matched.
1198 gBS
->SignalEvent (RxData
->RecycleSignal
);
1207 This function is to receive packets using Udp6Read.
1209 @param[in] Udp6 The pointer to EFI_UDP6_PROTOCOL.
1210 @param[in] Token The pointer to EFI_UDP6_COMPLETION_TOKEN.
1211 @param[in] Mode The pointer to EFI_PXE_BASE_CODE_MODE.
1212 @param[in] TimeoutEvent The event for timeout.
1213 @param[in] OpFlags The UDP operation flags.
1214 @param[in] IsDone The pointer to the IsDone flag.
1215 @param[out] IsMatched The pointer to the IsMatched flag.
1216 @param[in, out] DestIp The pointer to the destination address.
1217 @param[in, out] DestPort The pointer to the destination port.
1218 @param[in, out] SrcIp The pointer to the source address.
1219 @param[in, out] SrcPort The pointer to the source port.
1221 @retval EFI_SUCCESS Successfully read data using Udp6.
1222 @retval Others Failed to send out data.
1227 IN EFI_UDP6_PROTOCOL
*Udp6
,
1228 IN EFI_UDP6_COMPLETION_TOKEN
*Token
,
1229 IN EFI_PXE_BASE_CODE_MODE
*Mode
,
1230 IN EFI_EVENT TimeoutEvent
,
1233 OUT BOOLEAN
*IsMatched
,
1234 IN OUT EFI_IP_ADDRESS
*DestIp OPTIONAL
,
1235 IN OUT EFI_PXE_BASE_CODE_UDP_PORT
*DestPort OPTIONAL
,
1236 IN OUT EFI_IP_ADDRESS
*SrcIp OPTIONAL
,
1237 IN OUT EFI_PXE_BASE_CODE_UDP_PORT
*SrcPort OPTIONAL
1240 EFI_UDP6_RECEIVE_DATA
*RxData
;
1241 EFI_UDP6_SESSION_DATA
*Session
;
1244 Token
->Status
= EFI_NOT_READY
;
1247 Status
= Udp6
->Receive (Udp6
, Token
);
1248 if (EFI_ERROR (Status
)) {
1253 // Poll the UDPv6 read instance if no packet received and no timeout triggered.
1255 while (!(*IsDone
) &&
1256 Token
->Status
== EFI_NOT_READY
&&
1257 EFI_ERROR (gBS
->CheckEvent (TimeoutEvent
))) {
1259 // Poll the token utill reply/ICMPv6 error message received or timeout.
1262 if (Token
->Status
== EFI_ICMP_ERROR
||
1263 Token
->Status
== EFI_NETWORK_UNREACHABLE
||
1264 Token
->Status
== EFI_HOST_UNREACHABLE
||
1265 Token
->Status
== EFI_PROTOCOL_UNREACHABLE
||
1266 Token
->Status
== EFI_PORT_UNREACHABLE
) {
1271 Status
= (Token
->Status
== EFI_NOT_READY
) ? EFI_TIMEOUT
: Token
->Status
;
1273 if (!EFI_ERROR (Status
)) {
1275 // check whether this packet matches the filters
1277 RxData
= Token
->Packet
.RxData
;
1278 Session
= &RxData
->UdpSession
;
1280 *IsMatched
= PxeBcCheckByIpFilter (Mode
, Session
, OpFlags
);
1283 *IsMatched
= PxeBcCheckByDestIp (Mode
, Session
, DestIp
, OpFlags
);
1287 *IsMatched
= PxeBcCheckByDestPort (Mode
, Session
, DestPort
, OpFlags
);
1291 *IsMatched
= PxeBcFilterBySrcIp (Mode
, Session
, SrcIp
, OpFlags
);
1295 *IsMatched
= PxeBcFilterBySrcPort (Mode
, Session
, SrcPort
, OpFlags
);
1298 if (!(*IsMatched
)) {
1300 // Recycle the receiving buffer if not matched.
1302 gBS
->SignalEvent (RxData
->RecycleSignal
);
1311 This function is to display the IPv4 address.
1313 @param[in] Ip The pointer to the IPv4 address.
1318 IN EFI_IPv4_ADDRESS
*Ip
1323 for (Index
= 0; Index
< 4; Index
++) {
1324 AsciiPrint ("%d", Ip
->Addr
[Index
]);
1333 This function is to display the IPv6 address.
1335 @param[in] Ip The pointer to the IPv6 address.
1340 IN EFI_IPv6_ADDRESS
*Ip
1345 for (Index
= 0; Index
< 16; Index
++) {
1347 if (Ip
->Addr
[Index
] != 0) {
1348 AsciiPrint ("%x", Ip
->Addr
[Index
]);
1354 if (((Ip
->Addr
[Index
] & 0xf0) == 0) && (Ip
->Addr
[Index
- 1] != 0)) {
1357 AsciiPrint ("%x", Ip
->Addr
[Index
]);
1366 This function is to convert UINTN to ASCII string with the required formatting.
1368 @param[in] Number Numeric value to be converted.
1369 @param[in] Buffer The pointer to the buffer for ASCII string.
1370 @param[in] Length The length of the required format.
1374 PxeBcUintnToAscDecWithFormat (
1382 for (; Length
> 0; Length
--) {
1383 Remainder
= Number
% 10;
1385 Buffer
[Length
- 1] = (UINT8
) ('0' + Remainder
);
1391 This function is to convert a UINTN to a ASCII string, and return the
1392 actual length of the buffer.
1394 @param[in] Number Numeric value to be converted.
1395 @param[in] Buffer The pointer to the buffer for ASCII string.
1396 @param[in] BufferSize The maxsize of the buffer.
1398 @return Length The actual length of the ASCII string.
1402 PxeBcUintnToAscDec (
1417 TempStr
[Index
] = (CHAR8
) ('0' + (Number
% 10));
1418 Number
= (UINTN
) (Number
/ 10);
1419 } while (Number
!= 0);
1421 AsciiStrCpyS ((CHAR8
*) Buffer
, BufferSize
, &TempStr
[Index
]);
1423 Length
= AsciiStrLen ((CHAR8
*) Buffer
);
1430 This function is to convert unicode hex number to a UINT8.
1432 @param[out] Digit The converted UINT8 for output.
1433 @param[in] Char The unicode hex number to be converted.
1435 @retval EFI_SUCCESS Successfully converted the unicode hex.
1436 @retval EFI_INVALID_PARAMETER Failed to convert the unicode hex.
1440 PxeBcUniHexToUint8 (
1445 if ((Char
>= L
'0') && (Char
<= L
'9')) {
1446 *Digit
= (UINT8
) (Char
- L
'0');
1450 if ((Char
>= L
'A') && (Char
<= L
'F')) {
1451 *Digit
= (UINT8
) (Char
- L
'A' + 0x0A);
1455 if ((Char
>= L
'a') && (Char
<= L
'f')) {
1456 *Digit
= (UINT8
) (Char
- L
'a' + 0x0A);
1460 return EFI_INVALID_PARAMETER
;
1464 Calculate the elapsed time.
1466 @param[in] Private The pointer to PXE private data
1471 IN PXEBC_PRIVATE_DATA
*Private
1475 UINT64 CurrentStamp
;
1476 UINT64 ElapsedTimeValue
;
1479 // Generate a time stamp of the centiseconds from 1900/1/1, assume 30day/month.
1481 ZeroMem (&Time
, sizeof (EFI_TIME
));
1482 gRT
->GetTime (&Time
, NULL
);
1483 CurrentStamp
= (UINT64
)
1485 ((((((Time
.Year
- 1900) * 360 +
1486 (Time
.Month
- 1)) * 30 +
1487 (Time
.Day
- 1)) * 24 + Time
.Hour
) * 60 +
1488 Time
.Minute
) * 60 + Time
.Second
) * 100
1489 + DivU64x32(Time
.Nanosecond
, 10000000)
1493 // Sentinel value of 0 means that this is the first DHCP packet that we are
1494 // sending and that we need to initialize the value. First DHCP Solicit
1495 // gets 0 elapsed-time. Otherwise, calculate based on StartTime.
1497 if (Private
->ElapsedTime
== 0) {
1498 Private
->ElapsedTime
= CurrentStamp
;
1500 ElapsedTimeValue
= CurrentStamp
- Private
->ElapsedTime
;
1503 // If elapsed time cannot fit in two bytes, set it to 0xffff.
1505 if (ElapsedTimeValue
> 0xffff) {
1506 ElapsedTimeValue
= 0xffff;
1509 // Save the elapsed time
1511 Private
->ElapsedTime
= ElapsedTimeValue
;