Changeset ec700c7 in mainline

Timestamp:

2017-10-23T23:17:14Z (6 years ago)

Author:

Michal Staruch <salmelu@…>

Branches:

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

Children:

894f58c

Parents:

b724494

Message:

Superspeed companion descriptor is processed

Superspeed endpoint companion is now correctly read and processed while parsing descriptors.
As a side effect, mass storage endpoints now initialize correctly and therefore mass storage driver starts.

Location:

uspace/lib

Files:

• usb/include/usb/descriptor.h (modified) (1 diff)
• usb/include/usb/usb.h (modified) (1 diff)
• usbdev/include/usb/dev/pipes.h (modified) (2 diffs)
• usbdev/src/pipes.c (modified) (3 diffs)
• usbdev/src/pipesinit.c (modified) (9 diffs)
• usbhost/src/ddf_helpers.c (modified) (1 diff)

uspace/lib/usb/include/usb/descriptor.h

@@ -245 +245 @@
          */
         uint8_t attributes;
+#define SS_COMPANION_MAX_STREAMS(attributes) \
+        (attributes & 0x1f)
         /** The total number of bytes this endpoint will transfer
          * every service interval (SI).

uspace/lib/usb/include/usb/usb.h

@@ -197 +197 @@
                 unsigned polling_interval;
         } usb2;
+
+        struct {
+                unsigned max_burst;
+                unsigned max_streams;
+        } usb3;
 } usb_endpoint_desc_t;
 

uspace/lib/usbdev/include/usb/dev/pipes.h

@@ -88 +88 @@
         /** Found descriptor fitting the description. */
         const usb_standard_endpoint_descriptor_t *descriptor;
+        /** Relevant superspeed companion descriptor. */
+        const usb_superspeed_endpoint_companion_descriptor_t *companion_descriptor;
         /** Interface descriptor the endpoint belongs to. */
         const usb_standard_interface_descriptor_t *interface;
@@ -95 +97 @@
 
 int usb_pipe_initialize(usb_pipe_t *, usb_endpoint_t, usb_transfer_type_t,
-    size_t, usb_direction_t, unsigned, usb_dev_session_t *);
+    size_t, usb_direction_t, unsigned, unsigned, unsigned, usb_dev_session_t *);
 int usb_pipe_initialize_default_control(usb_pipe_t *, usb_dev_session_t *);
 

uspace/lib/usbdev/src/pipes.c

@@ -254 +254 @@
 int usb_pipe_initialize(usb_pipe_t *pipe, usb_endpoint_t endpoint_no,
     usb_transfer_type_t transfer_type, size_t max_packet_size,
-    usb_direction_t direction, unsigned packets, usb_dev_session_t *bus_session)
-{
+    usb_direction_t direction, unsigned packets,
+    unsigned max_burst, unsigned max_streams, usb_dev_session_t *bus_session)
+{
+        // FIXME refactor this function
         assert(pipe);
 
@@ -263 +265 @@
         pipe->desc.max_packet_size = max_packet_size;
         pipe->desc.direction = direction;
+        pipe->desc.usb3.max_burst = max_burst;
+        pipe->desc.usb3.max_streams = max_streams;
         pipe->auto_reset_halt = false;
         pipe->bus_session = bus_session;
@@ -280 +284 @@
 
         const int rc = usb_pipe_initialize(pipe, 0, USB_TRANSFER_CONTROL,
-            CTRL_PIPE_MIN_PACKET_SIZE, USB_DIRECTION_BOTH, 1, bus_session);
+            CTRL_PIPE_MIN_PACKET_SIZE, USB_DIRECTION_BOTH, 1, 0, 0, bus_session);
 
         pipe->auto_reset_halt = true;

uspace/lib/usbdev/src/pipesinit.c

@@ -38 +38 @@
 #include <usb/dev/request.h>
 #include <usb/usb.h>
+#include <usb/debug.h>
 #include <usb/descriptor.h>
 
@@ -59 +60 @@
         NESTING(INTERFACE, HID),
         NESTING(HID, HID_REPORT),
+        NESTING(ENDPOINT, SSPEED_EP_COMPANION),
         LAST_NESTING
 };
@@ -70 +72 @@
 {
         return descriptor[1] == USB_DESCTYPE_ENDPOINT;
+}
+
+/** Tells whether given descriptor is of superspeed companion type.
+ *
+ * @param descriptor Descriptor in question.
+ * @return Whether the given descriptor is superspeed companion descriptor.
+ */
+static inline bool is_superspeed_companion_descriptor(const uint8_t *descriptor)
+{
+        return descriptor[1] == USB_DESCTYPE_SSPEED_EP_COMPANION;
 }
 
@@ -150 +162 @@
  * @param interface Interface descriptor under which belongs the @p endpoint.
  * @param endpoint Endpoint descriptor.
+ * @param companion Superspeed companion descriptor.
  * @return Error code.
  */
@@ -156 +169 @@
     usb_standard_interface_descriptor_t *interface,
     usb_standard_endpoint_descriptor_t *endpoint_desc,
+    usb_superspeed_endpoint_companion_descriptor_t *companion_desc,
     usb_dev_session_t *bus_session)
 {
@@ -194 +208 @@
         }
 
+        unsigned max_burst = 0;
+        unsigned max_streams = 0;
+        if(companion_desc) {
+                max_burst = companion_desc->max_burst;
+                max_streams = SS_COMPANION_MAX_STREAMS(companion_desc->attributes);
+        }
+
         int rc = usb_pipe_initialize(&ep_mapping->pipe,
             ep_no, description.transfer_type,
             ED_MPS_PACKET_SIZE_GET(
                 uint16_usb2host(endpoint_desc->max_packet_size)),
-            description.direction,
+            description.direction, max_burst, max_streams,
             ED_MPS_TRANS_OPPORTUNITIES_GET(
                 uint16_usb2host(endpoint_desc->max_packet_size)), bus_session);
@@ -207 +228 @@
         ep_mapping->present = true;
         ep_mapping->descriptor = endpoint_desc;
+        ep_mapping->companion_descriptor = companion_desc;
         ep_mapping->interface = interface;
 
@@ -235 +257 @@
         do {
                 if (is_endpoint_descriptor(descriptor)) {
+                        /* Check if companion descriptor is present too, it should immediatelly follow. */
+                        const uint8_t *companion_desc = usb_dp_get_nested_descriptor(parser,
+                                parser_data, descriptor);
+                        if (companion_desc && !is_superspeed_companion_descriptor(companion_desc)) {
+                                /* Not what we wanted, don't pass it further. */
+                                companion_desc = NULL;
+                        }
+
                         (void) process_endpoint(mapping, mapping_count,
                             (usb_standard_interface_descriptor_t *)
@@ -240 +270 @@
                             (usb_standard_endpoint_descriptor_t *)
                                 descriptor,
+                            (usb_superspeed_endpoint_companion_descriptor_t *)
+                                companion_desc,
                             bus_session);
                 }

uspace/lib/usbhost/src/ddf_helpers.c

@@ -105 +105 @@
                 usb_str_direction(endpoint_desc->direction),
                 endpoint_desc->max_packet_size, endpoint_desc->usb2.polling_interval);
+
+        // FIXME: we now have max_streams and max_burst in endpoint_desc->usb3 struct
+        // Hand it down to XHCI, refactor, whatever
 
         return bus_add_ep(hcd->bus, dev, endpoint_desc->endpoint_no,