blob: 73b68d1f2cb01a2da4fbb65bd5bb319b51ac690e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef __LINUX_USB_H
2#define __LINUX_USB_H
3
4#include <linux/mod_devicetable.h>
David Brownell5f848132006-12-16 15:34:53 -08005#include <linux/usb/ch9.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006
7#define USB_MAJOR 180
Kay Sieversfbf82fd2005-07-31 01:05:53 +02008#define USB_DEVICE_MAJOR 189
Linus Torvalds1da177e2005-04-16 15:20:36 -07009
10
11#ifdef __KERNEL__
12
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/errno.h> /* for -ENODEV */
14#include <linux/delay.h> /* for mdelay() */
15#include <linux/interrupt.h> /* for in_interrupt() */
16#include <linux/list.h> /* for struct list_head */
17#include <linux/kref.h> /* for struct kref */
18#include <linux/device.h> /* for struct device */
19#include <linux/fs.h> /* for struct file_operations */
20#include <linux/completion.h> /* for struct completion */
21#include <linux/sched.h> /* for current && schedule_timeout */
Alan Stern645daaa2006-08-30 15:47:02 -040022#include <linux/mutex.h> /* for struct mutex */
Ming Lei6ddf27c2010-11-15 15:57:30 -050023#include <linux/pm_runtime.h> /* for runtime PM */
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
25struct usb_device;
26struct usb_driver;
Inaky Perez-Gonzalezb1d8dfb2008-04-08 13:24:46 -070027struct wusb_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070028
29/*-------------------------------------------------------------------------*/
30
31/*
32 * Host-side wrappers for standard USB descriptors ... these are parsed
33 * from the data provided by devices. Parsing turns them from a flat
34 * sequence of descriptors into a hierarchy:
35 *
36 * - devices have one (usually) or more configs;
37 * - configs have one (often) or more interfaces;
38 * - interfaces have one (usually) or more settings;
39 * - each interface setting has zero or (usually) more endpoints.
Sarah Sharp663c30d2009-04-27 19:58:14 -070040 * - a SuperSpeed endpoint has a companion descriptor
Linus Torvalds1da177e2005-04-16 15:20:36 -070041 *
42 * And there might be other descriptors mixed in with those.
43 *
44 * Devices may also have class-specific or vendor-specific descriptors.
45 */
46
Greg Kroah-Hartman9bde7492006-06-14 12:14:34 -070047struct ep_device;
48
Linus Torvalds1da177e2005-04-16 15:20:36 -070049/**
50 * struct usb_host_endpoint - host-side endpoint descriptor and queue
51 * @desc: descriptor for this endpoint, wMaxPacketSize in native byteorder
Alan Stern842f1692010-04-30 12:44:46 -040052 * @ss_ep_comp: SuperSpeed companion descriptor for this endpoint
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 * @urb_list: urbs queued to this endpoint; maintained by usbcore
54 * @hcpriv: for use by HCD; typically holds hardware dma queue head (QH)
55 * with one or more transfer descriptors (TDs) per urb
Randy Dunlap7fac9a32006-06-22 15:12:41 -070056 * @ep_dev: ep_device for sysfs info
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 * @extra: descriptors following this endpoint in the configuration
58 * @extralen: how many bytes of "extra" are valid
Alan Sternbdd016b2007-07-30 17:05:22 -040059 * @enabled: URBs may be submitted to this endpoint
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 *
61 * USB requests are always queued to a given endpoint, identified by a
62 * descriptor within an active interface in a given USB configuration.
63 */
64struct usb_host_endpoint {
Alan Stern842f1692010-04-30 12:44:46 -040065 struct usb_endpoint_descriptor desc;
66 struct usb_ss_ep_comp_descriptor ss_ep_comp;
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 struct list_head urb_list;
68 void *hcpriv;
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -070069 struct ep_device *ep_dev; /* For sysfs info */
Linus Torvalds1da177e2005-04-16 15:20:36 -070070
71 unsigned char *extra; /* Extra descriptors */
72 int extralen;
Alan Sternbdd016b2007-07-30 17:05:22 -040073 int enabled;
Linus Torvalds1da177e2005-04-16 15:20:36 -070074};
75
76/* host-side wrapper for one interface setting's parsed descriptors */
77struct usb_host_interface {
78 struct usb_interface_descriptor desc;
79
80 /* array of desc.bNumEndpoint endpoints associated with this
81 * interface setting. these will be in no particular order.
82 */
83 struct usb_host_endpoint *endpoint;
84
85 char *string; /* iInterface string, if present */
86 unsigned char *extra; /* Extra descriptors */
87 int extralen;
88};
89
90enum usb_interface_condition {
91 USB_INTERFACE_UNBOUND = 0,
92 USB_INTERFACE_BINDING,
93 USB_INTERFACE_BOUND,
94 USB_INTERFACE_UNBINDING,
95};
96
97/**
98 * struct usb_interface - what usb device drivers talk to
99 * @altsetting: array of interface structures, one for each alternate
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -0700100 * setting that may be selected. Each one includes a set of
101 * endpoint configurations. They will be in no particular order.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 * @cur_altsetting: the current altsetting.
Lei Mingd6d914f2008-02-25 18:07:28 +0800103 * @num_altsetting: number of altsettings defined.
Randy Dunlap3f423782007-07-19 10:21:37 -0700104 * @intf_assoc: interface association descriptor
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 * @minor: the minor number assigned to this interface, if this
106 * interface is bound to a driver that uses the USB major number.
107 * If this interface does not use the USB major, this field should
108 * be unused. The driver should set this value in the probe()
109 * function of the driver, after it has been assigned a minor
110 * number from the USB core by calling usb_register_dev().
111 * @condition: binding state of the interface: not bound, binding
112 * (in probe()), bound to a driver, or unbinding (in disconnect())
Randy Dunlapf88ed902007-12-03 14:14:16 -0800113 * @sysfs_files_created: sysfs attributes exist
Alan Stern3b23dd62008-12-05 14:10:34 -0500114 * @ep_devs_created: endpoint child pseudo-devices exist
Alan Stern352d0262008-10-29 15:16:58 -0400115 * @unregistering: flag set when the interface is being unregistered
Alan Stern645daaa2006-08-30 15:47:02 -0400116 * @needs_remote_wakeup: flag set when the driver requires remote-wakeup
117 * capability during autosuspend.
Alan Stern55151d72008-08-12 14:33:59 -0400118 * @needs_altsetting0: flag set when a set-interface request for altsetting 0
119 * has been deferred.
Alan Sternf4f4d582008-07-28 10:39:28 -0400120 * @needs_binding: flag set when the driver should be re-probed or unbound
121 * following a reset or suspend operation it doesn't support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 * @dev: driver model's view of this device
Greg Kroah-Hartman0873c762006-06-20 13:09:50 -0700123 * @usb_dev: if an interface is bound to the USB major, this will point
124 * to the sysfs representation for that device.
Alan Stern9bbdf1e2010-01-08 12:57:28 -0500125 * @pm_usage_cnt: PM usage counter for this interface
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -0800126 * @reset_ws: Used for scheduling resets from atomic context.
127 * @reset_running: set to 1 if the interface is currently running a
128 * queued reset so that usb_cancel_queued_reset() doesn't try to
129 * remove from the workqueue when running inside the worker
130 * thread. See __usb_queue_reset_device().
Randy Dunlapc6ba1c22010-07-29 15:54:38 -0700131 * @resetting_device: USB core reset the device, so use alt setting 0 as
132 * current; needs bandwidth alloc after reset.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 *
134 * USB device drivers attach to interfaces on a physical device. Each
135 * interface encapsulates a single high level function, such as feeding
136 * an audio stream to a speaker or reporting a change in a volume control.
137 * Many USB devices only have one interface. The protocol used to talk to
138 * an interface's endpoints can be defined in a usb "class" specification,
139 * or by a product's vendor. The (default) control endpoint is part of
140 * every interface, but is never listed among the interface's descriptors.
141 *
142 * The driver that is bound to the interface can use standard driver model
143 * calls such as dev_get_drvdata() on the dev member of this structure.
144 *
145 * Each interface may have alternate settings. The initial configuration
146 * of a device sets altsetting 0, but the device driver can change
147 * that setting using usb_set_interface(). Alternate settings are often
Michael Opdenacker59c51592007-05-09 08:57:56 +0200148 * used to control the use of periodic endpoints, such as by having
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 * different endpoints use different amounts of reserved USB bandwidth.
150 * All standards-conformant USB devices that use isochronous endpoints
151 * will use them in non-default settings.
152 *
153 * The USB specification says that alternate setting numbers must run from
154 * 0 to one less than the total number of alternate settings. But some
155 * devices manage to mess this up, and the structures aren't necessarily
156 * stored in numerical order anyhow. Use usb_altnum_to_altsetting() to
157 * look up an alternate setting in the altsetting array based on its number.
158 */
159struct usb_interface {
160 /* array of alternate settings for this interface,
161 * stored in no particular order */
162 struct usb_host_interface *altsetting;
163
164 struct usb_host_interface *cur_altsetting; /* the currently
165 * active alternate setting */
166 unsigned num_altsetting; /* number of alternate settings */
167
Craig W. Nadler165fe972007-06-15 23:14:35 -0400168 /* If there is an interface association descriptor then it will list
169 * the associated interfaces */
170 struct usb_interface_assoc_descriptor *intf_assoc;
171
Alan Sternb724ae72005-10-24 15:36:00 -0400172 int minor; /* minor number this interface is
173 * bound to */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 enum usb_interface_condition condition; /* state of binding */
Alan Stern7e615592007-11-06 11:43:42 -0500175 unsigned sysfs_files_created:1; /* the sysfs attributes exist */
Alan Stern3b23dd62008-12-05 14:10:34 -0500176 unsigned ep_devs_created:1; /* endpoint "devices" exist */
Alan Stern352d0262008-10-29 15:16:58 -0400177 unsigned unregistering:1; /* unregistration is in progress */
Alan Stern645daaa2006-08-30 15:47:02 -0400178 unsigned needs_remote_wakeup:1; /* driver requires remote wakeup */
Alan Stern55151d72008-08-12 14:33:59 -0400179 unsigned needs_altsetting0:1; /* switch to altsetting 0 is pending */
Alan Stern78d9a482008-06-23 16:00:40 -0400180 unsigned needs_binding:1; /* needs delayed unbind/rebind */
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -0800181 unsigned reset_running:1;
Sarah Sharp04a723e2010-01-06 10:16:51 -0800182 unsigned resetting_device:1; /* true: bandwidth alloc after reset */
Alan Stern4d064c02006-07-01 22:11:44 -0400183
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 struct device dev; /* interface specific device info */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800185 struct device *usb_dev;
Alan Sternccf5b802009-06-29 11:00:01 -0400186 atomic_t pm_usage_cnt; /* usage counter for autosuspend */
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -0800187 struct work_struct reset_ws; /* for resets in atomic context */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188};
189#define to_usb_interface(d) container_of(d, struct usb_interface, dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800191static inline void *usb_get_intfdata(struct usb_interface *intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192{
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800193 return dev_get_drvdata(&intf->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194}
195
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800196static inline void usb_set_intfdata(struct usb_interface *intf, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197{
198 dev_set_drvdata(&intf->dev, data);
199}
200
201struct usb_interface *usb_get_intf(struct usb_interface *intf);
202void usb_put_intf(struct usb_interface *intf);
203
204/* this maximum is arbitrary */
205#define USB_MAXINTERFACES 32
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -0700206#define USB_MAXIADS (USB_MAXINTERFACES/2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207
208/**
209 * struct usb_interface_cache - long-term representation of a device interface
210 * @num_altsetting: number of altsettings defined.
211 * @ref: reference counter.
212 * @altsetting: variable-length array of interface structures, one for
213 * each alternate setting that may be selected. Each one includes a
214 * set of endpoint configurations. They will be in no particular order.
215 *
216 * These structures persist for the lifetime of a usb_device, unlike
217 * struct usb_interface (which persists only as long as its configuration
218 * is installed). The altsetting arrays can be accessed through these
219 * structures at any time, permitting comparison of configurations and
220 * providing support for the /proc/bus/usb/devices pseudo-file.
221 */
222struct usb_interface_cache {
223 unsigned num_altsetting; /* number of alternate settings */
224 struct kref ref; /* reference counter */
225
226 /* variable-length array of alternate settings for this interface,
227 * stored in no particular order */
228 struct usb_host_interface altsetting[0];
229};
230#define ref_to_usb_interface_cache(r) \
231 container_of(r, struct usb_interface_cache, ref)
232#define altsetting_to_usb_interface_cache(a) \
233 container_of(a, struct usb_interface_cache, altsetting[0])
234
235/**
236 * struct usb_host_config - representation of a device's configuration
237 * @desc: the device's configuration descriptor.
238 * @string: pointer to the cached version of the iConfiguration string, if
239 * present for this configuration.
Randy Dunlap3f423782007-07-19 10:21:37 -0700240 * @intf_assoc: list of any interface association descriptors in this config
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 * @interface: array of pointers to usb_interface structures, one for each
242 * interface in the configuration. The number of interfaces is stored
243 * in desc.bNumInterfaces. These pointers are valid only while the
244 * the configuration is active.
245 * @intf_cache: array of pointers to usb_interface_cache structures, one
246 * for each interface in the configuration. These structures exist
247 * for the entire life of the device.
248 * @extra: pointer to buffer containing all extra descriptors associated
249 * with this configuration (those preceding the first interface
250 * descriptor).
251 * @extralen: length of the extra descriptors buffer.
252 *
253 * USB devices may have multiple configurations, but only one can be active
254 * at any time. Each encapsulates a different operational environment;
255 * for example, a dual-speed device would have separate configurations for
256 * full-speed and high-speed operation. The number of configurations
257 * available is stored in the device descriptor as bNumConfigurations.
258 *
259 * A configuration can contain multiple interfaces. Each corresponds to
260 * a different function of the USB device, and all are available whenever
261 * the configuration is active. The USB standard says that interfaces
262 * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot
263 * of devices get this wrong. In addition, the interface array is not
264 * guaranteed to be sorted in numerical order. Use usb_ifnum_to_if() to
265 * look up an interface entry based on its number.
266 *
267 * Device drivers should not attempt to activate configurations. The choice
268 * of which configuration to install is a policy decision based on such
269 * considerations as available power, functionality provided, and the user's
Kay Sievers312c0042005-11-16 09:00:00 +0100270 * desires (expressed through userspace tools). However, drivers can call
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271 * usb_reset_configuration() to reinitialize the current configuration and
272 * all its interfaces.
273 */
274struct usb_host_config {
275 struct usb_config_descriptor desc;
276
Alan Stern4f62efe2005-10-24 16:24:14 -0400277 char *string; /* iConfiguration string, if present */
Craig W. Nadler165fe972007-06-15 23:14:35 -0400278
279 /* List of any Interface Association Descriptors in this
280 * configuration. */
281 struct usb_interface_assoc_descriptor *intf_assoc[USB_MAXIADS];
282
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 /* the interfaces associated with this configuration,
284 * stored in no particular order */
285 struct usb_interface *interface[USB_MAXINTERFACES];
286
287 /* Interface information available even when this is not the
288 * active configuration */
289 struct usb_interface_cache *intf_cache[USB_MAXINTERFACES];
290
291 unsigned char *extra; /* Extra descriptors */
292 int extralen;
293};
294
Andiry Xu3148bf02011-09-23 14:19:47 -0700295/* USB2.0 and USB3.0 device BOS descriptor set */
296struct usb_host_bos {
297 struct usb_bos_descriptor *desc;
298
299 /* wireless cap descriptor is handled by wusb */
300 struct usb_ext_cap_descriptor *ext_cap;
301 struct usb_ss_cap_descriptor *ss_cap;
302 struct usb_ss_container_id_descriptor *ss_id;
303};
304
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305int __usb_get_extra_descriptor(char *buffer, unsigned size,
306 unsigned char type, void **ptr);
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800307#define usb_get_extra_descriptor(ifpoint, type, ptr) \
308 __usb_get_extra_descriptor((ifpoint)->extra, \
309 (ifpoint)->extralen, \
310 type, (void **)ptr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311
Alan Sternb724ae72005-10-24 15:36:00 -0400312/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314/* USB device number allocation bitmap */
315struct usb_devmap {
316 unsigned long devicemap[128 / (8*sizeof(unsigned long))];
317};
318
319/*
320 * Allocated per bus (tree of devices) we have:
321 */
322struct usb_bus {
323 struct device *controller; /* host/master side hardware */
324 int busnum; /* Bus number (in order of reg) */
Greg Kroah-Hartman1b26da12008-07-02 12:46:22 -0700325 const char *bus_name; /* stable id (PCI slot_name etc) */
Alan Sterndd990f12006-08-30 11:29:56 -0400326 u8 uses_dma; /* Does the host controller use DMA? */
Anand Gadiyar07a8cdd2010-11-18 18:54:17 +0530327 u8 uses_pio_for_control; /*
328 * Does the host controller use PIO
329 * for control transfers?
330 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 u8 otg_port; /* 0, or number of OTG/HNP port */
332 unsigned is_b_host:1; /* true during some HNP roleswitches */
333 unsigned b_hnp_enable:1; /* OTG: did A-Host enable HNP? */
David Vrabel4c1bd3d2009-08-24 14:44:30 +0100334 unsigned sg_tablesize; /* 0 or largest number of sg list entries */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335
Alan Sternb724ae72005-10-24 15:36:00 -0400336 int devnum_next; /* Next open device number in
337 * round-robin allocation */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338
339 struct usb_devmap devmap; /* device address allocation map */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 struct usb_device *root_hub; /* Root hub */
Alan Stern6d19c002010-02-12 12:21:11 +0100341 struct usb_bus *hs_companion; /* Companion EHCI bus, if any */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 struct list_head bus_list; /* list of busses */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343
344 int bandwidth_allocated; /* on this bus: how much of the time
345 * reserved for periodic (intr/iso)
346 * requests is used, on average?
347 * Units: microseconds/frame.
348 * Limits: Full/low speed reserve 90%,
349 * while high speed reserves 80%.
350 */
351 int bandwidth_int_reqs; /* number of Interrupt requests */
352 int bandwidth_isoc_reqs; /* number of Isoc. requests */
353
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100354#ifdef CONFIG_USB_DEVICEFS
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 struct dentry *usbfs_dentry; /* usbfs dentry entry for the bus */
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100356#endif
Alan Sternb724ae72005-10-24 15:36:00 -0400357
Pete Zaitcevf150fa12008-11-13 21:31:21 -0700358#if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 struct mon_bus *mon_bus; /* non-null when associated */
360 int monitored; /* non-zero when monitored */
361#endif
362};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363
Alan Sternb724ae72005-10-24 15:36:00 -0400364/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365
366/* This is arbitrary.
367 * From USB 2.0 spec Table 11-13, offset 7, a hub can
368 * have up to 255 ports. The most yet reported is 10.
inaky@linux.intel.com43705252006-10-11 20:05:58 -0700369 *
370 * Current Wireless USB host hardware (Intel i1480 for example) allows
371 * up to 22 devices to connect. Upcoming hardware might raise that
372 * limit. Because the arrays need to add a bit for hub status data, we
373 * do 31, so plus one evens out to four bytes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 */
inaky@linux.intel.com43705252006-10-11 20:05:58 -0700375#define USB_MAXCHILDREN (31)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376
377struct usb_tt;
378
Matthew Garrett0846e7e2012-02-03 17:11:54 -0500379enum usb_device_removable {
380 USB_DEVICE_REMOVABLE_UNKNOWN = 0,
381 USB_DEVICE_REMOVABLE,
382 USB_DEVICE_FIXED,
383};
384
Randy Dunlapf476fba2008-02-13 18:33:15 -0800385/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 * struct usb_device - kernel's representation of a USB device
Randy Dunlapf476fba2008-02-13 18:33:15 -0800387 * @devnum: device number; address on a USB bus
388 * @devpath: device ID string for use in messages (e.g., /port/...)
Sarah Sharp7206b002009-04-27 19:54:49 -0700389 * @route: tree topology hex string for use with xHCI
Randy Dunlapf476fba2008-02-13 18:33:15 -0800390 * @state: device state: configured, not attached, etc.
391 * @speed: device speed: high/full/low (or error)
392 * @tt: Transaction Translator info; used with low/full speed dev, highspeed hub
393 * @ttport: device port on that tt hub
394 * @toggle: one bit for each endpoint, with ([0] = IN, [1] = OUT) endpoints
395 * @parent: our hub, unless we're the root
396 * @bus: bus we're part of
397 * @ep0: endpoint 0 data (default control pipe)
398 * @dev: generic device interface
399 * @descriptor: USB device descriptor
Andiry Xu3148bf02011-09-23 14:19:47 -0700400 * @bos: USB device BOS descriptor set
Randy Dunlapf476fba2008-02-13 18:33:15 -0800401 * @config: all of the device's configs
402 * @actconfig: the active configuration
403 * @ep_in: array of IN endpoints
404 * @ep_out: array of OUT endpoints
405 * @rawdescriptors: raw descriptors for each config
406 * @bus_mA: Current available from the bus
407 * @portnum: parent port number (origin 1)
408 * @level: number of USB hub ancestors
409 * @can_submit: URBs may be submitted
Randy Dunlapf476fba2008-02-13 18:33:15 -0800410 * @persist_enabled: USB_PERSIST enabled for this device
411 * @have_langid: whether string_langid is valid
412 * @authorized: policy has said we can use it;
413 * (user space) policy determines if we authorize this device to be
414 * used or not. By default, wired USB devices are authorized.
415 * WUSB devices are not, until we authorize them from user space.
416 * FIXME -- complete doc
Inaky Perez-Gonzalez3b52f122008-04-08 13:24:46 -0700417 * @authenticated: Crypto authentication passed
Randy Dunlapf476fba2008-02-13 18:33:15 -0800418 * @wusb: device is Wireless USB
Andiry Xu1ff4df52011-09-23 14:19:48 -0700419 * @lpm_capable: device supports LPM
Andiry Xu65580b432011-09-23 14:19:52 -0700420 * @usb2_hw_lpm_capable: device can perform USB2 hardware LPM
421 * @usb2_hw_lpm_enabled: USB2 hardware LPM enabled
Randy Dunlapf476fba2008-02-13 18:33:15 -0800422 * @string_langid: language ID for strings
423 * @product: iProduct string, if present (static)
424 * @manufacturer: iManufacturer string, if present (static)
425 * @serial: iSerialNumber string, if present (static)
426 * @filelist: usbfs files that are open to this device
427 * @usb_classdev: USB class device that was created for usbfs device
428 * access from userspace
429 * @usbfs_dentry: usbfs dentry entry for the device
430 * @maxchild: number of ports if hub
431 * @children: child devices - USB devices that are attached to this hub
Randy Dunlapf476fba2008-02-13 18:33:15 -0800432 * @quirks: quirks of the whole device
433 * @urbnum: number of URBs submitted for the whole device
434 * @active_duration: total time device is not suspended
Randy Dunlapf476fba2008-02-13 18:33:15 -0800435 * @connect_time: time device was first connected
Randy Dunlapf476fba2008-02-13 18:33:15 -0800436 * @do_remote_wakeup: remote wakeup should be enabled
437 * @reset_resume: needs reset instead of resume
Inaky Perez-Gonzalez11e76ae2009-01-08 12:52:19 -0800438 * @wusb_dev: if this is a Wireless USB device, link to the WUSB
439 * specific data for the device.
Sarah Sharpc6515272009-04-27 19:57:26 -0700440 * @slot_id: Slot ID assigned by xHCI
Matthew Garrett0846e7e2012-02-03 17:11:54 -0500441 * @removable: Device can be physically removed from this port
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 *
Randy Dunlapf476fba2008-02-13 18:33:15 -0800443 * Notes:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 * Usbcore drivers should not set usbdev->state directly. Instead use
445 * usb_set_device_state().
446 */
447struct usb_device {
Randy Dunlapf476fba2008-02-13 18:33:15 -0800448 int devnum;
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -0700449 char devpath[16];
Sarah Sharp7206b002009-04-27 19:54:49 -0700450 u32 route;
Randy Dunlapf476fba2008-02-13 18:33:15 -0800451 enum usb_device_state state;
452 enum usb_device_speed speed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453
Randy Dunlapf476fba2008-02-13 18:33:15 -0800454 struct usb_tt *tt;
455 int ttport;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456
Randy Dunlapf476fba2008-02-13 18:33:15 -0800457 unsigned int toggle[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458
Randy Dunlapf476fba2008-02-13 18:33:15 -0800459 struct usb_device *parent;
460 struct usb_bus *bus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 struct usb_host_endpoint ep0;
462
Randy Dunlapf476fba2008-02-13 18:33:15 -0800463 struct device dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464
Randy Dunlapf476fba2008-02-13 18:33:15 -0800465 struct usb_device_descriptor descriptor;
Andiry Xu3148bf02011-09-23 14:19:47 -0700466 struct usb_host_bos *bos;
Randy Dunlapf476fba2008-02-13 18:33:15 -0800467 struct usb_host_config *config;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468
Randy Dunlapf476fba2008-02-13 18:33:15 -0800469 struct usb_host_config *actconfig;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470 struct usb_host_endpoint *ep_in[16];
471 struct usb_host_endpoint *ep_out[16];
472
Randy Dunlapf476fba2008-02-13 18:33:15 -0800473 char **rawdescriptors;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474
Randy Dunlapf476fba2008-02-13 18:33:15 -0800475 unsigned short bus_mA;
476 u8 portnum;
477 u8 level;
Alan Stern55c52712005-11-23 12:03:12 -0500478
Randy Dunlapf476fba2008-02-13 18:33:15 -0800479 unsigned can_submit:1;
Randy Dunlapf476fba2008-02-13 18:33:15 -0800480 unsigned persist_enabled:1;
481 unsigned have_langid:1;
482 unsigned authorized:1;
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -0700483 unsigned authenticated:1;
Randy Dunlapf476fba2008-02-13 18:33:15 -0800484 unsigned wusb:1;
Andiry Xu1ff4df52011-09-23 14:19:48 -0700485 unsigned lpm_capable:1;
Andiry Xu65580b432011-09-23 14:19:52 -0700486 unsigned usb2_hw_lpm_capable:1;
487 unsigned usb2_hw_lpm_enabled:1;
Randy Dunlapf476fba2008-02-13 18:33:15 -0800488 int string_langid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489
Alan Stern4f62efe2005-10-24 16:24:14 -0400490 /* static strings from the device */
Randy Dunlapf476fba2008-02-13 18:33:15 -0800491 char *product;
492 char *manufacturer;
493 char *serial;
Alan Stern4f62efe2005-10-24 16:24:14 -0400494
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 struct list_head filelist;
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100496#ifdef CONFIG_USB_DEVICE_CLASS
497 struct device *usb_classdev;
498#endif
499#ifdef CONFIG_USB_DEVICEFS
Randy Dunlapf476fba2008-02-13 18:33:15 -0800500 struct dentry *usbfs_dentry;
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100501#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502
Randy Dunlapf476fba2008-02-13 18:33:15 -0800503 int maxchild;
Huajun Li88162302012-03-12 21:00:19 +0800504 struct usb_device **children;
Alan Stern645daaa2006-08-30 15:47:02 -0400505
Randy Dunlapf476fba2008-02-13 18:33:15 -0800506 u32 quirks;
507 atomic_t urbnum;
Alan Sternb5e795f2007-02-20 15:00:53 -0500508
Randy Dunlapf476fba2008-02-13 18:33:15 -0800509 unsigned long active_duration;
Sarah Sharp15123002007-12-21 16:54:15 -0800510
Alan Stern645daaa2006-08-30 15:47:02 -0400511#ifdef CONFIG_PM
Randy Dunlapf476fba2008-02-13 18:33:15 -0800512 unsigned long connect_time;
Alan Sternb5e795f2007-02-20 15:00:53 -0500513
Randy Dunlapf476fba2008-02-13 18:33:15 -0800514 unsigned do_remote_wakeup:1;
515 unsigned reset_resume:1;
Alan Stern645daaa2006-08-30 15:47:02 -0400516#endif
Inaky Perez-Gonzalezb1d8dfb2008-04-08 13:24:46 -0700517 struct wusb_dev *wusb_dev;
Sarah Sharpc6515272009-04-27 19:57:26 -0700518 int slot_id;
Matthew Garrett0846e7e2012-02-03 17:11:54 -0500519 enum usb_device_removable removable;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520};
521#define to_usb_device(d) container_of(d, struct usb_device, dev)
522
Matthew Wilcox1e429012010-04-30 13:11:30 -0600523static inline struct usb_device *interface_to_usbdev(struct usb_interface *intf)
524{
525 return to_usb_device(intf->dev.parent);
526}
527
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528extern struct usb_device *usb_get_dev(struct usb_device *dev);
529extern void usb_put_dev(struct usb_device *dev);
530
Alan Stern9ad3d6c2005-11-17 17:10:32 -0500531/* USB device locking */
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800532#define usb_lock_device(udev) device_lock(&(udev)->dev)
533#define usb_unlock_device(udev) device_unlock(&(udev)->dev)
534#define usb_trylock_device(udev) device_trylock(&(udev)->dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535extern int usb_lock_device_for_reset(struct usb_device *udev,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300536 const struct usb_interface *iface);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537
538/* USB port reset for device reinitialization */
539extern int usb_reset_device(struct usb_device *dev);
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -0800540extern void usb_queue_reset_device(struct usb_interface *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542
Alan Stern645daaa2006-08-30 15:47:02 -0400543/* USB autosuspend and autoresume */
544#ifdef CONFIG_USB_SUSPEND
Alan Stern9e18c822010-04-02 13:22:09 -0400545extern void usb_enable_autosuspend(struct usb_device *udev);
546extern void usb_disable_autosuspend(struct usb_device *udev);
Alan Stern088f7fe2010-01-08 12:56:54 -0500547
Alan Stern645daaa2006-08-30 15:47:02 -0400548extern int usb_autopm_get_interface(struct usb_interface *intf);
549extern void usb_autopm_put_interface(struct usb_interface *intf);
Alan Stern9ac39f22008-11-12 16:19:49 -0500550extern int usb_autopm_get_interface_async(struct usb_interface *intf);
551extern void usb_autopm_put_interface_async(struct usb_interface *intf);
Alan Stern9bbdf1e2010-01-08 12:57:28 -0500552extern void usb_autopm_get_interface_no_resume(struct usb_interface *intf);
553extern void usb_autopm_put_interface_no_suspend(struct usb_interface *intf);
Alan Stern692a1862006-10-30 17:07:51 -0500554
Alan Stern19410442007-03-27 13:33:59 -0400555static inline void usb_mark_last_busy(struct usb_device *udev)
556{
Ming Lei6ddf27c2010-11-15 15:57:30 -0500557 pm_runtime_mark_last_busy(&udev->dev);
Alan Stern19410442007-03-27 13:33:59 -0400558}
559
Alan Stern692a1862006-10-30 17:07:51 -0500560#else
561
Alan Stern088f7fe2010-01-08 12:56:54 -0500562static inline int usb_enable_autosuspend(struct usb_device *udev)
563{ return 0; }
564static inline int usb_disable_autosuspend(struct usb_device *udev)
565{ return 0; }
566
Alan Stern692a1862006-10-30 17:07:51 -0500567static inline int usb_autopm_get_interface(struct usb_interface *intf)
568{ return 0; }
Alan Stern9ac39f22008-11-12 16:19:49 -0500569static inline int usb_autopm_get_interface_async(struct usb_interface *intf)
570{ return 0; }
571
Alan Stern692a1862006-10-30 17:07:51 -0500572static inline void usb_autopm_put_interface(struct usb_interface *intf)
573{ }
Alan Stern9ac39f22008-11-12 16:19:49 -0500574static inline void usb_autopm_put_interface_async(struct usb_interface *intf)
575{ }
Alan Stern8e4ceb32009-12-07 13:01:37 -0500576static inline void usb_autopm_get_interface_no_resume(
577 struct usb_interface *intf)
Alan Stern692a1862006-10-30 17:07:51 -0500578{ }
Alan Stern8e4ceb32009-12-07 13:01:37 -0500579static inline void usb_autopm_put_interface_no_suspend(
580 struct usb_interface *intf)
Alan Stern692a1862006-10-30 17:07:51 -0500581{ }
Alan Stern19410442007-03-27 13:33:59 -0400582static inline void usb_mark_last_busy(struct usb_device *udev)
583{ }
Alan Stern692a1862006-10-30 17:07:51 -0500584#endif
Alan Stern645daaa2006-08-30 15:47:02 -0400585
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586/*-------------------------------------------------------------------------*/
587
588/* for drivers using iso endpoints */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800589extern int usb_get_current_frame_number(struct usb_device *usb_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590
Sarah Sharpeab1caf2010-04-05 10:55:58 -0700591/* Sets up a group of bulk endpoints to support multiple stream IDs. */
592extern int usb_alloc_streams(struct usb_interface *interface,
593 struct usb_host_endpoint **eps, unsigned int num_eps,
594 unsigned int num_streams, gfp_t mem_flags);
595
596/* Reverts a group of bulk endpoints back to not using stream IDs. */
597extern void usb_free_streams(struct usb_interface *interface,
598 struct usb_host_endpoint **eps, unsigned int num_eps,
599 gfp_t mem_flags);
600
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601/* used these for multi-interface device registration */
602extern int usb_driver_claim_interface(struct usb_driver *driver,
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800603 struct usb_interface *iface, void *priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604
605/**
606 * usb_interface_claimed - returns true iff an interface is claimed
607 * @iface: the interface being checked
608 *
609 * Returns true (nonzero) iff the interface is claimed, else false (zero).
610 * Callers must own the driver model's usb bus readlock. So driver
611 * probe() entries don't need extra locking, but other call contexts
612 * may need to explicitly claim that lock.
613 *
614 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800615static inline int usb_interface_claimed(struct usb_interface *iface)
616{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 return (iface->dev.driver != NULL);
618}
619
620extern void usb_driver_release_interface(struct usb_driver *driver,
621 struct usb_interface *iface);
622const struct usb_device_id *usb_match_id(struct usb_interface *interface,
623 const struct usb_device_id *id);
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +0100624extern int usb_match_one_id(struct usb_interface *interface,
625 const struct usb_device_id *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626
627extern struct usb_interface *usb_find_interface(struct usb_driver *drv,
628 int minor);
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300629extern struct usb_interface *usb_ifnum_to_if(const struct usb_device *dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 unsigned ifnum);
631extern struct usb_host_interface *usb_altnum_to_altsetting(
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300632 const struct usb_interface *intf, unsigned int altnum);
Sarah Sharp91017f92009-12-03 09:44:34 -0800633extern struct usb_host_interface *usb_find_alt_setting(
634 struct usb_host_config *config,
635 unsigned int iface_num,
636 unsigned int alt_num);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637
638
639/**
640 * usb_make_path - returns stable device path in the usb tree
641 * @dev: the device whose path is being constructed
642 * @buf: where to put the string
643 * @size: how big is "buf"?
644 *
645 * Returns length of the string (> 0) or negative if size was too small.
646 *
647 * This identifier is intended to be "stable", reflecting physical paths in
648 * hardware such as physical bus addresses for host controllers or ports on
649 * USB hubs. That makes it stay the same until systems are physically
650 * reconfigured, by re-cabling a tree of USB devices or by moving USB host
651 * controllers. Adding and removing devices, including virtual root hubs
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300652 * in host controller driver modules, does not change these path identifiers;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 * neither does rebooting or re-enumerating. These are more useful identifiers
654 * than changeable ("unstable") ones like bus numbers or device addresses.
655 *
656 * With a partial exception for devices connected to USB 2.0 root hubs, these
657 * identifiers are also predictable. So long as the device tree isn't changed,
658 * plugging any USB device into a given hub port always gives it the same path.
659 * Because of the use of "companion" controllers, devices connected to ports on
660 * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are
661 * high speed, and a different one if they are full or low speed.
662 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800663static inline int usb_make_path(struct usb_device *dev, char *buf, size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664{
665 int actual;
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800666 actual = snprintf(buf, size, "usb-%s-%s", dev->bus->bus_name,
667 dev->devpath);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 return (actual >= (int)size) ? -1 : actual;
669}
670
671/*-------------------------------------------------------------------------*/
672
Alan Sternb724ae72005-10-24 15:36:00 -0400673#define USB_DEVICE_ID_MATCH_DEVICE \
674 (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
675#define USB_DEVICE_ID_MATCH_DEV_RANGE \
676 (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI)
677#define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
678 (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679#define USB_DEVICE_ID_MATCH_DEV_INFO \
Alan Sternb724ae72005-10-24 15:36:00 -0400680 (USB_DEVICE_ID_MATCH_DEV_CLASS | \
681 USB_DEVICE_ID_MATCH_DEV_SUBCLASS | \
682 USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683#define USB_DEVICE_ID_MATCH_INT_INFO \
Alan Sternb724ae72005-10-24 15:36:00 -0400684 (USB_DEVICE_ID_MATCH_INT_CLASS | \
685 USB_DEVICE_ID_MATCH_INT_SUBCLASS | \
686 USB_DEVICE_ID_MATCH_INT_PROTOCOL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687
688/**
689 * USB_DEVICE - macro used to describe a specific usb device
690 * @vend: the 16 bit USB Vendor ID
691 * @prod: the 16 bit USB Product ID
692 *
693 * This macro is used to create a struct usb_device_id that matches a
694 * specific device.
695 */
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -0700696#define USB_DEVICE(vend, prod) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800697 .match_flags = USB_DEVICE_ID_MATCH_DEVICE, \
698 .idVendor = (vend), \
699 .idProduct = (prod)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700/**
Randy Dunlapd0bcabc2008-02-29 22:03:07 -0800701 * USB_DEVICE_VER - describe a specific usb device with a version range
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702 * @vend: the 16 bit USB Vendor ID
703 * @prod: the 16 bit USB Product ID
704 * @lo: the bcdDevice_lo value
705 * @hi: the bcdDevice_hi value
706 *
707 * This macro is used to create a struct usb_device_id that matches a
708 * specific device, with a version range.
709 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800710#define USB_DEVICE_VER(vend, prod, lo, hi) \
Alan Sternb724ae72005-10-24 15:36:00 -0400711 .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800712 .idVendor = (vend), \
713 .idProduct = (prod), \
714 .bcdDevice_lo = (lo), \
715 .bcdDevice_hi = (hi)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716
717/**
Randy Dunlapd0bcabc2008-02-29 22:03:07 -0800718 * USB_DEVICE_INTERFACE_PROTOCOL - describe a usb device with a specific interface protocol
Jan Kratochvilf836ac82007-05-09 00:26:15 -0400719 * @vend: the 16 bit USB Vendor ID
720 * @prod: the 16 bit USB Product ID
721 * @pr: bInterfaceProtocol value
722 *
723 * This macro is used to create a struct usb_device_id that matches a
724 * specific interface protocol of devices.
725 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800726#define USB_DEVICE_INTERFACE_PROTOCOL(vend, prod, pr) \
727 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
728 USB_DEVICE_ID_MATCH_INT_PROTOCOL, \
Jan Kratochvilf836ac82007-05-09 00:26:15 -0400729 .idVendor = (vend), \
730 .idProduct = (prod), \
731 .bInterfaceProtocol = (pr)
732
733/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 * USB_DEVICE_INFO - macro used to describe a class of usb devices
735 * @cl: bDeviceClass value
736 * @sc: bDeviceSubClass value
737 * @pr: bDeviceProtocol value
738 *
739 * This macro is used to create a struct usb_device_id that matches a
740 * specific class of devices.
741 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800742#define USB_DEVICE_INFO(cl, sc, pr) \
743 .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, \
744 .bDeviceClass = (cl), \
745 .bDeviceSubClass = (sc), \
746 .bDeviceProtocol = (pr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747
748/**
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800749 * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 * @cl: bInterfaceClass value
751 * @sc: bInterfaceSubClass value
752 * @pr: bInterfaceProtocol value
753 *
754 * This macro is used to create a struct usb_device_id that matches a
755 * specific class of interfaces.
756 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800757#define USB_INTERFACE_INFO(cl, sc, pr) \
758 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, \
759 .bInterfaceClass = (cl), \
760 .bInterfaceSubClass = (sc), \
761 .bInterfaceProtocol = (pr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762
Daniel Drake8538f962007-05-10 00:32:24 +0100763/**
Randy Dunlapd0bcabc2008-02-29 22:03:07 -0800764 * USB_DEVICE_AND_INTERFACE_INFO - describe a specific usb device with a class of usb interfaces
Daniel Drake8538f962007-05-10 00:32:24 +0100765 * @vend: the 16 bit USB Vendor ID
766 * @prod: the 16 bit USB Product ID
767 * @cl: bInterfaceClass value
768 * @sc: bInterfaceSubClass value
769 * @pr: bInterfaceProtocol value
770 *
771 * This macro is used to create a struct usb_device_id that matches a
772 * specific device with a specific class of interfaces.
773 *
774 * This is especially useful when explicitly matching devices that have
775 * vendor specific bDeviceClass values, but standards-compliant interfaces.
776 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800777#define USB_DEVICE_AND_INTERFACE_INFO(vend, prod, cl, sc, pr) \
Daniel Drake8538f962007-05-10 00:32:24 +0100778 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO \
779 | USB_DEVICE_ID_MATCH_DEVICE, \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800780 .idVendor = (vend), \
781 .idProduct = (prod), \
Daniel Drake8538f962007-05-10 00:32:24 +0100782 .bInterfaceClass = (cl), \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800783 .bInterfaceSubClass = (sc), \
784 .bInterfaceProtocol = (pr)
Daniel Drake8538f962007-05-10 00:32:24 +0100785
Alan Sternb724ae72005-10-24 15:36:00 -0400786/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +0100788/* Stuff for dynamic usb ids */
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800789struct usb_dynids {
790 spinlock_t lock;
791 struct list_head list;
792};
793
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +0100794struct usb_dynid {
795 struct list_head node;
796 struct usb_device_id id;
797};
798
799extern ssize_t usb_store_new_id(struct usb_dynids *dynids,
800 struct device_driver *driver,
801 const char *buf, size_t count);
802
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803/**
Alan Stern8bb54ab2006-07-01 22:08:49 -0400804 * struct usbdrv_wrap - wrapper for driver-model structure
805 * @driver: The driver-model core driver structure.
806 * @for_devices: Non-zero for device drivers, 0 for interface drivers.
807 */
808struct usbdrv_wrap {
809 struct device_driver driver;
810 int for_devices;
811};
812
813/**
814 * struct usb_driver - identifies USB interface driver to usbcore
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 * @name: The driver name should be unique among USB drivers,
816 * and should normally be the same as the module name.
817 * @probe: Called to see if the driver is willing to manage a particular
818 * interface on a device. If it is, probe returns zero and uses
Oliver Neukum7ef4f062008-04-10 15:15:37 +0200819 * usb_set_intfdata() to associate driver-specific data with the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 * interface. It may also use usb_set_interface() to specify the
821 * appropriate altsetting. If unwilling to manage the interface,
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300822 * return -ENODEV, if genuine IO errors occurred, an appropriate
Oliver Neukum7ef4f062008-04-10 15:15:37 +0200823 * negative errno value.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 * @disconnect: Called when the interface is no longer accessible, usually
825 * because its device has been (or is being) disconnected or the
826 * driver module is being unloaded.
Randy Dunlapa91be2a2010-10-25 15:04:13 -0700827 * @unlocked_ioctl: Used for drivers that want to talk to userspace through
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 * the "usbfs" filesystem. This lets devices provide ways to
829 * expose information to user space regardless of where they
830 * do (or don't) show up otherwise in the filesystem.
831 * @suspend: Called when the device is going to be suspended by the system.
832 * @resume: Called when the device is being resumed by the system.
Alan Sternf07600c2007-05-30 15:38:16 -0400833 * @reset_resume: Called when the suspended device has been reset instead
834 * of being resumed.
Alan Stern6498d9d2011-04-28 10:45:24 -0400835 * @pre_reset: Called by usb_reset_device() when the device is about to be
836 * reset. This routine must not return until the driver has no active
837 * URBs for the device, and no more URBs may be submitted until the
838 * post_reset method is called.
Ming Lei742120c2008-06-18 22:00:29 +0800839 * @post_reset: Called by usb_reset_device() after the device
Oliver Neukum7ef4f062008-04-10 15:15:37 +0200840 * has been reset
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 * @id_table: USB drivers use ID table to support hotplugging.
842 * Export this with MODULE_DEVICE_TABLE(usb,...). This must be set
843 * or your driver's probe function will never get called.
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800844 * @dynids: used internally to hold the list of dynamically added device
845 * ids for this driver.
Alan Stern8bb54ab2006-07-01 22:08:49 -0400846 * @drvwrap: Driver-model core structure wrapper.
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -0800847 * @no_dynamic_id: if set to 1, the USB core will not allow dynamic ids to be
848 * added to this driver by preventing the sysfs file from being created.
Alan Stern645daaa2006-08-30 15:47:02 -0400849 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
850 * for interfaces bound to this driver.
Alan Stern9da82bd2008-05-08 11:54:37 -0400851 * @soft_unbind: if set to 1, the USB core will not kill URBs and disable
852 * endpoints before calling the driver's disconnect method.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 *
Alan Stern8bb54ab2006-07-01 22:08:49 -0400854 * USB interface drivers must provide a name, probe() and disconnect()
855 * methods, and an id_table. Other driver fields are optional.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 *
857 * The id_table is used in hotplugging. It holds a set of descriptors,
858 * and specialized data may be associated with each entry. That table
859 * is used by both user and kernel mode hotplugging support.
860 *
861 * The probe() and disconnect() methods are called in a context where
862 * they can sleep, but they should avoid abusing the privilege. Most
863 * work to connect to a device should be done when the device is opened,
864 * and undone at the last close. The disconnect code needs to address
865 * concurrency issues with respect to open() and close() methods, as
866 * well as forcing all pending I/O requests to complete (by unlinking
867 * them as necessary, and blocking until the unlinks complete).
868 */
869struct usb_driver {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870 const char *name;
871
872 int (*probe) (struct usb_interface *intf,
873 const struct usb_device_id *id);
874
875 void (*disconnect) (struct usb_interface *intf);
876
Andi Kleenc532b292010-06-01 23:04:41 +0200877 int (*unlocked_ioctl) (struct usb_interface *intf, unsigned int code,
Alan Sternb724ae72005-10-24 15:36:00 -0400878 void *buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879
David Brownell27d72e82005-04-18 17:39:22 -0700880 int (*suspend) (struct usb_interface *intf, pm_message_t message);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881 int (*resume) (struct usb_interface *intf);
Alan Sternf07600c2007-05-30 15:38:16 -0400882 int (*reset_resume)(struct usb_interface *intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883
Alan Sternf07600c2007-05-30 15:38:16 -0400884 int (*pre_reset)(struct usb_interface *intf);
885 int (*post_reset)(struct usb_interface *intf);
Alan Stern79efa092006-06-01 13:33:42 -0400886
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887 const struct usb_device_id *id_table;
888
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800889 struct usb_dynids dynids;
Alan Stern8bb54ab2006-07-01 22:08:49 -0400890 struct usbdrv_wrap drvwrap;
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -0800891 unsigned int no_dynamic_id:1;
Alan Stern645daaa2006-08-30 15:47:02 -0400892 unsigned int supports_autosuspend:1;
Alan Stern9da82bd2008-05-08 11:54:37 -0400893 unsigned int soft_unbind:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894};
Alan Stern8bb54ab2006-07-01 22:08:49 -0400895#define to_usb_driver(d) container_of(d, struct usb_driver, drvwrap.driver)
896
897/**
898 * struct usb_device_driver - identifies USB device driver to usbcore
899 * @name: The driver name should be unique among USB drivers,
900 * and should normally be the same as the module name.
901 * @probe: Called to see if the driver is willing to manage a particular
902 * device. If it is, probe returns zero and uses dev_set_drvdata()
903 * to associate driver-specific data with the device. If unwilling
904 * to manage the device, return a negative errno value.
905 * @disconnect: Called when the device is no longer accessible, usually
906 * because it has been (or is being) disconnected or the driver's
907 * module is being unloaded.
908 * @suspend: Called when the device is going to be suspended by the system.
909 * @resume: Called when the device is being resumed by the system.
910 * @drvwrap: Driver-model core structure wrapper.
Alan Stern645daaa2006-08-30 15:47:02 -0400911 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
912 * for devices bound to this driver.
Alan Stern8bb54ab2006-07-01 22:08:49 -0400913 *
914 * USB drivers must provide all the fields listed above except drvwrap.
915 */
916struct usb_device_driver {
917 const char *name;
918
919 int (*probe) (struct usb_device *udev);
920 void (*disconnect) (struct usb_device *udev);
921
922 int (*suspend) (struct usb_device *udev, pm_message_t message);
Alan Stern65bfd292008-11-25 16:39:18 -0500923 int (*resume) (struct usb_device *udev, pm_message_t message);
Alan Stern8bb54ab2006-07-01 22:08:49 -0400924 struct usbdrv_wrap drvwrap;
Alan Stern645daaa2006-08-30 15:47:02 -0400925 unsigned int supports_autosuspend:1;
Alan Stern8bb54ab2006-07-01 22:08:49 -0400926};
927#define to_usb_device_driver(d) container_of(d, struct usb_device_driver, \
928 drvwrap.driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929
930extern struct bus_type usb_bus_type;
931
932/**
933 * struct usb_class_driver - identifies a USB driver that wants to use the USB major number
Greg Kroah-Hartmand6e5bcf2005-06-20 21:15:16 -0700934 * @name: the usb class device name for this driver. Will show up in sysfs.
Kay Sieverse454cea2009-09-18 23:01:12 +0200935 * @devnode: Callback to provide a naming hint for a possible
Randy Dunlape376bbb2009-06-18 10:39:11 -0700936 * device node to create.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 * @fops: pointer to the struct file_operations of this driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938 * @minor_base: the start of the minor range for this driver.
939 *
940 * This structure is used for the usb_register_dev() and
941 * usb_unregister_dev() functions, to consolidate a number of the
942 * parameters used for them.
943 */
944struct usb_class_driver {
945 char *name;
Al Viro2c9ede52011-07-23 20:24:48 -0400946 char *(*devnode)(struct device *dev, umode_t *mode);
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800947 const struct file_operations *fops;
Greg Kroah-Hartmand6e5bcf2005-06-20 21:15:16 -0700948 int minor_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949};
950
951/*
952 * use these in module_init()/module_exit()
953 * and don't forget MODULE_DEVICE_TABLE(usb, ...)
954 */
Greg Kroah-Hartman80f745f2007-01-15 11:50:02 -0800955extern int usb_register_driver(struct usb_driver *, struct module *,
956 const char *);
Paul Gortmakereb5589a2011-05-27 09:02:11 -0400957
958/* use a define to avoid include chaining to get THIS_MODULE & friends */
959#define usb_register(driver) \
960 usb_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
961
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962extern void usb_deregister(struct usb_driver *);
963
Greg Kroah-Hartmanf3a6a4b2011-11-17 14:38:33 -0800964/**
965 * module_usb_driver() - Helper macro for registering a USB driver
966 * @__usb_driver: usb_driver struct
967 *
968 * Helper macro for USB drivers which do not do anything special in module
969 * init/exit. This eliminates a lot of boilerplate. Each module may only
970 * use this macro once, and calling it replaces module_init() and module_exit()
971 */
972#define module_usb_driver(__usb_driver) \
973 module_driver(__usb_driver, usb_register, \
974 usb_deregister)
975
Alan Stern8bb54ab2006-07-01 22:08:49 -0400976extern int usb_register_device_driver(struct usb_device_driver *,
977 struct module *);
978extern void usb_deregister_device_driver(struct usb_device_driver *);
979
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980extern int usb_register_dev(struct usb_interface *intf,
981 struct usb_class_driver *class_driver);
982extern void usb_deregister_dev(struct usb_interface *intf,
983 struct usb_class_driver *class_driver);
984
985extern int usb_disabled(void);
986
Alan Sternb724ae72005-10-24 15:36:00 -0400987/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988
989/*
990 * URB support, for asynchronous request completions
991 */
992
993/*
994 * urb->transfer_flags:
Alan Sternfea34092007-07-30 17:06:16 -0400995 *
996 * Note: URB_DIR_IN/OUT is automatically set in usb_submit_urb().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 */
998#define URB_SHORT_NOT_OK 0x0001 /* report short reads as errors */
Alan Sternb724ae72005-10-24 15:36:00 -0400999#define URB_ISO_ASAP 0x0002 /* iso-only, urb->start_frame
1000 * ignored */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001#define URB_NO_TRANSFER_DMA_MAP 0x0004 /* urb->transfer_dma valid on submit */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002#define URB_NO_FSBR 0x0020 /* UHCI-specific */
Alan Sternb724ae72005-10-24 15:36:00 -04001003#define URB_ZERO_PACKET 0x0040 /* Finish bulk OUT with short packet */
1004#define URB_NO_INTERRUPT 0x0080 /* HINT: no non-error interrupt
1005 * needed */
Marcel Holtmann8b3b01c2007-06-13 08:02:11 +02001006#define URB_FREE_BUFFER 0x0100 /* Free transfer buffer with the URB */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007
Alan Sternff9c8952010-04-02 13:27:28 -04001008/* The following flags are used internally by usbcore and HCDs */
Alan Sternfea34092007-07-30 17:06:16 -04001009#define URB_DIR_IN 0x0200 /* Transfer from device to host */
1010#define URB_DIR_OUT 0
1011#define URB_DIR_MASK URB_DIR_IN
1012
Alan Sternff9c8952010-04-02 13:27:28 -04001013#define URB_DMA_MAP_SINGLE 0x00010000 /* Non-scatter-gather mapping */
1014#define URB_DMA_MAP_PAGE 0x00020000 /* HCD-unsupported S-G */
1015#define URB_DMA_MAP_SG 0x00040000 /* HCD-supported S-G */
1016#define URB_MAP_LOCAL 0x00080000 /* HCD-local-memory mapping */
1017#define URB_SETUP_MAP_SINGLE 0x00100000 /* Setup packet DMA mapped */
1018#define URB_SETUP_MAP_LOCAL 0x00200000 /* HCD-local setup packet */
1019#define URB_DMA_SG_COMBINED 0x00400000 /* S-G entries were combined */
Robert Morell2694a482011-01-26 19:06:48 -08001020#define URB_ALIGNED_TEMP_BUFFER 0x00800000 /* Temp buffer was alloc'd */
Alan Sternff9c8952010-04-02 13:27:28 -04001021
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022struct usb_iso_packet_descriptor {
1023 unsigned int offset;
1024 unsigned int length; /* expected length */
1025 unsigned int actual_length;
Pete Zaitcevd1bbb602007-02-11 13:56:13 -08001026 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027};
1028
1029struct urb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030
Oliver Neukum51a2f072007-05-25 13:40:56 +02001031struct usb_anchor {
1032 struct list_head urb_list;
1033 wait_queue_head_t wait;
1034 spinlock_t lock;
Oliver Neukum6a2839b2008-07-29 16:18:47 +02001035 unsigned int poisoned:1;
Oliver Neukum51a2f072007-05-25 13:40:56 +02001036};
1037
1038static inline void init_usb_anchor(struct usb_anchor *anchor)
1039{
1040 INIT_LIST_HEAD(&anchor->urb_list);
1041 init_waitqueue_head(&anchor->wait);
1042 spin_lock_init(&anchor->lock);
1043}
1044
David Howells7d12e782006-10-05 14:55:46 +01001045typedef void (*usb_complete_t)(struct urb *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046
1047/**
1048 * struct urb - USB Request Block
1049 * @urb_list: For use by current owner of the URB.
Oliver Neukum51a2f072007-05-25 13:40:56 +02001050 * @anchor_list: membership in the list of an anchor
1051 * @anchor: to anchor URBs to a common mooring
Alan Stern5b653c72007-07-30 17:04:37 -04001052 * @ep: Points to the endpoint's data structure. Will eventually
1053 * replace @pipe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054 * @pipe: Holds endpoint number, direction, type, and more.
1055 * Create these values with the eight macros available;
1056 * usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl"
1057 * (control), "bulk", "int" (interrupt), or "iso" (isochronous).
1058 * For example usb_sndbulkpipe() or usb_rcvintpipe(). Endpoint
1059 * numbers range from zero to fifteen. Note that "in" endpoint two
1060 * is a different endpoint (and pipe) from "out" endpoint two.
1061 * The current configuration controls the existence, type, and
1062 * maximum packet size of any given endpoint.
Randy Dunlapc6ba1c22010-07-29 15:54:38 -07001063 * @stream_id: the endpoint's stream ID for bulk streams
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064 * @dev: Identifies the USB device to perform the request.
1065 * @status: This is read in non-iso completion functions to get the
1066 * status of the particular request. ISO requests only use it
1067 * to tell whether the URB was unlinked; detailed status for
1068 * each frame is in the fields of the iso_frame-desc.
1069 * @transfer_flags: A variety of flags may be used to affect how URB
1070 * submission, unlinking, or operation are handled. Different
1071 * kinds of URB can use different flags.
Pete Zaitcev4e9e9202009-06-11 08:53:20 -06001072 * @transfer_buffer: This identifies the buffer to (or from) which the I/O
1073 * request will be performed unless URB_NO_TRANSFER_DMA_MAP is set
1074 * (however, do not leave garbage in transfer_buffer even then).
1075 * This buffer must be suitable for DMA; allocate it with
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076 * kmalloc() or equivalent. For transfers to "in" endpoints, contents
1077 * of this buffer will be modified. This buffer is used for the data
1078 * stage of control transfers.
1079 * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP,
1080 * the device driver is saying that it provided this DMA address,
1081 * which the host controller driver should use in preference to the
1082 * transfer_buffer.
Randy Dunlape376bbb2009-06-18 10:39:11 -07001083 * @sg: scatter gather buffer list
Randy Dunlap4d922612012-01-21 11:02:56 -08001084 * @num_mapped_sgs: (internal) number of mapped sg entries
Randy Dunlape376bbb2009-06-18 10:39:11 -07001085 * @num_sgs: number of entries in the sg list
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086 * @transfer_buffer_length: How big is transfer_buffer. The transfer may
1087 * be broken up into chunks according to the current maximum packet
1088 * size for the endpoint, which is a function of the configuration
1089 * and is encoded in the pipe. When the length is zero, neither
1090 * transfer_buffer nor transfer_dma is used.
1091 * @actual_length: This is read in non-iso completion functions, and
1092 * it tells how many bytes (out of transfer_buffer_length) were
1093 * transferred. It will normally be the same as requested, unless
1094 * either an error was reported or a short read was performed.
1095 * The URB_SHORT_NOT_OK transfer flag may be used to make such
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001096 * short reads be reported as errors.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 * @setup_packet: Only used for control transfers, this points to eight bytes
1098 * of setup data. Control transfers always start by sending this data
1099 * to the device. Then transfer_buffer is read or written, if needed.
Alan Stern85bcb5e2010-04-30 16:35:37 -04001100 * @setup_dma: DMA pointer for the setup packet. The caller must not use
1101 * this field; setup_packet must point to a valid buffer.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102 * @start_frame: Returns the initial frame for isochronous transfers.
1103 * @number_of_packets: Lists the number of ISO transfer buffers.
1104 * @interval: Specifies the polling interval for interrupt or isochronous
Anand Gadiyar411c9402009-07-07 15:24:23 +05301105 * transfers. The units are frames (milliseconds) for full and low
Matthew Wilcoxf09a15e2010-03-16 12:55:44 -07001106 * speed devices, and microframes (1/8 millisecond) for highspeed
1107 * and SuperSpeed devices.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108 * @error_count: Returns the number of ISO transfers that reported errors.
1109 * @context: For use in completion functions. This normally points to
1110 * request-specific driver context.
1111 * @complete: Completion handler. This URB is passed as the parameter to the
1112 * completion function. The completion function may then do what
1113 * it likes with the URB, including resubmitting or freeing it.
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001114 * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115 * collect the transfer status for each buffer.
1116 *
1117 * This structure identifies USB transfer requests. URBs must be allocated by
1118 * calling usb_alloc_urb() and freed with a call to usb_free_urb().
1119 * Initialization may be done using various usb_fill_*_urb() functions. URBs
1120 * are submitted using usb_submit_urb(), and pending requests may be canceled
1121 * using usb_unlink_urb() or usb_kill_urb().
1122 *
1123 * Data Transfer Buffers:
1124 *
1125 * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise
1126 * taken from the general page pool. That is provided by transfer_buffer
1127 * (control requests also use setup_packet), and host controller drivers
1128 * perform a dma mapping (and unmapping) for each buffer transferred. Those
1129 * mapping operations can be expensive on some platforms (perhaps using a dma
1130 * bounce buffer or talking to an IOMMU),
1131 * although they're cheap on commodity x86 and ppc hardware.
1132 *
Alan Stern85bcb5e2010-04-30 16:35:37 -04001133 * Alternatively, drivers may pass the URB_NO_TRANSFER_DMA_MAP transfer flag,
1134 * which tells the host controller driver that no such mapping is needed for
1135 * the transfer_buffer since
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136 * the device driver is DMA-aware. For example, a device driver might
Daniel Mack073900a2010-04-12 13:17:25 +02001137 * allocate a DMA buffer with usb_alloc_coherent() or call usb_buffer_map().
Alan Stern85bcb5e2010-04-30 16:35:37 -04001138 * When this transfer flag is provided, host controller drivers will
1139 * attempt to use the dma address found in the transfer_dma
1140 * field rather than determining a dma address themselves.
Pete Zaitcev4e9e9202009-06-11 08:53:20 -06001141 *
1142 * Note that transfer_buffer must still be set if the controller
1143 * does not support DMA (as indicated by bus.uses_dma) and when talking
1144 * to root hub. If you have to trasfer between highmem zone and the device
1145 * on such controller, create a bounce buffer or bail out with an error.
1146 * If transfer_buffer cannot be set (is in highmem) and the controller is DMA
1147 * capable, assign NULL to it, so that usbmon knows not to use the value.
1148 * The setup_packet must always be set, so it cannot be located in highmem.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149 *
1150 * Initialization:
1151 *
1152 * All URBs submitted must initialize the dev, pipe, transfer_flags (may be
Alan Sternb375a042005-07-29 16:11:07 -04001153 * zero), and complete fields. All URBs must also initialize
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154 * transfer_buffer and transfer_buffer_length. They may provide the
1155 * URB_SHORT_NOT_OK transfer flag, indicating that short reads are
1156 * to be treated as errors; that flag is invalid for write requests.
1157 *
1158 * Bulk URBs may
1159 * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers
1160 * should always terminate with a short packet, even if it means adding an
1161 * extra zero length packet.
1162 *
Alan Stern85bcb5e2010-04-30 16:35:37 -04001163 * Control URBs must provide a valid pointer in the setup_packet field.
1164 * Unlike the transfer_buffer, the setup_packet may not be mapped for DMA
1165 * beforehand.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166 *
1167 * Interrupt URBs must provide an interval, saying how often (in milliseconds
1168 * or, for highspeed devices, 125 microsecond units)
1169 * to poll for transfers. After the URB has been submitted, the interval
1170 * field reflects how the transfer was actually scheduled.
1171 * The polling interval may be more frequent than requested.
1172 * For example, some controllers have a maximum interval of 32 milliseconds,
1173 * while others support intervals of up to 1024 milliseconds.
1174 * Isochronous URBs also have transfer intervals. (Note that for isochronous
1175 * endpoints, as well as high speed interrupt endpoints, the encoding of
1176 * the transfer interval in the endpoint descriptor is logarithmic.
1177 * Device drivers must convert that value to linear units themselves.)
1178 *
1179 * Isochronous URBs normally use the URB_ISO_ASAP transfer flag, telling
1180 * the host controller to schedule the transfer as soon as bandwidth
1181 * utilization allows, and then set start_frame to reflect the actual frame
1182 * selected during submission. Otherwise drivers must specify the start_frame
1183 * and handle the case where the transfer can't begin then. However, drivers
1184 * won't know how bandwidth is currently allocated, and while they can
1185 * find the current frame using usb_get_current_frame_number () they can't
1186 * know the range for that frame number. (Ranges for frame counter values
1187 * are HC-specific, and can go from 256 to 65536 frames from "now".)
1188 *
1189 * Isochronous URBs have a different data transfer model, in part because
1190 * the quality of service is only "best effort". Callers provide specially
1191 * allocated URBs, with number_of_packets worth of iso_frame_desc structures
1192 * at the end. Each such packet is an individual ISO transfer. Isochronous
1193 * URBs are normally queued, submitted by drivers to arrange that
1194 * transfers are at least double buffered, and then explicitly resubmitted
1195 * in completion handlers, so
1196 * that data (such as audio or video) streams at as constant a rate as the
1197 * host controller scheduler can support.
1198 *
1199 * Completion Callbacks:
1200 *
1201 * The completion callback is made in_interrupt(), and one of the first
1202 * things that a completion handler should do is check the status field.
1203 * The status field is provided for all URBs. It is used to report
1204 * unlinked URBs, and status for all non-ISO transfers. It should not
1205 * be examined before the URB is returned to the completion handler.
1206 *
1207 * The context field is normally used to link URBs back to the relevant
1208 * driver or request state.
1209 *
1210 * When the completion callback is invoked for non-isochronous URBs, the
1211 * actual_length field tells how many bytes were transferred. This field
1212 * is updated even when the URB terminated with an error or was unlinked.
1213 *
1214 * ISO transfer status is reported in the status and actual_length fields
1215 * of the iso_frame_desc array, and the number of errors is reported in
1216 * error_count. Completion callbacks for ISO transfers will normally
1217 * (re)submit URBs to ensure a constant transfer rate.
Roman Kagan719df462005-05-06 00:55:56 +04001218 *
1219 * Note that even fields marked "public" should not be touched by the driver
1220 * when the urb is owned by the hcd, that is, since the call to
1221 * usb_submit_urb() till the entry into the completion routine.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001223struct urb {
Martin Waitzaeec46b2005-11-13 16:08:13 -08001224 /* private: usb core and host controller only fields in the urb */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225 struct kref kref; /* reference count of the URB */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226 void *hcpriv; /* private data for host controller */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227 atomic_t use_count; /* concurrent submissions counter */
Ming Lei49367d82008-12-12 21:38:45 +08001228 atomic_t reject; /* submissions will fail */
Alan Sterneb231052007-08-21 15:40:36 -04001229 int unlinked; /* unlink error code */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230
Martin Waitzaeec46b2005-11-13 16:08:13 -08001231 /* public: documented fields in the urb that can be used by drivers */
Alan Sternb724ae72005-10-24 15:36:00 -04001232 struct list_head urb_list; /* list head for use by the urb's
1233 * current owner */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001234 struct list_head anchor_list; /* the URB may be anchored */
Oliver Neukum51a2f072007-05-25 13:40:56 +02001235 struct usb_anchor *anchor;
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -07001236 struct usb_device *dev; /* (in) pointer to associated device */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001237 struct usb_host_endpoint *ep; /* (internal) pointer to endpoint */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238 unsigned int pipe; /* (in) pipe information */
Sarah Sharp94af1222010-04-02 15:34:10 -07001239 unsigned int stream_id; /* (in) stream ID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240 int status; /* (return) non-ISO status */
1241 unsigned int transfer_flags; /* (in) URB_SHORT_NOT_OK | ...*/
1242 void *transfer_buffer; /* (in) associated data buffer */
1243 dma_addr_t transfer_dma; /* (in) dma addr for transfer_buffer */
Matthew Wilcox910f8d02010-05-01 12:20:01 -06001244 struct scatterlist *sg; /* (in) scatter gather buffer list */
Clemens Ladischbc677d52011-12-03 23:41:31 +01001245 int num_mapped_sgs; /* (internal) mapped sg entries */
Sarah Sharpe04748e2009-04-27 19:59:01 -07001246 int num_sgs; /* (in) number of entries in the sg list */
Greg Kroah-Hartman16e2e5f2009-03-03 16:44:13 -08001247 u32 transfer_buffer_length; /* (in) data buffer length */
Greg Kroah-Hartman8c209e62009-03-06 21:31:03 -08001248 u32 actual_length; /* (return) actual transfer length */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249 unsigned char *setup_packet; /* (in) setup packet (control only) */
1250 dma_addr_t setup_dma; /* (in) dma addr for setup_packet */
1251 int start_frame; /* (modify) start frame (ISO) */
1252 int number_of_packets; /* (in) number of ISO packets */
Alan Sternb724ae72005-10-24 15:36:00 -04001253 int interval; /* (modify) transfer interval
1254 * (INT/ISO) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255 int error_count; /* (return) number of ISO errors */
1256 void *context; /* (in) context for completion */
1257 usb_complete_t complete; /* (in) completion routine */
Alan Sternb724ae72005-10-24 15:36:00 -04001258 struct usb_iso_packet_descriptor iso_frame_desc[0];
1259 /* (in) ISO ONLY */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260};
1261
Alan Sternb724ae72005-10-24 15:36:00 -04001262/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263
1264/**
1265 * usb_fill_control_urb - initializes a control urb
1266 * @urb: pointer to the urb to initialize.
1267 * @dev: pointer to the struct usb_device for this urb.
1268 * @pipe: the endpoint pipe
1269 * @setup_packet: pointer to the setup_packet buffer
1270 * @transfer_buffer: pointer to the transfer buffer
1271 * @buffer_length: length of the transfer buffer
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001272 * @complete_fn: pointer to the usb_complete_t function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273 * @context: what to set the urb context to.
1274 *
1275 * Initializes a control urb with the proper information needed to submit
1276 * it to a device.
1277 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001278static inline void usb_fill_control_urb(struct urb *urb,
1279 struct usb_device *dev,
1280 unsigned int pipe,
1281 unsigned char *setup_packet,
1282 void *transfer_buffer,
1283 int buffer_length,
1284 usb_complete_t complete_fn,
1285 void *context)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001287 urb->dev = dev;
1288 urb->pipe = pipe;
1289 urb->setup_packet = setup_packet;
1290 urb->transfer_buffer = transfer_buffer;
1291 urb->transfer_buffer_length = buffer_length;
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001292 urb->complete = complete_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293 urb->context = context;
1294}
1295
1296/**
1297 * usb_fill_bulk_urb - macro to help initialize a bulk urb
1298 * @urb: pointer to the urb to initialize.
1299 * @dev: pointer to the struct usb_device for this urb.
1300 * @pipe: the endpoint pipe
1301 * @transfer_buffer: pointer to the transfer buffer
1302 * @buffer_length: length of the transfer buffer
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001303 * @complete_fn: pointer to the usb_complete_t function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304 * @context: what to set the urb context to.
1305 *
1306 * Initializes a bulk urb with the proper information needed to submit it
1307 * to a device.
1308 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001309static inline void usb_fill_bulk_urb(struct urb *urb,
1310 struct usb_device *dev,
1311 unsigned int pipe,
1312 void *transfer_buffer,
1313 int buffer_length,
1314 usb_complete_t complete_fn,
1315 void *context)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317 urb->dev = dev;
1318 urb->pipe = pipe;
1319 urb->transfer_buffer = transfer_buffer;
1320 urb->transfer_buffer_length = buffer_length;
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001321 urb->complete = complete_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322 urb->context = context;
1323}
1324
1325/**
1326 * usb_fill_int_urb - macro to help initialize a interrupt urb
1327 * @urb: pointer to the urb to initialize.
1328 * @dev: pointer to the struct usb_device for this urb.
1329 * @pipe: the endpoint pipe
1330 * @transfer_buffer: pointer to the transfer buffer
1331 * @buffer_length: length of the transfer buffer
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001332 * @complete_fn: pointer to the usb_complete_t function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 * @context: what to set the urb context to.
1334 * @interval: what to set the urb interval to, encoded like
1335 * the endpoint descriptor's bInterval value.
1336 *
1337 * Initializes a interrupt urb with the proper information needed to submit
1338 * it to a device.
Matthew Wilcoxf09a15e2010-03-16 12:55:44 -07001339 *
1340 * Note that High Speed and SuperSpeed interrupt endpoints use a logarithmic
1341 * encoding of the endpoint interval, and express polling intervals in
1342 * microframes (eight per millisecond) rather than in frames (one per
1343 * millisecond).
1344 *
1345 * Wireless USB also uses the logarithmic encoding, but specifies it in units of
1346 * 128us instead of 125us. For Wireless USB devices, the interval is passed
1347 * through to the host controller, rather than being translated into microframe
1348 * units.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001350static inline void usb_fill_int_urb(struct urb *urb,
1351 struct usb_device *dev,
1352 unsigned int pipe,
1353 void *transfer_buffer,
1354 int buffer_length,
1355 usb_complete_t complete_fn,
1356 void *context,
1357 int interval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359 urb->dev = dev;
1360 urb->pipe = pipe;
1361 urb->transfer_buffer = transfer_buffer;
1362 urb->transfer_buffer_length = buffer_length;
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001363 urb->complete = complete_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364 urb->context = context;
Matthew Wilcoxf09a15e2010-03-16 12:55:44 -07001365 if (dev->speed == USB_SPEED_HIGH || dev->speed == USB_SPEED_SUPER)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366 urb->interval = 1 << (interval - 1);
1367 else
1368 urb->interval = interval;
1369 urb->start_frame = -1;
1370}
1371
1372extern void usb_init_urb(struct urb *urb);
Al Viro55016f12005-10-21 03:21:58 -04001373extern struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374extern void usb_free_urb(struct urb *urb);
1375#define usb_put_urb usb_free_urb
1376extern struct urb *usb_get_urb(struct urb *urb);
Al Viro55016f12005-10-21 03:21:58 -04001377extern int usb_submit_urb(struct urb *urb, gfp_t mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378extern int usb_unlink_urb(struct urb *urb);
1379extern void usb_kill_urb(struct urb *urb);
Oliver Neukum55b447b2008-07-29 15:26:15 +02001380extern void usb_poison_urb(struct urb *urb);
1381extern void usb_unpoison_urb(struct urb *urb);
Oliver Neukum51a2f072007-05-25 13:40:56 +02001382extern void usb_kill_anchored_urbs(struct usb_anchor *anchor);
Oliver Neukum6a2839b2008-07-29 16:18:47 +02001383extern void usb_poison_anchored_urbs(struct usb_anchor *anchor);
Oliver Neukum856395d2008-12-18 09:17:49 +01001384extern void usb_unpoison_anchored_urbs(struct usb_anchor *anchor);
Oliver Neukumeda76952008-04-10 14:07:37 +02001385extern void usb_unlink_anchored_urbs(struct usb_anchor *anchor);
Oliver Neukum51a2f072007-05-25 13:40:56 +02001386extern void usb_anchor_urb(struct urb *urb, struct usb_anchor *anchor);
1387extern void usb_unanchor_urb(struct urb *urb);
1388extern int usb_wait_anchor_empty_timeout(struct usb_anchor *anchor,
1389 unsigned int timeout);
Oliver Neukum19876252008-08-25 22:40:25 +02001390extern struct urb *usb_get_from_anchor(struct usb_anchor *anchor);
1391extern void usb_scuttle_anchored_urbs(struct usb_anchor *anchor);
1392extern int usb_anchor_empty(struct usb_anchor *anchor);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393
Alan Sternfea34092007-07-30 17:06:16 -04001394/**
1395 * usb_urb_dir_in - check if an URB describes an IN transfer
1396 * @urb: URB to be checked
1397 *
1398 * Returns 1 if @urb describes an IN transfer (device-to-host),
1399 * otherwise 0.
1400 */
1401static inline int usb_urb_dir_in(struct urb *urb)
1402{
Alan Sternd617bc82007-08-02 15:04:52 -04001403 return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_IN;
Alan Sternfea34092007-07-30 17:06:16 -04001404}
1405
1406/**
1407 * usb_urb_dir_out - check if an URB describes an OUT transfer
1408 * @urb: URB to be checked
1409 *
1410 * Returns 1 if @urb describes an OUT transfer (host-to-device),
1411 * otherwise 0.
1412 */
1413static inline int usb_urb_dir_out(struct urb *urb)
1414{
1415 return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_OUT;
1416}
1417
Daniel Mack073900a2010-04-12 13:17:25 +02001418void *usb_alloc_coherent(struct usb_device *dev, size_t size,
Al Viro55016f12005-10-21 03:21:58 -04001419 gfp_t mem_flags, dma_addr_t *dma);
Daniel Mack073900a2010-04-12 13:17:25 +02001420void usb_free_coherent(struct usb_device *dev, size_t size,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 void *addr, dma_addr_t dma);
1422
1423#if 0
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001424struct urb *usb_buffer_map(struct urb *urb);
1425void usb_buffer_dmasync(struct urb *urb);
1426void usb_buffer_unmap(struct urb *urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427#endif
1428
1429struct scatterlist;
Alan Stern5e60a162007-07-30 17:07:21 -04001430int usb_buffer_map_sg(const struct usb_device *dev, int is_in,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -03001431 struct scatterlist *sg, int nents);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432#if 0
Alan Stern5e60a162007-07-30 17:07:21 -04001433void usb_buffer_dmasync_sg(const struct usb_device *dev, int is_in,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -03001434 struct scatterlist *sg, int n_hw_ents);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435#endif
Alan Stern5e60a162007-07-30 17:07:21 -04001436void usb_buffer_unmap_sg(const struct usb_device *dev, int is_in,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -03001437 struct scatterlist *sg, int n_hw_ents);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438
1439/*-------------------------------------------------------------------*
1440 * SYNCHRONOUS CALL SUPPORT *
1441 *-------------------------------------------------------------------*/
1442
1443extern int usb_control_msg(struct usb_device *dev, unsigned int pipe,
1444 __u8 request, __u8 requesttype, __u16 value, __u16 index,
1445 void *data, __u16 size, int timeout);
Greg Kroah-Hartman782a7a62006-05-19 13:20:20 -07001446extern int usb_interrupt_msg(struct usb_device *usb_dev, unsigned int pipe,
1447 void *data, int len, int *actual_length, int timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448extern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,
1449 void *data, int len, int *actual_length,
1450 int timeout);
1451
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452/* wrappers around usb_control_msg() for the most common standard requests */
1453extern int usb_get_descriptor(struct usb_device *dev, unsigned char desctype,
1454 unsigned char descindex, void *buf, int size);
1455extern int usb_get_status(struct usb_device *dev,
1456 int type, int target, void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457extern int usb_string(struct usb_device *dev, int index,
1458 char *buf, size_t size);
1459
1460/* wrappers that also update important state inside usbcore */
1461extern int usb_clear_halt(struct usb_device *dev, int pipe);
1462extern int usb_reset_configuration(struct usb_device *dev);
1463extern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate);
David Vrabel3444b262009-04-08 17:36:28 +00001464extern void usb_reset_endpoint(struct usb_device *dev, unsigned int epaddr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465
Alan Stern088dc272006-08-21 12:08:19 -04001466/* this request isn't really synchronous, but it belongs with the others */
1467extern int usb_driver_set_configuration(struct usb_device *udev, int config);
1468
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469/*
1470 * timeouts, in milliseconds, used for sending/receiving control messages
1471 * they typically complete within a few frames (msec) after they're issued
1472 * USB identifies 5 second timeouts, maybe more in a few cases, and a few
1473 * slow devices (like some MGE Ellipse UPSes) actually push that limit.
1474 */
1475#define USB_CTRL_GET_TIMEOUT 5000
1476#define USB_CTRL_SET_TIMEOUT 5000
1477
1478
1479/**
1480 * struct usb_sg_request - support for scatter/gather I/O
1481 * @status: zero indicates success, else negative errno
1482 * @bytes: counts bytes transferred.
1483 *
1484 * These requests are initialized using usb_sg_init(), and then are used
1485 * as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most
1486 * members of the request object aren't for driver access.
1487 *
1488 * The status and bytecount values are valid only after usb_sg_wait()
1489 * returns. If the status is zero, then the bytecount matches the total
1490 * from the request.
1491 *
1492 * After an error completion, drivers may need to clear a halt condition
1493 * on the endpoint.
1494 */
1495struct usb_sg_request {
1496 int status;
1497 size_t bytes;
1498
Randy Dunlapbf92c192009-04-29 21:02:49 -07001499 /* private:
1500 * members below are private to usbcore,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501 * and are not provided for driver access!
1502 */
1503 spinlock_t lock;
1504
1505 struct usb_device *dev;
1506 int pipe;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507
1508 int entries;
1509 struct urb **urbs;
1510
1511 int count;
1512 struct completion complete;
1513};
1514
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001515int usb_sg_init(
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516 struct usb_sg_request *io,
1517 struct usb_device *dev,
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001518 unsigned pipe,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519 unsigned period,
1520 struct scatterlist *sg,
1521 int nents,
1522 size_t length,
Al Viro55016f12005-10-21 03:21:58 -04001523 gfp_t mem_flags
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524);
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001525void usb_sg_cancel(struct usb_sg_request *io);
1526void usb_sg_wait(struct usb_sg_request *io);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527
1528
Alan Sternb724ae72005-10-24 15:36:00 -04001529/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530
1531/*
1532 * For various legacy reasons, Linux has a small cookie that's paired with
1533 * a struct usb_device to identify an endpoint queue. Queue characteristics
1534 * are defined by the endpoint's descriptor. This cookie is called a "pipe",
1535 * an unsigned int encoded as:
1536 *
1537 * - direction: bit 7 (0 = Host-to-Device [Out],
1538 * 1 = Device-to-Host [In] ...
1539 * like endpoint bEndpointAddress)
1540 * - device address: bits 8-14 ... bit positions known to uhci-hcd
1541 * - endpoint: bits 15-18 ... bit positions known to uhci-hcd
1542 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
1543 * 10 = control, 11 = bulk)
1544 *
1545 * Given the device address and endpoint descriptor, pipes are redundant.
1546 */
1547
1548/* NOTE: these are not the standard USB_ENDPOINT_XFER_* values!! */
1549/* (yet ... they're the values used by usbfs) */
1550#define PIPE_ISOCHRONOUS 0
1551#define PIPE_INTERRUPT 1
1552#define PIPE_CONTROL 2
1553#define PIPE_BULK 3
1554
1555#define usb_pipein(pipe) ((pipe) & USB_DIR_IN)
1556#define usb_pipeout(pipe) (!usb_pipein(pipe))
1557
1558#define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
1559#define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
1560
1561#define usb_pipetype(pipe) (((pipe) >> 30) & 3)
1562#define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
1563#define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
1564#define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
1565#define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
1566
Alan Sternb724ae72005-10-24 15:36:00 -04001567static inline unsigned int __create_pipe(struct usb_device *dev,
1568 unsigned int endpoint)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569{
1570 return (dev->devnum << 8) | (endpoint << 15);
1571}
1572
1573/* Create various pipes... */
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -07001574#define usb_sndctrlpipe(dev, endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001575 ((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint))
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -07001576#define usb_rcvctrlpipe(dev, endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001577 ((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -07001578#define usb_sndisocpipe(dev, endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001579 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint))
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -07001580#define usb_rcvisocpipe(dev, endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001581 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -07001582#define usb_sndbulkpipe(dev, endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001583 ((PIPE_BULK << 30) | __create_pipe(dev, endpoint))
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -07001584#define usb_rcvbulkpipe(dev, endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001585 ((PIPE_BULK << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -07001586#define usb_sndintpipe(dev, endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001587 ((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint))
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -07001588#define usb_rcvintpipe(dev, endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001589 ((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590
Matthew Wilcoxfe54b052010-04-30 13:11:29 -06001591static inline struct usb_host_endpoint *
1592usb_pipe_endpoint(struct usb_device *dev, unsigned int pipe)
1593{
1594 struct usb_host_endpoint **eps;
1595 eps = usb_pipein(pipe) ? dev->ep_in : dev->ep_out;
1596 return eps[usb_pipeendpoint(pipe)];
1597}
1598
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599/*-------------------------------------------------------------------------*/
1600
1601static inline __u16
1602usb_maxpacket(struct usb_device *udev, int pipe, int is_out)
1603{
1604 struct usb_host_endpoint *ep;
1605 unsigned epnum = usb_pipeendpoint(pipe);
1606
1607 if (is_out) {
1608 WARN_ON(usb_pipein(pipe));
1609 ep = udev->ep_out[epnum];
1610 } else {
1611 WARN_ON(usb_pipeout(pipe));
1612 ep = udev->ep_in[epnum];
1613 }
1614 if (!ep)
1615 return 0;
1616
1617 /* NOTE: only 0x07ff bits are for packet size... */
Kuninori Morimoto29cc8892011-08-23 03:12:03 -07001618 return usb_endpoint_maxp(&ep->desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619}
1620
Alan Sternb724ae72005-10-24 15:36:00 -04001621/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622
Johan Hovold2c4d6bf2011-11-10 14:58:26 +01001623/* translate USB error codes to codes user space understands */
1624static inline int usb_translate_errors(int error_code)
1625{
1626 switch (error_code) {
1627 case 0:
1628 case -ENOMEM:
1629 case -ENODEV:
1630 return error_code;
1631 default:
1632 return -EIO;
1633 }
1634}
1635
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -07001636/* Events from the usb core */
1637#define USB_DEVICE_ADD 0x0001
1638#define USB_DEVICE_REMOVE 0x0002
1639#define USB_BUS_ADD 0x0003
1640#define USB_BUS_REMOVE 0x0004
1641extern void usb_register_notify(struct notifier_block *nb);
1642extern void usb_unregister_notify(struct notifier_block *nb);
1643
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644#ifdef DEBUG
Joe Perchesefcbd3d2010-02-05 18:09:49 -08001645#define dbg(format, arg...) \
1646 printk(KERN_DEBUG "%s: " format "\n", __FILE__, ##arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647#else
Joe Perchesefcbd3d2010-02-05 18:09:49 -08001648#define dbg(format, arg...) \
1649do { \
1650 if (0) \
1651 printk(KERN_DEBUG "%s: " format "\n", __FILE__, ##arg); \
1652} while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653#endif
1654
Joe Perchesefcbd3d2010-02-05 18:09:49 -08001655#define err(format, arg...) \
1656 printk(KERN_ERR KBUILD_MODNAME ": " format "\n", ##arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657
Greg Kroah-Hartman00048b82009-04-24 14:56:26 -07001658/* debugfs stuff */
1659extern struct dentry *usb_debug_root;
1660
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661#endif /* __KERNEL__ */
1662
1663#endif