4 (C) Copyright 2014 Hewlett-Packard Development Company, L.P.<BR>
5 Copyright (c) 2005 - 2009, 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.
17 #include <Protocol/Udp4.h>
19 #include <Library/IpIoLib.h>
20 #include <Library/BaseLib.h>
21 #include <Library/DebugLib.h>
22 #include <Library/BaseMemoryLib.h>
23 #include <Library/UefiBootServicesTableLib.h>
24 #include <Library/MemoryAllocationLib.h>
25 #include <Library/DpcLib.h>
28 GLOBAL_REMOVE_IF_UNREFERENCED LIST_ENTRY mActiveIpIoList
= {
33 GLOBAL_REMOVE_IF_UNREFERENCED EFI_IP4_CONFIG_DATA mIp4IoDefaultIpConfigData
= {
50 GLOBAL_REMOVE_IF_UNREFERENCED EFI_IP6_CONFIG_DATA mIp6IoDefaultIpConfigData
= {
55 {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
56 {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
64 GLOBAL_REMOVE_IF_UNREFERENCED ICMP_ERROR_INFO mIcmpErrMap
[10] = {
65 {FALSE
, TRUE
}, // ICMP_ERR_UNREACH_NET
66 {FALSE
, TRUE
}, // ICMP_ERR_UNREACH_HOST
67 {TRUE
, TRUE
}, // ICMP_ERR_UNREACH_PROTOCOL
68 {TRUE
, TRUE
}, // ICMP_ERR_UNREACH_PORT
69 {TRUE
, TRUE
}, // ICMP_ERR_MSGSIZE
70 {FALSE
, TRUE
}, // ICMP_ERR_UNREACH_SRCFAIL
71 {FALSE
, TRUE
}, // ICMP_ERR_TIMXCEED_INTRANS
72 {FALSE
, TRUE
}, // ICMP_ERR_TIMEXCEED_REASS
73 {FALSE
, FALSE
}, // ICMP_ERR_QUENCH
74 {FALSE
, TRUE
} // ICMP_ERR_PARAMPROB
77 GLOBAL_REMOVE_IF_UNREFERENCED ICMP_ERROR_INFO mIcmp6ErrMap
[10] = {
78 {FALSE
, TRUE
}, // ICMP6_ERR_UNREACH_NET
79 {FALSE
, TRUE
}, // ICMP6_ERR_UNREACH_HOST
80 {TRUE
, TRUE
}, // ICMP6_ERR_UNREACH_PROTOCOL
81 {TRUE
, TRUE
}, // ICMP6_ERR_UNREACH_PORT
82 {TRUE
, TRUE
}, // ICMP6_ERR_PACKAGE_TOOBIG
83 {FALSE
, TRUE
}, // ICMP6_ERR_TIMXCEED_HOPLIMIT
84 {FALSE
, TRUE
}, // ICMP6_ERR_TIMXCEED_REASS
85 {FALSE
, TRUE
}, // ICMP6_ERR_PARAMPROB_HEADER
86 {FALSE
, TRUE
}, // ICMP6_ERR_PARAMPROB_NEXHEADER
87 {FALSE
, TRUE
} // ICMP6_ERR_PARAMPROB_IPV6OPTION
92 Notify function for IP transmit token.
94 @param[in] Context The context passed in by the event notifier.
99 IpIoTransmitHandlerDpc (
105 Notify function for IP transmit token.
107 @param[in] Event The event signaled.
108 @param[in] Context The context passed in by the event notifier.
113 IpIoTransmitHandler (
120 This function create an IP child ,open the IP protocol, and return the opened
121 IP protocol as Interface.
123 @param[in] ControllerHandle The controller handle.
124 @param[in] ImageHandle The image handle.
125 @param[in] ChildHandle Pointer to the buffer to save the IP child handle.
126 @param[in] IpVersion The version of the IP protocol to use, either
128 @param[out] Interface Pointer used to get the IP protocol interface.
130 @retval EFI_SUCCESS The IP child is created and the IP protocol
131 interface is retrieved.
132 @retval Others The required operation failed.
136 IpIoCreateIpChildOpenProtocol (
137 IN EFI_HANDLE ControllerHandle
,
138 IN EFI_HANDLE ImageHandle
,
139 IN EFI_HANDLE
*ChildHandle
,
145 EFI_GUID
*ServiceBindingGuid
;
146 EFI_GUID
*IpProtocolGuid
;
148 if (IpVersion
== IP_VERSION_4
) {
149 ServiceBindingGuid
= &gEfiIp4ServiceBindingProtocolGuid
;
150 IpProtocolGuid
= &gEfiIp4ProtocolGuid
;
151 } else if (IpVersion
== IP_VERSION_6
){
152 ServiceBindingGuid
= &gEfiIp6ServiceBindingProtocolGuid
;
153 IpProtocolGuid
= &gEfiIp6ProtocolGuid
;
155 return EFI_UNSUPPORTED
;
159 // Create an IP child.
161 Status
= NetLibCreateServiceChild (
167 if (EFI_ERROR (Status
)) {
172 // Open the IP protocol installed on the *ChildHandle.
174 Status
= gBS
->OpenProtocol (
180 EFI_OPEN_PROTOCOL_BY_DRIVER
182 if (EFI_ERROR (Status
)) {
184 // On failure, destroy the IP child.
186 NetLibDestroyServiceChild (
199 This function close the previously openned IP protocol and destroy the IP child.
201 @param[in] ControllerHandle The controller handle.
202 @param[in] ImageHandle The image handle.
203 @param[in] ChildHandle The child handle of the IP child.
204 @param[in] IpVersion The version of the IP protocol to use, either
207 @retval EFI_SUCCESS The IP protocol is closed and the relevant IP child
209 @retval Others The required operation failed.
213 IpIoCloseProtocolDestroyIpChild (
214 IN EFI_HANDLE ControllerHandle
,
215 IN EFI_HANDLE ImageHandle
,
216 IN EFI_HANDLE ChildHandle
,
221 EFI_GUID
*ServiceBindingGuid
;
222 EFI_GUID
*IpProtocolGuid
;
224 if (IpVersion
== IP_VERSION_4
) {
225 ServiceBindingGuid
= &gEfiIp4ServiceBindingProtocolGuid
;
226 IpProtocolGuid
= &gEfiIp4ProtocolGuid
;
227 } else if (IpVersion
== IP_VERSION_6
) {
228 ServiceBindingGuid
= &gEfiIp6ServiceBindingProtocolGuid
;
229 IpProtocolGuid
= &gEfiIp6ProtocolGuid
;
231 return EFI_UNSUPPORTED
;
235 // Close the previously openned IP protocol.
245 // Destroy the IP child.
247 Status
= NetLibDestroyServiceChild (
258 This function handles ICMPv4 packets. It is the worker function of
261 @param[in] IpIo Pointer to the IP_IO instance.
262 @param[in, out] Pkt Pointer to the ICMPv4 packet.
263 @param[in] Session Pointer to the net session of this ICMPv4 packet.
265 @retval EFI_SUCCESS The ICMPv4 packet is handled successfully.
266 @retval EFI_ABORTED This type of ICMPv4 packet is not supported.
273 IN EFI_NET_SESSION_DATA
*Session
276 IP4_ICMP_ERROR_HEAD
*IcmpHdr
;
277 EFI_IP4_HEADER
*IpHdr
;
284 ASSERT (IpIo
->IpVersion
== IP_VERSION_4
);
286 IcmpHdr
= NET_PROTO_HDR (Pkt
, IP4_ICMP_ERROR_HEAD
);
287 IpHdr
= (EFI_IP4_HEADER
*) (&IcmpHdr
->IpHead
);
290 // Check the ICMP packet length.
292 if (Pkt
->TotalSize
< ICMP_ERRLEN (IpHdr
)) {
297 Type
= IcmpHdr
->Head
.Type
;
298 Code
= IcmpHdr
->Head
.Code
;
301 // Analyze the ICMP Error in this ICMP pkt
304 case ICMP_TYPE_UNREACH
:
306 case ICMP_CODE_UNREACH_NET
:
307 case ICMP_CODE_UNREACH_HOST
:
308 case ICMP_CODE_UNREACH_PROTOCOL
:
309 case ICMP_CODE_UNREACH_PORT
:
310 case ICMP_CODE_UNREACH_SRCFAIL
:
311 IcmpErr
= (UINT8
) (ICMP_ERR_UNREACH_NET
+ Code
);
315 case ICMP_CODE_UNREACH_NEEDFRAG
:
316 IcmpErr
= ICMP_ERR_MSGSIZE
;
320 case ICMP_CODE_UNREACH_NET_UNKNOWN
:
321 case ICMP_CODE_UNREACH_NET_PROHIB
:
322 case ICMP_CODE_UNREACH_TOSNET
:
323 IcmpErr
= ICMP_ERR_UNREACH_NET
;
327 case ICMP_CODE_UNREACH_HOST_UNKNOWN
:
328 case ICMP_CODE_UNREACH_ISOLATED
:
329 case ICMP_CODE_UNREACH_HOST_PROHIB
:
330 case ICMP_CODE_UNREACH_TOSHOST
:
331 IcmpErr
= ICMP_ERR_UNREACH_HOST
;
341 case ICMP_TYPE_TIMXCEED
:
346 IcmpErr
= (UINT8
) (Code
+ ICMP_ERR_TIMXCEED_INTRANS
);
350 case ICMP_TYPE_PARAMPROB
:
355 IcmpErr
= ICMP_ERR_PARAMPROB
;
359 case ICMP_TYPE_SOURCEQUENCH
:
364 IcmpErr
= ICMP_ERR_QUENCH
;
373 // Notify user the ICMP pkt only containing payload except
374 // IP and ICMP header
376 PayLoadHdr
= (UINT8
*) ((UINT8
*) IpHdr
+ EFI_IP4_HEADER_LEN (IpHdr
));
377 TrimBytes
= (UINT32
) (PayLoadHdr
- (UINT8
*) IcmpHdr
);
379 NetbufTrim (Pkt
, TrimBytes
, TRUE
);
381 IpIo
->PktRcvdNotify (EFI_ICMP_ERROR
, IcmpErr
, Session
, Pkt
, IpIo
->RcvdContext
);
387 This function handles ICMPv6 packets. It is the worker function of
390 @param[in] IpIo Pointer to the IP_IO instance.
391 @param[in, out] Pkt Pointer to the ICMPv6 packet.
392 @param[in] Session Pointer to the net session of this ICMPv6 packet.
394 @retval EFI_SUCCESS The ICMPv6 packet is handled successfully.
395 @retval EFI_ABORTED This type of ICMPv6 packet is not supported.
402 IN EFI_NET_SESSION_DATA
*Session
405 IP6_ICMP_ERROR_HEAD
*IcmpHdr
;
406 EFI_IP6_HEADER
*IpHdr
;
415 ASSERT (IpIo
->IpVersion
== IP_VERSION_6
);
418 // Check the ICMPv6 packet length.
420 if (Pkt
->TotalSize
< sizeof (IP6_ICMP_ERROR_HEAD
)) {
425 IcmpHdr
= NET_PROTO_HDR (Pkt
, IP6_ICMP_ERROR_HEAD
);
426 Type
= IcmpHdr
->Head
.Type
;
427 Code
= IcmpHdr
->Head
.Code
;
430 // Analyze the ICMPv6 Error in this ICMPv6 packet
433 case ICMP_V6_DEST_UNREACHABLE
:
435 case ICMP_V6_NO_ROUTE_TO_DEST
:
436 case ICMP_V6_BEYOND_SCOPE
:
437 case ICMP_V6_ROUTE_REJECTED
:
438 IcmpErr
= ICMP6_ERR_UNREACH_NET
;
442 case ICMP_V6_COMM_PROHIBITED
:
443 case ICMP_V6_ADDR_UNREACHABLE
:
444 case ICMP_V6_SOURCE_ADDR_FAILED
:
445 IcmpErr
= ICMP6_ERR_UNREACH_HOST
;
449 case ICMP_V6_PORT_UNREACHABLE
:
450 IcmpErr
= ICMP6_ERR_UNREACH_PORT
;
460 case ICMP_V6_PACKET_TOO_BIG
:
465 IcmpErr
= ICMP6_ERR_PACKAGE_TOOBIG
;
469 case ICMP_V6_TIME_EXCEEDED
:
474 IcmpErr
= (UINT8
) (ICMP6_ERR_TIMXCEED_HOPLIMIT
+ Code
);
478 case ICMP_V6_PARAMETER_PROBLEM
:
483 IcmpErr
= (UINT8
) (ICMP6_ERR_PARAMPROB_HEADER
+ Code
);
493 // Notify user the ICMPv6 packet only containing payload except
494 // IPv6 basic header, extension header and ICMP header
497 IpHdr
= (EFI_IP6_HEADER
*) (&IcmpHdr
->IpHead
);
498 NextHeader
= IpHdr
->NextHeader
;
499 PayLoadHdr
= (UINT8
*) ((UINT8
*) IcmpHdr
+ sizeof (IP6_ICMP_ERROR_HEAD
));
503 switch (NextHeader
) {
504 case EFI_IP_PROTO_UDP
:
505 case EFI_IP_PROTO_TCP
:
506 case EFI_IP_PROTO_ICMP
:
507 case IP6_NO_NEXT_HEADER
:
513 case IP6_DESTINATION
:
515 // The Hdr Ext Len is 8-bit unsigned integer in 8-octet units, not including
516 // the first 8 octets.
518 NextHeader
= *(PayLoadHdr
);
519 PayLoadHdr
= (UINT8
*) (PayLoadHdr
+ (*(PayLoadHdr
+ 1) + 1) * 8);
525 // The Fragment Header Length is 8 octets.
527 NextHeader
= *(PayLoadHdr
);
528 PayLoadHdr
= (UINT8
*) (PayLoadHdr
+ 8);
538 TrimBytes
= (UINT32
) (PayLoadHdr
- (UINT8
*) IcmpHdr
);
540 NetbufTrim (Pkt
, TrimBytes
, TRUE
);
542 IpIo
->PktRcvdNotify (EFI_ICMP_ERROR
, IcmpErr
, Session
, Pkt
, IpIo
->RcvdContext
);
548 This function handles ICMP packets.
550 @param[in] IpIo Pointer to the IP_IO instance.
551 @param[in, out] Pkt Pointer to the ICMP packet.
552 @param[in] Session Pointer to the net session of this ICMP packet.
554 @retval EFI_SUCCESS The ICMP packet is handled successfully.
555 @retval EFI_ABORTED This type of ICMP packet is not supported.
556 @retval EFI_UNSUPPORTED The IP protocol version in IP_IO is not supported.
563 IN EFI_NET_SESSION_DATA
*Session
567 if (IpIo
->IpVersion
== IP_VERSION_4
) {
569 return IpIoIcmpv4Handler (IpIo
, Pkt
, Session
);
571 } else if (IpIo
->IpVersion
== IP_VERSION_6
) {
573 return IpIoIcmpv6Handler (IpIo
, Pkt
, Session
);
577 return EFI_UNSUPPORTED
;
583 Free function for receive token of IP_IO. It is used to
584 signal the recycle event to notify IP to recycle the
587 @param[in] Event The event to be signaled.
596 gBS
->SignalEvent ((EFI_EVENT
) Event
);
601 Create a send entry to wrap a packet before sending
604 @param[in, out] IpIo Pointer to the IP_IO instance.
605 @param[in, out] Pkt Pointer to the packet.
606 @param[in] Sender Pointer to the IP sender.
607 @param[in] Context Pointer to the context.
608 @param[in] NotifyData Pointer to the notify data.
609 @param[in] Dest Pointer to the destination IP address.
610 @param[in] Override Pointer to the overriden IP_IO data.
612 @return Pointer to the data structure created to wrap the packet. If NULL,
613 @return resource limit occurred.
620 IN IP_IO_IP_PROTOCOL Sender
,
621 IN VOID
*Context OPTIONAL
,
622 IN VOID
*NotifyData OPTIONAL
,
623 IN EFI_IP_ADDRESS
*Dest OPTIONAL
,
624 IN IP_IO_OVERRIDE
*Override
627 IP_IO_SEND_ENTRY
*SndEntry
;
630 NET_FRAGMENT
*ExtFragment
;
631 UINT32 FragmentCount
;
632 IP_IO_OVERRIDE
*OverrideData
;
633 IP_IO_IP_TX_DATA
*TxData
;
634 EFI_IP4_TRANSMIT_DATA
*Ip4TxData
;
635 EFI_IP6_TRANSMIT_DATA
*Ip6TxData
;
637 if ((IpIo
->IpVersion
!= IP_VERSION_4
) && (IpIo
->IpVersion
!= IP_VERSION_6
)) {
646 // Allocate resource for SndEntry
648 SndEntry
= AllocatePool (sizeof (IP_IO_SEND_ENTRY
));
649 if (NULL
== SndEntry
) {
653 Status
= gBS
->CreateEvent (
660 if (EFI_ERROR (Status
)) {
664 FragmentCount
= Pkt
->BlockOpNum
;
667 // Allocate resource for TxData
669 TxData
= (IP_IO_IP_TX_DATA
*) AllocatePool (
670 sizeof (IP_IO_IP_TX_DATA
) + sizeof (NET_FRAGMENT
) * (FragmentCount
- 1)
673 if (NULL
== TxData
) {
678 // Build a fragment table to contain the fragments in the packet.
680 if (IpIo
->IpVersion
== IP_VERSION_4
) {
681 ExtFragment
= (NET_FRAGMENT
*) TxData
->Ip4TxData
.FragmentTable
;
683 ExtFragment
= (NET_FRAGMENT
*) TxData
->Ip6TxData
.FragmentTable
;
686 NetbufBuildExt (Pkt
, ExtFragment
, &FragmentCount
);
690 // Allocate resource for OverrideData if needed
692 if (NULL
!= Override
) {
694 OverrideData
= AllocateCopyPool (sizeof (IP_IO_OVERRIDE
), Override
);
695 if (NULL
== OverrideData
) {
701 // Set other fields of TxData except the fragment table
703 if (IpIo
->IpVersion
== IP_VERSION_4
) {
705 Ip4TxData
= &TxData
->Ip4TxData
;
707 IP4_COPY_ADDRESS (&Ip4TxData
->DestinationAddress
, Dest
);
709 Ip4TxData
->OverrideData
= &OverrideData
->Ip4OverrideData
;
710 Ip4TxData
->OptionsLength
= 0;
711 Ip4TxData
->OptionsBuffer
= NULL
;
712 Ip4TxData
->TotalDataLength
= Pkt
->TotalSize
;
713 Ip4TxData
->FragmentCount
= FragmentCount
;
716 // Set the fields of SndToken
718 SndEntry
->SndToken
.Ip4Token
.Event
= Event
;
719 SndEntry
->SndToken
.Ip4Token
.Packet
.TxData
= Ip4TxData
;
722 Ip6TxData
= &TxData
->Ip6TxData
;
725 CopyMem (&Ip6TxData
->DestinationAddress
, Dest
, sizeof (EFI_IPv6_ADDRESS
));
727 ZeroMem (&Ip6TxData
->DestinationAddress
, sizeof (EFI_IPv6_ADDRESS
));
730 Ip6TxData
->OverrideData
= &OverrideData
->Ip6OverrideData
;
731 Ip6TxData
->DataLength
= Pkt
->TotalSize
;
732 Ip6TxData
->FragmentCount
= FragmentCount
;
733 Ip6TxData
->ExtHdrsLength
= 0;
734 Ip6TxData
->ExtHdrs
= NULL
;
737 // Set the fields of SndToken
739 SndEntry
->SndToken
.Ip6Token
.Event
= Event
;
740 SndEntry
->SndToken
.Ip6Token
.Packet
.TxData
= Ip6TxData
;
744 // Set the fields of SndEntry
746 SndEntry
->IpIo
= IpIo
;
747 SndEntry
->Ip
= Sender
;
748 SndEntry
->Context
= Context
;
749 SndEntry
->NotifyData
= NotifyData
;
754 InsertTailList (&IpIo
->PendingSndList
, &SndEntry
->Entry
);
760 if (OverrideData
!= NULL
) {
761 FreePool (OverrideData
);
764 if (TxData
!= NULL
) {
768 if (SndEntry
!= NULL
) {
773 gBS
->CloseEvent (Event
);
781 Destroy the SndEntry.
783 This function pairs with IpIoCreateSndEntry().
785 @param[in] SndEntry Pointer to the send entry to be destroyed.
789 IpIoDestroySndEntry (
790 IN IP_IO_SEND_ENTRY
*SndEntry
794 IP_IO_IP_TX_DATA
*TxData
;
795 IP_IO_OVERRIDE
*Override
;
797 if (SndEntry
->IpIo
->IpVersion
== IP_VERSION_4
) {
798 Event
= SndEntry
->SndToken
.Ip4Token
.Event
;
799 TxData
= (IP_IO_IP_TX_DATA
*) SndEntry
->SndToken
.Ip4Token
.Packet
.TxData
;
800 Override
= (IP_IO_OVERRIDE
*) TxData
->Ip4TxData
.OverrideData
;
801 } else if (SndEntry
->IpIo
->IpVersion
== IP_VERSION_6
) {
802 Event
= SndEntry
->SndToken
.Ip6Token
.Event
;
803 TxData
= (IP_IO_IP_TX_DATA
*) SndEntry
->SndToken
.Ip6Token
.Packet
.TxData
;
804 Override
= (IP_IO_OVERRIDE
*) TxData
->Ip6TxData
.OverrideData
;
809 gBS
->CloseEvent (Event
);
813 if (NULL
!= Override
) {
817 NetbufFree (SndEntry
->Pkt
);
819 RemoveEntryList (&SndEntry
->Entry
);
826 Notify function for IP transmit token.
828 @param[in] Context The context passed in by the event notifier.
833 IpIoTransmitHandlerDpc (
838 IP_IO_SEND_ENTRY
*SndEntry
;
841 SndEntry
= (IP_IO_SEND_ENTRY
*) Context
;
843 IpIo
= SndEntry
->IpIo
;
845 if (IpIo
->IpVersion
== IP_VERSION_4
) {
846 Status
= SndEntry
->SndToken
.Ip4Token
.Status
;
847 } else if (IpIo
->IpVersion
== IP_VERSION_6
){
848 Status
= SndEntry
->SndToken
.Ip6Token
.Status
;
853 if ((IpIo
->PktSentNotify
!= NULL
) && (SndEntry
->NotifyData
!= NULL
)) {
854 IpIo
->PktSentNotify (
862 IpIoDestroySndEntry (SndEntry
);
867 Notify function for IP transmit token.
869 @param[in] Event The event signaled.
870 @param[in] Context The context passed in by the event notifier.
875 IpIoTransmitHandler (
881 // Request IpIoTransmitHandlerDpc as a DPC at TPL_CALLBACK
883 QueueDpc (TPL_CALLBACK
, IpIoTransmitHandlerDpc
, Context
);
888 The dummy handler for the dummy IP receive token.
890 @param[in] Context The context passed in by the event notifier.
895 IpIoDummyHandlerDpc (
899 IP_IO_IP_INFO
*IpInfo
;
901 EFI_EVENT RecycleEvent
;
903 IpInfo
= (IP_IO_IP_INFO
*) Context
;
905 if ((IpInfo
->IpVersion
!= IP_VERSION_4
) && (IpInfo
->IpVersion
!= IP_VERSION_6
)) {
911 if (IpInfo
->IpVersion
== IP_VERSION_4
) {
912 Status
= IpInfo
->DummyRcvToken
.Ip4Token
.Status
;
914 if (IpInfo
->DummyRcvToken
.Ip4Token
.Packet
.RxData
!= NULL
) {
915 RecycleEvent
= IpInfo
->DummyRcvToken
.Ip4Token
.Packet
.RxData
->RecycleSignal
;
918 Status
= IpInfo
->DummyRcvToken
.Ip6Token
.Status
;
920 if (IpInfo
->DummyRcvToken
.Ip6Token
.Packet
.RxData
!= NULL
) {
921 RecycleEvent
= IpInfo
->DummyRcvToken
.Ip6Token
.Packet
.RxData
->RecycleSignal
;
927 if (EFI_ABORTED
== Status
) {
929 // The reception is actively aborted by the consumer, directly return.
932 } else if (EFI_SUCCESS
== Status
) {
934 // Recycle the RxData.
936 ASSERT (RecycleEvent
!= NULL
);
938 gBS
->SignalEvent (RecycleEvent
);
942 // Continue the receive.
944 if (IpInfo
->IpVersion
== IP_VERSION_4
) {
945 IpInfo
->Ip
.Ip4
->Receive (
947 &IpInfo
->DummyRcvToken
.Ip4Token
950 IpInfo
->Ip
.Ip6
->Receive (
952 &IpInfo
->DummyRcvToken
.Ip6Token
959 This function add IpIoDummyHandlerDpc to the end of the DPC queue.
961 @param[in] Event The event signaled.
962 @param[in] Context The context passed in by the event notifier.
973 // Request IpIoDummyHandlerDpc as a DPC at TPL_CALLBACK
975 QueueDpc (TPL_CALLBACK
, IpIoDummyHandlerDpc
, Context
);
980 Notify function for the IP receive token, used to process
981 the received IP packets.
983 @param[in] Context The context passed in by the event notifier.
988 IpIoListenHandlerDpc (
994 IP_IO_IP_RX_DATA
*RxData
;
995 EFI_NET_SESSION_DATA Session
;
998 IpIo
= (IP_IO
*) Context
;
1000 if (IpIo
->IpVersion
== IP_VERSION_4
) {
1001 Status
= IpIo
->RcvToken
.Ip4Token
.Status
;
1002 RxData
= (IP_IO_IP_RX_DATA
*) IpIo
->RcvToken
.Ip4Token
.Packet
.RxData
;
1003 } else if (IpIo
->IpVersion
== IP_VERSION_6
) {
1004 Status
= IpIo
->RcvToken
.Ip6Token
.Status
;
1005 RxData
= (IP_IO_IP_RX_DATA
*) IpIo
->RcvToken
.Ip6Token
.Packet
.RxData
;
1010 if (EFI_ABORTED
== Status
) {
1012 // The reception is actively aborted by the consumer, directly return.
1017 if (((EFI_SUCCESS
!= Status
) && (EFI_ICMP_ERROR
!= Status
)) || (NULL
== RxData
)) {
1019 // @bug Only process the normal packets and the icmp error packets, if RxData is NULL
1020 // @bug with Status == EFI_SUCCESS or EFI_ICMP_ERROR, just resume the receive although
1021 // @bug this should be a bug of the low layer (IP).
1026 if (NULL
== IpIo
->PktRcvdNotify
) {
1030 if (IpIo
->IpVersion
== IP_VERSION_4
) {
1031 if ((EFI_IP4 (RxData
->Ip4RxData
.Header
->SourceAddress
) != 0) &&
1032 !NetIp4IsUnicast (EFI_NTOHL (((EFI_IP4_RECEIVE_DATA
*) RxData
)->Header
->SourceAddress
), 0)) {
1034 // The source address is not zero and it's not a unicast IP address, discard it.
1040 // Create a netbuffer representing IPv4 packet
1042 Pkt
= NetbufFromExt (
1043 (NET_FRAGMENT
*) RxData
->Ip4RxData
.FragmentTable
,
1044 RxData
->Ip4RxData
.FragmentCount
,
1048 RxData
->Ip4RxData
.RecycleSignal
1055 // Create a net session
1057 Session
.Source
.Addr
[0] = EFI_IP4 (RxData
->Ip4RxData
.Header
->SourceAddress
);
1058 Session
.Dest
.Addr
[0] = EFI_IP4 (RxData
->Ip4RxData
.Header
->DestinationAddress
);
1059 Session
.IpHdr
.Ip4Hdr
= RxData
->Ip4RxData
.Header
;
1060 Session
.IpHdrLen
= RxData
->Ip4RxData
.HeaderLength
;
1061 Session
.IpVersion
= IP_VERSION_4
;
1064 if (!NetIp6IsValidUnicast(&RxData
->Ip6RxData
.Header
->SourceAddress
)) {
1069 // Create a netbuffer representing IPv6 packet
1071 Pkt
= NetbufFromExt (
1072 (NET_FRAGMENT
*) RxData
->Ip6RxData
.FragmentTable
,
1073 RxData
->Ip6RxData
.FragmentCount
,
1077 RxData
->Ip6RxData
.RecycleSignal
1084 // Create a net session
1088 &RxData
->Ip6RxData
.Header
->SourceAddress
,
1089 sizeof(EFI_IPv6_ADDRESS
)
1093 &RxData
->Ip6RxData
.Header
->DestinationAddress
,
1094 sizeof(EFI_IPv6_ADDRESS
)
1096 Session
.IpHdr
.Ip6Hdr
= RxData
->Ip6RxData
.Header
;
1097 Session
.IpHdrLen
= RxData
->Ip6RxData
.HeaderLength
;
1098 Session
.IpVersion
= IP_VERSION_6
;
1101 if (EFI_SUCCESS
== Status
) {
1103 IpIo
->PktRcvdNotify (EFI_SUCCESS
, 0, &Session
, Pkt
, IpIo
->RcvdContext
);
1106 // Status is EFI_ICMP_ERROR
1108 Status
= IpIoIcmpHandler (IpIo
, Pkt
, &Session
);
1109 if (EFI_ERROR (Status
)) {
1118 if (IpIo
->IpVersion
== IP_VERSION_4
){
1119 gBS
->SignalEvent (RxData
->Ip4RxData
.RecycleSignal
);
1121 gBS
->SignalEvent (RxData
->Ip6RxData
.RecycleSignal
);
1126 if (IpIo
->IpVersion
== IP_VERSION_4
){
1127 IpIo
->Ip
.Ip4
->Receive (IpIo
->Ip
.Ip4
, &(IpIo
->RcvToken
.Ip4Token
));
1129 IpIo
->Ip
.Ip6
->Receive (IpIo
->Ip
.Ip6
, &(IpIo
->RcvToken
.Ip6Token
));
1134 This function add IpIoListenHandlerDpc to the end of the DPC queue.
1136 @param[in] Event The event signaled.
1137 @param[in] Context The context passed in by the event notifier.
1148 // Request IpIoListenHandlerDpc as a DPC at TPL_CALLBACK
1150 QueueDpc (TPL_CALLBACK
, IpIoListenHandlerDpc
, Context
);
1155 Create a new IP_IO instance.
1157 This function uses IP4/IP6 service binding protocol in Controller to create
1158 an IP4/IP6 child (aka IP4/IP6 instance).
1160 @param[in] Image The image handle of the driver or application that
1162 @param[in] Controller The controller handle that has IP4 or IP6 service
1163 binding protocol installed.
1164 @param[in] IpVersion The version of the IP protocol to use, either
1167 @return Pointer to a newly created IP_IO instance, or NULL if failed.
1173 IN EFI_HANDLE Image
,
1174 IN EFI_HANDLE Controller
,
1182 ASSERT ((IpVersion
== IP_VERSION_4
) || (IpVersion
== IP_VERSION_6
));
1184 IpIo
= AllocateZeroPool (sizeof (IP_IO
));
1189 InitializeListHead (&(IpIo
->PendingSndList
));
1190 InitializeListHead (&(IpIo
->IpList
));
1191 IpIo
->Controller
= Controller
;
1192 IpIo
->Image
= Image
;
1193 IpIo
->IpVersion
= IpVersion
;
1196 Status
= gBS
->CreateEvent (
1203 if (EFI_ERROR (Status
)) {
1207 if (IpVersion
== IP_VERSION_4
) {
1208 IpIo
->RcvToken
.Ip4Token
.Event
= Event
;
1210 IpIo
->RcvToken
.Ip6Token
.Event
= Event
;
1214 // Create an IP child and open IP protocol
1216 Status
= IpIoCreateIpChildOpenProtocol (
1221 (VOID
**)&(IpIo
->Ip
)
1223 if (EFI_ERROR (Status
)) {
1231 if (Event
!= NULL
) {
1232 gBS
->CloseEvent (Event
);
1235 gBS
->FreePool (IpIo
);
1242 Open an IP_IO instance for use.
1244 This function is called after IpIoCreate(). It is used for configuring the IP
1245 instance and register the callbacks and their context data for sending and
1246 receiving IP packets.
1248 @param[in, out] IpIo Pointer to an IP_IO instance that needs
1250 @param[in] OpenData The configuration data and callbacks for
1253 @retval EFI_SUCCESS The IP_IO instance opened with OpenData
1255 @retval EFI_ACCESS_DENIED The IP_IO instance is configured, avoid to
1257 @retval Others Error condition occurred.
1264 IN IP_IO_OPEN_DATA
*OpenData
1270 if (IpIo
->IsConfigured
) {
1271 return EFI_ACCESS_DENIED
;
1274 IpVersion
= IpIo
->IpVersion
;
1276 ASSERT ((IpVersion
== IP_VERSION_4
) || (IpVersion
== IP_VERSION_6
));
1281 if (IpVersion
== IP_VERSION_4
){
1282 Status
= IpIo
->Ip
.Ip4
->Configure (
1284 &OpenData
->IpConfigData
.Ip4CfgData
1288 Status
= IpIo
->Ip
.Ip6
->Configure (
1290 &OpenData
->IpConfigData
.Ip6CfgData
1294 if (EFI_ERROR (Status
)) {
1299 // @bug To delete the default route entry in this Ip, if it is:
1300 // @bug (0.0.0.0, 0.0.0.0, 0.0.0.0). Delete this statement if Ip modified
1303 if (IpVersion
== IP_VERSION_4
){
1304 Status
= IpIo
->Ip
.Ip4
->Routes (
1312 if (EFI_ERROR (Status
) && (EFI_NOT_FOUND
!= Status
)) {
1317 IpIo
->PktRcvdNotify
= OpenData
->PktRcvdNotify
;
1318 IpIo
->PktSentNotify
= OpenData
->PktSentNotify
;
1320 IpIo
->RcvdContext
= OpenData
->RcvdContext
;
1321 IpIo
->SndContext
= OpenData
->SndContext
;
1323 if (IpVersion
== IP_VERSION_4
){
1324 IpIo
->Protocol
= OpenData
->IpConfigData
.Ip4CfgData
.DefaultProtocol
;
1327 // start to listen incoming packet
1329 Status
= IpIo
->Ip
.Ip4
->Receive (
1331 &(IpIo
->RcvToken
.Ip4Token
)
1333 if (EFI_ERROR (Status
)) {
1334 IpIo
->Ip
.Ip4
->Configure (IpIo
->Ip
.Ip4
, NULL
);
1340 IpIo
->Protocol
= OpenData
->IpConfigData
.Ip6CfgData
.DefaultProtocol
;
1341 Status
= IpIo
->Ip
.Ip6
->Receive (
1343 &(IpIo
->RcvToken
.Ip6Token
)
1345 if (EFI_ERROR (Status
)) {
1346 IpIo
->Ip
.Ip6
->Configure (IpIo
->Ip
.Ip6
, NULL
);
1351 IpIo
->IsConfigured
= TRUE
;
1352 InsertTailList (&mActiveIpIoList
, &IpIo
->Entry
);
1361 Stop an IP_IO instance.
1363 This function is paired with IpIoOpen(). The IP_IO will be unconfigured and all
1364 the pending send/receive tokens will be canceled.
1366 @param[in, out] IpIo Pointer to the IP_IO instance that needs to stop.
1368 @retval EFI_SUCCESS The IP_IO instance stopped successfully.
1369 @retval Others Error condition occurred.
1379 IP_IO_IP_INFO
*IpInfo
;
1382 if (!IpIo
->IsConfigured
) {
1386 IpVersion
= IpIo
->IpVersion
;
1388 ASSERT ((IpVersion
== IP_VERSION_4
) || (IpVersion
== IP_VERSION_6
));
1391 // Remove the IpIo from the active IpIo list.
1393 RemoveEntryList (&IpIo
->Entry
);
1396 // Configure NULL Ip
1398 if (IpVersion
== IP_VERSION_4
) {
1399 Status
= IpIo
->Ip
.Ip4
->Configure (IpIo
->Ip
.Ip4
, NULL
);
1401 Status
= IpIo
->Ip
.Ip6
->Configure (IpIo
->Ip
.Ip6
, NULL
);
1403 if (EFI_ERROR (Status
)) {
1407 IpIo
->IsConfigured
= FALSE
;
1410 // Detroy the Ip List used by IpIo
1413 while (!IsListEmpty (&(IpIo
->IpList
))) {
1414 IpInfo
= NET_LIST_HEAD (&(IpIo
->IpList
), IP_IO_IP_INFO
, Entry
);
1416 IpIoRemoveIp (IpIo
, IpInfo
);
1420 // All pending send tokens should be flushed by reseting the IP instances.
1422 ASSERT (IsListEmpty (&IpIo
->PendingSndList
));
1425 // Close the receive event.
1427 if (IpVersion
== IP_VERSION_4
){
1428 gBS
->CloseEvent (IpIo
->RcvToken
.Ip4Token
.Event
);
1430 gBS
->CloseEvent (IpIo
->RcvToken
.Ip6Token
.Event
);
1438 Destroy an IP_IO instance.
1440 This function is paired with IpIoCreate(). The IP_IO will be closed first.
1441 Resource will be freed afterwards. See IpIoCloseProtocolDestroyIpChild().
1443 @param[in, out] IpIo Pointer to the IP_IO instance that needs to be
1446 @retval EFI_SUCCESS The IP_IO instance destroyed successfully.
1447 @retval Others Error condition occurred.
1462 // Close the IP protocol and destroy the child.
1464 IpIoCloseProtocolDestroyIpChild (
1471 gBS
->FreePool (IpIo
);
1478 Send out an IP packet.
1480 This function is called after IpIoOpen(). The data to be sent are wrapped in
1481 Pkt. The IP instance wrapped in IpIo is used for sending by default but can be
1482 overriden by Sender. Other sending configs, like source address and gateway
1483 address etc., are specified in OverrideData.
1485 @param[in, out] IpIo Pointer to an IP_IO instance used for sending IP
1487 @param[in, out] Pkt Pointer to the IP packet to be sent.
1488 @param[in] Sender The IP protocol instance used for sending.
1489 @param[in] Context Optional context data.
1490 @param[in] NotifyData Optional notify data.
1491 @param[in] Dest The destination IP address to send this packet to.
1492 @param[in] OverrideData The data to override some configuration of the IP
1493 instance used for sending.
1495 @retval EFI_SUCCESS The operation is completed successfully.
1496 @retval EFI_NOT_STARTED The IpIo is not configured.
1497 @retval EFI_OUT_OF_RESOURCES Failed due to resource limit.
1504 IN OUT NET_BUF
*Pkt
,
1505 IN IP_IO_IP_INFO
*Sender OPTIONAL
,
1506 IN VOID
*Context OPTIONAL
,
1507 IN VOID
*NotifyData OPTIONAL
,
1508 IN EFI_IP_ADDRESS
*Dest
,
1509 IN IP_IO_OVERRIDE
*OverrideData OPTIONAL
1513 IP_IO_IP_PROTOCOL Ip
;
1514 IP_IO_SEND_ENTRY
*SndEntry
;
1516 ASSERT ((IpIo
->IpVersion
!= IP_VERSION_4
) || (Dest
!= NULL
));
1518 if (!IpIo
->IsConfigured
) {
1519 return EFI_NOT_STARTED
;
1522 Ip
= (NULL
== Sender
) ? IpIo
->Ip
: Sender
->Ip
;
1525 // create a new SndEntry
1527 SndEntry
= IpIoCreateSndEntry (IpIo
, Pkt
, Ip
, Context
, NotifyData
, Dest
, OverrideData
);
1528 if (NULL
== SndEntry
) {
1529 return EFI_OUT_OF_RESOURCES
;
1535 if (IpIo
->IpVersion
== IP_VERSION_4
){
1536 Status
= Ip
.Ip4
->Transmit (
1538 &SndEntry
->SndToken
.Ip4Token
1541 Status
= Ip
.Ip6
->Transmit (
1543 &SndEntry
->SndToken
.Ip6Token
1547 if (EFI_ERROR (Status
)) {
1548 IpIoDestroySndEntry (SndEntry
);
1556 Cancel the IP transmit token which wraps this Packet.
1558 @param[in] IpIo Pointer to the IP_IO instance.
1559 @param[in] Packet Pointer to the packet of NET_BUF to cancel.
1570 IP_IO_SEND_ENTRY
*SndEntry
;
1571 IP_IO_IP_PROTOCOL Ip
;
1573 ASSERT ((IpIo
!= NULL
) && (Packet
!= NULL
));
1575 NET_LIST_FOR_EACH (Node
, &IpIo
->PendingSndList
) {
1577 SndEntry
= NET_LIST_USER_STRUCT (Node
, IP_IO_SEND_ENTRY
, Entry
);
1579 if (SndEntry
->Pkt
== Packet
) {
1583 if (IpIo
->IpVersion
== IP_VERSION_4
) {
1586 &SndEntry
->SndToken
.Ip4Token
1591 &SndEntry
->SndToken
.Ip6Token
1603 Add a new IP instance for sending data.
1605 The function is used to add the IP_IO to the IP_IO sending list. The caller
1606 can later use IpIoFindSender() to get the IP_IO and call IpIoSend() to send
1609 @param[in, out] IpIo Pointer to a IP_IO instance to add a new IP
1610 instance for sending purpose.
1612 @return Pointer to the created IP_IO_IP_INFO structure, NULL if failed.
1622 IP_IO_IP_INFO
*IpInfo
;
1625 ASSERT (IpIo
!= NULL
);
1627 IpInfo
= AllocatePool (sizeof (IP_IO_IP_INFO
));
1628 if (IpInfo
== NULL
) {
1633 // Init this IpInfo, set the Addr and SubnetMask to 0 before we configure the IP
1636 InitializeListHead (&IpInfo
->Entry
);
1637 IpInfo
->ChildHandle
= NULL
;
1638 ZeroMem (&IpInfo
->Addr
, sizeof (IpInfo
->Addr
));
1639 ZeroMem (&IpInfo
->PreMask
, sizeof (IpInfo
->PreMask
));
1642 IpInfo
->IpVersion
= IpIo
->IpVersion
;
1645 // Create the IP instance and open the IP protocol.
1647 Status
= IpIoCreateIpChildOpenProtocol (
1650 &IpInfo
->ChildHandle
,
1652 (VOID
**) &IpInfo
->Ip
1654 if (EFI_ERROR (Status
)) {
1659 // Create the event for the DummyRcvToken.
1661 Status
= gBS
->CreateEvent (
1668 if (EFI_ERROR (Status
)) {
1669 goto ReleaseIpChild
;
1672 if (IpInfo
->IpVersion
== IP_VERSION_4
) {
1673 IpInfo
->DummyRcvToken
.Ip4Token
.Event
= Event
;
1675 IpInfo
->DummyRcvToken
.Ip6Token
.Event
= Event
;
1679 // Link this IpInfo into the IpIo.
1681 InsertTailList (&IpIo
->IpList
, &IpInfo
->Entry
);
1687 IpIoCloseProtocolDestroyIpChild (
1690 IpInfo
->ChildHandle
,
1696 gBS
->FreePool (IpInfo
);
1703 Configure the IP instance of this IpInfo and start the receiving if IpConfigData
1706 @param[in, out] IpInfo Pointer to the IP_IO_IP_INFO instance.
1707 @param[in, out] IpConfigData The IP configure data used to configure the IP
1708 instance, if NULL the IP instance is reset. If
1709 UseDefaultAddress is set to TRUE, and the configure
1710 operation succeeds, the default address information
1711 is written back in this IpConfigData.
1713 @retval EFI_SUCCESS The IP instance of this IpInfo is configured successfully
1714 or no need to reconfigure it.
1715 @retval Others Configuration fails.
1721 IN OUT IP_IO_IP_INFO
*IpInfo
,
1722 IN OUT VOID
*IpConfigData OPTIONAL
1726 IP_IO_IP_PROTOCOL Ip
;
1728 EFI_IP4_MODE_DATA Ip4ModeData
;
1729 EFI_IP6_MODE_DATA Ip6ModeData
;
1731 ASSERT (IpInfo
!= NULL
);
1733 if (IpInfo
->RefCnt
> 1) {
1735 // This IP instance is shared, don't reconfigure it until it has only one
1736 // consumer. Currently, only the tcp children cloned from their passive parent
1737 // will share the same IP. So this cases only happens while IpConfigData is NULL,
1738 // let the last consumer clean the IP instance.
1743 IpVersion
= IpInfo
->IpVersion
;
1744 ASSERT ((IpVersion
== IP_VERSION_4
) || (IpVersion
== IP_VERSION_6
));
1748 if (IpInfo
->IpVersion
== IP_VERSION_4
) {
1749 Status
= Ip
.Ip4
->Configure (Ip
.Ip4
, IpConfigData
);
1751 Status
= Ip
.Ip6
->Configure (Ip
.Ip6
, IpConfigData
);
1754 if (EFI_ERROR (Status
)) {
1758 if (IpConfigData
!= NULL
) {
1759 if (IpInfo
->IpVersion
== IP_VERSION_4
){
1761 if (((EFI_IP4_CONFIG_DATA
*) IpConfigData
)->UseDefaultAddress
) {
1762 Ip
.Ip4
->GetModeData (
1769 IP4_COPY_ADDRESS (&((EFI_IP4_CONFIG_DATA
*) IpConfigData
)->StationAddress
, &Ip4ModeData
.ConfigData
.StationAddress
);
1770 IP4_COPY_ADDRESS (&((EFI_IP4_CONFIG_DATA
*) IpConfigData
)->SubnetMask
, &Ip4ModeData
.ConfigData
.SubnetMask
);
1775 &((EFI_IP4_CONFIG_DATA
*) IpConfigData
)->StationAddress
,
1779 &IpInfo
->PreMask
.SubnetMask
,
1780 &((EFI_IP4_CONFIG_DATA
*) IpConfigData
)->SubnetMask
,
1784 Status
= Ip
.Ip4
->Receive (
1786 &IpInfo
->DummyRcvToken
.Ip4Token
1788 if (EFI_ERROR (Status
)) {
1789 Ip
.Ip4
->Configure (Ip
.Ip4
, NULL
);
1792 Ip
.Ip6
->GetModeData (
1799 if (Ip6ModeData
.IsConfigured
) {
1801 &((EFI_IP6_CONFIG_DATA
*) IpConfigData
)->StationAddress
,
1802 &Ip6ModeData
.ConfigData
.StationAddress
,
1803 sizeof (EFI_IPv6_ADDRESS
)
1806 if (Ip6ModeData
.AddressList
!= NULL
) {
1807 FreePool (Ip6ModeData
.AddressList
);
1810 if (Ip6ModeData
.GroupTable
!= NULL
) {
1811 FreePool (Ip6ModeData
.GroupTable
);
1814 if (Ip6ModeData
.RouteTable
!= NULL
) {
1815 FreePool (Ip6ModeData
.RouteTable
);
1818 if (Ip6ModeData
.NeighborCache
!= NULL
) {
1819 FreePool (Ip6ModeData
.NeighborCache
);
1822 if (Ip6ModeData
.PrefixTable
!= NULL
) {
1823 FreePool (Ip6ModeData
.PrefixTable
);
1826 if (Ip6ModeData
.IcmpTypeList
!= NULL
) {
1827 FreePool (Ip6ModeData
.IcmpTypeList
);
1831 Status
= EFI_NO_MAPPING
;
1837 &Ip6ModeData
.ConfigData
.StationAddress
,
1838 sizeof (EFI_IPv6_ADDRESS
)
1841 Status
= Ip
.Ip6
->Receive (
1843 &IpInfo
->DummyRcvToken
.Ip6Token
1845 if (EFI_ERROR (Status
)) {
1846 Ip
.Ip6
->Configure (Ip
.Ip6
, NULL
);
1851 // The IP instance is reset, set the stored Addr and SubnetMask to zero.
1853 ZeroMem (&IpInfo
->Addr
, sizeof (IpInfo
->Addr
));
1854 ZeroMem (&IpInfo
->PreMask
, sizeof (IpInfo
->PreMask
));
1864 Destroy an IP instance maintained in IpIo->IpList for
1867 This function pairs with IpIoAddIp(). The IpInfo is previously created by
1868 IpIoAddIp(). The IP_IO_IP_INFO::RefCnt is decremented and the IP instance
1869 will be dstroyed if the RefCnt is zero.
1871 @param[in] IpIo Pointer to the IP_IO instance.
1872 @param[in] IpInfo Pointer to the IpInfo to be removed.
1879 IN IP_IO_IP_INFO
*IpInfo
1885 ASSERT (IpInfo
->RefCnt
> 0);
1887 NET_PUT_REF (IpInfo
);
1889 if (IpInfo
->RefCnt
> 0) {
1894 IpVersion
= IpIo
->IpVersion
;
1896 ASSERT ((IpVersion
== IP_VERSION_4
) || (IpVersion
== IP_VERSION_6
));
1898 RemoveEntryList (&IpInfo
->Entry
);
1900 if (IpVersion
== IP_VERSION_4
){
1901 IpInfo
->Ip
.Ip4
->Configure (
1905 IpIoCloseProtocolDestroyIpChild (
1908 IpInfo
->ChildHandle
,
1912 gBS
->CloseEvent (IpInfo
->DummyRcvToken
.Ip4Token
.Event
);
1916 IpInfo
->Ip
.Ip6
->Configure (
1921 IpIoCloseProtocolDestroyIpChild (
1924 IpInfo
->ChildHandle
,
1928 gBS
->CloseEvent (IpInfo
->DummyRcvToken
.Ip6Token
.Event
);
1936 Find the first IP protocol maintained in IpIo whose local
1937 address is the same as Src.
1939 This function is called when the caller needs the IpIo to send data to the
1940 specified Src. The IpIo was added previously by IpIoAddIp().
1942 @param[in, out] IpIo Pointer to the pointer of the IP_IO instance.
1943 @param[in] IpVersion The version of the IP protocol to use, either
1945 @param[in] Src The local IP address.
1947 @return Pointer to the IP protocol can be used for sending purpose and its local
1948 address is the same with Src.
1954 IN OUT IP_IO
**IpIo
,
1956 IN EFI_IP_ADDRESS
*Src
1959 LIST_ENTRY
*IpIoEntry
;
1961 LIST_ENTRY
*IpInfoEntry
;
1962 IP_IO_IP_INFO
*IpInfo
;
1964 ASSERT ((IpVersion
== IP_VERSION_4
) || (IpVersion
== IP_VERSION_6
));
1966 NET_LIST_FOR_EACH (IpIoEntry
, &mActiveIpIoList
) {
1967 IpIoPtr
= NET_LIST_USER_STRUCT (IpIoEntry
, IP_IO
, Entry
);
1969 if (((*IpIo
!= NULL
) && (*IpIo
!= IpIoPtr
)) || (IpIoPtr
->IpVersion
!= IpVersion
)) {
1973 NET_LIST_FOR_EACH (IpInfoEntry
, &IpIoPtr
->IpList
) {
1974 IpInfo
= NET_LIST_USER_STRUCT (IpInfoEntry
, IP_IO_IP_INFO
, Entry
);
1975 if (IpInfo
->IpVersion
== IP_VERSION_4
){
1977 if (EFI_IP4_EQUAL (&IpInfo
->Addr
.v4
, &Src
->v4
)) {
1984 if (EFI_IP6_EQUAL (&IpInfo
->Addr
.v6
, &Src
->v6
)) {
2001 Get the ICMP error map information.
2003 The ErrorStatus will be returned. The IsHard and Notify are optional. If they
2004 are not NULL, this routine will fill them.
2006 @param[in] IcmpError IcmpError Type.
2007 @param[in] IpVersion The version of the IP protocol to use,
2008 either IPv4 or IPv6.
2009 @param[out] IsHard If TRUE, indicates that it is a hard error.
2010 @param[out] Notify If TRUE, SockError needs to be notified.
2012 @return ICMP Error Status, such as EFI_NETWORK_UNREACHABLE.
2017 IpIoGetIcmpErrStatus (
2020 OUT BOOLEAN
*IsHard OPTIONAL
,
2021 OUT BOOLEAN
*Notify OPTIONAL
2024 if (IpVersion
== IP_VERSION_4
) {
2025 ASSERT (IcmpError
<= ICMP_ERR_PARAMPROB
);
2027 if (IsHard
!= NULL
) {
2028 *IsHard
= mIcmpErrMap
[IcmpError
].IsHard
;
2031 if (Notify
!= NULL
) {
2032 *Notify
= mIcmpErrMap
[IcmpError
].Notify
;
2035 switch (IcmpError
) {
2036 case ICMP_ERR_UNREACH_NET
:
2037 return EFI_NETWORK_UNREACHABLE
;
2039 case ICMP_ERR_TIMXCEED_INTRANS
:
2040 case ICMP_ERR_TIMXCEED_REASS
:
2041 case ICMP_ERR_UNREACH_HOST
:
2042 return EFI_HOST_UNREACHABLE
;
2044 case ICMP_ERR_UNREACH_PROTOCOL
:
2045 return EFI_PROTOCOL_UNREACHABLE
;
2047 case ICMP_ERR_UNREACH_PORT
:
2048 return EFI_PORT_UNREACHABLE
;
2050 case ICMP_ERR_MSGSIZE
:
2051 case ICMP_ERR_UNREACH_SRCFAIL
:
2052 case ICMP_ERR_QUENCH
:
2053 case ICMP_ERR_PARAMPROB
:
2054 return EFI_ICMP_ERROR
;
2058 return EFI_UNSUPPORTED
;
2061 } else if (IpVersion
== IP_VERSION_6
) {
2063 ASSERT (IcmpError
<= ICMP6_ERR_PARAMPROB_IPV6OPTION
);
2065 if (IsHard
!= NULL
) {
2066 *IsHard
= mIcmp6ErrMap
[IcmpError
].IsHard
;
2069 if (Notify
!= NULL
) {
2070 *Notify
= mIcmp6ErrMap
[IcmpError
].Notify
;
2073 switch (IcmpError
) {
2074 case ICMP6_ERR_UNREACH_NET
:
2075 return EFI_NETWORK_UNREACHABLE
;
2077 case ICMP6_ERR_UNREACH_HOST
:
2078 case ICMP6_ERR_TIMXCEED_HOPLIMIT
:
2079 case ICMP6_ERR_TIMXCEED_REASS
:
2080 return EFI_HOST_UNREACHABLE
;
2082 case ICMP6_ERR_UNREACH_PROTOCOL
:
2083 return EFI_PROTOCOL_UNREACHABLE
;
2085 case ICMP6_ERR_UNREACH_PORT
:
2086 return EFI_PORT_UNREACHABLE
;
2088 case ICMP6_ERR_PACKAGE_TOOBIG
:
2089 case ICMP6_ERR_PARAMPROB_HEADER
:
2090 case ICMP6_ERR_PARAMPROB_NEXHEADER
:
2091 case ICMP6_ERR_PARAMPROB_IPV6OPTION
:
2092 return EFI_ICMP_ERROR
;
2096 return EFI_UNSUPPORTED
;
2101 // Should never be here
2104 return EFI_UNSUPPORTED
;
2110 Refresh the remote peer's Neighbor Cache entries.
2112 This function is called when the caller needs the IpIo to refresh the existing
2113 IPv6 neighbor cache entries since the neighbor is considered reachable by the
2114 node has recently received a confirmation that packets sent recently to the
2115 neighbor were received by its IP layer.
2117 @param[in] IpIo Pointer to an IP_IO instance
2118 @param[in] Neighbor The IP address of the neighbor
2119 @param[in] Timeout Time in 100-ns units that this entry will
2120 remain in the neighbor cache. A value of
2121 zero means that the entry is permanent.
2122 A value of non-zero means that the entry is
2123 dynamic and will be deleted after Timeout.
2125 @retval EFI_SUCCESS The operation is completed successfully.
2126 @retval EFI_NOT_STARTED The IpIo is not configured.
2127 @retval EFI_INVALID_PARAMETER Neighbor Address is invalid.
2128 @retval EFI_NOT_FOUND The neighbor cache entry is not in the
2130 @retval EFI_OUT_OF_RESOURCES Failed due to resource limit.
2134 IpIoRefreshNeighbor (
2136 IN EFI_IP_ADDRESS
*Neighbor
,
2140 EFI_IP6_PROTOCOL
*Ip
;
2142 if (!IpIo
->IsConfigured
|| IpIo
->IpVersion
!= IP_VERSION_6
) {
2143 return EFI_NOT_STARTED
;
2148 return Ip
->Neighbors (Ip
, FALSE
, &Neighbor
->v6
, NULL
, Timeout
, TRUE
);