[SEABIOS] [PATCH] usb.c: Fix devices using non-primary interface descriptor

[Matt DeVillier]

From 38f63fcd9b646d6a4eac30f0476bbaee611211ce Mon Sep 17 00:00:00 2001
From: Matt DeVillier 
Date: Fri, 11 Sep 2020 12:54:21 -0500
Subject: [PATCH] usb.c: Fix devices using non-primary interface descriptor

A fair number of USB devices (keyboards in particular) use an
interface descriptor
other than the first available, making them non-functional currently.
To correct this, iterate through all available interface descriptors
until one with the correct class/subclass is found, then proceed to set the
configuration and setup the driver.

Tested on an ultimate hacking keyboard (UHK 60)

Signed-off-by: Matt DeVillier 
---
 src/hw/usb.c | 27 +++++++++++++++++++--------
 1 file changed, 19 insertions(+), 8 deletions(-)

diff --git a/src/hw/usb.c b/src/hw/usb.c
index 4f9a852..38a866a 100644
--- a/src/hw/usb.c
+++ b/src/hw/usb.c
@@ -248,14 +248,14 @@ get_device_config(struct usb_pipe *pipe)
     if (ret)
         return NULL;

-    void *config = malloc_tmphigh(cfg.wTotalLength);
+    struct usb_config_descriptor *config = malloc_tmphigh(cfg.wTotalLength);
     if (!config) {
         warn_noalloc();
         return NULL;
     }
     req.wLength = cfg.wTotalLength;
     ret = usb_send_default_control(pipe, &req, config);
-    if (ret) {
+    if (ret || config->wTotalLength != cfg.wTotalLength) {
         free(config);
         return NULL;
     }
@@ -367,13 +367,24 @@ configure_usb_device(struct usbdevice_s *usbdev)
         return 0;

// Determine if a driver exists for this device - only look at the
-    // first interface of the first configuration.
+    // interfaces of the first configuration.
+    int num_iface = config->bNumInterfaces;
+    void *config_end = (void*)config + config->wTotalLength;
     struct usb_interface_descriptor *iface = (void*)(&config[1]);
-    if (iface->bInterfaceClass != USB_CLASS_HID
-        && iface->bInterfaceClass != USB_CLASS_MASS_STORAGE
-        && iface->bInterfaceClass != USB_CLASS_HUB)
-        // Not a supported device.
-        goto fail;
+    for (;;) {
+        if (!num_iface-- || (void*)iface + iface->bLength > config_end)
+            // Not a supported device.
+            goto fail;
+        if (iface->bDescriptorType == USB_DT_INTERFACE
+            && (iface->bInterfaceClass == USB_CLASS_HUB
+                || (iface->bInterfaceClass == USB_CLASS_MASS_STORAGE
+                    && (iface->bInterfaceProtocol == US_PR_BULK
+                        || iface->bInterfaceProtocol == US_PR_UAS))
+                || (iface->bInterfaceClass == USB_CLASS_HID
+                    && iface->bInterfaceSubClass ==
USB_INTERFACE_SUBCLASS_BOOT)))
+            break;
+        iface = (void*)iface + iface->bLength;
+    }

// Set the configuration.
     ret = set_configuration(usbdev->defpipe, config->bConfigurationValue);

[Kevin O'Connor]

On Fri, Sep 11, 2020 at 01:09:11PM -0500, Matt DeVillier wrote:
> From 38f63fcd9b646d6a4eac30f0476bbaee611211ce Mon Sep 17 00:00:00 2001
> From: Matt DeVillier 
> Date: Fri, 11 Sep 2020 12:54:21 -0500
> Subject: [PATCH] usb.c: Fix devices using non-primary interface descriptor
>
> A fair number of USB devices (keyboards in particular) use an
> interface descriptor
> other than the first available, making them non-functional currently.
> To correct this, iterate through all available interface descriptors
> until one with the correct class/subclass is found, then proceed to set the
> configuration and setup the driver.
>
> Tested on an ultimate hacking keyboard (UHK 60)

Thanks, I committed this change.

-Kevin