linux/drivers/usb
Julia Lawall 2e0fe70968 USB: drivers: use USB API functions rather than constants
This set of patches introduces calls to the following set of functions:

usb_endpoint_dir_in(epd)
usb_endpoint_dir_out(epd)
usb_endpoint_is_bulk_in(epd)
usb_endpoint_is_bulk_out(epd)
usb_endpoint_is_int_in(epd)
usb_endpoint_is_int_out(epd)
usb_endpoint_num(epd)
usb_endpoint_type(epd)
usb_endpoint_xfer_bulk(epd)
usb_endpoint_xfer_control(epd)
usb_endpoint_xfer_int(epd)
usb_endpoint_xfer_isoc(epd)

In some cases, introducing one of these functions is not possible, and it
just replaces an explicit integer value by one of the following constants:

USB_ENDPOINT_XFER_BULK
USB_ENDPOINT_XFER_CONTROL
USB_ENDPOINT_XFER_INT
USB_ENDPOINT_XFER_ISOC

An extract of the semantic patch that makes these changes is as follows:
(http://www.emn.fr/x-info/coccinelle/)

// <smpl>
@r1@ struct usb_endpoint_descriptor *epd; @@

- ((epd->bmAttributes & \(USB_ENDPOINT_XFERTYPE_MASK\|3\)) ==
- \(USB_ENDPOINT_XFER_CONTROL\|0\))
+ usb_endpoint_xfer_control(epd)

@r5@ struct usb_endpoint_descriptor *epd; @@

- ((epd->bEndpointAddress & \(USB_ENDPOINT_DIR_MASK\|0x80\)) ==
-  \(USB_DIR_IN\|0x80\))
+ usb_endpoint_dir_in(epd)

@inc@
@@

#include <linux/usb.h>

@depends on !inc && (r1||r5)@
@@

+ #include <linux/usb.h>
  #include <linux/usb/...>
// </smpl>

Signed-off-by: Julia Lawall <julia@diku.dk>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2009-03-24 16:20:28 -07:00
..
atm USB: atm/cxacru, fix lock imbalance 2009-03-17 14:01:28 -07:00
c67x00 usb/c67x00 endianness annotations 2008-06-04 08:06:01 -07:00
class usblp: continuously poll for status 2009-03-24 16:20:26 -07:00
core USB: drivers: use USB API functions rather than constants 2009-03-24 16:20:28 -07:00
gadget USB: Remove redundant test in pxa27x_udc and ftdi_sio 2009-03-24 16:20:28 -07:00
host USB: drivers: use USB API functions rather than constants 2009-03-24 16:20:28 -07:00
image USB: image/mdc800, fix lock imbalance 2009-03-17 14:01:28 -07:00
misc USB: misc/vstusb, fix lock imbalance 2009-03-17 14:01:29 -07:00
mon USB: usbmon: Implement compat_ioctl 2009-01-27 16:15:36 -08:00
musb USB: musb: fix srp sysfs entry deletion 2009-02-27 14:40:51 -08:00
otg USB: gpio_vbus: add delayed vbus_session calls 2009-03-24 16:20:26 -07:00
serial USB: drivers: use USB API functions rather than constants 2009-03-24 16:20:28 -07:00
storage USB: drivers: use USB API functions rather than constants 2009-03-24 16:20:28 -07:00
wusbcore USB: wusbcore/wa-xfer, fix lock imbalance 2009-03-17 14:01:29 -07:00
Kconfig USB: move isp1301_omap to drivers/usb/otg 2009-01-07 10:00:02 -08:00
Makefile USB: Correct Makefile to make isp1760 buildable 2009-02-09 11:19:49 -08:00
README USB: fix directory references in usb/README 2007-11-28 13:58:34 -08:00
usb-skeleton.c USB: remove unnecessary type casting of urb->context 2008-04-24 21:16:55 -07:00

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 ("khubd").

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.