2 Implement IP4 pesudo interface.
4 Copyright (c) 2005 - 2013, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 // Mac address with all zero, used to determine whethter the ARP
19 // resolve succeeded. Failed ARP requests zero the MAC address buffer.
21 EFI_MAC_ADDRESS mZeroMacAddress
;
24 Callback funtion when frame transmission is finished. It will
25 call the frame owner's callback function to tell it the result.
27 @param[in] Context Context which is point to the token.
37 Request Ip4OnFrameSentDpc as a DPC at TPL_CALLBACK.
39 @param[in] Event The transmit token's event.
40 @param[in] Context Context which is point to the token.
51 Callback function when ARP request are finished. It will cancelled
52 all the queued frame if the ARP requests failed. Or transmit them
53 if the request succeed.
55 @param[in] Context The context of the callback, a point to the ARP
66 Request Ip4OnArpResolvedDpc as a DPC at TPL_CALLBACK.
68 @param Event The Arp request event.
69 @param Context The context of the callback, a point to the ARP
81 Received a frame from MNP, wrap it in net buffer then deliver
82 it to IP's input function. The ownship of the packet also
83 transferred to IP. When Ip is finished with this packet, it
84 will call NetbufFree to release the packet, NetbufFree will
85 again call the Ip4RecycleFrame to signal MNP's event and free
88 @param Context Context for the callback.
93 Ip4OnFrameReceivedDpc (
98 Request Ip4OnFrameReceivedDpc as a DPC at TPL_CALLBACK.
100 @param Event The receive event delivered to MNP for receive.
101 @param Context Context for the callback.
112 Remove all the frames on the ARP queue that pass the FrameToCancel,
113 that is, either FrameToCancel is NULL or it returns true for the frame.
115 @param[in] ArpQue ARP frame to remove the frames from.
116 @param[in] IoStatus The status returned to the cancelled frames'
118 @param[in] FrameToCancel Function to select which frame to cancel.
119 @param[in] Context Opaque parameter to the FrameToCancel.
124 IN IP4_ARP_QUE
*ArpQue
,
125 IN EFI_STATUS IoStatus
,
126 IN IP4_FRAME_TO_CANCEL FrameToCancel OPTIONAL
,
132 Wrap a transmit request into a newly allocated IP4_LINK_TX_TOKEN.
134 @param[in] Interface The interface to send out to.
135 @param[in] IpInstance The IpInstance that transmit the packet. NULL if
136 the packet is sent by the IP4 driver itself.
137 @param[in] Packet The packet to transmit
138 @param[in] CallBack Call back function to execute if transmission
140 @param[in] Context Opaque parameter to the call back.
142 @retval Token The wrapped token if succeed
143 @retval NULL The wrapped token if NULL
148 IN IP4_INTERFACE
*Interface
,
149 IN IP4_PROTOCOL
*IpInstance OPTIONAL
,
151 IN IP4_FRAME_CALLBACK CallBack
,
155 EFI_MANAGED_NETWORK_COMPLETION_TOKEN
*MnpToken
;
156 EFI_MANAGED_NETWORK_TRANSMIT_DATA
*MnpTxData
;
157 IP4_LINK_TX_TOKEN
*Token
;
161 Token
= AllocatePool (sizeof (IP4_LINK_TX_TOKEN
) + \
162 (Packet
->BlockOpNum
- 1) * sizeof (EFI_MANAGED_NETWORK_FRAGMENT_DATA
));
168 Token
->Signature
= IP4_FRAME_TX_SIGNATURE
;
169 InitializeListHead (&Token
->Link
);
171 Token
->Interface
= Interface
;
172 Token
->IpInstance
= IpInstance
;
173 Token
->CallBack
= CallBack
;
174 Token
->Packet
= Packet
;
175 Token
->Context
= Context
;
176 CopyMem (&Token
->DstMac
, &mZeroMacAddress
, sizeof (Token
->DstMac
));
177 CopyMem (&Token
->SrcMac
, &Interface
->Mac
, sizeof (Token
->SrcMac
));
179 MnpToken
= &(Token
->MnpToken
);
180 MnpToken
->Status
= EFI_NOT_READY
;
182 Status
= gBS
->CreateEvent (
190 if (EFI_ERROR (Status
)) {
195 MnpTxData
= &Token
->MnpTxData
;
196 MnpToken
->Packet
.TxData
= MnpTxData
;
198 MnpTxData
->DestinationAddress
= &Token
->DstMac
;
199 MnpTxData
->SourceAddress
= &Token
->SrcMac
;
200 MnpTxData
->ProtocolType
= IP4_ETHER_PROTO
;
201 MnpTxData
->DataLength
= Packet
->TotalSize
;
202 MnpTxData
->HeaderLength
= 0;
204 Count
= Packet
->BlockOpNum
;
206 NetbufBuildExt (Packet
, (NET_FRAGMENT
*) MnpTxData
->FragmentTable
, &Count
);
207 MnpTxData
->FragmentCount
= (UINT16
)Count
;
214 Free the link layer transmit token. It will close the event
215 then free the memory used.
217 @param[in] Token Token to free
222 IN IP4_LINK_TX_TOKEN
*Token
225 NET_CHECK_SIGNATURE (Token
, IP4_FRAME_TX_SIGNATURE
);
227 gBS
->CloseEvent (Token
->MnpToken
.Event
);
233 Create an IP_ARP_QUE structure to request ARP service.
235 @param[in] Interface The interface to send ARP from.
236 @param[in] DestIp The destination IP (host byte order) to request MAC
239 @return Point to newly created IP4_ARP_QUE if succeed, otherwise NULL.
244 IN IP4_INTERFACE
*Interface
,
251 ArpQue
= AllocatePool (sizeof (IP4_ARP_QUE
));
253 if (ArpQue
== NULL
) {
257 ArpQue
->Signature
= IP4_FRAME_ARP_SIGNATURE
;
258 InitializeListHead (&ArpQue
->Link
);
260 InitializeListHead (&ArpQue
->Frames
);
261 ArpQue
->Interface
= Interface
;
263 Status
= gBS
->CreateEvent (
271 if (EFI_ERROR (Status
)) {
277 CopyMem (&ArpQue
->Mac
, &mZeroMacAddress
, sizeof (ArpQue
->Mac
));
284 Remove all the transmit requests queued on the ARP queue, then free it.
286 @param[in] ArpQue Arp queue to free
287 @param[in] IoStatus The transmit status returned to transmit requests'
293 IN IP4_ARP_QUE
*ArpQue
,
294 IN EFI_STATUS IoStatus
297 NET_CHECK_SIGNATURE (ArpQue
, IP4_FRAME_ARP_SIGNATURE
);
300 // Remove all the frame waiting the ARP response
302 Ip4CancelFrameArp (ArpQue
, IoStatus
, NULL
, NULL
);
304 gBS
->CloseEvent (ArpQue
->OnResolved
);
310 Create a link layer receive token to wrap the receive request
312 @param[in] Interface The interface to receive from
313 @param[in] IpInstance The instance that request the receive (NULL for IP4
315 @param[in] CallBack Call back function to execute when finished.
316 @param[in] Context Opaque parameters to the callback
318 @return Point to created IP4_LINK_RX_TOKEN if succeed, otherwise NULL.
322 Ip4CreateLinkRxToken (
323 IN IP4_INTERFACE
*Interface
,
324 IN IP4_PROTOCOL
*IpInstance
,
325 IN IP4_FRAME_CALLBACK CallBack
,
329 EFI_MANAGED_NETWORK_COMPLETION_TOKEN
*MnpToken
;
330 IP4_LINK_RX_TOKEN
*Token
;
333 Token
= AllocatePool (sizeof (IP4_LINK_RX_TOKEN
));
338 Token
->Signature
= IP4_FRAME_RX_SIGNATURE
;
339 Token
->Interface
= Interface
;
340 Token
->IpInstance
= IpInstance
;
341 Token
->CallBack
= CallBack
;
342 Token
->Context
= Context
;
344 MnpToken
= &Token
->MnpToken
;
345 MnpToken
->Status
= EFI_NOT_READY
;
347 Status
= gBS
->CreateEvent (
355 if (EFI_ERROR (Status
)) {
360 MnpToken
->Packet
.RxData
= NULL
;
366 Free the link layer request token. It will close the event
367 then free the memory used.
369 @param[in] Token Request token to free.
373 Ip4FreeFrameRxToken (
374 IN IP4_LINK_RX_TOKEN
*Token
378 NET_CHECK_SIGNATURE (Token
, IP4_FRAME_RX_SIGNATURE
);
380 gBS
->CloseEvent (Token
->MnpToken
.Event
);
386 Remove all the frames on the ARP queue that pass the FrameToCancel,
387 that is, either FrameToCancel is NULL or it returns true for the frame.
389 @param[in] ArpQue ARP frame to remove the frames from.
390 @param[in] IoStatus The status returned to the cancelled frames'
392 @param[in] FrameToCancel Function to select which frame to cancel.
393 @param[in] Context Opaque parameter to the FrameToCancel.
398 IN IP4_ARP_QUE
*ArpQue
,
399 IN EFI_STATUS IoStatus
,
400 IN IP4_FRAME_TO_CANCEL FrameToCancel OPTIONAL
,
406 IP4_LINK_TX_TOKEN
*Token
;
408 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, &ArpQue
->Frames
) {
409 Token
= NET_LIST_USER_STRUCT (Entry
, IP4_LINK_TX_TOKEN
, Link
);
411 if ((FrameToCancel
== NULL
) || FrameToCancel (Token
, Context
)) {
412 RemoveEntryList (Entry
);
414 Token
->CallBack (Token
->IpInstance
, Token
->Packet
, IoStatus
, 0, Token
->Context
);
415 Ip4FreeLinkTxToken (Token
);
422 Remove all the frames on the interface that pass the FrameToCancel,
423 either queued on ARP queues or that have already been delivered to
424 MNP and not yet recycled.
426 @param[in] Interface Interface to remove the frames from
427 @param[in] IoStatus The transmit status returned to the frames'
429 @param[in] FrameToCancel Function to select the frame to cancel, NULL to
431 @param[in] Context Opaque parameters passed to FrameToCancel
436 IN IP4_INTERFACE
*Interface
,
437 IN EFI_STATUS IoStatus
,
438 IN IP4_FRAME_TO_CANCEL FrameToCancel OPTIONAL
,
445 IP4_LINK_TX_TOKEN
*Token
;
448 // Cancel all the pending frames on ARP requests
450 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, &Interface
->ArpQues
) {
451 ArpQue
= NET_LIST_USER_STRUCT (Entry
, IP4_ARP_QUE
, Link
);
453 Ip4CancelFrameArp (ArpQue
, IoStatus
, FrameToCancel
, Context
);
455 if (IsListEmpty (&ArpQue
->Frames
)) {
456 Interface
->Arp
->Cancel (Interface
->Arp
, &ArpQue
->Ip
, ArpQue
->OnResolved
);
461 // Cancel all the frames that have been delivered to MNP
462 // but not yet recycled.
464 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, &Interface
->SentFrames
) {
465 Token
= NET_LIST_USER_STRUCT (Entry
, IP4_LINK_TX_TOKEN
, Link
);
467 if ((FrameToCancel
== NULL
) || FrameToCancel (Token
, Context
)) {
468 Interface
->Mnp
->Cancel (Interface
->Mnp
, &Token
->MnpToken
);
475 Create an IP4_INTERFACE. Delay the creation of ARP instance until
476 the interface is configured.
478 @param[in] Mnp The shared MNP child of this IP4 service binding
480 @param[in] Controller The controller this IP4 service binding instance
481 is installed. Most like the UNDI handle.
482 @param[in] ImageHandle This driver's image handle
484 @return Point to the created IP4_INTERFACE, otherwise NULL.
489 IN EFI_MANAGED_NETWORK_PROTOCOL
*Mnp
,
490 IN EFI_HANDLE Controller
,
491 IN EFI_HANDLE ImageHandle
494 IP4_INTERFACE
*Interface
;
495 EFI_SIMPLE_NETWORK_MODE SnpMode
;
497 Interface
= AllocatePool (sizeof (IP4_INTERFACE
));
499 if ((Interface
== NULL
) || (Mnp
== NULL
)) {
503 Interface
->Signature
= IP4_INTERFACE_SIGNATURE
;
504 InitializeListHead (&Interface
->Link
);
505 Interface
->RefCnt
= 1;
507 Interface
->Ip
= IP4_ALLZERO_ADDRESS
;
508 Interface
->SubnetMask
= IP4_ALLZERO_ADDRESS
;
509 Interface
->Configured
= FALSE
;
511 Interface
->Controller
= Controller
;
512 Interface
->Image
= ImageHandle
;
513 Interface
->Mnp
= Mnp
;
514 Interface
->Arp
= NULL
;
515 Interface
->ArpHandle
= NULL
;
517 InitializeListHead (&Interface
->ArpQues
);
518 InitializeListHead (&Interface
->SentFrames
);
520 Interface
->RecvRequest
= NULL
;
523 // Get the interface's Mac address and broadcast mac address from SNP
525 if (EFI_ERROR (Mnp
->GetModeData (Mnp
, NULL
, &SnpMode
))) {
526 FreePool (Interface
);
530 CopyMem (&Interface
->Mac
, &SnpMode
.CurrentAddress
, sizeof (Interface
->Mac
));
531 CopyMem (&Interface
->BroadcastMac
, &SnpMode
.BroadcastAddress
, sizeof (Interface
->BroadcastMac
));
532 Interface
->HwaddrLen
= SnpMode
.HwAddressSize
;
534 InitializeListHead (&Interface
->IpInstances
);
535 Interface
->PromiscRecv
= FALSE
;
542 Set the interface's address, create and configure
543 the ARP child if necessary.
545 @param Interface The interface to set the address
546 @param IpAddr The interface's IP address
547 @param SubnetMask The interface's netmask
549 @retval EFI_SUCCESS The interface is configured with Ip/netmask pair,
550 and a ARP is created for it.
551 @retval Others Failed to set the interface's address.
556 IN OUT IP4_INTERFACE
*Interface
,
558 IN IP4_ADDR SubnetMask
561 EFI_ARP_CONFIG_DATA ArpConfig
;
567 NET_CHECK_SIGNATURE (Interface
, IP4_INTERFACE_SIGNATURE
);
569 ASSERT (!Interface
->Configured
);
572 // Set the ip/netmask, then compute the subnet broadcast
573 // and network broadcast for easy access. When computing
574 // nework broadcast, the subnet mask is most like longer
575 // than the default netmask (not subneted) as defined in
576 // RFC793. If that isn't the case, we are aggregating the
577 // networks, use the subnet's mask instead.
579 Interface
->Ip
= IpAddr
;
580 Interface
->SubnetMask
= SubnetMask
;
581 Interface
->SubnetBrdcast
= (IpAddr
| ~SubnetMask
);
583 Type
= NetGetIpClass (IpAddr
);
584 Len
= NetGetMaskLength (SubnetMask
);
585 Netmask
= gIp4AllMasks
[MIN ((Len
- 1), Type
<< 3)];
586 Interface
->NetBrdcast
= (IpAddr
| ~Netmask
);
589 // If the address is NOT all zero, create then configure an ARP child.
590 // Pay attention: DHCP configures its station address as 0.0.0.0/0
592 Interface
->Arp
= NULL
;
593 Interface
->ArpHandle
= NULL
;
595 if (IpAddr
!= IP4_ALLZERO_ADDRESS
) {
596 Status
= NetLibCreateServiceChild (
597 Interface
->Controller
,
599 &gEfiArpServiceBindingProtocolGuid
,
600 &Interface
->ArpHandle
603 if (EFI_ERROR (Status
)) {
607 Status
= gBS
->OpenProtocol (
608 Interface
->ArpHandle
,
609 &gEfiArpProtocolGuid
,
610 (VOID
**) &Interface
->Arp
,
612 Interface
->Controller
,
613 EFI_OPEN_PROTOCOL_BY_DRIVER
616 if (EFI_ERROR (Status
)) {
620 IpAddr
= HTONL (IpAddr
);
621 ArpConfig
.SwAddressType
= IP4_ETHER_PROTO
;
622 ArpConfig
.SwAddressLength
= 4;
623 ArpConfig
.StationAddress
= &IpAddr
;
624 ArpConfig
.EntryTimeOut
= 0;
625 ArpConfig
.RetryCount
= 0;
626 ArpConfig
.RetryTimeOut
= 0;
628 Status
= Interface
->Arp
->Configure (Interface
->Arp
, &ArpConfig
);
630 if (EFI_ERROR (Status
)) {
632 Interface
->ArpHandle
,
633 &gEfiArpProtocolGuid
,
635 Interface
->Controller
642 Interface
->Configured
= TRUE
;
646 NetLibDestroyServiceChild (
647 Interface
->Controller
,
649 &gEfiArpServiceBindingProtocolGuid
,
650 &Interface
->ArpHandle
658 Filter function to cancel all the frame related to an IP instance.
660 @param[in] Frame The transmit request to test whether to cancel
661 @param[in] Context The context which is the Ip instance that issued
664 @retval TRUE The frame belongs to this instance and is to be
666 @retval FALSE The frame doesn't belong to this instance.
670 Ip4CancelInstanceFrame (
671 IN IP4_LINK_TX_TOKEN
*Frame
,
675 if (Frame
->IpInstance
== (IP4_PROTOCOL
*) Context
) {
685 If there is a pending receive request, cancel it. Don't call
686 the receive request's callback because this function can be only
687 called if the instance or driver is tearing itself down. It
688 doesn't make sense to call it back. But it is necessary to call
689 the transmit token's callback to give it a chance to free the
690 packet and update the upper layer's transmit request status, say
693 @param[in] Interface The interface used by the IpInstance
698 IN IP4_INTERFACE
*Interface
702 IP4_LINK_RX_TOKEN
*Token
;
704 if ((Token
= Interface
->RecvRequest
) != NULL
) {
705 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
707 Interface
->RecvRequest
= NULL
;
708 Interface
->Mnp
->Cancel (Interface
->Mnp
, &Token
->MnpToken
);
710 gBS
->RestoreTPL (OldTpl
);
716 Free the interface used by IpInstance. All the IP instance with
717 the same Ip/Netmask pair share the same interface. It is reference
718 counted. All the frames haven't been sent will be cancelled.
719 Because the IpInstance is optional, the caller must remove
720 IpInstance from the interface's instance list itself.
722 @param[in] Interface The interface used by the IpInstance
723 @param[in] IpInstance The Ip instance that free the interface. NULL if
724 the Ip driver is releasing the default interface.
726 @retval EFI_SUCCESS The interface use IpInstance is freed.
731 IN IP4_INTERFACE
*Interface
,
732 IN IP4_PROTOCOL
*IpInstance OPTIONAL
735 NET_CHECK_SIGNATURE (Interface
, IP4_INTERFACE_SIGNATURE
);
736 ASSERT (Interface
->RefCnt
> 0);
739 // Remove all the pending transmit token related to this IP instance.
741 Ip4CancelFrames (Interface
, EFI_ABORTED
, Ip4CancelInstanceFrame
, IpInstance
);
744 // Destroy the ARP instance if this is the last IP instance that
747 if (Interface
->Arp
!= NULL
&& IsListEmpty (&Interface
->IpInstances
)) {
749 Interface
->ArpHandle
,
750 &gEfiArpProtocolGuid
,
752 Interface
->Controller
755 NetLibDestroyServiceChild (
756 Interface
->Controller
,
758 &gEfiArpServiceBindingProtocolGuid
,
761 Interface
->Arp
= NULL
;
764 if (--Interface
->RefCnt
> 0) {
769 // Destroy the interface if it is not referenced by any IP instance (for common Interface)
770 // or the IP service (for the DefaultInterface). Remove all the system transmitted packets
771 // from this interface, cancel the receive request if there is one.
773 Ip4CancelFrames (Interface
, EFI_ABORTED
, Ip4CancelInstanceFrame
, NULL
);
774 Ip4CancelReceive (Interface
);
776 ASSERT (IsListEmpty (&Interface
->IpInstances
));
777 ASSERT (IsListEmpty (&Interface
->ArpQues
));
778 ASSERT (IsListEmpty (&Interface
->SentFrames
));
780 RemoveEntryList (&Interface
->Link
);
781 FreePool (Interface
);
788 Callback function when ARP request are finished. It will cancelled
789 all the queued frame if the ARP requests failed. Or transmit them
790 if the request succeed.
792 @param[in] Context The context of the callback, a point to the ARP
798 Ip4OnArpResolvedDpc (
805 IP4_INTERFACE
*Interface
;
806 IP4_LINK_TX_TOKEN
*Token
;
809 ArpQue
= (IP4_ARP_QUE
*) Context
;
810 NET_CHECK_SIGNATURE (ArpQue
, IP4_FRAME_ARP_SIGNATURE
);
812 RemoveEntryList (&ArpQue
->Link
);
815 // ARP resolve failed for some reason. Release all the frame
816 // and ARP queue itself. Ip4FreeArpQue will call the frame's
819 if (NET_MAC_EQUAL (&ArpQue
->Mac
, &mZeroMacAddress
, ArpQue
->Interface
->HwaddrLen
)) {
820 Ip4FreeArpQue (ArpQue
, EFI_NO_MAPPING
);
826 // ARP resolve succeeded, Transmit all the frame. Release the ARP
827 // queue. It isn't necessary for us to cache the ARP binding because
828 // we always check the ARP cache first before transmit.
830 Interface
= ArpQue
->Interface
;
832 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, &ArpQue
->Frames
) {
833 RemoveEntryList (Entry
);
835 Token
= NET_LIST_USER_STRUCT (Entry
, IP4_LINK_TX_TOKEN
, Link
);
836 CopyMem (&Token
->DstMac
, &ArpQue
->Mac
, sizeof (Token
->DstMac
));
839 // Insert the tx token before transmitting it via MNP as the FrameSentDpc
840 // may be called before Mnp->Transmit returns which will remove this tx
841 // token from the SentFrames list. Remove it from the list if the returned
842 // Status of Mnp->Transmit is not EFI_SUCCESS as in this case the
843 // FrameSentDpc won't be queued.
845 InsertTailList (&Interface
->SentFrames
, &Token
->Link
);
847 Status
= Interface
->Mnp
->Transmit (Interface
->Mnp
, &Token
->MnpToken
);
848 if (EFI_ERROR (Status
)) {
849 RemoveEntryList (Entry
);
850 Token
->CallBack (Token
->IpInstance
, Token
->Packet
, Status
, 0, Token
->Context
);
852 Ip4FreeLinkTxToken (Token
);
857 Ip4FreeArpQue (ArpQue
, EFI_SUCCESS
);
861 Request Ip4OnArpResolvedDpc as a DPC at TPL_CALLBACK.
863 @param Event The Arp request event.
864 @param Context The context of the callback, a point to the ARP
876 // Request Ip4OnArpResolvedDpc as a DPC at TPL_CALLBACK
878 QueueDpc (TPL_CALLBACK
, Ip4OnArpResolvedDpc
, Context
);
884 Callback funtion when frame transmission is finished. It will
885 call the frame owner's callback function to tell it the result.
887 @param[in] Context Context which is point to the token.
896 IP4_LINK_TX_TOKEN
*Token
;
898 Token
= (IP4_LINK_TX_TOKEN
*) Context
;
899 NET_CHECK_SIGNATURE (Token
, IP4_FRAME_TX_SIGNATURE
);
901 RemoveEntryList (&Token
->Link
);
906 Token
->MnpToken
.Status
,
911 Ip4FreeLinkTxToken (Token
);
915 Request Ip4OnFrameSentDpc as a DPC at TPL_CALLBACK.
917 @param[in] Event The transmit token's event.
918 @param[in] Context Context which is point to the token.
929 // Request Ip4OnFrameSentDpc as a DPC at TPL_CALLBACK
931 QueueDpc (TPL_CALLBACK
, Ip4OnFrameSentDpc
, Context
);
937 Send a frame from the interface. If the next hop is broadcast or
938 multicast address, it is transmitted immediately. If the next hop
939 is a unicast, it will consult ARP to resolve the NextHop's MAC.
940 If some error happened, the CallBack won't be called. So, the caller
941 must test the return value, and take action when there is an error.
943 @param[in] Interface The interface to send the frame from
944 @param[in] IpInstance The IP child that request the transmission. NULL
945 if it is the IP4 driver itself.
946 @param[in] Packet The packet to transmit.
947 @param[in] NextHop The immediate destination to transmit the packet
949 @param[in] CallBack Function to call back when transmit finished.
950 @param[in] Context Opaque parameter to the call back.
952 @retval EFI_OUT_OF_RESOURCES Failed to allocate resource to send the frame
953 @retval EFI_NO_MAPPING Can't resolve the MAC for the nexthop
954 @retval EFI_SUCCESS The packet is successfully transmitted.
955 @retval other Other error occurs.
960 IN IP4_INTERFACE
*Interface
,
961 IN IP4_PROTOCOL
*IpInstance OPTIONAL
,
964 IN IP4_FRAME_CALLBACK CallBack
,
968 IP4_LINK_TX_TOKEN
*Token
;
971 EFI_ARP_PROTOCOL
*Arp
;
974 ASSERT (Interface
->Configured
);
976 Token
= Ip4WrapLinkTxToken (Interface
, IpInstance
, Packet
, CallBack
, Context
);
979 return EFI_OUT_OF_RESOURCES
;
983 // Get the destination MAC address for multicast and broadcasts.
984 // Don't depend on ARP to solve the address since there maybe no
985 // ARP at all. Ip4Output has set NextHop to 255.255.255.255 for
986 // all the broadcasts.
988 if (NextHop
== IP4_ALLONE_ADDRESS
) {
989 CopyMem (&Token
->DstMac
, &Interface
->BroadcastMac
, sizeof (Token
->DstMac
));
992 } else if (IP4_IS_MULTICAST (NextHop
)) {
994 Status
= Ip4GetMulticastMac (Interface
->Mnp
, NextHop
, &Token
->DstMac
);
996 if (EFI_ERROR (Status
)) {
1004 // Can only send out multicast/broadcast if the IP address is zero
1006 if ((Arp
= Interface
->Arp
) == NULL
) {
1007 Status
= EFI_NO_MAPPING
;
1012 // First check whether this binding is in the ARP cache.
1014 NextHop
= HTONL (NextHop
);
1015 Status
= Arp
->Request (Arp
, &NextHop
, NULL
, &Token
->DstMac
);
1017 if (Status
== EFI_SUCCESS
) {
1020 } else if (Status
!= EFI_NOT_READY
) {
1025 // Have to do asynchronous ARP resolution. First check
1026 // whether there is already a pending request.
1030 NET_LIST_FOR_EACH (Entry
, &Interface
->ArpQues
) {
1031 ArpQue
= NET_LIST_USER_STRUCT (Entry
, IP4_ARP_QUE
, Link
);
1033 if (ArpQue
->Ip
== NextHop
) {
1039 // Found a pending ARP request, enqueue the frame then return
1041 if (Entry
!= &Interface
->ArpQues
) {
1042 InsertTailList (&ArpQue
->Frames
, &Token
->Link
);
1047 // First frame to NextHop, issue an asynchronous ARP requests
1049 ArpQue
= Ip4CreateArpQue (Interface
, NextHop
);
1051 if (ArpQue
== NULL
) {
1052 Status
= EFI_OUT_OF_RESOURCES
;
1056 Status
= Arp
->Request (Arp
, &ArpQue
->Ip
, ArpQue
->OnResolved
, ArpQue
->Mac
.Addr
);
1058 if (EFI_ERROR (Status
) && (Status
!= EFI_NOT_READY
)) {
1059 Ip4FreeArpQue (ArpQue
, EFI_NO_MAPPING
);
1063 InsertHeadList (&ArpQue
->Frames
, &Token
->Link
);
1064 InsertHeadList (&Interface
->ArpQues
, &ArpQue
->Link
);
1069 // Insert the tx token into the SentFrames list before calling Mnp->Transmit.
1070 // Remove it if the returned status is not EFI_SUCCESS.
1072 InsertTailList (&Interface
->SentFrames
, &Token
->Link
);
1073 Status
= Interface
->Mnp
->Transmit (Interface
->Mnp
, &Token
->MnpToken
);
1074 if (EFI_ERROR (Status
)) {
1075 RemoveEntryList (&Interface
->SentFrames
);
1082 Ip4FreeLinkTxToken (Token
);
1088 Call back function when the received packet is freed.
1089 Check Ip4OnFrameReceived for information.
1091 @param Context Context, which is the IP4_LINK_RX_TOKEN.
1100 IP4_LINK_RX_TOKEN
*Frame
;
1102 Frame
= (IP4_LINK_RX_TOKEN
*) Context
;
1103 NET_CHECK_SIGNATURE (Frame
, IP4_FRAME_RX_SIGNATURE
);
1105 gBS
->SignalEvent (Frame
->MnpToken
.Packet
.RxData
->RecycleEvent
);
1106 Ip4FreeFrameRxToken (Frame
);
1111 Received a frame from MNP, wrap it in net buffer then deliver
1112 it to IP's input function. The ownship of the packet also
1113 transferred to IP. When Ip is finished with this packet, it
1114 will call NetbufFree to release the packet, NetbufFree will
1115 again call the Ip4RecycleFrame to signal MNP's event and free
1118 @param Context Context for the callback.
1123 Ip4OnFrameReceivedDpc (
1127 EFI_MANAGED_NETWORK_COMPLETION_TOKEN
*MnpToken
;
1128 EFI_MANAGED_NETWORK_RECEIVE_DATA
*MnpRxData
;
1129 IP4_LINK_RX_TOKEN
*Token
;
1130 NET_FRAGMENT Netfrag
;
1134 Token
= (IP4_LINK_RX_TOKEN
*) Context
;
1135 NET_CHECK_SIGNATURE (Token
, IP4_FRAME_RX_SIGNATURE
);
1138 // First clear the interface's receive request in case the
1139 // caller wants to call Ip4ReceiveFrame in the callback.
1141 Token
->Interface
->RecvRequest
= NULL
;
1143 MnpToken
= &Token
->MnpToken
;
1144 MnpRxData
= MnpToken
->Packet
.RxData
;
1146 if (EFI_ERROR (MnpToken
->Status
) || (MnpRxData
== NULL
)) {
1147 Token
->CallBack (Token
->IpInstance
, NULL
, MnpToken
->Status
, 0, Token
->Context
);
1148 Ip4FreeFrameRxToken (Token
);
1154 // Wrap the frame in a net buffer then deliever it to IP input.
1155 // IP will reassemble the packet, and deliver it to upper layer
1157 Netfrag
.Len
= MnpRxData
->DataLength
;
1158 Netfrag
.Bulk
= MnpRxData
->PacketData
;
1160 Packet
= NetbufFromExt (&Netfrag
, 1, 0, IP4_MAX_HEADLEN
, Ip4RecycleFrame
, Token
);
1162 if (Packet
== NULL
) {
1163 gBS
->SignalEvent (MnpRxData
->RecycleEvent
);
1165 Token
->CallBack (Token
->IpInstance
, NULL
, EFI_OUT_OF_RESOURCES
, 0, Token
->Context
);
1166 Ip4FreeFrameRxToken (Token
);
1171 Flag
= (MnpRxData
->BroadcastFlag
? IP4_LINK_BROADCAST
: 0);
1172 Flag
|= (MnpRxData
->MulticastFlag
? IP4_LINK_MULTICAST
: 0);
1173 Flag
|= (MnpRxData
->PromiscuousFlag
? IP4_LINK_PROMISC
: 0);
1175 Token
->CallBack (Token
->IpInstance
, Packet
, EFI_SUCCESS
, Flag
, Token
->Context
);
1179 Request Ip4OnFrameReceivedDpc as a DPC at TPL_CALLBACK.
1181 @param Event The receive event delivered to MNP for receive.
1182 @param Context Context for the callback.
1187 Ip4OnFrameReceived (
1193 // Request Ip4OnFrameReceivedDpc as a DPC at TPL_CALLBACK
1195 QueueDpc (TPL_CALLBACK
, Ip4OnFrameReceivedDpc
, Context
);
1200 Request to receive the packet from the interface.
1202 @param[in] Interface The interface to receive the frames from
1203 @param[in] IpInstance The instance that requests the receive. NULL for
1205 @param[in] CallBack Function to call when receive finished.
1206 @param[in] Context Opaque parameter to the callback
1208 @retval EFI_ALREADY_STARTED There is already a pending receive request.
1209 @retval EFI_OUT_OF_RESOURCES Failed to allocate resource to receive
1210 @retval EFI_SUCCESS The recieve request has been started.
1211 @retval other Other error occurs.
1216 IN IP4_INTERFACE
*Interface
,
1217 IN IP4_PROTOCOL
*IpInstance OPTIONAL
,
1218 IN IP4_FRAME_CALLBACK CallBack
,
1222 IP4_LINK_RX_TOKEN
*Token
;
1225 NET_CHECK_SIGNATURE (Interface
, IP4_INTERFACE_SIGNATURE
);
1227 if (Interface
->RecvRequest
!= NULL
) {
1228 return EFI_ALREADY_STARTED
;
1231 Token
= Ip4CreateLinkRxToken (Interface
, IpInstance
, CallBack
, Context
);
1233 if (Token
== NULL
) {
1234 return EFI_OUT_OF_RESOURCES
;
1237 Interface
->RecvRequest
= Token
;
1238 Status
= Interface
->Mnp
->Receive (Interface
->Mnp
, &Token
->MnpToken
);
1239 if (EFI_ERROR (Status
)) {
1240 Interface
->RecvRequest
= NULL
;
1241 Ip4FreeFrameRxToken (Token
);