Changeset f7ac3f3 in mainline for uspace/drv/bus/usb/uhci/uhci_batch.h

Timestamp:

2011-12-06T12:46:52Z (13 years ago)

Author:

Jan Vesely <jano.vesely@…>

Branches:

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

Children:

6fa04db

Parents:

ad91b806

Message:

uhci: Doxygen

File:

• uspace/drv/bus/usb/uhci/uhci_batch.h (modified) (4 diffs)

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

@@ -64 +64 @@
 bool uhci_transfer_batch_is_complete(const uhci_transfer_batch_t *uhci_batch);
 
+/** Get offset to setup buffer accessible to the HC hw.
+ * @param uhci_batch UHCI batch structure.
+ * @return Pointer to the setup buffer.
+ */
 static inline void * uhci_transfer_batch_setup_buffer(
     const uhci_transfer_batch_t *uhci_batch)
@@ -73 +77 @@
 }
 /*----------------------------------------------------------------------------*/
+/** Get offset to data buffer accessible to the HC hw.
+ * @param uhci_batch UHCI batch structure.
+ * @return Pointer to the data buffer.
+ */
 static inline void * uhci_transfer_batch_data_buffer(
     const uhci_transfer_batch_t *uhci_batch)
@@ -82 +90 @@
 }
 /*----------------------------------------------------------------------------*/
-static inline void uhci_transfer_batch_abort(
-    uhci_transfer_batch_t *uhci_batch)
+/** Aborts the batch.
+ * Sets error to EINTR and size off transferd data to 0, before finishing the
+ * batch.
+ * @param uhci_batch Batch to abort.
+ */
+static inline void uhci_transfer_batch_abort(uhci_transfer_batch_t *uhci_batch)
 {
         assert(uhci_batch);
@@ -92 +104 @@
 }
 /*----------------------------------------------------------------------------*/
+/** Linked list conversion wrapper.
+ * @param l Linked list link.
+ * @return Pointer to the uhci batch structure.
+ */
 static inline uhci_transfer_batch_t *uhci_transfer_batch_from_link(link_t *l)
 {