#include <IndustryStandard/VirtioNet.h>
#include <Library/DebugLib.h>
#include <Library/VirtioLib.h>
#include <Protocol/ComponentName.h>
#include <Protocol/ComponentName2.h>
#include <Protocol/DevicePath.h>
#include <Protocol/DriverBinding.h>
#include <Protocol/SimpleNetwork.h>
#include <Library/OrderedCollectionLib.h>

Data Structures
struct	VNET_DEV

Macros
#define	VNET_SIG SIGNATURE_32 ('V', 'N', 'E', 'T')

#define	VNET_MAX_PENDING 64

#define	VIRTIO_NET_FROM_SNP(SnpPointer) CR (SnpPointer, VNET_DEV, Snp, VNET_SIG)

#define	VIRTIO_CFG_WRITE(Dev, Field, Value)

#define	VIRTIO_CFG_READ(Dev, Field, Pointer)

Functions
EFI_STATUS EFIAPI	VirtioNetStart (IN EFI_SIMPLE_NETWORK_PROTOCOL *This)

EFI_STATUS EFIAPI	VirtioNetStop (IN EFI_SIMPLE_NETWORK_PROTOCOL *This)

EFI_STATUS EFIAPI	VirtioNetInitialize (IN EFI_SIMPLE_NETWORK_PROTOCOL *This, IN UINTN ExtraRxBufferSize OPTIONAL, IN UINTN ExtraTxBufferSize OPTIONAL)

EFI_STATUS EFIAPI	VirtioNetReset (IN EFI_SIMPLE_NETWORK_PROTOCOL *This, IN BOOLEAN ExtendedVerification)

EFI_STATUS EFIAPI	VirtioNetShutdown (IN EFI_SIMPLE_NETWORK_PROTOCOL *This)

EFI_STATUS EFIAPI	VirtioNetReceiveFilters (IN EFI_SIMPLE_NETWORK_PROTOCOL This, IN UINT32 Enable, IN UINT32 Disable, IN BOOLEAN ResetMCastFilter, IN UINTN MCastFilterCnt OPTIONAL, IN EFI_MAC_ADDRESS MCastFilter OPTIONAL)

EFI_STATUS EFIAPI	VirtioNetStationAddress (IN EFI_SIMPLE_NETWORK_PROTOCOL This, IN BOOLEAN Reset, IN EFI_MAC_ADDRESS New OPTIONAL)

EFI_STATUS EFIAPI	VirtioNetStatistics (IN EFI_SIMPLE_NETWORK_PROTOCOL This, IN BOOLEAN Reset, IN OUT UINTN StatisticsSize OPTIONAL, OUT EFI_NETWORK_STATISTICS *StatisticsTable OPTIONAL)

EFI_STATUS EFIAPI	VirtioNetMcastIpToMac (IN EFI_SIMPLE_NETWORK_PROTOCOL This, IN BOOLEAN IPv6, IN EFI_IP_ADDRESS Ip, OUT EFI_MAC_ADDRESS *Mac)

EFI_STATUS EFIAPI	VirtioNetNvData (IN EFI_SIMPLE_NETWORK_PROTOCOL This, IN BOOLEAN ReadWrite, IN UINTN Offset, IN UINTN BufferSize, IN OUT VOID Buffer)

EFI_STATUS EFIAPI	VirtioNetGetStatus (IN EFI_SIMPLE_NETWORK_PROTOCOL This, OUT UINT32 InterruptStatus OPTIONAL, OUT VOID **TxBuf OPTIONAL)

EFI_STATUS EFIAPI	VirtioNetTransmit (IN EFI_SIMPLE_NETWORK_PROTOCOL This, IN UINTN HeaderSize, IN UINTN BufferSize, IN VOID Buffer, IN EFI_MAC_ADDRESS SrcAddr OPTIONAL, IN EFI_MAC_ADDRESS DestAddr OPTIONAL, IN UINT16 *Protocol OPTIONAL)

EFI_STATUS EFIAPI	VirtioNetReceive (IN EFI_SIMPLE_NETWORK_PROTOCOL This, OUT UINTN HeaderSize OPTIONAL, IN OUT UINTN BufferSize, OUT VOID Buffer, OUT EFI_MAC_ADDRESS SrcAddr OPTIONAL, OUT EFI_MAC_ADDRESS DestAddr OPTIONAL, OUT UINT16 *Protocol OPTIONAL)

VOID EFIAPI	VirtioNetShutdownRx (IN OUT VNET_DEV *Dev)

VOID EFIAPI	VirtioNetShutdownTx (IN OUT VNET_DEV *Dev)

VOID EFIAPI	VirtioNetUninitRing (IN OUT VNET_DEV Dev, IN OUT VRING Ring, IN VOID *RingMap)

EFI_STATUS EFIAPI	VirtioNetMapTxBuf (IN VNET_DEV Dev, IN VOID Buffer, IN UINTN NumberOfBytes, OUT EFI_PHYSICAL_ADDRESS *DeviceAddress)

EFI_STATUS EFIAPI	VirtioNetUnmapTxBuf (IN VNET_DEV Dev, OUT VOID *Buffer, IN EFI_PHYSICAL_ADDRESS DeviceAddress)

INTN EFIAPI	VirtioNetTxBufMapInfoCompare (IN CONST VOID UserStruct1, IN CONST VOID UserStruct2)

INTN EFIAPI	VirtioNetTxBufDeviceAddressCompare (IN CONST VOID StandaloneKey, IN CONST VOID UserStruct)

VOID EFIAPI	VirtioNetIsPacketAvailable (IN EFI_EVENT Event, IN VOID *Context)

VOID EFIAPI	VirtioNetExitBoot (IN EFI_EVENT Event, IN VOID *Context)

Variables
EFI_COMPONENT_NAME_PROTOCOL	gVirtioNetComponentName

EFI_COMPONENT_NAME2_PROTOCOL	gVirtioNetComponentName2

EFI_DRIVER_BINDING_PROTOCOL	gVirtioNetDriverBinding

Detailed Description

Internal definitions for the virtio-net driver, which produces Simple Network Protocol instances for virtio-net devices.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file VirtioNet.h.

Macro Definition Documentation

◆ VIRTIO_CFG_READ

#define VIRTIO_CFG_READ	(	Dev,
		Field,
		Pointer
	)

Value:

                                                ((Dev)->VirtIo->ReadDevice (  \
                                                (Dev)->VirtIo,              \
                                                OFFSET_OF_VNET (Field),     \
                                                SIZE_OF_VNET (Field),       \
                                                sizeof *(Pointer),          \
                                                (Pointer)                   \
                                                ))

Definition at line 121 of file VirtioNet.h.

◆ VIRTIO_CFG_WRITE

#define VIRTIO_CFG_WRITE	(	Dev,
		Field,
		Value
	)

Value:

                                                ((Dev)->VirtIo->WriteDevice (  \
                                                (Dev)->VirtIo,              \
                                                OFFSET_OF_VNET (Field),     \
                                                SIZE_OF_VNET (Field),       \
                                                (Value)                     \
                                                ))

Definition at line 114 of file VirtioNet.h.

◆ VIRTIO_NET_FROM_SNP

#define VIRTIO_NET_FROM_SNP ( SnpPointer ) CR (SnpPointer, VNET_DEV, Snp, VNET_SIG)

Definition at line 111 of file VirtioNet.h.

◆ VNET_MAX_PENDING

#define VNET_MAX_PENDING 64

Definition at line 30 of file VirtioNet.h.

◆ VNET_SIG

#define VNET_SIG SIGNATURE_32 ('V', 'N', 'E', 'T')

Definition at line 25 of file VirtioNet.h.

Function Documentation

◆ VirtioNetExitBoot()

VOID EFIAPI VirtioNetExitBoot	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

Definition at line 66 of file Events.c.

◆ VirtioNetGetStatus()

EFI_STATUS EFIAPI VirtioNetGetStatus	(	IN EFI_SIMPLE_NETWORK_PROTOCOL *	This,
		OUT UINT32 *InterruptStatus	OPTIONAL,
		OUT VOID **TxBuf	OPTIONAL
	)

Reads the current interrupt status and recycled transmit buffer status from a network interface.

Parameters

This	The protocol instance pointer.
InterruptStatus	A pointer to the bit mask of the currently active interrupts If this is NULL, the interrupt status will not be read from the device. If this is not NULL, the interrupt status will be read from the device. When the interrupt status is read, it will also be cleared. Clearing the transmit interrupt does not empty the recycled transmit buffer array.
TxBuf	Recycled transmit buffer address. The network interface will not transmit if its internal recycled transmit buffer array is full. Reading the transmit buffer does not clear the transmit interrupt. If this is NULL, then the transmit buffer status will not be read. If there are no transmit buffers to recycle and TxBuf is not NULL, * TxBuf will be set to NULL.

Return values

EFI_SUCCESS	The status of the network interface was retrieved.
EFI_NOT_STARTED	The network interface has not been started.
EFI_INVALID_PARAMETER	One or more of the parameters has an unsupported value.
EFI_DEVICE_ERROR	The command could not be sent to the network interface.
EFI_UNSUPPORTED	This function is not supported by the network interface.

Definition at line 51 of file SnpGetStatus.c.

◆ VirtioNetInitialize()

EFI_STATUS EFIAPI VirtioNetInitialize	(	IN EFI_SIMPLE_NETWORK_PROTOCOL *	This,
		IN UINTN ExtraRxBufferSize	OPTIONAL,
		IN UINTN ExtraTxBufferSize	OPTIONAL
	)

Resets a network adapter and allocates the transmit and receive buffers required by the network interface; optionally, also requests allocation of additional transmit and receive buffers.

Parameters

This	The protocol instance pointer.
ExtraRxBufferSize	The size, in bytes, of the extra receive buffer space that the driver should allocate for the network interface. Some network interfaces will not be able to use the extra buffer, and the caller will not know if it is actually being used.
ExtraTxBufferSize	The size, in bytes, of the extra transmit buffer space that the driver should allocate for the network interface. Some network interfaces will not be able to use the extra buffer, and the caller will not know if it is actually being used.

Return values

EFI_SUCCESS	The network interface was initialized.
EFI_NOT_STARTED	The network interface has not been started.
EFI_OUT_OF_RESOURCES	There was not enough memory for the transmit and receive buffers.
EFI_INVALID_PARAMETER	One or more of the parameters has an unsupported value.
EFI_DEVICE_ERROR	The command could not be sent to the network interface.
EFI_UNSUPPORTED	This function is not supported by the network interface.

Definition at line 489 of file SnpInitialize.c.

◆ VirtioNetIsPacketAvailable()

VOID EFIAPI VirtioNetIsPacketAvailable	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

Invoke a notification event

Parameters

Event	Event whose notification function is being invoked.
Context	The pointer to the notification function's context, which is implementation-dependent.

Definition at line 31 of file Events.c.

◆ VirtioNetMapTxBuf()

EFI_STATUS EFIAPI VirtioNetMapTxBuf	(	IN VNET_DEV *	Dev,
		IN VOID *	Buffer,
		IN UINTN	NumberOfBytes,
		OUT EFI_PHYSICAL_ADDRESS *	DeviceAddress
	)

Map Caller-supplied TxBuf buffer to the device-mapped address

Parameters

[in]	Dev	The VNET_DEV driver instance which wants to map the Tx packet.
[in]	Buffer	The system physical address of TxBuf
[in]	NumberOfBytes	Number of bytes to map
[out]	DeviceAddress	The resulting device address for the bus master access.

Return values

EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.

Returns: Status codes from VirtioMapAllBytesInSharedBuffer()

Return values

EFI_SUCCESS Caller-supplied buffer is successfully mapped.

Definition at line 124 of file SnpSharedHelpers.c.

◆ VirtioNetMcastIpToMac()

EFI_STATUS EFIAPI VirtioNetMcastIpToMac	(	IN EFI_SIMPLE_NETWORK_PROTOCOL *	This,
		IN BOOLEAN	IPv6,
		IN EFI_IP_ADDRESS *	Ip,
		OUT EFI_MAC_ADDRESS *	Mac
	)

Converts a multicast IP address to a multicast HW MAC address.

Parameters

This	The protocol instance pointer.
IPv6	Set to TRUE if the multicast IP address is IPv6 [RFC 2460]. Set to FALSE if the multicast IP address is IPv4 [RFC 791].
IP	The multicast IP address that is to be converted to a multicast HW MAC address.
MAC	The multicast HW MAC address that is to be generated from IP.

Return values

EFI_SUCCESS	The multicast IP address was mapped to the multicast HW MAC address.
EFI_NOT_STARTED	The network interface has not been started.
EFI_BUFFER_TOO_SMALL	The Statistics buffer was too small. The current buffer size needed to hold the statistics is returned in StatisticsSize.
EFI_INVALID_PARAMETER	One or more of the parameters has an unsupported value.
EFI_DEVICE_ERROR	The command could not be sent to the network interface.
EFI_UNSUPPORTED	This function is not supported by the network interface.

Definition at line 43 of file SnpMcastIpToMac.c.

◆ VirtioNetNvData()

EFI_STATUS EFIAPI VirtioNetNvData	(	IN EFI_SIMPLE_NETWORK_PROTOCOL *	This,
		IN BOOLEAN	ReadWrite,
		IN UINTN	Offset,
		IN UINTN	BufferSize,
		IN OUT VOID *	Buffer
	)

Performs read and write operations on the NVRAM device attached to a network interface.

Parameters

This	The protocol instance pointer.
ReadWrite	TRUE for read operations, FALSE for write operations.
Offset	Byte offset in the NVRAM device at which to start the read or write operation. This must be a multiple of NvRamAccessSize and less than NvRamSize.
BufferSize	The number of bytes to read or write from the NVRAM device. This must also be a multiple of NvramAccessSize.
Buffer	A pointer to the data buffer.

Return values

EFI_SUCCESS	The NVRAM access was performed.
EFI_NOT_STARTED	The network interface has not been started.
EFI_INVALID_PARAMETER	One or more of the parameters has an unsupported value.
EFI_DEVICE_ERROR	The command could not be sent to the network interface.
EFI_UNSUPPORTED	This function is not supported by the network interface.

Definition at line 138 of file SnpUnsupported.c.

◆ VirtioNetReceive()

EFI_STATUS EFIAPI VirtioNetReceive	(	IN EFI_SIMPLE_NETWORK_PROTOCOL *	This,
		OUT UINTN *HeaderSize	OPTIONAL,
		IN OUT UINTN *	BufferSize,
		OUT VOID *	Buffer,
		OUT EFI_MAC_ADDRESS *SrcAddr	OPTIONAL,
		OUT EFI_MAC_ADDRESS *DestAddr	OPTIONAL,
		OUT UINT16 *Protocol	OPTIONAL
	)

Receives a packet from a network interface.

Parameters

This	The protocol instance pointer.
HeaderSize	The size, in bytes, of the media header received on the network interface. If this parameter is NULL, then the media header size will not be returned.
BufferSize	On entry, the size, in bytes, of Buffer. On exit, the size, in bytes, of the packet that was received on the network interface.
Buffer	A pointer to the data buffer to receive both the media header and the data.
SrcAddr	The source HW MAC address. If this parameter is NULL, the HW MAC source address will not be extracted from the media header.
DestAddr	The destination HW MAC address. If this parameter is NULL, the HW MAC destination address will not be extracted from the media header.
Protocol	The media header type. If this parameter is NULL, then the protocol will not be extracted from the media header. See RFC 1700 section "Ether Types" for examples.

Return values

EFI_SUCCESS	The received data was stored in Buffer, and BufferSize has been updated to the number of bytes received.
EFI_NOT_STARTED	The network interface has not been started.
EFI_NOT_READY	The network interface is too busy to accept this transmit request.
EFI_BUFFER_TOO_SMALL	The BufferSize parameter is too small.
EFI_INVALID_PARAMETER	One or more of the parameters has an unsupported value.
EFI_DEVICE_ERROR	The command could not be sent to the network interface.
EFI_UNSUPPORTED	This function is not supported by the network interface.

Definition at line 57 of file SnpReceive.c.

◆ VirtioNetReceiveFilters()

EFI_STATUS EFIAPI VirtioNetReceiveFilters	(	IN EFI_SIMPLE_NETWORK_PROTOCOL *	This,
		IN UINT32	Enable,
		IN UINT32	Disable,
		IN BOOLEAN	ResetMCastFilter,
		IN UINTN MCastFilterCnt	OPTIONAL,
		IN EFI_MAC_ADDRESS *MCastFilter	OPTIONAL
	)

Manages the multicast receive filters of a network interface.

Parameters

This	The protocol instance pointer.
Enable	A bit mask of receive filters to enable on the network interface.
Disable	A bit mask of receive filters to disable on the network interface.
ResetMCastFilter	Set to TRUE to reset the contents of the multicast receive filters on the network interface to their default values.
McastFilterCnt	Number of multicast HW MAC addresses in the new MCastFilter list. This value must be less than or equal to the MCastFilterCnt field of EFI_SIMPLE_NETWORK_MODE. This field is optional if ResetMCastFilter is TRUE.
MCastFilter	A pointer to a list of new multicast receive filter HW MAC addresses. This list will replace any existing multicast HW MAC address list. This field is optional if ResetMCastFilter is TRUE.

Return values

EFI_SUCCESS	The multicast receive filter list was updated.
EFI_NOT_STARTED	The network interface has not been started.
EFI_INVALID_PARAMETER	One or more of the parameters has an unsupported value.
EFI_DEVICE_ERROR	The command could not be sent to the network interface.
EFI_UNSUPPORTED	This function is not supported by the network interface.

Definition at line 50 of file SnpReceiveFilters.c.

◆ VirtioNetReset()

EFI_STATUS EFIAPI VirtioNetReset	(	IN EFI_SIMPLE_NETWORK_PROTOCOL *	This,
		IN BOOLEAN	ExtendedVerification
	)

Resets a network adapter and re-initializes it with the parameters that were provided in the previous call to Initialize().

Parameters

This	The protocol instance pointer.
ExtendedVerification	Indicates that the driver may perform a more exhaustive verification operation of the device during reset.

Return values

EFI_SUCCESS	The network interface was reset.
EFI_NOT_STARTED	The network interface has not been started.
EFI_INVALID_PARAMETER	One or more of the parameters has an unsupported value.
EFI_DEVICE_ERROR	The command could not be sent to the network interface.
EFI_UNSUPPORTED	This function is not supported by the network interface.

Definition at line 37 of file SnpUnsupported.c.

◆ VirtioNetShutdown()

EFI_STATUS EFIAPI VirtioNetShutdown ( IN EFI_SIMPLE_NETWORK_PROTOCOL * This )

Resets a network adapter and leaves it in a state that is safe for another driver to initialize.

Parameters

This	Protocol instance pointer.

Return values

EFI_SUCCESS	The network interface was shutdown.
EFI_NOT_STARTED	The network interface has not been started.
EFI_INVALID_PARAMETER	One or more of the parameters has an unsupported value.
EFI_DEVICE_ERROR	The command could not be sent to the network interface.
EFI_UNSUPPORTED	This function is not supported by the network interface.

Definition at line 35 of file SnpShutdown.c.

◆ VirtioNetShutdownRx()

VOID EFIAPI VirtioNetShutdownRx ( IN OUT VNET_DEV * Dev )

Release RX and TX resources on the boundary of the EfiSimpleNetworkInitialized state.

These functions contribute to rolling back a partial, failed initialization of the virtio-net SNP driver instance, or to shutting down a fully initialized, running instance.

They are only callable by the VirtioNetInitialize() and the VirtioNetShutdown() SNP methods. See the state diagram in "VirtioNet.h".

Parameters

[in,out] Dev The VNET_DEV driver instance being shut down, or whose partial, failed initialization is being rolled back.

Definition at line 41 of file SnpSharedHelpers.c.

◆ VirtioNetShutdownTx()

VOID EFIAPI VirtioNetShutdownTx ( IN OUT VNET_DEV * Dev )

Definition at line 55 of file SnpSharedHelpers.c.

◆ VirtioNetStart()

EFI_STATUS EFIAPI VirtioNetStart ( IN EFI_SIMPLE_NETWORK_PROTOCOL * This )

Changes the state of a network interface from "stopped" to "started".

Parameters

This	Protocol instance pointer.

Return values

EFI_SUCCESS	The network interface was started.
EFI_ALREADY_STARTED	The network interface is already in the started state.
EFI_INVALID_PARAMETER	One or more of the parameters has an unsupported value.
EFI_DEVICE_ERROR	The command could not be sent to the network interface.
EFI_UNSUPPORTED	This function is not supported by the network interface.

Definition at line 33 of file SnpStart.c.

◆ VirtioNetStationAddress()

EFI_STATUS EFIAPI VirtioNetStationAddress	(	IN EFI_SIMPLE_NETWORK_PROTOCOL *	This,
		IN BOOLEAN	Reset,
		IN EFI_MAC_ADDRESS *New	OPTIONAL
	)

Modifies or resets the current station address, if supported.

Parameters

This	The protocol instance pointer.
Reset	Flag used to reset the station address to the network interfaces permanent address.
New	The new station address to be used for the network interface.

Return values

EFI_SUCCESS	The network interfaces station address was updated.
EFI_NOT_STARTED	The network interface has not been started.
EFI_INVALID_PARAMETER	One or more of the parameters has an unsupported value.
EFI_DEVICE_ERROR	The command could not be sent to the network interface.
EFI_UNSUPPORTED	This function is not supported by the network interface.

Definition at line 66 of file SnpUnsupported.c.

◆ VirtioNetStatistics()

EFI_STATUS EFIAPI VirtioNetStatistics	(	IN EFI_SIMPLE_NETWORK_PROTOCOL *	This,
		IN BOOLEAN	Reset,
		IN OUT UINTN *StatisticsSize	OPTIONAL,
		OUT EFI_NETWORK_STATISTICS *StatisticsTable	OPTIONAL
	)

Resets or collects the statistics on a network interface.

Parameters

This	Protocol instance pointer.
Reset	Set to TRUE to reset the statistics for the network interface.
StatisticsSize	On input the size, in bytes, of StatisticsTable. On output the size, in bytes, of the resulting table of statistics.
StatisticsTable	A pointer to the EFI_NETWORK_STATISTICS structure that contains the statistics.

Return values

EFI_SUCCESS	The statistics were collected from the network interface.
EFI_NOT_STARTED	The network interface has not been started.
EFI_BUFFER_TOO_SMALL	The Statistics buffer was too small. The current buffer size needed to hold the statistics is returned in StatisticsSize.
EFI_INVALID_PARAMETER	One or more of the parameters has an unsupported value.
EFI_DEVICE_ERROR	The command could not be sent to the network interface.
EFI_UNSUPPORTED	This function is not supported by the network interface.

Definition at line 103 of file SnpUnsupported.c.

◆ VirtioNetStop()

EFI_STATUS EFIAPI VirtioNetStop ( IN EFI_SIMPLE_NETWORK_PROTOCOL * This )

Changes the state of a network interface from "started" to "stopped".

Parameters

This	Protocol instance pointer.

Return values

EFI_SUCCESS	The network interface was stopped.
EFI_ALREADY_STARTED	The network interface is already in the stopped state.
EFI_INVALID_PARAMETER	One or more of the parameters has an unsupported value.
EFI_DEVICE_ERROR	The command could not be sent to the network interface.
EFI_UNSUPPORTED	This function is not supported by the network interface.

Definition at line 34 of file SnpStop.c.

◆ VirtioNetTransmit()

EFI_STATUS EFIAPI VirtioNetTransmit	(	IN EFI_SIMPLE_NETWORK_PROTOCOL *	This,
		IN UINTN	HeaderSize,
		IN UINTN	BufferSize,
		IN VOID *	Buffer,
		IN EFI_MAC_ADDRESS *SrcAddr	OPTIONAL,
		IN EFI_MAC_ADDRESS *DestAddr	OPTIONAL,
		IN UINT16 *Protocol	OPTIONAL
	)

Places a packet in the transmit queue of a network interface.

Parameters

This	The protocol instance pointer.
HeaderSize	The size, in bytes, of the media header to be filled in by the Transmit() function. If HeaderSize is non-zero, then it must be equal to This->Mode->MediaHeaderSize and the DestAddr and Protocol parameters must not be NULL.
BufferSize	The size, in bytes, of the entire packet (media header and data) to be transmitted through the network interface.
Buffer	A pointer to the packet (media header followed by data) to be transmitted. This parameter cannot be NULL. If HeaderSize is zero, then the media header in Buffer must already be filled in by the caller. If HeaderSize is non-zero, then the media header will be filled in by the Transmit() function.
SrcAddr	The source HW MAC address. If HeaderSize is zero, then this parameter is ignored. If HeaderSize is non-zero and SrcAddr is NULL, then This->Mode->CurrentAddress is used for the source HW MAC address.
DestAddr	The destination HW MAC address. If HeaderSize is zero, then this parameter is ignored.
Protocol	The type of header to build. If HeaderSize is zero, then this parameter is ignored. See RFC 1700, section "Ether Types", for examples.

Return values

EFI_SUCCESS	The packet was placed on the transmit queue.
EFI_NOT_STARTED	The network interface has not been started.
EFI_NOT_READY	The network interface is too busy to accept this transmit request.
EFI_BUFFER_TOO_SMALL	The BufferSize parameter is too small.
EFI_INVALID_PARAMETER	One or more of the parameters has an unsupported value.
EFI_DEVICE_ERROR	The command could not be sent to the network interface.
EFI_UNSUPPORTED	This function is not supported by the network interface.

Definition at line 59 of file SnpTransmit.c.

◆ VirtioNetTxBufDeviceAddressCompare()

INTN EFIAPI VirtioNetTxBufDeviceAddressCompare	(	IN CONST VOID *	StandaloneKey,
		IN CONST VOID *	UserStruct
	)

Compare a standalone DeviceAddress against a TX_BUF_MAP_INFO object containing an embedded DeviceAddress.

Parameters

[in]	StandaloneKey	Pointer to DeviceAddress, which has type EFI_PHYSICAL_ADDRESS.
[in]	UserStruct	Pointer to the TX_BUF_MAP_INFO object with the embedded DeviceAddress.

Return values

<0	If StandaloneKey compares less than UserStruct's key.
0	If StandaloneKey compares equal to UserStruct's key.
>0	If StandaloneKey compares greater than UserStruct's key.

Definition at line 288 of file SnpSharedHelpers.c.

◆ VirtioNetTxBufMapInfoCompare()

INTN EFIAPI VirtioNetTxBufMapInfoCompare	(	IN CONST VOID *	UserStruct1,
		IN CONST VOID *	UserStruct2
	)

Comparator function for two TX_BUF_MAP_INFO objects.

Parameters

[in]	UserStruct1	Pointer to the first TX_BUF_MAP_INFO object.
[in]	UserStruct2	Pointer to the second TX_BUF_MAP_INFO object.

Return values

<0	If UserStruct1 compares less than UserStruct2.
0	If UserStruct1 compares equal to UserStruct2.
>0	If UserStruct1 compares greater than UserStruct2.

Definition at line 254 of file SnpSharedHelpers.c.

◆ VirtioNetUninitRing()

VOID EFIAPI VirtioNetUninitRing	(	IN OUT VNET_DEV *	Dev,
		IN OUT VRING *	Ring,
		IN VOID *	RingMap
	)

Release TX and RX VRING resources.

Parameters

[in,out]	Dev	The VNET_DEV driver instance which was using the ring.
[in,out]	Ring	The virtio ring to clean up.
[in]	RingMap	A token return from the VirtioRingMap()

Definition at line 96 of file SnpSharedHelpers.c.

◆ VirtioNetUnmapTxBuf()

EFI_STATUS EFIAPI VirtioNetUnmapTxBuf	(	IN VNET_DEV *	Dev,
		OUT VOID **	Buffer,
		IN EFI_PHYSICAL_ADDRESS	DeviceAddress
	)

Unmap (aka reverse mapping) device mapped TxBuf buffer to the system physical address

Parameters

[in]	Dev	The VNET_DEV driver instance which wants to reverse- and unmap the Tx packet.
[out]	Buffer	The system physical address of TxBuf
[in]	DeviceAddress	The device address for the TxBuf

Return values

EFI_INVALID_PARAMETER	The DeviceAddress is not mapped
EFI_SUCCESS	The TxBuf at DeviceAddress has been unmapped, and Buffer has been set to TxBuf's system physical address.

Definition at line 213 of file SnpSharedHelpers.c.

Variable Documentation

◆ gVirtioNetComponentName

EFI_COMPONENT_NAME_PROTOCOL gVirtioNetComponentName

extern

Definition at line 165 of file ComponentName.c.

◆ gVirtioNetComponentName2

EFI_COMPONENT_NAME2_PROTOCOL gVirtioNetComponentName2

extern

Definition at line 171 of file ComponentName.c.

◆ gVirtioNetDriverBinding

EFI_DRIVER_BINDING_PROTOCOL gVirtioNetDriverBinding

extern

Definition at line 704 of file DriverBinding.c.

Data Structures

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ VIRTIO_CFG_READ

◆ VIRTIO_CFG_WRITE

◆ VIRTIO_NET_FROM_SNP

◆ VNET_MAX_PENDING

◆ VNET_SIG

Function Documentation

◆ VirtioNetExitBoot()

◆ VirtioNetGetStatus()

◆ VirtioNetInitialize()

◆ VirtioNetIsPacketAvailable()

◆ VirtioNetMapTxBuf()

◆ VirtioNetMcastIpToMac()

◆ VirtioNetNvData()

◆ VirtioNetReceive()

◆ VirtioNetReceiveFilters()

◆ VirtioNetReset()

◆ VirtioNetShutdown()

◆ VirtioNetShutdownRx()

◆ VirtioNetShutdownTx()

◆ VirtioNetStart()

◆ VirtioNetStationAddress()

◆ VirtioNetStatistics()

◆ VirtioNetStop()

◆ VirtioNetTransmit()

◆ VirtioNetTxBufDeviceAddressCompare()

◆ VirtioNetTxBufMapInfoCompare()

◆ VirtioNetUninitRing()

◆ VirtioNetUnmapTxBuf()

Variable Documentation

◆ gVirtioNetComponentName

◆ gVirtioNetComponentName2

◆ gVirtioNetDriverBinding