MCast - MultiCast\r
...\r
\r
- Copyright (c) 2006 - 2009, 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 EFI Specification 1.10 \r
+ This Protocol is introduced in EFI Specification 1.10. \r
\r
**/\r
\r
typedef EFI_SIMPLE_NETWORK_PROTOCOL EFI_SIMPLE_NETWORK;\r
\r
///\r
-/// Simple Network Protocol data structures\r
+/// Simple Network Protocol data structures.\r
///\r
typedef struct {\r
///\r
} EFI_NETWORK_STATISTICS;\r
\r
///\r
-/// State of the network interface\r
+/// The state of the network interface.\r
/// When an EFI_SIMPLE_NETWORK_PROTOCOL driver initializes a\r
/// network interface, the network interface is left in the EfiSimpleNetworkStopped state.\r
///\r
required by the network interface; optionally, also requests allocation \r
of additional transmit and receive buffers.\r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
@param ExtraRxBufferSize The size, in bytes, of the extra receive buffer space\r
that the driver should allocate for the network interface.\r
Some network interfaces will not be able to use the extra\r
being used.\r
\r
@retval EFI_SUCCESS The network interface was initialized.\r
- @retval EFI_NOT_STARTED The network interface has not been started\r
+ @retval EFI_NOT_STARTED The network interface has not been started.\r
@retval EFI_OUT_OF_RESOURCES There was not enough memory for the transmit and\r
receive buffers.\r
@retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.\r
Resets a network adapter and re-initializes it with the parameters that were \r
provided in the previous call to Initialize(). \r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
@param ExtendedVerification Indicates that the driver may perform a more\r
exhaustive verification operation of the device\r
during reset.\r
\r
@retval EFI_SUCCESS The network interface was reset.\r
- @retval EFI_NOT_STARTED The network interface has not been started\r
+ @retval EFI_NOT_STARTED The network interface has not been started.\r
@retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.\r
@retval EFI_DEVICE_ERROR The command could not be sent to the network interface.\r
@retval EFI_UNSUPPORTED This function is not supported by the network interface.\r
@param This Protocol instance pointer.\r
\r
@retval EFI_SUCCESS The network interface was shutdown.\r
- @retval EFI_NOT_STARTED The network interface has not been started\r
+ @retval EFI_NOT_STARTED The network interface has not been started.\r
@retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.\r
@retval EFI_DEVICE_ERROR The command could not be sent to the network interface.\r
@retval EFI_UNSUPPORTED This function is not supported by the network interface.\r
/**\r
Manages the multicast receive filters of a network interface.\r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
@param Enable A bit mask of receive filters to enable on the network interface.\r
@param Disable A bit mask of receive filters to disable on the network interface.\r
@param ResetMCastFilter Set to TRUE to reset the contents of the multicast receive\r
ResetMCastFilter is TRUE.\r
\r
@retval EFI_SUCCESS The multicast receive filter list was updated.\r
- @retval EFI_NOT_STARTED The network interface has not been started\r
+ @retval EFI_NOT_STARTED The network interface has not been started.\r
@retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.\r
@retval EFI_DEVICE_ERROR The command could not be sent to the network interface.\r
@retval EFI_UNSUPPORTED This function is not supported by the network interface.\r
/**\r
Modifies or resets the current station address, if supported.\r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
@param Reset Flag used to reset the station address to the network interfaces\r
permanent address.\r
- @param New New station address to be used for the network interface.\r
+ @param New The new station address to be used for the network interface.\r
\r
@retval EFI_SUCCESS The network interfaces station address was updated.\r
- @retval EFI_NOT_STARTED The network interface has not been started\r
+ @retval EFI_NOT_STARTED The network interface has not been started.\r
@retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.\r
@retval EFI_DEVICE_ERROR The command could not be sent to the network interface.\r
@retval EFI_UNSUPPORTED This function is not supported by the network interface.\r
/**\r
Converts a multicast IP address to a multicast HW MAC address.\r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
@param IPv6 Set to TRUE if the multicast IP address is IPv6 [RFC 2460]. Set\r
to FALSE if the multicast IP address is IPv4 [RFC 791].\r
@param IP The multicast IP address that is to be converted to a multicast\r
Performs read and write operations on the NVRAM device attached to a \r
network interface.\r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
@param ReadWrite TRUE for read operations, FALSE for write operations.\r
@param Offset Byte offset in the NVRAM device at which to start the read or\r
write operation. This must be a multiple of NvRamAccessSize and\r
Reads the current interrupt status and recycled transmit buffer status from \r
a network interface.\r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
@param InterruptStatus A pointer to the bit mask of the currently active interrupts\r
If this is NULL, the interrupt status will not be read from\r
the device. If this is not NULL, the interrupt status will\r
/**\r
Places a packet in the transmit queue of a network interface.\r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
@param HeaderSize The size, in bytes, of the media header to be filled in by\r
the Transmit() function. If HeaderSize is non-zero, then it\r
must be equal to This->Mode->MediaHeaderSize and the DestAddr\r
/**\r
Receives a packet from a network interface.\r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
@param HeaderSize The size, in bytes, of the media header received on the network\r
interface. If this parameter is NULL, then the media header size\r
will not be returned.\r
projects / mirror_edk2.git / blobdiff