Skip to contentSkip to conversation

USB: core: drop outdated interface-binding comment

PATCH New Johan Hovold 1 participant 2 messages Mar 18, 2021 USB

lore
Share & tools
lore
#0 lore raw

PATCH 1/2 USB: core: drop outdated interface-binding comment

It's been almost twenty years since USB drivers returned a data pointer from their probe routines in order to bind to an interface.

Time to update the documentation for usb_driver_claim_interface().

---
 drivers/usb/core/driver.c | 4 ----
 1 file changed, 4 deletions(-)
drivers/usb/core/driver.c +0 -4
index 4dfa44d6cc3c..a1013d9da08d 100644
@@ -526,10 +526,6 @@ static int usb_unbind_interface(struct device *dev)
  * No device driver should directly modify internal usb_interface or
  * usb_device structure members.
  *
- * Few drivers should need to use this routine, since the most natural
- * way to bind to an interface is to return the private data from
- * the driver's probe() method.
- *
  * Callers must own the device lock, so driver probe() entries don't need
  * extra locking, but other call contexts may need to explicitly claim that
  * lock.
Signature · 1 line
2.26.2
#1 lore raw

PATCH 2/2 USB: core: rename usb_driver_claim_interface() data parameter

It's been almost twenty years since the interface "private data" pointer was removed in favour of using the driver-data pointer of struct device.

Let's rename the driver-data parameter of usb_driver_claim_interface() so that it better reflects how it's used.

---
 drivers/usb/core/driver.c | 6 +++---
 include/linux/usb.h       | 2 +-
 2 files changed, 4 insertions(+), 4 deletions(-)
drivers/usb/core/driver.c +3 -3
index a1013d9da08d..072968c40ade 100644
@@ -519,7 +519,7 @@ static int usb_unbind_interface(struct device *dev)
  * @driver: the driver to be bound
  * @iface: the interface to which it will be bound; must be in the
  *	usb device's active configuration
- * @priv: driver data associated with that interface
+ * @data: driver data associated with that interface
  *
  * This is used by usb device drivers that need to claim more than one
  * interface on a device when probing (audio and acm are current examples).
@@ -533,7 +533,7 @@ static int usb_unbind_interface(struct device *dev)
  * Return: 0 on success.
  */
 int usb_driver_claim_interface(struct usb_driver *driver,
-				struct usb_interface *iface, void *priv)
+				struct usb_interface *iface, void *data)
 {
 	struct device *dev;
 	int retval = 0;
@@ -550,7 +550,7 @@ int usb_driver_claim_interface(struct usb_driver *driver,
 		return -ENODEV;
 
 	dev->driver = &driver->drvwrap.driver;
-	usb_set_intfdata(iface, priv);
+	usb_set_intfdata(iface, data);
 	iface->needs_binding = 0;
 
 	iface->condition = USB_INTERFACE_BOUND;
include/linux/usb.h +1 -1
index d6a41841b93e..08c672e7ece2 100644
@@ -841,7 +841,7 @@ extern int usb_free_streams(struct usb_interface *interface,
 
 /* used these for multi-interface device registration */
 extern int usb_driver_claim_interface(struct usb_driver *driver,
-			struct usb_interface *iface, void *priv);
+			struct usb_interface *iface, void *data);
 
 /**
  * usb_interface_claimed - returns true iff an interface is claimed
Signature · 1 line
2.26.2