[mirror_edk2.git] / OvmfPkg / VirtioNetDxe / VirtioNet.h

/** @file\r
\r
  Internal definitions for the virtio-net driver, which produces Simple Network\r
  Protocol instances for virtio-net devices.\r
\r
  Copyright (C) 2013, Red Hat, Inc.\r
  Copyright (c) 2017, AMD Inc, All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
**/\r
\r
#ifndef _VIRTIO_NET_DXE_H_\r
#define _VIRTIO_NET_DXE_H_\r
\r
#include <IndustryStandard/VirtioNet.h>\r
#include <Library/DebugLib.h>\r
#include <Library/VirtioLib.h>\r
#include <Protocol/ComponentName.h>\r
#include <Protocol/ComponentName2.h>\r
#include <Protocol/DevicePath.h>\r
#include <Protocol/DriverBinding.h>\r
#include <Protocol/SimpleNetwork.h>\r
#include <Library/OrderedCollectionLib.h>\r
\r
#define VNET_SIG  SIGNATURE_32 ('V', 'N', 'E', 'T')\r
\r
//\r
// maximum number of pending packets, separately for each direction\r
//\r
#define VNET_MAX_PENDING  64\r
\r
//\r
// State diagram:\r
//\r
//                  |     ^\r
//                  |     |\r
//        BindingStart  BindingStop\r
//        +SnpPopulate    |\r
//        ++GetFeatures   |\r
//                  |     |\r
//                  v     |\r
//                +---------+    virtio-net device is reset, no resources are\r
//                | stopped |    allocated for traffic, but MAC address has\r
//                +---------+    been retrieved\r
//                  |     ^\r
//                  |     |\r
//            SNP.Start SNP.Stop\r
//                  |     |\r
//                  v     |\r
//                +---------+\r
//                | started |    functionally identical to stopped\r
//                +---------+\r
//                  |     ^\r
//                  |     |\r
//       SNP.Initialize SNP.Shutdown\r
//                  |     |\r
//                  v     |\r
//              +-------------+  Virtio-net setup complete, including DRIVER_OK\r
//              | initialized |  bit. The receive queue is populated with\r
//              +-------------+  requests; McastIpToMac, GetStatus, Transmit,\r
//                               Receive are callable.\r
//\r
\r
typedef struct {\r
  //\r
  // Parts of this structure are initialized / torn down in various functions\r
  // at various call depths. The table to the right should make it easier to\r
  // track them.\r
  //\r
  //                          field              init function\r
  //                          ------------------ ------------------------------\r
  UINT32                         Signature;      // VirtioNetDriverBindingStart\r
  VIRTIO_DEVICE_PROTOCOL         *VirtIo;        // VirtioNetDriverBindingStart\r
  EFI_SIMPLE_NETWORK_PROTOCOL    Snp;            // VirtioNetSnpPopulate\r
  EFI_SIMPLE_NETWORK_MODE        Snm;            // VirtioNetSnpPopulate\r
  EFI_EVENT                      ExitBoot;       // VirtioNetSnpPopulate\r
  EFI_DEVICE_PATH_PROTOCOL       *MacDevicePath; // VirtioNetDriverBindingStart\r
  EFI_HANDLE                     MacHandle;      // VirtioNetDriverBindingStart\r
\r
  VRING                          RxRing;          // VirtioNetInitRing\r
  VOID                           *RxRingMap;      // VirtioRingMap and\r
                                                  // VirtioNetInitRing\r
  UINT8                          *RxBuf;          // VirtioNetInitRx\r
  UINT16                         RxLastUsed;      // VirtioNetInitRx\r
  UINTN                          RxBufNrPages;    // VirtioNetInitRx\r
  EFI_PHYSICAL_ADDRESS           RxBufDeviceBase; // VirtioNetInitRx\r
  VOID                           *RxBufMap;       // VirtioNetInitRx\r
\r
  VRING                          TxRing;           // VirtioNetInitRing\r
  VOID                           *TxRingMap;       // VirtioRingMap and\r
                                                   // VirtioNetInitRing\r
  UINT16                         TxMaxPending;     // VirtioNetInitTx\r
  UINT16                         TxCurPending;     // VirtioNetInitTx\r
  UINT16                         *TxFreeStack;     // VirtioNetInitTx\r
  VIRTIO_1_0_NET_REQ             *TxSharedReq;     // VirtioNetInitTx\r
  VOID                           *TxSharedReqMap;  // VirtioNetInitTx\r
  UINT16                         TxLastUsed;       // VirtioNetInitTx\r
  ORDERED_COLLECTION             *TxBufCollection; // VirtioNetInitTx\r
} VNET_DEV;\r
\r
//\r
// In order to avoid duplication of interface documentation, please find all\r
// leading comments near the respective function / variable definitions (not\r
// the declarations here), which is where your code editor of choice takes you\r
// anyway when jumping to a function.\r
//\r
\r
//\r
// utility macros\r
//\r
#define VIRTIO_NET_FROM_SNP(SnpPointer) \\r
        CR (SnpPointer, VNET_DEV, Snp, VNET_SIG)\r
\r
#define VIRTIO_CFG_WRITE(Dev, Field, Value)  ((Dev)->VirtIo->WriteDevice (  \\r
                                                (Dev)->VirtIo,              \\r
                                                OFFSET_OF_VNET (Field),     \\r
                                                SIZE_OF_VNET (Field),       \\r
                                                (Value)                     \\r
                                                ))\r
\r
#define VIRTIO_CFG_READ(Dev, Field, Pointer)  ((Dev)->VirtIo->ReadDevice (  \\r
                                                (Dev)->VirtIo,              \\r
                                                OFFSET_OF_VNET (Field),     \\r
                                                SIZE_OF_VNET (Field),       \\r
                                                sizeof *(Pointer),          \\r
                                                (Pointer)                   \\r
                                                ))\r
\r
//\r
// component naming\r
//\r
extern EFI_COMPONENT_NAME_PROTOCOL   gVirtioNetComponentName;\r
extern EFI_COMPONENT_NAME2_PROTOCOL  gVirtioNetComponentName2;\r
\r
//\r
// driver binding\r
//\r
extern EFI_DRIVER_BINDING_PROTOCOL  gVirtioNetDriverBinding;\r
\r
//\r
// member functions implementing the Simple Network Protocol\r
//\r
EFI_STATUS\r
EFIAPI\r
VirtioNetStart (\r
  IN EFI_SIMPLE_NETWORK_PROTOCOL  *This\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioNetStop (\r
  IN EFI_SIMPLE_NETWORK_PROTOCOL  *This\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioNetInitialize (\r
  IN EFI_SIMPLE_NETWORK_PROTOCOL  *This,\r
  IN UINTN                        ExtraRxBufferSize  OPTIONAL,\r
  IN UINTN                        ExtraTxBufferSize  OPTIONAL\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioNetReset (\r
  IN EFI_SIMPLE_NETWORK_PROTOCOL  *This,\r
  IN BOOLEAN                      ExtendedVerification\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioNetShutdown (\r
  IN EFI_SIMPLE_NETWORK_PROTOCOL  *This\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioNetReceiveFilters (\r
  IN EFI_SIMPLE_NETWORK_PROTOCOL  *This,\r
  IN UINT32                       Enable,\r
  IN UINT32                       Disable,\r
  IN BOOLEAN                      ResetMCastFilter,\r
  IN UINTN                        MCastFilterCnt    OPTIONAL,\r
  IN EFI_MAC_ADDRESS              *MCastFilter      OPTIONAL\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioNetStationAddress (\r
  IN EFI_SIMPLE_NETWORK_PROTOCOL  *This,\r
  IN BOOLEAN                      Reset,\r
  IN EFI_MAC_ADDRESS              *New OPTIONAL\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioNetStatistics (\r
  IN EFI_SIMPLE_NETWORK_PROTOCOL  *This,\r
  IN BOOLEAN                      Reset,\r
  IN OUT UINTN                    *StatisticsSize   OPTIONAL,\r
  OUT EFI_NETWORK_STATISTICS      *StatisticsTable  OPTIONAL\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioNetMcastIpToMac (\r
  IN EFI_SIMPLE_NETWORK_PROTOCOL  *This,\r
  IN BOOLEAN                      IPv6,\r
  IN EFI_IP_ADDRESS               *Ip,\r
  OUT EFI_MAC_ADDRESS             *Mac\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioNetNvData (\r
  IN EFI_SIMPLE_NETWORK_PROTOCOL  *This,\r
  IN BOOLEAN                      ReadWrite,\r
  IN UINTN                        Offset,\r
  IN UINTN                        BufferSize,\r
  IN OUT VOID                     *Buffer\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioNetGetStatus (\r
  IN EFI_SIMPLE_NETWORK_PROTOCOL  *This,\r
  OUT UINT32                      *InterruptStatus OPTIONAL,\r
  OUT VOID                        **TxBuf OPTIONAL\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioNetTransmit (\r
  IN EFI_SIMPLE_NETWORK_PROTOCOL  *This,\r
  IN UINTN                        HeaderSize,\r
  IN UINTN                        BufferSize,\r
  IN /* +OUT! */ VOID             *Buffer,\r
  IN EFI_MAC_ADDRESS              *SrcAddr  OPTIONAL,\r
  IN EFI_MAC_ADDRESS              *DestAddr OPTIONAL,\r
  IN UINT16                       *Protocol OPTIONAL\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioNetReceive (\r
  IN EFI_SIMPLE_NETWORK_PROTOCOL  *This,\r
  OUT UINTN                       *HeaderSize OPTIONAL,\r
  IN OUT UINTN                    *BufferSize,\r
  OUT VOID                        *Buffer,\r
  OUT EFI_MAC_ADDRESS             *SrcAddr    OPTIONAL,\r
  OUT EFI_MAC_ADDRESS             *DestAddr   OPTIONAL,\r
  OUT UINT16                      *Protocol   OPTIONAL\r
  );\r
\r
//\r
// utility functions shared by various SNP member functions\r
//\r
VOID\r
EFIAPI\r
VirtioNetShutdownRx (\r
  IN OUT VNET_DEV  *Dev\r
  );\r
\r
VOID\r
EFIAPI\r
VirtioNetShutdownTx (\r
  IN OUT VNET_DEV  *Dev\r
  );\r
\r
VOID\r
EFIAPI\r
VirtioNetUninitRing (\r
  IN OUT VNET_DEV  *Dev,\r
  IN OUT VRING     *Ring,\r
  IN     VOID      *RingMap\r
  );\r
\r
//\r
// utility functions to map caller-supplied Tx buffer system physical address\r
// to a device address and vice versa\r
//\r
EFI_STATUS\r
EFIAPI\r
VirtioNetMapTxBuf (\r
  IN  VNET_DEV              *Dev,\r
  IN  VOID                  *Buffer,\r
  IN  UINTN                 NumberOfBytes,\r
  OUT EFI_PHYSICAL_ADDRESS  *DeviceAddress\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioNetUnmapTxBuf (\r
  IN  VNET_DEV              *Dev,\r
  OUT VOID                  **Buffer,\r
  IN  EFI_PHYSICAL_ADDRESS  DeviceAddress\r
  );\r
\r
INTN\r
EFIAPI\r
VirtioNetTxBufMapInfoCompare (\r
  IN CONST VOID  *UserStruct1,\r
  IN CONST VOID  *UserStruct2\r
  );\r
\r
INTN\r
EFIAPI\r
VirtioNetTxBufDeviceAddressCompare (\r
  IN CONST VOID  *StandaloneKey,\r
  IN CONST VOID  *UserStruct\r
  );\r
\r
//\r
// event callbacks\r
//\r
VOID\r
EFIAPI\r
VirtioNetIsPacketAvailable (\r
  IN  EFI_EVENT  Event,\r
  IN  VOID       *Context\r
  );\r
\r
VOID\r
EFIAPI\r
VirtioNetExitBoot (\r
  IN  EFI_EVENT  Event,\r
  IN  VOID       *Context\r
  );\r
\r
#endif // _VIRTIO_NET_DXE_H_\r
Commit	Line	Data
201cac0d LE	1	/** @file\r
	2	\r
	3	Internal definitions for the virtio-net driver, which produces Simple Network\r
	4	Protocol instances for virtio-net devices.\r
	5	\r
	6	Copyright (C) 2013, Red Hat, Inc.\r
46b11f00	7	Copyright (c) 2017, AMD Inc, All rights reserved.<BR>\r
201cac0d	8	\r
b26f0cf9	9	SPDX-License-Identifier: BSD-2-Clause-Patent\r
201cac0d LE	10	**/\r
	11	\r
	12	#ifndef _VIRTIO_NET_DXE_H_\r
	13	#define _VIRTIO_NET_DXE_H_\r
	14	\r
	15	#include <IndustryStandard/VirtioNet.h>\r
	16	#include <Library/DebugLib.h>\r
	17	#include <Library/VirtioLib.h>\r
	18	#include <Protocol/ComponentName.h>\r
	19	#include <Protocol/ComponentName2.h>\r
	20	#include <Protocol/DevicePath.h>\r
	21	#include <Protocol/DriverBinding.h>\r
201cac0d	22	#include <Protocol/SimpleNetwork.h>\r
bd114d9f	23	#include <Library/OrderedCollectionLib.h>\r
201cac0d	24	\r
ac0a286f	25	#define VNET_SIG SIGNATURE_32 ('V', 'N', 'E', 'T')\r
201cac0d LE	26	\r
	27	//\r
	28	// maximum number of pending packets, separately for each direction\r
	29	//\r
ac0a286f	30	#define VNET_MAX_PENDING 64\r
201cac0d LE	31	\r
	32	//\r
	33	// State diagram:\r
	34	//\r
	35	// \| ^\r
	36	// \| \|\r
	37	// BindingStart BindingStop\r
	38	// +SnpPopulate \|\r
	39	// ++GetFeatures \|\r
	40	// \| \|\r
	41	// v \|\r
	42	// +---------+ virtio-net device is reset, no resources are\r
	43	// \| stopped \| allocated for traffic, but MAC address has\r
	44	// +---------+ been retrieved\r
	45	// \| ^\r
	46	// \| \|\r
	47	// SNP.Start SNP.Stop\r
	48	// \| \|\r
	49	// v \|\r
	50	// +---------+\r
	51	// \| started \| functionally identical to stopped\r
	52	// +---------+\r
	53	// \| ^\r
	54	// \| \|\r
	55	// SNP.Initialize SNP.Shutdown\r
	56	// \| \|\r
	57	// v \|\r
	58	// +-------------+ Virtio-net setup complete, including DRIVER_OK\r
	59	// \| initialized \| bit. The receive queue is populated with\r
	60	// +-------------+ requests; McastIpToMac, GetStatus, Transmit,\r
	61	// Receive are callable.\r
	62	//\r
	63	\r
	64	typedef struct {\r
	65	//\r
	66	// Parts of this structure are initialized / torn down in various functions\r
	67	// at various call depths. The table to the right should make it easier to\r
	68	// track them.\r
	69	//\r
	70	// field init function\r
	71	// ------------------ ------------------------------\r
ac0a286f MK	72	UINT32 Signature; // VirtioNetDriverBindingStart\r
	73	VIRTIO_DEVICE_PROTOCOL *VirtIo; // VirtioNetDriverBindingStart\r
	74	EFI_SIMPLE_NETWORK_PROTOCOL Snp; // VirtioNetSnpPopulate\r
	75	EFI_SIMPLE_NETWORK_MODE Snm; // VirtioNetSnpPopulate\r
	76	EFI_EVENT ExitBoot; // VirtioNetSnpPopulate\r
	77	EFI_DEVICE_PATH_PROTOCOL *MacDevicePath; // VirtioNetDriverBindingStart\r
	78	EFI_HANDLE MacHandle; // VirtioNetDriverBindingStart\r
	79	\r
	80	VRING RxRing; // VirtioNetInitRing\r
	81	VOID *RxRingMap; // VirtioRingMap and\r
	82	// VirtioNetInitRing\r
	83	UINT8 *RxBuf; // VirtioNetInitRx\r
	84	UINT16 RxLastUsed; // VirtioNetInitRx\r
	85	UINTN RxBufNrPages; // VirtioNetInitRx\r
	86	EFI_PHYSICAL_ADDRESS RxBufDeviceBase; // VirtioNetInitRx\r
	87	VOID *RxBufMap; // VirtioNetInitRx\r
	88	\r
	89	VRING TxRing; // VirtioNetInitRing\r
	90	VOID *TxRingMap; // VirtioRingMap and\r
	91	// VirtioNetInitRing\r
	92	UINT16 TxMaxPending; // VirtioNetInitTx\r
	93	UINT16 TxCurPending; // VirtioNetInitTx\r
	94	UINT16 *TxFreeStack; // VirtioNetInitTx\r
	95	VIRTIO_1_0_NET_REQ *TxSharedReq; // VirtioNetInitTx\r
	96	VOID *TxSharedReqMap; // VirtioNetInitTx\r
	97	UINT16 TxLastUsed; // VirtioNetInitTx\r
	98	ORDERED_COLLECTION *TxBufCollection; // VirtioNetInitTx\r
201cac0d LE	99	} VNET_DEV;\r
201cac0d LE	100	\r
201cac0d LE	101	//\r
	102	// In order to avoid duplication of interface documentation, please find all\r
	103	// leading comments near the respective function / variable definitions (not\r
	104	// the declarations here), which is where your code editor of choice takes you\r
	105	// anyway when jumping to a function.\r
	106	//\r
	107	\r
	108	//\r
	109	// utility macros\r
	110	//\r
	111	#define VIRTIO_NET_FROM_SNP(SnpPointer) \\r
	112	CR (SnpPointer, VNET_DEV, Snp, VNET_SIG)\r
	113	\r
ece77e40 OM	114	#define VIRTIO_CFG_WRITE(Dev, Field, Value) ((Dev)->VirtIo->WriteDevice ( \\r
	115	(Dev)->VirtIo, \\r
	116	OFFSET_OF_VNET (Field), \\r
	117	SIZE_OF_VNET (Field), \\r
	118	(Value) \\r
201cac0d LE	119	))\r
201cac0d LE	120	\r
ac0a286f	121	#define VIRTIO_CFG_READ(Dev, Field, Pointer) ((Dev)->VirtIo->ReadDevice ( \\r
ece77e40 OM	122	(Dev)->VirtIo, \\r
	123	OFFSET_OF_VNET (Field), \\r
	124	SIZE_OF_VNET (Field), \\r
	125	sizeof *(Pointer), \\r
	126	(Pointer) \\r
201cac0d LE	127	))\r
	128	\r
	129	//\r
	130	// component naming\r
	131	//\r
ac0a286f MK	132	extern EFI_COMPONENT_NAME_PROTOCOL gVirtioNetComponentName;\r
ac0a286f MK	133	extern EFI_COMPONENT_NAME2_PROTOCOL gVirtioNetComponentName2;\r
201cac0d LE	134	\r
	135	//\r
	136	// driver binding\r
	137	//\r
ac0a286f	138	extern EFI_DRIVER_BINDING_PROTOCOL gVirtioNetDriverBinding;\r
201cac0d LE	139	\r
	140	//\r
	141	// member functions implementing the Simple Network Protocol\r
	142	//\r
	143	EFI_STATUS\r
	144	EFIAPI\r
	145	VirtioNetStart (\r
ac0a286f	146	IN EFI_SIMPLE_NETWORK_PROTOCOL *This\r
201cac0d LE	147	);\r
	148	\r
	149	EFI_STATUS\r
	150	EFIAPI\r
	151	VirtioNetStop (\r
ac0a286f	152	IN EFI_SIMPLE_NETWORK_PROTOCOL *This\r
201cac0d LE	153	);\r
	154	\r
	155	EFI_STATUS\r
	156	EFIAPI\r
	157	VirtioNetInitialize (\r
ac0a286f MK	158	IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r
	159	IN UINTN ExtraRxBufferSize OPTIONAL,\r
	160	IN UINTN ExtraTxBufferSize OPTIONAL\r
201cac0d LE	161	);\r
	162	\r
	163	EFI_STATUS\r
	164	EFIAPI\r
	165	VirtioNetReset (\r
ac0a286f MK	166	IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r
ac0a286f MK	167	IN BOOLEAN ExtendedVerification\r
201cac0d LE	168	);\r
	169	\r
	170	EFI_STATUS\r
	171	EFIAPI\r
	172	VirtioNetShutdown (\r
ac0a286f	173	IN EFI_SIMPLE_NETWORK_PROTOCOL *This\r
201cac0d LE	174	);\r
	175	\r
	176	EFI_STATUS\r
	177	EFIAPI\r
	178	VirtioNetReceiveFilters (\r
ac0a286f MK	179	IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r
	180	IN UINT32 Enable,\r
	181	IN UINT32 Disable,\r
	182	IN BOOLEAN ResetMCastFilter,\r
	183	IN UINTN MCastFilterCnt OPTIONAL,\r
	184	IN EFI_MAC_ADDRESS *MCastFilter OPTIONAL\r
201cac0d LE	185	);\r
	186	\r
	187	EFI_STATUS\r
	188	EFIAPI\r
	189	VirtioNetStationAddress (\r
ac0a286f MK	190	IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r
	191	IN BOOLEAN Reset,\r
	192	IN EFI_MAC_ADDRESS *New OPTIONAL\r
201cac0d LE	193	);\r
	194	\r
	195	EFI_STATUS\r
	196	EFIAPI\r
	197	VirtioNetStatistics (\r
ac0a286f MK	198	IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r
	199	IN BOOLEAN Reset,\r
	200	IN OUT UINTN *StatisticsSize OPTIONAL,\r
	201	OUT EFI_NETWORK_STATISTICS *StatisticsTable OPTIONAL\r
201cac0d LE	202	);\r
	203	\r
	204	EFI_STATUS\r
	205	EFIAPI\r
	206	VirtioNetMcastIpToMac (\r
ac0a286f MK	207	IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r
	208	IN BOOLEAN IPv6,\r
	209	IN EFI_IP_ADDRESS *Ip,\r
	210	OUT EFI_MAC_ADDRESS *Mac\r
201cac0d LE	211	);\r
	212	\r
	213	EFI_STATUS\r
	214	EFIAPI\r
	215	VirtioNetNvData (\r
ac0a286f MK	216	IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r
	217	IN BOOLEAN ReadWrite,\r
	218	IN UINTN Offset,\r
	219	IN UINTN BufferSize,\r
	220	IN OUT VOID *Buffer\r
201cac0d LE	221	);\r
	222	\r
	223	EFI_STATUS\r
	224	EFIAPI\r
	225	VirtioNetGetStatus (\r
ac0a286f MK	226	IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r
	227	OUT UINT32 *InterruptStatus OPTIONAL,\r
	228	OUT VOID **TxBuf OPTIONAL\r
201cac0d LE	229	);\r
	230	\r
	231	EFI_STATUS\r
	232	EFIAPI\r
	233	VirtioNetTransmit (\r
ac0a286f MK	234	IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r
	235	IN UINTN HeaderSize,\r
	236	IN UINTN BufferSize,\r
	237	IN /* +OUT! / VOID Buffer,\r
	238	IN EFI_MAC_ADDRESS *SrcAddr OPTIONAL,\r
	239	IN EFI_MAC_ADDRESS *DestAddr OPTIONAL,\r
	240	IN UINT16 *Protocol OPTIONAL\r
201cac0d LE	241	);\r
	242	\r
	243	EFI_STATUS\r
	244	EFIAPI\r
	245	VirtioNetReceive (\r
ac0a286f MK	246	IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r
	247	OUT UINTN *HeaderSize OPTIONAL,\r
	248	IN OUT UINTN *BufferSize,\r
	249	OUT VOID *Buffer,\r
	250	OUT EFI_MAC_ADDRESS *SrcAddr OPTIONAL,\r
	251	OUT EFI_MAC_ADDRESS *DestAddr OPTIONAL,\r
	252	OUT UINT16 *Protocol OPTIONAL\r
201cac0d LE	253	);\r
	254	\r
	255	//\r
	256	// utility functions shared by various SNP member functions\r
	257	//\r
	258	VOID\r
	259	EFIAPI\r
	260	VirtioNetShutdownRx (\r
ac0a286f	261	IN OUT VNET_DEV *Dev\r
201cac0d LE	262	);\r
	263	\r
	264	VOID\r
	265	EFIAPI\r
	266	VirtioNetShutdownTx (\r
ac0a286f	267	IN OUT VNET_DEV *Dev\r
201cac0d LE	268	);\r
201cac0d LE	269	\r
55dd5a67 BS	270	VOID\r
	271	EFIAPI\r
	272	VirtioNetUninitRing (\r
ac0a286f MK	273	IN OUT VNET_DEV *Dev,\r
	274	IN OUT VRING *Ring,\r
	275	IN VOID *RingMap\r
55dd5a67 BS	276	);\r
55dd5a67 BS	277	\r
bd114d9f BS	278	//\r
	279	// utility functions to map caller-supplied Tx buffer system physical address\r
	280	// to a device address and vice versa\r
	281	//\r
	282	EFI_STATUS\r
	283	EFIAPI\r
	284	VirtioNetMapTxBuf (\r
	285	IN VNET_DEV *Dev,\r
	286	IN VOID *Buffer,\r
	287	IN UINTN NumberOfBytes,\r
	288	OUT EFI_PHYSICAL_ADDRESS *DeviceAddress\r
	289	);\r
	290	\r
	291	EFI_STATUS\r
	292	EFIAPI\r
	293	VirtioNetUnmapTxBuf (\r
	294	IN VNET_DEV *Dev,\r
	295	OUT VOID **Buffer,\r
	296	IN EFI_PHYSICAL_ADDRESS DeviceAddress\r
	297	);\r
	298	\r
	299	INTN\r
	300	EFIAPI\r
	301	VirtioNetTxBufMapInfoCompare (\r
ac0a286f MK	302	IN CONST VOID *UserStruct1,\r
ac0a286f MK	303	IN CONST VOID *UserStruct2\r
bd114d9f BS	304	);\r
	305	\r
	306	INTN\r
	307	EFIAPI\r
	308	VirtioNetTxBufDeviceAddressCompare (\r
ac0a286f MK	309	IN CONST VOID *StandaloneKey,\r
ac0a286f MK	310	IN CONST VOID *UserStruct\r
bd114d9f BS	311	);\r
bd114d9f BS	312	\r
201cac0d LE	313	//\r
	314	// event callbacks\r
	315	//\r
	316	VOID\r
	317	EFIAPI\r
	318	VirtioNetIsPacketAvailable (\r
ac0a286f MK	319	IN EFI_EVENT Event,\r
ac0a286f MK	320	IN VOID *Context\r
201cac0d LE	321	);\r
	322	\r
	323	VOID\r
	324	EFIAPI\r
	325	VirtioNetExitBoot (\r
ac0a286f MK	326	IN EFI_EVENT Event,\r
ac0a286f MK	327	IN VOID *Context\r
201cac0d LE	328	);\r
	329	\r
	330	#endif // _VIRTIO_NET_DXE_H_\r