Changeset 63884 in vbox

Timestamp:

Sep 19, 2016 12:21:00 PM (8 years ago)

Author:

vboxsync

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

110748

Message:

Devices/Samples: add "playground" device for making experiments (it isn't used by default and will be changed when specific PDM PCI testing is needed)

Location:

trunk/src/VBox/Devices/Samples

Files:

• DevPlayground.cpp (copied) (copied from trunk/src/VBox/Devices/Samples/VBoxSampleDevice.cpp ) (8 diffs)
• Makefile.kmk (modified) (1 diff)
• VBoxSampleDevice.cpp (modified) (1 diff)

trunk/src/VBox/Devices/Samples/DevPlayground.cpp

@@ -1 +1 @@
 /* $Id$ */
 /** @file
- * VBox Sample Device.
+ * DevPlayground - Device for making PDM/PCI/... experiments.
+ *
+ * This device uses big PCI BAR64 resources, which needs the ICH9 chipset.
+ * The device works without any PCI config (because the default setup with the
+ * ICH9 chipset doesn't have anything at bus=0, device=0, function=0.
+ *
+ * To enable this device for a particular VM:
+ * VBoxManage setextradata vmname VBoxInternal/PDM/Devices/playground/Path .../obj/VBoxSampleDevice/VBoxSampleDevice
+ * VBoxManage setextradata vmname VBoxInternal/Devices/playground/0/Config/Whatever1 0
  */
 
@@ -35 +43 @@
  * Device Instance Data.
  */
-typedef struct VBOXSAMPLEDEVICE
-{
-    uint32_t    Whatever;
-} VBOXSAMPLEDEVICE;
-typedef VBOXSAMPLEDEVICE *PVBOXSAMPLEDEVICE;
-
-
-
-static DECLCALLBACK(int) devSampleDestruct(PPDMDEVINS pDevIns)
+typedef struct VBOXPLAYGROUNDDEVICE
+{
+    /** The PCI device. */
+    PCIDEVICE           PciDev;
+} VBOXPLAYGROUNDDEVICE;
+typedef VBOXPLAYGROUNDDEVICE *PVBOXPLAYGROUNDDEVICE;
+
+
+/*********************************************************************************************************************************
+*   Device Functions                                                                                                             *
+*********************************************************************************************************************************/
+/**
+ * @interface_method_impl{PDMDEVREG,pfnDestruct}
+ */
+static DECLCALLBACK(int) devPlaygroundDestruct(PPDMDEVINS pDevIns)
 {
     /*
@@ -55 +69 @@
 
 
-static DECLCALLBACK(int) devSampleConstruct(PPDMDEVINS pDevIns, int iInstance, PCFGMNODE pCfg)
-{
+PDMBOTHCBDECL(int) devPlaygroundMMIORead(PPDMDEVINS pDevIns, void *pvUser, RTGCPHYS GCPhysAddr, void *pv, unsigned cb)
+{
+    NOREF(pDevIns);
+    NOREF(pvUser);
+    NOREF(GCPhysAddr);
+    NOREF(pv);
+    NOREF(cb);
+    return VINF_SUCCESS;
+}
+
+
+PDMBOTHCBDECL(int) devPlaygroundMMIOWrite(PPDMDEVINS pDevIns, void *pvUser, RTGCPHYS GCPhysAddr, void const *pv, unsigned cb)
+{
+    NOREF(pDevIns);
+    NOREF(pvUser);
+    NOREF(GCPhysAddr);
+    NOREF(pv);
+    NOREF(cb);
+    return VINF_SUCCESS;
+}
+
+
+/**
+ * @callback_method_impl{FNPCIIOREGIONMAP}
+ */
+static DECLCALLBACK(int) devPlaygroundMap(PPCIDEVICE pPciDev, int iRegion, RTGCPHYS GCPhysAddress, RTGCPHYS cb, PCIADDRESSSPACE enmType)
+{
+    NOREF(enmType);
+    int rc;
+
+    switch (iRegion)
+    {
+        case 0:
+            rc = PDMDevHlpMMIORegister(pPciDev->pDevIns, GCPhysAddress, cb, NULL,
+                                       IOMMMIO_FLAGS_READ_PASSTHRU | IOMMMIO_FLAGS_WRITE_PASSTHRU,
+                                       devPlaygroundMMIOWrite, devPlaygroundMMIORead, "PG-BAR0");
+            break;
+        case 2:
+            rc = PDMDevHlpMMIORegister(pPciDev->pDevIns, GCPhysAddress, cb, NULL,
+                                       IOMMMIO_FLAGS_READ_PASSTHRU | IOMMMIO_FLAGS_WRITE_PASSTHRU,
+                                       devPlaygroundMMIOWrite, devPlaygroundMMIORead, "PG-BAR2");
+            break;
+        default:
+            /* We should never get here */
+            AssertMsgFailed(("Invalid PCI region param in map callback"));
+            rc = VERR_INTERNAL_ERROR;
+    }
+    return rc;
+
+}
+
+
+/**
+ * @interface_method_impl{PDMDEVREG,pfnConstruct}
+ */
+static DECLCALLBACK(int) devPlaygroundConstruct(PPDMDEVINS pDevIns, int iInstance, PCFGMNODE pCfg)
+{
+    NOREF(iInstance);
+
     /*
      * Check that the device instance and device helper structures are compatible.
@@ -66 +137 @@
      * Initialize the instance data so that the destructor won't mess up.
      */
-    PVBOXSAMPLEDEVICE pThis = PDMINS_2_DATA(pDevIns, PVBOXSAMPLEDEVICE);
-    pThis->Whatever = 0;
+    PVBOXPLAYGROUNDDEVICE pThis = PDMINS_2_DATA(pDevIns, PVBOXPLAYGROUNDDEVICE);
+    PCIDevSetVendorId(&pThis->PciDev, 0x80ee);
+    PCIDevSetDeviceId(&pThis->PciDev, 0xde4e);
+    PCIDevSetClassBase(&pThis->PciDev, 0x07);   /* communications device */
+    PCIDevSetClassSub(&pThis->PciDev, 0x80);    /* other communications device */
 
     /*
@@ -78 +152 @@
 
     /*
-     * Use the instance number if necessary (not for this device, which in
-     * g_DeviceSample below declares a maximum instance count of 1).
-     */
-    NOREF(iInstance);
-
-    return VINF_SUCCESS;
-}
-
+     * PCI device setup.
+     */
+    int rc = PDMDevHlpPCIRegister(pDevIns, &pThis->PciDev);
+    if (RT_FAILURE(rc))
+        return rc;
+    rc = PDMDevHlpPCIIORegionRegister(pDevIns, 0, 8*_1G64,
+                                      (PCIADDRESSSPACE)(PCI_ADDRESS_SPACE_MEM | PCI_ADDRESS_SPACE_BAR64),
+                                      devPlaygroundMap);
+    if (RT_FAILURE(rc))
+        return rc;
+    rc = PDMDevHlpPCIIORegionRegister(pDevIns, 2, 8*_1G64,
+                                      (PCIADDRESSSPACE)(PCI_ADDRESS_SPACE_MEM | PCI_ADDRESS_SPACE_BAR64),
+                                      devPlaygroundMap);
+    if (RT_FAILURE(rc))
+        return rc;
+
+    return VINF_SUCCESS;
+}
+
+RT_C_DECLS_BEGIN
+extern const PDMDEVREG g_DevicePlayground;
+RT_C_DECLS_END
 
 /**
  * The device registration structure.
  */
-static const PDMDEVREG g_DeviceSample =
+const PDMDEVREG g_DevicePlayground =
 {
     /* u32Version */
     PDM_DEVREG_VERSION,
     /* szName */
-    "sample",
+    "playground",
     /* szRCMod */
     "",
@@ -101 +189 @@
     "",
     /* pszDescription */
-    "VBox Sample Device.",
+    "VBox Playground Device.",
     /* fFlags */
     PDM_DEVREG_FLAGS_DEFAULT_BITS,
@@ -109 +197 @@
     1,
     /* cbInstance */
-    sizeof(VBOXSAMPLEDEVICE),
+    sizeof(VBOXPLAYGROUNDDEVICE),
     /* pfnConstruct */
-    devSampleConstruct,
+    devPlaygroundConstruct,
     /* pfnDestruct */
-    devSampleDestruct,
+    devPlaygroundDestruct,
     /* pfnRelocate */
     NULL,
@@ -141 +229 @@
     PDM_DEVREG_VERSION
 };
-
-
-/**
- * Register devices provided by the plugin.
- *
- * @returns VBox status code.
- * @param   pCallbacks      Pointer to the callback table.
- * @param   u32Version      VBox version number.
- */
-extern "C" DECLEXPORT(int) VBoxDevicesRegister(PPDMDEVREGCB pCallbacks, uint32_t u32Version)
-{
-    LogFlow(("VBoxSampleDevice::VBoxDevicesRegister: u32Version=%#x pCallbacks->u32Version=%#x\n", u32Version, pCallbacks->u32Version));
-
-    AssertLogRelMsgReturn(pCallbacks->u32Version == PDM_DEVREG_CB_VERSION,
-                          ("%#x, expected %#x\n", pCallbacks->u32Version, PDM_DEVREG_CB_VERSION),
-                          VERR_VERSION_MISMATCH);
-
-    return pCallbacks->pfnRegister(pCallbacks, &g_DeviceSample);
-}
-

trunk/src/VBox/Devices/Samples/Makefile.kmk

@@ -27 +27 @@
 VBoxSampleDevice_INSTTYPE = none
 VBoxSampleDevice_SOURCES  = \
-        VBoxSampleDevice.cpp
+        VBoxSampleDevice.cpp \
+        DevPlayground.cpp
 VBoxSampleDevice_LIBS     = \
         $(LIB_RUNTIME) \

trunk/src/VBox/Devices/Samples/VBoxSampleDevice.cpp

@@ -158 +158 @@
                           VERR_VERSION_MISMATCH);
 
-    return pCallbacks->pfnRegister(pCallbacks, &g_DeviceSample);
+    /* Two devices in this module. */
+    extern const PDMDEVREG g_DevicePlayground;
+    int rc = pCallbacks->pfnRegister(pCallbacks, &g_DeviceSample);
+    if (RT_SUCCESS(rc))
+        rc = pCallbacks->pfnRegister(pCallbacks, &g_DevicePlayground);
+    return rc;
 }