Changeset 9efad54 in mainline for uspace/lib/drv/include/usbhc_iface.h

Timestamp:

2018-01-06T21:15:48Z (7 years ago)

Author:

Ondřej Hlavatý <aearsis@…>

Branches:

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

Children:

56257ba

Parents:

c901632

Message:

usb: move endpoint descriptor parsing to HC

This better separates responsibilities. Now the device driver does not
care about the contents of an endpoint descriptor, and HC can parse the
values according to device's actual speed.

Currently, it is device driver's responsibility to fetch endpoint
descriptors, map them and register pipes - sending the endpoint
descriptor back to HC. HC then parses it, and fills the pipe
description, which then sends back to device driver. We shall probably
fetch the endpoint descriptor from inside the HC (also fixing the USB
spec violation of communication with EP0).

File:

• uspace/lib/drv/include/usbhc_iface.h (modified) (3 diffs)

uspace/lib/drv/include/usbhc_iface.h

@@ -44 +44 @@
 #include <async.h>
 
+typedef struct usb_pipe_desc {
+        /** Endpoint number. */
+        usb_endpoint_t endpoint_no;
+
+        /** Endpoint transfer type. */
+        usb_transfer_type_t transfer_type;
+
+        /** Endpoint direction. */
+        usb_direction_t direction;
+
+        /** Maximum size of one transfer */
+        size_t max_transfer_size;
+} usb_pipe_desc_t;
+
+/** This structure follows standard endpoint descriptor + superspeed companion
+ * descriptor, and exists to avoid dependency of libdrv on libusb. Keep the
+ * internal fields named exactly like their source (because we want to use the
+ * same macros to access them).
+ * Callers shall fill it with bare contents of respective descriptors (in usb endianity).
+ */
+typedef struct {
+        struct {
+                uint8_t endpoint_address;
+                uint8_t attributes;
+                uint16_t max_packet_size;
+                uint8_t poll_interval;
+        } endpoint;
+
+        /* Superspeed companion descriptor */
+        struct companion_desc_t {
+                uint8_t max_burst;
+                uint8_t attributes;
+                uint16_t bytes_per_interval;
+        } companion;
+} usb_endpoint_descriptors_t;
+
 extern int usbhc_reserve_default_address(async_exch_t *, usb_speed_t);
 extern int usbhc_release_default_address(async_exch_t *);
@@ -50 +86 @@
 extern int usbhc_device_remove(async_exch_t *, unsigned port);
 
-extern int usbhc_register_endpoint(async_exch_t *, usb_endpoint_desc_t *);
-extern int usbhc_unregister_endpoint(async_exch_t *, usb_endpoint_desc_t *);
+extern int usbhc_register_endpoint(async_exch_t *, usb_pipe_desc_t *, const usb_endpoint_descriptors_t *);
+extern int usbhc_unregister_endpoint(async_exch_t *, const usb_pipe_desc_t *);
+
 extern int usbhc_read(async_exch_t *, usb_endpoint_t, uint64_t, void *, size_t,
     size_t *);
@@ -68 +105 @@
         int (*device_remove)(ddf_fun_t *, unsigned);
 
-        int (*register_endpoint)(ddf_fun_t *, usb_endpoint_desc_t *);
-        int (*unregister_endpoint)(ddf_fun_t *, usb_endpoint_desc_t *);
+        int (*register_endpoint)(ddf_fun_t *, usb_pipe_desc_t *, const usb_endpoint_descriptors_t *);
+        int (*unregister_endpoint)(ddf_fun_t *, const usb_pipe_desc_t *);
 
         int (*read)(ddf_fun_t *, usb_target_t,