OvmfPkg: VirtioNetDxe: declarations and macro definitions

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
Reviewed-by: Jordan Justen <jordan.l.justen@intel.com>
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@14405 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/OvmfPkg/Include/IndustryStandard/VirtioNet.h b/OvmfPkg/Include/IndustryStandard/VirtioNet.h
new file mode 100644 (file)
index 0000000..9f5291a
--- /dev/null
+++ b/OvmfPkg/Include/IndustryStandard/VirtioNet.h
@@ -0,0 +1,99 @@
+/** @file
+
+  Virtio Network Device specific type and macro definitions corresponding to
+  the virtio-0.9.5 specification.
+
+  Copyright (C) 2013, Red Hat, Inc.
+
+  This program and the accompanying materials are licensed and made available
+  under the terms and conditions of the BSD License which 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.
+
+**/
+
+#ifndef _VIRTIO_NET_H_
+#define _VIRTIO_NET_H_
+
+#include <IndustryStandard/Virtio.h>
+
+//
+// virtio-0.9.5, Appendix C: Network Device
+//
+#pragma pack(1)
+typedef struct {
+  VIRTIO_HDR Generic;
+  UINT8      VhdrMac[6];
+  UINT16     VhdrLinkStatus;
+} VNET_HDR;
+#pragma pack()
+
+#define OFFSET_OF_VNET(Field) OFFSET_OF (VNET_HDR, Field)
+#define SIZE_OF_VNET(Field)   (sizeof ((VNET_HDR *) 0)->Field)
+
+//
+// Queue Identifiers
+//
+#define VIRTIO_NET_Q_RX 0
+#define VIRTIO_NET_Q_TX 1
+
+//
+// Feature Bits
+//
+#define VIRTIO_NET_F_CSUM           BIT0  // host to checksum outgoing packets
+#define VIRTIO_NET_F_GUEST_CSUM     BIT1  // guest to checksum incoming packets
+#define VIRTIO_NET_F_MAC            BIT5  // MAC available to guest
+#define VIRTIO_NET_F_GSO            BIT6  // deprecated
+#define VIRTIO_NET_F_GUEST_TSO4     BIT7  // guest can receive TSOv4
+#define VIRTIO_NET_F_GUEST_TSO6     BIT8  // guest can receive TSOv6
+#define VIRTIO_NET_F_GUEST_ECN      BIT9  // guest can receive TSO with ECN
+#define VIRTIO_NET_F_GUEST_UFO      BIT10 // guest can receive UFO
+#define VIRTIO_NET_F_HOST_TSO4      BIT11 // host can receive TSOv4
+#define VIRTIO_NET_F_HOST_TSO6      BIT12 // host can receive TSOv6
+#define VIRTIO_NET_F_HOST_ECN       BIT13 // host can receive TSO with ECN
+#define VIRTIO_NET_F_HOST_UFO       BIT14 // host can receive UFO
+#define VIRTIO_NET_F_MRG_RXBUF      BIT15 // guest can merge receive buffers
+#define VIRTIO_NET_F_STATUS         BIT16 // link status available to guest
+#define VIRTIO_NET_F_CTRL_VQ        BIT17 // control channel available
+#define VIRTIO_NET_F_CTRL_RX        BIT18 // control channel RX mode support
+#define VIRTIO_NET_F_CTRL_VLAN      BIT19 // control channel VLAN filtering
+#define VIRTIO_NET_F_GUEST_ANNOUNCE BIT21 // guest can send gratuitous pkts
+
+//
+// Packet Header
+//
+#pragma pack(1)
+typedef struct {
+  UINT8  Flags;
+  UINT8  GsoType;
+  UINT16 HdrLen;
+  UINT16 GsoSize;
+  UINT16 CsumStart;
+  UINT16 CsumOffset;
+} VIRTIO_NET_REQ;
+#pragma pack()
+
+//
+// Bits in VIRTIO_NET_REQ.Flags
+//
+#define VIRTIO_NET_HDR_F_NEEDS_CSUM BIT0
+
+//
+// Types/Bits for VIRTIO_NET_REQ.GsoType
+//
+#define VIRTIO_NET_HDR_GSO_NONE  0x00
+#define VIRTIO_NET_HDR_GSO_TCPV4 0x01
+#define VIRTIO_NET_HDR_GSO_UDP   0x03
+#define VIRTIO_NET_HDR_GSO_TCPV6 0x04
+#define VIRTIO_NET_HDR_GSO_ECN   BIT7
+
+//
+// Link Status Bits in VNET_HDR.VhdrLinkStatus
+//
+#define VIRTIO_NET_S_LINK_UP  BIT0
+#define VIRTIO_NET_S_ANNOUNCE BIT1
+
+#endif // _VIRTIO_NET_H_

diff --git a/OvmfPkg/VirtioNetDxe/VirtioNet.h b/OvmfPkg/VirtioNetDxe/VirtioNet.h
new file mode 100644 (file)
index 0000000..8c21bcd
--- /dev/null
+++ b/OvmfPkg/VirtioNetDxe/VirtioNet.h
@@ -0,0 +1,285 @@
+/** @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
+\r
+  This program and the accompanying materials are licensed and made available\r
+  under the terms and conditions of the BSD License which accompanies this\r
+  distribution. The full text of the license may be found at\r
+  http://opensource.org/licenses/bsd-license.php\r
+\r
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT\r
+  WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\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/PciIo.h>\r
+#include <Protocol/SimpleNetwork.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
+  EFI_PCI_IO_PROTOCOL         *PciIo;            // VirtioNetDriverBindingStart\r
+  UINT64                      OrigPciAttributes; // 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
+  UINT8                       *RxBuf;            // VirtioNetInitRx\r
+  UINT16                      RxLastUsed;        // VirtioNetInitRx\r
+\r
+  VRING                       TxRing;            // VirtioNetInitRing\r
+  UINT16                      TxMaxPending;      // VirtioNetInitTx\r
+  UINT16                      TxCurPending;      // VirtioNetInitTx\r
+  UINT16                      *TxFreeStack;      // VirtioNetInitTx\r
+  VIRTIO_NET_REQ              TxSharedReq;       // VirtioNetInitTx\r
+  UINT16                      TxLastUsed;        // VirtioNetInitTx\r
+} VNET_DEV;\r
+\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)  (VirtioWrite (             \\r
+                                                (Dev)->PciIo,           \\r
+                                                OFFSET_OF_VNET (Field), \\r
+                                                SIZE_OF_VNET (Field),   \\r
+                                                (Value)                 \\r
+                                                ))\r
+\r
+#define VIRTIO_CFG_READ(Dev, Field, Pointer) (VirtioRead (              \\r
+                                                (Dev)->PciIo,           \\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
+//\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