Changeset 28d9c95 in mainline for uspace/drv/uhci-hcd/batch.c

Timestamp:

2011-05-17T12:21:55Z (14 years ago)

Author:

Jan Vesely <jano.vesely@…>

Branches:

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

Children:

d736fe38

Parents:

5f94a0c

Message:

Cleanup, add normal and doxygen comments

File:

• uspace/drv/uhci-hcd/batch.c (modified) (3 diffs)

uspace/drv/uhci-hcd/batch.c

@@ -45 +45 @@
 #define DEFAULT_ERROR_COUNT 3
 
+/** UHCI specific data required for USB transfer */
 typedef struct uhci_transfer_batch {
+        /** Queue head
+         * This QH is used to maintain UHCI schedule structure and the element
+         * pointer points to the first TD of this batch.
+         */
         qh_t *qh;
+        /** List of TDs needed for the transfer */
         td_t *tds;
+        /** Number of TDs used by the transfer */
+        size_t td_count;
+        /** Data buffer, must be accessible by the UHCI hw */
         void *device_buffer;
-        size_t td_count;
 } uhci_transfer_batch_t;
 /*----------------------------------------------------------------------------*/
-static void uhci_transfer_batch_dispose(void *uhci_batch)
-{
-        uhci_transfer_batch_t *instance = uhci_batch;
-        assert(instance);
-        free32(instance->device_buffer);
-        free(instance);
-}
-/*----------------------------------------------------------------------------*/
-
 static void batch_control(usb_transfer_batch_t *instance,
     usb_packet_id data_stage, usb_packet_id status_stage);
 static void batch_data(usb_transfer_batch_t *instance, usb_packet_id pid);
-
+/*----------------------------------------------------------------------------*/
+/** Safely destructs uhci_transfer_batch_t structure
+ *
+ * @param[in] uhci_batch Instance to destroy.
+ */
+static void uhci_transfer_batch_dispose(void *uhci_batch)
+{
+        uhci_transfer_batch_t *instance = uhci_batch;
+        assert(instance);
+        free32(instance->device_buffer);
+        free(instance);
+}
+/*----------------------------------------------------------------------------*/
 /** Allocate memory and initialize internal data structure.
  *
@@ -173 +184 @@
                 instance->error = td_status(&data->tds[i]);
                 if (instance->error != EOK) {
-                        usb_log_debug("Batch(%p) found error TD(%zu):%" PRIx32 ".\n",
-                            instance, i, data->tds[i].status);
+                        usb_log_debug("Batch(%p) found error TD(%zu):%"
+                            PRIx32 ".\n", instance, i, data->tds[i].status);
                         td_print_status(&data->tds[i]);
 
@@ -397 +408 @@
 /*----------------------------------------------------------------------------*/
 /** Provides access to QH data structure.
+ *
  * @param[in] instance Batch pointer to use.
  * @return Pointer to the QH used by the batch.