Kernel/linux-next
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git synced 2024-12-29 09:12:07 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

usb: add usb_set_intfdata() documentation

Browse Source 
USB drivers do not need to call usb_set_intfdata(intf, NULL) in their
usb_driver::disconnect callback because the core already does it in [1].

However, this fact is widely unknown, c.f.:

  $ git grep "usb_set_intfdata(.*NULL)" | wc -l
  215

Especially, setting the interface to NULL before all action completed
can result in a NULL pointer dereference. Not calling
usb_set_intfdata() at all in disconnect() is the safest method.

Add documentation to usb_set_intfdata() to clarify this point.

Also remove the call in usb-skeletion's disconnect() not to confuse
the new comers.

[1] function usb_unbind_interface() from drivers/usb/core/driver.c
Link: https://elixir.bootlin.com/linux/v6.0/source/drivers/usb/core/driver.c#L497

Signed-off-by: Vincent Mailhol <mailhol.vincent@wanadoo.fr>
Link: https://lore.kernel.org/r/20221128102954.3615579-1-mailhol.vincent@wanadoo.fr
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
Vincent Mailhol 2022-11-28 19:29:54 +09:00 committed by Greg Kroah-Hartman
parent 01792c6036
commit 27ef178497
2 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
drivers/usb/usb-skeleton.c
View File

@ -564,7 +564,6 @@ static void skel_disconnect(struct usb_interface *interface)
int minor = interface->minor; int minor = interface->minor;
dev = usb_get_intfdata(interface); dev = usb_get_intfdata(interface);
usb_set_intfdata(interface, NULL);
/* give back our minor */ /* give back our minor */
usb_deregister_dev(interface, &skel_class); usb_deregister_dev(interface, &skel_class);

12
include/linux/usb.h
View File

@ -265,6 +265,18 @@ static inline void *usb_get_intfdata(struct usb_interface *intf)
return dev_get_drvdata(&intf->dev); return dev_get_drvdata(&intf->dev);
} }
/**
* usb_set_intfdata() - associate driver-specific data with the interface
* @intf: the usb interface
* @data: pointer to the device priv structure or %NULL
*
* Drivers should use this function in their probe() to associate their
* driver-specific data with the usb interface.
*
* When disconnecting, the core will take care of setting @intf back to %NULL,
* so no actions are needed on the driver side. The interface should not be set
* to %NULL before all actions completed (e.g. no outsanding URB remaining).
*/
static inline void usb_set_intfdata(struct usb_interface *intf, void *data) static inline void usb_set_intfdata(struct usb_interface *intf, void *data)
{ {
dev_set_drvdata(&intf->dev, data); dev_set_drvdata(&intf->dev, data);