Changeset e4d7363 in mainline for uspace/lib/usbhost/src/ddf_helpers.c

Timestamp:

2017-06-22T21:34:39Z (7 years ago)

Author:

Ondřej Hlavatý <aearsis@…>

Branches:

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

Children:

91ca111

Parents:

cb89430

Message:

usbhost: refactor the initialization

Before that, drivers had to setup MMIO range multiple times, or even parse hw
resources themselves again. The former init method was split in half - init and
start. Init shall allocate and initialize inner structures, start shall start
the HC.

In the XHCI it is demonstrated how to isolate inner HC implementation from the
fact this driver is using libusbhost. It adds some boilerplate code, but
I think it leads to cleaner design.

File:

• uspace/lib/usbhost/src/ddf_helpers.c (modified) (6 diffs)

uspace/lib/usbhost/src/ddf_helpers.c

@@ -753 +753 @@
     const hw_res_list_parsed_t *hw_res,
     interrupt_handler_t handler,
-    int (*gen_irq_code)(irq_code_t *, const hw_res_list_parsed_t *hw_res))
-{
-
+    irq_code_gen_t gen_irq_code)
+{
         assert(device);
+
+        hcd_t *hcd = dev_to_hcd(device);
+
         if (!handler || !gen_irq_code)
                 return ENOTSUP;
@@ -762 +764 @@
         irq_code_t irq_code = {0};
 
-        const int irq = gen_irq_code(&irq_code, hw_res);
+        const int irq = gen_irq_code(&irq_code, hcd, hw_res);
         if (irq < 0) {
                 usb_log_error("Failed to generate IRQ code: %s.\n",
@@ -878 +880 @@
         if (ret != EOK) {
                 usb_log_error("Failed to setup generic HCD.\n");
-                hw_res_list_parsed_clean(&hw_res);
-                return ret;
-        }
-
+                goto err_hw_res;
+        }
+
+        hcd_t *hcd = dev_to_hcd(device);
+
+        if (driver->init)
+                ret = driver->init(hcd, &hw_res);
+        if (ret != EOK) {
+                usb_log_error("Failed to init HCD.\n");
+                goto err_hcd;
+        }
+
+        /* Setup interrupts  */
         interrupt_handler_t *irq_handler =
             driver->irq_handler ? driver->irq_handler : ddf_hcd_gen_irq_handler;
-        const int irq = hcd_ddf_setup_interrupts(device, &hw_res, irq_handler,
-            driver->irq_code_gen);
+        const int irq = hcd_ddf_setup_interrupts(device, &hw_res, irq_handler, driver->irq_code_gen);
         if (!(irq < 0)) {
                 usb_log_debug("Hw interrupts enabled.\n");
         }
 
+        /* Claim the device from BIOS */
         if (driver->claim)
-                ret = driver->claim(device);
-        if (ret != EOK) {
-                usb_log_error("Failed to claim `%s' for driver `%s'",
-                    ddf_dev_get_name(device), driver->name);
-                return ret;
-        }
-
-
-        /* Init hw driver */
-        hcd_t *hcd = dev_to_hcd(device);
-        ret = driver->init(hcd, &hw_res, !(irq < 0));
-        hw_res_list_parsed_clean(&hw_res);
-        if (ret != EOK) {
-                usb_log_error("Failed to init HCD: %s.\n", str_error(ret));
-                goto irq_unregister;
+                ret = driver->claim(hcd, device);
+        if (ret != EOK) {
+                usb_log_error("Failed to claim `%s' for driver `%s': %s",
+                    ddf_dev_get_name(device), driver->name, str_error(ret));
+                goto err_irq;
+        }
+
+        /* Start hw driver */
+        if (driver->start)
+                ret = driver->start(hcd, !(irq < 0));
+        if (ret != EOK) {
+                usb_log_error("Failed to start HCD: %s.\n", str_error(ret));
+                goto err_irq;
         }
 
@@ -914 +923 @@
                         usb_log_error("Failed to create polling fibril\n");
                         ret = ENOMEM;
-                        goto irq_unregister;
+                        goto err_started;
                 }
                 fibril_add_ready(hcd->polling_fibril);
@@ -929 +938 @@
                 usb_log_error("Failed to setup HC root hub: %s.\n",
                     str_error(ret));
-                driver->fini(dev_to_hcd(device));
-irq_unregister:
-                /* Unregistering non-existent should be ok */
-                unregister_interrupt_handler(device, irq);
-                hcd_ddf_clean_hc(device);
-                return ret;
+                goto err_polling;
         }
 
@@ -940 +944 @@
             driver->name, ddf_dev_get_name(device));
         return EOK;
+        
+err_polling:
+        // TODO: Stop the polling fibril (refactor the interrupt_polling func)
+        //
+err_started:
+        if (driver->stop)
+                driver->stop(hcd);
+err_irq:
+        unregister_interrupt_handler(device, irq);
+        if (driver->fini)
+                driver->fini(hcd);
+err_hcd:
+        hcd_ddf_clean_hc(device);
+err_hw_res:
+        hw_res_list_parsed_clean(&hw_res);
+        return ret;
 }
 /**