blob: acb1b0aa77d85fdbdf83031bde45896ae9024f61 [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
Richard Kennedy0d5ff302012-07-10 17:19:25 +010080 int extralen;
81 unsigned char *extra; /* Extra descriptors */
82
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 /* array of desc.bNumEndpoint endpoints associated with this
84 * interface setting. these will be in no particular order.
85 */
86 struct usb_host_endpoint *endpoint;
87
88 char *string; /* iInterface string, if present */
Linus Torvalds1da177e2005-04-16 15:20:36 -070089};
90
91enum usb_interface_condition {
92 USB_INTERFACE_UNBOUND = 0,
93 USB_INTERFACE_BINDING,
94 USB_INTERFACE_BOUND,
95 USB_INTERFACE_UNBINDING,
96};
97
98/**
99 * struct usb_interface - what usb device drivers talk to
100 * @altsetting: array of interface structures, one for each alternate
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -0700101 * setting that may be selected. Each one includes a set of
102 * endpoint configurations. They will be in no particular order.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 * @cur_altsetting: the current altsetting.
Lei Mingd6d914f2008-02-25 18:07:28 +0800104 * @num_altsetting: number of altsettings defined.
Randy Dunlap3f423782007-07-19 10:21:37 -0700105 * @intf_assoc: interface association descriptor
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 * @minor: the minor number assigned to this interface, if this
107 * interface is bound to a driver that uses the USB major number.
108 * If this interface does not use the USB major, this field should
109 * be unused. The driver should set this value in the probe()
110 * function of the driver, after it has been assigned a minor
111 * number from the USB core by calling usb_register_dev().
112 * @condition: binding state of the interface: not bound, binding
113 * (in probe()), bound to a driver, or unbinding (in disconnect())
Randy Dunlapf88ed902007-12-03 14:14:16 -0800114 * @sysfs_files_created: sysfs attributes exist
Alan Stern3b23dd62008-12-05 14:10:34 -0500115 * @ep_devs_created: endpoint child pseudo-devices exist
Alan Stern352d0262008-10-29 15:16:58 -0400116 * @unregistering: flag set when the interface is being unregistered
Alan Stern645daaa2006-08-30 15:47:02 -0400117 * @needs_remote_wakeup: flag set when the driver requires remote-wakeup
118 * capability during autosuspend.
Alan Stern55151d72008-08-12 14:33:59 -0400119 * @needs_altsetting0: flag set when a set-interface request for altsetting 0
120 * has been deferred.
Alan Sternf4f4d582008-07-28 10:39:28 -0400121 * @needs_binding: flag set when the driver should be re-probed or unbound
122 * following a reset or suspend operation it doesn't support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123 * @dev: driver model's view of this device
Greg Kroah-Hartman0873c762006-06-20 13:09:50 -0700124 * @usb_dev: if an interface is bound to the USB major, this will point
125 * to the sysfs representation for that device.
Alan Stern9bbdf1e2010-01-08 12:57:28 -0500126 * @pm_usage_cnt: PM usage counter for this interface
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -0800127 * @reset_ws: Used for scheduling resets from atomic context.
128 * @reset_running: set to 1 if the interface is currently running a
129 * queued reset so that usb_cancel_queued_reset() doesn't try to
130 * remove from the workqueue when running inside the worker
131 * thread. See __usb_queue_reset_device().
Randy Dunlapc6ba1c22010-07-29 15:54:38 -0700132 * @resetting_device: USB core reset the device, so use alt setting 0 as
133 * current; needs bandwidth alloc after reset.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 *
135 * USB device drivers attach to interfaces on a physical device. Each
136 * interface encapsulates a single high level function, such as feeding
137 * an audio stream to a speaker or reporting a change in a volume control.
138 * Many USB devices only have one interface. The protocol used to talk to
139 * an interface's endpoints can be defined in a usb "class" specification,
140 * or by a product's vendor. The (default) control endpoint is part of
141 * every interface, but is never listed among the interface's descriptors.
142 *
143 * The driver that is bound to the interface can use standard driver model
144 * calls such as dev_get_drvdata() on the dev member of this structure.
145 *
146 * Each interface may have alternate settings. The initial configuration
147 * of a device sets altsetting 0, but the device driver can change
148 * that setting using usb_set_interface(). Alternate settings are often
Michael Opdenacker59c51592007-05-09 08:57:56 +0200149 * used to control the use of periodic endpoints, such as by having
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 * different endpoints use different amounts of reserved USB bandwidth.
151 * All standards-conformant USB devices that use isochronous endpoints
152 * will use them in non-default settings.
153 *
154 * The USB specification says that alternate setting numbers must run from
155 * 0 to one less than the total number of alternate settings. But some
156 * devices manage to mess this up, and the structures aren't necessarily
157 * stored in numerical order anyhow. Use usb_altnum_to_altsetting() to
158 * look up an alternate setting in the altsetting array based on its number.
159 */
160struct usb_interface {
161 /* array of alternate settings for this interface,
162 * stored in no particular order */
163 struct usb_host_interface *altsetting;
164
165 struct usb_host_interface *cur_altsetting; /* the currently
166 * active alternate setting */
167 unsigned num_altsetting; /* number of alternate settings */
168
Craig W. Nadler165fe972007-06-15 23:14:35 -0400169 /* If there is an interface association descriptor then it will list
170 * the associated interfaces */
171 struct usb_interface_assoc_descriptor *intf_assoc;
172
Alan Sternb724ae72005-10-24 15:36:00 -0400173 int minor; /* minor number this interface is
174 * bound to */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 enum usb_interface_condition condition; /* state of binding */
Alan Stern7e615592007-11-06 11:43:42 -0500176 unsigned sysfs_files_created:1; /* the sysfs attributes exist */
Alan Stern3b23dd62008-12-05 14:10:34 -0500177 unsigned ep_devs_created:1; /* endpoint "devices" exist */
Alan Stern352d0262008-10-29 15:16:58 -0400178 unsigned unregistering:1; /* unregistration is in progress */
Alan Stern645daaa2006-08-30 15:47:02 -0400179 unsigned needs_remote_wakeup:1; /* driver requires remote wakeup */
Alan Stern55151d72008-08-12 14:33:59 -0400180 unsigned needs_altsetting0:1; /* switch to altsetting 0 is pending */
Alan Stern78d9a482008-06-23 16:00:40 -0400181 unsigned needs_binding:1; /* needs delayed unbind/rebind */
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -0800182 unsigned reset_running:1;
Sarah Sharp04a723e2010-01-06 10:16:51 -0800183 unsigned resetting_device:1; /* true: bandwidth alloc after reset */
Alan Stern4d064c02006-07-01 22:11:44 -0400184
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 struct device dev; /* interface specific device info */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800186 struct device *usb_dev;
Alan Sternccf5b802009-06-29 11:00:01 -0400187 atomic_t pm_usage_cnt; /* usage counter for autosuspend */
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -0800188 struct work_struct reset_ws; /* for resets in atomic context */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189};
190#define to_usb_interface(d) container_of(d, struct usb_interface, dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800192static inline void *usb_get_intfdata(struct usb_interface *intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193{
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800194 return dev_get_drvdata(&intf->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195}
196
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800197static inline void usb_set_intfdata(struct usb_interface *intf, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198{
199 dev_set_drvdata(&intf->dev, data);
200}
201
202struct usb_interface *usb_get_intf(struct usb_interface *intf);
203void usb_put_intf(struct usb_interface *intf);
204
205/* this maximum is arbitrary */
206#define USB_MAXINTERFACES 32
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -0700207#define USB_MAXIADS (USB_MAXINTERFACES/2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208
209/**
210 * struct usb_interface_cache - long-term representation of a device interface
211 * @num_altsetting: number of altsettings defined.
212 * @ref: reference counter.
213 * @altsetting: variable-length array of interface structures, one for
214 * each alternate setting that may be selected. Each one includes a
215 * set of endpoint configurations. They will be in no particular order.
216 *
217 * These structures persist for the lifetime of a usb_device, unlike
218 * struct usb_interface (which persists only as long as its configuration
219 * is installed). The altsetting arrays can be accessed through these
220 * structures at any time, permitting comparison of configurations and
221 * providing support for the /proc/bus/usb/devices pseudo-file.
222 */
223struct usb_interface_cache {
224 unsigned num_altsetting; /* number of alternate settings */
225 struct kref ref; /* reference counter */
226
227 /* variable-length array of alternate settings for this interface,
228 * stored in no particular order */
229 struct usb_host_interface altsetting[0];
230};
231#define ref_to_usb_interface_cache(r) \
232 container_of(r, struct usb_interface_cache, ref)
233#define altsetting_to_usb_interface_cache(a) \
234 container_of(a, struct usb_interface_cache, altsetting[0])
235
236/**
237 * struct usb_host_config - representation of a device's configuration
238 * @desc: the device's configuration descriptor.
239 * @string: pointer to the cached version of the iConfiguration string, if
240 * present for this configuration.
Randy Dunlap3f423782007-07-19 10:21:37 -0700241 * @intf_assoc: list of any interface association descriptors in this config
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 * @interface: array of pointers to usb_interface structures, one for each
243 * interface in the configuration. The number of interfaces is stored
244 * in desc.bNumInterfaces. These pointers are valid only while the
245 * the configuration is active.
246 * @intf_cache: array of pointers to usb_interface_cache structures, one
247 * for each interface in the configuration. These structures exist
248 * for the entire life of the device.
249 * @extra: pointer to buffer containing all extra descriptors associated
250 * with this configuration (those preceding the first interface
251 * descriptor).
252 * @extralen: length of the extra descriptors buffer.
253 *
254 * USB devices may have multiple configurations, but only one can be active
255 * at any time. Each encapsulates a different operational environment;
256 * for example, a dual-speed device would have separate configurations for
257 * full-speed and high-speed operation. The number of configurations
258 * available is stored in the device descriptor as bNumConfigurations.
259 *
260 * A configuration can contain multiple interfaces. Each corresponds to
261 * a different function of the USB device, and all are available whenever
262 * the configuration is active. The USB standard says that interfaces
263 * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot
264 * of devices get this wrong. In addition, the interface array is not
265 * guaranteed to be sorted in numerical order. Use usb_ifnum_to_if() to
266 * look up an interface entry based on its number.
267 *
268 * Device drivers should not attempt to activate configurations. The choice
269 * of which configuration to install is a policy decision based on such
270 * considerations as available power, functionality provided, and the user's
Kay Sievers312c0042005-11-16 09:00:00 +0100271 * desires (expressed through userspace tools). However, drivers can call
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 * usb_reset_configuration() to reinitialize the current configuration and
273 * all its interfaces.
274 */
275struct usb_host_config {
276 struct usb_config_descriptor desc;
277
Alan Stern4f62efe2005-10-24 16:24:14 -0400278 char *string; /* iConfiguration string, if present */
Craig W. Nadler165fe972007-06-15 23:14:35 -0400279
280 /* List of any Interface Association Descriptors in this
281 * configuration. */
282 struct usb_interface_assoc_descriptor *intf_assoc[USB_MAXIADS];
283
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284 /* the interfaces associated with this configuration,
285 * stored in no particular order */
286 struct usb_interface *interface[USB_MAXINTERFACES];
287
288 /* Interface information available even when this is not the
289 * active configuration */
290 struct usb_interface_cache *intf_cache[USB_MAXINTERFACES];
291
292 unsigned char *extra; /* Extra descriptors */
293 int extralen;
294};
295
Andiry Xu3148bf02011-09-23 14:19:47 -0700296/* USB2.0 and USB3.0 device BOS descriptor set */
297struct usb_host_bos {
298 struct usb_bos_descriptor *desc;
299
300 /* wireless cap descriptor is handled by wusb */
301 struct usb_ext_cap_descriptor *ext_cap;
302 struct usb_ss_cap_descriptor *ss_cap;
303 struct usb_ss_container_id_descriptor *ss_id;
304};
305
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306int __usb_get_extra_descriptor(char *buffer, unsigned size,
307 unsigned char type, void **ptr);
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800308#define usb_get_extra_descriptor(ifpoint, type, ptr) \
309 __usb_get_extra_descriptor((ifpoint)->extra, \
310 (ifpoint)->extralen, \
311 type, (void **)ptr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312
Alan Sternb724ae72005-10-24 15:36:00 -0400313/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315/* USB device number allocation bitmap */
316struct usb_devmap {
317 unsigned long devicemap[128 / (8*sizeof(unsigned long))];
318};
319
320/*
321 * Allocated per bus (tree of devices) we have:
322 */
323struct usb_bus {
324 struct device *controller; /* host/master side hardware */
325 int busnum; /* Bus number (in order of reg) */
Greg Kroah-Hartman1b26da12008-07-02 12:46:22 -0700326 const char *bus_name; /* stable id (PCI slot_name etc) */
Alan Sterndd990f12006-08-30 11:29:56 -0400327 u8 uses_dma; /* Does the host controller use DMA? */
Anand Gadiyar07a8cdd2010-11-18 18:54:17 +0530328 u8 uses_pio_for_control; /*
329 * Does the host controller use PIO
330 * for control transfers?
331 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332 u8 otg_port; /* 0, or number of OTG/HNP port */
333 unsigned is_b_host:1; /* true during some HNP roleswitches */
334 unsigned b_hnp_enable:1; /* OTG: did A-Host enable HNP? */
Hans de Goede19181bc2012-07-04 09:18:02 +0200335 unsigned no_stop_on_short:1; /*
336 * Quirk: some controllers don't stop
337 * the ep queue on a short transfer
338 * with the URB_SHORT_NOT_OK flag set.
339 */
David Vrabel4c1bd3d2009-08-24 14:44:30 +0100340 unsigned sg_tablesize; /* 0 or largest number of sg list entries */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341
Alan Sternb724ae72005-10-24 15:36:00 -0400342 int devnum_next; /* Next open device number in
343 * round-robin allocation */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344
345 struct usb_devmap devmap; /* device address allocation map */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 struct usb_device *root_hub; /* Root hub */
Alan Stern6d19c002010-02-12 12:21:11 +0100347 struct usb_bus *hs_companion; /* Companion EHCI bus, if any */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 struct list_head bus_list; /* list of busses */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349
350 int bandwidth_allocated; /* on this bus: how much of the time
351 * reserved for periodic (intr/iso)
352 * requests is used, on average?
353 * Units: microseconds/frame.
354 * Limits: Full/low speed reserve 90%,
355 * while high speed reserves 80%.
356 */
357 int bandwidth_int_reqs; /* number of Interrupt requests */
358 int bandwidth_isoc_reqs; /* number of Isoc. requests */
359
Alan Sternda0aa712013-01-25 17:09:42 -0500360 unsigned resuming_ports; /* bit array: resuming root-hub ports */
361
Pete Zaitcevf150fa12008-11-13 21:31:21 -0700362#if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 struct mon_bus *mon_bus; /* non-null when associated */
364 int monitored; /* non-zero when monitored */
365#endif
366};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367
Alan Sternb724ae72005-10-24 15:36:00 -0400368/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370struct usb_tt;
371
Matthew Garrett0846e7e2012-02-03 17:11:54 -0500372enum usb_device_removable {
373 USB_DEVICE_REMOVABLE_UNKNOWN = 0,
374 USB_DEVICE_REMOVABLE,
375 USB_DEVICE_FIXED,
376};
377
Lan Tianyu05f91682012-09-05 13:44:34 +0800378enum usb_port_connect_type {
379 USB_PORT_CONNECT_TYPE_UNKNOWN = 0,
380 USB_PORT_CONNECT_TYPE_HOT_PLUG,
381 USB_PORT_CONNECT_TYPE_HARD_WIRED,
382 USB_PORT_NOT_USED,
383};
384
Sarah Sharp51e0a012012-02-20 12:02:19 -0800385/*
Mathias Nyman17f34862013-05-23 17:14:31 +0300386 * USB 2.0 Link Power Management (LPM) parameters.
387 */
388struct usb2_lpm_parameters {
389 /* Best effort service latency indicate how long the host will drive
390 * resume on an exit from L1.
391 */
392 unsigned int besl;
393
394 /* Timeout value in microseconds for the L1 inactivity (LPM) timer.
395 * When the timer counts to zero, the parent hub will initiate a LPM
396 * transition to L1.
397 */
398 int timeout;
399};
400
401/*
Sarah Sharp51e0a012012-02-20 12:02:19 -0800402 * USB 3.0 Link Power Management (LPM) parameters.
403 *
404 * PEL and SEL are USB 3.0 Link PM latencies for device-initiated LPM exit.
405 * MEL is the USB 3.0 Link PM latency for host-initiated LPM exit.
406 * All three are stored in nanoseconds.
407 */
408struct usb3_lpm_parameters {
409 /*
410 * Maximum exit latency (MEL) for the host to send a packet to the
411 * device (either a Ping for isoc endpoints, or a data packet for
412 * interrupt endpoints), the hubs to decode the packet, and for all hubs
413 * in the path to transition the links to U0.
414 */
415 unsigned int mel;
416 /*
417 * Maximum exit latency for a device-initiated LPM transition to bring
418 * all links into U0. Abbreviated as "PEL" in section 9.4.12 of the USB
419 * 3.0 spec, with no explanation of what "P" stands for. "Path"?
420 */
421 unsigned int pel;
422
423 /*
424 * The System Exit Latency (SEL) includes PEL, and three other
425 * latencies. After a device initiates a U0 transition, it will take
426 * some time from when the device sends the ERDY to when it will finally
427 * receive the data packet. Basically, SEL should be the worse-case
428 * latency from when a device starts initiating a U0 transition to when
429 * it will get data.
430 */
431 unsigned int sel;
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -0700432 /*
433 * The idle timeout value that is currently programmed into the parent
434 * hub for this device. When the timer counts to zero, the parent hub
435 * will initiate an LPM transition to either U1 or U2.
436 */
437 int timeout;
Sarah Sharp51e0a012012-02-20 12:02:19 -0800438};
439
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800440/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 * struct usb_device - kernel's representation of a USB device
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800442 * @devnum: device number; address on a USB bus
443 * @devpath: device ID string for use in messages (e.g., /port/...)
Sarah Sharp7206b002009-04-27 19:54:49 -0700444 * @route: tree topology hex string for use with xHCI
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800445 * @state: device state: configured, not attached, etc.
446 * @speed: device speed: high/full/low (or error)
447 * @tt: Transaction Translator info; used with low/full speed dev, highspeed hub
448 * @ttport: device port on that tt hub
449 * @toggle: one bit for each endpoint, with ([0] = IN, [1] = OUT) endpoints
450 * @parent: our hub, unless we're the root
451 * @bus: bus we're part of
452 * @ep0: endpoint 0 data (default control pipe)
453 * @dev: generic device interface
454 * @descriptor: USB device descriptor
Andiry Xu3148bf02011-09-23 14:19:47 -0700455 * @bos: USB device BOS descriptor set
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800456 * @config: all of the device's configs
457 * @actconfig: the active configuration
458 * @ep_in: array of IN endpoints
459 * @ep_out: array of OUT endpoints
460 * @rawdescriptors: raw descriptors for each config
461 * @bus_mA: Current available from the bus
462 * @portnum: parent port number (origin 1)
463 * @level: number of USB hub ancestors
464 * @can_submit: URBs may be submitted
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800465 * @persist_enabled: USB_PERSIST enabled for this device
466 * @have_langid: whether string_langid is valid
467 * @authorized: policy has said we can use it;
468 * (user space) policy determines if we authorize this device to be
469 * used or not. By default, wired USB devices are authorized.
470 * WUSB devices are not, until we authorize them from user space.
471 * FIXME -- complete doc
Inaky Perez-Gonzalez3b52f122008-04-08 13:24:46 -0700472 * @authenticated: Crypto authentication passed
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800473 * @wusb: device is Wireless USB
Andiry Xu1ff4df52011-09-23 14:19:48 -0700474 * @lpm_capable: device supports LPM
Andiry Xu65580b432011-09-23 14:19:52 -0700475 * @usb2_hw_lpm_capable: device can perform USB2 hardware LPM
Mathias Nymana558ccd2013-05-23 17:14:30 +0300476 * @usb2_hw_lpm_besl_capable: device can perform USB2 hardware BESL LPM
Andiry Xu65580b432011-09-23 14:19:52 -0700477 * @usb2_hw_lpm_enabled: USB2 hardware LPM enabled
Nishanth Menondad3cab2013-03-04 16:52:49 -0600478 * @usb3_lpm_enabled: USB3 hardware LPM enabled
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800479 * @string_langid: language ID for strings
480 * @product: iProduct string, if present (static)
481 * @manufacturer: iManufacturer string, if present (static)
482 * @serial: iSerialNumber string, if present (static)
483 * @filelist: usbfs files that are open to this device
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800484 * @maxchild: number of ports if hub
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800485 * @quirks: quirks of the whole device
486 * @urbnum: number of URBs submitted for the whole device
487 * @active_duration: total time device is not suspended
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800488 * @connect_time: time device was first connected
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800489 * @do_remote_wakeup: remote wakeup should be enabled
490 * @reset_resume: needs reset instead of resume
Alan Sternbfd1e912012-10-19 11:03:39 -0400491 * @port_is_suspended: the upstream port is suspended (L2 or U3)
Inaky Perez-Gonzalez11e76ae2009-01-08 12:52:19 -0800492 * @wusb_dev: if this is a Wireless USB device, link to the WUSB
493 * specific data for the device.
Sarah Sharpc6515272009-04-27 19:57:26 -0700494 * @slot_id: Slot ID assigned by xHCI
Matthew Garrett0846e7e2012-02-03 17:11:54 -0500495 * @removable: Device can be physically removed from this port
Mathias Nyman17f34862013-05-23 17:14:31 +0300496 * @l1_params: best effor service latency for USB2 L1 LPM state, and L1 timeout.
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -0700497 * @u1_params: exit latencies for USB3 U1 LPM state, and hub-initiated timeout.
498 * @u2_params: exit latencies for USB3 U2 LPM state, and hub-initiated timeout.
499 * @lpm_disable_count: Ref count used by usb_disable_lpm() and usb_enable_lpm()
500 * to keep track of the number of functions that require USB 3.0 Link Power
501 * Management to be disabled for this usb_device. This count should only
502 * be manipulated by those functions, with the bandwidth_mutex is held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 *
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800504 * Notes:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505 * Usbcore drivers should not set usbdev->state directly. Instead use
506 * usb_set_device_state().
507 */
508struct usb_device {
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800509 int devnum;
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -0700510 char devpath[16];
Sarah Sharp7206b002009-04-27 19:54:49 -0700511 u32 route;
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800512 enum usb_device_state state;
513 enum usb_device_speed speed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800515 struct usb_tt *tt;
516 int ttport;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800518 unsigned int toggle[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800520 struct usb_device *parent;
521 struct usb_bus *bus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522 struct usb_host_endpoint ep0;
523
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800524 struct device dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800526 struct usb_device_descriptor descriptor;
Andiry Xu3148bf02011-09-23 14:19:47 -0700527 struct usb_host_bos *bos;
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800528 struct usb_host_config *config;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800530 struct usb_host_config *actconfig;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 struct usb_host_endpoint *ep_in[16];
532 struct usb_host_endpoint *ep_out[16];
533
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800534 char **rawdescriptors;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800536 unsigned short bus_mA;
537 u8 portnum;
538 u8 level;
Alan Stern55c52712005-11-23 12:03:12 -0500539
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800540 unsigned can_submit:1;
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800541 unsigned persist_enabled:1;
542 unsigned have_langid:1;
543 unsigned authorized:1;
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -0700544 unsigned authenticated:1;
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800545 unsigned wusb:1;
Andiry Xu1ff4df52011-09-23 14:19:48 -0700546 unsigned lpm_capable:1;
Andiry Xu65580b432011-09-23 14:19:52 -0700547 unsigned usb2_hw_lpm_capable:1;
Mathias Nymana558ccd2013-05-23 17:14:30 +0300548 unsigned usb2_hw_lpm_besl_capable:1;
Andiry Xu65580b432011-09-23 14:19:52 -0700549 unsigned usb2_hw_lpm_enabled:1;
Sarah Sharp83060952012-05-02 14:25:52 -0700550 unsigned usb3_lpm_enabled:1;
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800551 int string_langid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552
Alan Stern4f62efe2005-10-24 16:24:14 -0400553 /* static strings from the device */
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800554 char *product;
555 char *manufacturer;
556 char *serial;
Alan Stern4f62efe2005-10-24 16:24:14 -0400557
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 struct list_head filelist;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800560 int maxchild;
Alan Stern645daaa2006-08-30 15:47:02 -0400561
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800562 u32 quirks;
563 atomic_t urbnum;
Alan Sternb5e795f2007-02-20 15:00:53 -0500564
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800565 unsigned long active_duration;
Sarah Sharp15123002007-12-21 16:54:15 -0800566
Alan Stern645daaa2006-08-30 15:47:02 -0400567#ifdef CONFIG_PM
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800568 unsigned long connect_time;
Alan Sternb5e795f2007-02-20 15:00:53 -0500569
Randy Dunlapf476fbab2008-02-13 18:33:15 -0800570 unsigned do_remote_wakeup:1;
571 unsigned reset_resume:1;
Alan Sternbfd1e912012-10-19 11:03:39 -0400572 unsigned port_is_suspended:1;
Alan Stern645daaa2006-08-30 15:47:02 -0400573#endif
Inaky Perez-Gonzalezb1d8dfb2008-04-08 13:24:46 -0700574 struct wusb_dev *wusb_dev;
Sarah Sharpc6515272009-04-27 19:57:26 -0700575 int slot_id;
Matthew Garrett0846e7e2012-02-03 17:11:54 -0500576 enum usb_device_removable removable;
Mathias Nyman17f34862013-05-23 17:14:31 +0300577 struct usb2_lpm_parameters l1_params;
Sarah Sharp51e0a012012-02-20 12:02:19 -0800578 struct usb3_lpm_parameters u1_params;
579 struct usb3_lpm_parameters u2_params;
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -0700580 unsigned lpm_disable_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581};
582#define to_usb_device(d) container_of(d, struct usb_device, dev)
583
Matthew Wilcox1e429012010-04-30 13:11:30 -0600584static inline struct usb_device *interface_to_usbdev(struct usb_interface *intf)
585{
586 return to_usb_device(intf->dev.parent);
587}
588
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589extern struct usb_device *usb_get_dev(struct usb_device *dev);
590extern void usb_put_dev(struct usb_device *dev);
Lan Tianyuff823c792012-09-05 13:44:32 +0800591extern struct usb_device *usb_hub_find_child(struct usb_device *hdev,
592 int port1);
593
594/**
595 * usb_hub_for_each_child - iterate over all child devices on the hub
596 * @hdev: USB device belonging to the usb hub
597 * @port1: portnum associated with child device
598 * @child: child device pointer
599 */
600#define usb_hub_for_each_child(hdev, port1, child) \
601 for (port1 = 1, child = usb_hub_find_child(hdev, port1); \
Alan Stern969ddcf2012-10-19 11:03:02 -0400602 port1 <= hdev->maxchild; \
603 child = usb_hub_find_child(hdev, ++port1)) \
604 if (!child) continue; else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605
Alan Stern9ad3d6c2005-11-17 17:10:32 -0500606/* USB device locking */
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800607#define usb_lock_device(udev) device_lock(&(udev)->dev)
608#define usb_unlock_device(udev) device_unlock(&(udev)->dev)
609#define usb_trylock_device(udev) device_trylock(&(udev)->dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610extern int usb_lock_device_for_reset(struct usb_device *udev,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300611 const struct usb_interface *iface);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612
613/* USB port reset for device reinitialization */
614extern int usb_reset_device(struct usb_device *dev);
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -0800615extern void usb_queue_reset_device(struct usb_interface *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616
Lan Tianyuf7ac7782012-09-05 13:44:36 +0800617#ifdef CONFIG_ACPI
618extern int usb_acpi_set_power_state(struct usb_device *hdev, int index,
619 bool enable);
620extern bool usb_acpi_power_manageable(struct usb_device *hdev, int index);
621#else
622static inline int usb_acpi_set_power_state(struct usb_device *hdev, int index,
623 bool enable) { return 0; }
624static inline bool usb_acpi_power_manageable(struct usb_device *hdev, int index)
625 { return true; }
626#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627
Alan Stern645daaa2006-08-30 15:47:02 -0400628/* USB autosuspend and autoresume */
Alan Stern84ebc102013-03-27 16:14:46 -0400629#ifdef CONFIG_PM_RUNTIME
Alan Stern9e18c822010-04-02 13:22:09 -0400630extern void usb_enable_autosuspend(struct usb_device *udev);
631extern void usb_disable_autosuspend(struct usb_device *udev);
Alan Stern088f7fe2010-01-08 12:56:54 -0500632
Alan Stern645daaa2006-08-30 15:47:02 -0400633extern int usb_autopm_get_interface(struct usb_interface *intf);
634extern void usb_autopm_put_interface(struct usb_interface *intf);
Alan Stern9ac39f22008-11-12 16:19:49 -0500635extern int usb_autopm_get_interface_async(struct usb_interface *intf);
636extern void usb_autopm_put_interface_async(struct usb_interface *intf);
Alan Stern9bbdf1e2010-01-08 12:57:28 -0500637extern void usb_autopm_get_interface_no_resume(struct usb_interface *intf);
638extern void usb_autopm_put_interface_no_suspend(struct usb_interface *intf);
Alan Stern692a1862006-10-30 17:07:51 -0500639
Alan Stern19410442007-03-27 13:33:59 -0400640static inline void usb_mark_last_busy(struct usb_device *udev)
641{
Ming Lei6ddf27c2010-11-15 15:57:30 -0500642 pm_runtime_mark_last_busy(&udev->dev);
Alan Stern19410442007-03-27 13:33:59 -0400643}
644
Alan Stern692a1862006-10-30 17:07:51 -0500645#else
646
Alan Stern088f7fe2010-01-08 12:56:54 -0500647static inline int usb_enable_autosuspend(struct usb_device *udev)
648{ return 0; }
649static inline int usb_disable_autosuspend(struct usb_device *udev)
650{ return 0; }
651
Alan Stern692a1862006-10-30 17:07:51 -0500652static inline int usb_autopm_get_interface(struct usb_interface *intf)
653{ return 0; }
Alan Stern9ac39f22008-11-12 16:19:49 -0500654static inline int usb_autopm_get_interface_async(struct usb_interface *intf)
655{ return 0; }
656
Alan Stern692a1862006-10-30 17:07:51 -0500657static inline void usb_autopm_put_interface(struct usb_interface *intf)
658{ }
Alan Stern9ac39f22008-11-12 16:19:49 -0500659static inline void usb_autopm_put_interface_async(struct usb_interface *intf)
660{ }
Alan Stern8e4ceb32009-12-07 13:01:37 -0500661static inline void usb_autopm_get_interface_no_resume(
662 struct usb_interface *intf)
Alan Stern692a1862006-10-30 17:07:51 -0500663{ }
Alan Stern8e4ceb32009-12-07 13:01:37 -0500664static inline void usb_autopm_put_interface_no_suspend(
665 struct usb_interface *intf)
Alan Stern692a1862006-10-30 17:07:51 -0500666{ }
Alan Stern19410442007-03-27 13:33:59 -0400667static inline void usb_mark_last_busy(struct usb_device *udev)
668{ }
Alan Stern692a1862006-10-30 17:07:51 -0500669#endif
Alan Stern645daaa2006-08-30 15:47:02 -0400670
Sarah Sharpe9261fb2012-05-21 08:29:01 -0700671extern int usb_disable_lpm(struct usb_device *udev);
672extern void usb_enable_lpm(struct usb_device *udev);
673/* Same as above, but these functions lock/unlock the bandwidth_mutex. */
674extern int usb_unlocked_disable_lpm(struct usb_device *udev);
675extern void usb_unlocked_enable_lpm(struct usb_device *udev);
676
Sarah Sharpf74631e2012-06-25 12:08:08 -0700677extern int usb_disable_ltm(struct usb_device *udev);
678extern void usb_enable_ltm(struct usb_device *udev);
679
Sarah Sharp024f1172012-07-05 17:17:24 -0700680static inline bool usb_device_supports_ltm(struct usb_device *udev)
681{
682 if (udev->speed != USB_SPEED_SUPER || !udev->bos || !udev->bos->ss_cap)
683 return false;
684 return udev->bos->ss_cap->bmAttributes & USB_LTM_SUPPORT;
685}
686
687
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688/*-------------------------------------------------------------------------*/
689
690/* for drivers using iso endpoints */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800691extern int usb_get_current_frame_number(struct usb_device *usb_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692
Sarah Sharpeab1caf2010-04-05 10:55:58 -0700693/* Sets up a group of bulk endpoints to support multiple stream IDs. */
694extern int usb_alloc_streams(struct usb_interface *interface,
695 struct usb_host_endpoint **eps, unsigned int num_eps,
696 unsigned int num_streams, gfp_t mem_flags);
697
698/* Reverts a group of bulk endpoints back to not using stream IDs. */
699extern void usb_free_streams(struct usb_interface *interface,
700 struct usb_host_endpoint **eps, unsigned int num_eps,
701 gfp_t mem_flags);
702
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703/* used these for multi-interface device registration */
704extern int usb_driver_claim_interface(struct usb_driver *driver,
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800705 struct usb_interface *iface, void *priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706
707/**
708 * usb_interface_claimed - returns true iff an interface is claimed
709 * @iface: the interface being checked
710 *
Yacine Belkadi626f0902013-08-02 20:10:04 +0200711 * Return: %true (nonzero) iff the interface is claimed, else %false
712 * (zero).
713 *
714 * Note:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715 * Callers must own the driver model's usb bus readlock. So driver
716 * probe() entries don't need extra locking, but other call contexts
717 * may need to explicitly claim that lock.
718 *
719 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800720static inline int usb_interface_claimed(struct usb_interface *iface)
721{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 return (iface->dev.driver != NULL);
723}
724
725extern void usb_driver_release_interface(struct usb_driver *driver,
726 struct usb_interface *iface);
727const struct usb_device_id *usb_match_id(struct usb_interface *interface,
728 const struct usb_device_id *id);
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +0100729extern int usb_match_one_id(struct usb_interface *interface,
730 const struct usb_device_id *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731
Julius Werner9b790912013-05-17 12:08:51 -0700732extern int usb_for_each_dev(void *data, int (*fn)(struct usb_device *, void *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733extern struct usb_interface *usb_find_interface(struct usb_driver *drv,
734 int minor);
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300735extern struct usb_interface *usb_ifnum_to_if(const struct usb_device *dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 unsigned ifnum);
737extern struct usb_host_interface *usb_altnum_to_altsetting(
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300738 const struct usb_interface *intf, unsigned int altnum);
Sarah Sharp91017f92009-12-03 09:44:34 -0800739extern struct usb_host_interface *usb_find_alt_setting(
740 struct usb_host_config *config,
741 unsigned int iface_num,
742 unsigned int alt_num);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743
744
745/**
746 * usb_make_path - returns stable device path in the usb tree
747 * @dev: the device whose path is being constructed
748 * @buf: where to put the string
749 * @size: how big is "buf"?
750 *
Yacine Belkadi626f0902013-08-02 20:10:04 +0200751 * Return: Length of the string (> 0) or negative if size was too small.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 *
Yacine Belkadi626f0902013-08-02 20:10:04 +0200753 * Note:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754 * This identifier is intended to be "stable", reflecting physical paths in
755 * hardware such as physical bus addresses for host controllers or ports on
756 * USB hubs. That makes it stay the same until systems are physically
757 * reconfigured, by re-cabling a tree of USB devices or by moving USB host
758 * controllers. Adding and removing devices, including virtual root hubs
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300759 * in host controller driver modules, does not change these path identifiers;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 * neither does rebooting or re-enumerating. These are more useful identifiers
761 * than changeable ("unstable") ones like bus numbers or device addresses.
762 *
763 * With a partial exception for devices connected to USB 2.0 root hubs, these
764 * identifiers are also predictable. So long as the device tree isn't changed,
765 * plugging any USB device into a given hub port always gives it the same path.
766 * Because of the use of "companion" controllers, devices connected to ports on
767 * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are
768 * high speed, and a different one if they are full or low speed.
769 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800770static inline int usb_make_path(struct usb_device *dev, char *buf, size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771{
772 int actual;
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800773 actual = snprintf(buf, size, "usb-%s-%s", dev->bus->bus_name,
774 dev->devpath);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775 return (actual >= (int)size) ? -1 : actual;
776}
777
778/*-------------------------------------------------------------------------*/
779
Alan Sternb724ae72005-10-24 15:36:00 -0400780#define USB_DEVICE_ID_MATCH_DEVICE \
781 (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
782#define USB_DEVICE_ID_MATCH_DEV_RANGE \
783 (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI)
784#define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
785 (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786#define USB_DEVICE_ID_MATCH_DEV_INFO \
Alan Sternb724ae72005-10-24 15:36:00 -0400787 (USB_DEVICE_ID_MATCH_DEV_CLASS | \
788 USB_DEVICE_ID_MATCH_DEV_SUBCLASS | \
789 USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790#define USB_DEVICE_ID_MATCH_INT_INFO \
Alan Sternb724ae72005-10-24 15:36:00 -0400791 (USB_DEVICE_ID_MATCH_INT_CLASS | \
792 USB_DEVICE_ID_MATCH_INT_SUBCLASS | \
793 USB_DEVICE_ID_MATCH_INT_PROTOCOL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794
795/**
796 * USB_DEVICE - macro used to describe a specific usb device
797 * @vend: the 16 bit USB Vendor ID
798 * @prod: the 16 bit USB Product ID
799 *
800 * This macro is used to create a struct usb_device_id that matches a
801 * specific device.
802 */
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -0700803#define USB_DEVICE(vend, prod) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800804 .match_flags = USB_DEVICE_ID_MATCH_DEVICE, \
805 .idVendor = (vend), \
806 .idProduct = (prod)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807/**
Randy Dunlapd0bcabc2008-02-29 22:03:07 -0800808 * USB_DEVICE_VER - describe a specific usb device with a version range
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 * @vend: the 16 bit USB Vendor ID
810 * @prod: the 16 bit USB Product ID
811 * @lo: the bcdDevice_lo value
812 * @hi: the bcdDevice_hi value
813 *
814 * This macro is used to create a struct usb_device_id that matches a
815 * specific device, with a version range.
816 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800817#define USB_DEVICE_VER(vend, prod, lo, hi) \
Alan Sternb724ae72005-10-24 15:36:00 -0400818 .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800819 .idVendor = (vend), \
820 .idProduct = (prod), \
821 .bcdDevice_lo = (lo), \
822 .bcdDevice_hi = (hi)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823
824/**
Bjørn Mork17b72fe2012-10-31 06:08:39 +0100825 * USB_DEVICE_INTERFACE_CLASS - describe a usb device with a specific interface class
826 * @vend: the 16 bit USB Vendor ID
827 * @prod: the 16 bit USB Product ID
828 * @cl: bInterfaceClass value
829 *
830 * This macro is used to create a struct usb_device_id that matches a
831 * specific interface class of devices.
832 */
833#define USB_DEVICE_INTERFACE_CLASS(vend, prod, cl) \
834 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
835 USB_DEVICE_ID_MATCH_INT_CLASS, \
836 .idVendor = (vend), \
837 .idProduct = (prod), \
838 .bInterfaceClass = (cl)
839
840/**
Randy Dunlapd0bcabc2008-02-29 22:03:07 -0800841 * USB_DEVICE_INTERFACE_PROTOCOL - describe a usb device with a specific interface protocol
Jan Kratochvilf836ac82007-05-09 00:26:15 -0400842 * @vend: the 16 bit USB Vendor ID
843 * @prod: the 16 bit USB Product ID
844 * @pr: bInterfaceProtocol value
845 *
846 * This macro is used to create a struct usb_device_id that matches a
847 * specific interface protocol of devices.
848 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800849#define USB_DEVICE_INTERFACE_PROTOCOL(vend, prod, pr) \
850 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
851 USB_DEVICE_ID_MATCH_INT_PROTOCOL, \
Jan Kratochvilf836ac82007-05-09 00:26:15 -0400852 .idVendor = (vend), \
853 .idProduct = (prod), \
854 .bInterfaceProtocol = (pr)
855
856/**
Bjørn Mork81df2d52012-05-18 21:27:43 +0200857 * USB_DEVICE_INTERFACE_NUMBER - describe a usb device with a specific interface number
858 * @vend: the 16 bit USB Vendor ID
859 * @prod: the 16 bit USB Product ID
860 * @num: bInterfaceNumber value
861 *
862 * This macro is used to create a struct usb_device_id that matches a
863 * specific interface number of devices.
864 */
865#define USB_DEVICE_INTERFACE_NUMBER(vend, prod, num) \
866 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
867 USB_DEVICE_ID_MATCH_INT_NUMBER, \
868 .idVendor = (vend), \
869 .idProduct = (prod), \
870 .bInterfaceNumber = (num)
871
872/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 * USB_DEVICE_INFO - macro used to describe a class of usb devices
874 * @cl: bDeviceClass value
875 * @sc: bDeviceSubClass value
876 * @pr: bDeviceProtocol value
877 *
878 * This macro is used to create a struct usb_device_id that matches a
879 * specific class of devices.
880 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800881#define USB_DEVICE_INFO(cl, sc, pr) \
882 .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, \
883 .bDeviceClass = (cl), \
884 .bDeviceSubClass = (sc), \
885 .bDeviceProtocol = (pr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886
887/**
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800888 * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 * @cl: bInterfaceClass value
890 * @sc: bInterfaceSubClass value
891 * @pr: bInterfaceProtocol value
892 *
893 * This macro is used to create a struct usb_device_id that matches a
894 * specific class of interfaces.
895 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800896#define USB_INTERFACE_INFO(cl, sc, pr) \
897 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, \
898 .bInterfaceClass = (cl), \
899 .bInterfaceSubClass = (sc), \
900 .bInterfaceProtocol = (pr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901
Daniel Drake8538f962007-05-10 00:32:24 +0100902/**
Randy Dunlapd0bcabc2008-02-29 22:03:07 -0800903 * USB_DEVICE_AND_INTERFACE_INFO - describe a specific usb device with a class of usb interfaces
Daniel Drake8538f962007-05-10 00:32:24 +0100904 * @vend: the 16 bit USB Vendor ID
905 * @prod: the 16 bit USB Product ID
906 * @cl: bInterfaceClass value
907 * @sc: bInterfaceSubClass value
908 * @pr: bInterfaceProtocol value
909 *
910 * This macro is used to create a struct usb_device_id that matches a
911 * specific device with a specific class of interfaces.
912 *
913 * This is especially useful when explicitly matching devices that have
914 * vendor specific bDeviceClass values, but standards-compliant interfaces.
915 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800916#define USB_DEVICE_AND_INTERFACE_INFO(vend, prod, cl, sc, pr) \
Daniel Drake8538f962007-05-10 00:32:24 +0100917 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO \
918 | USB_DEVICE_ID_MATCH_DEVICE, \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800919 .idVendor = (vend), \
920 .idProduct = (prod), \
Daniel Drake8538f962007-05-10 00:32:24 +0100921 .bInterfaceClass = (cl), \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800922 .bInterfaceSubClass = (sc), \
923 .bInterfaceProtocol = (pr)
Daniel Drake8538f962007-05-10 00:32:24 +0100924
Gustavo Padovand81a5d12012-07-10 19:10:06 -0300925/**
926 * USB_VENDOR_AND_INTERFACE_INFO - describe a specific usb vendor with a class of usb interfaces
927 * @vend: the 16 bit USB Vendor ID
928 * @cl: bInterfaceClass value
929 * @sc: bInterfaceSubClass value
930 * @pr: bInterfaceProtocol value
931 *
932 * This macro is used to create a struct usb_device_id that matches a
933 * specific vendor with a specific class of interfaces.
934 *
935 * This is especially useful when explicitly matching devices that have
936 * vendor specific bDeviceClass values, but standards-compliant interfaces.
937 */
938#define USB_VENDOR_AND_INTERFACE_INFO(vend, cl, sc, pr) \
939 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO \
940 | USB_DEVICE_ID_MATCH_VENDOR, \
941 .idVendor = (vend), \
942 .bInterfaceClass = (cl), \
943 .bInterfaceSubClass = (sc), \
944 .bInterfaceProtocol = (pr)
945
Alan Sternb724ae72005-10-24 15:36:00 -0400946/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +0100948/* Stuff for dynamic usb ids */
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800949struct usb_dynids {
950 spinlock_t lock;
951 struct list_head list;
952};
953
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +0100954struct usb_dynid {
955 struct list_head node;
956 struct usb_device_id id;
957};
958
959extern ssize_t usb_store_new_id(struct usb_dynids *dynids,
960 struct device_driver *driver,
961 const char *buf, size_t count);
962
Bjørn Morkef206f32012-05-13 12:35:00 +0200963extern ssize_t usb_show_dynids(struct usb_dynids *dynids, char *buf);
964
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965/**
Alan Stern8bb54ab2006-07-01 22:08:49 -0400966 * struct usbdrv_wrap - wrapper for driver-model structure
967 * @driver: The driver-model core driver structure.
968 * @for_devices: Non-zero for device drivers, 0 for interface drivers.
969 */
970struct usbdrv_wrap {
971 struct device_driver driver;
972 int for_devices;
973};
974
975/**
976 * struct usb_driver - identifies USB interface driver to usbcore
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 * @name: The driver name should be unique among USB drivers,
978 * and should normally be the same as the module name.
979 * @probe: Called to see if the driver is willing to manage a particular
980 * interface on a device. If it is, probe returns zero and uses
Oliver Neukum7ef4f062008-04-10 15:15:37 +0200981 * usb_set_intfdata() to associate driver-specific data with the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982 * interface. It may also use usb_set_interface() to specify the
983 * appropriate altsetting. If unwilling to manage the interface,
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300984 * return -ENODEV, if genuine IO errors occurred, an appropriate
Oliver Neukum7ef4f062008-04-10 15:15:37 +0200985 * negative errno value.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 * @disconnect: Called when the interface is no longer accessible, usually
987 * because its device has been (or is being) disconnected or the
988 * driver module is being unloaded.
Randy Dunlapa91be2a2010-10-25 15:04:13 -0700989 * @unlocked_ioctl: Used for drivers that want to talk to userspace through
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990 * the "usbfs" filesystem. This lets devices provide ways to
991 * expose information to user space regardless of where they
992 * do (or don't) show up otherwise in the filesystem.
Ming Lei303f0842013-03-15 12:08:53 +0800993 * @suspend: Called when the device is going to be suspended by the
994 * system either from system sleep or runtime suspend context. The
995 * return value will be ignored in system sleep context, so do NOT
996 * try to continue using the device if suspend fails in this case.
997 * Instead, let the resume or reset-resume routine recover from
998 * the failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999 * @resume: Called when the device is being resumed by the system.
Alan Sternf07600c2007-05-30 15:38:16 -04001000 * @reset_resume: Called when the suspended device has been reset instead
1001 * of being resumed.
Alan Stern6498d9d2011-04-28 10:45:24 -04001002 * @pre_reset: Called by usb_reset_device() when the device is about to be
1003 * reset. This routine must not return until the driver has no active
1004 * URBs for the device, and no more URBs may be submitted until the
1005 * post_reset method is called.
Ming Lei742120c2008-06-18 22:00:29 +08001006 * @post_reset: Called by usb_reset_device() after the device
Oliver Neukum7ef4f062008-04-10 15:15:37 +02001007 * has been reset
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008 * @id_table: USB drivers use ID table to support hotplugging.
1009 * Export this with MODULE_DEVICE_TABLE(usb,...). This must be set
1010 * or your driver's probe function will never get called.
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -08001011 * @dynids: used internally to hold the list of dynamically added device
1012 * ids for this driver.
Alan Stern8bb54ab2006-07-01 22:08:49 -04001013 * @drvwrap: Driver-model core structure wrapper.
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -08001014 * @no_dynamic_id: if set to 1, the USB core will not allow dynamic ids to be
1015 * added to this driver by preventing the sysfs file from being created.
Alan Stern645daaa2006-08-30 15:47:02 -04001016 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
1017 * for interfaces bound to this driver.
Alan Stern9da82bd2008-05-08 11:54:37 -04001018 * @soft_unbind: if set to 1, the USB core will not kill URBs and disable
1019 * endpoints before calling the driver's disconnect method.
Sarah Sharp8afa4082012-04-23 10:08:51 -07001020 * @disable_hub_initiated_lpm: if set to 0, the USB core will not allow hubs
1021 * to initiate lower power link state transitions when an idle timeout
1022 * occurs. Device-initiated USB 3.0 link PM will still be allowed.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023 *
Alan Stern8bb54ab2006-07-01 22:08:49 -04001024 * USB interface drivers must provide a name, probe() and disconnect()
1025 * methods, and an id_table. Other driver fields are optional.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026 *
1027 * The id_table is used in hotplugging. It holds a set of descriptors,
1028 * and specialized data may be associated with each entry. That table
1029 * is used by both user and kernel mode hotplugging support.
1030 *
1031 * The probe() and disconnect() methods are called in a context where
1032 * they can sleep, but they should avoid abusing the privilege. Most
1033 * work to connect to a device should be done when the device is opened,
1034 * and undone at the last close. The disconnect code needs to address
1035 * concurrency issues with respect to open() and close() methods, as
1036 * well as forcing all pending I/O requests to complete (by unlinking
1037 * them as necessary, and blocking until the unlinks complete).
1038 */
1039struct usb_driver {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040 const char *name;
1041
1042 int (*probe) (struct usb_interface *intf,
1043 const struct usb_device_id *id);
1044
1045 void (*disconnect) (struct usb_interface *intf);
1046
Andi Kleenc532b292010-06-01 23:04:41 +02001047 int (*unlocked_ioctl) (struct usb_interface *intf, unsigned int code,
Alan Sternb724ae72005-10-24 15:36:00 -04001048 void *buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049
David Brownell27d72e82005-04-18 17:39:22 -07001050 int (*suspend) (struct usb_interface *intf, pm_message_t message);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051 int (*resume) (struct usb_interface *intf);
Alan Sternf07600c2007-05-30 15:38:16 -04001052 int (*reset_resume)(struct usb_interface *intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053
Alan Sternf07600c2007-05-30 15:38:16 -04001054 int (*pre_reset)(struct usb_interface *intf);
1055 int (*post_reset)(struct usb_interface *intf);
Alan Stern79efa092006-06-01 13:33:42 -04001056
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057 const struct usb_device_id *id_table;
1058
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -08001059 struct usb_dynids dynids;
Alan Stern8bb54ab2006-07-01 22:08:49 -04001060 struct usbdrv_wrap drvwrap;
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -08001061 unsigned int no_dynamic_id:1;
Alan Stern645daaa2006-08-30 15:47:02 -04001062 unsigned int supports_autosuspend:1;
Sarah Sharp8afa4082012-04-23 10:08:51 -07001063 unsigned int disable_hub_initiated_lpm:1;
Alan Stern9da82bd2008-05-08 11:54:37 -04001064 unsigned int soft_unbind:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065};
Alan Stern8bb54ab2006-07-01 22:08:49 -04001066#define to_usb_driver(d) container_of(d, struct usb_driver, drvwrap.driver)
1067
1068/**
1069 * struct usb_device_driver - identifies USB device driver to usbcore
1070 * @name: The driver name should be unique among USB drivers,
1071 * and should normally be the same as the module name.
1072 * @probe: Called to see if the driver is willing to manage a particular
1073 * device. If it is, probe returns zero and uses dev_set_drvdata()
1074 * to associate driver-specific data with the device. If unwilling
1075 * to manage the device, return a negative errno value.
1076 * @disconnect: Called when the device is no longer accessible, usually
1077 * because it has been (or is being) disconnected or the driver's
1078 * module is being unloaded.
1079 * @suspend: Called when the device is going to be suspended by the system.
1080 * @resume: Called when the device is being resumed by the system.
1081 * @drvwrap: Driver-model core structure wrapper.
Alan Stern645daaa2006-08-30 15:47:02 -04001082 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
1083 * for devices bound to this driver.
Alan Stern8bb54ab2006-07-01 22:08:49 -04001084 *
1085 * USB drivers must provide all the fields listed above except drvwrap.
1086 */
1087struct usb_device_driver {
1088 const char *name;
1089
1090 int (*probe) (struct usb_device *udev);
1091 void (*disconnect) (struct usb_device *udev);
1092
1093 int (*suspend) (struct usb_device *udev, pm_message_t message);
Alan Stern65bfd292008-11-25 16:39:18 -05001094 int (*resume) (struct usb_device *udev, pm_message_t message);
Alan Stern8bb54ab2006-07-01 22:08:49 -04001095 struct usbdrv_wrap drvwrap;
Alan Stern645daaa2006-08-30 15:47:02 -04001096 unsigned int supports_autosuspend:1;
Alan Stern8bb54ab2006-07-01 22:08:49 -04001097};
1098#define to_usb_device_driver(d) container_of(d, struct usb_device_driver, \
1099 drvwrap.driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100
1101extern struct bus_type usb_bus_type;
1102
1103/**
1104 * struct usb_class_driver - identifies a USB driver that wants to use the USB major number
Greg Kroah-Hartmand6e5bcf2005-06-20 21:15:16 -07001105 * @name: the usb class device name for this driver. Will show up in sysfs.
Kay Sieverse454cea2009-09-18 23:01:12 +02001106 * @devnode: Callback to provide a naming hint for a possible
Randy Dunlape376bbb2009-06-18 10:39:11 -07001107 * device node to create.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108 * @fops: pointer to the struct file_operations of this driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109 * @minor_base: the start of the minor range for this driver.
1110 *
1111 * This structure is used for the usb_register_dev() and
1112 * usb_unregister_dev() functions, to consolidate a number of the
1113 * parameters used for them.
1114 */
1115struct usb_class_driver {
1116 char *name;
Al Viro2c9ede52011-07-23 20:24:48 -04001117 char *(*devnode)(struct device *dev, umode_t *mode);
Arjan van de Ven99ac48f2006-03-28 01:56:41 -08001118 const struct file_operations *fops;
Greg Kroah-Hartmand6e5bcf2005-06-20 21:15:16 -07001119 int minor_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120};
1121
1122/*
1123 * use these in module_init()/module_exit()
1124 * and don't forget MODULE_DEVICE_TABLE(usb, ...)
1125 */
Greg Kroah-Hartman80f745f2007-01-15 11:50:02 -08001126extern int usb_register_driver(struct usb_driver *, struct module *,
1127 const char *);
Paul Gortmakereb5589a2011-05-27 09:02:11 -04001128
1129/* use a define to avoid include chaining to get THIS_MODULE & friends */
1130#define usb_register(driver) \
1131 usb_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
1132
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133extern void usb_deregister(struct usb_driver *);
1134
Greg Kroah-Hartmanf3a6a4b2011-11-17 14:38:33 -08001135/**
1136 * module_usb_driver() - Helper macro for registering a USB driver
1137 * @__usb_driver: usb_driver struct
1138 *
1139 * Helper macro for USB drivers which do not do anything special in module
1140 * init/exit. This eliminates a lot of boilerplate. Each module may only
1141 * use this macro once, and calling it replaces module_init() and module_exit()
1142 */
1143#define module_usb_driver(__usb_driver) \
1144 module_driver(__usb_driver, usb_register, \
1145 usb_deregister)
1146
Alan Stern8bb54ab2006-07-01 22:08:49 -04001147extern int usb_register_device_driver(struct usb_device_driver *,
1148 struct module *);
1149extern void usb_deregister_device_driver(struct usb_device_driver *);
1150
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151extern int usb_register_dev(struct usb_interface *intf,
1152 struct usb_class_driver *class_driver);
1153extern void usb_deregister_dev(struct usb_interface *intf,
1154 struct usb_class_driver *class_driver);
1155
1156extern int usb_disabled(void);
1157
Alan Sternb724ae72005-10-24 15:36:00 -04001158/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159
1160/*
1161 * URB support, for asynchronous request completions
1162 */
1163
1164/*
1165 * urb->transfer_flags:
Alan Sternfea34092007-07-30 17:06:16 -04001166 *
1167 * Note: URB_DIR_IN/OUT is automatically set in usb_submit_urb().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168 */
1169#define URB_SHORT_NOT_OK 0x0001 /* report short reads as errors */
Alan Sterna03bede2012-10-01 10:31:53 -04001170#define URB_ISO_ASAP 0x0002 /* iso-only; use the first unexpired
1171 * slot in the schedule */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172#define URB_NO_TRANSFER_DMA_MAP 0x0004 /* urb->transfer_dma valid on submit */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173#define URB_NO_FSBR 0x0020 /* UHCI-specific */
Alan Sternb724ae72005-10-24 15:36:00 -04001174#define URB_ZERO_PACKET 0x0040 /* Finish bulk OUT with short packet */
1175#define URB_NO_INTERRUPT 0x0080 /* HINT: no non-error interrupt
1176 * needed */
Marcel Holtmann8b3b01c2007-06-13 08:02:11 +02001177#define URB_FREE_BUFFER 0x0100 /* Free transfer buffer with the URB */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178
Alan Sternff9c8952010-04-02 13:27:28 -04001179/* The following flags are used internally by usbcore and HCDs */
Alan Sternfea34092007-07-30 17:06:16 -04001180#define URB_DIR_IN 0x0200 /* Transfer from device to host */
1181#define URB_DIR_OUT 0
1182#define URB_DIR_MASK URB_DIR_IN
1183
Alan Sternff9c8952010-04-02 13:27:28 -04001184#define URB_DMA_MAP_SINGLE 0x00010000 /* Non-scatter-gather mapping */
1185#define URB_DMA_MAP_PAGE 0x00020000 /* HCD-unsupported S-G */
1186#define URB_DMA_MAP_SG 0x00040000 /* HCD-supported S-G */
1187#define URB_MAP_LOCAL 0x00080000 /* HCD-local-memory mapping */
1188#define URB_SETUP_MAP_SINGLE 0x00100000 /* Setup packet DMA mapped */
1189#define URB_SETUP_MAP_LOCAL 0x00200000 /* HCD-local setup packet */
1190#define URB_DMA_SG_COMBINED 0x00400000 /* S-G entries were combined */
Robert Morell2694a482011-01-26 19:06:48 -08001191#define URB_ALIGNED_TEMP_BUFFER 0x00800000 /* Temp buffer was alloc'd */
Alan Sternff9c8952010-04-02 13:27:28 -04001192
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193struct usb_iso_packet_descriptor {
1194 unsigned int offset;
1195 unsigned int length; /* expected length */
1196 unsigned int actual_length;
Pete Zaitcevd1bbb602007-02-11 13:56:13 -08001197 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198};
1199
1200struct urb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201
Oliver Neukum51a2f072007-05-25 13:40:56 +02001202struct usb_anchor {
1203 struct list_head urb_list;
1204 wait_queue_head_t wait;
1205 spinlock_t lock;
Oliver Neukum6a2839b2008-07-29 16:18:47 +02001206 unsigned int poisoned:1;
Oliver Neukum51a2f072007-05-25 13:40:56 +02001207};
1208
1209static inline void init_usb_anchor(struct usb_anchor *anchor)
1210{
1211 INIT_LIST_HEAD(&anchor->urb_list);
1212 init_waitqueue_head(&anchor->wait);
1213 spin_lock_init(&anchor->lock);
1214}
1215
David Howells7d12e782006-10-05 14:55:46 +01001216typedef void (*usb_complete_t)(struct urb *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217
1218/**
1219 * struct urb - USB Request Block
1220 * @urb_list: For use by current owner of the URB.
Oliver Neukum51a2f072007-05-25 13:40:56 +02001221 * @anchor_list: membership in the list of an anchor
1222 * @anchor: to anchor URBs to a common mooring
Alan Stern5b653c72007-07-30 17:04:37 -04001223 * @ep: Points to the endpoint's data structure. Will eventually
1224 * replace @pipe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225 * @pipe: Holds endpoint number, direction, type, and more.
1226 * Create these values with the eight macros available;
1227 * usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl"
1228 * (control), "bulk", "int" (interrupt), or "iso" (isochronous).
1229 * For example usb_sndbulkpipe() or usb_rcvintpipe(). Endpoint
1230 * numbers range from zero to fifteen. Note that "in" endpoint two
1231 * is a different endpoint (and pipe) from "out" endpoint two.
1232 * The current configuration controls the existence, type, and
1233 * maximum packet size of any given endpoint.
Randy Dunlapc6ba1c22010-07-29 15:54:38 -07001234 * @stream_id: the endpoint's stream ID for bulk streams
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235 * @dev: Identifies the USB device to perform the request.
1236 * @status: This is read in non-iso completion functions to get the
1237 * status of the particular request. ISO requests only use it
1238 * to tell whether the URB was unlinked; detailed status for
1239 * each frame is in the fields of the iso_frame-desc.
1240 * @transfer_flags: A variety of flags may be used to affect how URB
1241 * submission, unlinking, or operation are handled. Different
1242 * kinds of URB can use different flags.
Pete Zaitcev4e9e9202009-06-11 08:53:20 -06001243 * @transfer_buffer: This identifies the buffer to (or from) which the I/O
1244 * request will be performed unless URB_NO_TRANSFER_DMA_MAP is set
1245 * (however, do not leave garbage in transfer_buffer even then).
1246 * This buffer must be suitable for DMA; allocate it with
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247 * kmalloc() or equivalent. For transfers to "in" endpoints, contents
1248 * of this buffer will be modified. This buffer is used for the data
1249 * stage of control transfers.
1250 * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP,
1251 * the device driver is saying that it provided this DMA address,
1252 * which the host controller driver should use in preference to the
1253 * transfer_buffer.
Ming Lei10e232c2013-06-28 09:38:12 +08001254 * @sg: scatter gather buffer list, the buffer size of each element in
1255 * the list (except the last) must be divisible by the endpoint's
1256 * max packet size
Randy Dunlap4d922612012-01-21 11:02:56 -08001257 * @num_mapped_sgs: (internal) number of mapped sg entries
Randy Dunlape376bbb2009-06-18 10:39:11 -07001258 * @num_sgs: number of entries in the sg list
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259 * @transfer_buffer_length: How big is transfer_buffer. The transfer may
1260 * be broken up into chunks according to the current maximum packet
1261 * size for the endpoint, which is a function of the configuration
1262 * and is encoded in the pipe. When the length is zero, neither
1263 * transfer_buffer nor transfer_dma is used.
1264 * @actual_length: This is read in non-iso completion functions, and
1265 * it tells how many bytes (out of transfer_buffer_length) were
1266 * transferred. It will normally be the same as requested, unless
1267 * either an error was reported or a short read was performed.
1268 * The URB_SHORT_NOT_OK transfer flag may be used to make such
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001269 * short reads be reported as errors.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270 * @setup_packet: Only used for control transfers, this points to eight bytes
1271 * of setup data. Control transfers always start by sending this data
1272 * to the device. Then transfer_buffer is read or written, if needed.
Alan Stern85bcb5e2010-04-30 16:35:37 -04001273 * @setup_dma: DMA pointer for the setup packet. The caller must not use
1274 * this field; setup_packet must point to a valid buffer.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275 * @start_frame: Returns the initial frame for isochronous transfers.
1276 * @number_of_packets: Lists the number of ISO transfer buffers.
1277 * @interval: Specifies the polling interval for interrupt or isochronous
Anand Gadiyar411c9402009-07-07 15:24:23 +05301278 * transfers. The units are frames (milliseconds) for full and low
Matthew Wilcoxf09a15e2010-03-16 12:55:44 -07001279 * speed devices, and microframes (1/8 millisecond) for highspeed
1280 * and SuperSpeed devices.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281 * @error_count: Returns the number of ISO transfers that reported errors.
1282 * @context: For use in completion functions. This normally points to
1283 * request-specific driver context.
1284 * @complete: Completion handler. This URB is passed as the parameter to the
1285 * completion function. The completion function may then do what
1286 * it likes with the URB, including resubmitting or freeing it.
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001287 * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288 * collect the transfer status for each buffer.
1289 *
1290 * This structure identifies USB transfer requests. URBs must be allocated by
1291 * calling usb_alloc_urb() and freed with a call to usb_free_urb().
1292 * Initialization may be done using various usb_fill_*_urb() functions. URBs
1293 * are submitted using usb_submit_urb(), and pending requests may be canceled
1294 * using usb_unlink_urb() or usb_kill_urb().
1295 *
1296 * Data Transfer Buffers:
1297 *
1298 * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise
1299 * taken from the general page pool. That is provided by transfer_buffer
1300 * (control requests also use setup_packet), and host controller drivers
1301 * perform a dma mapping (and unmapping) for each buffer transferred. Those
1302 * mapping operations can be expensive on some platforms (perhaps using a dma
1303 * bounce buffer or talking to an IOMMU),
1304 * although they're cheap on commodity x86 and ppc hardware.
1305 *
Alan Stern85bcb5e2010-04-30 16:35:37 -04001306 * Alternatively, drivers may pass the URB_NO_TRANSFER_DMA_MAP transfer flag,
1307 * which tells the host controller driver that no such mapping is needed for
1308 * the transfer_buffer since
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309 * the device driver is DMA-aware. For example, a device driver might
Daniel Mack073900a2010-04-12 13:17:25 +02001310 * allocate a DMA buffer with usb_alloc_coherent() or call usb_buffer_map().
Alan Stern85bcb5e2010-04-30 16:35:37 -04001311 * When this transfer flag is provided, host controller drivers will
1312 * attempt to use the dma address found in the transfer_dma
1313 * field rather than determining a dma address themselves.
Pete Zaitcev4e9e9202009-06-11 08:53:20 -06001314 *
1315 * Note that transfer_buffer must still be set if the controller
1316 * does not support DMA (as indicated by bus.uses_dma) and when talking
1317 * to root hub. If you have to trasfer between highmem zone and the device
1318 * on such controller, create a bounce buffer or bail out with an error.
1319 * If transfer_buffer cannot be set (is in highmem) and the controller is DMA
1320 * capable, assign NULL to it, so that usbmon knows not to use the value.
1321 * The setup_packet must always be set, so it cannot be located in highmem.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322 *
1323 * Initialization:
1324 *
1325 * All URBs submitted must initialize the dev, pipe, transfer_flags (may be
Alan Sternb375a042005-07-29 16:11:07 -04001326 * zero), and complete fields. All URBs must also initialize
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327 * transfer_buffer and transfer_buffer_length. They may provide the
1328 * URB_SHORT_NOT_OK transfer flag, indicating that short reads are
1329 * to be treated as errors; that flag is invalid for write requests.
1330 *
1331 * Bulk URBs may
1332 * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers
1333 * should always terminate with a short packet, even if it means adding an
1334 * extra zero length packet.
1335 *
Alan Stern85bcb5e2010-04-30 16:35:37 -04001336 * Control URBs must provide a valid pointer in the setup_packet field.
1337 * Unlike the transfer_buffer, the setup_packet may not be mapped for DMA
1338 * beforehand.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339 *
1340 * Interrupt URBs must provide an interval, saying how often (in milliseconds
1341 * or, for highspeed devices, 125 microsecond units)
1342 * to poll for transfers. After the URB has been submitted, the interval
1343 * field reflects how the transfer was actually scheduled.
1344 * The polling interval may be more frequent than requested.
1345 * For example, some controllers have a maximum interval of 32 milliseconds,
1346 * while others support intervals of up to 1024 milliseconds.
1347 * Isochronous URBs also have transfer intervals. (Note that for isochronous
1348 * endpoints, as well as high speed interrupt endpoints, the encoding of
1349 * the transfer interval in the endpoint descriptor is logarithmic.
1350 * Device drivers must convert that value to linear units themselves.)
1351 *
Alan Sterna03bede2012-10-01 10:31:53 -04001352 * If an isochronous endpoint queue isn't already running, the host
1353 * controller will schedule a new URB to start as soon as bandwidth
1354 * utilization allows. If the queue is running then a new URB will be
1355 * scheduled to start in the first transfer slot following the end of the
1356 * preceding URB, if that slot has not already expired. If the slot has
1357 * expired (which can happen when IRQ delivery is delayed for a long time),
1358 * the scheduling behavior depends on the URB_ISO_ASAP flag. If the flag
1359 * is clear then the URB will be scheduled to start in the expired slot,
1360 * implying that some of its packets will not be transferred; if the flag
1361 * is set then the URB will be scheduled in the first unexpired slot,
1362 * breaking the queue's synchronization. Upon URB completion, the
1363 * start_frame field will be set to the (micro)frame number in which the
1364 * transfer was scheduled. Ranges for frame counter values are HC-specific
1365 * and can go from as low as 256 to as high as 65536 frames.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366 *
1367 * Isochronous URBs have a different data transfer model, in part because
1368 * the quality of service is only "best effort". Callers provide specially
1369 * allocated URBs, with number_of_packets worth of iso_frame_desc structures
1370 * at the end. Each such packet is an individual ISO transfer. Isochronous
1371 * URBs are normally queued, submitted by drivers to arrange that
1372 * transfers are at least double buffered, and then explicitly resubmitted
1373 * in completion handlers, so
1374 * that data (such as audio or video) streams at as constant a rate as the
1375 * host controller scheduler can support.
1376 *
1377 * Completion Callbacks:
1378 *
1379 * The completion callback is made in_interrupt(), and one of the first
1380 * things that a completion handler should do is check the status field.
1381 * The status field is provided for all URBs. It is used to report
1382 * unlinked URBs, and status for all non-ISO transfers. It should not
1383 * be examined before the URB is returned to the completion handler.
1384 *
1385 * The context field is normally used to link URBs back to the relevant
1386 * driver or request state.
1387 *
1388 * When the completion callback is invoked for non-isochronous URBs, the
1389 * actual_length field tells how many bytes were transferred. This field
1390 * is updated even when the URB terminated with an error or was unlinked.
1391 *
1392 * ISO transfer status is reported in the status and actual_length fields
1393 * of the iso_frame_desc array, and the number of errors is reported in
1394 * error_count. Completion callbacks for ISO transfers will normally
1395 * (re)submit URBs to ensure a constant transfer rate.
Roman Kagan719df462005-05-06 00:55:56 +04001396 *
1397 * Note that even fields marked "public" should not be touched by the driver
1398 * when the urb is owned by the hcd, that is, since the call to
1399 * usb_submit_urb() till the entry into the completion routine.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001401struct urb {
Martin Waitzaeec46b2005-11-13 16:08:13 -08001402 /* private: usb core and host controller only fields in the urb */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 struct kref kref; /* reference count of the URB */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404 void *hcpriv; /* private data for host controller */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405 atomic_t use_count; /* concurrent submissions counter */
Ming Lei49367d82008-12-12 21:38:45 +08001406 atomic_t reject; /* submissions will fail */
Alan Sterneb231052007-08-21 15:40:36 -04001407 int unlinked; /* unlink error code */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408
Martin Waitzaeec46b2005-11-13 16:08:13 -08001409 /* public: documented fields in the urb that can be used by drivers */
Alan Sternb724ae72005-10-24 15:36:00 -04001410 struct list_head urb_list; /* list head for use by the urb's
1411 * current owner */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001412 struct list_head anchor_list; /* the URB may be anchored */
Oliver Neukum51a2f072007-05-25 13:40:56 +02001413 struct usb_anchor *anchor;
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -07001414 struct usb_device *dev; /* (in) pointer to associated device */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001415 struct usb_host_endpoint *ep; /* (internal) pointer to endpoint */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416 unsigned int pipe; /* (in) pipe information */
Sarah Sharp94af1222010-04-02 15:34:10 -07001417 unsigned int stream_id; /* (in) stream ID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418 int status; /* (return) non-ISO status */
1419 unsigned int transfer_flags; /* (in) URB_SHORT_NOT_OK | ...*/
1420 void *transfer_buffer; /* (in) associated data buffer */
1421 dma_addr_t transfer_dma; /* (in) dma addr for transfer_buffer */
Matthew Wilcox910f8d02010-05-01 12:20:01 -06001422 struct scatterlist *sg; /* (in) scatter gather buffer list */
Clemens Ladischbc677d5b2011-12-03 23:41:31 +01001423 int num_mapped_sgs; /* (internal) mapped sg entries */
Sarah Sharpe04748e2009-04-27 19:59:01 -07001424 int num_sgs; /* (in) number of entries in the sg list */
Greg Kroah-Hartman16e2e5f2009-03-03 16:44:13 -08001425 u32 transfer_buffer_length; /* (in) data buffer length */
Greg Kroah-Hartman8c209e62009-03-06 21:31:03 -08001426 u32 actual_length; /* (return) actual transfer length */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427 unsigned char *setup_packet; /* (in) setup packet (control only) */
1428 dma_addr_t setup_dma; /* (in) dma addr for setup_packet */
1429 int start_frame; /* (modify) start frame (ISO) */
1430 int number_of_packets; /* (in) number of ISO packets */
Alan Sternb724ae72005-10-24 15:36:00 -04001431 int interval; /* (modify) transfer interval
1432 * (INT/ISO) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433 int error_count; /* (return) number of ISO errors */
1434 void *context; /* (in) context for completion */
1435 usb_complete_t complete; /* (in) completion routine */
Alan Sternb724ae72005-10-24 15:36:00 -04001436 struct usb_iso_packet_descriptor iso_frame_desc[0];
1437 /* (in) ISO ONLY */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438};
1439
Alan Sternb724ae72005-10-24 15:36:00 -04001440/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441
1442/**
1443 * usb_fill_control_urb - initializes a control urb
1444 * @urb: pointer to the urb to initialize.
1445 * @dev: pointer to the struct usb_device for this urb.
1446 * @pipe: the endpoint pipe
1447 * @setup_packet: pointer to the setup_packet buffer
1448 * @transfer_buffer: pointer to the transfer buffer
1449 * @buffer_length: length of the transfer buffer
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001450 * @complete_fn: pointer to the usb_complete_t function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451 * @context: what to set the urb context to.
1452 *
1453 * Initializes a control urb with the proper information needed to submit
1454 * it to a device.
1455 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001456static inline void usb_fill_control_urb(struct urb *urb,
1457 struct usb_device *dev,
1458 unsigned int pipe,
1459 unsigned char *setup_packet,
1460 void *transfer_buffer,
1461 int buffer_length,
1462 usb_complete_t complete_fn,
1463 void *context)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465 urb->dev = dev;
1466 urb->pipe = pipe;
1467 urb->setup_packet = setup_packet;
1468 urb->transfer_buffer = transfer_buffer;
1469 urb->transfer_buffer_length = buffer_length;
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001470 urb->complete = complete_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471 urb->context = context;
1472}
1473
1474/**
1475 * usb_fill_bulk_urb - macro to help initialize a bulk urb
1476 * @urb: pointer to the urb to initialize.
1477 * @dev: pointer to the struct usb_device for this urb.
1478 * @pipe: the endpoint pipe
1479 * @transfer_buffer: pointer to the transfer buffer
1480 * @buffer_length: length of the transfer buffer
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001481 * @complete_fn: pointer to the usb_complete_t function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482 * @context: what to set the urb context to.
1483 *
1484 * Initializes a bulk urb with the proper information needed to submit it
1485 * to a device.
1486 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001487static inline void usb_fill_bulk_urb(struct urb *urb,
1488 struct usb_device *dev,
1489 unsigned int pipe,
1490 void *transfer_buffer,
1491 int buffer_length,
1492 usb_complete_t complete_fn,
1493 void *context)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495 urb->dev = dev;
1496 urb->pipe = pipe;
1497 urb->transfer_buffer = transfer_buffer;
1498 urb->transfer_buffer_length = buffer_length;
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001499 urb->complete = complete_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500 urb->context = context;
1501}
1502
1503/**
1504 * usb_fill_int_urb - macro to help initialize a interrupt urb
1505 * @urb: pointer to the urb to initialize.
1506 * @dev: pointer to the struct usb_device for this urb.
1507 * @pipe: the endpoint pipe
1508 * @transfer_buffer: pointer to the transfer buffer
1509 * @buffer_length: length of the transfer buffer
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001510 * @complete_fn: pointer to the usb_complete_t function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511 * @context: what to set the urb context to.
1512 * @interval: what to set the urb interval to, encoded like
1513 * the endpoint descriptor's bInterval value.
1514 *
1515 * Initializes a interrupt urb with the proper information needed to submit
1516 * it to a device.
Matthew Wilcoxf09a15e2010-03-16 12:55:44 -07001517 *
1518 * Note that High Speed and SuperSpeed interrupt endpoints use a logarithmic
1519 * encoding of the endpoint interval, and express polling intervals in
1520 * microframes (eight per millisecond) rather than in frames (one per
1521 * millisecond).
1522 *
1523 * Wireless USB also uses the logarithmic encoding, but specifies it in units of
1524 * 128us instead of 125us. For Wireless USB devices, the interval is passed
1525 * through to the host controller, rather than being translated into microframe
1526 * units.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001528static inline void usb_fill_int_urb(struct urb *urb,
1529 struct usb_device *dev,
1530 unsigned int pipe,
1531 void *transfer_buffer,
1532 int buffer_length,
1533 usb_complete_t complete_fn,
1534 void *context,
1535 int interval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537 urb->dev = dev;
1538 urb->pipe = pipe;
1539 urb->transfer_buffer = transfer_buffer;
1540 urb->transfer_buffer_length = buffer_length;
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001541 urb->complete = complete_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542 urb->context = context;
Felipe Balbi42189d82013-07-02 10:50:15 +03001543
1544 if (dev->speed == USB_SPEED_HIGH || dev->speed == USB_SPEED_SUPER) {
1545 /* make sure interval is within allowed range */
1546 interval = clamp(interval, 1, 16);
1547
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548 urb->interval = 1 << (interval - 1);
Felipe Balbi42189d82013-07-02 10:50:15 +03001549 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550 urb->interval = interval;
Felipe Balbi42189d82013-07-02 10:50:15 +03001551 }
1552
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553 urb->start_frame = -1;
1554}
1555
1556extern void usb_init_urb(struct urb *urb);
Al Viro55016f12005-10-21 03:21:58 -04001557extern struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558extern void usb_free_urb(struct urb *urb);
1559#define usb_put_urb usb_free_urb
1560extern struct urb *usb_get_urb(struct urb *urb);
Al Viro55016f12005-10-21 03:21:58 -04001561extern int usb_submit_urb(struct urb *urb, gfp_t mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562extern int usb_unlink_urb(struct urb *urb);
1563extern void usb_kill_urb(struct urb *urb);
Oliver Neukum55b447b2008-07-29 15:26:15 +02001564extern void usb_poison_urb(struct urb *urb);
1565extern void usb_unpoison_urb(struct urb *urb);
Oliver Neukum8815bb02012-04-30 09:13:46 +02001566extern void usb_block_urb(struct urb *urb);
Oliver Neukum51a2f072007-05-25 13:40:56 +02001567extern void usb_kill_anchored_urbs(struct usb_anchor *anchor);
Oliver Neukum6a2839b2008-07-29 16:18:47 +02001568extern void usb_poison_anchored_urbs(struct usb_anchor *anchor);
Oliver Neukum856395d2008-12-18 09:17:49 +01001569extern void usb_unpoison_anchored_urbs(struct usb_anchor *anchor);
Oliver Neukumeda76952008-04-10 14:07:37 +02001570extern void usb_unlink_anchored_urbs(struct usb_anchor *anchor);
Oliver Neukum51a2f072007-05-25 13:40:56 +02001571extern void usb_anchor_urb(struct urb *urb, struct usb_anchor *anchor);
1572extern void usb_unanchor_urb(struct urb *urb);
1573extern int usb_wait_anchor_empty_timeout(struct usb_anchor *anchor,
1574 unsigned int timeout);
Oliver Neukum19876252008-08-25 22:40:25 +02001575extern struct urb *usb_get_from_anchor(struct usb_anchor *anchor);
1576extern void usb_scuttle_anchored_urbs(struct usb_anchor *anchor);
1577extern int usb_anchor_empty(struct usb_anchor *anchor);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578
Oliver Neukum8815bb02012-04-30 09:13:46 +02001579#define usb_unblock_urb usb_unpoison_urb
1580
Alan Sternfea34092007-07-30 17:06:16 -04001581/**
1582 * usb_urb_dir_in - check if an URB describes an IN transfer
1583 * @urb: URB to be checked
1584 *
Yacine Belkadi626f0902013-08-02 20:10:04 +02001585 * Return: 1 if @urb describes an IN transfer (device-to-host),
Alan Sternfea34092007-07-30 17:06:16 -04001586 * otherwise 0.
1587 */
1588static inline int usb_urb_dir_in(struct urb *urb)
1589{
Alan Sternd617bc82007-08-02 15:04:52 -04001590 return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_IN;
Alan Sternfea34092007-07-30 17:06:16 -04001591}
1592
1593/**
1594 * usb_urb_dir_out - check if an URB describes an OUT transfer
1595 * @urb: URB to be checked
1596 *
Yacine Belkadi626f0902013-08-02 20:10:04 +02001597 * Return: 1 if @urb describes an OUT transfer (host-to-device),
Alan Sternfea34092007-07-30 17:06:16 -04001598 * otherwise 0.
1599 */
1600static inline int usb_urb_dir_out(struct urb *urb)
1601{
1602 return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_OUT;
1603}
1604
Daniel Mack073900a2010-04-12 13:17:25 +02001605void *usb_alloc_coherent(struct usb_device *dev, size_t size,
Al Viro55016f12005-10-21 03:21:58 -04001606 gfp_t mem_flags, dma_addr_t *dma);
Daniel Mack073900a2010-04-12 13:17:25 +02001607void usb_free_coherent(struct usb_device *dev, size_t size,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608 void *addr, dma_addr_t dma);
1609
1610#if 0
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001611struct urb *usb_buffer_map(struct urb *urb);
1612void usb_buffer_dmasync(struct urb *urb);
1613void usb_buffer_unmap(struct urb *urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614#endif
1615
1616struct scatterlist;
Alan Stern5e60a162007-07-30 17:07:21 -04001617int usb_buffer_map_sg(const struct usb_device *dev, int is_in,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -03001618 struct scatterlist *sg, int nents);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619#if 0
Alan Stern5e60a162007-07-30 17:07:21 -04001620void usb_buffer_dmasync_sg(const struct usb_device *dev, int is_in,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -03001621 struct scatterlist *sg, int n_hw_ents);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622#endif
Alan Stern5e60a162007-07-30 17:07:21 -04001623void usb_buffer_unmap_sg(const struct usb_device *dev, int is_in,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -03001624 struct scatterlist *sg, int n_hw_ents);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625
1626/*-------------------------------------------------------------------*
1627 * SYNCHRONOUS CALL SUPPORT *
1628 *-------------------------------------------------------------------*/
1629
1630extern int usb_control_msg(struct usb_device *dev, unsigned int pipe,
1631 __u8 request, __u8 requesttype, __u16 value, __u16 index,
1632 void *data, __u16 size, int timeout);
Greg Kroah-Hartman782a7a62006-05-19 13:20:20 -07001633extern int usb_interrupt_msg(struct usb_device *usb_dev, unsigned int pipe,
1634 void *data, int len, int *actual_length, int timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635extern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,
1636 void *data, int len, int *actual_length,
1637 int timeout);
1638
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639/* wrappers around usb_control_msg() for the most common standard requests */
1640extern int usb_get_descriptor(struct usb_device *dev, unsigned char desctype,
1641 unsigned char descindex, void *buf, int size);
1642extern int usb_get_status(struct usb_device *dev,
1643 int type, int target, void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644extern int usb_string(struct usb_device *dev, int index,
1645 char *buf, size_t size);
1646
1647/* wrappers that also update important state inside usbcore */
1648extern int usb_clear_halt(struct usb_device *dev, int pipe);
1649extern int usb_reset_configuration(struct usb_device *dev);
1650extern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate);
David Vrabel3444b262009-04-08 17:36:28 +00001651extern void usb_reset_endpoint(struct usb_device *dev, unsigned int epaddr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652
Alan Stern088dc272006-08-21 12:08:19 -04001653/* this request isn't really synchronous, but it belongs with the others */
1654extern int usb_driver_set_configuration(struct usb_device *udev, int config);
1655
Linus Torvalds1da177e2005-04-16 15:20:36 -07001656/*
1657 * timeouts, in milliseconds, used for sending/receiving control messages
1658 * they typically complete within a few frames (msec) after they're issued
1659 * USB identifies 5 second timeouts, maybe more in a few cases, and a few
1660 * slow devices (like some MGE Ellipse UPSes) actually push that limit.
1661 */
1662#define USB_CTRL_GET_TIMEOUT 5000
1663#define USB_CTRL_SET_TIMEOUT 5000
1664
1665
1666/**
1667 * struct usb_sg_request - support for scatter/gather I/O
1668 * @status: zero indicates success, else negative errno
1669 * @bytes: counts bytes transferred.
1670 *
1671 * These requests are initialized using usb_sg_init(), and then are used
1672 * as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most
1673 * members of the request object aren't for driver access.
1674 *
1675 * The status and bytecount values are valid only after usb_sg_wait()
1676 * returns. If the status is zero, then the bytecount matches the total
1677 * from the request.
1678 *
1679 * After an error completion, drivers may need to clear a halt condition
1680 * on the endpoint.
1681 */
1682struct usb_sg_request {
1683 int status;
1684 size_t bytes;
1685
Randy Dunlapbf92c192009-04-29 21:02:49 -07001686 /* private:
1687 * members below are private to usbcore,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688 * and are not provided for driver access!
1689 */
1690 spinlock_t lock;
1691
1692 struct usb_device *dev;
1693 int pipe;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001694
1695 int entries;
1696 struct urb **urbs;
1697
1698 int count;
1699 struct completion complete;
1700};
1701
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001702int usb_sg_init(
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703 struct usb_sg_request *io,
1704 struct usb_device *dev,
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001705 unsigned pipe,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706 unsigned period,
1707 struct scatterlist *sg,
1708 int nents,
1709 size_t length,
Al Viro55016f12005-10-21 03:21:58 -04001710 gfp_t mem_flags
Linus Torvalds1da177e2005-04-16 15:20:36 -07001711);
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001712void usb_sg_cancel(struct usb_sg_request *io);
1713void usb_sg_wait(struct usb_sg_request *io);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714
1715
Alan Sternb724ae72005-10-24 15:36:00 -04001716/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001717
1718/*
1719 * For various legacy reasons, Linux has a small cookie that's paired with
1720 * a struct usb_device to identify an endpoint queue. Queue characteristics
1721 * are defined by the endpoint's descriptor. This cookie is called a "pipe",
1722 * an unsigned int encoded as:
1723 *
1724 * - direction: bit 7 (0 = Host-to-Device [Out],
1725 * 1 = Device-to-Host [In] ...
1726 * like endpoint bEndpointAddress)
1727 * - device address: bits 8-14 ... bit positions known to uhci-hcd
1728 * - endpoint: bits 15-18 ... bit positions known to uhci-hcd
1729 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
1730 * 10 = control, 11 = bulk)
1731 *
1732 * Given the device address and endpoint descriptor, pipes are redundant.
1733 */
1734
1735/* NOTE: these are not the standard USB_ENDPOINT_XFER_* values!! */
1736/* (yet ... they're the values used by usbfs) */
1737#define PIPE_ISOCHRONOUS 0
1738#define PIPE_INTERRUPT 1
1739#define PIPE_CONTROL 2
1740#define PIPE_BULK 3
1741
1742#define usb_pipein(pipe) ((pipe) & USB_DIR_IN)
1743#define usb_pipeout(pipe) (!usb_pipein(pipe))
1744
1745#define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
1746#define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
1747
1748#define usb_pipetype(pipe) (((pipe) >> 30) & 3)
1749#define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
1750#define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
1751#define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
1752#define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
1753
Alan Sternb724ae72005-10-24 15:36:00 -04001754static inline unsigned int __create_pipe(struct usb_device *dev,
1755 unsigned int endpoint)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756{
1757 return (dev->devnum << 8) | (endpoint << 15);
1758}
1759
1760/* Create various pipes... */
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -07001761#define usb_sndctrlpipe(dev, endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001762 ((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint))
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -07001763#define usb_rcvctrlpipe(dev, endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001764 ((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -07001765#define usb_sndisocpipe(dev, endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001766 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint))
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -07001767#define usb_rcvisocpipe(dev, endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001768 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -07001769#define usb_sndbulkpipe(dev, endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001770 ((PIPE_BULK << 30) | __create_pipe(dev, endpoint))
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -07001771#define usb_rcvbulkpipe(dev, endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001772 ((PIPE_BULK << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -07001773#define usb_sndintpipe(dev, endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001774 ((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint))
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -07001775#define usb_rcvintpipe(dev, endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001776 ((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777
Matthew Wilcoxfe54b052010-04-30 13:11:29 -06001778static inline struct usb_host_endpoint *
1779usb_pipe_endpoint(struct usb_device *dev, unsigned int pipe)
1780{
1781 struct usb_host_endpoint **eps;
1782 eps = usb_pipein(pipe) ? dev->ep_in : dev->ep_out;
1783 return eps[usb_pipeendpoint(pipe)];
1784}
1785
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786/*-------------------------------------------------------------------------*/
1787
1788static inline __u16
1789usb_maxpacket(struct usb_device *udev, int pipe, int is_out)
1790{
1791 struct usb_host_endpoint *ep;
1792 unsigned epnum = usb_pipeendpoint(pipe);
1793
1794 if (is_out) {
1795 WARN_ON(usb_pipein(pipe));
1796 ep = udev->ep_out[epnum];
1797 } else {
1798 WARN_ON(usb_pipeout(pipe));
1799 ep = udev->ep_in[epnum];
1800 }
1801 if (!ep)
1802 return 0;
1803
1804 /* NOTE: only 0x07ff bits are for packet size... */
Kuninori Morimoto29cc8892011-08-23 03:12:03 -07001805 return usb_endpoint_maxp(&ep->desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806}
1807
Alan Sternb724ae72005-10-24 15:36:00 -04001808/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809
Johan Hovold2c4d6bf2011-11-10 14:58:26 +01001810/* translate USB error codes to codes user space understands */
1811static inline int usb_translate_errors(int error_code)
1812{
1813 switch (error_code) {
1814 case 0:
1815 case -ENOMEM:
1816 case -ENODEV:
Johan Hovold67c88382012-03-26 21:01:50 +02001817 case -EOPNOTSUPP:
Johan Hovold2c4d6bf2011-11-10 14:58:26 +01001818 return error_code;
1819 default:
1820 return -EIO;
1821 }
1822}
1823
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -07001824/* Events from the usb core */
1825#define USB_DEVICE_ADD 0x0001
1826#define USB_DEVICE_REMOVE 0x0002
1827#define USB_BUS_ADD 0x0003
1828#define USB_BUS_REMOVE 0x0004
1829extern void usb_register_notify(struct notifier_block *nb);
1830extern void usb_unregister_notify(struct notifier_block *nb);
1831
Greg Kroah-Hartman00048b82009-04-24 14:56:26 -07001832/* debugfs stuff */
1833extern struct dentry *usb_debug_root;
1834
Linus Torvalds1da177e2005-04-16 15:20:36 -07001835#endif /* __KERNEL__ */
1836
1837#endif