Changeset 4c70554 in mainline

Timestamp:

2011-04-13T19:06:11Z (14 years ago)

Author:

Jan Vesely <jano.vesely@…>

Branches:

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

Children:

9d2d444

Parents:

a0a134b

Message:

Refactoring, doxygen

Remove queue_head_pa, it was not really needed as this value was use exactly once for every list.
qh_set_next_qh accepts virtual address and does the conversion internally.
Removed unused qh function

Location:

uspace/drv/uhci-hcd

Files:

• hc.c (modified) (2 diffs)
• hw_struct/queue_head.h (modified) (2 diffs)
• transfer_list.c (modified) (11 diffs)
• transfer_list.h (modified) (1 diff)

uspace/drv/uhci-hcd/hc.c

@@ -228 +228 @@
         /* Set all frames to point to the first queue head */
         const uint32_t queue =
-          instance->transfers_interrupt.queue_head_pa
-          | LINK_POINTER_QUEUE_HEAD_FLAG;
+            LINK_POINTER_QH(addr_to_phys(
+                instance->transfers_interrupt.queue_head));
 
         unsigned i = 0;
@@ -236 +236 @@
         }
 
-        /* Init device keeper*/
+        /* Init device keeper */
         usb_device_keeper_init(&instance->manager);
         usb_log_debug("Initialized device manager.\n");

uspace/drv/uhci-hcd/hw_struct/queue_head.h

@@ -34 +34 @@
 #ifndef DRV_UHCI_QH_H
 #define DRV_UHCI_QH_H
-
-/* libc */
 #include <assert.h>
 
 #include "link_pointer.h"
+#include "utils/malloc32.h"
 
 typedef struct queue_head {
@@ -67 +66 @@
  * NULL.
  */
-static inline void qh_set_next_qh(qh_t *instance, uint32_t pa)
+static inline void qh_set_next_qh(qh_t *instance, qh_t *next)
 {
         /* Address is valid and not terminal */
-        if (pa && ((pa & LINK_POINTER_TERMINATE_FLAG) == 0)) {
+        uint32_t pa = addr_to_phys(next);
+        if (pa) {
                 instance->next = LINK_POINTER_QH(pa);
         } else {
                 instance->next = LINK_POINTER_TERM;
-        }
-}
-/*----------------------------------------------------------------------------*/
-/** Set queue head element pointer
- *
- * @param[in] instance qh_t structure to initialize.
- * @param[in] pa Physical address of the next queue head.
- *
- * Adds proper flag. If the pointer is NULL or terminal, sets element
- * to terminal NULL.
- */
-static inline void qh_set_element_qh(qh_t *instance, uint32_t pa)
-{
-        /* Address is valid and not terminal */
-        if (pa && ((pa & LINK_POINTER_TERMINATE_FLAG) == 0)) {
-                instance->element = LINK_POINTER_QH(pa);
-        } else {
-                instance->element = LINK_POINTER_TERM;
         }
 }

uspace/drv/uhci-hcd/transfer_list.c

@@ -57 +57 @@
                 return ENOMEM;
         }
-        instance->queue_head_pa = addr_to_phys(instance->queue_head);
+        uint32_t queue_head_pa = addr_to_phys(instance->queue_head);
         usb_log_debug2("Transfer list %s setup with QH: %p(%p).\n",
-            name, instance->queue_head, instance->queue_head_pa);
+            name, instance->queue_head, queue_head_pa);
 
         qh_init(instance->queue_head);
@@ -67 +67 @@
 }
 /*----------------------------------------------------------------------------*/
+/** Dispose transfer list structures.
+ *
+ * @param[in] instance Memory place to use.
+ *
+ * Frees memory for internal qh_t structure.
+ */
+void transfer_list_fini(transfer_list_t *instance)
+{
+        assert(instance);
+        free32(instance->queue_head);
+}
 /** Set the next list in transfer list chain.
  *
@@ -81 +92 @@
         if (!instance->queue_head)
                 return;
-        /* Set both queue_head.next to point to the follower */
-        qh_set_next_qh(instance->queue_head, next->queue_head_pa);
-}
-/*----------------------------------------------------------------------------*/
-/** Submit transfer batch to the list and queue.
+        /* Set queue_head.next to point to the follower */
+        qh_set_next_qh(instance->queue_head, next->queue_head);
+}
+/*----------------------------------------------------------------------------*/
+/** Add transfer batch to the list and queue.
  *
  * @param[in] instance List to use.
  * @param[in] batch Transfer batch to submit.
- * @return Error code
  *
  * The batch is added to the end of the list and queue.
@@ -109 +119 @@
         } else {
                 /* There is something scheduled */
-                usb_transfer_batch_t *last = list_get_instance(
-                    instance->batch_list.prev, usb_transfer_batch_t, link);
+                usb_transfer_batch_t *last =
+                    usb_transfer_batch_from_link(instance->batch_list.prev);
                 last_qh = batch_qh(last);
         }
@@ -118 +128 @@
         /* keep link */
         batch_qh(batch)->next = last_qh->next;
-        qh_set_next_qh(last_qh, pa);
+        qh_set_next_qh(last_qh, batch_qh(batch));
 
         asm volatile ("": : :"memory");
@@ -132 +142 @@
 }
 /*----------------------------------------------------------------------------*/
-/** Create list for finished batches.
+/** Add completed bantches to the provided list.
  *
  * @param[in] instance List to use.
@@ -147 +157 @@
                 link_t *next = current->next;
                 usb_transfer_batch_t *batch =
-                    list_get_instance(current, usb_transfer_batch_t, link);
+                    usb_transfer_batch_from_link(current);
 
                 if (batch_is_complete(batch)) {
-                        /* Save for post-processing */
+                        /* Save for processing */
                         transfer_list_remove_batch(instance, batch);
                         list_append(current, done);
@@ -159 +169 @@
 }
 /*----------------------------------------------------------------------------*/
-/** Walk the list and abort all batches.
+/** Walk the list and finish all batches with EINTR.
  *
  * @param[in] instance List to use.
@@ -169 +179 @@
                 link_t *current = instance->batch_list.next;
                 usb_transfer_batch_t *batch =
-                    list_get_instance(current, usb_transfer_batch_t, link);
+                    usb_transfer_batch_from_link(current);
                 transfer_list_remove_batch(instance, batch);
-                usb_transfer_batch_finish_error(batch, EIO);
+                usb_transfer_batch_finish_error(batch, EINTR);
         }
         fibril_mutex_unlock(&instance->guard);
@@ -180 +190 @@
  * @param[in] instance List to use.
  * @param[in] batch Transfer batch to remove.
- * @return Error code
  *
  * Does not lock the transfer list, caller is responsible for that.
@@ -197 +206 @@
 
         const char *qpos = NULL;
+        qh_t *prev_qh = NULL;
         /* Remove from the hardware queue */
         if (instance->batch_list.next == &batch->link) {
                 /* I'm the first one here */
-                assert((instance->queue_head->next & LINK_POINTER_ADDRESS_MASK)
-                    == addr_to_phys(batch_qh(batch)));
-                instance->queue_head->next = batch_qh(batch)->next;
+                prev_qh = instance->queue_head;
                 qpos = "FIRST";
         } else {
+                /* The thing before me is a batch too */
                 usb_transfer_batch_t *prev =
-                    list_get_instance(
-                        batch->link.prev, usb_transfer_batch_t, link);
-                assert((batch_qh(prev)->next & LINK_POINTER_ADDRESS_MASK)
-                    == addr_to_phys(batch_qh(batch)));
-                batch_qh(prev)->next = batch_qh(batch)->next;
+                    usb_transfer_batch_from_link(batch->link.prev);
+                prev_qh = batch_qh(prev);
                 qpos = "NOT FIRST";
         }
+        assert((prev_qh->next & LINK_POINTER_ADDRESS_MASK)
+            == addr_to_phys(batch_qh(batch)));
+        prev_qh->next = batch_qh(batch)->next;
         asm volatile ("": : :"memory");
         /* Remove from the batch list */
         list_remove(&batch->link);
-        usb_log_debug("Batch(%p) removed (%s) from %s, next %x.\n",
+        usb_log_debug("Batch(%p) removed (%s) from %s, next: %x.\n",
             batch, qpos, instance->name, batch_qh(batch)->next);
 }

uspace/drv/uhci-hcd/transfer_list.h

@@ -39 +39 @@
 #include "batch.h"
 #include "hw_struct/queue_head.h"
-#include "utils/malloc32.h"
 
+/** Structure maintaining both hw queue and software list
+ * of currently executed transfers
+ */
 typedef struct transfer_list
 {
+        /** Guard against multiple add/remove races */
         fibril_mutex_t guard;
+        /** UHCI hw structure represeting this queue */
         qh_t *queue_head;
-        uint32_t queue_head_pa;
+        /** Assigned name, for nicer debug output */
         const char *name;
+        /** List of all batches in this list */
         link_t batch_list;
 } transfer_list_t;
 
-/** 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)
-{
-        assert(instance);
-        free32(instance->queue_head);
-}
-
+void transfer_list_fini(transfer_list_t *instance);
 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_add_batch(transfer_list_t *instance, usb_transfer_batch_t *batch);
-
+void transfer_list_add_batch(
+    transfer_list_t *instance, usb_transfer_batch_t *batch);
 void transfer_list_remove_finished(transfer_list_t *instance, link_t *done);
-
 void transfer_list_abort_all(transfer_list_t *instance);
 #endif