Changeset 70e5ad5 in mainline for uspace/drv/vhc/hub/virthub.c

Timestamp:

2010-12-16T11:12:31Z (13 years ago)

Author:

Vojtech Horky <vojtechhorky@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

11658b64, 5863a95

Parents:

cea3fca

Message:

More doxygen comments

File:

• uspace/drv/vhc/hub/virthub.c (modified) (7 diffs)

uspace/drv/vhc/hub/virthub.c

@@ -72 +72 @@
 };
 
+/** Hub descriptor. */
 hub_descriptor_t hub_descriptor = {
         .length = sizeof(hub_descriptor_t),
@@ -140 +141 @@
 };
 
+/** Initializes virtual hub device.
+ *
+ * @param dev Virtual USB device backend.
+ * @return Error code.
+ */
 int virthub_init(usbvirt_device_t *dev)
 {
@@ -163 +169 @@
 }
 
+/** Connect a device to a virtual hub.
+ *
+ * @param dev Virtual device representing the hub.
+ * @param conn Device to be connected.
+ * @return Port device was connected to.
+ */
 int virthub_connect_device(usbvirt_device_t *dev, virtdev_connection_t *conn)
 {
@@ -177 +189 @@
 }
 
+/** Disconnect a device from a virtual hub.
+ *
+ * @param dev Virtual device representing the hub.
+ * @param conn Device to be disconnected.
+ * @return Error code.
+ */
 int virthub_disconnect_device(usbvirt_device_t *dev, virtdev_connection_t *conn)
 {
@@ -185 +203 @@
 
         hub_acquire(hub);
+        /* TODO: implement. */
         hub_release(hub);
 
@@ -190 +209 @@
 }
 
+/** Whether trafic is propagated to given device.
+ *
+ * @param dev Virtual device representing the hub.
+ * @param conn Connected device.
+ * @return Whether port is signalling to the device.
+ */
 bool virthub_is_device_enabled(usbvirt_device_t *dev, virtdev_connection_t *conn)
 {
@@ -209 +234 @@
 }
 
+/** Format status of a virtual hub.
+ *
+ * @param dev Virtual device representing the hub.
+ * @param[out] status Hub status information.
+ * @param[in] len Size of the @p status buffer.
+ */
 void virthub_get_status(usbvirt_device_t *dev, char *status, size_t len)
 {