4 (C) Copyright 2014 Hewlett-Packard Development Company, L.P.<BR>
5 Copyright (c) 2005 - 2016, 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.
1039 if (RxData
->Ip4RxData
.DataLength
== 0) {
1041 // Discard zero length data payload packet.
1047 // Create a netbuffer representing IPv4 packet
1049 Pkt
= NetbufFromExt (
1050 (NET_FRAGMENT
*) RxData
->Ip4RxData
.FragmentTable
,
1051 RxData
->Ip4RxData
.FragmentCount
,
1055 RxData
->Ip4RxData
.RecycleSignal
1062 // Create a net session
1064 Session
.Source
.Addr
[0] = EFI_IP4 (RxData
->Ip4RxData
.Header
->SourceAddress
);
1065 Session
.Dest
.Addr
[0] = EFI_IP4 (RxData
->Ip4RxData
.Header
->DestinationAddress
);
1066 Session
.IpHdr
.Ip4Hdr
= RxData
->Ip4RxData
.Header
;
1067 Session
.IpHdrLen
= RxData
->Ip4RxData
.HeaderLength
;
1068 Session
.IpVersion
= IP_VERSION_4
;
1071 if (!NetIp6IsValidUnicast(&RxData
->Ip6RxData
.Header
->SourceAddress
)) {
1075 if (RxData
->Ip6RxData
.DataLength
== 0) {
1077 // Discard zero length data payload packet.
1083 // Create a netbuffer representing IPv6 packet
1085 Pkt
= NetbufFromExt (
1086 (NET_FRAGMENT
*) RxData
->Ip6RxData
.FragmentTable
,
1087 RxData
->Ip6RxData
.FragmentCount
,
1091 RxData
->Ip6RxData
.RecycleSignal
1098 // Create a net session
1102 &RxData
->Ip6RxData
.Header
->SourceAddress
,
1103 sizeof(EFI_IPv6_ADDRESS
)
1107 &RxData
->Ip6RxData
.Header
->DestinationAddress
,
1108 sizeof(EFI_IPv6_ADDRESS
)
1110 Session
.IpHdr
.Ip6Hdr
= RxData
->Ip6RxData
.Header
;
1111 Session
.IpHdrLen
= RxData
->Ip6RxData
.HeaderLength
;
1112 Session
.IpVersion
= IP_VERSION_6
;
1115 if (EFI_SUCCESS
== Status
) {
1117 IpIo
->PktRcvdNotify (EFI_SUCCESS
, 0, &Session
, Pkt
, IpIo
->RcvdContext
);
1120 // Status is EFI_ICMP_ERROR
1122 Status
= IpIoIcmpHandler (IpIo
, Pkt
, &Session
);
1123 if (EFI_ERROR (Status
)) {
1132 if (IpIo
->IpVersion
== IP_VERSION_4
){
1133 gBS
->SignalEvent (RxData
->Ip4RxData
.RecycleSignal
);
1135 gBS
->SignalEvent (RxData
->Ip6RxData
.RecycleSignal
);
1140 if (IpIo
->IpVersion
== IP_VERSION_4
){
1141 IpIo
->Ip
.Ip4
->Receive (IpIo
->Ip
.Ip4
, &(IpIo
->RcvToken
.Ip4Token
));
1143 IpIo
->Ip
.Ip6
->Receive (IpIo
->Ip
.Ip6
, &(IpIo
->RcvToken
.Ip6Token
));
1148 This function add IpIoListenHandlerDpc to the end of the DPC queue.
1150 @param[in] Event The event signaled.
1151 @param[in] Context The context passed in by the event notifier.
1162 // Request IpIoListenHandlerDpc as a DPC at TPL_CALLBACK
1164 QueueDpc (TPL_CALLBACK
, IpIoListenHandlerDpc
, Context
);
1169 Create a new IP_IO instance.
1171 This function uses IP4/IP6 service binding protocol in Controller to create
1172 an IP4/IP6 child (aka IP4/IP6 instance).
1174 @param[in] Image The image handle of the driver or application that
1176 @param[in] Controller The controller handle that has IP4 or IP6 service
1177 binding protocol installed.
1178 @param[in] IpVersion The version of the IP protocol to use, either
1181 @return Pointer to a newly created IP_IO instance, or NULL if failed.
1187 IN EFI_HANDLE Image
,
1188 IN EFI_HANDLE Controller
,
1196 ASSERT ((IpVersion
== IP_VERSION_4
) || (IpVersion
== IP_VERSION_6
));
1198 IpIo
= AllocateZeroPool (sizeof (IP_IO
));
1203 InitializeListHead (&(IpIo
->PendingSndList
));
1204 InitializeListHead (&(IpIo
->IpList
));
1205 IpIo
->Controller
= Controller
;
1206 IpIo
->Image
= Image
;
1207 IpIo
->IpVersion
= IpVersion
;
1210 Status
= gBS
->CreateEvent (
1217 if (EFI_ERROR (Status
)) {
1221 if (IpVersion
== IP_VERSION_4
) {
1222 IpIo
->RcvToken
.Ip4Token
.Event
= Event
;
1224 IpIo
->RcvToken
.Ip6Token
.Event
= Event
;
1228 // Create an IP child and open IP protocol
1230 Status
= IpIoCreateIpChildOpenProtocol (
1235 (VOID
**)&(IpIo
->Ip
)
1237 if (EFI_ERROR (Status
)) {
1245 if (Event
!= NULL
) {
1246 gBS
->CloseEvent (Event
);
1249 gBS
->FreePool (IpIo
);
1256 Open an IP_IO instance for use.
1258 This function is called after IpIoCreate(). It is used for configuring the IP
1259 instance and register the callbacks and their context data for sending and
1260 receiving IP packets.
1262 @param[in, out] IpIo Pointer to an IP_IO instance that needs
1264 @param[in] OpenData The configuration data and callbacks for
1267 @retval EFI_SUCCESS The IP_IO instance opened with OpenData
1269 @retval EFI_ACCESS_DENIED The IP_IO instance is configured, avoid to
1271 @retval Others Error condition occurred.
1278 IN IP_IO_OPEN_DATA
*OpenData
1284 if (IpIo
->IsConfigured
) {
1285 return EFI_ACCESS_DENIED
;
1288 IpVersion
= IpIo
->IpVersion
;
1290 ASSERT ((IpVersion
== IP_VERSION_4
) || (IpVersion
== IP_VERSION_6
));
1295 if (IpVersion
== IP_VERSION_4
){
1297 // RawData mode is no supported.
1299 ASSERT (!OpenData
->IpConfigData
.Ip4CfgData
.RawData
);
1300 if (OpenData
->IpConfigData
.Ip4CfgData
.RawData
) {
1301 return EFI_UNSUPPORTED
;
1304 Status
= IpIo
->Ip
.Ip4
->Configure (
1306 &OpenData
->IpConfigData
.Ip4CfgData
1310 Status
= IpIo
->Ip
.Ip6
->Configure (
1312 &OpenData
->IpConfigData
.Ip6CfgData
1316 if (EFI_ERROR (Status
)) {
1321 // @bug To delete the default route entry in this Ip, if it is:
1322 // @bug (0.0.0.0, 0.0.0.0, 0.0.0.0). Delete this statement if Ip modified
1325 if (IpVersion
== IP_VERSION_4
){
1326 Status
= IpIo
->Ip
.Ip4
->Routes (
1334 if (EFI_ERROR (Status
) && (EFI_NOT_FOUND
!= Status
)) {
1339 IpIo
->PktRcvdNotify
= OpenData
->PktRcvdNotify
;
1340 IpIo
->PktSentNotify
= OpenData
->PktSentNotify
;
1342 IpIo
->RcvdContext
= OpenData
->RcvdContext
;
1343 IpIo
->SndContext
= OpenData
->SndContext
;
1345 if (IpVersion
== IP_VERSION_4
){
1346 IpIo
->Protocol
= OpenData
->IpConfigData
.Ip4CfgData
.DefaultProtocol
;
1349 // start to listen incoming packet
1351 Status
= IpIo
->Ip
.Ip4
->Receive (
1353 &(IpIo
->RcvToken
.Ip4Token
)
1355 if (EFI_ERROR (Status
)) {
1356 IpIo
->Ip
.Ip4
->Configure (IpIo
->Ip
.Ip4
, NULL
);
1362 IpIo
->Protocol
= OpenData
->IpConfigData
.Ip6CfgData
.DefaultProtocol
;
1363 Status
= IpIo
->Ip
.Ip6
->Receive (
1365 &(IpIo
->RcvToken
.Ip6Token
)
1367 if (EFI_ERROR (Status
)) {
1368 IpIo
->Ip
.Ip6
->Configure (IpIo
->Ip
.Ip6
, NULL
);
1373 IpIo
->IsConfigured
= TRUE
;
1374 InsertTailList (&mActiveIpIoList
, &IpIo
->Entry
);
1383 Stop an IP_IO instance.
1385 This function is paired with IpIoOpen(). The IP_IO will be unconfigured and all
1386 the pending send/receive tokens will be canceled.
1388 @param[in, out] IpIo Pointer to the IP_IO instance that needs to stop.
1390 @retval EFI_SUCCESS The IP_IO instance stopped successfully.
1391 @retval Others Error condition occurred.
1401 IP_IO_IP_INFO
*IpInfo
;
1404 if (!IpIo
->IsConfigured
) {
1408 IpVersion
= IpIo
->IpVersion
;
1410 ASSERT ((IpVersion
== IP_VERSION_4
) || (IpVersion
== IP_VERSION_6
));
1413 // Remove the IpIo from the active IpIo list.
1415 RemoveEntryList (&IpIo
->Entry
);
1418 // Configure NULL Ip
1420 if (IpVersion
== IP_VERSION_4
) {
1421 Status
= IpIo
->Ip
.Ip4
->Configure (IpIo
->Ip
.Ip4
, NULL
);
1423 Status
= IpIo
->Ip
.Ip6
->Configure (IpIo
->Ip
.Ip6
, NULL
);
1425 if (EFI_ERROR (Status
)) {
1429 IpIo
->IsConfigured
= FALSE
;
1432 // Detroy the Ip List used by IpIo
1435 while (!IsListEmpty (&(IpIo
->IpList
))) {
1436 IpInfo
= NET_LIST_HEAD (&(IpIo
->IpList
), IP_IO_IP_INFO
, Entry
);
1438 IpIoRemoveIp (IpIo
, IpInfo
);
1442 // All pending send tokens should be flushed by resetting the IP instances.
1444 ASSERT (IsListEmpty (&IpIo
->PendingSndList
));
1447 // Close the receive event.
1449 if (IpVersion
== IP_VERSION_4
){
1450 gBS
->CloseEvent (IpIo
->RcvToken
.Ip4Token
.Event
);
1452 gBS
->CloseEvent (IpIo
->RcvToken
.Ip6Token
.Event
);
1460 Destroy an IP_IO instance.
1462 This function is paired with IpIoCreate(). The IP_IO will be closed first.
1463 Resource will be freed afterwards. See IpIoCloseProtocolDestroyIpChild().
1465 @param[in, out] IpIo Pointer to the IP_IO instance that needs to be
1468 @retval EFI_SUCCESS The IP_IO instance destroyed successfully.
1469 @retval Others Error condition occurred.
1484 // Close the IP protocol and destroy the child.
1486 IpIoCloseProtocolDestroyIpChild (
1493 gBS
->FreePool (IpIo
);
1500 Send out an IP packet.
1502 This function is called after IpIoOpen(). The data to be sent are wrapped in
1503 Pkt. The IP instance wrapped in IpIo is used for sending by default but can be
1504 overriden by Sender. Other sending configs, like source address and gateway
1505 address etc., are specified in OverrideData.
1507 @param[in, out] IpIo Pointer to an IP_IO instance used for sending IP
1509 @param[in, out] Pkt Pointer to the IP packet to be sent.
1510 @param[in] Sender The IP protocol instance used for sending.
1511 @param[in] Context Optional context data.
1512 @param[in] NotifyData Optional notify data.
1513 @param[in] Dest The destination IP address to send this packet to.
1514 @param[in] OverrideData The data to override some configuration of the IP
1515 instance used for sending.
1517 @retval EFI_SUCCESS The operation is completed successfully.
1518 @retval EFI_NOT_STARTED The IpIo is not configured.
1519 @retval EFI_OUT_OF_RESOURCES Failed due to resource limit.
1526 IN OUT NET_BUF
*Pkt
,
1527 IN IP_IO_IP_INFO
*Sender OPTIONAL
,
1528 IN VOID
*Context OPTIONAL
,
1529 IN VOID
*NotifyData OPTIONAL
,
1530 IN EFI_IP_ADDRESS
*Dest
,
1531 IN IP_IO_OVERRIDE
*OverrideData OPTIONAL
1535 IP_IO_IP_PROTOCOL Ip
;
1536 IP_IO_SEND_ENTRY
*SndEntry
;
1538 ASSERT ((IpIo
->IpVersion
!= IP_VERSION_4
) || (Dest
!= NULL
));
1540 if (!IpIo
->IsConfigured
) {
1541 return EFI_NOT_STARTED
;
1544 Ip
= (NULL
== Sender
) ? IpIo
->Ip
: Sender
->Ip
;
1547 // create a new SndEntry
1549 SndEntry
= IpIoCreateSndEntry (IpIo
, Pkt
, Ip
, Context
, NotifyData
, Dest
, OverrideData
);
1550 if (NULL
== SndEntry
) {
1551 return EFI_OUT_OF_RESOURCES
;
1557 if (IpIo
->IpVersion
== IP_VERSION_4
){
1558 Status
= Ip
.Ip4
->Transmit (
1560 &SndEntry
->SndToken
.Ip4Token
1563 Status
= Ip
.Ip6
->Transmit (
1565 &SndEntry
->SndToken
.Ip6Token
1569 if (EFI_ERROR (Status
)) {
1570 IpIoDestroySndEntry (SndEntry
);
1578 Cancel the IP transmit token which wraps this Packet.
1580 @param[in] IpIo Pointer to the IP_IO instance.
1581 @param[in] Packet Pointer to the packet of NET_BUF to cancel.
1592 IP_IO_SEND_ENTRY
*SndEntry
;
1593 IP_IO_IP_PROTOCOL Ip
;
1595 ASSERT ((IpIo
!= NULL
) && (Packet
!= NULL
));
1597 NET_LIST_FOR_EACH (Node
, &IpIo
->PendingSndList
) {
1599 SndEntry
= NET_LIST_USER_STRUCT (Node
, IP_IO_SEND_ENTRY
, Entry
);
1601 if (SndEntry
->Pkt
== Packet
) {
1605 if (IpIo
->IpVersion
== IP_VERSION_4
) {
1608 &SndEntry
->SndToken
.Ip4Token
1613 &SndEntry
->SndToken
.Ip6Token
1625 Add a new IP instance for sending data.
1627 The function is used to add the IP_IO to the IP_IO sending list. The caller
1628 can later use IpIoFindSender() to get the IP_IO and call IpIoSend() to send
1631 @param[in, out] IpIo Pointer to a IP_IO instance to add a new IP
1632 instance for sending purpose.
1634 @return Pointer to the created IP_IO_IP_INFO structure, NULL if failed.
1644 IP_IO_IP_INFO
*IpInfo
;
1647 ASSERT (IpIo
!= NULL
);
1649 IpInfo
= AllocatePool (sizeof (IP_IO_IP_INFO
));
1650 if (IpInfo
== NULL
) {
1655 // Init this IpInfo, set the Addr and SubnetMask to 0 before we configure the IP
1658 InitializeListHead (&IpInfo
->Entry
);
1659 IpInfo
->ChildHandle
= NULL
;
1660 ZeroMem (&IpInfo
->Addr
, sizeof (IpInfo
->Addr
));
1661 ZeroMem (&IpInfo
->PreMask
, sizeof (IpInfo
->PreMask
));
1664 IpInfo
->IpVersion
= IpIo
->IpVersion
;
1667 // Create the IP instance and open the IP protocol.
1669 Status
= IpIoCreateIpChildOpenProtocol (
1672 &IpInfo
->ChildHandle
,
1674 (VOID
**) &IpInfo
->Ip
1676 if (EFI_ERROR (Status
)) {
1681 // Create the event for the DummyRcvToken.
1683 Status
= gBS
->CreateEvent (
1690 if (EFI_ERROR (Status
)) {
1691 goto ReleaseIpChild
;
1694 if (IpInfo
->IpVersion
== IP_VERSION_4
) {
1695 IpInfo
->DummyRcvToken
.Ip4Token
.Event
= Event
;
1697 IpInfo
->DummyRcvToken
.Ip6Token
.Event
= Event
;
1701 // Link this IpInfo into the IpIo.
1703 InsertTailList (&IpIo
->IpList
, &IpInfo
->Entry
);
1709 IpIoCloseProtocolDestroyIpChild (
1712 IpInfo
->ChildHandle
,
1718 gBS
->FreePool (IpInfo
);
1725 Configure the IP instance of this IpInfo and start the receiving if IpConfigData
1728 @param[in, out] IpInfo Pointer to the IP_IO_IP_INFO instance.
1729 @param[in, out] IpConfigData The IP configure data used to configure the IP
1730 instance, if NULL the IP instance is reset. If
1731 UseDefaultAddress is set to TRUE, and the configure
1732 operation succeeds, the default address information
1733 is written back in this IpConfigData.
1735 @retval EFI_SUCCESS The IP instance of this IpInfo is configured successfully
1736 or no need to reconfigure it.
1737 @retval Others Configuration fails.
1743 IN OUT IP_IO_IP_INFO
*IpInfo
,
1744 IN OUT VOID
*IpConfigData OPTIONAL
1748 IP_IO_IP_PROTOCOL Ip
;
1750 EFI_IP4_MODE_DATA Ip4ModeData
;
1751 EFI_IP6_MODE_DATA Ip6ModeData
;
1753 ASSERT (IpInfo
!= NULL
);
1755 if (IpInfo
->RefCnt
> 1) {
1757 // This IP instance is shared, don't reconfigure it until it has only one
1758 // consumer. Currently, only the tcp children cloned from their passive parent
1759 // will share the same IP. So this cases only happens while IpConfigData is NULL,
1760 // let the last consumer clean the IP instance.
1765 IpVersion
= IpInfo
->IpVersion
;
1766 ASSERT ((IpVersion
== IP_VERSION_4
) || (IpVersion
== IP_VERSION_6
));
1770 if (IpInfo
->IpVersion
== IP_VERSION_4
) {
1771 Status
= Ip
.Ip4
->Configure (Ip
.Ip4
, IpConfigData
);
1773 Status
= Ip
.Ip6
->Configure (Ip
.Ip6
, IpConfigData
);
1776 if (EFI_ERROR (Status
)) {
1780 if (IpConfigData
!= NULL
) {
1781 if (IpInfo
->IpVersion
== IP_VERSION_4
){
1783 if (((EFI_IP4_CONFIG_DATA
*) IpConfigData
)->UseDefaultAddress
) {
1784 Ip
.Ip4
->GetModeData (
1791 IP4_COPY_ADDRESS (&((EFI_IP4_CONFIG_DATA
*) IpConfigData
)->StationAddress
, &Ip4ModeData
.ConfigData
.StationAddress
);
1792 IP4_COPY_ADDRESS (&((EFI_IP4_CONFIG_DATA
*) IpConfigData
)->SubnetMask
, &Ip4ModeData
.ConfigData
.SubnetMask
);
1797 &((EFI_IP4_CONFIG_DATA
*) IpConfigData
)->StationAddress
,
1801 &IpInfo
->PreMask
.SubnetMask
,
1802 &((EFI_IP4_CONFIG_DATA
*) IpConfigData
)->SubnetMask
,
1806 Status
= Ip
.Ip4
->Receive (
1808 &IpInfo
->DummyRcvToken
.Ip4Token
1810 if (EFI_ERROR (Status
)) {
1811 Ip
.Ip4
->Configure (Ip
.Ip4
, NULL
);
1814 Ip
.Ip6
->GetModeData (
1821 if (Ip6ModeData
.IsConfigured
) {
1823 &((EFI_IP6_CONFIG_DATA
*) IpConfigData
)->StationAddress
,
1824 &Ip6ModeData
.ConfigData
.StationAddress
,
1825 sizeof (EFI_IPv6_ADDRESS
)
1828 if (Ip6ModeData
.AddressList
!= NULL
) {
1829 FreePool (Ip6ModeData
.AddressList
);
1832 if (Ip6ModeData
.GroupTable
!= NULL
) {
1833 FreePool (Ip6ModeData
.GroupTable
);
1836 if (Ip6ModeData
.RouteTable
!= NULL
) {
1837 FreePool (Ip6ModeData
.RouteTable
);
1840 if (Ip6ModeData
.NeighborCache
!= NULL
) {
1841 FreePool (Ip6ModeData
.NeighborCache
);
1844 if (Ip6ModeData
.PrefixTable
!= NULL
) {
1845 FreePool (Ip6ModeData
.PrefixTable
);
1848 if (Ip6ModeData
.IcmpTypeList
!= NULL
) {
1849 FreePool (Ip6ModeData
.IcmpTypeList
);
1853 Status
= EFI_NO_MAPPING
;
1859 &Ip6ModeData
.ConfigData
.StationAddress
,
1860 sizeof (EFI_IPv6_ADDRESS
)
1863 Status
= Ip
.Ip6
->Receive (
1865 &IpInfo
->DummyRcvToken
.Ip6Token
1867 if (EFI_ERROR (Status
)) {
1868 Ip
.Ip6
->Configure (Ip
.Ip6
, NULL
);
1873 // The IP instance is reset, set the stored Addr and SubnetMask to zero.
1875 ZeroMem (&IpInfo
->Addr
, sizeof (IpInfo
->Addr
));
1876 ZeroMem (&IpInfo
->PreMask
, sizeof (IpInfo
->PreMask
));
1886 Destroy an IP instance maintained in IpIo->IpList for
1889 This function pairs with IpIoAddIp(). The IpInfo is previously created by
1890 IpIoAddIp(). The IP_IO_IP_INFO::RefCnt is decremented and the IP instance
1891 will be dstroyed if the RefCnt is zero.
1893 @param[in] IpIo Pointer to the IP_IO instance.
1894 @param[in] IpInfo Pointer to the IpInfo to be removed.
1901 IN IP_IO_IP_INFO
*IpInfo
1907 ASSERT (IpInfo
->RefCnt
> 0);
1909 NET_PUT_REF (IpInfo
);
1911 if (IpInfo
->RefCnt
> 0) {
1916 IpVersion
= IpIo
->IpVersion
;
1918 ASSERT ((IpVersion
== IP_VERSION_4
) || (IpVersion
== IP_VERSION_6
));
1920 RemoveEntryList (&IpInfo
->Entry
);
1922 if (IpVersion
== IP_VERSION_4
){
1923 IpInfo
->Ip
.Ip4
->Configure (
1927 IpIoCloseProtocolDestroyIpChild (
1930 IpInfo
->ChildHandle
,
1934 gBS
->CloseEvent (IpInfo
->DummyRcvToken
.Ip4Token
.Event
);
1938 IpInfo
->Ip
.Ip6
->Configure (
1943 IpIoCloseProtocolDestroyIpChild (
1946 IpInfo
->ChildHandle
,
1950 gBS
->CloseEvent (IpInfo
->DummyRcvToken
.Ip6Token
.Event
);
1958 Find the first IP protocol maintained in IpIo whose local
1959 address is the same as Src.
1961 This function is called when the caller needs the IpIo to send data to the
1962 specified Src. The IpIo was added previously by IpIoAddIp().
1964 @param[in, out] IpIo Pointer to the pointer of the IP_IO instance.
1965 @param[in] IpVersion The version of the IP protocol to use, either
1967 @param[in] Src The local IP address.
1969 @return Pointer to the IP protocol can be used for sending purpose and its local
1970 address is the same with Src.
1976 IN OUT IP_IO
**IpIo
,
1978 IN EFI_IP_ADDRESS
*Src
1981 LIST_ENTRY
*IpIoEntry
;
1983 LIST_ENTRY
*IpInfoEntry
;
1984 IP_IO_IP_INFO
*IpInfo
;
1986 ASSERT ((IpVersion
== IP_VERSION_4
) || (IpVersion
== IP_VERSION_6
));
1988 NET_LIST_FOR_EACH (IpIoEntry
, &mActiveIpIoList
) {
1989 IpIoPtr
= NET_LIST_USER_STRUCT (IpIoEntry
, IP_IO
, Entry
);
1991 if (((*IpIo
!= NULL
) && (*IpIo
!= IpIoPtr
)) || (IpIoPtr
->IpVersion
!= IpVersion
)) {
1995 NET_LIST_FOR_EACH (IpInfoEntry
, &IpIoPtr
->IpList
) {
1996 IpInfo
= NET_LIST_USER_STRUCT (IpInfoEntry
, IP_IO_IP_INFO
, Entry
);
1997 if (IpInfo
->IpVersion
== IP_VERSION_4
){
1999 if (EFI_IP4_EQUAL (&IpInfo
->Addr
.v4
, &Src
->v4
)) {
2006 if (EFI_IP6_EQUAL (&IpInfo
->Addr
.v6
, &Src
->v6
)) {
2023 Get the ICMP error map information.
2025 The ErrorStatus will be returned. The IsHard and Notify are optional. If they
2026 are not NULL, this routine will fill them.
2028 @param[in] IcmpError IcmpError Type.
2029 @param[in] IpVersion The version of the IP protocol to use,
2030 either IPv4 or IPv6.
2031 @param[out] IsHard If TRUE, indicates that it is a hard error.
2032 @param[out] Notify If TRUE, SockError needs to be notified.
2034 @return ICMP Error Status, such as EFI_NETWORK_UNREACHABLE.
2039 IpIoGetIcmpErrStatus (
2042 OUT BOOLEAN
*IsHard OPTIONAL
,
2043 OUT BOOLEAN
*Notify OPTIONAL
2046 if (IpVersion
== IP_VERSION_4
) {
2047 ASSERT (IcmpError
<= ICMP_ERR_PARAMPROB
);
2049 if (IsHard
!= NULL
) {
2050 *IsHard
= mIcmpErrMap
[IcmpError
].IsHard
;
2053 if (Notify
!= NULL
) {
2054 *Notify
= mIcmpErrMap
[IcmpError
].Notify
;
2057 switch (IcmpError
) {
2058 case ICMP_ERR_UNREACH_NET
:
2059 return EFI_NETWORK_UNREACHABLE
;
2061 case ICMP_ERR_TIMXCEED_INTRANS
:
2062 case ICMP_ERR_TIMXCEED_REASS
:
2063 case ICMP_ERR_UNREACH_HOST
:
2064 return EFI_HOST_UNREACHABLE
;
2066 case ICMP_ERR_UNREACH_PROTOCOL
:
2067 return EFI_PROTOCOL_UNREACHABLE
;
2069 case ICMP_ERR_UNREACH_PORT
:
2070 return EFI_PORT_UNREACHABLE
;
2072 case ICMP_ERR_MSGSIZE
:
2073 case ICMP_ERR_UNREACH_SRCFAIL
:
2074 case ICMP_ERR_QUENCH
:
2075 case ICMP_ERR_PARAMPROB
:
2076 return EFI_ICMP_ERROR
;
2080 return EFI_UNSUPPORTED
;
2083 } else if (IpVersion
== IP_VERSION_6
) {
2085 ASSERT (IcmpError
<= ICMP6_ERR_PARAMPROB_IPV6OPTION
);
2087 if (IsHard
!= NULL
) {
2088 *IsHard
= mIcmp6ErrMap
[IcmpError
].IsHard
;
2091 if (Notify
!= NULL
) {
2092 *Notify
= mIcmp6ErrMap
[IcmpError
].Notify
;
2095 switch (IcmpError
) {
2096 case ICMP6_ERR_UNREACH_NET
:
2097 return EFI_NETWORK_UNREACHABLE
;
2099 case ICMP6_ERR_UNREACH_HOST
:
2100 case ICMP6_ERR_TIMXCEED_HOPLIMIT
:
2101 case ICMP6_ERR_TIMXCEED_REASS
:
2102 return EFI_HOST_UNREACHABLE
;
2104 case ICMP6_ERR_UNREACH_PROTOCOL
:
2105 return EFI_PROTOCOL_UNREACHABLE
;
2107 case ICMP6_ERR_UNREACH_PORT
:
2108 return EFI_PORT_UNREACHABLE
;
2110 case ICMP6_ERR_PACKAGE_TOOBIG
:
2111 case ICMP6_ERR_PARAMPROB_HEADER
:
2112 case ICMP6_ERR_PARAMPROB_NEXHEADER
:
2113 case ICMP6_ERR_PARAMPROB_IPV6OPTION
:
2114 return EFI_ICMP_ERROR
;
2118 return EFI_UNSUPPORTED
;
2123 // Should never be here
2126 return EFI_UNSUPPORTED
;
2132 Refresh the remote peer's Neighbor Cache entries.
2134 This function is called when the caller needs the IpIo to refresh the existing
2135 IPv6 neighbor cache entries since the neighbor is considered reachable by the
2136 node has recently received a confirmation that packets sent recently to the
2137 neighbor were received by its IP layer.
2139 @param[in] IpIo Pointer to an IP_IO instance
2140 @param[in] Neighbor The IP address of the neighbor
2141 @param[in] Timeout Time in 100-ns units that this entry will
2142 remain in the neighbor cache. A value of
2143 zero means that the entry is permanent.
2144 A value of non-zero means that the entry is
2145 dynamic and will be deleted after Timeout.
2147 @retval EFI_SUCCESS The operation is completed successfully.
2148 @retval EFI_NOT_STARTED The IpIo is not configured.
2149 @retval EFI_INVALID_PARAMETER Neighbor Address is invalid.
2150 @retval EFI_NOT_FOUND The neighbor cache entry is not in the
2152 @retval EFI_OUT_OF_RESOURCES Failed due to resource limit.
2156 IpIoRefreshNeighbor (
2158 IN EFI_IP_ADDRESS
*Neighbor
,
2162 EFI_IP6_PROTOCOL
*Ip
;
2164 if (!IpIo
->IsConfigured
|| IpIo
->IpVersion
!= IP_VERSION_6
) {
2165 return EFI_NOT_STARTED
;
2170 return Ip
->Neighbors (Ip
, FALSE
, &Neighbor
->v6
, NULL
, Timeout
, TRUE
);