Changeset 24730 in vbox for trunk/include

Timestamp:

Nov 17, 2009 4:51:03 PM (15 years ago)

Author:

vboxsync

Message:

PDM: Implemented making device/driver/usb-device suspend and poweroff notifications asynchronous when needed. Also prepped the way for failing poweron and resume.

Location:

trunk/include/VBox

Files:

• pdmcommon.h (moved) (moved from trunk/include/VBox/pdmdevdrv.h ) (3 diffs)
• pdmdev.h (modified) (6 diffs)
• pdmdrv.h (modified) (2 diffs)
• pdmusb.h (modified) (4 diffs)

trunk/include/VBox/pdmcommon.h

@@ -1 +1 @@
 /** @file
- * PDM - Pluggable Device Manager, Common Device & Driver Definitions. (VMM)
+ * PDM - Pluggable Device Manager, Common Definitions & Types. (VMM)
  */
 
@@ -28 +28 @@
  */
 
-#ifndef ___VBox_pdmdevdrv_h
-#define ___VBox_pdmdevdrv_h
+#ifndef ___VBox_pdmcommon_h
+#define ___VBox_pdmcommon_h
 
-/** @defgroup grp_pdm_devdrv    Common Device & Driver Definitions
+/** @defgroup grp_pdm_common    Common Definitions & Types
  * @ingroup grp_pdm
+ *
+ * Not all the types here are "common", they are here to work around header
+ * ordering issues.
+ *
  * @{
  */
@@ -38 +42 @@
 /** PDM Attach/Detach Callback Flags.
  * Used by PDMDeviceAttach, PDMDeviceDetach, PDMDriverAttach, PDMDriverDetach,
- * FNPDMDEVATTACH, FNPDMDEVDETACH, FNPDMDRVATTACH, FNPDMDRVDETACH and 
- * FNPDMDRVCONSTRUCT. 
- @{ */ 
+ * FNPDMDEVATTACH, FNPDMDEVDETACH, FNPDMDRVATTACH, FNPDMDRVDETACH and
+ * FNPDMDRVCONSTRUCT.
+ @{ */
 /** The attach/detach command is not a hotplug event. */
 #define PDM_TACH_FLAGS_NOT_HOT_PLUG     RT_BIT_32(0)
 /* @} */
+
+
+/**
+ * Is asynchronous handling of suspend or power off notification completed?
+ *
+ * This is called to check whether the USB device has quiesced.  Don't deadlock.
+ * Avoid blocking.  Do NOT wait for anything.
+ *
+ * @returns true if done, false if more work to be done.
+ *
+ * @param   pUsbIns             The USB device instance.
+ *
+ * @thread  EMT(0)
+ */
+typedef DECLCALLBACK(bool) FNPDMUSBASYNCNOTIFY(PPDMUSBINS pUsbIns);
+/** Pointer to a FNPDMUSBASYNCNOTIFY. */
+typedef FNPDMUSBASYNCNOTIFY *PFNPDMUSBASYNCNOTIFY;
+
+/**
+ * Is asynchronous handling of suspend or power off notification completed?
+ *
+ * This is called to check whether the device has quiesced.  Don't deadlock.
+ * Avoid blocking.  Do NOT wait for anything.
+ *
+ * @returns true if done, false if more work to be done.
+ *
+ * @param   pDevIns             The device instance.
+ *
+ * @thread  EMT(0)
+ */
+typedef DECLCALLBACK(bool) FNPDMDEVASYNCNOTIFY(PPDMDEVINS pDevIns);
+/** Pointer to a FNPDMDEVASYNCNOTIFY. */
+typedef FNPDMDEVASYNCNOTIFY *PFNPDMDEVASYNCNOTIFY;
+
+/**
+ * Is asynchronous handling of suspend or power off notification completed?
+ *
+ * This is called to check whether the driver has quiesced.  Don't deadlock.
+ * Avoid blocking.  Do NOT wait for anything.
+ *
+ * @returns true if done, false if more work to be done.
+ *
+ * @param   pDrvIns             The driver instance.
+ *
+ * @thread  EMT(0)
+ */
+typedef DECLCALLBACK(bool) FNPDMDRVASYNCNOTIFY(PPDMDRVINS pDrvIns);
+/** Pointer to a FNPDMDRVASYNCNOTIFY. */
+typedef FNPDMDRVASYNCNOTIFY *PFNPDMDRVASYNCNOTIFY;
 
 /** @} */

trunk/include/VBox/pdmdev.h

@@ -36 +36 @@
 #include <VBox/pdmifs.h>
 #include <VBox/pdmins.h>
-#include <VBox/pdmdevdrv.h>
+#include <VBox/pdmcommon.h>
 #include <VBox/iom.h>
 #include <VBox/tm.h>
@@ -151 +151 @@
  * @returns VBox status.
  * @param   pDevIns     The device instance data.
+ * @thread  EMT(0)
  */
 typedef DECLCALLBACK(void)  FNPDMDEVSUSPEND(PPDMDEVINS pDevIns);
@@ -170 +171 @@
  *
  * @param   pDevIns     The device instance data.
+ * @thread  EMT(0)
  */
 typedef DECLCALLBACK(void)   FNPDMDEVPOWEROFF(PPDMDEVINS pDevIns);
@@ -406 +408 @@
 #define PDM_IRQ_LEVEL_HIGH                      RT_BIT(0)
 /** Deassert the IRQ (can assume value 0). */
-#define PDM_IRQ_LEVEL_LOW           0
+#define PDM_IRQ_LEVEL_LOW                       0
 /** flip-flop - assert and then deassert it again immediately. */
 #define PDM_IRQ_LEVEL_FLIP_FLOP                 (RT_BIT(1) | PDM_IRQ_LEVEL_HIGH)
@@ -2405 +2407 @@
     DECLR3CALLBACKMEMBER(int, pfnPhysGCPtr2GCPhys, (PPDMDEVINS pDevIns, RTGCPTR GCPtr, PRTGCPHYS pGCPhys));
 
+    /**
+     * Set up asynchronous handling of a suspend or power off notification.
+     *
+     * This shall only be called when getting the notification.  It must be called
+     * for each one.
+     *
+     * @returns VBox status code.
+     * @param   pDevIns             The device instance.
+     * @param   pfnAsyncNotify      The callback.
+     * @thread  EMT(0)
+     */
+    DECLR3CALLBACKMEMBER(int, pfnSetAsyncNotification, (PPDMDEVINS pDevIns, PFNPDMDEVASYNCNOTIFY pfnAsyncNotify));
+
     /** Space reserved for future members.
      * @{ */
@@ -3716 +3731 @@
 
 /**
+ * @copydoc PDMDEVHLPR3::pfnSetAsyncNotification
+ */
+DECLINLINE(int) PDMDevHlpSetAsyncNotification(PPDMDEVINS pDevIns, PFNPDMDEVASYNCNOTIFY pfnAsyncNotify)
+{
+    return pDevIns->pDevHlpR3->pfnSetAsyncNotification(pDevIns, pfnAsyncNotify);
+}
+
+/**
  * @copydoc PDMDEVHLPR3::pfnVMState
  */

trunk/include/VBox/pdmdrv.h

@@ -36 +36 @@
 #include <VBox/pdmifs.h>
 #include <VBox/pdmins.h>
-#include <VBox/pdmdevdrv.h>
+#include <VBox/pdmcommon.h>
 #include <VBox/tm.h>
 #include <VBox/ssm.h>
@@ -698 +698 @@
 
     /**
+     * Set up asynchronous handling of a suspend or power off notification.
+     *
+     * This shall only be called when getting the notification.  It must be called
+     * for each one.
+     *
+     * @returns VBox status code.
+     * @param   pDrvIns             The driver instance.
+     * @param   pfnAsyncNotify      The callback.
+     * @thread  EMT(0)
+     */
+    DECLR3CALLBACKMEMBER(int, pfnSetAsyncNotification, (PPDMDRVINS pDrvIns, PFNPDMDRVASYNCNOTIFY pfnAsyncNotify));
+
+    /**
      * Creates a PDM thread.
      *

trunk/include/VBox/pdmusb.h

@@ -35 +35 @@
 #include <VBox/pdmthread.h>
 #include <VBox/pdmifs.h>
+#include <VBox/pdmcommon.h>
 #include <VBox/tm.h>
 #include <VBox/ssm.h>
@@ -374 +375 @@
 /** @} */
 
+
 #ifdef IN_RING3
+
 /**
  * PDM USB Device API.
@@ -570 +573 @@
      */
     DECLR3CALLBACKMEMBER(VMSTATE, pfnVMState, (PPDMUSBINS pUsbIns));
+
+    /**
+     * Set up asynchronous handling of a suspend or power off notification.
+     *
+     * This shall only be called when getting the notification.  It must be called
+     * for each one.
+     *
+     * @returns VBox status code.
+     * @param   pUSBIns             The USB device instance.
+     * @param   pfnAsyncNotify      The callback.
+     * @thread  EMT(0)
+     */
+    DECLR3CALLBACKMEMBER(int, pfnSetAsyncNotification, (PPDMUSBINS pUSbIns, PFNPDMUSBASYNCNOTIFY pfnAsyncNotify));
 
     /** Just a safety precaution. */
@@ -607 +623 @@
         PDMUSBINSINT            s;
 #endif
-        uint8_t                 padding[HC_ARCH_BITS == 32 ? 64 : 96];
+        uint8_t                 padding[HC_ARCH_BITS == 32 ? 96 : 128];
     } Internal;