Changeset a7e2f0d in mainline for uspace/drv/uhci-hcd/uhci_struct/transfer_descriptor.c

Timestamp:

2011-03-07T18:57:00Z (14 years ago)

Author:

Jan Vesely <jano.vesely@…>

Branches:

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

Children:

18e9eeb

Parents:

0d3167e

Message:

Doxygen and other comments

File:

• uspace/drv/uhci-hcd/uhci_struct/transfer_descriptor.c (modified) (2 diffs)

uspace/drv/uhci-hcd/uhci_struct/transfer_descriptor.c

@@ -38 +38 @@
 #include "utils/malloc32.h"
 
+/** Initializes Transfer Descriptor
+ *
+ * @param[in] instance Memory place to initialize.
+ * @param[in] err_count Number of retries hc should attempt.
+ * @param[in] size Size of data source.
+ * @param[in] toggle Value of toggle bit.
+ * @param[in] iso True if TD is for Isochronous transfer.
+ * @param[in] low_speed Target device's speed.
+ * @param[in] target Address and endpoint receiving the transfer.
+ * @param[in] pid Packet identification (SETUP, IN or OUT).
+ * @param[in] buffer Source of data.
+ * @param[in] next Net TD in transaction.
+ * @return Error code.
+ */
 void td_init(td_t *instance, int err_count, size_t size, bool toggle, bool iso,
-    bool low_speed, usb_target_t target, usb_packet_id pid, void *buffer, td_t *next)
+    bool low_speed, usb_target_t target, usb_packet_id pid, void *buffer,
+    td_t *next)
 {
         assert(instance);
         assert(size < 1024);
-        assert((pid == USB_PID_SETUP) || (pid == USB_PID_IN) || (pid == USB_PID_OUT));
+        assert((pid == USB_PID_SETUP) || (pid == USB_PID_IN)
+            || (pid == USB_PID_OUT));
 
         instance->next = 0
@@ -81 +97 @@
 }
 /*----------------------------------------------------------------------------*/
+/** Converts TD status into standard error code
+ *
+ * @param[in] instance TD structure to use.
+ * @return Error code.
+ */
 int td_status(td_t *instance)
 {