Changeset 58340 in vbox for trunk/src/VBox/HostDrivers/VBoxUSB/solaris

Timestamp:

Oct 20, 2015 1:58:41 PM (10 years ago)

Author:

vboxsync

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

103540

Message:

HostDrivers: Doxygen fixes

Location:

trunk/src/VBox/HostDrivers/VBoxUSB/solaris

Files:

• VBoxUSB-solaris.c (modified) (9 diffs)
• VBoxUSBMon-solaris.c (modified) (5 diffs)

trunk/src/VBox/HostDrivers/VBoxUSB/solaris/VBoxUSB-solaris.c

@@ -330 +330 @@
 LOCAL bool vboxUSBSolarisIsUSBDevice(dev_info_t *pDip);
 
-/** Device Operation Hooks */
+/** @name Device Operation Hooks
+ * @{ */
 LOCAL int vboxUSBSolarisSendURB(vboxusb_state_t *pState, PVBOXUSBREQ_URB pUrbReq, int Mode);
 LOCAL int vboxUSBSolarisReapURB(vboxusb_state_t *pState, PVBOXUSBREQ_URB pUrbReq, int Mode);
@@ -340 +341 @@
 LOCAL int vboxUSBSolarisAbortPipe(vboxusb_state_t *pState, uint8_t bEndpoint);
 LOCAL int vboxUSBSolarisGetConfigIndex(vboxusb_state_t *pState, uint_t uCfgValue);
-
-/** Hotplug & Power Management Hooks */
+/** @} */
+
+/** @name Hotplug & Power Management Hooks
+ * @{ */
 LOCAL inline void vboxUSBSolarisNotifyHotplug(vboxusb_state_t *pState);
 LOCAL int vboxUSBSolarisDeviceDisconnected(dev_info_t *pDip);
@@ -353 +356 @@
 LOCAL void vboxUSBSolarisPowerBusy(vboxusb_state_t *pState);
 LOCAL void vboxUSBSolarisPowerIdle(vboxusb_state_t *pState);
-
-/** Monitor Hooks */
+/** @} */
+
+/** @name Monitor Hooks
+ * @{ */
 int VBoxUSBMonSolarisRegisterClient(dev_info_t *pClientDip, PVBOXUSB_CLIENT_INFO pClientInfo);
 int VBoxUSBMonSolarisUnregisterClient(dev_info_t *pClientDip);
-
-/** Callbacks from Monitor */
+/** @} */
+
+/** @name Callbacks from Monitor
+ * @{ */
 LOCAL int vboxUSBSolarisSetConsumerCredentials(RTPROCESS Process, int Instance, void *pvReserved);
+/** @} */
 
 
@@ -1551 +1559 @@
  * Convert Solaris' USBA device state to VBox's error code.
  *
- * @param   UsbRc           Solaris USBA error code.
+ * @param   uDeviceState        The USB device state to convert.
  *
  * @returns VBox error code.
@@ -2060 +2068 @@
  *
  * @param   pState          The USB device instance.
- * @param   uCfgValue       The Configuration value.
+ * @param   bCfgValue       The Configuration value.
  *
  * @returns VBox error code.
@@ -2216 +2224 @@
  *
  * @param   pState          The USB device instance.
- * @param   ResetLevel      The reset level.
+ * @param   enmReset        The reset level.
  *
  * @returns VBox error code.
@@ -2350 +2358 @@
  * @param   pEpData         The Endpoint data.
  * @param   uCfgValue       The Configuration value.
- * @param   uCfgIndex       The Configuration index.
  * @param   uInterface      The Interface.
  * @param   uAlt            The Alternate setting.
@@ -2357 +2364 @@
  */
 LOCAL int vboxUSBSolarisInitEndPoint(vboxusb_state_t *pState, usb_ep_data_t *pEpData, uchar_t uCfgValue,
-                                uchar_t uInterface, uchar_t uAlt)
+                                     uchar_t uInterface, uchar_t uAlt)
 {
     LogFunc((DEVICE_NAME ":vboxUSBSolarisInitEndPoint pState=%p pEpData=%p CfgVal=%d Iface=%d Alt=%d", pState,
@@ -2815 +2822 @@
  *
  * @param   pState          The USB device instance.
- * @param   pUrb            The URB to initialize.
  * @param   pUrbReq         Opaque pointer to the complete request.
- * @param   pMsg            Pointer to the allocated request data.
  *
  * @returns The allocated Isoc. In URB to be used.

trunk/src/VBox/HostDrivers/VBoxUSB/solaris/VBoxUSBMon-solaris.c

@@ -669 +669 @@
  *
  * @param   iFunction           The requested function.
- * @param   pvState             Opaque pointer to driver state used for getting ring-3 process (Id).
- * @param   pvData              The input/output data buffer. Can be NULL depending on the function.
+ * @param   pvState             Opaque pointer to driver state used for getting
+ *                              ring-3 process (Id).
+ * @param   pvData              The input/output data buffer. Can be NULL
+ *                              depending on the function.
  * @param   cbData              The max size of the data buffer.
- * @param   pcbDataReturned     Where to store the amount of returned data. Can be NULL.
+ * @param   pcbReturnedData     Where to store the amount of returned data.  Can
+ *                              be NULL.
  */
 static int vboxUSBMonSolarisProcessIOCtl(int iFunction, void *pvState, void *pvData, size_t cbData, size_t *pcbReturnedData)
@@ -904 +907 @@
  *
  * @returns VBox status code.
- * @param   pszDevicePath       The device path of the client driver.
- * @param   Instance            The client driver instance.
  */
 int VBoxUSBMonSolarisRegisterClient(dev_info_t *pClientDip, PVBOXUSB_CLIENT_INFO pClientInfo)
@@ -933 +934 @@
             return VINF_SUCCESS;
         }
-        else
-            return VERR_NO_MEMORY;
-    }
-    else
-        return VERR_INVALID_STATE;
+        return VERR_NO_MEMORY;
+    }
+    return VERR_INVALID_STATE;
 }
 
@@ -945 +944 @@
  *
  * @returns VBox status code.
- * @param   pszDevicePath       The device path of the client driver.
- * @param   Instance            The client driver instance.
  */
 int VBoxUSBMonSolarisUnregisterClient(dev_info_t *pClientDip)
@@ -985 +982 @@
         return VERR_NOT_FOUND;
     }
-    else
-        return VERR_INVALID_STATE;
+    return VERR_INVALID_STATE;
 }