3 Copyright (c) 2005 - 2007, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 Implementation of Managed Network Protocol I/O functions.
24 #include <Library/NetLib.h>
25 #include <Library/BaseMemoryLib.h>
26 #include <Library/BaseLib.h>
27 #include <Library/MemoryAllocationLib.h>
31 Validates the Mnp transmit token.
33 @param Instance Pointer to the Mnp instance context data.
34 @param Token Pointer to the transmit token to check.
36 @return The Token is valid or not.
41 IN MNP_INSTANCE_DATA
*Instance
,
42 IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN
*Token
45 MNP_SERVICE_DATA
*MnpServiceData
;
46 EFI_MANAGED_NETWORK_TRANSMIT_DATA
*TxData
;
49 EFI_MANAGED_NETWORK_FRAGMENT_DATA
*FragmentTable
;
51 MnpServiceData
= Instance
->MnpServiceData
;
52 NET_CHECK_SIGNATURE (MnpServiceData
, MNP_SERVICE_DATA_SIGNATURE
);
54 TxData
= Token
->Packet
.TxData
;
56 if ((Token
->Event
== NULL
) || (TxData
== NULL
) || (TxData
->FragmentCount
== 0)) {
58 // The token is invalid if the Event is NULL, or the TxData is NULL, or
59 // the fragment count is zero.
61 DEBUG ((EFI_D_WARN
, "MnpIsValidTxToken: Invalid Token.\n"));
65 if ((TxData
->DestinationAddress
!= NULL
) && (TxData
->HeaderLength
!= 0)) {
67 // The token is invalid if the HeaderLength isn't zero while the DestinationAddress
68 // is NULL (The destination address is already put into the packet).
70 DEBUG ((EFI_D_WARN
, "MnpIsValidTxToken: DestinationAddress isn't NULL, HeaderLength must be 0.\n"));
75 FragmentTable
= TxData
->FragmentTable
;
76 for (Index
= 0; Index
< TxData
->FragmentCount
; Index
++) {
78 if ((FragmentTable
[Index
].FragmentLength
== 0) || (FragmentTable
[Index
].FragmentBuffer
== NULL
)) {
80 // The token is invalid if any FragmentLength is zero or any FragmentBuffer is NULL.
82 DEBUG ((EFI_D_WARN
, "MnpIsValidTxToken: Invalid FragmentLength or FragmentBuffer.\n"));
86 TotalLength
+= FragmentTable
[Index
].FragmentLength
;
89 if ((TxData
->DestinationAddress
== NULL
) && (FragmentTable
[0].FragmentLength
< TxData
->HeaderLength
)) {
91 // Media header is split between fragments.
96 if (TotalLength
!= (TxData
->DataLength
+ TxData
->HeaderLength
)) {
98 // The length calculated from the fragment information doesn't equal to the
99 // sum of the DataLength and the HeaderLength.
101 DEBUG ((EFI_D_WARN
, "MnpIsValidTxData: Invalid Datalength compared with the sum of fragment length.\n"));
105 if (TxData
->DataLength
> MnpServiceData
->Mtu
) {
107 // The total length is larger than the MTU.
109 DEBUG ((EFI_D_WARN
, "MnpIsValidTxData: TxData->DataLength exceeds Mtu.\n"));
118 Build the packet to transmit from the TxData passed in.
120 @param MnpServiceData Pointer to the mnp service context data.
121 @param TxData Pointer to the transmit data containing the
122 information to build the packet.
123 @param PktBuf Pointer to record the address of the packet.
124 @param PktLen Pointer to a UINT32 variable used to record the
132 IN MNP_SERVICE_DATA
*MnpServiceData
,
133 IN EFI_MANAGED_NETWORK_TRANSMIT_DATA
*TxData
,
138 EFI_SIMPLE_NETWORK_MODE
*SnpMode
;
142 if ((TxData
->DestinationAddress
== NULL
) && (TxData
->FragmentCount
== 1)) {
144 // Media header is in FragmentTable and there is only one fragment,
145 // use fragment buffer directly.
147 *PktBuf
= TxData
->FragmentTable
[0].FragmentBuffer
;
148 *PktLen
= TxData
->FragmentTable
[0].FragmentLength
;
151 // Either media header isn't in FragmentTable or there is more than
152 // one fragment, copy the data into the packet buffer. Reserve the
153 // media header space if necessary.
155 SnpMode
= MnpServiceData
->Snp
->Mode
;
156 DstPos
= MnpServiceData
->TxBuf
;
159 if (TxData
->DestinationAddress
!= NULL
) {
161 // If dest address is not NULL, move DstPos to reserve space for the
162 // media header. Add the media header length to buflen.
164 DstPos
+= SnpMode
->MediaHeaderSize
;
165 *PktLen
+= SnpMode
->MediaHeaderSize
;
168 for (Index
= 0; Index
< TxData
->FragmentCount
; Index
++) {
174 TxData
->FragmentTable
[Index
].FragmentBuffer
,
175 TxData
->FragmentTable
[Index
].FragmentLength
177 DstPos
+= TxData
->FragmentTable
[Index
].FragmentLength
;
181 // Set the buffer pointer and the buffer length.
183 *PktBuf
= MnpServiceData
->TxBuf
;
184 *PktLen
+= TxData
->DataLength
+ TxData
->HeaderLength
;
190 Synchronously send out the packet.
192 @param MnpServiceData Pointer to the mnp service context data.
193 @param Packet Pointer to the pakcet buffer.
194 @param Length The length of the packet.
195 @param Token Pointer to the token the packet generated from.
197 @retval EFI_SUCCESS The packet is sent out.
198 @retval EFI_TIMEOUT Time out occurs, the packet isn't sent.
199 @retval EFI_DEVICE_ERROR An unexpected network error occurs.
204 IN MNP_SERVICE_DATA
*MnpServiceData
,
207 IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN
*Token
211 EFI_SIMPLE_NETWORK_PROTOCOL
*Snp
;
212 EFI_MANAGED_NETWORK_TRANSMIT_DATA
*TxData
;
216 Snp
= MnpServiceData
->Snp
;
217 TxData
= Token
->Packet
.TxData
;
219 HeaderSize
= Snp
->Mode
->MediaHeaderSize
- TxData
->HeaderLength
;
222 // Start the timeout event.
224 Status
= gBS
->SetTimer (
225 MnpServiceData
->TxTimeoutEvent
,
229 if (EFI_ERROR (Status
)) {
236 // Transmit the packet through SNP.
238 Status
= Snp
->Transmit (
243 TxData
->SourceAddress
,
244 TxData
->DestinationAddress
,
245 &TxData
->ProtocolType
247 if ((Status
!= EFI_SUCCESS
) && (Status
!= EFI_NOT_READY
)) {
249 Status
= EFI_DEVICE_ERROR
;
254 // If Status is EFI_SUCCESS, the packet is put in the transmit queue.
255 // if Status is EFI_NOT_READY, the transmit engine of the network interface is busy.
256 // Both need to sync SNP.
261 // Get the recycled transmit buffer status.
263 Snp
->GetStatus (Snp
, NULL
, (VOID
**) &TxBuf
);
265 if (!EFI_ERROR (gBS
->CheckEvent (MnpServiceData
->TxTimeoutEvent
))) {
267 Status
= EFI_TIMEOUT
;
270 } while (TxBuf
== NULL
);
272 if ((Status
== EFI_SUCCESS
) || (Status
== EFI_TIMEOUT
)) {
277 // Status is EFI_NOT_READY. Restart the timer event and call Snp->Transmit again.
280 MnpServiceData
->TxTimeoutEvent
,
288 // Cancel the timer event.
290 gBS
->SetTimer (MnpServiceData
->TxTimeoutEvent
, TimerCancel
, 0);
294 Token
->Status
= Status
;
295 gBS
->SignalEvent (Token
->Event
);
298 // Dispatch the DPC queued by the NotifyFunction of Token->Event.
300 NetLibDispatchDpc ();
307 Try to deliver the received packet to the instance.
309 @param Instance Pointer to the mnp instance context data.
311 @retval EFI_SUCCESS The received packet is delivered, or there is no
312 packet to deliver, or there is no available receive
314 @retval EFI_OUT_OF_RESOURCES The deliver fails due to lack of memory resource.
318 MnpInstanceDeliverPacket (
319 IN MNP_INSTANCE_DATA
*Instance
322 MNP_SERVICE_DATA
*MnpServiceData
;
323 MNP_RXDATA_WRAP
*RxDataWrap
;
325 EFI_MANAGED_NETWORK_RECEIVE_DATA
*RxData
;
326 EFI_SIMPLE_NETWORK_MODE
*SnpMode
;
327 EFI_MANAGED_NETWORK_COMPLETION_TOKEN
*RxToken
;
329 MnpServiceData
= Instance
->MnpServiceData
;
330 NET_CHECK_SIGNATURE (MnpServiceData
, MNP_SERVICE_DATA_SIGNATURE
);
332 if (NetMapIsEmpty (&Instance
->RxTokenMap
) || IsListEmpty (&Instance
->RcvdPacketQueue
)) {
334 // No pending received data or no available receive token, return.
339 ASSERT (Instance
->RcvdPacketQueueSize
!= 0);
341 RxDataWrap
= NET_LIST_HEAD (&Instance
->RcvdPacketQueue
, MNP_RXDATA_WRAP
, WrapEntry
);
342 if (RxDataWrap
->Nbuf
->RefCnt
> 2) {
344 // There are other instances share this Nbuf, duplicate to get a
345 // copy to allow the instance to do R/W operations.
347 DupNbuf
= MnpAllocNbuf (MnpServiceData
);
348 if (DupNbuf
== NULL
) {
349 DEBUG ((EFI_D_WARN
, "MnpDeliverPacket: Failed to allocate a free Nbuf.\n"));
351 return EFI_OUT_OF_RESOURCES
;
355 // Duplicate the net buffer.
357 NetbufDuplicate (RxDataWrap
->Nbuf
, DupNbuf
, 0);
358 MnpFreeNbuf (MnpServiceData
, RxDataWrap
->Nbuf
);
359 RxDataWrap
->Nbuf
= DupNbuf
;
363 // All resources are OK, remove the packet from the queue.
365 NetListRemoveHead (&Instance
->RcvdPacketQueue
);
366 Instance
->RcvdPacketQueueSize
--;
368 RxData
= &RxDataWrap
->RxData
;
369 SnpMode
= MnpServiceData
->Snp
->Mode
;
372 // Set all the buffer pointers.
374 RxData
->MediaHeader
= NetbufGetByte (RxDataWrap
->Nbuf
, 0, NULL
);
375 RxData
->DestinationAddress
= RxData
->MediaHeader
;
376 RxData
->SourceAddress
= (UINT8
*) RxData
->MediaHeader
+ SnpMode
->HwAddressSize
;
377 RxData
->PacketData
= (UINT8
*) RxData
->MediaHeader
+ SnpMode
->MediaHeaderSize
;
380 // Insert this RxDataWrap into the delivered queue.
382 InsertTailList (&Instance
->RxDeliveredPacketQueue
, &RxDataWrap
->WrapEntry
);
385 // Get the receive token from the RxTokenMap.
387 RxToken
= NetMapRemoveHead (&Instance
->RxTokenMap
, NULL
);
390 // Signal this token's event.
392 RxToken
->Packet
.RxData
= &RxDataWrap
->RxData
;
393 RxToken
->Status
= EFI_SUCCESS
;
394 gBS
->SignalEvent (RxToken
->Event
);
401 Deliver the received packet for the instances belonging to the MnpServiceData.
403 @param MnpServiceData Pointer to the mnp service context data.
410 IN MNP_SERVICE_DATA
*MnpServiceData
414 MNP_INSTANCE_DATA
*Instance
;
416 NET_CHECK_SIGNATURE (MnpServiceData
, MNP_SERVICE_DATA_SIGNATURE
);
418 NET_LIST_FOR_EACH (Entry
, &MnpServiceData
->ChildrenList
) {
419 Instance
= NET_LIST_USER_STRUCT (Entry
, MNP_INSTANCE_DATA
, InstEntry
);
420 NET_CHECK_SIGNATURE (Instance
, MNP_INSTANCE_DATA_SIGNATURE
);
423 // Try to deliver packet for this instance.
425 MnpInstanceDeliverPacket (Instance
);
431 Recycle the RxData and other resources used to hold and deliver the received
434 @param Event The event this notify function registered to.
435 @param Context Pointer to the context data registerd to the Event.
447 MNP_RXDATA_WRAP
*RxDataWrap
;
448 MNP_SERVICE_DATA
*MnpServiceData
;
450 ASSERT (Context
!= NULL
);
452 RxDataWrap
= (MNP_RXDATA_WRAP
*) Context
;
453 NET_CHECK_SIGNATURE (RxDataWrap
->Instance
, MNP_INSTANCE_DATA_SIGNATURE
);
455 ASSERT (RxDataWrap
->Nbuf
!= NULL
);
457 MnpServiceData
= RxDataWrap
->Instance
->MnpServiceData
;
458 NET_CHECK_SIGNATURE (MnpServiceData
, MNP_SERVICE_DATA_SIGNATURE
);
463 MnpFreeNbuf (MnpServiceData
, RxDataWrap
->Nbuf
);
464 RxDataWrap
->Nbuf
= NULL
;
467 // Close the recycle event.
469 gBS
->CloseEvent (RxDataWrap
->RxData
.RecycleEvent
);
472 // Remove this Wrap entry from the list.
474 RemoveEntryList (&RxDataWrap
->WrapEntry
);
476 gBS
->FreePool (RxDataWrap
);
481 Queue the received packet into instance's receive queue.
483 @param Instance Pointer to the mnp instance context data.
484 @param RxDataWrap Pointer to the Wrap structure containing the
485 received data and other information.
492 IN MNP_INSTANCE_DATA
*Instance
,
493 IN MNP_RXDATA_WRAP
*RxDataWrap
496 MNP_RXDATA_WRAP
*OldRxDataWrap
;
498 NET_CHECK_SIGNATURE (Instance
, MNP_INSTANCE_DATA_SIGNATURE
);
501 // Check the queue size. If it exceeds the limit, drop one packet
504 if (Instance
->RcvdPacketQueueSize
== MNP_MAX_RCVD_PACKET_QUE_SIZE
) {
506 DEBUG ((EFI_D_WARN
, "MnpQueueRcvdPacket: Drop one packet bcz queue size limit reached.\n"));
509 // Get the oldest packet.
511 OldRxDataWrap
= NET_LIST_HEAD (
512 &Instance
->RcvdPacketQueue
,
518 // Recycle this OldRxDataWrap, this entry will be removed by the callee.
520 MnpRecycleRxData (NULL
, (VOID
*) OldRxDataWrap
);
521 Instance
->RcvdPacketQueueSize
--;
525 // Update the timeout tick using the configured parameter.
527 RxDataWrap
->TimeoutTick
= Instance
->ConfigData
.ReceivedQueueTimeoutValue
;
530 // Insert this Wrap into the instance queue.
532 InsertTailList (&Instance
->RcvdPacketQueue
, &RxDataWrap
->WrapEntry
);
533 Instance
->RcvdPacketQueueSize
++;
538 Match the received packet with the instance receive filters.
540 @param Instance Pointer to the mnp instance context data.
541 @param RxData Pointer to the EFI_MANAGED_NETWORK_RECEIVE_DATA.
542 @param GroupAddress Pointer to the GroupAddress, the GroupAddress is
543 non-NULL and it contains the destination multicast
544 mac address of the received packet if the packet
545 destinated to a multicast mac address.
546 @param PktAttr The received packets attribute.
548 @return The received packet matches the instance's receive filters or not.
553 IN MNP_INSTANCE_DATA
*Instance
,
554 IN EFI_MANAGED_NETWORK_RECEIVE_DATA
*RxData
,
555 IN MNP_GROUP_ADDRESS
*GroupAddress OPTIONAL
,
559 EFI_MANAGED_NETWORK_CONFIG_DATA
*ConfigData
;
561 MNP_GROUP_CONTROL_BLOCK
*GroupCtrlBlk
;
563 NET_CHECK_SIGNATURE (Instance
, MNP_INSTANCE_DATA_SIGNATURE
);
565 ConfigData
= &Instance
->ConfigData
;
568 // Check the protocol type.
570 if ((ConfigData
->ProtocolTypeFilter
!= 0) && (ConfigData
->ProtocolTypeFilter
!= RxData
->ProtocolType
)) {
574 if (ConfigData
->EnablePromiscuousReceive
) {
576 // Always match if this instance is configured to be promiscuous.
582 // The protocol type is matched, check receive filter, include unicast and broadcast.
584 if ((Instance
->ReceiveFilter
& PktAttr
) != 0) {
589 // Check multicast addresses.
591 if (ConfigData
->EnableMulticastReceive
&& RxData
->MulticastFlag
) {
593 ASSERT (GroupAddress
!= NULL
);
595 NET_LIST_FOR_EACH (Entry
, &Instance
->GroupCtrlBlkList
) {
597 GroupCtrlBlk
= NET_LIST_USER_STRUCT (Entry
, MNP_GROUP_CONTROL_BLOCK
, CtrlBlkEntry
);
598 if (GroupCtrlBlk
->GroupAddress
== GroupAddress
) {
600 // The instance is configured to receiveing packets destinated to this
601 // multicast address.
616 Analyse the received packets.
618 @param MnpServiceData Pointer to the mnp service context data.
619 @param Nbuf Pointer to the net buffer holding the received
621 @param RxData Pointer to the buffer used to save the analysed
622 result in EFI_MANAGED_NETWORK_RECEIVE_DATA.
623 @param GroupAddress Pointer to pointer to a MNP_GROUP_ADDRESS used to
624 pass out the address of the multicast address the
625 received packet destinated to.
626 @param PktAttr Pointer to the buffer used to save the analysed
634 IN MNP_SERVICE_DATA
*MnpServiceData
,
636 IN EFI_MANAGED_NETWORK_RECEIVE_DATA
*RxData
,
637 OUT MNP_GROUP_ADDRESS
**GroupAddress
,
641 EFI_SIMPLE_NETWORK_MODE
*SnpMode
;
645 SnpMode
= MnpServiceData
->Snp
->Mode
;
648 // Get the packet buffer.
650 BufPtr
= NetbufGetByte (Nbuf
, 0, NULL
);
651 ASSERT (BufPtr
!= NULL
);
654 // Set the initial values.
656 RxData
->BroadcastFlag
= FALSE
;
657 RxData
->MulticastFlag
= FALSE
;
658 RxData
->PromiscuousFlag
= FALSE
;
659 *PktAttr
= UNICAST_PACKET
;
661 if (!NET_MAC_EQUAL (&SnpMode
->CurrentAddress
, BufPtr
, SnpMode
->HwAddressSize
)) {
663 // This packet isn't destinated to our current mac address, it't not unicast.
667 if (NET_MAC_EQUAL (&SnpMode
->BroadcastAddress
, BufPtr
, SnpMode
->HwAddressSize
)) {
671 RxData
->BroadcastFlag
= TRUE
;
672 *PktAttr
= BROADCAST_PACKET
;
673 } else if ((*BufPtr
& 0x01) == 0x1) {
675 // It's multicast, try to match the multicast filters.
677 NET_LIST_FOR_EACH (Entry
, &MnpServiceData
->GroupAddressList
) {
679 *GroupAddress
= NET_LIST_USER_STRUCT (Entry
, MNP_GROUP_ADDRESS
, AddrEntry
);
680 if (NET_MAC_EQUAL (BufPtr
, &((*GroupAddress
)->Address
), SnpMode
->HwAddressSize
)) {
681 RxData
->MulticastFlag
= TRUE
;
686 if (!RxData
->MulticastFlag
) {
688 // No match, set GroupAddress to NULL. This multicast packet must
689 // be the result of PROMISUCOUS or PROMISUCOUS_MULTICAST flag is on.
691 *GroupAddress
= NULL
;
692 RxData
->PromiscuousFlag
= TRUE
;
694 if (MnpServiceData
->PromiscuousCount
== 0) {
696 // Skip the below code, there is no receiver of this packet.
702 RxData
->PromiscuousFlag
= TRUE
;
706 ZeroMem (&RxData
->Timestamp
, sizeof (EFI_TIME
));
709 // Fill the common parts of RxData.
711 RxData
->PacketLength
= Nbuf
->TotalSize
;
712 RxData
->HeaderLength
= SnpMode
->MediaHeaderSize
;
713 RxData
->AddressLength
= SnpMode
->HwAddressSize
;
714 RxData
->DataLength
= RxData
->PacketLength
- RxData
->HeaderLength
;
715 RxData
->ProtocolType
= NTOHS (*(UINT16
*) (BufPtr
+ 2 * SnpMode
->HwAddressSize
));
722 @param Instance Pointer to the mnp instance context data.
723 @param RxData Pointer to the receive data to wrap.
725 @return Pointer to a MNP_RXDATA_WRAP which wraps the RxData.
730 IN MNP_INSTANCE_DATA
*Instance
,
731 IN EFI_MANAGED_NETWORK_RECEIVE_DATA
*RxData
735 MNP_RXDATA_WRAP
*RxDataWrap
;
740 RxDataWrap
= AllocatePool (sizeof (MNP_RXDATA_WRAP
));
741 if (RxDataWrap
== NULL
) {
742 DEBUG ((EFI_D_ERROR
, "MnpDispatchPacket: Failed to allocate a MNP_RXDATA_WRAP.\n"));
746 RxDataWrap
->Instance
= Instance
;
749 // Fill the RxData in RxDataWrap,
751 CopyMem (&RxDataWrap
->RxData
, RxData
, sizeof (RxDataWrap
->RxData
));
754 // Create the recycle event.
756 Status
= gBS
->CreateEvent (
761 &RxDataWrap
->RxData
.RecycleEvent
763 if (EFI_ERROR (Status
)) {
765 DEBUG ((EFI_D_ERROR
, "MnpDispatchPacket: gBS->CreateEvent failed, %r.\n", Status
));
766 gBS
->FreePool (RxDataWrap
);
775 Enqueue the received the packets to the instances belonging to the
778 @param MnpServiceData Pointer to the mnp service context data.
779 @param Nbuf Pointer to the net buffer representing the received
787 IN MNP_SERVICE_DATA
*MnpServiceData
,
792 MNP_INSTANCE_DATA
*Instance
;
793 EFI_MANAGED_NETWORK_RECEIVE_DATA RxData
;
795 MNP_GROUP_ADDRESS
*GroupAddress
;
796 MNP_RXDATA_WRAP
*RxDataWrap
;
801 // First, analyse the packet header.
803 MnpAnalysePacket (MnpServiceData
, Nbuf
, &RxData
, &GroupAddress
, &PktAttr
);
805 if (RxData
.PromiscuousFlag
&& (MnpServiceData
->PromiscuousCount
== 0)) {
807 // No receivers, no more action need.
813 // Iterate the children to find match.
815 NET_LIST_FOR_EACH (Entry
, &MnpServiceData
->ChildrenList
) {
817 Instance
= NET_LIST_USER_STRUCT (Entry
, MNP_INSTANCE_DATA
, InstEntry
);
818 NET_CHECK_SIGNATURE (Instance
, MNP_INSTANCE_DATA_SIGNATURE
);
820 if (!Instance
->Configured
) {
825 // Check the packet against the instance receive filters.
827 if (MnpMatchPacket (Instance
, &RxData
, GroupAddress
, PktAttr
)) {
832 RxDataWrap
= MnpWrapRxData (Instance
, &RxData
);
833 if (RxDataWrap
== NULL
) {
838 // Associate RxDataWrap with Nbuf and increase the RefCnt.
840 RxDataWrap
->Nbuf
= Nbuf
;
841 NET_GET_REF (RxDataWrap
->Nbuf
);
844 // Queue the packet into the instance queue.
846 MnpQueueRcvdPacket (Instance
, RxDataWrap
);
853 Try to receive a packet and deliver it.
855 @param MnpServiceData Pointer to the mnp service context data.
857 @retval EFI_SUCCESS add return value to function comment
858 @retval EFI_NOT_STARTED The simple network protocol is not started.
859 @retval EFI_NOT_READY No packet received.
860 @retval EFI_DEVICE_ERROR An unexpected error occurs.
865 IN MNP_SERVICE_DATA
*MnpServiceData
869 EFI_SIMPLE_NETWORK_PROTOCOL
*Snp
;
876 NET_CHECK_SIGNATURE (MnpServiceData
, MNP_SERVICE_DATA_SIGNATURE
);
878 Snp
= MnpServiceData
->Snp
;
879 if (Snp
->Mode
->State
!= EfiSimpleNetworkInitialized
) {
881 // The simple network protocol is not started.
883 return EFI_NOT_STARTED
;
886 if (IsListEmpty (&MnpServiceData
->ChildrenList
)) {
888 // There is no child, no need to receive packets.
893 if (MnpServiceData
->RxNbufCache
== NULL
) {
895 // Try to get a new buffer as there may be buffers recycled.
897 MnpServiceData
->RxNbufCache
= MnpAllocNbuf (MnpServiceData
);
899 if (MnpServiceData
->RxNbufCache
== NULL
) {
901 // No availabe buffer in the buffer pool.
903 return EFI_DEVICE_ERROR
;
907 MnpServiceData
->RxNbufCache
,
908 MnpServiceData
->BufferLength
,
913 Nbuf
= MnpServiceData
->RxNbufCache
;
914 BufLen
= Nbuf
->TotalSize
;
915 BufPtr
= NetbufGetByte (Nbuf
, 0, NULL
);
916 ASSERT (BufPtr
!= NULL
);
919 // Receive packet through Snp.
921 Status
= Snp
->Receive (Snp
, &HeaderSize
, &BufLen
, BufPtr
, NULL
, NULL
, NULL
);
922 if (EFI_ERROR (Status
)) {
925 if (Status
!= EFI_NOT_READY
) {
926 DEBUG ((EFI_D_WARN
, "MnpReceivePacket: Snp->Receive() = %r.\n", Status
));
936 if ((HeaderSize
!= Snp
->Mode
->MediaHeaderSize
) || (BufLen
< HeaderSize
)) {
940 "MnpReceivePacket: Size error, HL:TL = %d:%d.\n",
944 return EFI_DEVICE_ERROR
;
948 if (Nbuf
->TotalSize
!= BufLen
) {
950 // Trim the packet from tail.
952 Trimmed
= NetbufTrim (Nbuf
, Nbuf
->TotalSize
- (UINT32
) BufLen
, NET_BUF_TAIL
);
953 ASSERT (Nbuf
->TotalSize
== BufLen
);
957 // Enqueue the packet to the matched instances.
959 MnpEnqueuePacket (MnpServiceData
, Nbuf
);
961 if (Nbuf
->RefCnt
> 2) {
963 // RefCnt > 2 indicates there is at least one receiver of this packet.
964 // Free the current RxNbufCache and allocate a new one.
966 MnpFreeNbuf (MnpServiceData
, Nbuf
);
968 Nbuf
= MnpAllocNbuf (MnpServiceData
);
969 MnpServiceData
->RxNbufCache
= Nbuf
;
971 DEBUG ((EFI_D_ERROR
, "MnpReceivePacket: Alloc packet for receiving cache failed.\n"));
972 return EFI_DEVICE_ERROR
;
975 NetbufAllocSpace (Nbuf
, MnpServiceData
->BufferLength
, NET_BUF_TAIL
);
978 // No receiver for this packet.
981 NetbufAllocSpace (Nbuf
, Trimmed
, NET_BUF_TAIL
);
987 // Deliver the queued packets.
989 MnpDeliverPacket (MnpServiceData
);
992 // Dispatch the DPC queued by the NotifyFunction of rx token's events.
994 NetLibDispatchDpc ();
998 ASSERT (Nbuf
->TotalSize
== MnpServiceData
->BufferLength
);
1005 Remove the received packets if timeout occurs.
1007 @param Event The event this notify function registered to.
1008 @param Context Pointer to the context data registered to the
1016 MnpCheckPacketTimeout (
1021 MNP_SERVICE_DATA
*MnpServiceData
;
1023 LIST_ENTRY
*RxEntry
;
1024 LIST_ENTRY
*NextEntry
;
1025 MNP_INSTANCE_DATA
*Instance
;
1026 MNP_RXDATA_WRAP
*RxDataWrap
;
1029 MnpServiceData
= (MNP_SERVICE_DATA
*) Context
;
1030 NET_CHECK_SIGNATURE (MnpServiceData
, MNP_SERVICE_DATA_SIGNATURE
);
1032 NET_LIST_FOR_EACH (Entry
, &MnpServiceData
->ChildrenList
) {
1034 Instance
= NET_LIST_USER_STRUCT (Entry
, MNP_INSTANCE_DATA
, InstEntry
);
1035 NET_CHECK_SIGNATURE (Instance
, MNP_INSTANCE_DATA_SIGNATURE
);
1037 if (!Instance
->Configured
|| (Instance
->ConfigData
.ReceivedQueueTimeoutValue
== 0)) {
1039 // This instance is not configured or there is no receive time out,
1040 // just skip to the next instance.
1045 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
1047 NET_LIST_FOR_EACH_SAFE (RxEntry
, NextEntry
, &Instance
->RcvdPacketQueue
) {
1049 RxDataWrap
= NET_LIST_USER_STRUCT (RxEntry
, MNP_RXDATA_WRAP
, WrapEntry
);
1051 if (RxDataWrap
->TimeoutTick
>= MNP_TIMEOUT_CHECK_INTERVAL
) {
1053 RxDataWrap
->TimeoutTick
-= MNP_TIMEOUT_CHECK_INTERVAL
;
1056 // Drop the timeout packet.
1058 DEBUG ((EFI_D_WARN
, "MnpCheckPacketTimeout: Received packet timeout.\n"));
1059 MnpRecycleRxData (NULL
, RxDataWrap
);
1060 Instance
->RcvdPacketQueueSize
--;
1064 gBS
->RestoreTPL (OldTpl
);
1070 Poll to receive the packets from Snp. This function is either called by upperlayer
1071 protocols/applications or the system poll timer notify mechanism.
1073 @param Event The event this notify function registered to.
1074 @param Context Pointer to the context data registered to the
1087 MNP_SERVICE_DATA
*MnpServiceData
;
1089 MnpServiceData
= (MNP_SERVICE_DATA
*) Context
;
1090 NET_CHECK_SIGNATURE (MnpServiceData
, MNP_SERVICE_DATA_SIGNATURE
);
1093 // Try to receive packets from Snp.
1095 MnpReceivePacket (MnpServiceData
);
1097 NetLibDispatchDpc ();