Skip to contentSkip to conversation

uvcvideo: Add iFunction or iInterface to device names.

PATCH Superseded Peter Boström 2 participants 3 messages Apr 6, 2017 – Apr 17, 2017

Subsystems (2)

v1 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 uvcvideo: Add iFunction or iInterface to device names.

Permits distinguishing between two /dev/videoX entries from the same physical UVC device (that naturally share the same iProduct name).

This change matches current Windows behavior by prioritizing iFunction over iInterface, but unlike Windows it displays both iProduct and iFunction/iInterface strings when both are available.

---
 drivers/media/usb/uvc/uvc_driver.c | 43 +++++++++++++++++++++++++++++++-------
 drivers/media/usb/uvc/uvcvideo.h   |  4 +++-
 2 files changed, 39 insertions(+), 8 deletions(-)
drivers/media/usb/uvc/uvc_driver.c +36 -7
index 04bf35063c4c..66adf8a77e56 100644
@@ -1998,6 +1998,8 @@ static int uvc_probe(struct usb_interface *intf,
 {
 	struct usb_device *udev = interface_to_usbdev(intf);
 	struct uvc_device *dev;
+	char additional_name_buf[UVC_DEVICE_NAME_SIZE];
+	const char *additional_name = NULL;
 	int ret;
 
 	if (id->idVendor && id->idProduct)
@@ -2025,13 +2027,40 @@ static int uvc_probe(struct usb_interface *intf,
 	dev->quirks = (uvc_quirks_param == -1)
 		    ? id->driver_info : uvc_quirks_param;
 
-	if (udev->product != NULL)
-		strlcpy(dev->name, udev->product, sizeof dev->name);
-	else
-		snprintf(dev->name, sizeof dev->name,
-			"UVC Camera (%04x:%04x)",
-			le16_to_cpu(udev->descriptor.idVendor),
-			le16_to_cpu(udev->descriptor.idProduct));
+	/*
+	 * Add iFunction or iInterface to names when available as additional
+	 * distinguishers between interfaces. iFunction is prioritized over
+	 * iInterface which matches Windows behavior at the point of writing.
+	 */
+	if (intf->intf_assoc && intf->intf_assoc->iFunction != 0) {
+		usb_string(udev, intf->intf_assoc->iFunction,
+			   additional_name_buf, sizeof(additional_name_buf));
+		additional_name = additional_name_buf;
+	} else if (intf->cur_altsetting->desc.iInterface != 0) {
+		usb_string(udev, intf->cur_altsetting->desc.iInterface,
+			   additional_name_buf, sizeof(additional_name_buf));
+		additional_name = additional_name_buf;
+	}
+
+	if (additional_name) {
+		if (udev->product) {
+			snprintf(dev->name, sizeof(dev->name), "%s: %s",
+				 udev->product, additional_name);
+		} else {
+			snprintf(dev->name, sizeof(dev->name),
+				 "UVC Camera: %s (%04x:%04x)",
+				 additional_name,
+				 le16_to_cpu(udev->descriptor.idVendor),
+				 le16_to_cpu(udev->descriptor.idProduct));
+		}
+	} else if (udev->product) {
+		strlcpy(dev->name, udev->product, sizeof(dev->name));
+	} else {
+		snprintf(dev->name, sizeof(dev->name),
+			 "UVC Camera (%04x:%04x)",
+			 le16_to_cpu(udev->descriptor.idVendor),
+			 le16_to_cpu(udev->descriptor.idProduct));
+	}
 
 	/* Parse the Video Class control descriptor. */
 	if (uvc_parse_control(dev) < 0) {
drivers/media/usb/uvc/uvcvideo.h +3 -1
index 4205e7a423f0..0cbedaee6e19 100644
@@ -541,13 +541,15 @@ struct uvc_streaming {
 	} clock;
 };
 
+#define UVC_DEVICE_NAME_SIZE	64
+
 struct uvc_device {
 	struct usb_device *udev;
 	struct usb_interface *intf;
 	unsigned long warnings;
 	__u32 quirks;
 	int intfnum;
-	char name[32];
+	char name[UVC_DEVICE_NAME_SIZE];
 
 	struct mutex lock;		/* Protects users */
 	unsigned int users;
Signature · 1 line
2.12.2.715.g7642488e1d-goog
#1 lore raw

I'll put some more info/discussion points inline. Very happy for feedback/input here, thanks!

Quoted 3 lines · Peter Boström

Permits distinguishing between two /dev/videoX entries from the same physical UVC device (that naturally share the same iProduct name).

The device under test has interface associations (and has iFunction present, but not iInterface present). This device is enumerated as "Camera Name: Interface Function" after this patch, instead of two /dev/videoX entries showing up as "Camera Name" with different functions not user visible (apart from lsusb). My tested "Logitech Webcam C930e" shows no additional string (has only iProduct out of these). I haven't tested any other devices (none with iInterface present), and this device is still under development, so any experience or input from interpretating the USB standard is appreciated here.

Quoted 3 lines

This change matches current Windows behavior by prioritizing iFunction over iInterface, but unlike Windows it displays both iProduct and iFunction/iInterface strings when both are available.

Windows only displays one of them, but I thought removing iProduct from the string was scary. Do we want to match Windows for consistency/keeping names short here, or is displaying both (which I personally thinks make more sense) a good strategy here? "Should" iFunction be expected to include the product name? Otherwise I think it's fair to display both since something generic like "main video feed" doesn't tie back to a specific device.

-------------------------------------------------------------------------
String descriptors present | Device function name used
-------------------------------------------------------------------------

iProduct                                |    iProduct
iProduct + iFunction                    |    iFunction
iProduct + iFunction + iInterface       |    iFunction
iProduct + iInterface                   |    iInterface

-------------------------------------------------------------------------

Quoted 72 lines
---
 drivers/media/usb/uvc/uvc_driver.c | 43 +++++++++++++++++++++++++++++++-------
 drivers/media/usb/uvc/uvcvideo.h   |  4 +++-
 2 files changed, 39 insertions(+), 8 deletions(-)
drivers/media/usb/uvc/uvc_driver.c +36 -7
index 04bf35063c4c..66adf8a77e56 100644
@@ -1998,6 +1998,8 @@ static int uvc_probe(struct usb_interface *intf,
 {
        struct usb_device *udev = interface_to_usbdev(intf);
        struct uvc_device *dev;
+       char additional_name_buf[UVC_DEVICE_NAME_SIZE];
+       const char *additional_name = NULL;
        int ret;
 
        if (id->idVendor && id->idProduct)
@@ -2025,13 +2027,40 @@ static int uvc_probe(struct usb_interface *intf,
        dev->quirks = (uvc_quirks_param == -1)
                    ? id->driver_info : uvc_quirks_param;
 
-       if (udev->product != NULL)
-               strlcpy(dev->name, udev->product, sizeof dev->name);
-       else
-               snprintf(dev->name, sizeof dev->name,
-                       "UVC Camera (%04x:%04x)",
-                       le16_to_cpu(udev->descriptor.idVendor),
-                       le16_to_cpu(udev->descriptor.idProduct));
+       /*
+        * Add iFunction or iInterface to names when available as additional
+        * distinguishers between interfaces. iFunction is prioritized over
+        * iInterface which matches Windows behavior at the point of writing.
+        */
+       if (intf->intf_assoc && intf->intf_assoc->iFunction != 0) {
+               usb_string(udev, intf->intf_assoc->iFunction,
+                          additional_name_buf, sizeof(additional_name_buf));
+               additional_name = additional_name_buf;
+       } else if (intf->cur_altsetting->desc.iInterface != 0) {
+               usb_string(udev, intf->cur_altsetting->desc.iInterface,
+                          additional_name_buf, sizeof(additional_name_buf));
+               additional_name = additional_name_buf;
+       }
+
+       if (additional_name) {
+               if (udev->product) {
+                       snprintf(dev->name, sizeof(dev->name), "%s: %s",
+                                udev->product, additional_name);
+               } else {
+                       snprintf(dev->name, sizeof(dev->name),
+                                "UVC Camera: %s (%04x:%04x)",
+                                additional_name,
+                                le16_to_cpu(udev->descriptor.idVendor),
+                                le16_to_cpu(udev->descriptor.idProduct));
+               }
+       } else if (udev->product) {
+               strlcpy(dev->name, udev->product, sizeof(dev->name));
+       } else {
+               snprintf(dev->name, sizeof(dev->name),
+                        "UVC Camera (%04x:%04x)",
+                        le16_to_cpu(udev->descriptor.idVendor),
+                        le16_to_cpu(udev->descriptor.idProduct));
+       }
 
        /* Parse the Video Class control descriptor. */
        if (uvc_parse_control(dev) < 0) {
drivers/media/usb/uvc/uvcvideo.h +0 -0
index 4205e7a423f0..0cbedaee6e19 100644

drivers/media/usb/uvc/uvcvideo.h struct uvc_streaming { · line 544

Quoted 4 lines
drivers/media/usb/uvc/uvcvideo.h +1 -0
@@ -541,13 +541,15 @@ struct uvc_streaming {
        } clock;
 };
 
+#define UVC_DEVICE_NAME_SIZE   64

Note that this expands the device name, and is used because I believe iProduct + iFunction strings can reasonably extend the previous 32 character max.

Quoted 13 lines
drivers/media/usb/uvc/uvcvideo.h +2 -2
+
 struct uvc_device {
        struct usb_device *udev;
        struct usb_interface *intf;
        unsigned long warnings;
        __u32 quirks;
        int intfnum;
-       char name[32];
+       char name[UVC_DEVICE_NAME_SIZE];
 
        struct mutex lock;              /* Protects users */
        unsigned int users;
--
Quoted 2 lines

2.12.2.715.g7642488e1d-goog

Best,
- Peter

maintainer
#2 lore raw
In reply to Peter Boström

Hi Peter,

Thank you for the patch.

Quoted 62 lines · On Thursday 06 April 2017 13:58:25 Peter Boström wrote:

Permits distinguishing between two /dev/videoX entries from the same physical UVC device (that naturally share the same iProduct name).

This change matches current Windows behavior by prioritizing iFunction over iInterface, but unlike Windows it displays both iProduct and iFunction/iInterface strings when both are available.

---
 drivers/media/usb/uvc/uvc_driver.c | 43 ++++++++++++++++++++++++++++-------
 drivers/media/usb/uvc/uvcvideo.h   |  4 +++-
 2 files changed, 39 insertions(+), 8 deletions(-)
(quoted diff) +0 -0

b/drivers/media/usb/uvc/uvc_driver.c index 04bf35063c4c..66adf8a77e56 100644

drivers/media/usb/uvc/uvc_driver.c +26 -7
@@ -1998,6 +1998,8 @@ static int uvc_probe(struct usb_interface *intf,
 {
 	struct usb_device *udev = interface_to_usbdev(intf);
 	struct uvc_device *dev;
+	char additional_name_buf[UVC_DEVICE_NAME_SIZE];
+	const char *additional_name = NULL;
 	int ret;
 
 	if (id->idVendor && id->idProduct)
@@ -2025,13 +2027,40 @@ static int uvc_probe(struct usb_interface *intf,
 	dev->quirks = (uvc_quirks_param == -1)
 		    ? id->driver_info : uvc_quirks_param;
 
-	if (udev->product != NULL)
-		strlcpy(dev->name, udev->product, sizeof dev->name);
-	else
-		snprintf(dev->name, sizeof dev->name,
-			"UVC Camera (%04x:%04x)",
-			le16_to_cpu(udev->descriptor.idVendor),
-			le16_to_cpu(udev->descriptor.idProduct));
+	/*
+	 * Add iFunction or iInterface to names when available as additional
+	 * distinguishers between interfaces. iFunction is prioritized over
+	 * iInterface which matches Windows behavior at the point of writing.
+	 */
+	if (intf->intf_assoc && intf->intf_assoc->iFunction != 0) {
+		usb_string(udev, intf->intf_assoc->iFunction,
+			   additional_name_buf, sizeof(additional_name_buf));
+		additional_name = additional_name_buf;
+	} else if (intf->cur_altsetting->desc.iInterface != 0) {
+		usb_string(udev, intf->cur_altsetting->desc.iInterface,
+			   additional_name_buf, sizeof(additional_name_buf));
+		additional_name = additional_name_buf;
+	}
+
+	if (additional_name) {
+		if (udev->product) {
+			snprintf(dev->name, sizeof(dev->name), "%s: %s",
+				 udev->product, additional_name);
+		} else {
+			snprintf(dev->name, sizeof(dev->name),
+				 "UVC Camera: %s (%04x:%04x)",
+				 additional_name,
+				 le16_to_cpu(udev->descriptor.idVendor),

drivers/media/usb/uvc/uvc_driver.c static int uvc_probe(struct usb_interface *intf, · line 2063

Quoted 10 lines
drivers/media/usb/uvc/uvc_driver.c +10 -0
+				 le16_to_cpu(udev->descriptor.idProduct));
+		}
+	} else if (udev->product) {
+		strlcpy(dev->name, udev->product, sizeof(dev->name));
+	} else {
+		snprintf(dev->name, sizeof(dev->name),
+			 "UVC Camera (%04x:%04x)",
+			 le16_to_cpu(udev->descriptor.idVendor),
+			 le16_to_cpu(udev->descriptor.idProduct));
+	}

This makes sense to me, but I think we could come up with a version of the same code that wouldn't require the temporary 64 bytes buffer on the stack. How about the following (untested) code ?

drivers/media/usb/uvc/uvc_driver.c +19 -0
index 602256ffe14d..9b90a1ac5945 100644
@@ -2013,6 +2013,7 @@ static int uvc_probe(struct usb_interface *intf,
 {
 	struct usb_device *udev = interface_to_usbdev(intf);
 	struct uvc_device *dev;
+	int string;
 	int ret;
 
 	if (id->idVendor && id->idProduct)
@@ -2048,6 +2049,24 @@ static int uvc_probe(struct usb_interface *intf,
 			le16_to_cpu(udev->descriptor.idVendor),
 			le16_to_cpu(udev->descriptor.idProduct));
 
+	/*
+	 * Add iFunction or iInterface to names when available as additional
+	 * distinguishers between interfaces. iFunction is prioritized over
+	 * iInterface which matches Windows behavior at the point of writing.
+	 */
+	string = intf->intf_assoc ? intf->intf_assoc->iFunction
+	       : intf->cur_altsetting->desc.iInterface;
+	if (string != 0) {
+		size_t len;
+
+		strlcat(dev->name, ": ", sizeof(dev->name));
+		len = strlen(dev->name);
+
+		/* usb_string() accounts for the terminating NULL character. */
+		usb_string(udev, string, dev->name + len,
+			   sizeof(dev->name) - len);
+	}
+
 	/* Parse the Video Class control descriptor. */
 	if (uvc_parse_control(dev) < 0) {
 		uvc_trace(UVC_TRACE_PROBE, "Unable to parse UVC "
drivers/media/usb/uvc/uvcvideo.h +1 -1
index 15e415e32c7f..f5bb42c6b023 100644
@@ -556,7 +556,7 @@ struct uvc_device {
 	unsigned long warnings;
 	__u32 quirks;
 	int intfnum;
-	char name[32];
+	char name[64];
 
 	struct mutex lock;		/* Protects users */
 	unsigned int users;
Quoted 23 lines
drivers/media/usb/uvc/uvc_driver.c +0 -0
 	/* Parse the Video Class control descriptor. */
 	if (uvc_parse_control(dev) < 0) {
(quoted diff) +0 -0

b/drivers/media/usb/uvc/uvcvideo.h index 4205e7a423f0..0cbedaee6e19 100644

drivers/media/usb/uvc/uvcvideo.h +3 -1
@@ -541,13 +541,15 @@ struct uvc_streaming {
 	} clock;
 };
 
+#define UVC_DEVICE_NAME_SIZE	64
+
 struct uvc_device {
 	struct usb_device *udev;
 	struct usb_interface *intf;
 	unsigned long warnings;
 	__u32 quirks;
 	int intfnum;
-	char name[32];
+	char name[UVC_DEVICE_NAME_SIZE];
 
 	struct mutex lock;		/* Protects users */
 	unsigned int users;
Signature · 3 lines
Regards,

Laurent Pinchart