MdePkg/Include/Protocol/SimpleNetwork.h File Reference


Data Structures

struct  EFI_NETWORK_STATISTICS
struct  EFI_SIMPLE_NETWORK_MODE
struct  _EFI_SIMPLE_NETWORK_PROTOCOL

Defines

#define EFI_SIMPLE_NETWORK_PROTOCOL_GUID
#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
#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
#define MAX_MCAST_FILTER_CNT   16
#define EFI_SIMPLE_NETWORK_PROTOCOL_REVISION   0x00010000
#define EFI_SIMPLE_NETWORK_INTERFACE_REVISION   EFI_SIMPLE_NETWORK_PROTOCOL_REVISION

Typedefs

typedef struct
_EFI_SIMPLE_NETWORK_PROTOCOL 
EFI_SIMPLE_NETWORK_PROTOCOL
typedef EFI_SIMPLE_NETWORK_PROTOCOL EFI_SIMPLE_NETWORK
typedef EFI_STATUS(EFIAPI * EFI_SIMPLE_NETWORK_START )(IN EFI_SIMPLE_NETWORK_PROTOCOL *This)
typedef EFI_STATUS(EFIAPI * EFI_SIMPLE_NETWORK_STOP )(IN EFI_SIMPLE_NETWORK_PROTOCOL *This)
typedef EFI_STATUS(EFIAPI * EFI_SIMPLE_NETWORK_INITIALIZE )(IN EFI_SIMPLE_NETWORK_PROTOCOL *This, IN UINTN ExtraRxBufferSize, IN UINTN ExtraTxBufferSize)
typedef EFI_STATUS(EFIAPI * EFI_SIMPLE_NETWORK_RESET )(IN EFI_SIMPLE_NETWORK_PROTOCOL *This, IN BOOLEAN ExtendedVerification)
typedef EFI_STATUS(EFIAPI * EFI_SIMPLE_NETWORK_SHUTDOWN )(IN EFI_SIMPLE_NETWORK_PROTOCOL *This)
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, IN EFI_MAC_ADDRESS *MCastFilter)
typedef EFI_STATUS(EFIAPI * EFI_SIMPLE_NETWORK_STATION_ADDRESS )(IN EFI_SIMPLE_NETWORK_PROTOCOL *This, IN BOOLEAN Reset, IN EFI_MAC_ADDRESS *New)
typedef EFI_STATUS(EFIAPI * EFI_SIMPLE_NETWORK_STATISTICS )(IN EFI_SIMPLE_NETWORK_PROTOCOL *This, IN BOOLEAN Reset, IN OUT UINTN *StatisticsSize, OUT EFI_NETWORK_STATISTICS *StatisticsTable)
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)
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)
typedef EFI_STATUS(EFIAPI * EFI_SIMPLE_NETWORK_GET_STATUS )(IN EFI_SIMPLE_NETWORK_PROTOCOL *This, OUT UINT32 *InterruptStatus, OUT VOID **TxBuf)
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, IN EFI_MAC_ADDRESS *DestAddr, IN UINT16 *Protocol)
typedef EFI_STATUS(EFIAPI * EFI_SIMPLE_NETWORK_RECEIVE )(IN EFI_SIMPLE_NETWORK_PROTOCOL *This, OUT UINTN *HeaderSize, IN OUT UINTN *BufferSize, OUT VOID *Buffer, OUT EFI_MAC_ADDRESS *SrcAddr, OUT EFI_MAC_ADDRESS *DestAddr, OUT UINT16 *Protocol)

Enumerations

enum  EFI_SIMPLE_NETWORK_STATE { EfiSimpleNetworkStopped, EfiSimpleNetworkStarted, EfiSimpleNetworkInitialized, EfiSimpleNetworkMaxState }

Variables

EFI_GUID gEfiSimpleNetworkProtocolGuid

Detailed Description

The EFI_SIMPLE_NETWORK_PROTOCOL provides services to initialize a network interface, transmit packets, receive packets, and close a network interface.

Basic network device abstraction.

Rx - Received Tx - Transmit MCast - MultiCast ...

Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Revision Reference:
This Protocol is introduced in EFI Specification 1.10.

Define Documentation

#define EFI_SIMPLE_NETWORK_COMMAND_INTERRUPT   0x04

#define EFI_SIMPLE_NETWORK_INTERFACE_REVISION   EFI_SIMPLE_NETWORK_PROTOCOL_REVISION

#define EFI_SIMPLE_NETWORK_PROTOCOL_GUID

Value:

{ \
    0xA19832B9, 0xAC25, 0x11D3, {0x9A, 0x2D, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D } \
  }

#define EFI_SIMPLE_NETWORK_PROTOCOL_REVISION   0x00010000

#define EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST   0x04

#define EFI_SIMPLE_NETWORK_RECEIVE_INTERRUPT   0x01

#define EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST   0x02

#define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS   0x08

#define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST   0x10

#define EFI_SIMPLE_NETWORK_RECEIVE_UNICAST   0x01

#define EFI_SIMPLE_NETWORK_SOFTWARE_INTERRUPT   0x08

#define EFI_SIMPLE_NETWORK_TRANSMIT_INTERRUPT   0x02

#define MAX_MCAST_FILTER_CNT   16


Typedef Documentation

Protocol defined in EFI1.1.

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

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.

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

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.

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)

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.

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)

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.

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

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.

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, IN EFI_MAC_ADDRESS *MCastFilter)

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.

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.

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.

typedef EFI_STATUS(EFIAPI * EFI_SIMPLE_NETWORK_START)(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.

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

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.

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

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.

typedef EFI_STATUS(EFIAPI * EFI_SIMPLE_NETWORK_STOP)(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.

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, IN EFI_MAC_ADDRESS *DestAddr, IN UINT16 *Protocol)

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.


Enumeration Type Documentation

The state of the network interface. When an EFI_SIMPLE_NETWORK_PROTOCOL driver initializes a network interface, the network interface is left in the EfiSimpleNetworkStopped state.

Enumerator:
EfiSimpleNetworkStopped 
EfiSimpleNetworkStarted 
EfiSimpleNetworkInitialized 
EfiSimpleNetworkMaxState 


Variable Documentation


Generated on Wed Sep 23 16:24:23 2015 for MdePkg[ALL] by  doxygen 1.5.7.1