Changeset 17ceb72 in mainline for uspace/drv/uhci-hcd/uhci_hc.h

Timestamp:

2011-03-14T01:39:44Z (14 years ago)

Author:

Jan Vesely <jano.vesely@…>

Branches:

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

Children:

6298d80

Parents:

3bd96bb

Message:

Doxygen

File:

• uspace/drv/uhci-hcd/uhci_hc.h (modified) (3 diffs)

uspace/drv/uhci-hcd/uhci_hc.h

@@ -27 +27 @@
  */
 
-/** @addtogroup drvusbuhci
+/** @addtogroup drvusbuhcihc
  * @{
  */
 /** @file
- * @brief UHCI driver
+ * @brief UHCI host controller driver structure
  */
 #ifndef DRV_UHCI_UHCI_HC_H
@@ -103 +103 @@
 } uhci_hc_t;
 
-/* init uhci specifics in device.driver_data */
 int uhci_hc_init(uhci_hc_t *instance, ddf_fun_t *fun, void *regs, size_t reg_size);
-
-static inline void uhci_hc_fini(uhci_hc_t *instance) { /* TODO: implement*/ };
 
 int uhci_hc_schedule(uhci_hc_t *instance, batch_t *batch);
@@ -112 +109 @@
 void uhci_hc_interrupt(uhci_hc_t *instance, uint16_t status);
 
+/** Safely dispose host controller internal structures
+ *
+ * @param[in] instance Host controller structure to use.
+ */
+static inline void uhci_hc_fini(uhci_hc_t *instance) { /* TODO: implement*/ };
+
+/** Get and cast pointer to the driver data
+ *
+ * @param[in] fun DDF function pointer
+ * @return cast pointer to driver_data
+ */
 static inline uhci_hc_t * fun_to_uhci_hc(ddf_fun_t *fun)
         { return (uhci_hc_t*)fun->driver_data; }