EmuSnp.h

Go to the documentation of this file.

 
#ifndef __EMU_SNP_H__
#define __EMU_SNP_H__
 
#include <Protocol/SimpleNetwork.h>
 
#define EMU_SNP_PROTOCOL_GUID \
 { 0xFD5FBE54, 0x8C35, 0xB345, { 0x8A, 0x0F, 0x7A, 0xC8, 0xA5, 0xFD, 0x05, 0x21 } }
 
typedef struct _EMU_SNP_PROTOCOL EMU_SNP_PROTOCOL;
 
typedef
EFI_STATUS
(EFIAPI *EMU_SNP_CREATE_MAPPING)(
  IN EMU_SNP_PROTOCOL         *This,
  IN EFI_SIMPLE_NETWORK_MODE  *Mode
  );
 
typedef
EFI_STATUS
(EFIAPI *EMU_SNP_START)(
  IN EMU_SNP_PROTOCOL  *This
  );
 
typedef
EFI_STATUS
(EFIAPI *EMU_SNP_STOP)(
  IN EMU_SNP_PROTOCOL  *This
  );
 
typedef
EFI_STATUS
(EFIAPI *EMU_SNP_INITIALIZE)(
  IN EMU_SNP_PROTOCOL                    *This,
  IN UINTN                               ExtraRxBufferSize  OPTIONAL,
  IN UINTN                               ExtraTxBufferSize  OPTIONAL
  );
 
typedef
EFI_STATUS
(EFIAPI *EMU_SNP_RESET)(
  IN EMU_SNP_PROTOCOL   *This,
  IN BOOLEAN            ExtendedVerification
  );
 
typedef
EFI_STATUS
(EFIAPI *EMU_SNP_SHUTDOWN)(
  IN EMU_SNP_PROTOCOL  *This
  );
 
typedef
EFI_STATUS
(EFIAPI *EMU_SNP_RECEIVE_FILTERS)(
  IN EMU_SNP_PROTOCOL                             *This,
  IN UINT32                                       Enable,
  IN UINT32                                       Disable,
  IN BOOLEAN                                      ResetMCastFilter,
  IN UINTN                                        MCastFilterCnt     OPTIONAL,
  IN EFI_MAC_ADDRESS                              *MCastFilter OPTIONAL
  );
 
typedef
EFI_STATUS
(EFIAPI *EMU_SNP_STATION_ADDRESS)(
  IN EMU_SNP_PROTOCOL            *This,
  IN BOOLEAN                     Reset,
  IN EFI_MAC_ADDRESS             *New OPTIONAL
  );
 
typedef
EFI_STATUS
(EFIAPI *EMU_SNP_STATISTICS)(
  IN EMU_SNP_PROTOCOL                     *This,
  IN BOOLEAN                              Reset,
  IN OUT UINTN                            *StatisticsSize   OPTIONAL,
  OUT EFI_NETWORK_STATISTICS              *StatisticsTable  OPTIONAL
  );
 
typedef
EFI_STATUS
(EFIAPI *EMU_SNP_MCAST_IP_TO_MAC)(
  IN EMU_SNP_PROTOCOL                     *This,
  IN BOOLEAN                              IPv6,
  IN EFI_IP_ADDRESS                       *IP,
  OUT EFI_MAC_ADDRESS                     *MAC
  );
 
typedef
EFI_STATUS
(EFIAPI *EMU_SNP_NVDATA)(
  IN EMU_SNP_PROTOCOL                     *This,
  IN BOOLEAN                              ReadWrite,
  IN UINTN                                Offset,
  IN UINTN                                BufferSize,
  IN OUT VOID                             *Buffer
  );
 
typedef
EFI_STATUS
(EFIAPI *EMU_SNP_GET_STATUS)(
  IN EMU_SNP_PROTOCOL                     *This,
  OUT UINT32                              *InterruptStatus OPTIONAL,
  OUT VOID                                **TxBuf OPTIONAL
  );
 
typedef
EFI_STATUS
(EFIAPI *EMU_SNP_TRANSMIT)(
  IN EMU_SNP_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
  );
 
typedef
EFI_STATUS
(EFIAPI *EMU_SNP_RECEIVE)(
  IN EMU_SNP_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
  );
 
#define EMU_SNP_PROTOCOL_REVISION  0x00010000
 
//
// Revision defined in EFI1.1
//
#define EMU_SNP_INTERFACE_REVISION  EMU_SNP_PROTOCOL_REVISION
 
struct _EMU_SNP_PROTOCOL {
  EMU_SNP_CREATE_MAPPING     CreateMapping;
  EMU_SNP_START              Start;
  EMU_SNP_STOP               Stop;
  EMU_SNP_INITIALIZE         Initialize;
  EMU_SNP_RESET              Reset;
  EMU_SNP_SHUTDOWN           Shutdown;
  EMU_SNP_RECEIVE_FILTERS    ReceiveFilters;
  EMU_SNP_STATION_ADDRESS    StationAddress;
  EMU_SNP_STATISTICS         Statistics;
  EMU_SNP_MCAST_IP_TO_MAC    MCastIpToMac;
  EMU_SNP_NVDATA             NvData;
  EMU_SNP_GET_STATUS         GetStatus;
  EMU_SNP_TRANSMIT           Transmit;
  EMU_SNP_RECEIVE            Receive;
};
 
extern EFI_GUID  gEmuSnpProtocolGuid;
 
#endif