Changeset 15075 in vbox for trunk/include/VBox

Timestamp:

Dec 8, 2008 3:06:50 AM (16 years ago)

Author:

vboxsync

Message:

Added interfaces for shared USB timer, currently mostly disabled.

Location:

trunk/include/VBox

Files:

• pdmifs.h (modified) (1 diff)
• vusb.h (modified) (2 diffs)

trunk/include/VBox/pdmifs.h

@@ -152 +152 @@
     PDMINTERFACE_VUSB_RH_CONFIG,
 
-    /** VUSBROOTHUBCONNECTOR    - VUSB Device interface.                (Up)     No coupling. */
+    /** VUSBIDEVICE             - VUSB Device interface.                (Up)     No coupling. */
     PDMINTERFACE_VUSB_DEVICE,
+
+    /** VUSBITIMER              - VUSB Timer interface.                 (Up)     No coupling. */
+    PDMINTERFACE_VUSB_TIMER,
 
     /** PDMIHOSTPARALLELPORT    - The Host Parallel port interface.     (Down)   Coupled with PDMINTERFACE_HOST_PARALLEL_CONNECTOR. */

trunk/include/VBox/vusb.h

@@ -330 +330 @@
 typedef struct VUSBIROOTHUBPORT *PVUSBIROOTHUBPORT;
 
+/** Pointer to a VBox USB timer interface. */
+typedef struct VUSBITIMER       *PVUSBITIMER;
+
 /** Pointer to an USB request descriptor. */
 typedef struct VUSBURB          *PVUSBURB;
@@ -760 +763 @@
 {
     return pInterface->pfnGetState(pInterface);
+}
+#endif /* IN_RING3 */
+
+
+/**
+ * USB Timer Interface.
+ */
+typedef struct VUSBITIMER
+{
+    /**
+     * Sets up initial frame timer parameters.
+     *
+     * @returns VBox status code.
+     * @param   pInterface      Pointer to the timer interface structure.
+     * @param   pfnCallback     Pointer to the timer callback function.
+     * @param   rate            Requested frame rate (normally 1,000).
+     */
+    DECLR3CALLBACKMEMBER(int, pfnTimerSetup,(PVUSBITIMER pInterface, PFNTMTIMERDEV pfnCallback, uint32_t rate));
+
+    /**
+     * Requests another tick of the frame timer.
+     *
+     * @returns VBox status code.
+     * @param   pInterface      Pointer to the timer interface structure.
+     */
+    DECLR3CALLBACKMEMBER(int, pfnTimerSetNext,(PVUSBITIMER pInterface));
+
+    /**
+     * Stops the frame timer for the caller.
+     *
+     * @returns VBox status code.
+     * @param   pInterface      Pointer to the timer interface structure.
+     */
+    DECLR3CALLBACKMEMBER(int, pfnTimerStop,(PVUSBITIMER pInterface));
+
+} VUSBITIMER;
+
+
+#ifdef IN_RING3
+/**
+ * Sets up initial frame timer parameters.
+ *
+ * @returns VBox status code.
+ * @param   pInterface      Pointer to the timer interface structure.
+ * @param   pfnCallback     Pointer to the timer callback function.
+ * @param   rate            Requested frame rate (normally 1,000).
+ */
+DECLINLINE(int) VUSBITimerSetup(PVUSBITIMER pInterface, PFNTMTIMERDEV pfnCallback, uint32_t rate)
+{
+    return pInterface->pfnTimerSetup(pInterface, pfnCallback, rate);
+}
+
+/**
+ * Requests another tick of the USB frame timer.
+ *
+ * @returns VBox status code.
+ * @param   pInterface      Pointer to the timer interface structure.
+ */
+DECLINLINE(int) VUSBITimerSetNext(PVUSBITIMER pInterface)
+{
+    return pInterface->pfnTimerSetNext(pInterface);
+}
+
+/**
+ * Stops the USB frame timer for the caller.
+ *
+ * @returns VBox status code.
+ * @param   pInterface      Pointer to the timer interface structure.
+ */
+DECLINLINE(int) VUSBITimerStop(PVUSBITIMER pInterface)
+{
+    return pInterface->pfnTimerStop(pInterface);
 }
 #endif /* IN_RING3 */