OvmfPkg/VirtioNetDxe: map VRINGs using VirtioRingMap()

When device is behind the IOMMU then driver need to pass the device
address when programing the bus master. The patch uses VirtioRingMap() to
map the VRING system physical address[es] to device address[es].

Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Cc: Jordan Justen <jordan.l.justen@intel.com>
Cc: Tom Lendacky <thomas.lendacky@amd.com>
Cc: Laszlo Ersek <lersek@redhat.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Brijesh Singh <brijesh.singh@amd.com>
Reviewed-by: Laszlo Ersek <lersek@redhat.com>
Regression-tested-by: Laszlo Ersek <lersek@redhat.com>
Tested-by: Laszlo Ersek <lersek@redhat.com>

diff --git a/OvmfPkg/VirtioNetDxe/SnpInitialize.c b/OvmfPkg/VirtioNetDxe/SnpInitialize.c
index 637c978709fd90f12bb40a9dd4e94982ae27ad82..8eabdbff6f5e268102f7edcb9765334a55c5654c 100644 (file)
--- a/OvmfPkg/VirtioNetDxe/SnpInitialize.c
+++ b/OvmfPkg/VirtioNetDxe/SnpInitialize.c
@@ -35,11 +35,13 @@
                            the network device.\r
   @param[out]    Ring      The virtio-ring inside the VNET_DEV structure,\r
                            corresponding to Selector.\r
                            the network device.\r
   @param[out]    Ring      The virtio-ring inside the VNET_DEV structure,\r
                            corresponding to Selector.\r

+  @param[out]    Mapping   A resulting token to pass to VirtioNetUninitRing()\r

 \r
   @retval EFI_UNSUPPORTED  The queue size reported by the virtio-net device is\r
                            too small.\r
   @return                  Status codes from VIRTIO_CFG_WRITE(),\r
 \r
   @retval EFI_UNSUPPORTED  The queue size reported by the virtio-net device is\r
                            too small.\r
   @return                  Status codes from VIRTIO_CFG_WRITE(),\r

-                           VIRTIO_CFG_READ() and VirtioRingInit().\r
+                           VIRTIO_CFG_READ(), VirtioRingInit() and\r
+                           VirtioRingMap().\r

   @retval EFI_SUCCESS      Ring initialized.\r
 */\r
 \r
   @retval EFI_SUCCESS      Ring initialized.\r
 */\r
 \r


@@ -49,11 +51,14 @@ EFIAPI
 VirtioNetInitRing (\r
   IN OUT VNET_DEV *Dev,\r
   IN     UINT16   Selector,\r
 VirtioNetInitRing (\r
   IN OUT VNET_DEV *Dev,\r
   IN     UINT16   Selector,\r

-  OUT    VRING    *Ring\r
+  OUT    VRING    *Ring,\r
+  OUT    VOID     **Mapping\r

   )\r
 {\r
   EFI_STATUS Status;\r
   UINT16     QueueSize;\r
   )\r
 {\r
   EFI_STATUS Status;\r
   UINT16     QueueSize;\r

+  UINT64     RingBaseShift;\r
+  VOID       *MapInfo;\r

 \r
   //\r
   // step 4b -- allocate selected queue\r
 \r
   //\r
   // step 4b -- allocate selected queue\r


@@ -79,30 +84,43 @@ VirtioNetInitRing (
     return Status;\r
   }\r
 \r
     return Status;\r
   }\r
 \r

+  //\r
+  // If anything fails from here on, we must release the ring resources.\r
+  //\r
+  Status = VirtioRingMap (Dev->VirtIo, Ring, &RingBaseShift, &MapInfo);\r
+  if (EFI_ERROR (Status)) {\r
+    goto ReleaseQueue;\r
+  }\r
+\r

   //\r
   // Additional steps for MMIO: align the queue appropriately, and set the\r
   //\r
   // Additional steps for MMIO: align the queue appropriately, and set the\r

-  // size. If anything fails from here on, we must release the ring resources.\r
+  // size. If anything fails from here on, we must unmap the ring resources.\r

   //\r
   Status = Dev->VirtIo->SetQueueNum (Dev->VirtIo, QueueSize);\r
   if (EFI_ERROR (Status)) {\r
   //\r
   Status = Dev->VirtIo->SetQueueNum (Dev->VirtIo, QueueSize);\r
   if (EFI_ERROR (Status)) {\r

-    goto ReleaseQueue;\r
+    goto UnmapQueue;\r

   }\r
 \r
   Status = Dev->VirtIo->SetQueueAlign (Dev->VirtIo, EFI_PAGE_SIZE);\r
   if (EFI_ERROR (Status)) {\r
   }\r
 \r
   Status = Dev->VirtIo->SetQueueAlign (Dev->VirtIo, EFI_PAGE_SIZE);\r
   if (EFI_ERROR (Status)) {\r

-    goto ReleaseQueue;\r
+    goto UnmapQueue;\r

   }\r
 \r
   //\r
   // step 4c -- report GPFN (guest-physical frame number) of queue\r
   //\r
   }\r
 \r
   //\r
   // step 4c -- report GPFN (guest-physical frame number) of queue\r
   //\r

-  Status = Dev->VirtIo->SetQueueAddress (Dev->VirtIo, Ring, 0);\r
+  Status = Dev->VirtIo->SetQueueAddress (Dev->VirtIo, Ring, RingBaseShift);\r

   if (EFI_ERROR (Status)) {\r
   if (EFI_ERROR (Status)) {\r

-    goto ReleaseQueue;\r
+    goto UnmapQueue;\r

   }\r
 \r
   }\r
 \r

+  *Mapping = MapInfo;\r
+\r

   return EFI_SUCCESS;\r
 \r
   return EFI_SUCCESS;\r
 \r

+UnmapQueue:\r
+  Dev->VirtIo->UnmapSharedBuffer (Dev->VirtIo, MapInfo);\r
+\r

 ReleaseQueue:\r
   VirtioRingUninit (Dev->VirtIo, Ring);\r
 \r
 ReleaseQueue:\r
   VirtioRingUninit (Dev->VirtIo, Ring);\r
 \r


@@ -456,12 +474,22 @@ VirtioNetInitialize (
   //\r
   // step 4b, 4c -- allocate and report virtqueues\r
   //\r
   //\r
   // step 4b, 4c -- allocate and report virtqueues\r
   //\r

-  Status = VirtioNetInitRing (Dev, VIRTIO_NET_Q_RX, &Dev->RxRing);\r
+  Status = VirtioNetInitRing (\r
+             Dev,\r
+             VIRTIO_NET_Q_RX,\r
+             &Dev->RxRing,\r
+             &Dev->RxRingMap\r
+             );\r

   if (EFI_ERROR (Status)) {\r
     goto DeviceFailed;\r
   }\r
 \r
   if (EFI_ERROR (Status)) {\r
     goto DeviceFailed;\r
   }\r
 \r

-  Status = VirtioNetInitRing (Dev, VIRTIO_NET_Q_TX, &Dev->TxRing);\r
+  Status = VirtioNetInitRing (\r
+             Dev,\r
+             VIRTIO_NET_Q_TX,\r
+             &Dev->TxRing,\r
+             &Dev->TxRingMap\r
+             );\r

   if (EFI_ERROR (Status)) {\r
     goto ReleaseRxRing;\r
   }\r
   if (EFI_ERROR (Status)) {\r
     goto ReleaseRxRing;\r
   }\r


@@ -510,10 +538,10 @@ AbortDevice:
   Dev->VirtIo->SetDeviceStatus (Dev->VirtIo, 0);\r
 \r
 ReleaseTxRing:\r
   Dev->VirtIo->SetDeviceStatus (Dev->VirtIo, 0);\r
 \r
 ReleaseTxRing:\r

-  VirtioNetUninitRing (Dev, &Dev->TxRing);\r
+  VirtioNetUninitRing (Dev, &Dev->TxRing, Dev->TxRingMap);\r

 \r
 ReleaseRxRing:\r
 \r
 ReleaseRxRing:\r

-  VirtioNetUninitRing (Dev, &Dev->RxRing);\r
+  VirtioNetUninitRing (Dev, &Dev->RxRing, Dev->RxRingMap);\r

 \r
 DeviceFailed:\r
   //\r
 \r
 DeviceFailed:\r
   //\r

diff --git a/OvmfPkg/VirtioNetDxe/SnpSharedHelpers.c b/OvmfPkg/VirtioNetDxe/SnpSharedHelpers.c
index 5b75eabc7a6bdad248baf8026d5474b1a01a34e3..57c7395848bd2d21c61abb0c0475783725cb05c5 100644 (file)
--- a/OvmfPkg/VirtioNetDxe/SnpSharedHelpers.c
+++ b/OvmfPkg/VirtioNetDxe/SnpSharedHelpers.c
@@ -55,15 +55,19 @@ VirtioNetShutdownTx (
 /**\r
   Release TX and RX VRING resources.\r
 \r
 /**\r
   Release TX and RX VRING resources.\r
 \r

-  @param[in,out] Dev   The VNET_DEV driver instance which was using the ring.\r
-  @param[in,out] Ring  The virtio ring to clean up.\r
+  @param[in,out] Dev       The VNET_DEV driver instance which was using\r
+                           the ring.\r
+  @param[in,out] Ring      The virtio ring to clean up.\r
+  @param[in]     RingMap   A token return from the VirtioRingMap()\r

 */\r
 VOID\r
 EFIAPI\r
 VirtioNetUninitRing (\r
   IN OUT VNET_DEV *Dev,\r
 */\r
 VOID\r
 EFIAPI\r
 VirtioNetUninitRing (\r
   IN OUT VNET_DEV *Dev,\r

-  IN OUT VRING    *Ring\r
+  IN OUT VRING    *Ring,\r
+  IN     VOID     *RingMap\r

   )\r
 {\r
   )\r
 {\r

+  Dev->VirtIo->UnmapSharedBuffer (Dev->VirtIo, RingMap);\r

   VirtioRingUninit (Dev->VirtIo, Ring);\r
 }\r
   VirtioRingUninit (Dev->VirtIo, Ring);\r
 }\r

diff --git a/OvmfPkg/VirtioNetDxe/SnpShutdown.c b/OvmfPkg/VirtioNetDxe/SnpShutdown.c
index 432e0691d4571a84650e3208c725c4280319bf8d..d8c11f20de619e73ae5455aebe8e6e6f608cbef2 100644 (file)
--- a/OvmfPkg/VirtioNetDxe/SnpShutdown.c
+++ b/OvmfPkg/VirtioNetDxe/SnpShutdown.c
@@ -67,8 +67,8 @@ VirtioNetShutdown (
   Dev->VirtIo->SetDeviceStatus (Dev->VirtIo, 0);\r
   VirtioNetShutdownRx (Dev);\r
   VirtioNetShutdownTx (Dev);\r
   Dev->VirtIo->SetDeviceStatus (Dev->VirtIo, 0);\r
   VirtioNetShutdownRx (Dev);\r
   VirtioNetShutdownTx (Dev);\r

-  VirtioNetUninitRing (Dev, &Dev->TxRing);\r
-  VirtioNetUninitRing (Dev, &Dev->RxRing);\r
+  VirtioNetUninitRing (Dev, &Dev->TxRing, Dev->TxRingMap);\r
+  VirtioNetUninitRing (Dev, &Dev->RxRing, Dev->RxRingMap);\r

 \r
   Dev->Snm.State = EfiSimpleNetworkStarted;\r
   Status = EFI_SUCCESS;\r
 \r
   Dev->Snm.State = EfiSimpleNetworkStarted;\r
   Status = EFI_SUCCESS;\r

diff --git a/OvmfPkg/VirtioNetDxe/TechNotes.txt b/OvmfPkg/VirtioNetDxe/TechNotes.txt
index 86b91f5614950f83b3e13c1462a269b9ea8fe1bc..37250b14a98cd09aa8a1fb52aa8c65beb2ad1b18 100644 (file)
--- a/OvmfPkg/VirtioNetDxe/TechNotes.txt
+++ b/OvmfPkg/VirtioNetDxe/TechNotes.txt
@@ -70,8 +70,9 @@ faithfully indented) that implement the transition.
   VirtioNetInitialize          |  | VirtioNetShutdown\r
     VirtioNetInitRing {Rx, Tx} |  |   VirtioNetShutdownRx [SnpSharedHelpers.c]\r
       VirtioRingInit           |  |   VirtioNetShutdownTx [SnpSharedHelpers.c]\r
   VirtioNetInitialize          |  | VirtioNetShutdown\r
     VirtioNetInitRing {Rx, Tx} |  |   VirtioNetShutdownRx [SnpSharedHelpers.c]\r
       VirtioRingInit           |  |   VirtioNetShutdownTx [SnpSharedHelpers.c]\r

-    VirtioNetInitTx            |  |   VirtioNetUninitRing [SnpSharedHelpers.c]\r
-    VirtioNetInitRx            |  |                       {Tx, Rx}\r
+      VirtioRingMap            |  |   VirtioNetUninitRing [SnpSharedHelpers.c]\r
+    VirtioNetInitTx            |  |                       {Tx, Rx}\r
+    VirtioNetInitRx            |  |     VirtIo->UnmapSharedBuffer\r

                                |  |     VirtioRingUninit\r
                                v  |\r
                   +-----------------------------+\r
                                |  |     VirtioRingUninit\r
                                v  |\r
                   +-----------------------------+\r

diff --git a/OvmfPkg/VirtioNetDxe/VirtioNet.h b/OvmfPkg/VirtioNetDxe/VirtioNet.h
index 87a0f06e01a42d424ae99eba3fc0adfc0fec9cbf..6762fc9d1d6e831ef770374a7a6c27537b2efc42 100644 (file)
--- a/OvmfPkg/VirtioNetDxe/VirtioNet.h
+++ b/OvmfPkg/VirtioNetDxe/VirtioNet.h
@@ -82,10 +82,14 @@ typedef struct {
   EFI_HANDLE                  MacHandle;         // VirtioNetDriverBindingStart\r
 \r
   VRING                       RxRing;            // VirtioNetInitRing\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
 \r
   VRING                       TxRing;            // VirtioNetInitRing\r
   UINT8                       *RxBuf;            // VirtioNetInitRx\r
   UINT16                      RxLastUsed;        // 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
   UINT16                      TxMaxPending;      // VirtioNetInitTx\r
   UINT16                      TxCurPending;      // VirtioNetInitTx\r
   UINT16                      *TxFreeStack;      // VirtioNetInitTx\r


@@ -267,7 +271,8 @@ VOID
 EFIAPI\r
 VirtioNetUninitRing (\r
   IN OUT VNET_DEV *Dev,\r
 EFIAPI\r
 VirtioNetUninitRing (\r
   IN OUT VNET_DEV *Dev,\r

-  IN OUT VRING    *Ring\r
+  IN OUT VRING    *Ring,\r
+  IN     VOID     *RingMap\r

   );\r
 \r
 //\r
   );\r
 \r
 //\r