Bug#986062: unblock: libusb-1.0/2:1.0.24-3
Package: release.debian.org
Severity: normal
User: release.debian.org@packages.debian.org
Usertags: unblock
Please unblock package libusb-1.0 version 1.0.24-3.
[ Reason ]
libusb-1.0 version 1.0.24-3 fixes an issue introduced in upstream
version 1.0.24, and preventing some buggy USB devices to work (see
#985723 for details). The fix consists in a backport of the upstream
commit. At least one of the affected USB device is commonly found in
Dell Latitude laptops.
[ Impact ]
Broadcom BCM5880 internal card reader, commonly found in Dell Latitude
laptops, stop working after an upgrade from Buster to Bullseye. Other
devices might be affected, although less common.
[ Tests ]
As the issue is related to hardware, this is not covered by autopkgtest.
It has been confirmed that version 1.0.24-3 fixes the issue with the
Broadcom BCM5880 internal card reader. In addition, I have personally
tested that this new version doesn't break any of the USB devices I
have. It has been in sid for one week without bug reported. In addition
this patch has already been backported in other distributions, at least
Fedora and Alpine.
[ Risks ]
This a package installed on most systems, however the changes are
relatively simple and basically consist in removing checks for buggy
hardware that have been added during code refactoring done in version
1.0.24.
[ Checklist ]
[x] all changes are documented in the d/changelog
[x] I reviewed all changes and I approve them
[x] attach debdiff against the package in testing
[ Other info ]
None
unblock libusb-1.0/2:1.0.24-3
-- System Information:
Debian Release: bullseye/sid
APT prefers testing
APT policy: (990, 'testing'), (500, 'unstable'), (1, 'experimental')
Architecture: amd64 (x86_64)
Kernel: Linux 5.9.0-5-amd64 (SMP w/4 CPU threads)
Kernel taint flags: TAINT_WARN, TAINT_OOT_MODULE, TAINT_UNSIGNED_MODULE
Locale: LANG=fr_FR.UTF-8, LC_CTYPE=fr_FR.UTF-8 (charmap=UTF-8), LANGUAGE=fr
Shell: /bin/sh linked to /bin/dash
Init: systemd (via /run/systemd/system)
LSM: AppArmor: enabled
diff -Nru libusb-1.0-1.0.24/debian/changelog libusb-1.0-1.0.24/debian/changelog
--- libusb-1.0-1.0.24/debian/changelog 2020-12-14 06:54:15.000000000 +0100
+++ libusb-1.0-1.0.24/debian/changelog 2021-03-22 22:41:50.000000000 +0100
@@ -1,3 +1,10 @@
+libusb-1.0 (2:1.0.24-3) unstable; urgency=medium
+
+ * Backport patch from upstream to gracefully handle buggy (but very common)
+ devices with a configuration 0 (closes: #985723).
+
+ -- Aurelien Jarno <aurel32@debian.org> Mon, 22 Mar 2021 22:41:50 +0100
+
libusb-1.0 (2:1.0.24-2) unstable; urgency=medium
* Backport patch from upstream to fix parsing of descriptors for
diff -Nru libusb-1.0-1.0.24/debian/patches/02-linux_usbfs-Gracefully-handle-buggy-devices-with-a-c.patch libusb-1.0-1.0.24/debian/patches/02-linux_usbfs-Gracefully-handle-buggy-devices-with-a-c.patch
--- libusb-1.0-1.0.24/debian/patches/02-linux_usbfs-Gracefully-handle-buggy-devices-with-a-c.patch 1970-01-01 01:00:00.000000000 +0100
+++ libusb-1.0-1.0.24/debian/patches/02-linux_usbfs-Gracefully-handle-buggy-devices-with-a-c.patch 2021-03-22 22:40:30.000000000 +0100
@@ -0,0 +1,217 @@
+From f38f09da98acc63966b65b72029b1f7f81166bef Mon Sep 17 00:00:00 2001
+From: Chris Dickens <christopher.a.dickens@gmail.com>
+Date: Mon, 8 Feb 2021 11:56:13 -0800
+Subject: [PATCH] linux_usbfs: Gracefully handle buggy devices with a
+ configuration 0
+
+The USB spec states that a configuration value of 0 is reserved and is
+used to indicate the device in not configured (e.g. is in the address
+state). Unfortunately some devices do exist that violate this and use 0
+as the bConfigurationValue of the configuration descriptor.
+
+Improve how the Linux backend handles such non-conformant devices by
+adding special handling around the configuration value 0. Most devices
+will not require this special handling, but for those that do there is
+no way to distinguish between the device being unconfigured and using
+configuration 0.
+
+Closes #850
+
+Signed-off-by: Chris Dickens <christopher.a.dickens@gmail.com>
+---
+ libusb/os/linux_usbfs.c | 94 ++++++++++++++++++++++++++---------------
+ libusb/version_nano.h | 2 +-
+ 2 files changed, 60 insertions(+), 36 deletions(-)
+
+diff --git a/libusb/os/linux_usbfs.c b/libusb/os/linux_usbfs.c
+index ebf8cfe..3a1894c 100644
+--- a/libusb/os/linux_usbfs.c
++++ b/libusb/os/linux_usbfs.c
+@@ -128,7 +128,7 @@ struct linux_device_priv {
+ void *descriptors;
+ size_t descriptors_len;
+ struct config_descriptor *config_descriptors;
+- uint8_t active_config; /* cache val for !sysfs_available */
++ int active_config; /* cache val for !sysfs_available */
+ };
+
+ struct linux_device_handle_priv {
+@@ -169,6 +169,21 @@ struct linux_transfer_priv {
+ int iso_packet_offset;
+ };
+
++static int dev_has_config0(struct libusb_device *dev)
++{
++ struct linux_device_priv *priv = usbi_get_device_priv(dev);
++ struct config_descriptor *config;
++ uint8_t idx;
++
++ for (idx = 0; idx < dev->device_descriptor.bNumConfigurations; idx++) {
++ config = &priv->config_descriptors[idx];
++ if (config->desc->bConfigurationValue == 0)
++ return 1;
++ }
++
++ return 0;
++}
++
+ static int get_usbfs_fd(struct libusb_device *dev, mode_t mode, int silent)
+ {
+ struct libusb_context *ctx = DEVICE_CTX(dev);
+@@ -574,22 +589,12 @@ static int sysfs_scan_device(struct libusb_context *ctx, const char *devname)
+ }
+
+ /* read the bConfigurationValue for a device */
+-static int sysfs_get_active_config(struct libusb_device *dev, uint8_t *config)
++static int sysfs_get_active_config(struct libusb_device *dev, int *config)
+ {
+ struct linux_device_priv *priv = usbi_get_device_priv(dev);
+- int ret, tmp;
+-
+- ret = read_sysfs_attr(DEVICE_CTX(dev), priv->sysfs_dir, "bConfigurationValue",
+- UINT8_MAX, &tmp);
+- if (ret < 0)
+- return ret;
+
+- if (tmp == -1)
+- tmp = 0; /* unconfigured */
+-
+- *config = (uint8_t)tmp;
+-
+- return 0;
++ return read_sysfs_attr(DEVICE_CTX(dev), priv->sysfs_dir, "bConfigurationValue",
++ UINT8_MAX, config);
+ }
+
+ int linux_get_device_address(struct libusb_context *ctx, int detached,
+@@ -765,6 +770,9 @@ static int parse_config_descriptors(struct libusb_device *dev)
+ }
+ }
+
++ if (config_desc->bConfigurationValue == 0)
++ usbi_warn(ctx, "device has configuration 0");
++
+ priv->config_descriptors[idx].desc = config_desc;
+ priv->config_descriptors[idx].actual_len = config_len;
+
+@@ -798,7 +806,7 @@ static int op_get_active_config_descriptor(struct libusb_device *dev,
+ {
+ struct linux_device_priv *priv = usbi_get_device_priv(dev);
+ void *config_desc;
+- uint8_t active_config;
++ int active_config;
+ int r;
+
+ if (priv->sysfs_dir) {
+@@ -810,12 +818,12 @@ static int op_get_active_config_descriptor(struct libusb_device *dev,
+ active_config = priv->active_config;
+ }
+
+- if (active_config == 0) {
++ if (active_config == -1) {
+ usbi_err(DEVICE_CTX(dev), "device unconfigured");
+ return LIBUSB_ERROR_NOT_FOUND;
+ }
+
+- r = op_get_config_descriptor_by_value(dev, active_config, &config_desc);
++ r = op_get_config_descriptor_by_value(dev, (uint8_t)active_config, &config_desc);
+ if (r < 0)
+ return r;
+
+@@ -863,17 +871,26 @@ static int usbfs_get_active_config(struct libusb_device *dev, int fd)
+
+ /* we hit this error path frequently with buggy devices :( */
+ usbi_warn(DEVICE_CTX(dev), "get configuration failed, errno=%d", errno);
++
++ /* assume the current configuration is the first one if we have
++ * the configuration descriptors, otherwise treat the device
++ * as unconfigured. */
++ if (priv->config_descriptors)
++ priv->active_config = (int)priv->config_descriptors[0].desc->bConfigurationValue;
++ else
++ priv->active_config = -1;
+ } else if (active_config == 0) {
+- /* some buggy devices have a configuration 0, but we're
+- * reaching into the corner of a corner case here, so let's
+- * not support buggy devices in these circumstances.
+- * stick to the specs: a configuration value of 0 means
+- * unconfigured. */
+- usbi_warn(DEVICE_CTX(dev), "active cfg 0? assuming unconfigured device");
++ if (dev_has_config0(dev)) {
++ /* some buggy devices have a configuration 0, but we're
++ * reaching into the corner of a corner case here. */
++ priv->active_config = 0;
++ } else {
++ priv->active_config = -1;
++ }
++ } else {
++ priv->active_config = (int)active_config;
+ }
+
+- priv->active_config = active_config;
+-
+ return LIBUSB_SUCCESS;
+ }
+
+@@ -1004,9 +1021,9 @@ static int initialize_device(struct libusb_device *dev, uint8_t busnum,
+ usbi_warn(ctx, "Missing rw usbfs access; cannot determine "
+ "active configuration descriptor");
+ if (priv->config_descriptors)
+- priv->active_config = priv->config_descriptors[0].desc->bConfigurationValue;
++ priv->active_config = (int)priv->config_descriptors[0].desc->bConfigurationValue;
+ else
+- priv->active_config = 0; /* No config dt */
++ priv->active_config = -1; /* No config dt */
+
+ return LIBUSB_SUCCESS;
+ }
+@@ -1428,22 +1445,27 @@ static int op_get_configuration(struct libusb_device_handle *handle,
+ uint8_t *config)
+ {
+ struct linux_device_priv *priv = usbi_get_device_priv(handle->dev);
++ int active_config;
+ int r;
+
+ if (priv->sysfs_dir) {
+- r = sysfs_get_active_config(handle->dev, config);
++ r = sysfs_get_active_config(handle->dev, &active_config);
+ } else {
+ struct linux_device_handle_priv *hpriv = usbi_get_device_handle_priv(handle);
+
+ r = usbfs_get_active_config(handle->dev, hpriv->fd);
+ if (r == LIBUSB_SUCCESS)
+- *config = priv->active_config;
++ active_config = priv->active_config;
+ }
+ if (r < 0)
+ return r;
+
+- if (*config == 0)
+- usbi_err(HANDLE_CTX(handle), "device unconfigured");
++ if (active_config == -1) {
++ usbi_warn(HANDLE_CTX(handle), "device unconfigured");
++ active_config = 0;
++ }
++
++ *config = (uint8_t)active_config;
+
+ return 0;
+ }
+@@ -1467,11 +1489,13 @@ static int op_set_configuration(struct libusb_device_handle *handle, int config)
+ return LIBUSB_ERROR_OTHER;
+ }
+
+- if (config == -1)
+- config = 0;
++ /* if necessary, update our cached active config descriptor */
++ if (!priv->sysfs_dir) {
++ if (config == 0 && !dev_has_config0(handle->dev))
++ config = -1;
+
+- /* update our cached active config descriptor */
+- priv->active_config = (uint8_t)config;
++ priv->active_config = config;
++ }
+
+ return LIBUSB_SUCCESS;
+ }
diff -Nru libusb-1.0-1.0.24/debian/patches/series libusb-1.0-1.0.24/debian/patches/series
--- libusb-1.0-1.0.24/debian/patches/series 2020-12-14 06:54:15.000000000 +0100
+++ libusb-1.0-1.0.24/debian/patches/series 2021-03-22 22:40:06.000000000 +0100
@@ -1 +1,2 @@
01-linux_usbfs-Fix-parsing-of-descriptors-for-multi-con.patch
+02-linux_usbfs-Gracefully-handle-buggy-devices-with-a-c.patch
Reply to: