linux/drivers/usb
David S. Miller cf124db566 net: Fix inconsistent teardown and release of private netdev state.
Network devices can allocate reasources and private memory using
netdev_ops->ndo_init().  However, the release of these resources
can occur in one of two different places.

Either netdev_ops->ndo_uninit() or netdev->destructor().

The decision of which operation frees the resources depends upon
whether it is necessary for all netdev refs to be released before it
is safe to perform the freeing.

netdev_ops->ndo_uninit() presumably can occur right after the
NETDEV_UNREGISTER notifier completes and the unicast and multicast
address lists are flushed.

netdev->destructor(), on the other hand, does not run until the
netdev references all go away.

Further complicating the situation is that netdev->destructor()
almost universally does also a free_netdev().

This creates a problem for the logic in register_netdevice().
Because all callers of register_netdevice() manage the freeing
of the netdev, and invoke free_netdev(dev) if register_netdevice()
fails.

If netdev_ops->ndo_init() succeeds, but something else fails inside
of register_netdevice(), it does call ndo_ops->ndo_uninit().  But
it is not able to invoke netdev->destructor().

This is because netdev->destructor() will do a free_netdev() and
then the caller of register_netdevice() will do the same.

However, this means that the resources that would normally be released
by netdev->destructor() will not be.

Over the years drivers have added local hacks to deal with this, by
invoking their destructor parts by hand when register_netdevice()
fails.

Many drivers do not try to deal with this, and instead we have leaks.

Let's close this hole by formalizing the distinction between what
private things need to be freed up by netdev->destructor() and whether
the driver needs unregister_netdevice() to perform the free_netdev().

netdev->priv_destructor() performs all actions to free up the private
resources that used to be freed by netdev->destructor(), except for
free_netdev().

netdev->needs_free_netdev is a boolean that indicates whether
free_netdev() should be done at the end of unregister_netdevice().

Now, register_netdevice() can sanely release all resources after
ndo_ops->ndo_init() succeeds, by invoking both ndo_ops->ndo_uninit()
and netdev->priv_destructor().

And at the end of unregister_netdevice(), we invoke
netdev->priv_destructor() and optionally call free_netdev().

Signed-off-by: David S. Miller <davem@davemloft.net>
2017-06-07 15:53:24 -04:00
..
atm usb: atm: remove unnecessary code 2017-03-16 17:58:44 +09:00
c67x00 c67x00-hcd: use USB_DT_HUB 2015-04-03 19:03:16 +02:00
chipidea Two changes for this v4.12-rc1: 2017-04-18 16:52:20 +02:00
class USB: Revert "cdc-wdm: fix "out-of-sync" due to missing notifications" 2017-04-25 20:04:28 +02:00
common DeviceTree for 4.12: 2017-05-05 19:33:07 -07:00
core USB: hub: fix SS max number of ports 2017-05-17 11:53:02 +02:00
dwc2 usb: changes for v4.12 2017-04-11 16:47:26 +02:00
dwc3 usb: dwc3: keystone: check return value 2017-05-16 14:11:04 +03:00
early usb/early: Add driver for xhci debug capability 2017-03-21 12:30:05 +01:00
gadget net: Fix inconsistent teardown and release of private netdev state. 2017-06-07 15:53:24 -04:00
host usb: host: xhci-plat: propagate return value of platform_get_irq() 2017-05-18 15:19:42 +02:00
image sched/headers: Prepare to move signal wakeup & sigpending methods from <linux/sched.h> into <linux/sched/signal.h> 2017-03-02 08:42:32 +01:00
isp1760 usb: add CONFIG_USB_PCI for system have both PCI HW and non-PCI based USB HW 2017-03-17 13:16:56 +09:00
misc USB: iowarrior: fix info ioctl on big-endian hosts 2017-05-17 11:27:41 +02:00
mon sched/headers: Prepare to move signal wakeup & sigpending methods from <linux/sched.h> into <linux/sched/signal.h> 2017-03-02 08:42:32 +01:00
mtu3 usb: mtu3: Replace the extcon API 2017-04-11 10:58:21 +03:00
musb usb: musb: tusb6010_omap: Do not reset the other direction's packet size 2017-05-18 15:21:17 +02:00
phy usb: changes for v4.12 2017-04-11 16:47:26 +02:00
renesas_usbhs usb: renesas_usbhs: Replace the deprecated extcon API 2017-01-24 11:04:14 +02:00
serial USB: serial: qcserial: add more Lenovo EM74xx device IDs 2017-05-17 17:10:57 +02:00
storage USB: ene_usb6250: fix DMA to the stack 2017-05-17 11:27:40 +02:00
typec usb: typec: add driver for Intel Whiskey Cove PMIC USB Type-C PHY 2017-03-23 13:48:44 +01:00
usbip USB: usbip: fix nonconforming hub descriptor 2017-05-17 11:53:02 +02:00
wusbcore USB: wusbcore: fix NULL-deref at probe 2017-03-14 17:07:30 +08:00
Kconfig usb: USB Type-C connector class 2017-03-23 13:48:44 +01:00
Makefile USB patches for 4.12-rc1 2017-05-04 18:03:51 -07:00
README
usb-skeleton.c USB: usb-skeleton: refactor endpoint retrieval 2017-03-23 13:54:08 +01:00

README

To understand all the Linux-USB framework, you'll use these resources:

    * This source code.  This is necessarily an evolving work, and
      includes kerneldoc that should help you get a current overview.
      ("make pdfdocs", and then look at "usb.pdf" for host side and
      "gadget.pdf" for peripheral side.)  Also, Documentation/usb has
      more information.

    * The USB 2.0 specification (from www.usb.org), with supplements
      such as those for USB OTG and the various device classes.
      The USB specification has a good overview chapter, and USB
      peripherals conform to the widely known "Chapter 9".

    * Chip specifications for USB controllers.  Examples include
      host controllers (on PCs, servers, and more); peripheral
      controllers (in devices with Linux firmware, like printers or
      cell phones); and hard-wired peripherals like Ethernet adapters.

    * Specifications for other protocols implemented by USB peripheral
      functions.  Some are vendor-specific; others are vendor-neutral
      but just standardized outside of the www.usb.org team.

Here is a list of what each subdirectory here is, and what is contained in
them.

core/		- This is for the core USB host code, including the
		  usbfs files and the hub class driver ("hub_wq").

host/		- This is for USB host controller drivers.  This
		  includes UHCI, OHCI, EHCI, and others that might
		  be used with more specialized "embedded" systems.

gadget/		- This is for USB peripheral controller drivers and
		  the various gadget drivers which talk to them.


Individual USB driver directories.  A new driver should be added to the
first subdirectory in the list below that it fits into.

image/		- This is for still image drivers, like scanners or
		  digital cameras.
../input/	- This is for any driver that uses the input subsystem,
		  like keyboard, mice, touchscreens, tablets, etc.
../media/	- This is for multimedia drivers, like video cameras,
		  radios, and any other drivers that talk to the v4l
		  subsystem.
../net/		- This is for network drivers.
serial/		- This is for USB to serial drivers.
storage/	- This is for USB mass-storage drivers.
class/		- This is for all USB device drivers that do not fit
		  into any of the above categories, and work for a range
		  of USB Class specified devices. 
misc/		- This is for all USB device drivers that do not fit
		  into any of the above categories.