EFI_MANAGED_NETWORK_SERVICE_BINDING_PROTOCOL as defined in UEFI 2.0.\r
EFI_MANAGED_NETWORK_PROTOCOL as defined in UEFI 2.0.\r
\r
- Copyright (c) 2006 - 2008, Intel Corporation\r
- All rights reserved. This program and the accompanying materials\r
- are licensed and made available under the terms and conditions of the BSD License\r
- which accompanies this distribution. The full text of the license may be found at\r
- http://opensource.org/licenses/bsd-license.php\r
-\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php. \r
+ \r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+ @par Revision Reference: \r
+ This Protocol is introduced in UEFI Specification 2.0\r
\r
**/\r
\r
typedef struct _EFI_MANAGED_NETWORK_PROTOCOL EFI_MANAGED_NETWORK_PROTOCOL;\r
\r
typedef struct {\r
+ ///\r
+ /// Timeout value for a UEFI one-shot timer event. A packet that has not been removed\r
+ /// from the MNP receive queue will be dropped if its receive timeout expires.\r
+ ///\r
UINT32 ReceivedQueueTimeoutValue;\r
+ ///\r
+ /// Timeout value for a UEFI one-shot timer event. A packet that has not been removed\r
+ /// from the MNP transmit queue will be dropped if its receive timeout expires.\r
+ ///\r
UINT32 TransmitQueueTimeoutValue;\r
+ ///\r
+ /// Ethernet type II 16-bit protocol type in host byte order. Valid\r
+ /// values are zero and 1,500 to 65,535.\r
+ ///\r
UINT16 ProtocolTypeFilter;\r
+ ///\r
+ /// Set to TRUE to receive packets that are sent to the network\r
+ /// device MAC address. The startup default value is FALSE.\r
+ ///\r
BOOLEAN EnableUnicastReceive;\r
+ ///\r
+ /// Set to TRUE to receive packets that are sent to any of the\r
+ /// active multicast groups. The startup default value is FALSE.\r
+ ///\r
BOOLEAN EnableMulticastReceive;\r
+ ///\r
+ /// Set to TRUE to receive packets that are sent to the network\r
+ /// device broadcast address. The startup default value is FALSE.\r
+ ///\r
BOOLEAN EnableBroadcastReceive;\r
+ ///\r
+ /// Set to TRUE to receive packets that are sent to any MAC address.\r
+ /// The startup default value is FALSE.\r
+ ///\r
BOOLEAN EnablePromiscuousReceive;\r
+ ///\r
+ /// Set to TRUE to drop queued packets when the configuration\r
+ /// is changed. The startup default value is FALSE.\r
+ ///\r
BOOLEAN FlushQueuesOnReset;\r
+ ///\r
+ /// Set to TRUE to timestamp all packets when they are received\r
+ /// by the MNP. Note that timestamps may be unsupported in some\r
+ /// MNP implementations. The startup default value is FALSE.\r
+ ///\r
BOOLEAN EnableReceiveTimestamps;\r
+ ///\r
+ /// Set to TRUE to disable background polling in this MNP\r
+ /// instance. Note that background polling may not be supported in\r
+ /// all MNP implementations. The startup default value is FALSE,\r
+ /// unless background polling is not supported.\r
+ ///\r
BOOLEAN DisableBackgroundPolling;\r
} EFI_MANAGED_NETWORK_CONFIG_DATA;\r
\r
\r
\r
typedef struct {\r
+ ///\r
+ /// This Event will be signaled after the Status field is updated\r
+ /// by the MNP. The type of Event must be\r
+ /// EFI_NOTIFY_SIGNAL. The Task Priority Level (TPL) of\r
+ /// Event must be lower than or equal to TPL_CALLBACK.\r
+ ///\r
EFI_EVENT Event;\r
+ ///\r
+ /// The status that is returned to the caller at the end of the operation\r
+ /// to indicate whether this operation completed successfully.\r
+ ///\r
EFI_STATUS Status;\r
union {\r
+ ///\r
+ /// When this token is used for receiving, RxData is a pointer to the EFI_MANAGED_NETWORK_RECEIVE_DATA.\r
+ ///\r
EFI_MANAGED_NETWORK_RECEIVE_DATA *RxData;\r
+ ///\r
+ /// When this token is used for transmitting, TxData is a pointer to the EFI_MANAGED_NETWORK_TRANSMIT_DATA.\r
+ ///\r
EFI_MANAGED_NETWORK_TRANSMIT_DATA *TxData;\r
} Packet;\r
} EFI_MANAGED_NETWORK_COMPLETION_TOKEN;\r
/**\r
Returns the operational parameters for the current MNP child driver.\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
- @param MnpConfigData Pointer to storage for MNP operational parameters.\r
- @param SnpModeData Pointer to storage for SNP operational parameters.\r
+ @param This The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param MnpConfigData The pointer to storage for MNP operational parameters.\r
+ @param SnpModeData The pointer to storage for SNP operational parameters.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
/**\r
Sets or clears the operational parameters for the MNP child driver.\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
- @param MnpConfigData Pointer to configuration data that will be assigned to the MNP\r
+ @param This The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param MnpConfigData The pointer to configuration data that will be assigned to the MNP\r
child driver instance. If NULL, the MNP child driver instance is\r
reset to startup defaults and all pending transmit and receive\r
requests are flushed.\r
/**\r
Translates an IP multicast address to a hardware (MAC) multicast address.\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param This The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
@param Ipv6Flag Set to TRUE to if IpAddress is an IPv6 multicast address.\r
Set to FALSE if IpAddress is an IPv4 multicast address.\r
- @param IpAddress Pointer to the multicast IP address (in network byte order) to convert.\r
- @param MacAddress Pointer to the resulting multicast MAC address.\r
+ @param IpAddress The pointer to the multicast IP address (in network byte order) to convert.\r
+ @param MacAddress The pointer to the resulting multicast MAC address.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_INVALID_PARAMETER One of the following conditions is TRUE:\r
/**\r
Enables and disables receive filters for multicast address.\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param This The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
@param JoinFlag Set to TRUE to join this multicast group.\r
Set to FALSE to leave this multicast group.\r
- @param MacAddress Pointer to the multicast MAC group (address) to join or leave.\r
+ @param MacAddress The pointer to the multicast MAC group (address) to join or leave.\r
\r
@retval EFI_SUCCESS The requested operation completed successfully.\r
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
/**\r
Places asynchronous outgoing data packets into the transmit queue.\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
- @param Token Pointer to a token associated with the transmit data descriptor.\r
+ @param This The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param Token The pointer to a token associated with the transmit data descriptor.\r
\r
@retval EFI_SUCCESS The transmit completion token was cached.\r
@retval EFI_NOT_STARTED This MNP child driver instance has not been configured.\r
/**\r
Places an asynchronous receiving request into the receiving queue.\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
- @param Token Pointer to a token associated with the receive data descriptor.\r
+ @param This The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param Token The pointer to a token associated with the receive data descriptor.\r
\r
@retval EFI_SUCCESS The receive completion token was cached.\r
@retval EFI_NOT_STARTED This MNP child driver instance has not been configured.\r
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
- This is NULL.\r
- Token is NULL.\r
- - Token.Event is NULL\r
+ - Token.Event is NULL.\r
@retval EFI_OUT_OF_RESOURCES The transmit data could not be queued due to a lack of system resources\r
(usually memory).\r
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
/**\r
Aborts an asynchronous transmit or receive request.\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
- @param Token Pointer to a token that has been issued by\r
+ @param This The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param Token The pointer to a token that has been issued by\r
EFI_MANAGED_NETWORK_PROTOCOL.Transmit() or\r
EFI_MANAGED_NETWORK_PROTOCOL.Receive(). If\r
NULL, all pending tokens are aborted.\r
/**\r
Polls for incoming data packets and processes outgoing data packets.\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param This The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
\r
@retval EFI_SUCCESS Incoming or outgoing data was processed.\r
@retval EFI_NOT_STARTED This MNP child driver instance has not been configured.\r
projects / mirror_edk2.git / blobdiff