Changeset 91930 in vbox for trunk/include/VBox

Timestamp:

Oct 21, 2021 10:12:30 AM (3 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

147735

Message:

VMM,Devices: Eliminate direct calls to IOMMmioResetRegion and IOMMmioMapMmio2Page APIs and introduce callbacks in the device helper callback table, bugref:10074

File:

• trunk/include/VBox/vmm/pdmdev.h (modified) (5 diffs)

trunk/include/VBox/vmm/pdmdev.h

@@ -2424 +2424 @@
 
 /** Current PDMDEVHLPR3 version number. */
-#define PDM_DEVHLPR3_VERSION                    PDM_VERSION_MAKE_PP(0xffe7, 55, 0)
+#define PDM_DEVHLPR3_VERSION                    PDM_VERSION_MAKE_PP(0xffe7, 56, 0)
 
 /**
@@ -2715 +2715 @@
      */
     DECLR3CALLBACKMEMBER(int, pfnMmio2ChangeRegionNo,(PPDMDEVINS pDevIns, PGMMMIO2HANDLE hRegion, uint32_t iNewRegion));
+
+    /**
+     * Mapping an MMIO2 page in place of an MMIO page for direct access.
+     *
+     * This is a special optimization used by the VGA device.  Call
+     * PDMDevHlpMmioResetRegion() to undo the mapping.
+     *
+     * @returns VBox status code.  This API may return VINF_SUCCESS even if no
+     *          remapping is made.
+     * @retval  VERR_SEM_BUSY in ring-0 if we cannot get the IOM lock.
+     *
+     * @param   pDevIns         The device instance @a hRegion and @a hMmio2 are
+     *                          associated with.
+     * @param   hRegion         The handle to the MMIO region.
+     * @param   offRegion       The offset into @a hRegion of the page to be
+     *                          remapped.
+     * @param   hMmio2          The MMIO2 handle.
+     * @param   offMmio2        Offset into @a hMmio2 of the page to be use for the
+     *                          mapping.
+     * @param   fPageFlags      Page flags to set. Must be (X86_PTE_RW | X86_PTE_P)
+     *                          for the time being.
+     */
+    DECLR3CALLBACKMEMBER(int, pfnMmioMapMmio2Page,(PPDMDEVINS pDevIns, IOMMMIOHANDLE hRegion, RTGCPHYS offRegion,
+                                                   uint64_t hMmio2, RTGCPHYS offMmio2, uint64_t fPageFlags));
+
+    /**
+     * Reset a previously modified MMIO region; restore the access flags.
+     *
+     * This undoes the effects of PDMDevHlpMmioMapMmio2Page() and is currently only
+     * intended for some ancient VGA hack.  However, it would be great to extend it
+     * beyond VT-x and/or nested-paging.
+     *
+     * @returns VBox status code.
+     *
+     * @param   pDevIns         The device instance @a hRegion is associated with.
+     * @param   hRegion         The handle to the MMIO region.
+     */
+    DECLR3CALLBACKMEMBER(int, pfnMmioResetRegion, (PPDMDEVINS pDevIns, IOMMMIOHANDLE hRegion));
     /** @} */
 
@@ -5704 +5742 @@
     DECLR0CALLBACKMEMBER(int, pfnPGMHandlerPhysicalPageTempOff,(PPDMDEVINS pDevIns, RTGCPHYS GCPhys, RTGCPHYS GCPhysPage));
 
+    /**
+     * Mapping an MMIO2 page in place of an MMIO page for direct access.
+     *
+     * This is a special optimization used by the VGA device.  Call
+     * PDMDevHlpMmioResetRegion() to undo the mapping.
+     *
+     * @returns VBox status code.  This API may return VINF_SUCCESS even if no
+     *          remapping is made.
+     * @retval  VERR_SEM_BUSY in ring-0 if we cannot get the IOM lock.
+     *
+     * @param   pDevIns         The device instance @a hRegion and @a hMmio2 are
+     *                          associated with.
+     * @param   hRegion         The handle to the MMIO region.
+     * @param   offRegion       The offset into @a hRegion of the page to be
+     *                          remapped.
+     * @param   hMmio2          The MMIO2 handle.
+     * @param   offMmio2        Offset into @a hMmio2 of the page to be use for the
+     *                          mapping.
+     * @param   fPageFlags      Page flags to set. Must be (X86_PTE_RW | X86_PTE_P)
+     *                          for the time being.
+     */
+    DECLR0CALLBACKMEMBER(int, pfnMmioMapMmio2Page,(PPDMDEVINS pDevIns, IOMMMIOHANDLE hRegion, RTGCPHYS offRegion,
+                                                   uint64_t hMmio2, RTGCPHYS offMmio2, uint64_t fPageFlags));
+
+    /**
+     * Reset a previously modified MMIO region; restore the access flags.
+     *
+     * This undoes the effects of PDMDevHlpMmioMapMmio2Page() and is currently only
+     * intended for some ancient VGA hack.  However, it would be great to extend it
+     * beyond VT-x and/or nested-paging.
+     *
+     * @returns VBox status code.
+     *
+     * @param   pDevIns         The device instance @a hRegion is associated with.
+     * @param   hRegion         The handle to the MMIO region.
+     */
+    DECLR0CALLBACKMEMBER(int, pfnMmioResetRegion, (PPDMDEVINS pDevIns, IOMMMIOHANDLE hRegion));
+
     /** Space reserved for future members.
      * @{ */
@@ -5727 +5803 @@
 
 /** Current PDMDEVHLP version number. */
-#define PDM_DEVHLPR0_VERSION                    PDM_VERSION_MAKE(0xffe5, 23, 0)
+#define PDM_DEVHLPR0_VERSION                    PDM_VERSION_MAKE(0xffe5, 24, 0)
 
 
@@ -6471 +6547 @@
 
 #endif /* IN_RING3 */
+
+/**
+ * @copydoc PDMDEVHLPR3::pfnMmioMapMmio2Page
+ */
+DECLINLINE(RTGCPHYS) PDMDevHlpMmioMapMmio2Page(PPDMDEVINS pDevIns, IOMMMIOHANDLE hRegion, RTGCPHYS offRegion,
+                                               uint64_t hMmio2, RTGCPHYS offMmio2, uint64_t fPageFlags)
+{
+    return pDevIns->CTX_SUFF(pHlp)->pfnMmioMapMmio2Page(pDevIns, hRegion, offRegion, hMmio2, offMmio2, fPageFlags);
+}
+
+/**
+ * @copydoc PDMDEVHLPR3::pfnMmioResetRegion
+ */
+DECLINLINE(RTGCPHYS) PDMDevHlpMmioResetRegion(PPDMDEVINS pDevIns, IOMMMIOHANDLE hRegion)
+{
+    return pDevIns->CTX_SUFF(pHlp)->pfnMmioResetRegion(pDevIns, hRegion);
+}
+
 #if !defined(IN_RING3) || defined(DOXYGEN_RUNNING)