Changeset 59700 in vbox for trunk/include/VBox

Timestamp:

Feb 16, 2016 12:18:30 PM (9 years ago)

Author:

vboxsync

Message:

VUSB: Some structural cleanup (#2 Remove the HCI specific bits from the VUSBURB structure and let each controller manage it by itself just telling the root hub how much space it needs for each URB)

File:

• trunk/include/VBox/vusb.h (modified) (9 diffs)

trunk/include/VBox/vusb.h

@@ -647 +647 @@
 } VUSBIROOTHUBPORT;
 /** VUSBIROOTHUBPORT interface ID. */
-#define VUSBIROOTHUBPORT_IID                    "e38e2978-7aa2-4860-94b6-9ef4a066d8a0"
+#define VUSBIROOTHUBPORT_IID                    "79a31188-043d-432c-82ac-9485c9ab9a49"
 
 /** Pointer to a VUSB RootHub connector interface. */
@@ -658 +658 @@
 typedef struct VUSBIROOTHUBCONNECTOR
 {
+    /**
+     * Sets the URB parameters for the caller.
+     *
+     * @returns VBox status code.
+     * @param   pInterface  Pointer to this struct.
+     * @param   cbHci       Size of the data private to the HCI for each URB when allocated.
+     * @param   cbHciTd     Size of one transfer descriptor. The number of transfer descriptors
+     *                      is given VUSBIROOTHUBCONNECTOR::pfnNewUrb for each URB to calculate the
+     *                      final amount of memory required for the TDs.
+     *
+     * @note This must be called before starting to allocate any URB or otherwise there will be no
+     *       data available for the HCI.
+     */
+    DECLR3CALLBACKMEMBER(int, pfnSetUrbParams, (PVUSBIROOTHUBCONNECTOR pInterface, size_t cbHci, size_t cbHciTd));
+
     /**
      * Allocates a new URB for a transfer.
@@ -763 +778 @@
 } VUSBIROOTHUBCONNECTOR;
 /** VUSBIROOTHUBCONNECTOR interface ID. */
-#define VUSBIROOTHUBCONNECTOR_IID               "dba1a54e-9708-4702-8d7f-b9ac94dc17e6"
+#define VUSBIROOTHUBCONNECTOR_IID               "481d7f23-f180-4fde-b636-094253eaf537"
 
 
 #ifdef IN_RING3
+/** @copydoc VUSBIROOTHUBCONNECTOR::pfnSetUrbParams */
+DECLINLINE(int) VUSBIRhSetUrbParams(PVUSBIROOTHUBCONNECTOR pInterface, size_t cbHci, size_t cbHciTd)
+{
+    return pInterface->pfnSetUrbParams(pInterface, cbHci, cbHciTd);
+}
+
 /** @copydoc VUSBIROOTHUBCONNECTOR::pfnNewUrb */
 DECLINLINE(PVUSBURB) VUSBIRhNewUrb(PVUSBIROOTHUBCONNECTOR pInterface, uint32_t DstAddress, VUSBXFERTYPE enmType,
@@ -927 +948 @@
 } VUSBIDEVICE;
 /** VUSBIDEVICE interface ID. */
-#define VUSBIDEVICE_IID                         "f3facb2b-edd3-4b5b-b07e-2cc4d52a471e"
+#define VUSBIDEVICE_IID                         "79a31188-043d-432c-82ac-9485c9ab9a49"
 
 
@@ -1090 +1111 @@
 typedef const VUSBURBISOCPKT *PCVUSBURBISOCPKT;
 
+/** Private controller emulation specific data for the associated USB request descriptor. */
+typedef struct VUSBURBHCIINT *PVUSBURBHCI;
+/** Private controller emulation specific TD data. */
+typedef struct VUSBURBHCITDINT *PVUSBURBHCITD;
+
 /**
  * Asynchronous USB request descriptor
@@ -1129 +1155 @@
          * This may be NULL if the destination address is invalid. */
         struct VUSBDEV *pDev;
-        /** Sepcific to the pfnFree function. */
+        /** Specific to the pfnFree function. */
         void           *pvFreeCtx;
         /**
@@ -1140 +1166 @@
         /** The allocated data length. */
         uint32_t        cbDataAllocated;
-        /** The allocated TD length. */
-        uint32_t        cTdsAllocated;
+        /** Opaque data holder when this is a read-ahead URB. */
+        void            *pvReadAhead;
     } VUsb;
 
-    /** The host controller data. */
-    struct VUSBURBHCI
-    {
-        /** The endpoint descriptor address. */
-        RTGCPHYS32      EdAddr;
-        /** Number of Tds in the array. */
-        uint32_t        cTds;
-        /** Pointer to an array of TD info items.*/
-        struct VUSBURBHCITD
-        {
-            /** Type of TD (private) */
-            uint32_t        TdType;
-            /** The address of the */
-            RTGCPHYS32      TdAddr;
-            /** A copy of the TD. */
-            uint32_t        TdCopy[16];
-        }              *paTds;
-        /** URB chain pointer. */
-        PVUSBURB        pNext;
-        /** When this URB was created.
-         * (Used for isochronous frames and for logging.) */
-        uint32_t        u32FrameNo;
-        /** Flag indicating that the TDs have been unlinked. */
-        bool            fUnlinked;
-    } Hci;
+    /** Private host controller data associated with this URB. */
+    PVUSBURBHCI         pHci;
+    /** Pointer to the host controller transfer descriptor array. */
+    PVUSBURBHCITD       paTds;
 
     /** The device data. */
@@ -1179 +1184 @@
     } Dev;
 
-#ifndef RDESKTOP
-    /** The USB device instance this belongs to.
-     * This is NULL if the device address is invalid, in which case this belongs to the hub. */
-    PPDMUSBINS      pUsbIns;
-#endif
     /** The device address.
      * This is set at allocation time. */
@@ -1193 +1193 @@
     uint8_t         EndPt;
     /** The transfer type.
-     * IN: Must be set before submitting the URB. */
+     * IN: Set at allocation time. */
     VUSBXFERTYPE    enmType;
     /** The transfer direction.
-     * IN: Must be set before submitting the URB. */
+     * IN: Set at allocation time. */
     VUSBDIRECTION   enmDir;
     /** Indicates whether it is OK to receive/send less data than requested.