4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The EFI_SIMPLE_NETWORK_PROTOCOL provides services to initialize a network interface,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync transmit packets, receive packets, and close a network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Basic network device abstraction.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Rx - Received
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Tx - Transmit
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MCast - MultiCast
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials are licensed and made available under
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncthe terms and conditions of the BSD License that accompanies this distribution.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThe full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @par Revision Reference:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This Protocol is introduced in EFI Specification 1.10.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0xA19832B9, 0xAC25, 0x11D3, {0x9A, 0x2D, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_SIMPLE_NETWORK_PROTOCOL EFI_SIMPLE_NETWORK_PROTOCOL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Protocol defined in EFI1.1.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef EFI_SIMPLE_NETWORK_PROTOCOL EFI_SIMPLE_NETWORK;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Simple Network Protocol data structures.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Total number of frames received. Includes frames with errors and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// dropped frames.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of valid frames received and copied into receive buffers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of frames below the minimum length for the media.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This would be <64 for ethernet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of frames longer than the maxminum length for the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// media. This would be >1500 for ethernet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Valid frames that were dropped because receive buffers were full.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of valid unicast frames received and not dropped.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of valid broadcast frames received and not dropped.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of valid mutlicast frames received and not dropped.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of frames w/ CRC or alignment errors.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Total number of bytes received. Includes frames with errors
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// and dropped frames.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Transmit statistics.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of collisions detection on this subnet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of frames destined for unsupported protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The state of the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// When an EFI_SIMPLE_NETWORK_PROTOCOL driver initializes a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// network interface, the network interface is left in the EfiSimpleNetworkStopped state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST 0x10
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Reports the current state of the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The size, in bytes, of the network interface's HW address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The size, in bytes, of the network interface's media header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The maximum size, in bytes, of the packets supported by the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The size, in bytes, of the NVRAM device attached to the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The size that must be used for all NVRAM reads and writes. The
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// start address for NVRAM read and write operations and the total
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// length of those operations, must be a multiple of this value. The
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// legal values for this field are 0, 1, 2, 4, and 8.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The multicast receive filter settings supported by the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The current multicast receive filter settings.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The maximum number of multicast address receive filters supported by the driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The current number of multicast address receive filters.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Array containing the addresses of the current multicast address receive filters.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The current HW MAC address for the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The current HW MAC address for broadcast packets.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The permanent HW MAC address for the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The interface type of the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// TRUE if the HW MAC address can be changed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// TRUE if the network interface can transmit more than one packet at a time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// TRUE if the presence of media can be determined; otherwise FALSE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// TRUE if media are connected to the network interface; otherwise FALSE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Protocol Member Functions
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Changes the state of a network interface from "stopped" to "started".
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Protocol instance pointer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The network interface was started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ALREADY_STARTED The network interface is already in the started state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The command could not be sent to the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED This function is not supported by the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Changes the state of a network interface from "started" to "stopped".
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Protocol instance pointer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The network interface was stopped.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ALREADY_STARTED The network interface is already in the stopped state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The command could not be sent to the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED This function is not supported by the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Resets a network adapter and allocates the transmit and receive buffers
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync required by the network interface; optionally, also requests allocation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of additional transmit and receive buffers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The protocol instance pointer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ExtraRxBufferSize The size, in bytes, of the extra receive buffer space
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync that the driver should allocate for the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Some network interfaces will not be able to use the extra
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync buffer, and the caller will not know if it is actually
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync being used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ExtraTxBufferSize The size, in bytes, of the extra transmit buffer space
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync that the driver should allocate for the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Some network interfaces will not be able to use the extra
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync buffer, and the caller will not know if it is actually
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync being used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The network interface was initialized.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The network interface has not been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There was not enough memory for the transmit and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync receive buffers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The command could not be sent to the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED This function is not supported by the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Resets a network adapter and re-initializes it with the parameters that were
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync provided in the previous call to Initialize().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The protocol instance pointer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ExtendedVerification Indicates that the driver may perform a more
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync exhaustive verification operation of the device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync during reset.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The network interface was reset.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The network interface has not been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The command could not be sent to the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED This function is not supported by the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Resets a network adapter and leaves it in a state that is safe for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync another driver to initialize.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Protocol instance pointer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The network interface was shutdown.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The network interface has not been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The command could not be sent to the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED This function is not supported by the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Manages the multicast receive filters of a network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The protocol instance pointer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Enable A bit mask of receive filters to enable on the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Disable A bit mask of receive filters to disable on the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ResetMCastFilter Set to TRUE to reset the contents of the multicast receive
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync filters on the network interface to their default values.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param McastFilterCnt Number of multicast HW MAC addresses in the new
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MCastFilter list. This value must be less than or equal to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the MCastFilterCnt field of EFI_SIMPLE_NETWORK_MODE. This
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync field is optional if ResetMCastFilter is TRUE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MCastFilter A pointer to a list of new multicast receive filter HW MAC
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync addresses. This list will replace any existing multicast
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync HW MAC address list. This field is optional if
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ResetMCastFilter is TRUE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The multicast receive filter list was updated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The network interface has not been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The command could not be sent to the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED This function is not supported by the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Modifies or resets the current station address, if supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The protocol instance pointer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Reset Flag used to reset the station address to the network interfaces
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync permanent address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param New The new station address to be used for the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The network interfaces station address was updated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The network interface has not been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The command could not be sent to the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED This function is not supported by the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Resets or collects the statistics on a network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Protocol instance pointer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Reset Set to TRUE to reset the statistics for the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StatisticsSize On input the size, in bytes, of StatisticsTable. On
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync output the size, in bytes, of the resulting table of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync statistics.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StatisticsTable A pointer to the EFI_NETWORK_STATISTICS structure that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync contains the statistics.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The statistics were collected from the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The network interface has not been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL The Statistics buffer was too small. The current buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync size needed to hold the statistics is returned in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync StatisticsSize.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The command could not be sent to the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED This function is not supported by the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT EFI_NETWORK_STATISTICS *StatisticsTable OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Converts a multicast IP address to a multicast HW MAC address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The protocol instance pointer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param IPv6 Set to TRUE if the multicast IP address is IPv6 [RFC 2460]. Set
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to FALSE if the multicast IP address is IPv4 [RFC 791].
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param IP The multicast IP address that is to be converted to a multicast
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync HW MAC address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MAC The multicast HW MAC address that is to be generated from IP.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The multicast IP address was mapped to the multicast
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync HW MAC address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The network interface has not been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL The Statistics buffer was too small. The current buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync size needed to hold the statistics is returned in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync StatisticsSize.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The command could not be sent to the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED This function is not supported by the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Performs read and write operations on the NVRAM device attached to a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The protocol instance pointer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ReadWrite TRUE for read operations, FALSE for write operations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Offset Byte offset in the NVRAM device at which to start the read or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync write operation. This must be a multiple of NvRamAccessSize and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync less than NvRamSize.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BufferSize The number of bytes to read or write from the NVRAM device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This must also be a multiple of NvramAccessSize.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer A pointer to the data buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The NVRAM access was performed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The network interface has not been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The command could not be sent to the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED This function is not supported by the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Reads the current interrupt status and recycled transmit buffer status from
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The protocol instance pointer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param InterruptStatus A pointer to the bit mask of the currently active interrupts
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If this is NULL, the interrupt status will not be read from
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the device. If this is not NULL, the interrupt status will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be read from the device. When the interrupt status is read,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync it will also be cleared. Clearing the transmit interrupt
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync does not empty the recycled transmit buffer array.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param TxBuf Recycled transmit buffer address. The network interface will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not transmit if its internal recycled transmit buffer array
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is full. Reading the transmit buffer does not clear the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync transmit interrupt. If this is NULL, then the transmit buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync status will not be read. If there are no transmit buffers to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync recycle and TxBuf is not NULL, * TxBuf will be set to NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The status of the network interface was retrieved.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The network interface has not been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The command could not be sent to the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED This function is not supported by the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Places a packet in the transmit queue of a network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The protocol instance pointer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param HeaderSize The size, in bytes, of the media header to be filled in by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the Transmit() function. If HeaderSize is non-zero, then it
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync must be equal to This->Mode->MediaHeaderSize and the DestAddr
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and Protocol parameters must not be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BufferSize The size, in bytes, of the entire packet (media header and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync data) to be transmitted through the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer A pointer to the packet (media header followed by data) to be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync transmitted. This parameter cannot be NULL. If HeaderSize is zero,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then the media header in Buffer must already be filled in by the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync caller. If HeaderSize is non-zero, then the media header will be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync filled in by the Transmit() function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SrcAddr The source HW MAC address. If HeaderSize is zero, then this parameter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is ignored. If HeaderSize is non-zero and SrcAddr is NULL, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This->Mode->CurrentAddress is used for the source HW MAC address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DestAddr The destination HW MAC address. If HeaderSize is zero, then this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync parameter is ignored.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Protocol The type of header to build. If HeaderSize is zero, then this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync parameter is ignored. See RFC 1700, section "Ether Types", for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The packet was placed on the transmit queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The network interface has not been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY The network interface is too busy to accept this transmit request.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL The BufferSize parameter is too small.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The command could not be sent to the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED This function is not supported by the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Receives a packet from a network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The protocol instance pointer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param HeaderSize The size, in bytes, of the media header received on the network
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync interface. If this parameter is NULL, then the media header size
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will not be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BufferSize On entry, the size, in bytes, of Buffer. On exit, the size, in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync bytes, of the packet that was received on the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer A pointer to the data buffer to receive both the media header and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SrcAddr The source HW MAC address. If this parameter is NULL, the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync HW MAC source address will not be extracted from the media
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DestAddr The destination HW MAC address. If this parameter is NULL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the HW MAC destination address will not be extracted from the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync media header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Protocol The media header type. If this parameter is NULL, then the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync protocol will not be extracted from the media header. See
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RFC 1700 section "Ether Types" for examples.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The received data was stored in Buffer, and BufferSize has
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync been updated to the number of bytes received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The network interface has not been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY The network interface is too busy to accept this transmit
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL The BufferSize parameter is too small.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The command could not be sent to the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED This function is not supported by the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_SIMPLE_NETWORK_PROTOCOL_REVISION 0x00010000
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Revision defined in EFI1.1
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_SIMPLE_NETWORK_INTERFACE_REVISION EFI_SIMPLE_NETWORK_PROTOCOL_REVISION
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The EFI_SIMPLE_NETWORK_PROTOCOL protocol is used to initialize access
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// to a network adapter. Once the network adapter initializes,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// the EFI_SIMPLE_NETWORK_PROTOCOL protocol provides services that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// allow packets to be transmitted and received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Revision of the EFI_SIMPLE_NETWORK_PROTOCOL. All future revisions must
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// be backwards compatible. If a future version is not backwards compatible
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// it is not the same GUID.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Event used with WaitForEvent() to wait for a packet to be received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Pointer to the EFI_SIMPLE_NETWORK_MODE data for the device.