git: d1cf19c70a6a - stable/13 - umodem: add quirk to ignore CDC_CM descriptor

From: Corvin Köhne <corvink_at_FreeBSD.org>
Date: Wed, 25 Jan 2023 07:48:29 UTC
The branch stable/13 has been updated by corvink:

URL: https://cgit.FreeBSD.org/src/commit/?id=d1cf19c70a6a1d34c1aa79eb584fb78bdfdb7a27

commit d1cf19c70a6a1d34c1aa79eb584fb78bdfdb7a27
Author:     Steffen Dirkwinkel <s.dirkwinkel@beckhoff.com>
AuthorDate: 2023-01-17 07:58:46 +0000
Commit:     Corvin Köhne <corvink@FreeBSD.org>
CommitDate: 2023-01-25 06:55:12 +0000

    umodem: add quirk to ignore CDC_CM descriptor
    
    Some devices have CDC_CM descriptors that would point us to
    the wrong interfaces. Add a quirk to ignore those (prefering the
    CDC_UNION descriptor effectively)
    
    Reviewed by:            manu
    MFC after:              1 week
    Sponsored by:           Beckhoff Automation GmbH & Co. KG
    Differential Revision:  https://reviews.freebsd.org/D37942
    
    (cherry picked from commit 73c3e8b1dee6cd42de32287ea8a57762b961d8ee)
---
 share/man/man4/usb_quirk.4    | 2 ++
 sys/dev/usb/quirk/usb_quirk.c | 1 +
 sys/dev/usb/quirk/usb_quirk.h | 1 +
 sys/dev/usb/serial/umodem.c   | 4 +++-
 4 files changed, 7 insertions(+), 1 deletion(-)

diff --git a/share/man/man4/usb_quirk.4 b/share/man/man4/usb_quirk.4
index c176993bdbc3..892c85aa6fba 100644
--- a/share/man/man4/usb_quirk.4
+++ b/share/man/man4/usb_quirk.4
@@ -100,6 +100,8 @@ select configuration index 4 by default
 select configuration index 0 by default
 .It UQ_ASSUME_CM_OVER_DATA
 assume cm over data feature
+.It UQ_IGNORE_CDC_CM
+ignore cm descriptor
 .It UQ_WMT_IGNORE
 device should be ignored by wmt driver
 .El
diff --git a/sys/dev/usb/quirk/usb_quirk.c b/sys/dev/usb/quirk/usb_quirk.c
index f0133e3e4b9b..e35297b2340c 100644
--- a/sys/dev/usb/quirk/usb_quirk.c
+++ b/sys/dev/usb/quirk/usb_quirk.c
@@ -660,6 +660,7 @@ static const char *usb_quirk_str[USB_QUIRK_MAX] = {
 	[UQ_CFG_INDEX_4]	= "UQ_CFG_INDEX_4",
 	[UQ_CFG_INDEX_0]	= "UQ_CFG_INDEX_0",
 	[UQ_ASSUME_CM_OVER_DATA]	= "UQ_ASSUME_CM_OVER_DATA",
+	[UQ_IGNORE_CDC_CM]	= "UQ_IGNORE_CDC_CM",
 	[UQ_MSC_NO_TEST_UNIT_READY]	= "UQ_MSC_NO_TEST_UNIT_READY",
 	[UQ_MSC_NO_RS_CLEAR_UA]		= "UQ_MSC_NO_RS_CLEAR_UA",
 	[UQ_MSC_NO_START_STOP]		= "UQ_MSC_NO_START_STOP",
diff --git a/sys/dev/usb/quirk/usb_quirk.h b/sys/dev/usb/quirk/usb_quirk.h
index 85bec036f84d..755465576684 100644
--- a/sys/dev/usb/quirk/usb_quirk.h
+++ b/sys/dev/usb/quirk/usb_quirk.h
@@ -66,6 +66,7 @@ enum {
 	UQ_CFG_INDEX_4,		/* select configuration index 4 by default */
 	UQ_CFG_INDEX_0,		/* select configuration index 0 by default */
 	UQ_ASSUME_CM_OVER_DATA,	/* assume cm over data feature */
+	UQ_IGNORE_CDC_CM,	/* ignore cm descriptor */
 
 	/*
 	 * USB Mass Storage Quirks. See "storage/umass.c" for a
diff --git a/sys/dev/usb/serial/umodem.c b/sys/dev/usb/serial/umodem.c
index c4aba1bdd3e2..ec7e3f21662d 100644
--- a/sys/dev/usb/serial/umodem.c
+++ b/sys/dev/usb/serial/umodem.c
@@ -361,7 +361,9 @@ umodem_attach(device_t dev)
 
 	/* get the data interface number */
 
-	cmd = umodem_get_desc(uaa, UDESC_CS_INTERFACE, UDESCSUB_CDC_CM);
+	cmd = NULL;
+	if (!usb_test_quirk(uaa, UQ_IGNORE_CDC_CM))
+		cmd = umodem_get_desc(uaa, UDESC_CS_INTERFACE, UDESCSUB_CDC_CM);
 
 	if ((cmd == NULL) || (cmd->bLength < sizeof(*cmd))) {
 		cud = usbd_find_descriptor(uaa->device, NULL,