Changeset af4e464e in mainline for uspace/drv/bus/usb/uhci/uhci_rh.h

Timestamp:

2013-02-08T13:05:54Z (12 years ago)

Author:

Jan Vesely <jano.vesely@…>

Branches:

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

Children:

711f5fb8

Parents:

4c86c7c

Message:

uhci: Cleanup.

include guard, doxygen, line wrap.

File:

• uspace/drv/bus/usb/uhci/uhci_rh.h (modified) (3 diffs)

uspace/drv/bus/usb/uhci/uhci_rh.h

@@ -33 +33 @@
  * @brief UHCI host controller driver structure
  */
-#ifndef DRV_UHCI_RHVIRT_H
-#define DRV_UHCI_RHVIRT_H
+#ifndef DRV_UHCI_UHCI_RH_H
+#define DRV_UHCI_UHCI_RH_H
 
 #include <usbvirt/virthub_base.h>
@@ -42 +42 @@
 #define HUB_STATUS_CHANGE_PIPE   1
 
-
+/** Virtual to UHCI hub connector */
 typedef struct {
+        /** Virtual hub software implementation */
         virthub_base_t base;
+        /** UHCI root hub port io registers */
         ioport16_t *ports[2];
+        /** Reset change indicator, it is not reported by regs */
         bool reset_changed[2];
 } uhci_rh_t;
@@ -51 +54 @@
 int uhci_rh_init(uhci_rh_t *instance, ioport16_t *ports, const char *name);
 int uhci_rh_schedule(uhci_rh_t *instance, usb_transfer_batch_t *batch);
+
+/** Get UHCI rh address.
+ *
+ * @param instance UHCI rh instance.
+ * @return USB address assigned to the hub.
+ * Wrapper for virtual hub address
+ */
 static inline usb_address_t uhci_rh_get_address(uhci_rh_t *instance)
 {