Changeset 41924f30 in mainline for uspace/lib/usbhost/include

Timestamp:

2017-10-12T14:07:27Z (8 years ago)

Author:

Ondřej Hlavatý <aearsis@…>

Branches:

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

Children:

a5976973

Parents:

7e74911

Message:

WIP usbhost refactoring

This commit replaces callbacks with more systematic virtual-like inheritance-like solution. Currently breaks build of HelenOS, but both xhci and usbhost are buildable. More refactoring follows…

Location:

uspace/lib/usbhost/include/usb/host

Files:

• bandwidth.h (added)
• bus.h (added)
• ddf_helpers.h (modified) (2 diffs)
• endpoint.h (modified) (6 diffs)
• hcd.h (modified) (4 diffs)
• usb2_bus.h (added)
• usb_bus.h (deleted)
• usb_transfer_batch.h (modified) (1 diff)

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

@@ -38 +38 @@
 
 #include <usb/host/hcd.h>
-#include <usb/host/usb_bus.h>
+#include <usb/host/bus.h>
 #include <usb/usb.h>
 
@@ -76 +76 @@
 int hcd_ddf_add_hc(ddf_dev_t *device, const ddf_hc_driver_t *driver);
 
-int hcd_ddf_setup_hc(ddf_dev_t *device, usb_speed_t max_speed,
-    size_t bw, bw_count_func_t bw_count);
+int hcd_ddf_setup_hc(ddf_dev_t *device);
 void hcd_ddf_clean_hc(ddf_dev_t *device);
 int hcd_ddf_setup_root_hub(ddf_dev_t *device);

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

@@ -32 +32 @@
 /** @file
  *
+ * Endpoint structure is tightly coupled to the bus. The bus controls the
+ * life-cycle of endpoint. In order to keep endpoints lightweight, operations
+ * on endpoints are part of the bus structure.
+ *
  */
 #ifndef LIBUSBHOST_HOST_ENDPOINT_H
@@ -42 +46 @@
 #include <atomic.h>
 
+typedef struct bus bus_t;
+
 /** Host controller side endpoint structure. */
 typedef struct endpoint {
+        /** Managing bus */
+        bus_t *bus;
         /** Reference count. */
         atomic_t refcnt;
@@ -49 +57 @@
         link_t link;
         /** USB address. */
-        usb_address_t address;
-        /** USB endpoint number. */
-        usb_endpoint_t endpoint;
+        usb_target_t target;
         /** Communication direction. */
         usb_direction_t direction;
@@ -62 +68 @@
         /** Additional opportunities per uframe */
         unsigned packets;
-        /** Necessary bandwidth. */
+        /** Reserved bandwidth. */
         size_t bandwidth;
         /** Value of the toggle bit. */
         unsigned toggle:1;
         /** True if there is a batch using this scheduled for this endpoint. */
-        volatile bool active;
+        bool active;
         /** Protects resources and active status changes. */
         fibril_mutex_t guard;
@@ -77 +83 @@
                 unsigned port;
         } tt;
-        /** Optional device specific data. */
-        struct {
-                /** Device specific data. */
-                void *data;
-                /** Callback to get the value of toggle bit. */
-                int (*toggle_get)(void *);
-                /** Callback to set the value of toggle bit. */
-                void (*toggle_set)(void *, int);
-                /** Device slot id. */
-                uint8_t slot_id;
-        } hc_data;
+
+        /* This structure is meant to be extended by overriding. */
 } endpoint_t;
 
-extern endpoint_t *endpoint_create(usb_address_t, usb_endpoint_t,
-    usb_direction_t, usb_transfer_type_t, usb_speed_t, size_t, unsigned int,
-    size_t, usb_address_t, unsigned int);
-extern void endpoint_destroy(endpoint_t *);
+extern void endpoint_init(endpoint_t *, bus_t *);
 
 extern void endpoint_add_ref(endpoint_t *);
 extern void endpoint_del_ref(endpoint_t *);
-
-extern void endpoint_set_hc_data(endpoint_t *, void *, int (*)(void *),
-    void (*)(void *, int));
-extern void endpoint_clear_hc_data(endpoint_t *);
 
 extern void endpoint_use(endpoint_t *);
@@ -106 +96 @@
 
 extern int endpoint_toggle_get(endpoint_t *);
-extern void endpoint_toggle_set(endpoint_t *, int);
+extern void endpoint_toggle_set(endpoint_t *, unsigned);
 
 /** list_get_instance wrapper.

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

@@ -38 +38 @@
 
 #include <usb/host/endpoint.h>
-#include <usb/host/usb_bus.h>
+#include <usb/host/bus.h>
 #include <usb/host/usb_transfer_batch.h>
 #include <usb/usb.h>
@@ -71 +71 @@
 struct hcd {
         /** Endpoint manager. */
-        usb_bus_t bus;
+        bus_t *bus;
 
         /** Interrupt replacement fibril */
@@ -78 +78 @@
         /** Driver implementation */
         hcd_ops_t ops;
+
         /** Device specific driver data. */
         void * driver_data;
 };
 
-extern void hcd_init(hcd_t *, usb_speed_t, size_t, bw_count_func_t);
+extern void hcd_init(hcd_t *);
 
 static inline void hcd_set_implementation(hcd_t *hcd, void *data,
-    const hcd_ops_t *ops)
+    const hcd_ops_t *ops, bus_t *bus)
 {
         assert(hcd);
@@ -91 +92 @@
                 hcd->driver_data = data;
                 hcd->ops = *ops;
+                hcd->bus = bus;
         } else {
                 memset(&hcd->ops, 0, sizeof(hcd->ops));

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

@@ -90 +90 @@
  */
 #define USB_TRANSFER_BATCH_ARGS(batch) \
-        (batch).ep->address, (batch).ep->endpoint, \
+        (batch).ep->target.address, (batch).ep->target.endpoint, \
         usb_str_speed((batch).ep->speed), \
         usb_str_transfer_type_short((batch).ep->transfer_type), \