OvmfPkg/Virtio: take RingBaseShift in SetQueueAddress()

For the case when an IOMMU is used for translating system physical
addresses to DMA bus master addresses, the transport-independent
virtio device drivers will be required to map their VRING areas to
bus addresses with VIRTIO_DEVICE_PROTOCOL.MapSharedBuffer() calls.

- MMIO and legacy virtio transport do not support IOMMU to translate the
  addresses hence RingBaseShift will always be set to zero.

- modern virtio transport supports IOMMU to translate the address, in
  next patch we will update the Virtio10Dxe to use RingBaseShift offset.

Suggested-by: Laszlo Ersek <lersek@redhat.com>
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>
[lersek@redhat.com: remove commit msg paragraph with VirtioLib reference]
[lersek@redhat.com: fix typo in VIRTIO_SET_QUEUE_ADDRESS comment block]
Reviewed-by: Laszlo Ersek <lersek@redhat.com>
Regression-tested-by: Laszlo Ersek <lersek@redhat.com>

11 files changed, 42 insertions, 12 deletions

diff --git a/OvmfPkg/Include/Protocol/VirtioDevice.h b/OvmfPkg/Include/Protocol/VirtioDevice.h
index 9a01932958..afc27e54a8 100644
--- a/OvmfPkg/Include/Protocol/VirtioDevice.h
+++ b/OvmfPkg/Include/Protocol/VirtioDevice.h
@@ -156,7 +156,21 @@ EFI_STATUS
   @param[in] This             This instance of VIRTIO_DEVICE_PROTOCOL

 

   @param[in] Ring             The initialized VRING object to take the

-                              addresses from.

+                              addresses from. The caller is responsible for

+                              ensuring that on input, all Ring->NumPages pages,

+                              starting at Ring->Base, have been successfully

+                              mapped with a single call to

+                              This->MapSharedBuffer() for CommonBuffer bus

+                              master operation.

+

+  @param[in] RingBaseShift    Adding this value using UINT64 arithmetic to the

+                              addresses found in Ring translates them from

+                              system memory to bus addresses. The caller shall

+                              calculate RingBaseShift as

+                              (DeviceAddress - (UINT64)(UINTN)HostAddress),

+                              where DeviceAddress and HostAddress (i.e.,

+                              Ring->Base) were output and input parameters of

+                              This->MapSharedBuffer(), respectively.

 

   @retval EFI_SUCCESS         The data was written successfully.

   @retval EFI_UNSUPPORTED     The underlying IO device doesn't support the

@@ -166,7 +180,8 @@ typedef
 EFI_STATUS

 (EFIAPI *VIRTIO_SET_QUEUE_ADDRESS) (

   IN VIRTIO_DEVICE_PROTOCOL  *This,

-  IN VRING                   *Ring

+  IN VRING                   *Ring,

+  IN UINT64                  RingBaseShift

   );

 

 /**

diff --git a/OvmfPkg/Library/VirtioMmioDeviceLib/VirtioMmioDevice.h b/OvmfPkg/Library/VirtioMmioDeviceLib/VirtioMmioDevice.h
index e5881d537f..e6279159f8 100644
--- a/OvmfPkg/Library/VirtioMmioDeviceLib/VirtioMmioDevice.h
+++ b/OvmfPkg/Library/VirtioMmioDeviceLib/VirtioMmioDevice.h
@@ -115,7 +115,8 @@ VirtioMmioSetQueueSel (
 EFI_STATUS

 VirtioMmioSetQueueAddress (

   IN VIRTIO_DEVICE_PROTOCOL  *This,

-  IN VRING                   *Ring

+  IN VRING                   *Ring,

+  IN UINT64                  RingBaseShift

   );

 

 EFI_STATUS

diff --git a/OvmfPkg/Library/VirtioMmioDeviceLib/VirtioMmioDeviceFunctions.c b/OvmfPkg/Library/VirtioMmioDeviceLib/VirtioMmioDeviceFunctions.c
index 644ec65e17..67458e5623 100644
--- a/OvmfPkg/Library/VirtioMmioDeviceLib/VirtioMmioDeviceFunctions.c
+++ b/OvmfPkg/Library/VirtioMmioDeviceLib/VirtioMmioDeviceFunctions.c
@@ -181,11 +181,14 @@ VirtioMmioSetQueueSel (
 EFI_STATUS

 VirtioMmioSetQueueAddress (

   IN VIRTIO_DEVICE_PROTOCOL  *This,

-  IN VRING                   *Ring

+  IN VRING                   *Ring,

+  IN UINT64                  RingBaseShift

   )

 {

   VIRTIO_MMIO_DEVICE *Device;

 

+  ASSERT (RingBaseShift == 0);

+

   Device = VIRTIO_MMIO_DEVICE_FROM_VIRTIO_DEVICE (This);

 

   VIRTIO_CFG_WRITE (Device, VIRTIO_MMIO_OFFSET_QUEUE_PFN,

diff --git a/OvmfPkg/Virtio10Dxe/Virtio10.c b/OvmfPkg/Virtio10Dxe/Virtio10.c
index 89ccac8c1c..ef9a007106 100644
--- a/OvmfPkg/Virtio10Dxe/Virtio10.c
+++ b/OvmfPkg/Virtio10Dxe/Virtio10.c
@@ -489,7 +489,8 @@ EFI_STATUS
 EFIAPI

 Virtio10SetQueueAddress (

   IN VIRTIO_DEVICE_PROTOCOL  *This,

-  IN VRING                   *Ring

+  IN VRING                   *Ring,

+  IN UINT64                  RingBaseShift

   )

 {

   VIRTIO_1_0_DEV *Dev;

@@ -497,6 +498,8 @@ Virtio10SetQueueAddress (
   UINT64         Address;

   UINT16         Enable;

 

+  ASSERT (RingBaseShift == 0);

+

   Dev = VIRTIO_1_0_FROM_VIRTIO_DEVICE (This);

 

   Address = (UINTN)Ring->Desc;

diff --git a/OvmfPkg/VirtioBlkDxe/VirtioBlk.c b/OvmfPkg/VirtioBlkDxe/VirtioBlk.c
index 61b9cab4ff..bff15fe3ad 100644
--- a/OvmfPkg/VirtioBlkDxe/VirtioBlk.c
+++ b/OvmfPkg/VirtioBlkDxe/VirtioBlk.c
@@ -745,7 +745,7 @@ VirtioBlkInit (
   //

   // step 4c -- Report GPFN (guest-physical frame number) of queue.

   //

-  Status = Dev->VirtIo->SetQueueAddress (Dev->VirtIo, &Dev->Ring);

+  Status = Dev->VirtIo->SetQueueAddress (Dev->VirtIo, &Dev->Ring, 0);

   if (EFI_ERROR (Status)) {

     goto ReleaseQueue;

   }

diff --git a/OvmfPkg/VirtioGpuDxe/Commands.c b/OvmfPkg/VirtioGpuDxe/Commands.c
index c2e4d72feb..5cb0031612 100644
--- a/OvmfPkg/VirtioGpuDxe/Commands.c
+++ b/OvmfPkg/VirtioGpuDxe/Commands.c
@@ -132,7 +132,11 @@ VirtioGpuInit (
   if (EFI_ERROR (Status)) {

     goto Failed;

   }

-  Status = VgpuDev->VirtIo->SetQueueAddress (VgpuDev->VirtIo, &VgpuDev->Ring);

+  Status = VgpuDev->VirtIo->SetQueueAddress (

+                              VgpuDev->VirtIo,

+                              &VgpuDev->Ring,

+                              0

+                              );

   if (EFI_ERROR (Status)) {

     goto ReleaseQueue;

   }

diff --git a/OvmfPkg/VirtioNetDxe/SnpInitialize.c b/OvmfPkg/VirtioNetDxe/SnpInitialize.c
index 6d9b81a9f9..0ecfe044a9 100644
--- a/OvmfPkg/VirtioNetDxe/SnpInitialize.c
+++ b/OvmfPkg/VirtioNetDxe/SnpInitialize.c
@@ -96,7 +96,7 @@ VirtioNetInitRing (
   //

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

   //

-  Status = Dev->VirtIo->SetQueueAddress (Dev->VirtIo, Ring);

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

   if (EFI_ERROR (Status)) {

     goto ReleaseQueue;

   }

diff --git a/OvmfPkg/VirtioPciDeviceDxe/VirtioPciDevice.h b/OvmfPkg/VirtioPciDeviceDxe/VirtioPciDevice.h
index 41df5a98e5..1f0dc45d50 100644
--- a/OvmfPkg/VirtioPciDeviceDxe/VirtioPciDevice.h
+++ b/OvmfPkg/VirtioPciDeviceDxe/VirtioPciDevice.h
@@ -126,7 +126,8 @@ EFI_STATUS
 EFIAPI

 VirtioPciSetQueueAddress (

   IN VIRTIO_DEVICE_PROTOCOL  *This,

-  IN VRING                   *Ring

+  IN VRING                   *Ring,

+  IN UINT64                  RingBaseShift

   );

 

 EFI_STATUS

diff --git a/OvmfPkg/VirtioPciDeviceDxe/VirtioPciFunctions.c b/OvmfPkg/VirtioPciDeviceDxe/VirtioPciFunctions.c
index bd912cca9b..b52060d13d 100644
--- a/OvmfPkg/VirtioPciDeviceDxe/VirtioPciFunctions.c
+++ b/OvmfPkg/VirtioPciDeviceDxe/VirtioPciFunctions.c
@@ -183,11 +183,14 @@ EFI_STATUS
 EFIAPI

 VirtioPciSetQueueAddress (

   IN VIRTIO_DEVICE_PROTOCOL  *This,

-  IN VRING                   *Ring

+  IN VRING                   *Ring,

+  IN UINT64                  RingBaseShift

   )

 {

   VIRTIO_PCI_DEVICE *Dev;

 

+  ASSERT (RingBaseShift == 0);

+

   Dev = VIRTIO_PCI_DEVICE_FROM_VIRTIO_DEVICE (This);

 

   return VirtioPciIoWrite (Dev, VIRTIO_PCI_OFFSET_QUEUE_ADDRESS, sizeof (UINT32),

diff --git a/OvmfPkg/VirtioRngDxe/VirtioRng.c b/OvmfPkg/VirtioRngDxe/VirtioRng.c
index e20602ac72..0abca488e6 100644
--- a/OvmfPkg/VirtioRngDxe/VirtioRng.c
+++ b/OvmfPkg/VirtioRngDxe/VirtioRng.c
@@ -298,7 +298,7 @@ VirtioRngInit (
   //

   // step 4c -- Report GPFN (guest-physical frame number) of queue.

   //

-  Status = Dev->VirtIo->SetQueueAddress (Dev->VirtIo, &Dev->Ring);

+  Status = Dev->VirtIo->SetQueueAddress (Dev->VirtIo, &Dev->Ring, 0);

   if (EFI_ERROR (Status)) {

     goto ReleaseQueue;

   }

diff --git a/OvmfPkg/VirtioScsiDxe/VirtioScsi.c b/OvmfPkg/VirtioScsiDxe/VirtioScsi.c
index c2f6f412ff..a983b3df7b 100644
--- a/OvmfPkg/VirtioScsiDxe/VirtioScsi.c
+++ b/OvmfPkg/VirtioScsiDxe/VirtioScsi.c
@@ -855,7 +855,7 @@ VirtioScsiInit (
   //

   // step 4c -- Report GPFN (guest-physical frame number) of queue.

   //

-  Status = Dev->VirtIo->SetQueueAddress (Dev->VirtIo, &Dev->Ring);

+  Status = Dev->VirtIo->SetQueueAddress (Dev->VirtIo, &Dev->Ring, 0);

   if (EFI_ERROR (Status)) {

     goto ReleaseQueue;

   }