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

Timestamp:

2011-03-14T01:39:44Z (13 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/transfer_list.h (modified) (3 diffs)

uspace/drv/uhci-hcd/transfer_list.h

@@ -26 +26 @@
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
-/** @addtogroup usb
+/** @addtogroup drvusbuhcihc
  * @{
  */
 /** @file
- * @brief UHCI driver
+ * @brief UHCI driver transfer list structure
  */
 #ifndef DRV_UHCI_TRANSFER_LIST_H
@@ -50 +50 @@
 } transfer_list_t;
 
-int transfer_list_init(transfer_list_t *instance, const char *name);
-
-void transfer_list_set_next(transfer_list_t *instance, transfer_list_t *next);
-
+/** Dispose transfer list structures.
+ *
+ * @param[in] instance Memory place to use.
+ *
+ * Frees memory for internal qh_t structure.
+ */
 static inline void transfer_list_fini(transfer_list_t *instance)
 {
@@ -59 +61 @@
         free32(instance->queue_head);
 }
+
+int transfer_list_init(transfer_list_t *instance, const char *name);
+
+void transfer_list_set_next(transfer_list_t *instance, transfer_list_t *next);
+
 void transfer_list_remove_finished(transfer_list_t *instance);