2 Implement IP4 pesudo interface.
4 Copyright (c) 2005 - 2017, 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
;
564 NET_CHECK_SIGNATURE (Interface
, IP4_INTERFACE_SIGNATURE
);
567 // Set the ip/netmask, then compute the subnet broadcast
568 // and network broadcast for easy access. When computing
569 // nework broadcast, the subnet mask is most like longer
570 // than the default netmask (not subneted) as defined in
571 // RFC793. If that isn't the case, we are aggregating the
572 // networks, use the subnet's mask instead.
574 Interface
->Ip
= IpAddr
;
575 Interface
->SubnetMask
= SubnetMask
;
576 Interface
->SubnetBrdcast
= (IpAddr
| ~SubnetMask
);
577 Interface
->NetBrdcast
= (IpAddr
| ~SubnetMask
);
580 // Do clean up for Arp child
582 if (Interface
->ArpHandle
!= NULL
) {
583 if (Interface
->Arp
!= NULL
) {
585 Interface
->ArpHandle
,
586 &gEfiArpProtocolGuid
,
588 Interface
->Controller
591 Interface
->Arp
= NULL
;
594 NetLibDestroyServiceChild (
595 Interface
->Controller
,
597 &gEfiArpServiceBindingProtocolGuid
,
598 &Interface
->ArpHandle
601 Interface
->ArpHandle
= NULL
;
605 // If the address is NOT all zero, create then configure an ARP child.
606 // Pay attention: DHCP configures its station address as 0.0.0.0/0
608 if (IpAddr
!= IP4_ALLZERO_ADDRESS
) {
609 Status
= NetLibCreateServiceChild (
610 Interface
->Controller
,
612 &gEfiArpServiceBindingProtocolGuid
,
613 &Interface
->ArpHandle
616 if (EFI_ERROR (Status
)) {
620 Status
= gBS
->OpenProtocol (
621 Interface
->ArpHandle
,
622 &gEfiArpProtocolGuid
,
623 (VOID
**) &Interface
->Arp
,
625 Interface
->Controller
,
626 EFI_OPEN_PROTOCOL_BY_DRIVER
629 if (EFI_ERROR (Status
)) {
633 IpAddr
= HTONL (IpAddr
);
634 ArpConfig
.SwAddressType
= IP4_ETHER_PROTO
;
635 ArpConfig
.SwAddressLength
= 4;
636 ArpConfig
.StationAddress
= &IpAddr
;
637 ArpConfig
.EntryTimeOut
= 0;
638 ArpConfig
.RetryCount
= 0;
639 ArpConfig
.RetryTimeOut
= 0;
641 Status
= Interface
->Arp
->Configure (Interface
->Arp
, &ArpConfig
);
643 if (EFI_ERROR (Status
)) {
645 Interface
->ArpHandle
,
646 &gEfiArpProtocolGuid
,
648 Interface
->Controller
655 Interface
->Configured
= TRUE
;
659 NetLibDestroyServiceChild (
660 Interface
->Controller
,
662 &gEfiArpServiceBindingProtocolGuid
,
663 &Interface
->ArpHandle
671 Filter function to cancel all the frame related to an IP instance.
673 @param[in] Frame The transmit request to test whether to cancel
674 @param[in] Context The context which is the Ip instance that issued
677 @retval TRUE The frame belongs to this instance and is to be
679 @retval FALSE The frame doesn't belong to this instance.
683 Ip4CancelInstanceFrame (
684 IN IP4_LINK_TX_TOKEN
*Frame
,
688 if (Frame
->IpInstance
== (IP4_PROTOCOL
*) Context
) {
698 If there is a pending receive request, cancel it. Don't call
699 the receive request's callback because this function can be only
700 called if the instance or driver is tearing itself down. It
701 doesn't make sense to call it back. But it is necessary to call
702 the transmit token's callback to give it a chance to free the
703 packet and update the upper layer's transmit request status, say
706 @param[in] Interface The interface used by the IpInstance
711 IN IP4_INTERFACE
*Interface
715 IP4_LINK_RX_TOKEN
*Token
;
717 if ((Token
= Interface
->RecvRequest
) != NULL
) {
718 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
720 Interface
->RecvRequest
= NULL
;
721 Interface
->Mnp
->Cancel (Interface
->Mnp
, &Token
->MnpToken
);
723 gBS
->RestoreTPL (OldTpl
);
729 Free the interface used by IpInstance. All the IP instance with
730 the same Ip/Netmask pair share the same interface. It is reference
731 counted. All the frames haven't been sent will be cancelled.
732 Because the IpInstance is optional, the caller must remove
733 IpInstance from the interface's instance list itself.
735 @param[in] Interface The interface used by the IpInstance.
736 @param[in] IpInstance The Ip instance that free the interface. NULL if
737 the Ip driver is releasing the default interface.
739 @retval EFI_SUCCESS The interface use IpInstance is freed.
744 IN IP4_INTERFACE
*Interface
,
745 IN IP4_PROTOCOL
*IpInstance OPTIONAL
748 NET_CHECK_SIGNATURE (Interface
, IP4_INTERFACE_SIGNATURE
);
749 ASSERT (Interface
->RefCnt
> 0);
752 // Remove all the pending transmit token related to this IP instance.
754 Ip4CancelFrames (Interface
, EFI_ABORTED
, Ip4CancelInstanceFrame
, IpInstance
);
756 if (--Interface
->RefCnt
> 0) {
761 // Destroy the interface if this is the last IP instance that
762 // has the address. Remove all the system transmitted packets
763 // from this interface, cancel the receive request if there is
764 // one, and destroy the ARP requests.
766 Ip4CancelFrames (Interface
, EFI_ABORTED
, Ip4CancelInstanceFrame
, NULL
);
767 Ip4CancelReceive (Interface
);
769 ASSERT (IsListEmpty (&Interface
->IpInstances
));
770 ASSERT (IsListEmpty (&Interface
->ArpQues
));
771 ASSERT (IsListEmpty (&Interface
->SentFrames
));
773 if (Interface
->Arp
!= NULL
) {
775 Interface
->ArpHandle
,
776 &gEfiArpProtocolGuid
,
778 Interface
->Controller
781 NetLibDestroyServiceChild (
782 Interface
->Controller
,
784 &gEfiArpServiceBindingProtocolGuid
,
789 RemoveEntryList (&Interface
->Link
);
790 FreePool (Interface
);
797 Callback function when ARP request are finished. It will cancelled
798 all the queued frame if the ARP requests failed. Or transmit them
799 if the request succeed.
801 @param[in] Context The context of the callback, a point to the ARP
807 Ip4OnArpResolvedDpc (
814 IP4_INTERFACE
*Interface
;
815 IP4_LINK_TX_TOKEN
*Token
;
818 ArpQue
= (IP4_ARP_QUE
*) Context
;
819 NET_CHECK_SIGNATURE (ArpQue
, IP4_FRAME_ARP_SIGNATURE
);
821 RemoveEntryList (&ArpQue
->Link
);
824 // ARP resolve failed for some reason. Release all the frame
825 // and ARP queue itself. Ip4FreeArpQue will call the frame's
828 if (NET_MAC_EQUAL (&ArpQue
->Mac
, &mZeroMacAddress
, ArpQue
->Interface
->HwaddrLen
)) {
829 Ip4FreeArpQue (ArpQue
, EFI_NO_MAPPING
);
835 // ARP resolve succeeded, Transmit all the frame. Release the ARP
836 // queue. It isn't necessary for us to cache the ARP binding because
837 // we always check the ARP cache first before transmit.
839 Interface
= ArpQue
->Interface
;
841 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, &ArpQue
->Frames
) {
842 RemoveEntryList (Entry
);
844 Token
= NET_LIST_USER_STRUCT (Entry
, IP4_LINK_TX_TOKEN
, Link
);
845 CopyMem (&Token
->DstMac
, &ArpQue
->Mac
, sizeof (Token
->DstMac
));
848 // Insert the tx token before transmitting it via MNP as the FrameSentDpc
849 // may be called before Mnp->Transmit returns which will remove this tx
850 // token from the SentFrames list. Remove it from the list if the returned
851 // Status of Mnp->Transmit is not EFI_SUCCESS as in this case the
852 // FrameSentDpc won't be queued.
854 InsertTailList (&Interface
->SentFrames
, &Token
->Link
);
856 Status
= Interface
->Mnp
->Transmit (Interface
->Mnp
, &Token
->MnpToken
);
857 if (EFI_ERROR (Status
)) {
858 RemoveEntryList (&Token
->Link
);
859 Token
->CallBack (Token
->IpInstance
, Token
->Packet
, Status
, 0, Token
->Context
);
861 Ip4FreeLinkTxToken (Token
);
866 Ip4FreeArpQue (ArpQue
, EFI_SUCCESS
);
870 Request Ip4OnArpResolvedDpc as a DPC at TPL_CALLBACK.
872 @param Event The Arp request event.
873 @param Context The context of the callback, a point to the ARP
885 // Request Ip4OnArpResolvedDpc as a DPC at TPL_CALLBACK
887 QueueDpc (TPL_CALLBACK
, Ip4OnArpResolvedDpc
, Context
);
893 Callback funtion when frame transmission is finished. It will
894 call the frame owner's callback function to tell it the result.
896 @param[in] Context Context which is point to the token.
905 IP4_LINK_TX_TOKEN
*Token
;
907 Token
= (IP4_LINK_TX_TOKEN
*) Context
;
908 NET_CHECK_SIGNATURE (Token
, IP4_FRAME_TX_SIGNATURE
);
910 RemoveEntryList (&Token
->Link
);
915 Token
->MnpToken
.Status
,
920 Ip4FreeLinkTxToken (Token
);
924 Request Ip4OnFrameSentDpc as a DPC at TPL_CALLBACK.
926 @param[in] Event The transmit token's event.
927 @param[in] Context Context which is point to the token.
938 // Request Ip4OnFrameSentDpc as a DPC at TPL_CALLBACK
940 QueueDpc (TPL_CALLBACK
, Ip4OnFrameSentDpc
, Context
);
946 Send a frame from the interface. If the next hop is broadcast or
947 multicast address, it is transmitted immediately. If the next hop
948 is a unicast, it will consult ARP to resolve the NextHop's MAC.
949 If some error happened, the CallBack won't be called. So, the caller
950 must test the return value, and take action when there is an error.
952 @param[in] Interface The interface to send the frame from
953 @param[in] IpInstance The IP child that request the transmission. NULL
954 if it is the IP4 driver itself.
955 @param[in] Packet The packet to transmit.
956 @param[in] NextHop The immediate destination to transmit the packet
958 @param[in] CallBack Function to call back when transmit finished.
959 @param[in] Context Opaque parameter to the call back.
961 @retval EFI_OUT_OF_RESOURCES Failed to allocate resource to send the frame
962 @retval EFI_NO_MAPPING Can't resolve the MAC for the nexthop
963 @retval EFI_SUCCESS The packet is successfully transmitted.
964 @retval other Other error occurs.
969 IN IP4_INTERFACE
*Interface
,
970 IN IP4_PROTOCOL
*IpInstance OPTIONAL
,
973 IN IP4_FRAME_CALLBACK CallBack
,
977 IP4_LINK_TX_TOKEN
*Token
;
980 EFI_ARP_PROTOCOL
*Arp
;
983 ASSERT (Interface
->Configured
);
985 Token
= Ip4WrapLinkTxToken (Interface
, IpInstance
, Packet
, CallBack
, Context
);
988 return EFI_OUT_OF_RESOURCES
;
992 // Get the destination MAC address for multicast and broadcasts.
993 // Don't depend on ARP to solve the address since there maybe no
994 // ARP at all. Ip4Output has set NextHop to 255.255.255.255 for
995 // all the broadcasts.
997 if (NextHop
== IP4_ALLONE_ADDRESS
) {
998 CopyMem (&Token
->DstMac
, &Interface
->BroadcastMac
, sizeof (Token
->DstMac
));
1001 } else if (IP4_IS_MULTICAST (NextHop
)) {
1003 Status
= Ip4GetMulticastMac (Interface
->Mnp
, NextHop
, &Token
->DstMac
);
1005 if (EFI_ERROR (Status
)) {
1013 // Can only send out multicast/broadcast if the IP address is zero
1015 if ((Arp
= Interface
->Arp
) == NULL
) {
1016 Status
= EFI_NO_MAPPING
;
1021 // First check whether this binding is in the ARP cache.
1023 NextHop
= HTONL (NextHop
);
1024 Status
= Arp
->Request (Arp
, &NextHop
, NULL
, &Token
->DstMac
);
1026 if (Status
== EFI_SUCCESS
) {
1029 } else if (Status
!= EFI_NOT_READY
) {
1034 // Have to do asynchronous ARP resolution. First check
1035 // whether there is already a pending request.
1039 NET_LIST_FOR_EACH (Entry
, &Interface
->ArpQues
) {
1040 ArpQue
= NET_LIST_USER_STRUCT (Entry
, IP4_ARP_QUE
, Link
);
1042 if (ArpQue
->Ip
== NextHop
) {
1048 // Found a pending ARP request, enqueue the frame then return
1050 if (Entry
!= &Interface
->ArpQues
) {
1051 InsertTailList (&ArpQue
->Frames
, &Token
->Link
);
1056 // First frame to NextHop, issue an asynchronous ARP requests
1058 ArpQue
= Ip4CreateArpQue (Interface
, NextHop
);
1060 if (ArpQue
== NULL
) {
1061 Status
= EFI_OUT_OF_RESOURCES
;
1065 Status
= Arp
->Request (Arp
, &ArpQue
->Ip
, ArpQue
->OnResolved
, ArpQue
->Mac
.Addr
);
1067 if (EFI_ERROR (Status
) && (Status
!= EFI_NOT_READY
)) {
1068 Ip4FreeArpQue (ArpQue
, EFI_NO_MAPPING
);
1072 InsertHeadList (&ArpQue
->Frames
, &Token
->Link
);
1073 InsertHeadList (&Interface
->ArpQues
, &ArpQue
->Link
);
1078 // Insert the tx token into the SentFrames list before calling Mnp->Transmit.
1079 // Remove it if the returned status is not EFI_SUCCESS.
1081 InsertTailList (&Interface
->SentFrames
, &Token
->Link
);
1082 Status
= Interface
->Mnp
->Transmit (Interface
->Mnp
, &Token
->MnpToken
);
1083 if (EFI_ERROR (Status
)) {
1084 RemoveEntryList (&Token
->Link
);
1091 Ip4FreeLinkTxToken (Token
);
1097 Call back function when the received packet is freed.
1098 Check Ip4OnFrameReceived for information.
1100 @param Context Context, which is the IP4_LINK_RX_TOKEN.
1109 IP4_LINK_RX_TOKEN
*Frame
;
1111 Frame
= (IP4_LINK_RX_TOKEN
*) Context
;
1112 NET_CHECK_SIGNATURE (Frame
, IP4_FRAME_RX_SIGNATURE
);
1114 gBS
->SignalEvent (Frame
->MnpToken
.Packet
.RxData
->RecycleEvent
);
1115 Ip4FreeFrameRxToken (Frame
);
1120 Received a frame from MNP, wrap it in net buffer then deliver
1121 it to IP's input function. The ownship of the packet also
1122 transferred to IP. When Ip is finished with this packet, it
1123 will call NetbufFree to release the packet, NetbufFree will
1124 again call the Ip4RecycleFrame to signal MNP's event and free
1127 @param Context Context for the callback.
1132 Ip4OnFrameReceivedDpc (
1136 EFI_MANAGED_NETWORK_COMPLETION_TOKEN
*MnpToken
;
1137 EFI_MANAGED_NETWORK_RECEIVE_DATA
*MnpRxData
;
1138 IP4_LINK_RX_TOKEN
*Token
;
1139 NET_FRAGMENT Netfrag
;
1143 Token
= (IP4_LINK_RX_TOKEN
*) Context
;
1144 NET_CHECK_SIGNATURE (Token
, IP4_FRAME_RX_SIGNATURE
);
1147 // First clear the interface's receive request in case the
1148 // caller wants to call Ip4ReceiveFrame in the callback.
1150 Token
->Interface
->RecvRequest
= NULL
;
1152 MnpToken
= &Token
->MnpToken
;
1153 MnpRxData
= MnpToken
->Packet
.RxData
;
1155 if (EFI_ERROR (MnpToken
->Status
) || (MnpRxData
== NULL
)) {
1156 Token
->CallBack (Token
->IpInstance
, NULL
, MnpToken
->Status
, 0, Token
->Context
);
1157 Ip4FreeFrameRxToken (Token
);
1163 // Wrap the frame in a net buffer then deliever it to IP input.
1164 // IP will reassemble the packet, and deliver it to upper layer
1166 Netfrag
.Len
= MnpRxData
->DataLength
;
1167 Netfrag
.Bulk
= MnpRxData
->PacketData
;
1169 Packet
= NetbufFromExt (&Netfrag
, 1, 0, IP4_MAX_HEADLEN
, Ip4RecycleFrame
, Token
);
1171 if (Packet
== NULL
) {
1172 gBS
->SignalEvent (MnpRxData
->RecycleEvent
);
1174 Token
->CallBack (Token
->IpInstance
, NULL
, EFI_OUT_OF_RESOURCES
, 0, Token
->Context
);
1175 Ip4FreeFrameRxToken (Token
);
1180 Flag
= (MnpRxData
->BroadcastFlag
? IP4_LINK_BROADCAST
: 0);
1181 Flag
|= (MnpRxData
->MulticastFlag
? IP4_LINK_MULTICAST
: 0);
1182 Flag
|= (MnpRxData
->PromiscuousFlag
? IP4_LINK_PROMISC
: 0);
1184 Token
->CallBack (Token
->IpInstance
, Packet
, EFI_SUCCESS
, Flag
, Token
->Context
);
1188 Request Ip4OnFrameReceivedDpc as a DPC at TPL_CALLBACK.
1190 @param Event The receive event delivered to MNP for receive.
1191 @param Context Context for the callback.
1196 Ip4OnFrameReceived (
1202 // Request Ip4OnFrameReceivedDpc as a DPC at TPL_CALLBACK
1204 QueueDpc (TPL_CALLBACK
, Ip4OnFrameReceivedDpc
, Context
);
1209 Request to receive the packet from the interface.
1211 @param[in] Interface The interface to receive the frames from.
1212 @param[in] IpInstance The instance that requests the receive. NULL for
1214 @param[in] CallBack Function to call when receive finished.
1215 @param[in] Context Opaque parameter to the callback.
1217 @retval EFI_ALREADY_STARTED There is already a pending receive request.
1218 @retval EFI_OUT_OF_RESOURCES Failed to allocate resource to receive.
1219 @retval EFI_SUCCESS The recieve request has been started.
1220 @retval other Other error occurs.
1225 IN IP4_INTERFACE
*Interface
,
1226 IN IP4_PROTOCOL
*IpInstance OPTIONAL
,
1227 IN IP4_FRAME_CALLBACK CallBack
,
1231 IP4_LINK_RX_TOKEN
*Token
;
1234 NET_CHECK_SIGNATURE (Interface
, IP4_INTERFACE_SIGNATURE
);
1236 if (Interface
->RecvRequest
!= NULL
) {
1237 return EFI_ALREADY_STARTED
;
1240 Token
= Ip4CreateLinkRxToken (Interface
, IpInstance
, CallBack
, Context
);
1242 if (Token
== NULL
) {
1243 return EFI_OUT_OF_RESOURCES
;
1246 Interface
->RecvRequest
= Token
;
1247 Status
= Interface
->Mnp
->Receive (Interface
->Mnp
, &Token
->MnpToken
);
1248 if (EFI_ERROR (Status
)) {
1249 Interface
->RecvRequest
= NULL
;
1250 Ip4FreeFrameRxToken (Token
);