Changeset 69df9373 in mainline for uspace/drv/usbhub/ports.h

Timestamp:

2011-04-07T12:14:21Z (14 years ago)

Author:

Vojtech Horky <vojtechhorky@…>

Branches:

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

Children:

a82889e, c1b1944

Parents:

c50941f

Message:

Add missing documentation

File:

• uspace/drv/usbhub/ports.h (modified) (1 diff)

uspace/drv/usbhub/ports.h

@@ -46 +46 @@
 #include <usb/devdrv.h>
 
+/** Information about single port on a hub. */
 typedef struct {
+        /** Mutex needed by CV for checking port reset. */
         fibril_mutex_t reset_mutex;
+        /** CV for waiting to port reset completion. */
         fibril_condvar_t reset_cv;
+        /** Whether port reset is completed.
+         * Guarded by @c reset_mutex.
+         */
+        bool reset_completed;
+
+        /** Information about attached device. */
         usb_hc_attached_device_t attached_device;
-        bool reset_completed;
 } usb_hub_port_t;
 
+/** Initialize hub port information.
+ *
+ * @param port Port to be initialized.
+ */
 static inline void usb_hub_port_init(usb_hub_port_t *port) {
         port->attached_device.address = -1;