EFI SIMPLE NETWORK PROTOCOL

From PhoenixWiki

Jump to: navigation, search

Provides services to initialize a network interface, transmit packets, receive packets, and close a network interface.

Contents

GUID

#define EFI_SIMPLE_NETWORK_PROTOCOL_GUID \
  {0xA19832B9,0xAC25,0x11D3,0x9A,0x2D,0x00,0x90,0x27,0x3f,0xc1,0x4d}

Revision Number

#define EFI_SIMPLE_NETWORK_PROTOCOL_REVISION 0x00010000

Protocol Interface Structure

#include EFI_PROTOCOL_CONSUMER(SimpleNetwork)
extern EFI_GUID gEfiSimpleNetworkProtocolGuid;
typedef struct _EFI_SIMPLE_NETWORK_PROTOCOL_ {
  UINT64 Revision;
  EFI_SIMPLE_NETWORK_START            Start;
  EFI_SIMPLE_NETWORK_STOP             Stop;
  EFI_SIMPLE_NETWORK_INITIALIZE       Initialize;
  EFI_SIMPLE_NETWORK_RESET            Reset;
  EFI_SIMPLE_NETWORK_SHUTDOWN         Shutdown;
  EFI_SIMPLE_NETWORK_RECEIVE_FILTERS  ReceiveFilters;
  EFI_SIMPLE_NETWORK_STATION_ADDRESS  StationAddress;
  EFI_SIMPLE_NETWORK_STATISTICS       Statistics;
  EFI_SIMPLE_NETWORK_MCAST_IP_TO_MAC  MCastIpToMac;
  EFI_SIMPLE_NETWORK_NVDATA           NvData;
  EFI_SIMPLE_NETWORK_GET_STATUS       GetStatus;
  EFI_SIMPLE_NETWORK_TRANSMIT         Transmit;
  EFI_SIMPLE_NETWORK_RECEIVE          Receive;
  EFI_EVENT                           WaitForPacket;
  EFI_SIMPLE_NETWORK_MODE             *Mode;
} EFI_SIMPLE_NETWORK_PROTOCOL;

Members

Members Description
Revision Revision of the EFI_SIMPLE_NETWORK_PROTOCOL. All future revisions must be backwards compatible. If a future version is not backwards compatible it is not the same GUID.
Start Prepares the network interface for further command operations. No other EFI_SIMPLE_NETWORK_PROTOCOL interface functions will operate until this call is made.
Stop Stops further network interface command processing. No other EFI_SIMPLE_NETWORK_PROTOCOL interface functions will operate after this call is made until another Start() call is made.
Initialize Resets the network adapter and allocates the transmit and receive buffers.
Reset Resets the network adapter and reinitializes it with the parameters provided in the previous call to Initialize().
Shutdown Resets the network adapter and leaves it in a state safe for another driver to initialize. The memory buffers assigned in the Initialize() call are released. After this call, only the Initialize() or Stop() calls may be used.
ReceiveFilters Enables and disables the receive filters for the network interface and, if supported, manages the filtered multicast HW MAC (Hardware Media Access Control) address list.
StationAddress Modifies or resets the current station address, if supported.
Statistics Collects statistics from the network interface and allows the statistics to be reset.
MCastIpToMac Maps a multicast IP address to a multicast HW MAC address.
NvData Reads and writes the contents of the NVRAM devices attached to the network interface.
GetStatus Reads the current interrupt status and the list of recycled transmit buffers from the network interface.
Transmit Places a packet in the transmit queue.
Receive Retrieves a packet from the receive queue, along with the status flags that describe the packet type.
WaitForPacket Event used with WaitForEvent() to wait for a packet to be received.
Mode Pointer to the EFI_SIMPLE_NETWORK_MODE data for the device. The fields in this data structure are read-only and are updated only by the driver that produces this protocol. All of these fields must be initialized during driver initialization.

Related Definitions

#define EFI_SIMPLE_NETWORK_RECEIVE_UNICAST               0x01
#define EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST             0x02
#define EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST             0x04
#define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS           0x08
#define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST 0x10

Description

The EFI_SIMPLE_NETWORK_PROTOCOL protocol is used to initialize access to a network adapter. Once the network adapter initializes, the EFI_SIMPLE_NETWORK_PROTOCOL protocol provides services that allow packets to be transmitted and received. This provides a packet level interface that can then be used by higher level drivers to produce boot services like DHCP, TFTP, and MTFTP. In addition, this protocol can be used as a building block in a full UDP and TCP/IP implementation that can produce a wide variety of application level network interfaces. See the Preboot Execution Environment (PXE) Specification for more information.

Note: The underlying network hardware may only be able to access 4 GB (32-bits) of system memory. Any requests to transfer data to/from memory above 4 GB with 32-bit network hardware will be double-buffered (using intermediate buffers below 4 GB) and will reduce performance.

Start()

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

Prototype

typedef
EFI_STATUS
(EFIAPI *EFI_SIMPLE_NETWORK_START) (
  IN EFI_SIMPLE_NETWORK_PROTOCOL *This
  );

Parameters

Parameter Description
This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.

Description
This function starts a network interface. If the network interface successfully starts, then EFI_SUCCESS will be returned.

Status Codes Returned

Status Code Description
EFI_SUCCESS The network interface was started.
EFI_ALREADY_STARTED The network interface is already in the started state.
EFI_INVALID_PARAMETER This parameter was NULL or did not point to a valid EFI_SIMPLE_NETWORK_PROTOCOL structure.
EFI_DEVICE_ERROR The command could not be sent to the network interface.
EFI_UNSUPPORTED This function is not supported by the network interface.

Stop()

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

Prototype

typedef
EFI_STATUS
(EFIAPI *EFI_SIMPLE_NETWORK_STOP) (
  IN EFI_SIMPLE_NETWORK_PROTOCOL *This
  );

Parameters

Parameter Description
This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.

Description
This function stops a network interface. This call is only valid if the network interface is in the started state. If the network interface was successfully stopped, then EFI_SUCCESS will be returned.

Status Codes Returned

Status Code Description
EFI_SUCCESS The network interface was stopped.
EFI_NOT_STARTED The network interface has not been started.
EFI_INVALID_PARAMETER This parameter was NULL or did not point to a valid EFI_SIMPLE_NETWORK_PROTOCOL structure.
EFI_DEVICE_ERROR The command could not be sent to the network interface.
EFI_UNSUPPORTED This function is not supported by the network interface.

Initialize()

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.

Prototype

typedef
EFI_STATUS
(EFIAPI *EFI_SIMPLE_NETWORK_INITIALIZE) (
  IN EFI_SIMPLE_NETWORK_PROTOCOL *This,
  IN UINTN                       ExtraRxBufferSize OPTIONAL,
  IN UINTN                       ExtraTxBufferSize OPTIONAL
  );

Parameters

Parameter Description
This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.
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.

Description
This function allocates the transmit and receive buffers required by the network interface. If this allocation fails, then EFI_OUT_OF_RESOURCES is returned. If the allocation succeeds and the network interface is successfully initialized, then EFI_SUCCESS will be returned.

Status Codes Returned

Status Code Description
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 This parameter was NULL or did not point to a valid EFI_SIMPLE_NETWORK_PROTOCOL structure.
EFI_DEVICE_ERROR The command could not be sent to the network interface.
EFI_UNSUPPORTED The increased buffer size feature is not supported.

Reset()

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

Prototype

typedef
EFI_STATUS
(EFIAPI *EFI_SIMPLE_NETWORK_RESET) (
  IN EFI_SIMPLE_NETWORK_PROTOCOL *This,
  IN BOOLEAN                     ExtendedVerification
  );

Parameters

Parameter Description
This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.
ExtendedVerification Indicates that the driver may perform a more exhaustive verification operation of the device during reset.


Description
This function resets a network adapter and reinitializes it with the parameters that were provided in the previous call to Initialize(). The transmit and receive queues are emptied and all pending interrupts are cleared. Receive filters, the station address, the statistics, and the multicast-IP-to-HW MAC addresses are not reset by this call. If the network interface was successfully reset, then EFI_SUCCESS will be returned. If the driver has not been initialized, EFI_DEVICE_ERROR will be returned.

Status Codes Returned

Status Code Description
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.

Shutdown()

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

Prototype

typedef
EFI_STATUS
(EFIAPI *EFI_SIMPLE_NETWORK_SHUTDOWN) (
  IN EFI_SIMPLE_NETWORK_PROTOCOL *This
  );

Parameters

Parameter Description
This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.

Description
This function releases the memory buffers assigned in the Initialize() call. Pending transmits and receives are lost, and interrupts are cleared and disabled. After this call, only the Initialize() and Stop() calls may be used. If the network interface was successfully shutdown, then EFI_SUCCESS will be returned. If the driver has not been initialized, EFI_DEVICE_ERROR will be returned.

Status Codes Returned

Status Code Description
EFI_SUCCESS The network interface was shutdown.
EFI_NOT_STARTED The network interface has not been started.
EFI_INVALID_PARAMETER This parameter was NULL or did not point to a valid EFI_SIMPLE_NETWORK_PROTOCOL structure.
EFI_DEVICE_ERROR The command could not be sent to the network interface.

ReceiveFilters()

Manages the multicast receive filters of a network interface.

Prototype

typedef
EFI_STATUS
(EFIAPI *EFI_SIMPLE_NETWORK_RECEIVE_FILTERS) (
  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,
  );

Parameters

Parameter Description
This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.
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. For backward compatibility with EFI 1.1 platforms, the EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST bit must be set when the ResetMCastFilter parameter is TRUE.
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.

Description
This function is used enable and disable the hardware and software receive filters for the underlying network device. The receive filter change is broken down into three steps:

  • The filter mask bits that are set (ON) in the Enable parameter are added to the current receive filter settings.
  • The filter mask bits that are set (ON) in the Disable parameter are subtracted from the updated receive filter settings.
  • If the resulting receive filter setting is not supported by the hardware a more liberal setting is selected.

If the same bits are set in the Enable and Disable parameters, then the bits in the Disable parameter takes precedence.

If the ResetMCastFilter parameter is TRUE, then the multicast address list filter is disabled (irregardless of what other multicast bits are set in the Enable and Disable parameters). The SNP->Mode->MCastFilterCount field is set to zero. The Snp->Mode->MCastFilter contents are undefined.

After enabling or disabling receive filter settings, software should verify the new settings by checking the Snp->Mode->ReceiveFilterSettings, Snp->Mode->MCastFilterCount and Snp->Mode->MCastFilter fields.

Note: Some network drivers and/or devices will automatically promote receive filter settings if the requested setting can not be honored. For example, if a request for four multicast addresses is made and the underlying hardware only supports two multicast addresses the driver might set the promiscuous or promiscuous multicast receive filters instead. The receiving software is responsible for discarding any extra packets that get through the hardware receive filters.

Note: Note: To disable all receive filter hardware, the network driver must be Shutdown() and Stopped(). Calling ReceiveFilters() with Disable set to Snp->Mode->ReceiveFilterSettings will make it so no more packets are returned by the Receive() function, but the receive hardware may still be moving packets into system memory before inspecting and discarding them. Unexpected system errors, reboots and hangs can occur if an OS is loaded and the network devices are not Shutdown() and Stopped().

If ResetMCastFilter is TRUE, then the multicast receive filter list on the network interface will be reset to the default multicast receive filter list. If ResetMCastFilter is FALSE, and this network interface allows the multicast receive filter list to be modified, then the MCastFilterCnt and MCastFilter are used to update the current multicast receive filter list. The modified receive filter list settings can be found in the MCastFilter field of EFI_SIMPLE_NETWORK_MODE. If the network interface does not allow the multicast receive filter list to be modified, then EFI_INVALID_PARAMETER will be returned. If the driver has not been initialized, EFI_DEVICE_ERROR will be returned.

If the receive filter mask and multicast receive filter list have been successfully updated on the network interface, EFI_SUCCESS will be returned.

Status Codes Returned

Status Code Description
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 following conditions is TRUE:
  • This is NULL
  • There are bits set in Enable that are not set in Snp->Mode->ReceiveFilterMask
  • There are bits set in Disable that are not set in Snp->Mode->ReceiveFilterMask
  • Multicast is being enabled (the EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST bit is set in Enable, it is not set in Disable, and ResetMCastFilter is FALSE) and MCastFilterCount is zero
  • Multicast is being enabled and MCastFilterCount is greater than Snp->Mode->MaxMCastFilterCount
  • Multicast is being enabled and MCastFilter is NULL
  • Multicast is being enabled and one or more of the addresses in the MCastFilter list are not valid multicast MAC addresses
EFI_DEVICE_ERROR One or more of the following conditions is TRUE:
  • The network interface has been started but has not been initialized
  • An unexpected error was returned by the underlying network driver or device
EFI_UNSUPPORTED This function is not supported by the network interface.

StationAddress()

Modifies or resets the current station address, if supported.

Prototype

typedef
EFI_STATUS
(EFIAPI *EFI_SIMPLE_NETWORK_STATION_ADDRESS) (
  IN EFI_SIMPLE_NETWORK_PROTOCOL *This,
  IN BOOLEAN                     Reset,
  IN EFI_MAC_ADDRESS             *New OPTIONAL
  );

Parameters

Parameter Description
This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.
Reset Flag used to reset the station address to the network interface’s permanent address.
New New station address to be used for the network interface.

Description
This function modifies or resets the current station address of a network interface, if supported. If Reset is TRUE, then the current station address is set to the network interface’s permanent address. If Reset is FALSE, and the network interface allows its station address to be modified, then the current station address is changed to the address specified by New. If the network interface does not allow its station address to be modified, then EFI_INVALID_PARAMETER will be returned. If the station address is successfully updated on the network interface, EFI_SUCCESS will be returned. If the driver has not been initialized, EFI_DEVICE_ERROR will be returned.

Status Codes Returned

Status Code Description
EFI_SUCCESS The network interface’s station address was updated.
EFI_NOT_STARTED The Simple Network Protocol interface has not been started by calling Start().
EFI_INVALID_PARAMETER The New station address was not accepted by the NIC.
EFI_INVALID_PARAMETER Reset is FALSE and New is NULL.
EFI_DEVICE_ERROR The Simple Network Protocol interface has not been initialized by calling Initialize().
EFI_DEVICE_ERROR An error occurred attempting to set the new station address.
EFI_UNSUPPORTED The NIC does not support changing the network interface’s station address.

Statistics()

Resets or collects the statistics on a network interface.

Prototype

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

Parameters

Parameter Description
This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.
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.

Description
This function resets or collects the statistics on a network interface. If the size of the statistics table specified by StatisticsSize is not big enough for all the statistics that are collected by the network interface, then a partial buffer of statistics is returned in StatisticsTable, StatisticsSize is set to the size required to collect all the available statistics, and EFI_BUFFER_TOO_SMALL is returned.

If StatisticsSize is big enough for all the statistics, then StatisticsTable will be filled, StatisticsSize will be set to the size of the returned StatisticsTable structure, and EFI_SUCCESS is returned. If the driver has not been initialized, EFI_DEVICE_ERROR will be returned.

If Reset is FALSE, and both StatisticsSize and StatisticsTable are NULL, then no operations will be performed, and EFI_SUCCESS will be returned.

If Reset is TRUE, then all of the supported statistics counters on this network interface will be reset to zero.

Status Codes Returned

Status Code Description
EFI_SUCCESS The requested operation succeeded.
EFI_NOT_STARTED The Simple Network Protocol interface has not been started by calling Start().
EFI_BUFFER_TOO_SMALL StatisticsSize is not NULL and StatisticsTable is NULL. The current buffer size that is needed to hold all the statistics is returned in StatisticsSize.
EFI_BUFFER_TOO_SMALL StatisticsSize is not NULL and StatisticsTable is not NULL. The current buffer size that is needed to hold all the statistics is returned in StatisticsSize. A partial set of statistics is returned in StatisticsTable.
EFI_INVALID_PARAMETER StatisticsSize is NULL and StatisticsTable is not NULL.
EFI_DEVICE_ERROR The Simple Network Protocol interface has not been initialized by calling Initialize().
EFI_DEVICE_ERROR An error was encountered collecting statistics from the NIC.
EFI_UNSUPPORTED The NIC does not support collecting statistics from the network interface.

MCastIPtoMAC()

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

Prototype

typedef
EFI_STATUS
(EFIAPI *EFI_SIMPLE_NETWORK_MCAST_IP_TO_MAC) (
  IN  EFI_SIMPLE_NETWORK_PROTOCOL *This,
  IN  BOOLEAN                     IPv6,
  IN  EFI_IP_ADDRESS              *IP,
  OUT EFI_MAC_ADDRESS             *MAC
  );

Parameters

Parameter Description
This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.
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.

Description
This function converts a multicast IP address to a multicast HW MAC address for all packet transactions. If the mapping is accepted, then EFI_SUCCESS will be returned.

Status Codes Returned

Status Code Description
EFI_SUCCESS The multicast IP address was mapped to the multicast HW MAC address.
EFI_NOT_STARTED The Simple Network Protocol interface has not been started by calling Start().
EFI_INVALID_PARAMETER IP is NULL.
EFI_INVALID_PARAMETER MAC is NULL.
EFI_INVALID_PARAMETER IP does not point to a valid IPv4 or IPv6 multicast address.
EFI_DEVICE_ERROR The Simple Network Protocol interface has not been initialized by calling Initialize().
EFI_UNSUPPORTED IPv6 is TRUE and the implementation does not support IPv6 multicast to MAC address conversion.

NvData()

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

'Prototype'

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

Parameters

Parameter Description
This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.
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. (See EFI_SIMPLE_NETWORK_MODE)
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.

Description
This function performs read and write operations on the NVRAM device attached to a network interface. If ReadWrite is TRUE, a read operation is performed. If ReadWrite is FALSE, a write operation is performed.

Offset specifies the byte offset at which to start either operation. Offset must be a multiple of NvRamAccessSize , and it must have a value between zero and NvRamSize.

BufferSize specifies the length of the read or write operation. BufferSize must also be a multiple of NvRamAccessSize, and Offset + BufferSize must not exceed NvRamSize.

If any of the above conditions is not met, then EFI_INVALID_PARAMETER will be returned.

If all the conditions are met and the operation is “read,” the NVRAM device attached to the network interface will be read into Buffer and EFI_SUCCESS will be returned. If this is a write operation, the contents of Buffer will be used to update the contents of the NVRAM device attached to the network interface and EFI_SUCCESS will be returned.

Status Codes Returned

Parameter Description
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 following conditions is TRUE:
  • The This parameter is NULL
  • The This parameter does not point to a valid EFI_SIMPLE_NETWORK_PROTOCOL structure
  • The Offset parameter is not a multiple of EFI_SIMPLE_NETWORK_MODE.NvRamAccessSize
  • The Offset parameter is not less than EFI_SIMPLE_NETWORK_MODE.NvRamSize
  • The BufferSize parameter is not a multiple of EFI_SIMPLE_NETWORK_MODE.NvRamAccessSize
  • The Buffer parameter is NULL
EFI_DEVICE_ERROR The command could not be sent to the network interface.
EFI_UNSUPPORTED This function is not supported by the network interface.

GetStatus()

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

Prototype

typedef
EFI_STATUS
(EFIAPI *EFI_SIMPLE_NETWORK_GET_STATUS) (
  IN  EFI_SIMPLE_NETWORK_PROTOCOL *This,
  OUT UINT32                      *InterruptStatus OPTIONAL,
  OUT VOID                        **TxBuf OPTIONAL
  );

Parameters

Parameter Description
This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.
InterruptStatus A pointer to the bit mask of the currently active interrupts (see “Related Definitions”). 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.

Related Definitions

#define EFI_SIMPLE_NETWORK_RECEIVE_INTERRUPT  0x01
#define EFI_SIMPLE_NETWORK_TRANSMIT_INTERRUPT 0x02
#define EFI_SIMPLE_NETWORK_COMMAND_INTERRUPT  0x04
#define EFI_SIMPLE_NETWORK_SOFTWARE_INTERRUPT 0x08

Description
This function gets the current interrupt and recycled transmit buffer status from the network interface. The interrupt status is returned as a bit mask in InterruptStatus. If InterruptStatus is NULL, the interrupt status will not be read. If TxBuf is not NULL, a recycled transmit buffer address will be retrieved. If a recycled transmit buffer address is returned in TxBuf, then the buffer has been successfully transmitted, and the status for that buffer is cleared. If the status of the network interface is successfully collected, EFI_SUCCESS will be returned. If the driver has not been initialized, EFI_DEVICE_ERROR will be returned.

Status Codes Returned

Status Code Description
EFI_SUCCESS The status of the network interface was retrieved.
EFI_NOT_STARTED The network interface has not been started.
EFI_INVALID_PARAMETER This parameter was NULL or did not point to a valid EFI_SIMPLE_NETWORK_PROTOCOL structure.
EFI_DEVICE_ERROR The command could not be sent to the network interface.

Transmit()

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

Prototype

typedef
EFI_STATUS
(EFIAPI *EFI_SIMPLE_NETWORK_TRANSMIT) (
  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,
  );

Parameters

Parameter Description
This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. HeaderSize The size, in bytes, of the media header to be filled in by the Transmit() function. If HeaderSize is nonzero, 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 nonzero, 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 nonzero 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.

Description
This function places the packet specified by Header and Buffer on the transmit queue. If HeaderSize is nonzero and HeaderSize is not equal to This->Mode->MediaHeaderSize, then EFI_INVALID_PARAMETER will be returned. If BufferSize is less than This->Mode->MediaHeaderSize, then EFI_BUFFER_TOO_SMALL will be returned. If Buffer is NULL, then EFI_INVALID_PARAMETER will be returned. If HeaderSize is nonzero and DestAddr or Protocol is NULL, then EFI_INVALID_PARAMETER will be returned. If the transmit engine of the network interface is busy, then EFI_NOT_READY will be returned. If this packet can be accepted by the transmit engine of the network interface, the packet contents specified by Buffer will be placed on the transmit queue of the network interface, and EFI_SUCCESS will be returned. GetStatus() can be used to determine when the packet has actually been transmitted. The contents of the Buffer must not be modified until the packet has actually been transmitted.

The Transmit() function performs nonblocking I/O. A caller who wants to perform blocking I/O, should call Transmit(), and then GetStatus() until the transmitted buffer shows up in the recycled transmit buffer.

If the driver has not been initialized, EFI_DEVICE_ERROR will be returned.

Status Codes Returned

Status Code Description
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.

Receive()

Receives a packet from a network interface.

Prototype

typedef
EFI_STATUS
(EFIAPI *EFI_SIMPLE_NETWORK_RECEIVE) (
  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
  );

Parameters

Parameter Description
This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.
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.

Description
This function retrieves one packet from the receive queue of a network interface. If there are no packets on the receive queue, then EFI_NOT_READY will be returned. If there is a packet on the receive queue, and the size of the packet is smaller than BufferSize, then the contents of the packet will be placed in Buffer, and BufferSize will be updated with the actual size of the packet. In addition, if SrcAddr, DestAddr, and Protocol are not NULL, then these values will be extracted from the media header and returned. EFI_SUCCESS will be returned if a packet was successfully received. If BufferSize is smaller than the received packet, then the size of the receive packet will be placed in BufferSize and EFI_BUFFER_TOO_SMALL will be returned. If the driver has not been initialized, EFI_DEVICE_ERROR will be returned.

Status Codes Returned

Status Code Description
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 No packets have been received on the network interface.
EFI_BUFFER_TOO_SMALL BufferSize is too small for the received packets. BufferSize has been updated to the required size.
EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
  • The This parameter is NULL
  • The This parameter does not point to a valid EFI_SIMPLE_NETWORK_PROTOCOL structure.
  • The BufferSize parameter is NULL
  • The Buffer parameter is NULL
EFI_DEVICE_ERROR The command could not be sent to the network interface.

Copyright (C) 2008 Phoenix Technologies Ltd. All Rights Reserved. Portions copyright (C) 2008 UEFI Forum, Inc. Used with permission

Personal tools