Changeset 9efad54 in mainline for uspace/lib/usbdev/src/pipes.c

Timestamp:

2018-01-06T21:15:48Z (6 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/usbdev/src/pipes.c (modified) (3 diffs)

uspace/lib/usbdev/src/pipes.c

@@ -272 +272 @@
  * @param pipe Endpoint pipe to be initialized.
  * @param bus_session Endpoint pipe to be initialized.
- * @param ep_desc Prepared endpoint descriptor
- * @return Error code.
- */
-int usb_pipe_initialize(usb_pipe_t *pipe,
-    usb_dev_session_t *bus_session,
-    const usb_endpoint_desc_t *ep_desc)
-{
-        int ret = EOK;
-        assert(pipe);
-
-        pipe->desc = *ep_desc;
+ * @return Error code.
+ */
+int usb_pipe_initialize(usb_pipe_t *pipe, usb_dev_session_t *bus_session, usb_transfer_type_t transfer_type)
+{
+        assert(pipe);
+
         pipe->auto_reset_halt = false;
         pipe->bus_session = bus_session;
 
-        if (pipe->desc.transfer_type == USB_TRANSFER_ISOCHRONOUS) {
-                ret = usb_isoch_session_initialize(pipe);
-        }
-
-        return ret;
-}
-
-static const usb_endpoint_desc_t default_control_ep_desc = {
-        .max_packet_size = CTRL_PIPE_MIN_PACKET_SIZE,
+        if (transfer_type == USB_TRANSFER_ISOCHRONOUS)
+                return usb_isoch_session_initialize(pipe);
+
+        return EOK;
+}
+
+static const usb_pipe_desc_t default_control_pipe = {
+        .endpoint_no = 0,
+        .transfer_type = USB_TRANSFER_CONTROL,
         .direction = USB_DIRECTION_BOTH,
-        .packets = 1,
+        .max_transfer_size = CTRL_PIPE_MIN_PACKET_SIZE,
 };
 
-/** Initialize USB endpoint pipe as the default zero control pipe.
+/** Initialize USB default control pipe.
+ *
+ * This one is special because it must not be registered, it is registered automatically.
  *
  * @param pipe Endpoint pipe to be initialized.
- * @param bus_session
+ * @param bus_session Endpoint pipe to be initialized.
  * @return Error code.
  */
 int usb_pipe_initialize_default_control(usb_pipe_t *pipe, usb_dev_session_t *bus_session)
 {
-        return usb_pipe_initialize(pipe, bus_session, &default_control_ep_desc); 
+        const int ret = usb_pipe_initialize(pipe, bus_session, USB_TRANSFER_CONTROL);
+        if (ret)
+                return ret;
+
+        pipe->desc = default_control_pipe;
+
+        return EOK;
 }
 
@@ -313 +316 @@
  *
  * @param pipe Pipe to be registered.
- * @param interval Polling interval.
- * @return Error code.
- */
-int usb_pipe_register(usb_pipe_t *pipe)
+ * @param ep_desc Matched endpoint descriptor
+ * @param comp_desc Matched superspeed companion descriptro, if any
+ * @return Error code.
+ */
+int usb_pipe_register(usb_pipe_t *pipe, const usb_standard_endpoint_descriptor_t *ep_desc, const usb_superspeed_endpoint_companion_descriptor_t *comp_desc)
 {
         assert(pipe);
         assert(pipe->bus_session);
+        assert(ep_desc);
 
         async_exch_t *exch = async_exchange_begin(pipe->bus_session);
@@ -325 +330 @@
                 return ENOMEM;
 
-        const int ret = usbhc_register_endpoint(exch, &pipe->desc);
-
+        usb_endpoint_descriptors_t descriptors;
+
+#define COPY(field) descriptors.endpoint.field = ep_desc->field
+        COPY(endpoint_address);
+        COPY(attributes);
+        COPY(max_packet_size);
+        COPY(poll_interval);
+#undef COPY
+
+#define COPY(field) descriptors.companion.field = comp_desc->field
+        if (comp_desc) {
+                COPY(max_burst);
+                COPY(attributes);
+                COPY(bytes_per_interval);
+        }
+#undef COPY
+
+        const int ret = usbhc_register_endpoint(exch, &pipe->desc, &descriptors);
         async_exchange_end(exch);
         return ret;