1c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#ifndef __LINUX_USB_H 2c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define __LINUX_USB_H 3c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 4c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#include <linux/mod_devicetable.h> 5c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#include <linux/usb_ch9.h> 6c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 7c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define USB_MAJOR 180 8c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define USB_DEVICE_MAJOR 189 9c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 10c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 11c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#ifdef __KERNEL__ 12c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 13c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#include <linux/errno.h> /* for -ENODEV */ 14c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#include <linux/delay.h> /* for mdelay() */ 15c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#include <linux/interrupt.h> /* for in_interrupt() */ 16c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#include <linux/list.h> /* for struct list_head */ 17c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#include <linux/kref.h> /* for struct kref */ 18c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#include <linux/device.h> /* for struct device */ 19c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#include <linux/fs.h> /* for struct file_operations */ 20c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#include <linux/completion.h> /* for struct completion */ 21c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#include <linux/sched.h> /* for current && schedule_timeout */ 22c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 23c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustruct usb_device; 24c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustruct usb_driver; 25c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 26c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/*-------------------------------------------------------------------------*/ 27c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 28c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* 29c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Host-side wrappers for standard USB descriptors ... these are parsed 30c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * from the data provided by devices. Parsing turns them from a flat 31c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * sequence of descriptors into a hierarchy: 32c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 33c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * - devices have one (usually) or more configs; 34c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * - configs have one (often) or more interfaces; 35c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * - interfaces have one (usually) or more settings; 36c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * - each interface setting has zero or (usually) more endpoints. 37c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 38c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * And there might be other descriptors mixed in with those. 39c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 40c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Devices may also have class-specific or vendor-specific descriptors. 41c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 42c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 43c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustruct ep_device; 44c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 45c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/** 46c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * struct usb_host_endpoint - host-side endpoint descriptor and queue 47c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @desc: descriptor for this endpoint, wMaxPacketSize in native byteorder 48c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @urb_list: urbs queued to this endpoint; maintained by usbcore 49c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @hcpriv: for use by HCD; typically holds hardware dma queue head (QH) 50c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * with one or more transfer descriptors (TDs) per urb 51c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @ep_dev: ep_device for sysfs info 52c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @extra: descriptors following this endpoint in the configuration 53c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @extralen: how many bytes of "extra" are valid 54c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 55c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * USB requests are always queued to a given endpoint, identified by a 56c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * descriptor within an active interface in a given USB configuration. 57c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 58c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustruct usb_host_endpoint { 59c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_endpoint_descriptor desc; 60c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct list_head urb_list; 61c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru void *hcpriv; 62c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct ep_device *ep_dev; /* For sysfs info */ 63c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 64c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru unsigned char *extra; /* Extra descriptors */ 65c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int extralen; 66c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru}; 67c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 68c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* host-side wrapper for one interface setting's parsed descriptors */ 69c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustruct usb_host_interface { 70c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_interface_descriptor desc; 71c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 72c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru /* array of desc.bNumEndpoint endpoints associated with this 73c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * interface setting. these will be in no particular order. 74c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 75c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_host_endpoint *endpoint; 76c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 77c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru char *string; /* iInterface string, if present */ 78c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru unsigned char *extra; /* Extra descriptors */ 79c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int extralen; 80c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru}; 81c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 82c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruenum usb_interface_condition { 83c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru USB_INTERFACE_UNBOUND = 0, 84c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru USB_INTERFACE_BINDING, 85c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru USB_INTERFACE_BOUND, 86c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru USB_INTERFACE_UNBINDING, 87c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru}; 88c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 89c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/** 90c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * struct usb_interface - what usb device drivers talk to 91c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @altsetting: array of interface structures, one for each alternate 92c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * setting that may be selected. Each one includes a set of 93c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * endpoint configurations. They will be in no particular order. 94c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @num_altsetting: number of altsettings defined. 95c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @cur_altsetting: the current altsetting. 96c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @driver: the USB driver that is bound to this interface. 97c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @minor: the minor number assigned to this interface, if this 98c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * interface is bound to a driver that uses the USB major number. 99c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * If this interface does not use the USB major, this field should 100c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * be unused. The driver should set this value in the probe() 101c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * function of the driver, after it has been assigned a minor 102c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * number from the USB core by calling usb_register_dev(). 103c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @condition: binding state of the interface: not bound, binding 104c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * (in probe()), bound to a driver, or unbinding (in disconnect()) 105c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @dev: driver model's view of this device 106c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @class_dev: driver model's class view of this device. 107c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 108c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * USB device drivers attach to interfaces on a physical device. Each 109c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * interface encapsulates a single high level function, such as feeding 110c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * an audio stream to a speaker or reporting a change in a volume control. 111c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Many USB devices only have one interface. The protocol used to talk to 112c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * an interface's endpoints can be defined in a usb "class" specification, 113c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * or by a product's vendor. The (default) control endpoint is part of 114c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * every interface, but is never listed among the interface's descriptors. 115c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 116c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * The driver that is bound to the interface can use standard driver model 117c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * calls such as dev_get_drvdata() on the dev member of this structure. 118c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 119c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Each interface may have alternate settings. The initial configuration 120c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * of a device sets altsetting 0, but the device driver can change 121c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * that setting using usb_set_interface(). Alternate settings are often 122c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * used to control the the use of periodic endpoints, such as by having 123c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * different endpoints use different amounts of reserved USB bandwidth. 124c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * All standards-conformant USB devices that use isochronous endpoints 125c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * will use them in non-default settings. 126c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 127c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * The USB specification says that alternate setting numbers must run from 128c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 0 to one less than the total number of alternate settings. But some 129c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * devices manage to mess this up, and the structures aren't necessarily 130c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * stored in numerical order anyhow. Use usb_altnum_to_altsetting() to 131c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * look up an alternate setting in the altsetting array based on its number. 132c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 133c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustruct usb_interface { 134c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru /* array of alternate settings for this interface, 135c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * stored in no particular order */ 136c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_host_interface *altsetting; 137c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 138c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_host_interface *cur_altsetting; /* the currently 139c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * active alternate setting */ 140c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru unsigned num_altsetting; /* number of alternate settings */ 141c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 142c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int minor; /* minor number this interface is 143c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * bound to */ 144c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru enum usb_interface_condition condition; /* state of binding */ 145c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct device dev; /* interface specific device info */ 146c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct class_device *class_dev; 147c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru}; 148c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define to_usb_interface(d) container_of(d, struct usb_interface, dev) 149c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define interface_to_usbdev(intf) \ 150c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru container_of(intf->dev.parent, struct usb_device, dev) 151c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 152c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustatic inline void *usb_get_intfdata (struct usb_interface *intf) 153c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru{ 154c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru return dev_get_drvdata (&intf->dev); 155c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru} 156c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 157c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustatic inline void usb_set_intfdata (struct usb_interface *intf, void *data) 158c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru{ 159c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru dev_set_drvdata(&intf->dev, data); 160c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru} 161c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 162c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustruct usb_interface *usb_get_intf(struct usb_interface *intf); 163c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruvoid usb_put_intf(struct usb_interface *intf); 164c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 165c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* this maximum is arbitrary */ 166c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define USB_MAXINTERFACES 32 167c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 168c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/** 169c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * struct usb_interface_cache - long-term representation of a device interface 170c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @num_altsetting: number of altsettings defined. 171c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @ref: reference counter. 172c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @altsetting: variable-length array of interface structures, one for 173c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * each alternate setting that may be selected. Each one includes a 174c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * set of endpoint configurations. They will be in no particular order. 175c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 176c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * These structures persist for the lifetime of a usb_device, unlike 177c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * struct usb_interface (which persists only as long as its configuration 178c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * is installed). The altsetting arrays can be accessed through these 179c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * structures at any time, permitting comparison of configurations and 180c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * providing support for the /proc/bus/usb/devices pseudo-file. 181c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 182c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustruct usb_interface_cache { 183c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru unsigned num_altsetting; /* number of alternate settings */ 184c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct kref ref; /* reference counter */ 185c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 186c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru /* variable-length array of alternate settings for this interface, 187c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * stored in no particular order */ 188c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_host_interface altsetting[0]; 189c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru}; 190c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define ref_to_usb_interface_cache(r) \ 191c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru container_of(r, struct usb_interface_cache, ref) 192c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define altsetting_to_usb_interface_cache(a) \ 193c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru container_of(a, struct usb_interface_cache, altsetting[0]) 194c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 195c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/** 196c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * struct usb_host_config - representation of a device's configuration 197c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @desc: the device's configuration descriptor. 198c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @string: pointer to the cached version of the iConfiguration string, if 199c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * present for this configuration. 200c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @interface: array of pointers to usb_interface structures, one for each 201c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * interface in the configuration. The number of interfaces is stored 202c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * in desc.bNumInterfaces. These pointers are valid only while the 203c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * the configuration is active. 204c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @intf_cache: array of pointers to usb_interface_cache structures, one 205c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * for each interface in the configuration. These structures exist 206c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * for the entire life of the device. 207c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @extra: pointer to buffer containing all extra descriptors associated 208c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * with this configuration (those preceding the first interface 209c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * descriptor). 210c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @extralen: length of the extra descriptors buffer. 211c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 212c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * USB devices may have multiple configurations, but only one can be active 213c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * at any time. Each encapsulates a different operational environment; 214c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * for example, a dual-speed device would have separate configurations for 215c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * full-speed and high-speed operation. The number of configurations 216c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * available is stored in the device descriptor as bNumConfigurations. 217c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 218c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * A configuration can contain multiple interfaces. Each corresponds to 219c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * a different function of the USB device, and all are available whenever 220c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * the configuration is active. The USB standard says that interfaces 221c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot 222c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * of devices get this wrong. In addition, the interface array is not 223c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * guaranteed to be sorted in numerical order. Use usb_ifnum_to_if() to 224c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * look up an interface entry based on its number. 225c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 226c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Device drivers should not attempt to activate configurations. The choice 227c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * of which configuration to install is a policy decision based on such 228c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * considerations as available power, functionality provided, and the user's 229c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * desires (expressed through userspace tools). However, drivers can call 230c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * usb_reset_configuration() to reinitialize the current configuration and 231c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * all its interfaces. 232c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 233c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustruct usb_host_config { 234c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_config_descriptor desc; 235c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 236c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru char *string; /* iConfiguration string, if present */ 237c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru /* the interfaces associated with this configuration, 238c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * stored in no particular order */ 239c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_interface *interface[USB_MAXINTERFACES]; 240c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 241c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru /* Interface information available even when this is not the 242c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * active configuration */ 243c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_interface_cache *intf_cache[USB_MAXINTERFACES]; 244c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 245c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru unsigned char *extra; /* Extra descriptors */ 246c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int extralen; 247c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru}; 248c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 249c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruint __usb_get_extra_descriptor(char *buffer, unsigned size, 250c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru unsigned char type, void **ptr); 251c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define usb_get_extra_descriptor(ifpoint,type,ptr)\ 252c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru __usb_get_extra_descriptor((ifpoint)->extra,(ifpoint)->extralen,\ 253c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru type,(void**)ptr) 254c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 255c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* ----------------------------------------------------------------------- */ 256c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 257c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustruct usb_operations; 258c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 259c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* USB device number allocation bitmap */ 260c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustruct usb_devmap { 261c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru unsigned long devicemap[128 / (8*sizeof(unsigned long))]; 262c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru}; 263c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 264c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* 265c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Allocated per bus (tree of devices) we have: 266c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 267c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustruct usb_bus { 268c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct device *controller; /* host/master side hardware */ 269c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int busnum; /* Bus number (in order of reg) */ 270c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru char *bus_name; /* stable id (PCI slot_name etc) */ 271c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru u8 otg_port; /* 0, or number of OTG/HNP port */ 272c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru unsigned is_b_host:1; /* true during some HNP roleswitches */ 273c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru unsigned b_hnp_enable:1; /* OTG: did A-Host enable HNP? */ 274c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 275c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int devnum_next; /* Next open device number in 276c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * round-robin allocation */ 277c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 278c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_devmap devmap; /* device address allocation map */ 279c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_operations *op; /* Operations (specific to the HC) */ 280c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_device *root_hub; /* Root hub */ 281c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct list_head bus_list; /* list of busses */ 282c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru void *hcpriv; /* Host Controller private data */ 283c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 284c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int bandwidth_allocated; /* on this bus: how much of the time 285c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * reserved for periodic (intr/iso) 286c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * requests is used, on average? 287c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Units: microseconds/frame. 288c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Limits: Full/low speed reserve 90%, 289c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * while high speed reserves 80%. 290c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 291c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int bandwidth_int_reqs; /* number of Interrupt requests */ 292c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int bandwidth_isoc_reqs; /* number of Isoc. requests */ 293c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 294c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct dentry *usbfs_dentry; /* usbfs dentry entry for the bus */ 295c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 296c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct class_device *class_dev; /* class device for this bus */ 297c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct kref kref; /* reference counting for this bus */ 298c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru void (*release)(struct usb_bus *bus); 299c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 300c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#if defined(CONFIG_USB_MON) 301c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct mon_bus *mon_bus; /* non-null when associated */ 302c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int monitored; /* non-zero when monitored */ 303c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#endif 304c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru}; 305c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 306c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* ----------------------------------------------------------------------- */ 307c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 308c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* This is arbitrary. 309c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * From USB 2.0 spec Table 11-13, offset 7, a hub can 310c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * have up to 255 ports. The most yet reported is 10. 311c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 312c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define USB_MAXCHILDREN (16) 313c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 314c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustruct usb_tt; 315c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 316c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* 317c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * struct usb_device - kernel's representation of a USB device 318c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 319c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * FIXME: Write the kerneldoc! 320c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 321c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Usbcore drivers should not set usbdev->state directly. Instead use 322c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * usb_set_device_state(). 323c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 324c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustruct usb_device { 325c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int devnum; /* Address on USB bus */ 326c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru char devpath [16]; /* Use in messages: /port/port/... */ 327c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru enum usb_device_state state; /* configured, not attached, etc */ 328c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru enum usb_device_speed speed; /* high/full/low (or error) */ 329c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 330c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_tt *tt; /* low/full speed dev, highspeed hub */ 331c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int ttport; /* device port on that tt hub */ 332c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 333c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru unsigned int toggle[2]; /* one bit for each endpoint 334c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * ([0] = IN, [1] = OUT) */ 335c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 336c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_device *parent; /* our hub, unless we're the root */ 337c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_bus *bus; /* Bus we're part of */ 338c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_host_endpoint ep0; 339c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 340c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct device dev; /* Generic device interface */ 341c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 342c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_device_descriptor descriptor;/* Descriptor */ 343c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_host_config *config; /* All of the configs */ 344c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 345c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_host_config *actconfig;/* the active configuration */ 346c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_host_endpoint *ep_in[16]; 347c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_host_endpoint *ep_out[16]; 348c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 349c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru char **rawdescriptors; /* Raw descriptors for each config */ 350c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 351c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru unsigned short bus_mA; /* Current available from the bus */ 352c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru u8 portnum; /* Parent port number (origin 1) */ 353c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 354c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int have_langid; /* whether string_langid is valid */ 355c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int string_langid; /* language ID for strings */ 356c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 357c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru /* static strings from the device */ 358c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru char *product; /* iProduct string, if present */ 359c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru char *manufacturer; /* iManufacturer string, if present */ 360c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru char *serial; /* iSerialNumber string, if present */ 361c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 362c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct list_head filelist; 363c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct class_device *class_dev; 364c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct dentry *usbfs_dentry; /* usbfs dentry entry for the device */ 365c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 366c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru /* 367c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Child devices - these can be either new devices 368c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * (if this is a hub device), or different instances 369c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * of this same device. 370c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 371c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Each instance needs its own set of data structures. 372c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 373c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 374c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int maxchild; /* Number of ports if hub */ 375c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_device *children[USB_MAXCHILDREN]; 376c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru}; 377c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define to_usb_device(d) container_of(d, struct usb_device, dev) 378c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 379c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern struct usb_device *usb_get_dev(struct usb_device *dev); 380c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern void usb_put_dev(struct usb_device *dev); 381c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 382c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* USB device locking */ 383c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define usb_lock_device(udev) down(&(udev)->dev.sem) 384c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define usb_unlock_device(udev) up(&(udev)->dev.sem) 385c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define usb_trylock_device(udev) down_trylock(&(udev)->dev.sem) 386c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern int usb_lock_device_for_reset(struct usb_device *udev, 387c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_interface *iface); 388c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 389c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* USB port reset for device reinitialization */ 390c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern int usb_reset_device(struct usb_device *dev); 391c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern int usb_reset_composite_device(struct usb_device *dev, 392c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_interface *iface); 393c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 394c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern struct usb_device *usb_find_device(u16 vendor_id, u16 product_id); 395c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 396c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/*-------------------------------------------------------------------------*/ 397c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 398c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* for drivers using iso endpoints */ 399c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern int usb_get_current_frame_number (struct usb_device *usb_dev); 400c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 401c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* used these for multi-interface device registration */ 402c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern int usb_driver_claim_interface(struct usb_driver *driver, 403c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_interface *iface, void* priv); 404c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 405c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/** 406c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * usb_interface_claimed - returns true iff an interface is claimed 407c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @iface: the interface being checked 408c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 409c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Returns true (nonzero) iff the interface is claimed, else false (zero). 410c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Callers must own the driver model's usb bus readlock. So driver 411c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * probe() entries don't need extra locking, but other call contexts 412c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * may need to explicitly claim that lock. 413c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 414c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 415c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustatic inline int usb_interface_claimed(struct usb_interface *iface) { 416c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru return (iface->dev.driver != NULL); 417c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru} 418c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 419c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern void usb_driver_release_interface(struct usb_driver *driver, 420c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_interface *iface); 421c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruconst struct usb_device_id *usb_match_id(struct usb_interface *interface, 422c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru const struct usb_device_id *id); 423c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 424c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern struct usb_interface *usb_find_interface(struct usb_driver *drv, 425c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int minor); 426c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern struct usb_interface *usb_ifnum_to_if(struct usb_device *dev, 427c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru unsigned ifnum); 428c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern struct usb_host_interface *usb_altnum_to_altsetting( 429c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_interface *intf, unsigned int altnum); 430c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 431c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 432c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/** 433c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * usb_make_path - returns stable device path in the usb tree 434c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @dev: the device whose path is being constructed 435c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @buf: where to put the string 436c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @size: how big is "buf"? 437c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 438c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Returns length of the string (> 0) or negative if size was too small. 439c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 440c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * This identifier is intended to be "stable", reflecting physical paths in 441c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * hardware such as physical bus addresses for host controllers or ports on 442c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * USB hubs. That makes it stay the same until systems are physically 443c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * reconfigured, by re-cabling a tree of USB devices or by moving USB host 444c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * controllers. Adding and removing devices, including virtual root hubs 445c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * in host controller driver modules, does not change these path identifers; 446c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * neither does rebooting or re-enumerating. These are more useful identifiers 447c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * than changeable ("unstable") ones like bus numbers or device addresses. 448c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 449c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * With a partial exception for devices connected to USB 2.0 root hubs, these 450c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * identifiers are also predictable. So long as the device tree isn't changed, 451c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * plugging any USB device into a given hub port always gives it the same path. 452c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Because of the use of "companion" controllers, devices connected to ports on 453c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are 454c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * high speed, and a different one if they are full or low speed. 455c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 456c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustatic inline int usb_make_path (struct usb_device *dev, char *buf, 457c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru size_t size) 458c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru{ 459c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int actual; 460c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru actual = snprintf (buf, size, "usb-%s-%s", dev->bus->bus_name, 461c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru dev->devpath); 462c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru return (actual >= (int)size) ? -1 : actual; 463c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru} 464c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 465c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/*-------------------------------------------------------------------------*/ 466c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 467c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define USB_DEVICE_ID_MATCH_DEVICE \ 468c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT) 469c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define USB_DEVICE_ID_MATCH_DEV_RANGE \ 470c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI) 471c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION \ 472c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE) 473c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define USB_DEVICE_ID_MATCH_DEV_INFO \ 474c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru (USB_DEVICE_ID_MATCH_DEV_CLASS | \ 475c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru USB_DEVICE_ID_MATCH_DEV_SUBCLASS | \ 476c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru USB_DEVICE_ID_MATCH_DEV_PROTOCOL) 477c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define USB_DEVICE_ID_MATCH_INT_INFO \ 478c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru (USB_DEVICE_ID_MATCH_INT_CLASS | \ 479c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru USB_DEVICE_ID_MATCH_INT_SUBCLASS | \ 480c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru USB_DEVICE_ID_MATCH_INT_PROTOCOL) 481c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 482c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/** 483c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * USB_DEVICE - macro used to describe a specific usb device 484c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @vend: the 16 bit USB Vendor ID 485c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @prod: the 16 bit USB Product ID 486c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 487c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * This macro is used to create a struct usb_device_id that matches a 488c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * specific device. 489c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 490c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define USB_DEVICE(vend,prod) \ 491c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru .match_flags = USB_DEVICE_ID_MATCH_DEVICE, .idVendor = (vend), \ 492c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru .idProduct = (prod) 493c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/** 494c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * USB_DEVICE_VER - macro used to describe a specific usb device with a 495c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * version range 496c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @vend: the 16 bit USB Vendor ID 497c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @prod: the 16 bit USB Product ID 498c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @lo: the bcdDevice_lo value 499c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @hi: the bcdDevice_hi value 500c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 501c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * This macro is used to create a struct usb_device_id that matches a 502c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * specific device, with a version range. 503c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 504c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define USB_DEVICE_VER(vend,prod,lo,hi) \ 505c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, \ 506c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru .idVendor = (vend), .idProduct = (prod), \ 507c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru .bcdDevice_lo = (lo), .bcdDevice_hi = (hi) 508c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 509c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/** 510c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * USB_DEVICE_INFO - macro used to describe a class of usb devices 511c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @cl: bDeviceClass value 512c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @sc: bDeviceSubClass value 513c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @pr: bDeviceProtocol value 514c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 515c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * This macro is used to create a struct usb_device_id that matches a 516c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * specific class of devices. 517c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 518c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define USB_DEVICE_INFO(cl,sc,pr) \ 519c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, .bDeviceClass = (cl), \ 520c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru .bDeviceSubClass = (sc), .bDeviceProtocol = (pr) 521c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 522c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/** 523c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces 524c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @cl: bInterfaceClass value 525c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @sc: bInterfaceSubClass value 526c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @pr: bInterfaceProtocol value 527c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 528c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * This macro is used to create a struct usb_device_id that matches a 529c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * specific class of interfaces. 530c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 531c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define USB_INTERFACE_INFO(cl,sc,pr) \ 532c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, .bInterfaceClass = (cl), \ 533c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru .bInterfaceSubClass = (sc), .bInterfaceProtocol = (pr) 534c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 535c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* ----------------------------------------------------------------------- */ 536c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 537c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustruct usb_dynids { 538c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru spinlock_t lock; 539c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct list_head list; 540c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru}; 541c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 542c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/** 543c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * struct usb_driver - identifies USB driver to usbcore 544c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @name: The driver name should be unique among USB drivers, 545c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * and should normally be the same as the module name. 546c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @probe: Called to see if the driver is willing to manage a particular 547c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * interface on a device. If it is, probe returns zero and uses 548c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * dev_set_drvdata() to associate driver-specific data with the 549c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * interface. It may also use usb_set_interface() to specify the 550c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * appropriate altsetting. If unwilling to manage the interface, 551c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * return a negative errno value. 552c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @disconnect: Called when the interface is no longer accessible, usually 553c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * because its device has been (or is being) disconnected or the 554c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * driver module is being unloaded. 555c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @ioctl: Used for drivers that want to talk to userspace through 556c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * the "usbfs" filesystem. This lets devices provide ways to 557c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * expose information to user space regardless of where they 558c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * do (or don't) show up otherwise in the filesystem. 559c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @suspend: Called when the device is going to be suspended by the system. 560c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @resume: Called when the device is being resumed by the system. 561c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @pre_reset: Called by usb_reset_composite_device() when the device 562c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * is about to be reset. 563c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @post_reset: Called by usb_reset_composite_device() after the device 564c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * has been reset. 565c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @id_table: USB drivers use ID table to support hotplugging. 566c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Export this with MODULE_DEVICE_TABLE(usb,...). This must be set 567c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * or your driver's probe function will never get called. 568c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @dynids: used internally to hold the list of dynamically added device 569c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * ids for this driver. 570c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @driver: the driver model core driver structure. 571c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @no_dynamic_id: if set to 1, the USB core will not allow dynamic ids to be 572c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * added to this driver by preventing the sysfs file from being created. 573c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 574c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * USB drivers must provide a name, probe() and disconnect() methods, 575c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * and an id_table. Other driver fields are optional. 576c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 577c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * The id_table is used in hotplugging. It holds a set of descriptors, 578c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * and specialized data may be associated with each entry. That table 579c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * is used by both user and kernel mode hotplugging support. 580c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 581c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * The probe() and disconnect() methods are called in a context where 582c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * they can sleep, but they should avoid abusing the privilege. Most 583c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * work to connect to a device should be done when the device is opened, 584c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * and undone at the last close. The disconnect code needs to address 585c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * concurrency issues with respect to open() and close() methods, as 586c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * well as forcing all pending I/O requests to complete (by unlinking 587c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * them as necessary, and blocking until the unlinks complete). 588c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 589c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustruct usb_driver { 590c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru const char *name; 591c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 592c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int (*probe) (struct usb_interface *intf, 593c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru const struct usb_device_id *id); 594c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 595c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru void (*disconnect) (struct usb_interface *intf); 596c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 597c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int (*ioctl) (struct usb_interface *intf, unsigned int code, 598c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru void *buf); 599c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 600c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int (*suspend) (struct usb_interface *intf, pm_message_t message); 601c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int (*resume) (struct usb_interface *intf); 602c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 603c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru void (*pre_reset) (struct usb_interface *intf); 604c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru void (*post_reset) (struct usb_interface *intf); 605c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 606c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru const struct usb_device_id *id_table; 607c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 608c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_dynids dynids; 609c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct device_driver driver; 610c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru unsigned int no_dynamic_id:1; 611c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru}; 612c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define to_usb_driver(d) container_of(d, struct usb_driver, driver) 613c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 614c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern struct bus_type usb_bus_type; 615c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 616c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/** 617c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * struct usb_class_driver - identifies a USB driver that wants to use the USB major number 618c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @name: the usb class device name for this driver. Will show up in sysfs. 619c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @fops: pointer to the struct file_operations of this driver. 620c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @minor_base: the start of the minor range for this driver. 621c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 622c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * This structure is used for the usb_register_dev() and 623c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * usb_unregister_dev() functions, to consolidate a number of the 624c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * parameters used for them. 625c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 626c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustruct usb_class_driver { 627c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru char *name; 628c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru const struct file_operations *fops; 629c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int minor_base; 630c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru}; 631c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 632c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* 633c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * use these in module_init()/module_exit() 634c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * and don't forget MODULE_DEVICE_TABLE(usb, ...) 635c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 636c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruint usb_register_driver(struct usb_driver *, struct module *); 637c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustatic inline int usb_register(struct usb_driver *driver) 638c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru{ 639c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru return usb_register_driver(driver, THIS_MODULE); 640c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru} 641c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern void usb_deregister(struct usb_driver *); 642c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 643c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern int usb_register_dev(struct usb_interface *intf, 644c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_class_driver *class_driver); 645c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern void usb_deregister_dev(struct usb_interface *intf, 646c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_class_driver *class_driver); 647c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 648c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern int usb_disabled(void); 649c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 650c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* ----------------------------------------------------------------------- */ 651c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 652c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* 653c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * URB support, for asynchronous request completions 654c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 655c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 656c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* 657c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * urb->transfer_flags: 658c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 659c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define URB_SHORT_NOT_OK 0x0001 /* report short reads as errors */ 660c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define URB_ISO_ASAP 0x0002 /* iso-only, urb->start_frame 661c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * ignored */ 662c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define URB_NO_TRANSFER_DMA_MAP 0x0004 /* urb->transfer_dma valid on submit */ 663c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define URB_NO_SETUP_DMA_MAP 0x0008 /* urb->setup_dma valid on submit */ 664c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define URB_NO_FSBR 0x0020 /* UHCI-specific */ 665c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define URB_ZERO_PACKET 0x0040 /* Finish bulk OUT with short packet */ 666c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define URB_NO_INTERRUPT 0x0080 /* HINT: no non-error interrupt 667c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * needed */ 668c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 669c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustruct usb_iso_packet_descriptor { 670c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru unsigned int offset; 671c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru unsigned int length; /* expected length */ 672c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru unsigned int actual_length; 673c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru unsigned int status; 674c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru}; 675c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 676c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustruct urb; 677c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustruct pt_regs; 678c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 679c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querutypedef void (*usb_complete_t)(struct urb *, struct pt_regs *); 680c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 681c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/** 682c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * struct urb - USB Request Block 683c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @urb_list: For use by current owner of the URB. 684c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @pipe: Holds endpoint number, direction, type, and more. 685c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Create these values with the eight macros available; 686c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl" 687c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * (control), "bulk", "int" (interrupt), or "iso" (isochronous). 688c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * For example usb_sndbulkpipe() or usb_rcvintpipe(). Endpoint 689c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * numbers range from zero to fifteen. Note that "in" endpoint two 690c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * is a different endpoint (and pipe) from "out" endpoint two. 691c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * The current configuration controls the existence, type, and 692c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * maximum packet size of any given endpoint. 693c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @dev: Identifies the USB device to perform the request. 694c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @status: This is read in non-iso completion functions to get the 695c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * status of the particular request. ISO requests only use it 696c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * to tell whether the URB was unlinked; detailed status for 697c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * each frame is in the fields of the iso_frame-desc. 698c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @transfer_flags: A variety of flags may be used to affect how URB 699c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * submission, unlinking, or operation are handled. Different 700c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * kinds of URB can use different flags. 701c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @transfer_buffer: This identifies the buffer to (or from) which 702c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * the I/O request will be performed (unless URB_NO_TRANSFER_DMA_MAP 703c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * is set). This buffer must be suitable for DMA; allocate it with 704c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * kmalloc() or equivalent. For transfers to "in" endpoints, contents 705c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * of this buffer will be modified. This buffer is used for the data 706c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * stage of control transfers. 707c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP, 708c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * the device driver is saying that it provided this DMA address, 709c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * which the host controller driver should use in preference to the 710c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * transfer_buffer. 711c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @transfer_buffer_length: How big is transfer_buffer. The transfer may 712c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * be broken up into chunks according to the current maximum packet 713c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * size for the endpoint, which is a function of the configuration 714c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * and is encoded in the pipe. When the length is zero, neither 715c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * transfer_buffer nor transfer_dma is used. 716c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @actual_length: This is read in non-iso completion functions, and 717c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * it tells how many bytes (out of transfer_buffer_length) were 718c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * transferred. It will normally be the same as requested, unless 719c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * either an error was reported or a short read was performed. 720c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * The URB_SHORT_NOT_OK transfer flag may be used to make such 721c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * short reads be reported as errors. 722c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @setup_packet: Only used for control transfers, this points to eight bytes 723c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * of setup data. Control transfers always start by sending this data 724c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * to the device. Then transfer_buffer is read or written, if needed. 725c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @setup_dma: For control transfers with URB_NO_SETUP_DMA_MAP set, the 726c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * device driver has provided this DMA address for the setup packet. 727c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * The host controller driver should use this in preference to 728c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * setup_packet. 729c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @start_frame: Returns the initial frame for isochronous transfers. 730c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @number_of_packets: Lists the number of ISO transfer buffers. 731c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @interval: Specifies the polling interval for interrupt or isochronous 732c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * transfers. The units are frames (milliseconds) for for full and low 733c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * speed devices, and microframes (1/8 millisecond) for highspeed ones. 734c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @error_count: Returns the number of ISO transfers that reported errors. 735c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @context: For use in completion functions. This normally points to 736c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * request-specific driver context. 737c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @complete: Completion handler. This URB is passed as the parameter to the 738c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * completion function. The completion function may then do what 739c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * it likes with the URB, including resubmitting or freeing it. 740c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to 741c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * collect the transfer status for each buffer. 742c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 743c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * This structure identifies USB transfer requests. URBs must be allocated by 744c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * calling usb_alloc_urb() and freed with a call to usb_free_urb(). 745c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Initialization may be done using various usb_fill_*_urb() functions. URBs 746c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * are submitted using usb_submit_urb(), and pending requests may be canceled 747c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * using usb_unlink_urb() or usb_kill_urb(). 748c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 749c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Data Transfer Buffers: 750c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 751c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise 752c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * taken from the general page pool. That is provided by transfer_buffer 753c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * (control requests also use setup_packet), and host controller drivers 754c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * perform a dma mapping (and unmapping) for each buffer transferred. Those 755c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * mapping operations can be expensive on some platforms (perhaps using a dma 756c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * bounce buffer or talking to an IOMMU), 757c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * although they're cheap on commodity x86 and ppc hardware. 758c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 759c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Alternatively, drivers may pass the URB_NO_xxx_DMA_MAP transfer flags, 760c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * which tell the host controller driver that no such mapping is needed since 761c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * the device driver is DMA-aware. For example, a device driver might 762c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * allocate a DMA buffer with usb_buffer_alloc() or call usb_buffer_map(). 763c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * When these transfer flags are provided, host controller drivers will 764c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * attempt to use the dma addresses found in the transfer_dma and/or 765c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * setup_dma fields rather than determining a dma address themselves. (Note 766c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * that transfer_buffer and setup_packet must still be set because not all 767c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * host controllers use DMA, nor do virtual root hubs). 768c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 769c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Initialization: 770c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 771c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * All URBs submitted must initialize the dev, pipe, transfer_flags (may be 772c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * zero), and complete fields. All URBs must also initialize 773c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * transfer_buffer and transfer_buffer_length. They may provide the 774c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * URB_SHORT_NOT_OK transfer flag, indicating that short reads are 775c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * to be treated as errors; that flag is invalid for write requests. 776c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 777c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Bulk URBs may 778c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers 779c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * should always terminate with a short packet, even if it means adding an 780c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * extra zero length packet. 781c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 782c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Control URBs must provide a setup_packet. The setup_packet and 783c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * transfer_buffer may each be mapped for DMA or not, independently of 784c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * the other. The transfer_flags bits URB_NO_TRANSFER_DMA_MAP and 785c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * URB_NO_SETUP_DMA_MAP indicate which buffers have already been mapped. 786c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * URB_NO_SETUP_DMA_MAP is ignored for non-control URBs. 787c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 788c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Interrupt URBs must provide an interval, saying how often (in milliseconds 789c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * or, for highspeed devices, 125 microsecond units) 790c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * to poll for transfers. After the URB has been submitted, the interval 791c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * field reflects how the transfer was actually scheduled. 792c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * The polling interval may be more frequent than requested. 793c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * For example, some controllers have a maximum interval of 32 milliseconds, 794c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * while others support intervals of up to 1024 milliseconds. 795c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Isochronous URBs also have transfer intervals. (Note that for isochronous 796c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * endpoints, as well as high speed interrupt endpoints, the encoding of 797c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * the transfer interval in the endpoint descriptor is logarithmic. 798c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Device drivers must convert that value to linear units themselves.) 799c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 800c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Isochronous URBs normally use the URB_ISO_ASAP transfer flag, telling 801c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * the host controller to schedule the transfer as soon as bandwidth 802c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * utilization allows, and then set start_frame to reflect the actual frame 803c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * selected during submission. Otherwise drivers must specify the start_frame 804c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * and handle the case where the transfer can't begin then. However, drivers 805c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * won't know how bandwidth is currently allocated, and while they can 806c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * find the current frame using usb_get_current_frame_number () they can't 807c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * know the range for that frame number. (Ranges for frame counter values 808c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * are HC-specific, and can go from 256 to 65536 frames from "now".) 809c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 810c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Isochronous URBs have a different data transfer model, in part because 811c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * the quality of service is only "best effort". Callers provide specially 812c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * allocated URBs, with number_of_packets worth of iso_frame_desc structures 813c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * at the end. Each such packet is an individual ISO transfer. Isochronous 814c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * URBs are normally queued, submitted by drivers to arrange that 815c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * transfers are at least double buffered, and then explicitly resubmitted 816c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * in completion handlers, so 817c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * that data (such as audio or video) streams at as constant a rate as the 818c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * host controller scheduler can support. 819c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 820c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Completion Callbacks: 821c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 822c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * The completion callback is made in_interrupt(), and one of the first 823c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * things that a completion handler should do is check the status field. 824c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * The status field is provided for all URBs. It is used to report 825c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * unlinked URBs, and status for all non-ISO transfers. It should not 826c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * be examined before the URB is returned to the completion handler. 827c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 828c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * The context field is normally used to link URBs back to the relevant 829c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * driver or request state. 830c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 831c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * When the completion callback is invoked for non-isochronous URBs, the 832c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * actual_length field tells how many bytes were transferred. This field 833c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * is updated even when the URB terminated with an error or was unlinked. 834c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 835c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * ISO transfer status is reported in the status and actual_length fields 836c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * of the iso_frame_desc array, and the number of errors is reported in 837c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * error_count. Completion callbacks for ISO transfers will normally 838c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * (re)submit URBs to ensure a constant transfer rate. 839c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 840c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Note that even fields marked "public" should not be touched by the driver 841c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * when the urb is owned by the hcd, that is, since the call to 842c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * usb_submit_urb() till the entry into the completion routine. 843c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 844c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustruct urb 845c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru{ 846c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru /* private: usb core and host controller only fields in the urb */ 847c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct kref kref; /* reference count of the URB */ 848c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru spinlock_t lock; /* lock for the URB */ 849c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru void *hcpriv; /* private data for host controller */ 850c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int bandwidth; /* bandwidth for INT/ISO request */ 851c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru atomic_t use_count; /* concurrent submissions counter */ 852c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru u8 reject; /* submissions will fail */ 853c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 854c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru /* public: documented fields in the urb that can be used by drivers */ 855c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct list_head urb_list; /* list head for use by the urb's 856c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * current owner */ 857c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_device *dev; /* (in) pointer to associated device */ 858c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru unsigned int pipe; /* (in) pipe information */ 859c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int status; /* (return) non-ISO status */ 860c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru unsigned int transfer_flags; /* (in) URB_SHORT_NOT_OK | ...*/ 861c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru void *transfer_buffer; /* (in) associated data buffer */ 862c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru dma_addr_t transfer_dma; /* (in) dma addr for transfer_buffer */ 863c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int transfer_buffer_length; /* (in) data buffer length */ 864c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int actual_length; /* (return) actual transfer length */ 865c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru unsigned char *setup_packet; /* (in) setup packet (control only) */ 866c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru dma_addr_t setup_dma; /* (in) dma addr for setup_packet */ 867c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int start_frame; /* (modify) start frame (ISO) */ 868c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int number_of_packets; /* (in) number of ISO packets */ 869c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int interval; /* (modify) transfer interval 870c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * (INT/ISO) */ 871c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int error_count; /* (return) number of ISO errors */ 872c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru void *context; /* (in) context for completion */ 873c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru usb_complete_t complete; /* (in) completion routine */ 874c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_iso_packet_descriptor iso_frame_desc[0]; 875c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru /* (in) ISO ONLY */ 876c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru}; 877c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 878c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* ----------------------------------------------------------------------- */ 879c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 880c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/** 881c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * usb_fill_control_urb - initializes a control urb 882c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @urb: pointer to the urb to initialize. 883c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @dev: pointer to the struct usb_device for this urb. 884c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @pipe: the endpoint pipe 885c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @setup_packet: pointer to the setup_packet buffer 886c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @transfer_buffer: pointer to the transfer buffer 887c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @buffer_length: length of the transfer buffer 888c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @complete: pointer to the usb_complete_t function 889c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @context: what to set the urb context to. 890c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 891c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Initializes a control urb with the proper information needed to submit 892c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * it to a device. 893c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 894c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustatic inline void usb_fill_control_urb (struct urb *urb, 895c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_device *dev, 896c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru unsigned int pipe, 897c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru unsigned char *setup_packet, 898c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru void *transfer_buffer, 899c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int buffer_length, 900c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru usb_complete_t complete, 901c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru void *context) 902c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru{ 903c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru spin_lock_init(&urb->lock); 904c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru urb->dev = dev; 905c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru urb->pipe = pipe; 906c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru urb->setup_packet = setup_packet; 907c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru urb->transfer_buffer = transfer_buffer; 908c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru urb->transfer_buffer_length = buffer_length; 909c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru urb->complete = complete; 910c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru urb->context = context; 911c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru} 912c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 913c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/** 914c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * usb_fill_bulk_urb - macro to help initialize a bulk urb 915c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @urb: pointer to the urb to initialize. 916c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @dev: pointer to the struct usb_device for this urb. 917c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @pipe: the endpoint pipe 918c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @transfer_buffer: pointer to the transfer buffer 919c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @buffer_length: length of the transfer buffer 920c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @complete: pointer to the usb_complete_t function 921c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @context: what to set the urb context to. 922c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 923c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Initializes a bulk urb with the proper information needed to submit it 924c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * to a device. 925c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 926c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustatic inline void usb_fill_bulk_urb (struct urb *urb, 927c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_device *dev, 928c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru unsigned int pipe, 929c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru void *transfer_buffer, 930c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int buffer_length, 931c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru usb_complete_t complete, 932c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru void *context) 933c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru{ 934c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru spin_lock_init(&urb->lock); 935c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru urb->dev = dev; 936c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru urb->pipe = pipe; 937c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru urb->transfer_buffer = transfer_buffer; 938c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru urb->transfer_buffer_length = buffer_length; 939c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru urb->complete = complete; 940c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru urb->context = context; 941c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru} 942c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 943c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/** 944c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * usb_fill_int_urb - macro to help initialize a interrupt urb 945c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @urb: pointer to the urb to initialize. 946c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @dev: pointer to the struct usb_device for this urb. 947c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @pipe: the endpoint pipe 948c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @transfer_buffer: pointer to the transfer buffer 949c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @buffer_length: length of the transfer buffer 950c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @complete: pointer to the usb_complete_t function 951c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @context: what to set the urb context to. 952c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @interval: what to set the urb interval to, encoded like 953c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * the endpoint descriptor's bInterval value. 954c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 955c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Initializes a interrupt urb with the proper information needed to submit 956c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * it to a device. 957c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Note that high speed interrupt endpoints use a logarithmic encoding of 958c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * the endpoint interval, and express polling intervals in microframes 959c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * (eight per millisecond) rather than in frames (one per millisecond). 960c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 961c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustatic inline void usb_fill_int_urb (struct urb *urb, 962c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_device *dev, 963c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru unsigned int pipe, 964c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru void *transfer_buffer, 965c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int buffer_length, 966c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru usb_complete_t complete, 967c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru void *context, 968c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int interval) 969c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru{ 970c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru spin_lock_init(&urb->lock); 971c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru urb->dev = dev; 972c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru urb->pipe = pipe; 973c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru urb->transfer_buffer = transfer_buffer; 974c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru urb->transfer_buffer_length = buffer_length; 975c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru urb->complete = complete; 976c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru urb->context = context; 977c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru if (dev->speed == USB_SPEED_HIGH) 978c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru urb->interval = 1 << (interval - 1); 979c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru else 980c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru urb->interval = interval; 981c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru urb->start_frame = -1; 982c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru} 983c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 984c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern void usb_init_urb(struct urb *urb); 985c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags); 986c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern void usb_free_urb(struct urb *urb); 987c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define usb_put_urb usb_free_urb 988c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern struct urb *usb_get_urb(struct urb *urb); 989c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern int usb_submit_urb(struct urb *urb, gfp_t mem_flags); 990c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern int usb_unlink_urb(struct urb *urb); 991c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern void usb_kill_urb(struct urb *urb); 992c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 993c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define HAVE_USB_BUFFERS 994c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruvoid *usb_buffer_alloc (struct usb_device *dev, size_t size, 995c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru gfp_t mem_flags, dma_addr_t *dma); 996c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruvoid usb_buffer_free (struct usb_device *dev, size_t size, 997c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru void *addr, dma_addr_t dma); 998c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 999c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#if 0 1000c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustruct urb *usb_buffer_map (struct urb *urb); 1001c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruvoid usb_buffer_dmasync (struct urb *urb); 1002c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruvoid usb_buffer_unmap (struct urb *urb); 1003c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#endif 1004c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1005c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustruct scatterlist; 1006c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruint usb_buffer_map_sg (struct usb_device *dev, unsigned pipe, 1007c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct scatterlist *sg, int nents); 1008c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#if 0 1009c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruvoid usb_buffer_dmasync_sg (struct usb_device *dev, unsigned pipe, 1010c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct scatterlist *sg, int n_hw_ents); 1011c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#endif 1012c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruvoid usb_buffer_unmap_sg (struct usb_device *dev, unsigned pipe, 1013c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct scatterlist *sg, int n_hw_ents); 1014c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1015c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/*-------------------------------------------------------------------* 1016c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * SYNCHRONOUS CALL SUPPORT * 1017c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru *-------------------------------------------------------------------*/ 1018c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1019c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern int usb_control_msg(struct usb_device *dev, unsigned int pipe, 1020c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru __u8 request, __u8 requesttype, __u16 value, __u16 index, 1021c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru void *data, __u16 size, int timeout); 1022c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern int usb_interrupt_msg(struct usb_device *usb_dev, unsigned int pipe, 1023c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru void *data, int len, int *actual_length, int timeout); 1024c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe, 1025c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru void *data, int len, int *actual_length, 1026c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int timeout); 1027c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1028c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* wrappers around usb_control_msg() for the most common standard requests */ 1029c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern int usb_get_descriptor(struct usb_device *dev, unsigned char desctype, 1030c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru unsigned char descindex, void *buf, int size); 1031c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern int usb_get_status(struct usb_device *dev, 1032c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int type, int target, void *data); 1033c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern int usb_string(struct usb_device *dev, int index, 1034c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru char *buf, size_t size); 1035c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1036c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* wrappers that also update important state inside usbcore */ 1037c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern int usb_clear_halt(struct usb_device *dev, int pipe); 1038c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern int usb_reset_configuration(struct usb_device *dev); 1039c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate); 1040c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1041c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* 1042c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * timeouts, in milliseconds, used for sending/receiving control messages 1043c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * they typically complete within a few frames (msec) after they're issued 1044c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * USB identifies 5 second timeouts, maybe more in a few cases, and a few 1045c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * slow devices (like some MGE Ellipse UPSes) actually push that limit. 1046c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 1047c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define USB_CTRL_GET_TIMEOUT 5000 1048c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define USB_CTRL_SET_TIMEOUT 5000 1049c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1050c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1051c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/** 1052c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * struct usb_sg_request - support for scatter/gather I/O 1053c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @status: zero indicates success, else negative errno 1054c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * @bytes: counts bytes transferred. 1055c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 1056c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * These requests are initialized using usb_sg_init(), and then are used 1057c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most 1058c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * members of the request object aren't for driver access. 1059c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 1060c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * The status and bytecount values are valid only after usb_sg_wait() 1061c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * returns. If the status is zero, then the bytecount matches the total 1062c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * from the request. 1063c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 1064c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * After an error completion, drivers may need to clear a halt condition 1065c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * on the endpoint. 1066c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 1067c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustruct usb_sg_request { 1068c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int status; 1069c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru size_t bytes; 1070c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1071c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru /* 1072c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * members below are private: to usbcore, 1073c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * and are not provided for driver access! 1074c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 1075c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru spinlock_t lock; 1076c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1077c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_device *dev; 1078c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int pipe; 1079c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct scatterlist *sg; 1080c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int nents; 1081c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1082c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int entries; 1083c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct urb **urbs; 1084c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1085c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int count; 1086c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct completion complete; 1087c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru}; 1088c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1089c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruint usb_sg_init ( 1090c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_sg_request *io, 1091c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_device *dev, 1092c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru unsigned pipe, 1093c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru unsigned period, 1094c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct scatterlist *sg, 1095c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru int nents, 1096c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru size_t length, 1097c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru gfp_t mem_flags 1098c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru); 1099c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruvoid usb_sg_cancel (struct usb_sg_request *io); 1100c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruvoid usb_sg_wait (struct usb_sg_request *io); 1101c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1102c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1103c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* ----------------------------------------------------------------------- */ 1104c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1105c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* 1106c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * For various legacy reasons, Linux has a small cookie that's paired with 1107c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * a struct usb_device to identify an endpoint queue. Queue characteristics 1108c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * are defined by the endpoint's descriptor. This cookie is called a "pipe", 1109c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * an unsigned int encoded as: 1110c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 1111c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * - direction: bit 7 (0 = Host-to-Device [Out], 1112c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 1 = Device-to-Host [In] ... 1113c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * like endpoint bEndpointAddress) 1114c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * - device address: bits 8-14 ... bit positions known to uhci-hcd 1115c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * - endpoint: bits 15-18 ... bit positions known to uhci-hcd 1116c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt, 1117c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 10 = control, 11 = bulk) 1118c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * 1119c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru * Given the device address and endpoint descriptor, pipes are redundant. 1120c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru */ 1121c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1122c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* NOTE: these are not the standard USB_ENDPOINT_XFER_* values!! */ 1123c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* (yet ... they're the values used by usbfs) */ 1124c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define PIPE_ISOCHRONOUS 0 1125c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define PIPE_INTERRUPT 1 1126c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define PIPE_CONTROL 2 1127c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define PIPE_BULK 3 1128c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1129c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define usb_pipein(pipe) ((pipe) & USB_DIR_IN) 1130c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define usb_pipeout(pipe) (!usb_pipein(pipe)) 1131c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1132c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f) 1133c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf) 1134c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1135c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define usb_pipetype(pipe) (((pipe) >> 30) & 3) 1136c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS) 1137c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT) 1138c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL) 1139c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK) 1140c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1141c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */ 1142c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1) 1143c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep))) 1144c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define usb_settoggle(dev, ep, out, bit) \ 1145c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \ 1146c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru ((bit) << (ep))) 1147c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1148c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1149c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustatic inline unsigned int __create_pipe(struct usb_device *dev, 1150c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru unsigned int endpoint) 1151c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru{ 1152c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru return (dev->devnum << 8) | (endpoint << 15); 1153c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru} 1154c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1155c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* Create various pipes... */ 1156c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define usb_sndctrlpipe(dev,endpoint) \ 1157c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint)) 1158c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define usb_rcvctrlpipe(dev,endpoint) \ 1159c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN) 1160c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define usb_sndisocpipe(dev,endpoint) \ 1161c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint)) 1162c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define usb_rcvisocpipe(dev,endpoint) \ 1163c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN) 1164c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define usb_sndbulkpipe(dev,endpoint) \ 1165c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru ((PIPE_BULK << 30) | __create_pipe(dev,endpoint)) 1166c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define usb_rcvbulkpipe(dev,endpoint) \ 1167c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru ((PIPE_BULK << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN) 1168c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define usb_sndintpipe(dev,endpoint) \ 1169c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint)) 1170c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define usb_rcvintpipe(dev,endpoint) \ 1171c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN) 1172c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1173c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/*-------------------------------------------------------------------------*/ 1174c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1175c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Querustatic inline __u16 1176c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruusb_maxpacket(struct usb_device *udev, int pipe, int is_out) 1177c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru{ 1178c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru struct usb_host_endpoint *ep; 1179c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru unsigned epnum = usb_pipeendpoint(pipe); 1180c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1181c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru if (is_out) { 1182c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru WARN_ON(usb_pipein(pipe)); 1183c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru ep = udev->ep_out[epnum]; 1184c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru } else { 1185c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru WARN_ON(usb_pipeout(pipe)); 1186c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru ep = udev->ep_in[epnum]; 1187c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru } 1188c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru if (!ep) 1189c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru return 0; 1190c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1191c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru /* NOTE: only 0x07ff bits are for packet size... */ 1192c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru return le16_to_cpu(ep->desc.wMaxPacketSize); 1193c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru} 1194c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1195c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* ----------------------------------------------------------------------- */ 1196c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1197c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru/* Events from the usb core */ 1198c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define USB_DEVICE_ADD 0x0001 1199c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define USB_DEVICE_REMOVE 0x0002 1200c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define USB_BUS_ADD 0x0003 1201c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define USB_BUS_REMOVE 0x0004 1202c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern void usb_register_notify(struct notifier_block *nb); 1203c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queruextern void usb_unregister_notify(struct notifier_block *nb); 1204c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1205c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#ifdef DEBUG 1206c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define dbg(format, arg...) printk(KERN_DEBUG "%s: " format "\n" , \ 1207c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru __FILE__ , ## arg) 1208c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#else 1209c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define dbg(format, arg...) do {} while (0) 1210c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#endif 1211c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1212c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define err(format, arg...) printk(KERN_ERR "%s: " format "\n" , \ 1213c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru __FILE__ , ## arg) 1214c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define info(format, arg...) printk(KERN_INFO "%s: " format "\n" , \ 1215c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru __FILE__ , ## arg) 1216c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#define warn(format, arg...) printk(KERN_WARNING "%s: " format "\n" , \ 1217c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru __FILE__ , ## arg) 1218c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1219c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1220c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#endif /* __KERNEL__ */ 1221c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru 1222c559cd81139f97cecad1ad91a0b2e25a5936d53Jean-Baptiste Queru#endif 1223