OvmfPkg/MemEncryptSevLib: find pages of initial SMRAM save state map

[mirror_edk2.git] / OvmfPkg / Include / Library / VirtioLib.h

diff --git a/OvmfPkg/Include/Library/VirtioLib.h b/OvmfPkg/Include/Library/VirtioLib.h
index 929e00c5f7d53cccb5b430786de92e2f195d0595..bca58cdeb2aa1fdfe5f49a7f72a64d4aaf42002e 100644 (file)
--- a/OvmfPkg/Include/Library/VirtioLib.h
+++ b/OvmfPkg/Include/Library/VirtioLib.h
@@ -42,9 +42,8 @@
 \r
   @param[out] Ring              The virtio ring to set up.\r
 \r
-  @retval EFI_OUT_OF_RESOURCES  AllocatePages() failed to allocate contiguous\r
-                                pages for the requested QueueSize. Fields of\r
-                                Ring have indeterminate value.\r
+  @return                       Status codes propagated from\r
+                                VirtIo->AllocateSharedPages().\r
 \r
   @retval EFI_SUCCESS           Allocation and setup successful. Ring->Base\r
                                 (and nothing else) is responsible for\r
@@ -60,6 +59,32 @@ VirtioRingInit (
   );\r
 \r
 \r
+/**\r
+\r
+  Map the ring buffer so that it can be accessed equally by both guest\r
+  and hypervisor.\r
+\r
+  @param[in]      VirtIo          The virtio device instance.\r
+\r
+  @param[in]      Ring            The virtio ring to map.\r
+\r
+  @param[out]     RingBaseShift   A resulting translation offset, to be\r
+                                  passed to VirtIo->SetQueueAddress().\r
+\r
+  @param[out]     Mapping         A resulting token to pass to\r
+                                  VirtIo->UnmapSharedBuffer().\r
+\r
+  @return         Status code from VirtIo->MapSharedBuffer()\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+VirtioRingMap (\r
+  IN  VIRTIO_DEVICE_PROTOCOL *VirtIo,\r
+  IN  VRING                  *Ring,\r
+  OUT UINT64                 *RingBaseShift,\r
+  OUT VOID                   **Mapping\r
+  );\r
+\r
 /**\r
 \r
   Tear down the internal resources of a configured virtio ring.\r
@@ -126,33 +151,34 @@ VirtioPrepare (
   The caller is responsible for initializing *Indices with VirtioPrepare()\r
   first.\r
 \r
-  @param[in,out] Ring        The virtio ring to append the buffer to, as a\r
-                             descriptor.\r
+  @param[in,out] Ring               The virtio ring to append the buffer to,\r
+                                    as a descriptor.\r
 \r
-  @param[in] BufferPhysAddr  (Guest pseudo-physical) start address of the\r
-                             transmit / receive buffer.\r
+  @param[in] BufferDeviceAddress    (Bus master device) start address of the\r
+                                    transmit / receive buffer.\r
 \r
-  @param[in] BufferSize      Number of bytes to transmit or receive.\r
+  @param[in] BufferSize             Number of bytes to transmit or receive.\r
 \r
-  @param[in] Flags           A bitmask of VRING_DESC_F_* flags. The caller\r
-                             computes this mask dependent on further buffers to\r
-                             append and transfer direction.\r
-                             VRING_DESC_F_INDIRECT is unsupported. The\r
-                             VRING_DESC.Next field is always set, but the host\r
-                             only interprets it dependent on VRING_DESC_F_NEXT.\r
+  @param[in] Flags                  A bitmask of VRING_DESC_F_* flags. The\r
+                                    caller computes this mask dependent on\r
+                                    further buffers to append and transfer\r
+                                    direction. VRING_DESC_F_INDIRECT is\r
+                                    unsupported. The VRING_DESC.Next field is\r
+                                    always set, but the host only interprets\r
+                                    it dependent on VRING_DESC_F_NEXT.\r
 \r
-  @param[in,out] Indices     Indices->HeadDescIdx is not accessed.\r
-                             On input, Indices->NextDescIdx identifies the next\r
-                             descriptor to carry the buffer. On output,\r
-                             Indices->NextDescIdx is incremented by one, modulo\r
-                             2^16.\r
+  @param[in,out] Indices            Indices->HeadDescIdx is not accessed.\r
+                                    On input, Indices->NextDescIdx identifies\r
+                                    the next descriptor to carry the buffer.\r
+                                    On output, Indices->NextDescIdx is\r
+                                    incremented by one, modulo 2^16.\r
 \r
 **/\r
 VOID\r
 EFIAPI\r
 VirtioAppendDesc (\r
   IN OUT VRING        *Ring,\r
-  IN     UINTN        BufferPhysAddr,\r
+  IN     UINT64       BufferDeviceAddress,\r
   IN     UINT32       BufferSize,\r
   IN     UINT16       Flags,\r
   IN OUT DESC_INDICES *Indices\r