Changeset e4d7363 in mainline for uspace/lib/usbhost/include/usb/host/ddf_helpers.h

Timestamp:

2017-06-22T21:34:39Z (8 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/include/usb/host/ddf_helpers.h (modified) (2 diffs)

uspace/lib/usbhost/include/usb/host/ddf_helpers.h

@@ -45 +45 @@
 #include <device/hw_res_parsed.h>
 
-typedef int (*driver_init_t)(hcd_t *, const hw_res_list_parsed_t *, bool);
+typedef int (*driver_init_t)(hcd_t *, const hw_res_list_parsed_t *);
+typedef int (*irq_code_gen_t)(irq_code_t *, hcd_t *, const hw_res_list_parsed_t *);
+typedef int (*claim_t)(hcd_t *, ddf_dev_t *);
+typedef int (*driver_start_t)(hcd_t *, bool irq);
+
+typedef void (*driver_stop_t)(hcd_t *);
 typedef void (*driver_fini_t)(hcd_t *);
-typedef int (*claim_t)(ddf_dev_t *);
-typedef int (*irq_code_gen_t)(irq_code_t *, const hw_res_list_parsed_t *);
 
+/**
+ * All callbacks are optional.
+ */
 typedef struct {
         hcd_ops_t ops;
-        claim_t claim;
         usb_speed_t hc_speed;
-        driver_init_t init;
-        driver_fini_t fini;
-        interrupt_handler_t *irq_handler;
-        irq_code_gen_t irq_code_gen;
         const char *name;
+
+        interrupt_handler_t *irq_handler;  /**< Handler of IRQ. Do have generic implementation. */
+
+        /* Initialization sequence: */
+        driver_init_t init;                /**< Initialize internal structures, memory */
+        claim_t claim;                     /**< Claim device from BIOS */
+        irq_code_gen_t irq_code_gen;       /**< Generate IRQ handling code */
+        driver_start_t start;              /**< Start the HC */
+
+        /* Destruction sequence: */
+        driver_stop_t stop;                /**< Stop the HC (counterpart of start) */
+        driver_fini_t fini;                /**< Destroy internal structures (counterpart of init) */
 } ddf_hc_driver_t;
 
@@ -75 +88 @@
     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 *));
+    irq_code_gen_t gen_irq_code);
 void ddf_hcd_gen_irq_handler(ipc_callid_t iid, ipc_call_t *call, ddf_dev_t *dev);