svn commit: r368659 - in head/sys: compat/linuxkpi/common/src dev/usb sys

[Hans Petter Selasky]

Author: hselasky
Date: Tue Dec 15 12:05:07 2020
New Revision: 368659
URL: https://svnweb.freebsd.org/changeset/base/368659

Log:
  Improve handling of alternate settings in the USB stack.
  
  Allow setting the alternate interface number to fail when there is only
  one alternate setting present, to comply with the USB specification.
  
  Refactor how iface->num_altsetting is computed.
  
  Bump the __FreeBSD_version due to change of core USB structure.
  
  PR:		251856
  MFC after:	1 week
  Submitted by:	Ma, Horse <Shichun.Ma at dell.com>
  Sponsored by:	Mellanox Technologies // NVIDIA Networking

Modified:
  head/sys/compat/linuxkpi/common/src/linux_usb.c
  head/sys/dev/usb/usb_device.c
  head/sys/dev/usb/usb_request.c
  head/sys/dev/usb/usbdi.h
  head/sys/sys/param.h

Modified: head/sys/compat/linuxkpi/common/src/linux_usb.c
==============================================================================
--- head/sys/compat/linuxkpi/common/src/linux_usb.c	Tue Dec 15 11:51:17 2020	(r368658)
+++ head/sys/compat/linuxkpi/common/src/linux_usb.c	Tue Dec 15 12:05:07 2020	(r368659)
@@ -931,17 +931,12 @@ usb_linux_create_usb_device(struct usb_device *udev, d
 					if (p_ui) {
 						p_ui->altsetting = p_uhi - 1;
 						p_ui->cur_altsetting = p_uhi - 1;
-						p_ui->num_altsetting = 1;
 						p_ui->bsd_iface_index = iface_index;
 						p_ui->linux_udev = udev;
 						p_ui++;
 					}
 					iface_no_curr = iface_no;
 					iface_index++;
-				} else {
-					if (p_ui) {
-						(p_ui - 1)->num_altsetting++;
-					}
 				}
 				break;
 

Modified: head/sys/dev/usb/usb_device.c
==============================================================================
--- head/sys/dev/usb/usb_device.c	Tue Dec 15 11:51:17 2020	(r368658)
+++ head/sys/dev/usb/usb_device.c	Tue Dec 15 12:05:07 2020	(r368659)
@@ -2,7 +2,7 @@
 /*-
  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
  *
- * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
+ * Copyright (c) 2008-2020 Hans Petter Selasky. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
@@ -905,6 +905,10 @@ usb_config_parse(struct usb_device *udev, uint8_t ifac
 			/* update current number of endpoints */
 			ep_curr = ep_max;
 		}
+		/* update number of alternate settings, if any */
+		if (iface_index == USB_IFACE_INDEX_ANY)
+			iface->num_altsetting = ips.iface_index_alt + 1;
+
 		/* check for init */
 		if (do_init) {
 			/* setup the USB interface structure */

Modified: head/sys/dev/usb/usb_request.c
==============================================================================
--- head/sys/dev/usb/usb_request.c	Tue Dec 15 11:51:17 2020	(r368658)
+++ head/sys/dev/usb/usb_request.c	Tue Dec 15 12:05:07 2020	(r368659)
@@ -4,7 +4,7 @@
  *
  * Copyright (c) 1998 The NetBSD Foundation, Inc. All rights reserved.
  * Copyright (c) 1998 Lennart Augustsson. All rights reserved.
- * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
+ * Copyright (c) 2008-2020 Hans Petter Selasky. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
@@ -1436,6 +1436,7 @@ usbd_req_set_alt_interface_no(struct usb_device *udev,
 {
 	struct usb_interface *iface = usbd_get_iface(udev, iface_index);
 	struct usb_device_request req;
+	usb_error_t err;
 
 	if ((iface == NULL) || (iface->idesc == NULL))
 		return (USB_ERR_INVAL);
@@ -1447,7 +1448,17 @@ usbd_req_set_alt_interface_no(struct usb_device *udev,
 	req.wIndex[0] = iface->idesc->bInterfaceNumber;
 	req.wIndex[1] = 0;
 	USETW(req.wLength, 0);
-	return (usbd_do_request(udev, mtx, &req, 0));
+	err = usbd_do_request(udev, mtx, &req, 0);
+	if (err == USB_ERR_STALLED && iface->num_altsetting == 1) {
+		/*
+		 * The USB specification chapter 9.4.10 says that USB
+		 * devices having only one alternate setting are
+		 * allowed to STALL this request. Ignore this failure.
+		 */
+		err = 0;
+		DPRINTF("Setting default alternate number failed. (ignored)\n");
+	}
+	return (err);
 }
 
 /*------------------------------------------------------------------------*

Modified: head/sys/dev/usb/usbdi.h
==============================================================================
--- head/sys/dev/usb/usbdi.h	Tue Dec 15 11:51:17 2020	(r368658)
+++ head/sys/dev/usb/usbdi.h	Tue Dec 15 12:05:07 2020	(r368659)
@@ -174,6 +174,9 @@ struct usb_endpoint {
 struct usb_interface {
 	struct usb_interface_descriptor *idesc;
 	device_t subdev;
+	/* Total number of alternate settings, from 1 to 256 */
+	uint16_t num_altsetting;
+	/* Current alternate interface index, from 0 to 255 */
 	uint8_t	alt_index;
 	uint8_t	parent_iface_index;
 
@@ -183,7 +186,6 @@ struct usb_interface {
 	struct usb_device *linux_udev;
 	void   *bsd_priv_sc;		/* device specific information */
 	char   *pnpinfo;		/* additional PnP-info for this interface */
-	uint8_t	num_altsetting;		/* number of alternate settings */
 	uint8_t	bsd_iface_index;
 };
 

Modified: head/sys/sys/param.h
==============================================================================
--- head/sys/sys/param.h	Tue Dec 15 11:51:17 2020	(r368658)
+++ head/sys/sys/param.h	Tue Dec 15 12:05:07 2020	(r368659)
@@ -60,7 +60,7 @@
  *		in the range 5 to 9.
  */
 #undef __FreeBSD_version
-#define __FreeBSD_version 1300131	/* Master, propagated to newvers */
+#define __FreeBSD_version 1300132	/* Master, propagated to newvers */
 
 /*
  * __FreeBSD_kernel__ indicates that this system uses the kernel of FreeBSD,