Changeset d736fe38 in mainline

Timestamp:

2011-05-17T12:54:02Z (13 years ago)

Author:

Jan Vesely <jano.vesely@…>

Branches:

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

Children:

c7b5826

Parents:

28d9c95

Message:

More comment fixes and code cleanup

Location:

uspace/drv

Files:

• ohci/endpoint_list.c (modified) (6 diffs)
• ohci/endpoint_list.h (modified) (3 diffs)
• ohci/hcd_endpoint.h (modified) (2 diffs)
• uhci-hcd/transfer_list.c (modified) (1 diff)

uspace/drv/ohci/endpoint_list.c

@@ -44 +44 @@
  * @return Error code
  *
- * Allocates memory for internal qh_t structure.
+ * Allocates memory for internal ed_t structure.
  */
 int endpoint_list_init(endpoint_list_t *instance, const char *name)
@@ -69 +69 @@
  * @param[in] instance List to lead.
  * @param[in] next List to append.
- * @return Error code
  *
- * Does not check whether this replaces an existing list .
+ * Does not check whether this replaces an existing list.
  */
 void endpoint_list_set_next(endpoint_list_t *instance, endpoint_list_t *next)
@@ -80 +79 @@
 }
 /*----------------------------------------------------------------------------*/
-/** Submit transfer endpoint to the list and queue.
+/** Add endpoint to the list and queue.
  *
  * @param[in] instance List to use.
- * @param[in] endpoint Transfer endpoint to submit.
- * @return Error code
+ * @param[in] endpoint Endpoint to add.
  *
  * The endpoint is added to the end of the list and queue.
@@ -100 +98 @@
         /* Add to the hardware queue. */
         if (list_empty(&instance->endpoint_list)) {
-                /* There is nothing scheduled */
+                /* There are no active EDs */
                 last_ed = instance->list_head;
         } else {
-                /* There is something scheduled */
+                /* There are active EDs, get the last one */
                 hcd_endpoint_t *last = list_get_instance(
                     instance->endpoint_list.prev, hcd_endpoint_t, link);
+                assert(last);
                 last_ed = last->ed;
         }
@@ -113 +112 @@
         write_barrier();
 
-        /* Add ed to the hw list */
+        /* Add ed to the hw queue */
         ed_append_ed(last_ed, hcd_ep->ed);
         /* Make sure ED is updated */
         write_barrier();
 
-
-        /* Add to the driver list */
+        /* Add to the sw list */
         list_append(&hcd_ep->link, &instance->endpoint_list);
 
@@ -135 +133 @@
 }
 /*----------------------------------------------------------------------------*/
-#if 0
-/** Create list for finished endpoints.
+/** Remove endpoint from the list and queue.
  *
  * @param[in] instance List to use.
- * @param[in] done list to fill
- */
-void endpoint_list_remove_finished(endpoint_list_t *instance, link_t *done)
-{
-        assert(instance);
-        assert(done);
-
-        fibril_mutex_lock(&instance->guard);
-        usb_log_debug2("Checking list %s for completed endpointes(%d).\n",
-            instance->name, list_count(&instance->endpoint_list));
-        link_t *current = instance->endpoint_list.next;
-        while (current != &instance->endpoint_list) {
-                link_t *next = current->next;
-                hcd_endpoint_t *endpoint =
-                    list_get_instance(current, hcd_endpoint_t, link);
-
-                if (endpoint_is_complete(endpoint)) {
-                        /* Save for post-processing */
-                        endpoint_list_remove_endpoint(instance, endpoint);
-                        list_append(current, done);
-                }
-                current = next;
-        }
-        fibril_mutex_unlock(&instance->guard);
-}
-/*----------------------------------------------------------------------------*/
-/** Walk the list and abort all endpointes.
- *
- * @param[in] instance List to use.
- */
-void endpoint_list_abort_all(endpoint_list_t *instance)
-{
-        fibril_mutex_lock(&instance->guard);
-        while (!list_empty(&instance->endpoint_list)) {
-                link_t *current = instance->endpoint_list.next;
-                hcd_endpoint_t *endpoint =
-                    list_get_instance(current, hcd_endpoint_t, link);
-                endpoint_list_remove_endpoint(instance, endpoint);
-                hcd_endpoint_finish_error(endpoint, EIO);
-        }
-        fibril_mutex_unlock(&instance->guard);
-}
-#endif
-/*----------------------------------------------------------------------------*/
-/** Remove a transfer endpoint from the list and queue.
- *
- * @param[in] instance List to use.
- * @param[in] endpoint Transfer endpoint to remove.
- * @return Error code
- *
- * Does not lock the transfer list, caller is responsible for that.
+ * @param[in] endpoint Endpoint to remove.
  */
 void endpoint_list_remove_ep(endpoint_list_t *instance, hcd_endpoint_t *hcd_ep)

uspace/drv/ohci/endpoint_list.h

@@ -41 +41 @@
 #include "utils/malloc32.h"
 
-typedef struct endpoint_list {
+/** Structure maintains both OHCI queue and software list of active endpoints.*/
+typedef struct endpoint_list
+{
+        /** Guard against add/remove races */
         fibril_mutex_t guard;
+        /** OHCI hw structure at the beginning of the queue */
         ed_t *list_head;
+        /** Physical address of the first(dummy) ED */
         uint32_t list_head_pa;
+        /** Assigned name, provides nicer debug output */
         const char *name;
+        /** Sw list of all active EDs */
         link_t endpoint_list;
 } endpoint_list_t;
@@ -53 +60 @@
  * @param[in] instance Memory place to use.
  *
- * Frees memory for internal qh_t structure.
+ * Frees memory of the internal ed_t structure.
  */
 static inline void endpoint_list_fini(endpoint_list_t *instance)
@@ -68 +75 @@
 
 void endpoint_list_remove_ep(endpoint_list_t *instance, hcd_endpoint_t *hcd_ep);
-#if 0
-void endpoint_list_remove_finished(endpoint_list_t *instance, link_t *done);
-
-void endpoint_list_abort_all(endpoint_list_t *instance);
-#endif
 #endif
 /**

uspace/drv/ohci/hcd_endpoint.h

@@ -37 +37 @@
 #include <assert.h>
 #include <adt/list.h>
-
 #include <usb/host/endpoint.h>
 
@@ -43 +42 @@
 #include "hw_struct/transfer_descriptor.h"
 
-typedef struct hcd_endpoint {
+typedef struct hcd_endpoint
+{
         ed_t *ed;
         td_t *td;

uspace/drv/uhci-hcd/transfer_list.c

@@ -72 +72 @@
  * @param[in] instance Memory place to use.
  *
- * Frees memory for internal qh_t structure.
+ * Frees memory of the internal qh_t structure.
  */
 void transfer_list_fini(transfer_list_t *instance)