2 Implementation of Managed Network Protocol public services.
4 Copyright (c) 2005 - 2007, Intel Corporation. <BR>
5 All rights reserved. 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 Returns the operational parameters for the current MNP child driver. May also
19 support returning the underlying SNP driver mode data.
21 The GetModeData() function is used to read the current mode data (operational
22 parameters) from the MNP or the underlying SNP.
24 @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
25 @param[out] MnpConfigData Pointer to storage for MNP operational parameters. Type
26 EFI_MANAGED_NETWORK_CONFIG_DATA is defined in "Related
28 @param[out] SnpModeData Pointer to storage for SNP operational parameters. This
29 feature may be unsupported. Type EFI_SIMPLE_NETWORK_MODE
30 is defined in the EFI_SIMPLE_NETWORK_PROTOCOL.
32 @retval EFI_SUCCESS The operation completed successfully.
33 @retval EFI_INVALID_PARAMETER This is NULL.
34 @retval EFI_UNSUPPORTED The requested feature is unsupported in this
36 @retval EFI_NOT_STARTED This MNP child driver instance has not been
37 configured. The default values are returned in
38 MnpConfigData if it is not NULL.
39 @retval Others The mode data could not be read.
45 IN EFI_MANAGED_NETWORK_PROTOCOL
*This
,
46 OUT EFI_MANAGED_NETWORK_CONFIG_DATA
*MnpConfigData
, OPTIONAL
47 OUT EFI_SIMPLE_NETWORK_MODE
*SnpModeData OPTIONAL
50 MNP_INSTANCE_DATA
*Instance
;
51 EFI_SIMPLE_NETWORK_PROTOCOL
*Snp
;
57 return EFI_INVALID_PARAMETER
;
60 Instance
= MNP_INSTANCE_DATA_FROM_THIS (This
);
62 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
64 if (MnpConfigData
!= NULL
) {
66 // Copy the instance configuration data.
68 CopyMem (MnpConfigData
, &Instance
->ConfigData
, sizeof (*MnpConfigData
));
71 if (SnpModeData
!= NULL
) {
73 // Copy the underlayer Snp mode data.
75 Snp
= Instance
->MnpServiceData
->Snp
;
76 CopyMem (SnpModeData
, Snp
->Mode
, sizeof (*SnpModeData
));
79 if (!Instance
->Configured
) {
80 Status
= EFI_NOT_STARTED
;
85 gBS
->RestoreTPL (OldTpl
);
92 Sets or clears the operational parameters for the MNP child driver.
94 The Configure() function is used to set, change, or reset the operational
95 parameters for the MNP child driver instance. Until the operational parameters
96 have been set, no network traffic can be sent or received by this MNP child
97 driver instance. Once the operational parameters have been reset, no more
98 traffic can be sent or received until the operational parameters have been set
100 Each MNP child driver instance can be started and stopped independently of
101 each other by setting or resetting their receive filter settings with the
102 Configure() function.
103 After any successful call to Configure(), the MNP child driver instance is
104 started. The internal periodic timer (if supported) is enabled. Data can be
105 transmitted and may be received if the receive filters have also been enabled.
106 Note: If multiple MNP child driver instances will receive the same packet
107 because of overlapping receive filter settings, then the first MNP child
108 driver instance will receive the original packet and additional instances will
109 receive copies of the original packet.
110 Note: Warning: Receive filter settings that overlap will consume extra
111 processor and/or DMA resources and degrade system and network performance.
113 @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
114 @param[in] MnpConfigData Pointer to configuration data that will be assigned
115 to the MNP child driver instance. If NULL, the MNP
116 child driver instance is reset to startup defaults
117 and all pending transmit and receive requests are
118 flushed. Type EFI_MANAGED_NETWORK_CONFIG_DATA is
119 defined in EFI_MANAGED_NETWORK_PROTOCOL.GetModeData().
121 @retval EFI_SUCCESS The operation completed successfully.
122 @retval EFI_INVALID_PARAMETER One or more of the following conditions is
125 * MnpConfigData.ProtocolTypeFilter is not
127 The operational data for the MNP child driver
128 instance is unchanged.
129 @retval EFI_OUT_OF_RESOURCES Required system resources (usually memory)
130 could not be allocated.
131 The MNP child driver instance has been reset to
133 @retval EFI_UNSUPPORTED The requested feature is unsupported in
134 this [MNP] implementation. The operational data
135 for the MNP child driver instance is unchanged.
136 @retval EFI_DEVICE_ERROR An unexpected network or system error
137 occurred. The MNP child driver instance has
138 been reset to startup defaults.
139 @retval Others The MNP child driver instance has been reset to
146 IN EFI_MANAGED_NETWORK_PROTOCOL
*This
,
147 IN EFI_MANAGED_NETWORK_CONFIG_DATA
*MnpConfigData OPTIONAL
150 MNP_INSTANCE_DATA
*Instance
;
154 if ((This
== NULL
) ||
155 ((MnpConfigData
!= NULL
) &&
156 (MnpConfigData
->ProtocolTypeFilter
> 0) &&
157 (MnpConfigData
->ProtocolTypeFilter
<= 1500))) {
159 return EFI_INVALID_PARAMETER
;
162 Instance
= MNP_INSTANCE_DATA_FROM_THIS (This
);
164 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
166 if ((MnpConfigData
== NULL
) && (!Instance
->Configured
)) {
168 // If the instance is not configured and a reset is requested, just return.
170 Status
= EFI_SUCCESS
;
175 // Configure the instance.
177 Status
= MnpConfigureInstance (Instance
, MnpConfigData
);
180 gBS
->RestoreTPL (OldTpl
);
187 Translates an IP multicast address to a hardware (MAC) multicast address. This
188 function may be unsupported in some MNP implementations.
190 The McastIpToMac() function translates an IP multicast address to a hardware
191 (MAC) multicast address. This function may be implemented by calling the
192 underlying EFI_SIMPLE_NETWORK. MCastIpToMac() function, which may also be
193 unsupported in some MNP implementations.
195 @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
196 @param[in] Ipv6Flag Set to TRUE to if IpAddress is an IPv6 multicast address.
197 Set to FALSE if IpAddress is an IPv4 multicast address.
198 @param[in] IpAddress Pointer to the multicast IP address (in network byte
200 @param[out] MacAddress Pointer to the resulting multicast MAC address.
202 @retval EFI_SUCCESS The operation completed successfully.
203 @retval EFI_INVALID_PARAMETER One of the following conditions is TRUE:
206 * IpAddress is not a valid multicast IP
208 * MacAddress is NULL.
209 @retval EFI_NOT_STARTED This MNP child driver instance has not been
211 @retval EFI_UNSUPPORTED The requested feature is unsupported in this
213 @retval EFI_DEVICE_ERROR An unexpected network or system error occurred.
214 @retval Others The address could not be converted.
219 IN EFI_MANAGED_NETWORK_PROTOCOL
*This
,
221 IN EFI_IP_ADDRESS
*IpAddress
,
222 OUT EFI_MAC_ADDRESS
*MacAddress
226 MNP_INSTANCE_DATA
*Instance
;
227 EFI_SIMPLE_NETWORK_PROTOCOL
*Snp
;
230 if ((This
== NULL
) || (IpAddress
== NULL
) || (MacAddress
== NULL
)) {
232 return EFI_INVALID_PARAMETER
;
237 // Currently IPv6 isn't supported.
239 return EFI_UNSUPPORTED
;
242 if (!IP4_IS_MULTICAST (EFI_NTOHL (*IpAddress
))) {
244 // The IPv4 address passed in is not a multicast address.
246 return EFI_INVALID_PARAMETER
;
249 Instance
= MNP_INSTANCE_DATA_FROM_THIS (This
);
251 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
253 if (!Instance
->Configured
) {
255 Status
= EFI_NOT_STARTED
;
259 Snp
= Instance
->MnpServiceData
->Snp
;
260 ASSERT (Snp
!= NULL
);
262 if (Snp
->Mode
->IfType
== NET_IFTYPE_ETHERNET
) {
264 // Translate the IPv4 address into a multicast MAC address if the NIC is an
267 MacAddress
->Addr
[0] = 0x01;
268 MacAddress
->Addr
[1] = 0x00;
269 MacAddress
->Addr
[2] = 0x5E;
270 MacAddress
->Addr
[3] = (UINT8
) (IpAddress
->v4
.Addr
[1] & 0x7F);
271 MacAddress
->Addr
[4] = IpAddress
->v4
.Addr
[2];
272 MacAddress
->Addr
[5] = IpAddress
->v4
.Addr
[3];
274 Status
= EFI_SUCCESS
;
277 // Invoke Snp to translate the multicast IP address.
279 Status
= Snp
->MCastIpToMac (
288 gBS
->RestoreTPL (OldTpl
);
294 Enables and disables receive filters for multicast address. This function may
295 be unsupported in some MNP implementations.
297 The Groups() function only adds and removes multicast MAC addresses from the
298 filter list. The MNP driver does not transmit or process Internet Group
299 Management Protocol (IGMP) packets. If JoinFlag is FALSE and MacAddress is
300 NULL, then all joined groups are left.
302 @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
303 @param[in] JoinFlag Set to TRUE to join this multicast group.
304 Set to FALSE to leave this multicast group.
305 @param[in] MacAddress Pointer to the multicast MAC group (address) to join or
308 @retval EFI_SUCCESS The requested operation completed successfully.
309 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
311 * JoinFlag is TRUE and MacAddress is NULL.
312 * MacAddress is not a valid multicast MAC
314 * The MNP multicast group settings are
316 @retval EFI_NOT_STARTED This MNP child driver instance has not been
318 @retval EFI_ALREADY_STARTED The supplied multicast group is already joined.
319 @retval EFI_NOT_FOUND The supplied multicast group is not joined.
320 @retval EFI_DEVICE_ERROR An unexpected network or system error occurred.
321 The MNP child driver instance has been reset to
323 @retval EFI_UNSUPPORTED The requested feature is unsupported in this MNP
325 @retval Others The requested operation could not be completed.
326 The MNP multicast group settings are unchanged.
332 IN EFI_MANAGED_NETWORK_PROTOCOL
*This
,
334 IN EFI_MAC_ADDRESS
*MacAddress OPTIONAL
337 MNP_INSTANCE_DATA
*Instance
;
338 EFI_SIMPLE_NETWORK_MODE
*SnpMode
;
339 MNP_GROUP_CONTROL_BLOCK
*GroupCtrlBlk
;
340 MNP_GROUP_ADDRESS
*GroupAddress
;
341 LIST_ENTRY
*ListEntry
;
342 BOOLEAN AddressExist
;
346 if (This
== NULL
|| (JoinFlag
&& (MacAddress
== NULL
))) {
348 // This is NULL, or it's a join operation but MacAddress is NULL.
350 return EFI_INVALID_PARAMETER
;
353 Instance
= MNP_INSTANCE_DATA_FROM_THIS (This
);
354 SnpMode
= Instance
->MnpServiceData
->Snp
->Mode
;
356 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
358 if (!Instance
->Configured
) {
360 Status
= EFI_NOT_STARTED
;
364 if ((!Instance
->ConfigData
.EnableMulticastReceive
) ||
365 ((MacAddress
!= NULL
) && !NET_MAC_IS_MULTICAST (MacAddress
, &SnpMode
->BroadcastAddress
, SnpMode
->HwAddressSize
))) {
367 // The instance isn't configured to do mulitcast receive. OR
368 // the passed in MacAddress is not a mutlticast mac address.
370 Status
= EFI_INVALID_PARAMETER
;
374 Status
= EFI_SUCCESS
;
375 AddressExist
= FALSE
;
378 if (MacAddress
!= NULL
) {
380 // Search the instance's GroupCtrlBlkList to find the specific address.
382 NET_LIST_FOR_EACH (ListEntry
, &Instance
->GroupCtrlBlkList
) {
384 GroupCtrlBlk
= NET_LIST_USER_STRUCT (
386 MNP_GROUP_CONTROL_BLOCK
,
389 GroupAddress
= GroupCtrlBlk
->GroupAddress
;
390 if (0 == CompareMem (
392 &GroupAddress
->Address
,
393 SnpMode
->HwAddressSize
396 // There is already the same multicast mac address configured.
403 if (JoinFlag
&& AddressExist
) {
405 // The multicast mac address to join already exists.
407 Status
= EFI_ALREADY_STARTED
;
410 if (!JoinFlag
&& !AddressExist
) {
412 // The multicast mac address to leave doesn't exist in this instance.
414 Status
= EFI_NOT_FOUND
;
417 if (EFI_ERROR (Status
)) {
420 } else if (IsListEmpty (&Instance
->GroupCtrlBlkList
)) {
422 // The MacAddress is NULL and there is no configured multicast mac address,
429 // OK, it is time to take action.
431 Status
= MnpGroupOp (Instance
, JoinFlag
, MacAddress
, GroupCtrlBlk
);
434 gBS
->RestoreTPL (OldTpl
);
440 Places asynchronous outgoing data packets into the transmit queue.
442 The Transmit() function places a completion token into the transmit packet
443 queue. This function is always asynchronous.
444 The caller must fill in the Token.Event and Token.TxData fields in the
445 completion token, and these fields cannot be NULL. When the transmit operation
446 completes, the MNP updates the Token.Status field and the Token.Event is
448 Note: There may be a performance penalty if the packet needs to be
449 defragmented before it can be transmitted by the network device. Systems in
450 which performance is critical should review the requirements and features of
451 the underlying communications device and drivers.
454 @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
455 @param[in] Token Pointer to a token associated with the transmit data
456 descriptor. Type EFI_MANAGED_NETWORK_COMPLETION_TOKEN
457 is defined in "Related Definitions" below.
459 @retval EFI_SUCCESS The transmit completion token was cached.
460 @retval EFI_NOT_STARTED This MNP child driver instance has not been
462 @retval EFI_INVALID_PARAMETER One or more of the following conditions is
466 * Token.Event is NULL.
467 * Token.TxData is NULL.
468 * Token.TxData.DestinationAddress is not
469 NULL and Token.TxData.HeaderLength is zero.
470 * Token.TxData.FragmentCount is zero.
471 * (Token.TxData.HeaderLength +
472 Token.TxData.DataLength) is not equal to the
474 Token.TxData.FragmentTable[].FragmentLength
477 Token.TxData.FragmentTable[].FragmentLength
480 Token.TxData.FragmentTable[].FragmentBufferfields
482 * Token.TxData.DataLength is greater than MTU.
483 @retval EFI_ACCESS_DENIED The transmit completion token is already in the
485 @retval EFI_OUT_OF_RESOURCES The transmit data could not be queued due to a
486 lack of system resources (usually memory).
487 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
488 The MNP child driver instance has been reset to
490 @retval EFI_NOT_READY The transmit request could not be queued because
491 the transmit queue is full.
497 IN EFI_MANAGED_NETWORK_PROTOCOL
*This
,
498 IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN
*Token
502 MNP_INSTANCE_DATA
*Instance
;
503 MNP_SERVICE_DATA
*MnpServiceData
;
508 if ((This
== NULL
) || (Token
== NULL
)) {
510 return EFI_INVALID_PARAMETER
;
513 Instance
= MNP_INSTANCE_DATA_FROM_THIS (This
);
515 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
517 if (!Instance
->Configured
) {
519 Status
= EFI_NOT_STARTED
;
523 if (!MnpIsValidTxToken (Instance
, Token
)) {
525 // The Token is invalid.
527 Status
= EFI_INVALID_PARAMETER
;
531 MnpServiceData
= Instance
->MnpServiceData
;
532 NET_CHECK_SIGNATURE (MnpServiceData
, MNP_SERVICE_DATA_SIGNATURE
);
535 // Build the tx packet
537 MnpBuildTxPacket (MnpServiceData
, Token
->Packet
.TxData
, &PktBuf
, &PktLen
);
540 // OK, send the packet synchronously.
542 Status
= MnpSyncSendPacket (MnpServiceData
, PktBuf
, PktLen
, Token
);
545 gBS
->RestoreTPL (OldTpl
);
552 Places an asynchronous receiving request into the receiving queue.
554 The Receive() function places a completion token into the receive packet
555 queue. This function is always asynchronous.
556 The caller must fill in the Token.Event field in the completion token, and
557 this field cannot be NULL. When the receive operation completes, the MNP
558 updates the Token.Status and Token.RxData fields and the Token.Event is
561 @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
562 @param[in] Token Pointer to a token associated with the receive
563 data descriptor. Type
564 EFI_MANAGED_NETWORK_COMPLETION_TOKEN is defined in
565 EFI_MANAGED_NETWORK_PROTOCOL.Transmit().
567 @retval EFI_SUCCESS The receive completion token was cached.
568 @retval EFI_NOT_STARTED This MNP child driver instance has not been
570 @retval EFI_INVALID_PARAMETER One or more of the following conditions is
574 * Token.Event is NULL
575 @retval EFI_OUT_OF_RESOURCES The transmit data could not be queued due to a
576 lack of system resources (usually memory).
577 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
578 The MNP child driver instance has been reset to
580 @retval EFI_ACCESS_DENIED The receive completion token was already in the
582 @retval EFI_NOT_READY The receive request could not be queued because
583 the receive queue is full.
589 IN EFI_MANAGED_NETWORK_PROTOCOL
*This
,
590 IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN
*Token
594 MNP_INSTANCE_DATA
*Instance
;
597 if ((This
== NULL
) || (Token
== NULL
) || (Token
->Event
== NULL
)) {
599 return EFI_INVALID_PARAMETER
;
602 Instance
= MNP_INSTANCE_DATA_FROM_THIS (This
);
604 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
606 if (!Instance
->Configured
) {
608 Status
= EFI_NOT_STARTED
;
613 // Check whether this token(event) is already in the rx token queue.
615 Status
= NetMapIterate (&Instance
->RxTokenMap
, MnpTokenExist
, (VOID
*) Token
);
616 if (EFI_ERROR (Status
)) {
622 // Insert the Token into the RxTokenMap.
624 Status
= NetMapInsertTail (&Instance
->RxTokenMap
, (VOID
*) Token
, NULL
);
626 if (!EFI_ERROR (Status
)) {
628 // Try to deliver any buffered packets.
630 Status
= MnpInstanceDeliverPacket (Instance
);
633 // Dispatch the DPC queued by the NotifyFunction of Token->Event.
635 NetLibDispatchDpc ();
639 gBS
->RestoreTPL (OldTpl
);
645 Aborts an asynchronous transmit or receive request.
647 The Cancel() function is used to abort a pending transmit or receive request.
648 If the token is in the transmit or receive request queues, after calling this
649 function, Token.Status will be set to EFI_ABORTED and then Token.Event will be
650 signaled. If the token is not in one of the queues, which usually means that
651 the asynchronous operation has completed, this function will not signal the
652 token and EFI_NOT_FOUND is returned.
654 @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
655 @param[in] Token Pointer to a token that has been issued by
656 EFI_MANAGED_NETWORK_PROTOCOL.Transmit() or
657 EFI_MANAGED_NETWORK_PROTOCOL.Receive(). If NULL, all
658 pending tokens are aborted.
660 @retval EFI_SUCCESS The asynchronous I/O request was aborted and
661 Token.Event was signaled. When Token is NULL,
662 all pending requests were aborted and their
663 events were signaled.
664 @retval EFI_NOT_STARTED This MNP child driver instance has not been
666 @retval EFI_INVALID_PARAMETER This is NULL.
667 @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O
668 request was not found in the transmit or
669 receive queue. It has either completed or was
670 not issued by Transmit() and Receive().
676 IN EFI_MANAGED_NETWORK_PROTOCOL
*This
,
677 IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN
*Token OPTIONAL
681 MNP_INSTANCE_DATA
*Instance
;
686 return EFI_INVALID_PARAMETER
;
689 Instance
= MNP_INSTANCE_DATA_FROM_THIS (This
);
691 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
693 if (!Instance
->Configured
) {
695 Status
= EFI_NOT_STARTED
;
700 // Iterate the RxTokenMap to cancel the specified Token.
702 Status
= NetMapIterate (&Instance
->RxTokenMap
, MnpCancelTokens
, (VOID
*) Token
);
706 Status
= (Status
== EFI_ABORTED
) ? EFI_SUCCESS
: EFI_NOT_FOUND
;
710 // Dispatch the DPC queued by the NotifyFunction of the cancled token's events.
712 NetLibDispatchDpc ();
715 gBS
->RestoreTPL (OldTpl
);
721 Polls for incoming data packets and processes outgoing data packets.
723 The Poll() function can be used by network drivers and applications to
724 increase the rate that data packets are moved between the communications
725 device and the transmit and receive queues.
726 Normally, a periodic timer event internally calls the Poll() function. But, in
727 some systems, the periodic timer event may not call Poll() fast enough to
728 transmit and/or receive all data packets without missing packets. Drivers and
729 applications that are experiencing packet loss should try calling the Poll()
732 @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
734 @retval EFI_SUCCESS Incoming or outgoing data was processed.
735 @retval EFI_NOT_STARTED This MNP child driver instance has not been
737 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The
738 MNP child driver instance has been reset to startup
740 @retval EFI_NOT_READY No incoming or outgoing data was processed. Consider
741 increasing the polling rate.
742 @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive
743 queue. Consider increasing the polling rate.
749 IN EFI_MANAGED_NETWORK_PROTOCOL
*This
753 MNP_INSTANCE_DATA
*Instance
;
757 return EFI_INVALID_PARAMETER
;
760 Instance
= MNP_INSTANCE_DATA_FROM_THIS (This
);
762 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
764 if (!Instance
->Configured
) {
765 Status
= EFI_NOT_STARTED
;
770 // Try to receive packets.
772 Status
= MnpReceivePacket (Instance
->MnpServiceData
);
775 // Dispatch the DPC queued by the NotifyFunction of rx token's events.
777 NetLibDispatchDpc ();
780 gBS
->RestoreTPL (OldTpl
);