TianoCore EDK2 master
Loading...
Searching...
No Matches
EmuSnpDxe.h File Reference

Go to the source code of this file.

Data Structures

struct  EMU_SNP_PRIVATE_DATA
 

Macros

#define NET_ETHER_HEADER_SIZE   14
 
#define EMU_SNP_PRIVATE_DATA_SIGNATURE   SIGNATURE_32( 'U', 'S', 'N', 'P' )
 
#define EMU_SNP_PRIVATE_DATA_FROM_SNP_THIS(a)    CR( a, EMU_SNP_PRIVATE_DATA, Snp, EMU_SNP_PRIVATE_DATA_SIGNATURE )
 

Functions

EFI_STATUS EFIAPI EmuSnpDriverBindingSupported (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL)
 
EFI_STATUS EFIAPI EmuSnpDriverBindingStart (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL)
 
EFI_STATUS EFIAPI EmuSnpDriverBindingStop (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN UINTN NumberOfChildren, IN EFI_HANDLE *ChildHandleBuffer)
 
EFI_STATUS EFIAPI EmuSnpStart (IN EFI_SIMPLE_NETWORK_PROTOCOL *This)
 
EFI_STATUS EFIAPI EmuSnpStop (IN EFI_SIMPLE_NETWORK_PROTOCOL *This)
 
EFI_STATUS EFIAPI EmuSnpInitialize (IN EFI_SIMPLE_NETWORK_PROTOCOL *This, IN UINTN ExtraRxBufferSize OPTIONAL, IN UINTN ExtraTxBufferSize OPTIONAL)
 
EFI_STATUS EFIAPI EmuSnpReset (IN EFI_SIMPLE_NETWORK_PROTOCOL *This, IN BOOLEAN ExtendedVerification)
 
EFI_STATUS EFIAPI EmuSnpShutdown (IN EFI_SIMPLE_NETWORK_PROTOCOL *This)
 
EFI_STATUS EFIAPI EmuSnpReceiveFilters (IN EFI_SIMPLE_NETWORK_PROTOCOL *This, IN UINT32 EnableBits, IN UINT32 DisableBits, IN BOOLEAN ResetMcastFilter, IN UINTN McastFilterCount OPTIONAL, IN EFI_MAC_ADDRESS *McastFilter OPTIONAL)
 
EFI_STATUS EFIAPI EmuSnpStationAddress (IN EFI_SIMPLE_NETWORK_PROTOCOL *This, IN BOOLEAN Reset, IN EFI_MAC_ADDRESS *NewMacAddr OPTIONAL)
 
EFI_STATUS EFIAPI EmuSnpStatistics (IN EFI_SIMPLE_NETWORK_PROTOCOL *This, IN BOOLEAN Reset, IN OUT UINTN *StatisticsSize OPTIONAL, OUT EFI_NETWORK_STATISTICS *StatisticsTable OPTIONAL)
 
EFI_STATUS EFIAPI EmuSnpMcastIptoMac (IN EFI_SIMPLE_NETWORK_PROTOCOL *This, IN BOOLEAN Ipv6, IN EFI_IP_ADDRESS *Ip, OUT EFI_MAC_ADDRESS *Mac)
 
EFI_STATUS EFIAPI EmuSnpNvdata (IN EFI_SIMPLE_NETWORK_PROTOCOL *This, IN BOOLEAN ReadOrWrite, IN UINTN Offset, IN UINTN BufferSize, IN OUT VOID *Buffer)
 
EFI_STATUS EFIAPI EmuSnpGetStatus (IN EFI_SIMPLE_NETWORK_PROTOCOL *This, OUT UINT32 *InterruptStatus, OUT VOID **TxBuffer)
 
EFI_STATUS EFIAPI EmuSnpTransmit (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 EmuSnpReceive (IN EFI_SIMPLE_NETWORK_PROTOCOL *This, OUT UINTN *HeaderSize OPTIONAL, IN OUT UINTN *BuffSize, OUT VOID *Buffer, OUT EFI_MAC_ADDRESS *SourceAddr OPTIONAL, OUT EFI_MAC_ADDRESS *DestinationAddr OPTIONAL, OUT UINT16 *Protocol OPTIONAL)
 
VOID EFIAPI EmuSnpWaitForPacketNotify (IN EFI_EVENT Event, IN VOID *Private)
 

Variables

EFI_DRIVER_BINDING_PROTOCOL gEmuSnpDriverBinding
 
EFI_COMPONENT_NAME_PROTOCOL gEmuSnpDriverComponentName
 
EFI_COMPONENT_NAME2_PROTOCOL gEmuSnpDriverComponentName2
 

Detailed Description

Copyright (c) 2010, Apple, Inc. All rights reserved.

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

Module Name:

EmuSnp.h

Abstract:

Definition in file EmuSnpDxe.h.

Macro Definition Documentation

◆ EMU_SNP_PRIVATE_DATA_FROM_SNP_THIS

#define EMU_SNP_PRIVATE_DATA_FROM_SNP_THIS (   a)     CR( a, EMU_SNP_PRIVATE_DATA, Snp, EMU_SNP_PRIVATE_DATA_SIGNATURE )

Definition at line 56 of file EmuSnpDxe.h.

◆ EMU_SNP_PRIVATE_DATA_SIGNATURE

#define EMU_SNP_PRIVATE_DATA_SIGNATURE   SIGNATURE_32( 'U', 'S', 'N', 'P' )

Definition at line 39 of file EmuSnpDxe.h.

◆ NET_ETHER_HEADER_SIZE

#define NET_ETHER_HEADER_SIZE   14

Definition at line 34 of file EmuSnpDxe.h.

Function Documentation

◆ EmuSnpDriverBindingStart()

EFI_STATUS EFIAPI EmuSnpDriverBindingStart ( IN EFI_DRIVER_BINDING_PROTOCOL This,
IN EFI_HANDLE  ControllerHandle,
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath  OPTIONAL 
)

Start this driver on ControllerHandle. This service is called by the EFI boot service ConnectController(). In order to make drivers as small as possible, there are a few calling restrictions for this service. ConnectController() must follow these calling restrictions. If any other agent wishes to call Start() it must also follow these calling restrictions.

Parameters
ThisProtocol instance pointer.
ControllerHandleHandle of device to bind driver to
RemainingDevicePathOptional parameter use to pick a specific child device to start.
Return values
EFI_SUCCESSAlways succeeds.

Definition at line 670 of file EmuSnpDxe.c.

◆ EmuSnpDriverBindingStop()

EFI_STATUS EFIAPI EmuSnpDriverBindingStop ( IN EFI_DRIVER_BINDING_PROTOCOL This,
IN EFI_HANDLE  ControllerHandle,
IN UINTN  NumberOfChildren,
IN EFI_HANDLE ChildHandleBuffer 
)

Stop this driver on ControllerHandle. This service is called by the EFI boot service DisconnectController(). In order to make drivers as small as possible, there are a few calling restrictions for this service. DisconnectController() must follow these calling restrictions. If any other agent wishes to call Stop() it must also follow these calling restrictions.

Parameters
ThisProtocol instance pointer.
ControllerHandleHandle of device to stop driver on
NumberOfChildrenNumber of Handles in ChildHandleBuffer. If number of children is zero stop the entire bus driver.
ChildHandleBufferList of Child Handles to Stop.
Return values
EFI_SUCCESSAlways succeeds.

Definition at line 849 of file EmuSnpDxe.c.

◆ EmuSnpDriverBindingSupported()

EFI_STATUS EFIAPI EmuSnpDriverBindingSupported ( IN EFI_DRIVER_BINDING_PROTOCOL This,
IN EFI_HANDLE  ControllerHandle,
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath  OPTIONAL 
)

Test to see if this driver supports ControllerHandle. This service is called by the EFI boot service ConnectController(). In order to make drivers as small as possible, there are a few calling restrictions for this service. ConnectController() must follow these calling restrictions. If any other agent wishes to call Supported() it must also follow these calling restrictions.

Parameters
ThisProtocol instance pointer.
ControllerHandleHandle of device to test
RemainingDevicePathOptional parameter use to pick a specific child device to start.
Return values
EFI_SUCCESSThis driver supports this device
EFI_UNSUPPORTEDThis driver does not support this device

Definition at line 564 of file EmuSnpDxe.c.

◆ EmuSnpGetStatus()

EFI_STATUS EFIAPI EmuSnpGetStatus ( IN EFI_SIMPLE_NETWORK_PROTOCOL This,
OUT UINT32 *  InterruptStatus,
OUT VOID **  TxBuffer 
)

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

Parameters
ThisProtocol instance pointer.
InterruptStatusA 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.
TxBufferRecycled 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_SUCCESSAlways succeeds.

Definition at line 412 of file EmuSnpDxe.c.

◆ EmuSnpInitialize()

EFI_STATUS EFIAPI EmuSnpInitialize ( 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
ThisProtocol instance pointer.
ExtraRxBufferSizeThe 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.
ExtraTxBufferSizeThe 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_SUCCESSAlways succeeds.

Definition at line 137 of file EmuSnpDxe.c.

◆ EmuSnpMcastIptoMac()

EFI_STATUS EFIAPI EmuSnpMcastIptoMac ( 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
ThisProtocol instance pointer.
Ipv6Set to TRUE if the multicast IP address is IPv6 [RFC 2460]. Set to FALSE if the multicast IP address is IPv4 [RFC 791].
IpThe multicast IP address that is to be converted to a multicast HW MAC address.
MacThe multicast HW MAC address that is to be generated from IP.
Return values
EFI_SUCCESSThe multicast IP address was mapped to the multicast HW MAC address.
EFI_NOT_STARTEDThe network interface has not been started.
EFI_BUFFER_TOO_SMALLThe Statistics buffer was too small. The current buffer size needed to hold the statistics is returned in StatisticsSize.
EFI_UNSUPPORTEDNot supported yet.

Definition at line 338 of file EmuSnpDxe.c.

◆ EmuSnpNvdata()

EFI_STATUS EFIAPI EmuSnpNvdata ( IN EFI_SIMPLE_NETWORK_PROTOCOL This,
IN BOOLEAN  ReadOrWrite,
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
ThisProtocol instance pointer.
ReadOrWriteTRUE for read operations, FALSE for write operations.
OffsetByte 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.
BufferSizeThe number of bytes to read or write from the NVRAM device. This must also be a multiple of NvramAccessSize.
BufferA pointer to the data buffer.
Return values
EFI_UNSUPPORTEDNot supported yet.

Definition at line 372 of file EmuSnpDxe.c.

◆ EmuSnpReceive()

EFI_STATUS EFIAPI EmuSnpReceive ( IN EFI_SIMPLE_NETWORK_PROTOCOL This,
OUT UINTN *HeaderSize  OPTIONAL,
IN OUT UINTN BuffSize,
OUT VOID *  Buffer,
OUT EFI_MAC_ADDRESS *SourceAddr  OPTIONAL,
OUT EFI_MAC_ADDRESS *DestinationAddr  OPTIONAL,
OUT UINT16 *Protocol  OPTIONAL 
)

Receives a packet from a network interface.

Parameters
ThisProtocol instance pointer.
HeaderSizeThe 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.
BuffSizeOn entry, the size, in bytes, of Buffer. On exit, the size, in bytes, of the packet that was received on the network interface.
BufferA pointer to the data buffer to receive both the media header and the data.
SourceAddrThe source HW MAC address. If this parameter is NULL, the HW MAC source address will not be extracted from the media header.
DestinationAddrThe destination HW MAC address. If this parameter is NULL, the HW MAC destination address will not be extracted from the media header.
ProtocolThe 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_SUCCESSThe received data was stored in Buffer, and BufferSize has been updated to the number of bytes received.
EFI_NOT_READYThe network interface is too busy to accept this transmit request.
EFI_BUFFER_TOO_SMALLThe BufferSize parameter is too small.
EFI_DEVICE_ERRORThe command could not be sent to the network interface.
EFI_ACCESS_DENIEDError acquire global lock for operation.

Receives a packet from a network interface.

Parameters
ThisProtocol instance pointer.
HeaderSizeThe 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.
BuffSizeOn entry, the size, in bytes, of Buffer. On exit, the size, in bytes, of the packet that was received on the network interface.
BufferA pointer to the data buffer to receive both the media header and the data.
SourceAddrThe source HW MAC address. If this parameter is NULL, the HW MAC source address will not be extracted from the media header.
DestinationAddrThe destination HW MAC address. If this parameter is NULL, the HW MAC destination address will not be extracted from the media header.
ProtocolThe 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_SUCCESSThe received data was stored in Buffer, and BufferSize has been updated to the number of bytes received.
EFI_NOT_READYThe network interface is too busy to accept this transmit request.
EFI_NOT_STARTEDThe network interface has not been started.
EFI_BUFFER_TOO_SMALLThe BufferSize parameter is too small.
EFI_DEVICE_ERRORThe command could not be sent to the network interface.

Definition at line 518 of file EmuSnpDxe.c.

◆ EmuSnpReceiveFilters()

EFI_STATUS EFIAPI EmuSnpReceiveFilters ( IN EFI_SIMPLE_NETWORK_PROTOCOL This,
IN UINT32  EnableBits,
IN UINT32  DisableBits,
IN BOOLEAN  ResetMcastFilter,
IN UINTN McastFilterCount  OPTIONAL,
IN EFI_MAC_ADDRESS *McastFilter  OPTIONAL 
)

Manages the multicast receive filters of a network interface.

Parameters
ThisProtocol instance pointer.
EnableBitsA bit mask of receive filters to enable on the network interface.
DisableBitsA bit mask of receive filters to disable on the network interface.
ResetMcastFilterSet to TRUE to reset the contents of the multicast receive filters on the network interface to their default values.
McastFilterCountNumber 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.
McastFilterA 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_SUCCESSThe multicast receive filter list was updated.
EFI_DEVICE_ERRORThe command could not be sent to the network interface.

Definition at line 227 of file EmuSnpDxe.c.

◆ EmuSnpReset()

EFI_STATUS EFIAPI EmuSnpReset ( 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
ThisProtocol instance pointer.
ExtendedVerificationIndicates that the driver may perform a more exhaustive verification operation of the device during reset.
Return values
EFI_SUCCESSAlways succeeds.

Definition at line 166 of file EmuSnpDxe.c.

◆ EmuSnpShutdown()

EFI_STATUS EFIAPI EmuSnpShutdown ( 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
ThisProtocol instance pointer.
Return values
EFI_SUCCESSAlways succeeds.

Definition at line 191 of file EmuSnpDxe.c.

◆ EmuSnpStart()

EFI_STATUS EFIAPI EmuSnpStart ( IN EFI_SIMPLE_NETWORK_PROTOCOL This)

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

Parameters
ThisProtocol instance pointer.
Return values
EFI_SUCCESSAlways succeeds.

Definition at line 79 of file EmuSnpDxe.c.

◆ EmuSnpStationAddress()

EFI_STATUS EFIAPI EmuSnpStationAddress ( IN EFI_SIMPLE_NETWORK_PROTOCOL This,
IN BOOLEAN  Reset,
IN EFI_MAC_ADDRESS *NewMacAddr  OPTIONAL 
)

Modifies or resets the current station address, if supported.

Parameters
ThisProtocol instance pointer.
ResetFlag used to reset the station address to the network interfaces permanent address.
NewMacAddrNew station address to be used for the network interface.
Return values
EFI_UNSUPPORTEDNot supported yet.

Definition at line 265 of file EmuSnpDxe.c.

◆ EmuSnpStatistics()

EFI_STATUS EFIAPI EmuSnpStatistics ( 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
ThisProtocol instance pointer.
ResetSet to TRUE to reset the statistics for the network interface.
StatisticsSizeOn input the size, in bytes, of StatisticsTable. On output the size, in bytes, of the resulting table of statistics.
StatisticsTableA pointer to the EFI_NETWORK_STATISTICS structure that contains the statistics.
Return values
EFI_SUCCESSThe statistics were collected from the network interface.
EFI_NOT_STARTEDThe network interface has not been started.
EFI_BUFFER_TOO_SMALLThe Statistics buffer was too small. The current buffer size needed to hold the statistics is returned in StatisticsSize.
EFI_UNSUPPORTEDNot supported yet.

Definition at line 301 of file EmuSnpDxe.c.

◆ EmuSnpStop()

EFI_STATUS EFIAPI EmuSnpStop ( IN EFI_SIMPLE_NETWORK_PROTOCOL This)

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

Parameters
ThisProtocol instance pointer.
Return values
EFI_SUCCESSAlways succeeds.

Definition at line 102 of file EmuSnpDxe.c.

◆ EmuSnpTransmit()

EFI_STATUS EFIAPI EmuSnpTransmit ( 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
ThisProtocol instance pointer.
HeaderSizeThe 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.
BufferSizeThe size, in bytes, of the entire packet (media header and data) to be transmitted through the network interface.
BufferA 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.
SrcAddrThe 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.
DestAddrThe destination HW MAC address. If HeaderSize is zero, then this parameter is ignored.
ProtocolThe 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_SUCCESSThe packet was placed on the transmit queue.
EFI_DEVICE_ERRORThe command could not be sent to the network interface.
EFI_ACCESS_DENIEDError acquire global lock for operation.

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

Parameters
ThisProtocol instance pointer.
HeaderSizeThe 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.
BufferSizeThe size, in bytes, of the entire packet (media header and data) to be transmitted through the network interface.
BufferA 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.
SrcAddrThe 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.
DestAddrThe destination HW MAC address. If HeaderSize is zero, then this parameter is ignored.
ProtocolThe 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_SUCCESSThe packet was placed on the transmit queue.
EFI_DEVICE_ERRORThe command could not be sent to the network interface.
EFI_INVALID_PARAMETEROne or more of the parameters has an unsupported value.
EFI_NOT_STARTEDThe network interface has not been started.

Definition at line 459 of file EmuSnpDxe.c.

Variable Documentation

◆ gEmuSnpDriverBinding

EFI_DRIVER_BINDING_PROTOCOL gEmuSnpDriverBinding
extern

Definition at line 943 of file EmuSnpDxe.c.

◆ gEmuSnpDriverComponentName

EFI_COMPONENT_NAME_PROTOCOL gEmuSnpDriverComponentName
extern

Definition at line 149 of file ComponentName.c.

◆ gEmuSnpDriverComponentName2

EFI_COMPONENT_NAME2_PROTOCOL gEmuSnpDriverComponentName2
extern

Definition at line 158 of file ComponentName.c.