Changeset 4fe3b6d in mainline for uspace/drv/uhci-hcd/batch.c

Timestamp:

2011-05-20T11:07:00Z (14 years ago)

Author:

Matus Dekanek <smekideki@…>

Branches:

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

Children:

8bb61e6

Parents:

3476be8 (diff), 7941bd6 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

merge with development

File:

• uspace/drv/uhci-hcd/batch.c (modified) (5 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.
  *
@@ -70 +81 @@
  * @param[in] ep Communication target
  * @param[in] buffer Data source/destination.
- * @param[in] size Size of the buffer.
+ * @param[in] buffer_size Size of the buffer.
  * @param[in] setup_buffer Setup data source (if not NULL)
  * @param[in] setup_size Size of setup_buffer (should be always 8)
@@ -84 +95 @@
  */
 usb_transfer_batch_t * batch_get(ddf_fun_t *fun, endpoint_t *ep,
-    char *buffer, size_t buffer_size, char* setup_buffer, size_t setup_size,
+    char *buffer, size_t buffer_size,
+    const char* setup_buffer, size_t setup_size,
     usbhc_iface_transfer_in_callback_t func_in,
     usbhc_iface_transfer_out_callback_t func_out, void *arg)
@@ -173 +185 @@
                 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 +409 @@
 /*----------------------------------------------------------------------------*/
 /** Provides access to QH data structure.
+ *
  * @param[in] instance Batch pointer to use.
  * @return Pointer to the QH used by the batch.