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.
23 #include <Library/NetLib.h>
24 #include <Library/BaseMemoryLib.h>
25 #include <Library/BaseLib.h>
26 #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_SIMPLE_NETWORK_MODE
*SnpMode
;
47 EFI_MANAGED_NETWORK_TRANSMIT_DATA
*TxData
;
50 EFI_MANAGED_NETWORK_FRAGMENT_DATA
*FragmentTable
;
52 MnpServiceData
= Instance
->MnpServiceData
;
53 NET_CHECK_SIGNATURE (MnpServiceData
, MNP_SERVICE_DATA_SIGNATURE
);
55 SnpMode
= MnpServiceData
->Snp
->Mode
;
56 TxData
= Token
->Packet
.TxData
;
58 if ((Token
->Event
== NULL
) || (TxData
== NULL
) || (TxData
->FragmentCount
== 0)) {
60 // The token is invalid if the Event is NULL, or the TxData is NULL, or
61 // the fragment count is zero.
63 MNP_DEBUG_WARN (("MnpIsValidTxToken: Invalid Token.\n"));
67 if ((TxData
->DestinationAddress
!= NULL
) && (TxData
->HeaderLength
!= 0)) {
69 // The token is invalid if the HeaderLength isn't zero while the DestinationAddress
70 // is NULL (The destination address is already put into the packet).
72 MNP_DEBUG_WARN (("MnpIsValidTxToken: DestinationAddress isn't NULL, HeaderLength must be 0.\n"));
77 FragmentTable
= TxData
->FragmentTable
;
78 for (Index
= 0; Index
< TxData
->FragmentCount
; Index
++) {
80 if ((FragmentTable
[Index
].FragmentLength
== 0) || (FragmentTable
[Index
].FragmentBuffer
== NULL
)) {
82 // The token is invalid if any FragmentLength is zero or any FragmentBuffer is NULL.
84 MNP_DEBUG_WARN (("MnpIsValidTxToken: Invalid FragmentLength or FragmentBuffer.\n"));
88 TotalLength
+= FragmentTable
[Index
].FragmentLength
;
91 if ((TxData
->DestinationAddress
== NULL
) && (FragmentTable
[0].FragmentLength
< TxData
->HeaderLength
)) {
93 // Media header is split between fragments.
98 if (TotalLength
!= (TxData
->DataLength
+ TxData
->HeaderLength
)) {
100 // The length calculated from the fragment information doesn't equal to the
101 // sum of the DataLength and the HeaderLength.
103 MNP_DEBUG_WARN (("MnpIsValidTxData: Invalid Datalength compared with the sum of fragment length.\n"));
107 if (TxData
->DataLength
> MnpServiceData
->Mtu
) {
109 // The total length is larger than the MTU.
111 MNP_DEBUG_WARN (("MnpIsValidTxData: TxData->DataLength exceeds Mtu.\n"));
120 Build the packet to transmit from the TxData passed in.
122 @param MnpServiceData Pointer to the mnp service context data.
123 @param TxData Pointer to the transmit data containing the
124 information to build the packet.
125 @param PktBuf Pointer to record the address of the packet.
126 @param PktLen Pointer to a UINT32 variable used to record the
134 IN MNP_SERVICE_DATA
*MnpServiceData
,
135 IN EFI_MANAGED_NETWORK_TRANSMIT_DATA
*TxData
,
140 EFI_SIMPLE_NETWORK_MODE
*SnpMode
;
144 if ((TxData
->DestinationAddress
== NULL
) && (TxData
->FragmentCount
== 1)) {
146 // Media header is in FragmentTable and there is only one fragment,
147 // use fragment buffer directly.
149 *PktBuf
= TxData
->FragmentTable
[0].FragmentBuffer
;
150 *PktLen
= TxData
->FragmentTable
[0].FragmentLength
;
153 // Either media header isn't in FragmentTable or there is more than
154 // one fragment, copy the data into the packet buffer. Reserve the
155 // media header space if necessary.
157 SnpMode
= MnpServiceData
->Snp
->Mode
;
158 DstPos
= MnpServiceData
->TxBuf
;
161 if (TxData
->DestinationAddress
!= NULL
) {
163 // If dest address is not NULL, move DstPos to reserve space for the
164 // media header. Add the media header length to buflen.
166 DstPos
+= SnpMode
->MediaHeaderSize
;
167 *PktLen
+= SnpMode
->MediaHeaderSize
;
170 for (Index
= 0; Index
< TxData
->FragmentCount
; Index
++) {
176 TxData
->FragmentTable
[Index
].FragmentBuffer
,
177 TxData
->FragmentTable
[Index
].FragmentLength
179 DstPos
+= TxData
->FragmentTable
[Index
].FragmentLength
;
183 // Set the buffer pointer and the buffer length.
185 *PktBuf
= MnpServiceData
->TxBuf
;
186 *PktLen
+= TxData
->DataLength
+ TxData
->HeaderLength
;
192 Synchronously send out the packet.
194 @param MnpServiceData Pointer to the mnp service context data.
195 @param Packet Pointer to the pakcet buffer.
196 @param Length The length of the packet.
197 @param Token Pointer to the token the packet generated from.
199 @retval EFI_SUCCESS The packet is sent out.
200 @retval EFI_TIMEOUT Time out occurs, the packet isn't sent.
201 @retval EFI_DEVICE_ERROR An unexpected network error occurs.
206 IN MNP_SERVICE_DATA
*MnpServiceData
,
209 IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN
*Token
213 EFI_SIMPLE_NETWORK_PROTOCOL
*Snp
;
214 EFI_MANAGED_NETWORK_TRANSMIT_DATA
*TxData
;
218 Snp
= MnpServiceData
->Snp
;
219 TxData
= Token
->Packet
.TxData
;
221 HeaderSize
= Snp
->Mode
->MediaHeaderSize
- TxData
->HeaderLength
;
224 // Start the timeout event.
226 Status
= gBS
->SetTimer (
227 MnpServiceData
->TxTimeoutEvent
,
231 if (EFI_ERROR (Status
)) {
238 // Transmit the packet through SNP.
240 Status
= Snp
->Transmit (
245 TxData
->SourceAddress
,
246 TxData
->DestinationAddress
,
247 &TxData
->ProtocolType
249 if ((Status
!= EFI_SUCCESS
) && (Status
!= EFI_NOT_READY
)) {
251 Status
= EFI_DEVICE_ERROR
;
256 // If Status is EFI_SUCCESS, the packet is put in the transmit queue.
257 // if Status is EFI_NOT_READY, the transmit engine of the network interface is busy.
258 // Both need to sync SNP.
263 // Get the recycled transmit buffer status.
265 Snp
->GetStatus (Snp
, NULL
, &TxBuf
);
267 if (!EFI_ERROR (gBS
->CheckEvent (MnpServiceData
->TxTimeoutEvent
))) {
269 Status
= EFI_TIMEOUT
;
272 } while (TxBuf
== NULL
);
274 if ((Status
== EFI_SUCCESS
) || (Status
== EFI_TIMEOUT
)) {
279 // Status is EFI_NOT_READY. Restart the timer event and call Snp->Transmit again.
282 MnpServiceData
->TxTimeoutEvent
,
290 // Cancel the timer event.
292 gBS
->SetTimer (MnpServiceData
->TxTimeoutEvent
, TimerCancel
, 0);
296 Token
->Status
= Status
;
297 gBS
->SignalEvent (Token
->Event
);
304 Try to deliver the received packet to the instance.
306 @param Instance Pointer to the mnp instance context data.
308 @retval EFI_SUCCESS The received packet is delivered, or there is no
309 packet to deliver, or there is no available receive
311 @retval EFI_OUT_OF_RESOURCES The deliver fails due to lack of memory resource.
315 MnpInstanceDeliverPacket (
316 IN MNP_INSTANCE_DATA
*Instance
319 MNP_SERVICE_DATA
*MnpServiceData
;
320 MNP_RXDATA_WRAP
*RxDataWrap
;
322 EFI_MANAGED_NETWORK_RECEIVE_DATA
*RxData
;
323 EFI_SIMPLE_NETWORK_MODE
*SnpMode
;
324 EFI_MANAGED_NETWORK_COMPLETION_TOKEN
*RxToken
;
326 MnpServiceData
= Instance
->MnpServiceData
;
327 NET_CHECK_SIGNATURE (MnpServiceData
, MNP_SERVICE_DATA_SIGNATURE
);
329 if (NetMapIsEmpty (&Instance
->RxTokenMap
) || NetListIsEmpty (&Instance
->RcvdPacketQueue
)) {
331 // No pending received data or no available receive token, return.
336 ASSERT (Instance
->RcvdPacketQueueSize
!= 0);
338 RxDataWrap
= NET_LIST_HEAD (&Instance
->RcvdPacketQueue
, MNP_RXDATA_WRAP
, WrapEntry
);
339 if (RxDataWrap
->Nbuf
->RefCnt
> 2) {
341 // There are other instances share this Nbuf, duplicate to get a
342 // copy to allow the instance to do R/W operations.
344 DupNbuf
= MnpAllocNbuf (MnpServiceData
);
345 if (DupNbuf
== NULL
) {
346 MNP_DEBUG_WARN (("MnpDeliverPacket: Failed to allocate a free Nbuf.\n"));
348 return EFI_OUT_OF_RESOURCES
;
352 // Duplicate the net buffer.
354 NetbufDuplicate (RxDataWrap
->Nbuf
, DupNbuf
, 0);
355 MnpFreeNbuf (MnpServiceData
, RxDataWrap
->Nbuf
);
356 RxDataWrap
->Nbuf
= DupNbuf
;
360 // All resources are OK, remove the packet from the queue.
362 NetListRemoveHead (&Instance
->RcvdPacketQueue
);
363 Instance
->RcvdPacketQueueSize
--;
365 RxData
= &RxDataWrap
->RxData
;
366 SnpMode
= MnpServiceData
->Snp
->Mode
;
369 // Set all the buffer pointers.
371 RxData
->MediaHeader
= NetbufGetByte (RxDataWrap
->Nbuf
, 0, NULL
);
372 RxData
->DestinationAddress
= RxData
->MediaHeader
;
373 RxData
->SourceAddress
= (UINT8
*) RxData
->MediaHeader
+ SnpMode
->HwAddressSize
;
374 RxData
->PacketData
= (UINT8
*) RxData
->MediaHeader
+ SnpMode
->MediaHeaderSize
;
377 // Insert this RxDataWrap into the delivered queue.
379 NetListInsertTail (&Instance
->RxDeliveredPacketQueue
, &RxDataWrap
->WrapEntry
);
382 // Get the receive token from the RxTokenMap.
384 RxToken
= NetMapRemoveHead (&Instance
->RxTokenMap
, NULL
);
387 // Signal this token's event.
389 RxToken
->Packet
.RxData
= &RxDataWrap
->RxData
;
390 RxToken
->Status
= EFI_SUCCESS
;
391 gBS
->SignalEvent (RxToken
->Event
);
398 Deliver the received packet for the instances belonging to the MnpServiceData.
400 @param MnpServiceData Pointer to the mnp service context data.
408 IN MNP_SERVICE_DATA
*MnpServiceData
411 NET_LIST_ENTRY
*Entry
;
412 MNP_INSTANCE_DATA
*Instance
;
414 NET_CHECK_SIGNATURE (MnpServiceData
, MNP_SERVICE_DATA_SIGNATURE
);
416 NET_LIST_FOR_EACH (Entry
, &MnpServiceData
->ChildrenList
) {
417 Instance
= NET_LIST_USER_STRUCT (Entry
, MNP_INSTANCE_DATA
, InstEntry
);
418 NET_CHECK_SIGNATURE (Instance
, MNP_INSTANCE_DATA_SIGNATURE
);
421 // Try to deliver packet for this instance.
423 MnpInstanceDeliverPacket (Instance
);
429 Recycle the RxData and other resources used to hold and deliver the received
432 @param Event The event this notify function registered to.
433 @param Context Pointer to the context data registerd to the Event.
445 MNP_RXDATA_WRAP
*RxDataWrap
;
446 MNP_SERVICE_DATA
*MnpServiceData
;
448 ASSERT (Context
!= NULL
);
450 RxDataWrap
= (MNP_RXDATA_WRAP
*) Context
;
451 NET_CHECK_SIGNATURE (RxDataWrap
->Instance
, MNP_INSTANCE_DATA_SIGNATURE
);
453 ASSERT (RxDataWrap
->Nbuf
!= NULL
);
455 MnpServiceData
= RxDataWrap
->Instance
->MnpServiceData
;
456 NET_CHECK_SIGNATURE (MnpServiceData
, MNP_SERVICE_DATA_SIGNATURE
);
461 MnpFreeNbuf (MnpServiceData
, RxDataWrap
->Nbuf
);
462 RxDataWrap
->Nbuf
= NULL
;
465 // Close the recycle event.
467 gBS
->CloseEvent (RxDataWrap
->RxData
.RecycleEvent
);
470 // Remove this Wrap entry from the list.
472 NetListRemoveEntry (&RxDataWrap
->WrapEntry
);
474 NetFreePool (RxDataWrap
);
479 Queue the received packet into instance's receive queue.
481 @param Instance Pointer to the mnp instance context data.
482 @param RxDataWrap Pointer to the Wrap structure containing the
483 received data and other information.
491 IN MNP_INSTANCE_DATA
*Instance
,
492 IN MNP_RXDATA_WRAP
*RxDataWrap
495 MNP_RXDATA_WRAP
*OldRxDataWrap
;
497 NET_CHECK_SIGNATURE (Instance
, MNP_INSTANCE_DATA_SIGNATURE
);
500 // Check the queue size. If it exceeds the limit, drop one packet
503 if (Instance
->RcvdPacketQueueSize
== MNP_MAX_RCVD_PACKET_QUE_SIZE
) {
505 MNP_DEBUG_WARN (("MnpQueueRcvdPacket: Drop one packet bcz queue size limit reached.\n"));
508 // Get the oldest packet.
510 OldRxDataWrap
= NET_LIST_HEAD (
511 &Instance
->RcvdPacketQueue
,
517 // Recycle this OldRxDataWrap, this entry will be removed by the callee.
519 MnpRecycleRxData (NULL
, (VOID
*) OldRxDataWrap
);
520 Instance
->RcvdPacketQueueSize
--;
524 // Update the timeout tick using the configured parameter.
526 RxDataWrap
->TimeoutTick
= Instance
->ConfigData
.ReceivedQueueTimeoutValue
;
529 // Insert this Wrap into the instance queue.
531 NetListInsertTail (&Instance
->RcvdPacketQueue
, &RxDataWrap
->WrapEntry
);
532 Instance
->RcvdPacketQueueSize
++;
537 Match the received packet with the instance receive filters.
539 @param Instance Pointer to the mnp instance context data.
540 @param RxData Pointer to the EFI_MANAGED_NETWORK_RECEIVE_DATA.
541 @param GroupAddress Pointer to the GroupAddress, the GroupAddress is
542 non-NULL and it contains the destination multicast
543 mac address of the received packet if the packet
544 destinated to a multicast mac address.
545 @param PktAttr The received packets attribute.
547 @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
;
560 NET_LIST_ENTRY
*Entry
;
561 MNP_GROUP_CONTROL_BLOCK
*GroupCtrlBlk
;
563 NET_CHECK_SIGNATURE (Instance
, MNP_INSTANCE_DATA_SIGNATURE
);
565 ConfigData
= &Instance
->ConfigData
;
567 if (ConfigData
->EnablePromiscuousReceive
) {
569 // Always match if this instance is configured to be promiscuous.
574 // Check the protocol type.
576 if ((ConfigData
->ProtocolTypeFilter
!= 0) && (ConfigData
->ProtocolTypeFilter
!= RxData
->ProtocolType
)) {
581 // The protocol type is matched, check receive filter, include unicast and broadcast.
583 if ((Instance
->ReceiveFilter
& PktAttr
) != 0) {
588 // Check multicast addresses.
590 if (ConfigData
->EnableMulticastReceive
&& RxData
->MulticastFlag
) {
592 ASSERT (GroupAddress
!= NULL
);
594 NET_LIST_FOR_EACH (Entry
, &Instance
->GroupCtrlBlkList
) {
596 GroupCtrlBlk
= NET_LIST_USER_STRUCT (Entry
, MNP_GROUP_CONTROL_BLOCK
, CtrlBlkEntry
);
597 if (GroupCtrlBlk
->GroupAddress
== GroupAddress
) {
599 // The instance is configured to receiveing packets destinated to this
600 // multicast address.
615 Analyse the received packets.
617 @param MnpServiceData Pointer to the mnp service context data.
618 @param Nbuf Pointer to the net buffer holding the received
620 @param RxData Pointer to the buffer used to save the analysed
621 result in EFI_MANAGED_NETWORK_RECEIVE_DATA.
622 @param GroupAddress Pointer to pointer to a MNP_GROUP_ADDRESS used to
623 pass out the address of the multicast address the
624 received packet destinated to.
625 @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
;
643 NET_LIST_ENTRY
*Entry
;
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 NetZeroMem (&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.
731 IN MNP_INSTANCE_DATA
*Instance
,
732 IN EFI_MANAGED_NETWORK_RECEIVE_DATA
*RxData
736 MNP_RXDATA_WRAP
*RxDataWrap
;
741 RxDataWrap
= NetAllocatePool (sizeof (MNP_RXDATA_WRAP
));
742 if (RxDataWrap
== NULL
) {
743 MNP_DEBUG_ERROR (("MnpDispatchPacket: Failed to allocate a MNP_RXDATA_WRAP.\n"));
747 RxDataWrap
->Instance
= Instance
;
750 // Fill the RxData in RxDataWrap,
752 RxDataWrap
->RxData
= *RxData
;
755 // Create the recycle event.
757 Status
= gBS
->CreateEvent (
762 &RxDataWrap
->RxData
.RecycleEvent
764 if (EFI_ERROR (Status
)) {
766 MNP_DEBUG_ERROR (("MnpDispatchPacket: gBS->CreateEvent failed, %r.\n", Status
));
767 NetFreePool (RxDataWrap
);
776 Enqueue the received the packets to the instances belonging to the
779 @param MnpServiceData Pointer to the mnp service context data.
780 @param Nbuf Pointer to the net buffer representing the received
789 IN MNP_SERVICE_DATA
*MnpServiceData
,
793 NET_LIST_ENTRY
*Entry
;
794 MNP_INSTANCE_DATA
*Instance
;
795 EFI_MANAGED_NETWORK_RECEIVE_DATA RxData
;
797 MNP_GROUP_ADDRESS
*GroupAddress
;
798 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 (NetListIsEmpty (&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 MNP_DEBUG_ERROR (("MnpReceivePacket: Snp->Receive() = %r.\n", Status
));
936 if ((HeaderSize
!= Snp
->Mode
->MediaHeaderSize
) || (BufLen
< HeaderSize
)) {
939 ("MnpReceivePacket: Size error, HL:TL = %d:%d.\n",
943 return EFI_DEVICE_ERROR
;
947 if (Nbuf
->TotalSize
!= BufLen
) {
949 // Trim the packet from tail.
951 Trimmed
= NetbufTrim (Nbuf
, Nbuf
->TotalSize
- (UINT32
) BufLen
, NET_BUF_TAIL
);
952 ASSERT (Nbuf
->TotalSize
== BufLen
);
956 // Enqueue the packet to the matched instances.
958 MnpEnqueuePacket (MnpServiceData
, Nbuf
);
960 if (Nbuf
->RefCnt
> 2) {
962 // RefCnt > 2 indicates there is at least one receiver of this packet.
963 // Free the current RxNbufCache and allocate a new one.
965 MnpFreeNbuf (MnpServiceData
, Nbuf
);
967 Nbuf
= MnpAllocNbuf (MnpServiceData
);
968 MnpServiceData
->RxNbufCache
= Nbuf
;
970 MNP_DEBUG_ERROR (("MnpReceivePacket: Alloc packet for receiving cache failed.\n"));
971 return EFI_DEVICE_ERROR
;
974 NetbufAllocSpace (Nbuf
, MnpServiceData
->BufferLength
, NET_BUF_TAIL
);
977 // No receiver for this packet.
979 NetbufAllocSpace (Nbuf
, Trimmed
, NET_BUF_TAIL
);
983 // Deliver the queued packets.
985 MnpDeliverPacket (MnpServiceData
);
989 ASSERT (Nbuf
->TotalSize
== MnpServiceData
->BufferLength
);
996 Remove the received packets if timeout occurs.
998 @param Event The event this notify function registered to.
999 @param Context Pointer to the context data registered to the
1007 MnpCheckPacketTimeout (
1012 MNP_SERVICE_DATA
*MnpServiceData
;
1013 NET_LIST_ENTRY
*Entry
;
1014 NET_LIST_ENTRY
*RxEntry
;
1015 NET_LIST_ENTRY
*NextEntry
;
1016 MNP_INSTANCE_DATA
*Instance
;
1017 MNP_RXDATA_WRAP
*RxDataWrap
;
1020 MnpServiceData
= (MNP_SERVICE_DATA
*) Context
;
1021 NET_CHECK_SIGNATURE (MnpServiceData
, MNP_SERVICE_DATA_SIGNATURE
);
1023 NET_LIST_FOR_EACH (Entry
, &MnpServiceData
->ChildrenList
) {
1025 Instance
= NET_LIST_USER_STRUCT (Entry
, MNP_INSTANCE_DATA
, InstEntry
);
1026 NET_CHECK_SIGNATURE (Instance
, MNP_INSTANCE_DATA_SIGNATURE
);
1028 if (!Instance
->Configured
|| (Instance
->ConfigData
.ReceivedQueueTimeoutValue
== 0)) {
1030 // This instance is not configured or there is no receive time out,
1031 // just skip to the next instance.
1036 OldTpl
= NET_RAISE_TPL (NET_TPL_RECYCLE
);
1038 NET_LIST_FOR_EACH_SAFE (RxEntry
, NextEntry
, &Instance
->RcvdPacketQueue
) {
1040 RxDataWrap
= NET_LIST_USER_STRUCT (RxEntry
, MNP_RXDATA_WRAP
, WrapEntry
);
1042 if (RxDataWrap
->TimeoutTick
>= MNP_TIMEOUT_CHECK_INTERVAL
) {
1044 RxDataWrap
->TimeoutTick
-= MNP_TIMEOUT_CHECK_INTERVAL
;
1047 // Drop the timeout packet.
1049 MNP_DEBUG_WARN (("MnpCheckPacketTimeout: Received packet timeout.\n"));
1050 MnpRecycleRxData (NULL
, RxDataWrap
);
1051 Instance
->RcvdPacketQueueSize
--;
1055 NET_RESTORE_TPL (OldTpl
);
1061 Poll to receive the packets from Snp. This function is either called by upperlayer
1062 protocols/applications or the system poll timer notify mechanism.
1064 @param Event The event this notify function registered to.
1065 @param Context Pointer to the context data registered to the
1078 MNP_SERVICE_DATA
*MnpServiceData
;
1080 MnpServiceData
= (MNP_SERVICE_DATA
*) Context
;
1081 NET_CHECK_SIGNATURE (MnpServiceData
, MNP_SERVICE_DATA_SIGNATURE
);
1084 // Try to receive packets from Snp.
1086 MnpReceivePacket (MnpServiceData
);