blob: a22a3e139e96202a777e4e2c430b638814146e90 [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001/* SPDX-License-Identifier: GPL-2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002#ifndef __LINUX_USB_H
3#define __LINUX_USB_H
4
5#include <linux/mod_devicetable.h>
David Brownell5f848132006-12-16 15:34:53 -08006#include <linux/usb/ch9.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07007
8#define USB_MAJOR 180
Kay Sieversfbf82fd2005-07-31 01:05:53 +02009#define USB_DEVICE_MAJOR 189
Linus Torvalds1da177e2005-04-16 15:20:36 -070010
11
12#ifdef __KERNEL__
13
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/errno.h> /* for -ENODEV */
15#include <linux/delay.h> /* for mdelay() */
16#include <linux/interrupt.h> /* for in_interrupt() */
17#include <linux/list.h> /* for struct list_head */
18#include <linux/kref.h> /* for struct kref */
19#include <linux/device.h> /* for struct device */
20#include <linux/fs.h> /* for struct file_operations */
21#include <linux/completion.h> /* for struct completion */
22#include <linux/sched.h> /* for current && schedule_timeout */
Alan Stern645daaa2006-08-30 15:47:02 -040023#include <linux/mutex.h> /* for struct mutex */
Ming Lei6ddf27c2010-11-15 15:57:30 -050024#include <linux/pm_runtime.h> /* for runtime PM */
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
26struct usb_device;
27struct usb_driver;
Inaky Perez-Gonzalezb1d8dfb2008-04-08 13:24:46 -070028struct wusb_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
30/*-------------------------------------------------------------------------*/
31
32/*
33 * Host-side wrappers for standard USB descriptors ... these are parsed
34 * from the data provided by devices. Parsing turns them from a flat
35 * sequence of descriptors into a hierarchy:
36 *
37 * - devices have one (usually) or more configs;
38 * - configs have one (often) or more interfaces;
39 * - interfaces have one (usually) or more settings;
40 * - each interface setting has zero or (usually) more endpoints.
Sarah Sharp663c30d2009-04-27 19:58:14 -070041 * - a SuperSpeed endpoint has a companion descriptor
Linus Torvalds1da177e2005-04-16 15:20:36 -070042 *
43 * And there might be other descriptors mixed in with those.
44 *
45 * Devices may also have class-specific or vendor-specific descriptors.
46 */
47
Greg Kroah-Hartman9bde7492006-06-14 12:14:34 -070048struct ep_device;
49
Linus Torvalds1da177e2005-04-16 15:20:36 -070050/**
51 * struct usb_host_endpoint - host-side endpoint descriptor and queue
52 * @desc: descriptor for this endpoint, wMaxPacketSize in native byteorder
Alan Stern842f1692010-04-30 12:44:46 -040053 * @ss_ep_comp: SuperSpeed companion descriptor for this endpoint
Mathias Nymanb37d83a2016-02-12 16:40:13 +020054 * @ssp_isoc_ep_comp: SuperSpeedPlus isoc companion descriptor for this endpoint
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 * @urb_list: urbs queued to this endpoint; maintained by usbcore
56 * @hcpriv: for use by HCD; typically holds hardware dma queue head (QH)
57 * with one or more transfer descriptors (TDs) per urb
Randy Dunlap7fac9a32006-06-22 15:12:41 -070058 * @ep_dev: ep_device for sysfs info
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 * @extra: descriptors following this endpoint in the configuration
60 * @extralen: how many bytes of "extra" are valid
Alan Sternbdd016b2007-07-30 17:05:22 -040061 * @enabled: URBs may be submitted to this endpoint
Hans de Goede8d4f70b2013-10-09 17:19:25 +020062 * @streams: number of USB-3 streams allocated on the endpoint
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 *
64 * USB requests are always queued to a given endpoint, identified by a
65 * descriptor within an active interface in a given USB configuration.
66 */
67struct usb_host_endpoint {
Alan Stern842f1692010-04-30 12:44:46 -040068 struct usb_endpoint_descriptor desc;
69 struct usb_ss_ep_comp_descriptor ss_ep_comp;
Mathias Nymanb37d83a2016-02-12 16:40:13 +020070 struct usb_ssp_isoc_ep_comp_descriptor ssp_isoc_ep_comp;
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 struct list_head urb_list;
72 void *hcpriv;
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -070073 struct ep_device *ep_dev; /* For sysfs info */
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
75 unsigned char *extra; /* Extra descriptors */
76 int extralen;
Alan Sternbdd016b2007-07-30 17:05:22 -040077 int enabled;
Hans de Goede8d4f70b2013-10-09 17:19:25 +020078 int streams;
Linus Torvalds1da177e2005-04-16 15:20:36 -070079};
80
81/* host-side wrapper for one interface setting's parsed descriptors */
82struct usb_host_interface {
83 struct usb_interface_descriptor desc;
84
Richard Kennedy0d5ff302012-07-10 17:19:25 +010085 int extralen;
86 unsigned char *extra; /* Extra descriptors */
87
Chris Rorvick9636c372015-01-14 21:52:28 -060088 /* array of desc.bNumEndpoints endpoints associated with this
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 * interface setting. these will be in no particular order.
90 */
91 struct usb_host_endpoint *endpoint;
92
93 char *string; /* iInterface string, if present */
Linus Torvalds1da177e2005-04-16 15:20:36 -070094};
95
96enum usb_interface_condition {
97 USB_INTERFACE_UNBOUND = 0,
98 USB_INTERFACE_BINDING,
99 USB_INTERFACE_BOUND,
100 USB_INTERFACE_UNBINDING,
101};
102
Johan Hovold66a35932017-03-17 11:35:30 +0100103int __must_check
104usb_find_common_endpoints(struct usb_host_interface *alt,
105 struct usb_endpoint_descriptor **bulk_in,
106 struct usb_endpoint_descriptor **bulk_out,
107 struct usb_endpoint_descriptor **int_in,
108 struct usb_endpoint_descriptor **int_out);
109
Johan Hovold279daf42017-03-17 11:35:31 +0100110int __must_check
111usb_find_common_endpoints_reverse(struct usb_host_interface *alt,
112 struct usb_endpoint_descriptor **bulk_in,
113 struct usb_endpoint_descriptor **bulk_out,
114 struct usb_endpoint_descriptor **int_in,
115 struct usb_endpoint_descriptor **int_out);
116
Johan Hovold66a35932017-03-17 11:35:30 +0100117static inline int __must_check
118usb_find_bulk_in_endpoint(struct usb_host_interface *alt,
119 struct usb_endpoint_descriptor **bulk_in)
120{
121 return usb_find_common_endpoints(alt, bulk_in, NULL, NULL, NULL);
122}
123
124static inline int __must_check
125usb_find_bulk_out_endpoint(struct usb_host_interface *alt,
126 struct usb_endpoint_descriptor **bulk_out)
127{
128 return usb_find_common_endpoints(alt, NULL, bulk_out, NULL, NULL);
129}
130
131static inline int __must_check
132usb_find_int_in_endpoint(struct usb_host_interface *alt,
133 struct usb_endpoint_descriptor **int_in)
134{
135 return usb_find_common_endpoints(alt, NULL, NULL, int_in, NULL);
136}
137
138static inline int __must_check
139usb_find_int_out_endpoint(struct usb_host_interface *alt,
140 struct usb_endpoint_descriptor **int_out)
141{
142 return usb_find_common_endpoints(alt, NULL, NULL, NULL, int_out);
143}
144
Johan Hovold279daf42017-03-17 11:35:31 +0100145static inline int __must_check
146usb_find_last_bulk_in_endpoint(struct usb_host_interface *alt,
147 struct usb_endpoint_descriptor **bulk_in)
148{
149 return usb_find_common_endpoints_reverse(alt, bulk_in, NULL, NULL, NULL);
150}
151
152static inline int __must_check
153usb_find_last_bulk_out_endpoint(struct usb_host_interface *alt,
154 struct usb_endpoint_descriptor **bulk_out)
155{
156 return usb_find_common_endpoints_reverse(alt, NULL, bulk_out, NULL, NULL);
157}
158
159static inline int __must_check
160usb_find_last_int_in_endpoint(struct usb_host_interface *alt,
161 struct usb_endpoint_descriptor **int_in)
162{
163 return usb_find_common_endpoints_reverse(alt, NULL, NULL, int_in, NULL);
164}
165
166static inline int __must_check
167usb_find_last_int_out_endpoint(struct usb_host_interface *alt,
168 struct usb_endpoint_descriptor **int_out)
169{
170 return usb_find_common_endpoints_reverse(alt, NULL, NULL, NULL, int_out);
171}
172
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173/**
174 * struct usb_interface - what usb device drivers talk to
175 * @altsetting: array of interface structures, one for each alternate
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -0700176 * setting that may be selected. Each one includes a set of
177 * endpoint configurations. They will be in no particular order.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 * @cur_altsetting: the current altsetting.
Lei Mingd6d914f2008-02-25 18:07:28 +0800179 * @num_altsetting: number of altsettings defined.
Randy Dunlap3f423782007-07-19 10:21:37 -0700180 * @intf_assoc: interface association descriptor
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 * @minor: the minor number assigned to this interface, if this
182 * interface is bound to a driver that uses the USB major number.
183 * If this interface does not use the USB major, this field should
184 * be unused. The driver should set this value in the probe()
185 * function of the driver, after it has been assigned a minor
186 * number from the USB core by calling usb_register_dev().
187 * @condition: binding state of the interface: not bound, binding
188 * (in probe()), bound to a driver, or unbinding (in disconnect())
Randy Dunlapf88ed902007-12-03 14:14:16 -0800189 * @sysfs_files_created: sysfs attributes exist
Alan Stern3b23dd62008-12-05 14:10:34 -0500190 * @ep_devs_created: endpoint child pseudo-devices exist
Alan Stern352d0262008-10-29 15:16:58 -0400191 * @unregistering: flag set when the interface is being unregistered
Alan Stern645daaa2006-08-30 15:47:02 -0400192 * @needs_remote_wakeup: flag set when the driver requires remote-wakeup
193 * capability during autosuspend.
Alan Stern55151d72008-08-12 14:33:59 -0400194 * @needs_altsetting0: flag set when a set-interface request for altsetting 0
195 * has been deferred.
Alan Sternf4f4d582008-07-28 10:39:28 -0400196 * @needs_binding: flag set when the driver should be re-probed or unbound
197 * following a reset or suspend operation it doesn't support.
Stefan Koch07294cc2015-09-28 23:59:52 +0200198 * @authorized: This allows to (de)authorize individual interfaces instead
199 * a whole device in contrast to the device authorization.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 * @dev: driver model's view of this device
Greg Kroah-Hartman0873c762006-06-20 13:09:50 -0700201 * @usb_dev: if an interface is bound to the USB major, this will point
202 * to the sysfs representation for that device.
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -0800203 * @reset_ws: Used for scheduling resets from atomic context.
Randy Dunlapc6ba1c22010-07-29 15:54:38 -0700204 * @resetting_device: USB core reset the device, so use alt setting 0 as
205 * current; needs bandwidth alloc after reset.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 *
207 * USB device drivers attach to interfaces on a physical device. Each
208 * interface encapsulates a single high level function, such as feeding
209 * an audio stream to a speaker or reporting a change in a volume control.
210 * Many USB devices only have one interface. The protocol used to talk to
211 * an interface's endpoints can be defined in a usb "class" specification,
212 * or by a product's vendor. The (default) control endpoint is part of
213 * every interface, but is never listed among the interface's descriptors.
214 *
215 * The driver that is bound to the interface can use standard driver model
216 * calls such as dev_get_drvdata() on the dev member of this structure.
217 *
218 * Each interface may have alternate settings. The initial configuration
219 * of a device sets altsetting 0, but the device driver can change
220 * that setting using usb_set_interface(). Alternate settings are often
Michael Opdenacker59c51592007-05-09 08:57:56 +0200221 * used to control the use of periodic endpoints, such as by having
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 * different endpoints use different amounts of reserved USB bandwidth.
223 * All standards-conformant USB devices that use isochronous endpoints
224 * will use them in non-default settings.
225 *
226 * The USB specification says that alternate setting numbers must run from
227 * 0 to one less than the total number of alternate settings. But some
228 * devices manage to mess this up, and the structures aren't necessarily
229 * stored in numerical order anyhow. Use usb_altnum_to_altsetting() to
230 * look up an alternate setting in the altsetting array based on its number.
231 */
232struct usb_interface {
233 /* array of alternate settings for this interface,
234 * stored in no particular order */
235 struct usb_host_interface *altsetting;
236
237 struct usb_host_interface *cur_altsetting; /* the currently
238 * active alternate setting */
239 unsigned num_altsetting; /* number of alternate settings */
240
Craig W. Nadler165fe972007-06-15 23:14:35 -0400241 /* If there is an interface association descriptor then it will list
242 * the associated interfaces */
243 struct usb_interface_assoc_descriptor *intf_assoc;
244
Alan Sternb724ae72005-10-24 15:36:00 -0400245 int minor; /* minor number this interface is
246 * bound to */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 enum usb_interface_condition condition; /* state of binding */
Alan Stern7e615592007-11-06 11:43:42 -0500248 unsigned sysfs_files_created:1; /* the sysfs attributes exist */
Alan Stern3b23dd62008-12-05 14:10:34 -0500249 unsigned ep_devs_created:1; /* endpoint "devices" exist */
Alan Stern352d0262008-10-29 15:16:58 -0400250 unsigned unregistering:1; /* unregistration is in progress */
Alan Stern645daaa2006-08-30 15:47:02 -0400251 unsigned needs_remote_wakeup:1; /* driver requires remote wakeup */
Alan Stern55151d72008-08-12 14:33:59 -0400252 unsigned needs_altsetting0:1; /* switch to altsetting 0 is pending */
Alan Stern78d9a482008-06-23 16:00:40 -0400253 unsigned needs_binding:1; /* needs delayed unbind/rebind */
Sarah Sharp04a723e2010-01-06 10:16:51 -0800254 unsigned resetting_device:1; /* true: bandwidth alloc after reset */
Stefan Koch4ad2ddc2015-08-25 21:10:05 +0200255 unsigned authorized:1; /* used for interface authorization */
Alan Stern4d064c02006-07-01 22:11:44 -0400256
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 struct device dev; /* interface specific device info */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800258 struct device *usb_dev;
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -0800259 struct work_struct reset_ws; /* for resets in atomic context */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260};
261#define to_usb_interface(d) container_of(d, struct usb_interface, dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800263static inline void *usb_get_intfdata(struct usb_interface *intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264{
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800265 return dev_get_drvdata(&intf->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266}
267
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800268static inline void usb_set_intfdata(struct usb_interface *intf, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269{
270 dev_set_drvdata(&intf->dev, data);
271}
272
273struct usb_interface *usb_get_intf(struct usb_interface *intf);
274void usb_put_intf(struct usb_interface *intf);
275
Hans de Goede8f5d3542013-10-09 17:19:24 +0200276/* Hard limit */
277#define USB_MAXENDPOINTS 30
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278/* this maximum is arbitrary */
279#define USB_MAXINTERFACES 32
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -0700280#define USB_MAXIADS (USB_MAXINTERFACES/2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281
Felipe Balbi62f03422015-02-13 14:34:25 -0600282/*
283 * USB Resume Timer: Every Host controller driver should drive the resume
284 * signalling on the bus for the amount of time defined by this macro.
285 *
286 * That way we will have a 'stable' behavior among all HCDs supported by Linux.
287 *
288 * Note that the USB Specification states we should drive resume for *at least*
289 * 20 ms, but it doesn't give an upper bound. This creates two possible
290 * situations which we want to avoid:
291 *
292 * (a) sometimes an msleep(20) might expire slightly before 20 ms, which causes
293 * us to fail USB Electrical Tests, thus failing Certification
294 *
295 * (b) Some (many) devices actually need more than 20 ms of resume signalling,
296 * and while we can argue that's against the USB Specification, we don't have
297 * control over which devices a certification laboratory will be using for
298 * certification. If CertLab uses a device which was tested against Windows and
299 * that happens to have relaxed resume signalling rules, we might fall into
300 * situations where we fail interoperability and electrical tests.
301 *
302 * In order to avoid both conditions, we're using a 40 ms resume timeout, which
303 * should cope with both LPJ calibration errors and devices not following every
304 * detail of the USB Specification.
305 */
306#define USB_RESUME_TIMEOUT 40 /* ms */
307
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308/**
309 * struct usb_interface_cache - long-term representation of a device interface
310 * @num_altsetting: number of altsettings defined.
311 * @ref: reference counter.
312 * @altsetting: variable-length array of interface structures, one for
313 * each alternate setting that may be selected. Each one includes a
314 * set of endpoint configurations. They will be in no particular order.
315 *
316 * These structures persist for the lifetime of a usb_device, unlike
317 * struct usb_interface (which persists only as long as its configuration
318 * is installed). The altsetting arrays can be accessed through these
319 * structures at any time, permitting comparison of configurations and
Mauro Carvalho Chehab21470e32017-04-16 21:51:07 -0300320 * providing support for the /sys/kernel/debug/usb/devices pseudo-file.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 */
322struct usb_interface_cache {
323 unsigned num_altsetting; /* number of alternate settings */
324 struct kref ref; /* reference counter */
325
326 /* variable-length array of alternate settings for this interface,
327 * stored in no particular order */
328 struct usb_host_interface altsetting[0];
329};
330#define ref_to_usb_interface_cache(r) \
331 container_of(r, struct usb_interface_cache, ref)
332#define altsetting_to_usb_interface_cache(a) \
333 container_of(a, struct usb_interface_cache, altsetting[0])
334
335/**
336 * struct usb_host_config - representation of a device's configuration
337 * @desc: the device's configuration descriptor.
338 * @string: pointer to the cached version of the iConfiguration string, if
339 * present for this configuration.
Randy Dunlap3f423782007-07-19 10:21:37 -0700340 * @intf_assoc: list of any interface association descriptors in this config
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 * @interface: array of pointers to usb_interface structures, one for each
342 * interface in the configuration. The number of interfaces is stored
343 * in desc.bNumInterfaces. These pointers are valid only while the
344 * the configuration is active.
345 * @intf_cache: array of pointers to usb_interface_cache structures, one
346 * for each interface in the configuration. These structures exist
347 * for the entire life of the device.
348 * @extra: pointer to buffer containing all extra descriptors associated
349 * with this configuration (those preceding the first interface
350 * descriptor).
351 * @extralen: length of the extra descriptors buffer.
352 *
353 * USB devices may have multiple configurations, but only one can be active
354 * at any time. Each encapsulates a different operational environment;
355 * for example, a dual-speed device would have separate configurations for
356 * full-speed and high-speed operation. The number of configurations
357 * available is stored in the device descriptor as bNumConfigurations.
358 *
359 * A configuration can contain multiple interfaces. Each corresponds to
360 * a different function of the USB device, and all are available whenever
361 * the configuration is active. The USB standard says that interfaces
362 * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot
363 * of devices get this wrong. In addition, the interface array is not
364 * guaranteed to be sorted in numerical order. Use usb_ifnum_to_if() to
365 * look up an interface entry based on its number.
366 *
367 * Device drivers should not attempt to activate configurations. The choice
368 * of which configuration to install is a policy decision based on such
369 * considerations as available power, functionality provided, and the user's
Kay Sievers312c0042005-11-16 09:00:00 +0100370 * desires (expressed through userspace tools). However, drivers can call
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 * usb_reset_configuration() to reinitialize the current configuration and
372 * all its interfaces.
373 */
374struct usb_host_config {
375 struct usb_config_descriptor desc;
376
Alan Stern4f62efe2005-10-24 16:24:14 -0400377 char *string; /* iConfiguration string, if present */
Craig W. Nadler165fe972007-06-15 23:14:35 -0400378
379 /* List of any Interface Association Descriptors in this
380 * configuration. */
381 struct usb_interface_assoc_descriptor *intf_assoc[USB_MAXIADS];
382
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 /* the interfaces associated with this configuration,
384 * stored in no particular order */
385 struct usb_interface *interface[USB_MAXINTERFACES];
386
387 /* Interface information available even when this is not the
388 * active configuration */
389 struct usb_interface_cache *intf_cache[USB_MAXINTERFACES];
390
391 unsigned char *extra; /* Extra descriptors */
392 int extralen;
393};
394
Andiry Xu3148bf02011-09-23 14:19:47 -0700395/* USB2.0 and USB3.0 device BOS descriptor set */
396struct usb_host_bos {
397 struct usb_bos_descriptor *desc;
398
399 /* wireless cap descriptor is handled by wusb */
400 struct usb_ext_cap_descriptor *ext_cap;
401 struct usb_ss_cap_descriptor *ss_cap;
Mathias Nyman3220bef2015-10-01 18:40:33 +0300402 struct usb_ssp_cap_descriptor *ssp_cap;
Andiry Xu3148bf02011-09-23 14:19:47 -0700403 struct usb_ss_container_id_descriptor *ss_id;
Mathias Nymanfaee8222016-02-12 16:40:14 +0200404 struct usb_ptm_cap_descriptor *ptm_cap;
Andiry Xu3148bf02011-09-23 14:19:47 -0700405};
406
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407int __usb_get_extra_descriptor(char *buffer, unsigned size,
Mathias Payer7b6e85d2018-12-05 21:19:59 +0100408 unsigned char type, void **ptr, size_t min);
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800409#define usb_get_extra_descriptor(ifpoint, type, ptr) \
410 __usb_get_extra_descriptor((ifpoint)->extra, \
411 (ifpoint)->extralen, \
Mathias Payer7b6e85d2018-12-05 21:19:59 +0100412 type, (void **)ptr, sizeof(**(ptr)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413
Alan Sternb724ae72005-10-24 15:36:00 -0400414/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416/* USB device number allocation bitmap */
417struct usb_devmap {
418 unsigned long devicemap[128 / (8*sizeof(unsigned long))];
419};
420
421/*
422 * Allocated per bus (tree of devices) we have:
423 */
424struct usb_bus {
425 struct device *controller; /* host/master side hardware */
Arnd Bergmanna8c06e42017-03-13 10:18:41 +0800426 struct device *sysdev; /* as seen from firmware or bus */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 int busnum; /* Bus number (in order of reg) */
Greg Kroah-Hartman1b26da12008-07-02 12:46:22 -0700428 const char *bus_name; /* stable id (PCI slot_name etc) */
Alan Sterndd990f12006-08-30 11:29:56 -0400429 u8 uses_dma; /* Does the host controller use DMA? */
Anand Gadiyar07a8cdd2010-11-18 18:54:17 +0530430 u8 uses_pio_for_control; /*
431 * Does the host controller use PIO
432 * for control transfers?
433 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 u8 otg_port; /* 0, or number of OTG/HNP port */
435 unsigned is_b_host:1; /* true during some HNP roleswitches */
436 unsigned b_hnp_enable:1; /* OTG: did A-Host enable HNP? */
Hans de Goede19181bc2012-07-04 09:18:02 +0200437 unsigned no_stop_on_short:1; /*
438 * Quirk: some controllers don't stop
439 * the ep queue on a short transfer
440 * with the URB_SHORT_NOT_OK flag set.
441 */
Ming Leibcc48f12013-08-08 21:48:22 +0800442 unsigned no_sg_constraint:1; /* no sg constraint */
David Vrabel4c1bd3d2009-08-24 14:44:30 +0100443 unsigned sg_tablesize; /* 0 or largest number of sg list entries */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444
Alan Sternb724ae72005-10-24 15:36:00 -0400445 int devnum_next; /* Next open device number in
446 * round-robin allocation */
Chris Bainbridgefeb26ac2016-04-25 13:48:38 +0100447 struct mutex devnum_next_mutex; /* devnum_next mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448
449 struct usb_devmap devmap; /* device address allocation map */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 struct usb_device *root_hub; /* Root hub */
Alan Stern6d19c002010-02-12 12:21:11 +0100451 struct usb_bus *hs_companion; /* Companion EHCI bus, if any */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452
453 int bandwidth_allocated; /* on this bus: how much of the time
454 * reserved for periodic (intr/iso)
455 * requests is used, on average?
456 * Units: microseconds/frame.
457 * Limits: Full/low speed reserve 90%,
458 * while high speed reserves 80%.
459 */
460 int bandwidth_int_reqs; /* number of Interrupt requests */
461 int bandwidth_isoc_reqs; /* number of Isoc. requests */
462
Alan Sternda0aa712013-01-25 17:09:42 -0500463 unsigned resuming_ports; /* bit array: resuming root-hub ports */
464
Pete Zaitcevf150fa12008-11-13 21:31:21 -0700465#if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 struct mon_bus *mon_bus; /* non-null when associated */
467 int monitored; /* non-zero when monitored */
468#endif
469};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470
Valentina Manea9b6f0c42014-03-10 10:36:40 +0200471struct usb_dev_state;
Valentina Manea6080cd02014-03-08 14:53:34 +0200472
Alan Sternb724ae72005-10-24 15:36:00 -0400473/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475struct usb_tt;
476
Matthew Garrett0846e7e2012-02-03 17:11:54 -0500477enum usb_device_removable {
478 USB_DEVICE_REMOVABLE_UNKNOWN = 0,
479 USB_DEVICE_REMOVABLE,
480 USB_DEVICE_FIXED,
481};
482
Lan Tianyu05f91682012-09-05 13:44:34 +0800483enum usb_port_connect_type {
484 USB_PORT_CONNECT_TYPE_UNKNOWN = 0,
485 USB_PORT_CONNECT_TYPE_HOT_PLUG,
486 USB_PORT_CONNECT_TYPE_HARD_WIRED,
487 USB_PORT_NOT_USED,
488};
489
Sarah Sharp51e0a012012-02-20 12:02:19 -0800490/*
Mathias Nyman17f34862013-05-23 17:14:31 +0300491 * USB 2.0 Link Power Management (LPM) parameters.
492 */
493struct usb2_lpm_parameters {
494 /* Best effort service latency indicate how long the host will drive
495 * resume on an exit from L1.
496 */
497 unsigned int besl;
498
499 /* Timeout value in microseconds for the L1 inactivity (LPM) timer.
500 * When the timer counts to zero, the parent hub will initiate a LPM
501 * transition to L1.
502 */
503 int timeout;
504};
505
506/*
Sarah Sharp51e0a012012-02-20 12:02:19 -0800507 * USB 3.0 Link Power Management (LPM) parameters.
508 *
509 * PEL and SEL are USB 3.0 Link PM latencies for device-initiated LPM exit.
510 * MEL is the USB 3.0 Link PM latency for host-initiated LPM exit.
511 * All three are stored in nanoseconds.
512 */
513struct usb3_lpm_parameters {
514 /*
515 * Maximum exit latency (MEL) for the host to send a packet to the
516 * device (either a Ping for isoc endpoints, or a data packet for
517 * interrupt endpoints), the hubs to decode the packet, and for all hubs
518 * in the path to transition the links to U0.
519 */
520 unsigned int mel;
521 /*
522 * Maximum exit latency for a device-initiated LPM transition to bring
523 * all links into U0. Abbreviated as "PEL" in section 9.4.12 of the USB
524 * 3.0 spec, with no explanation of what "P" stands for. "Path"?
525 */
526 unsigned int pel;
527
528 /*
529 * The System Exit Latency (SEL) includes PEL, and three other
530 * latencies. After a device initiates a U0 transition, it will take
531 * some time from when the device sends the ERDY to when it will finally
532 * receive the data packet. Basically, SEL should be the worse-case
533 * latency from when a device starts initiating a U0 transition to when
534 * it will get data.
535 */
536 unsigned int sel;
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -0700537 /*
538 * The idle timeout value that is currently programmed into the parent
539 * hub for this device. When the timer counts to zero, the parent hub
540 * will initiate an LPM transition to either U1 or U2.
541 */
542 int timeout;
Sarah Sharp51e0a012012-02-20 12:02:19 -0800543};
544
Randy Dunlapf476fba2008-02-13 18:33:15 -0800545/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 * struct usb_device - kernel's representation of a USB device
Randy Dunlapf476fba2008-02-13 18:33:15 -0800547 * @devnum: device number; address on a USB bus
548 * @devpath: device ID string for use in messages (e.g., /port/...)
Sarah Sharp7206b002009-04-27 19:54:49 -0700549 * @route: tree topology hex string for use with xHCI
Randy Dunlapf476fba2008-02-13 18:33:15 -0800550 * @state: device state: configured, not attached, etc.
551 * @speed: device speed: high/full/low (or error)
552 * @tt: Transaction Translator info; used with low/full speed dev, highspeed hub
553 * @ttport: device port on that tt hub
554 * @toggle: one bit for each endpoint, with ([0] = IN, [1] = OUT) endpoints
555 * @parent: our hub, unless we're the root
556 * @bus: bus we're part of
557 * @ep0: endpoint 0 data (default control pipe)
558 * @dev: generic device interface
559 * @descriptor: USB device descriptor
Andiry Xu3148bf02011-09-23 14:19:47 -0700560 * @bos: USB device BOS descriptor set
Randy Dunlapf476fba2008-02-13 18:33:15 -0800561 * @config: all of the device's configs
562 * @actconfig: the active configuration
563 * @ep_in: array of IN endpoints
564 * @ep_out: array of OUT endpoints
565 * @rawdescriptors: raw descriptors for each config
566 * @bus_mA: Current available from the bus
567 * @portnum: parent port number (origin 1)
568 * @level: number of USB hub ancestors
569 * @can_submit: URBs may be submitted
Randy Dunlapf476fba2008-02-13 18:33:15 -0800570 * @persist_enabled: USB_PERSIST enabled for this device
571 * @have_langid: whether string_langid is valid
572 * @authorized: policy has said we can use it;
573 * (user space) policy determines if we authorize this device to be
574 * used or not. By default, wired USB devices are authorized.
575 * WUSB devices are not, until we authorize them from user space.
576 * FIXME -- complete doc
Inaky Perez-Gonzalez3b52f122008-04-08 13:24:46 -0700577 * @authenticated: Crypto authentication passed
Randy Dunlapf476fba2008-02-13 18:33:15 -0800578 * @wusb: device is Wireless USB
Andiry Xu1ff4df52011-09-23 14:19:48 -0700579 * @lpm_capable: device supports LPM
Andiry Xu65580b432011-09-23 14:19:52 -0700580 * @usb2_hw_lpm_capable: device can perform USB2 hardware LPM
Mathias Nymana558ccd2013-05-23 17:14:30 +0300581 * @usb2_hw_lpm_besl_capable: device can perform USB2 hardware BESL LPM
Sarah Sharpde68bab2013-09-30 17:26:28 +0300582 * @usb2_hw_lpm_enabled: USB2 hardware LPM is enabled
583 * @usb2_hw_lpm_allowed: Userspace allows USB 2.0 LPM to be enabled
Lu Baolubf5ce5b2015-11-14 16:26:32 +0800584 * @usb3_lpm_u1_enabled: USB3 hardware U1 LPM enabled
585 * @usb3_lpm_u2_enabled: USB3 hardware U2 LPM enabled
Randy Dunlapf476fba2008-02-13 18:33:15 -0800586 * @string_langid: language ID for strings
587 * @product: iProduct string, if present (static)
588 * @manufacturer: iManufacturer string, if present (static)
589 * @serial: iSerialNumber string, if present (static)
590 * @filelist: usbfs files that are open to this device
Randy Dunlapf476fba2008-02-13 18:33:15 -0800591 * @maxchild: number of ports if hub
Randy Dunlapf476fba2008-02-13 18:33:15 -0800592 * @quirks: quirks of the whole device
593 * @urbnum: number of URBs submitted for the whole device
594 * @active_duration: total time device is not suspended
Randy Dunlapf476fba2008-02-13 18:33:15 -0800595 * @connect_time: time device was first connected
Randy Dunlapf476fba2008-02-13 18:33:15 -0800596 * @do_remote_wakeup: remote wakeup should be enabled
597 * @reset_resume: needs reset instead of resume
Alan Sternbfd1e912012-10-19 11:03:39 -0400598 * @port_is_suspended: the upstream port is suspended (L2 or U3)
Inaky Perez-Gonzalez11e76ae2009-01-08 12:52:19 -0800599 * @wusb_dev: if this is a Wireless USB device, link to the WUSB
600 * specific data for the device.
Sarah Sharpc6515272009-04-27 19:57:26 -0700601 * @slot_id: Slot ID assigned by xHCI
Matthew Garrett0846e7e2012-02-03 17:11:54 -0500602 * @removable: Device can be physically removed from this port
Mathias Nyman17f34862013-05-23 17:14:31 +0300603 * @l1_params: best effor service latency for USB2 L1 LPM state, and L1 timeout.
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -0700604 * @u1_params: exit latencies for USB3 U1 LPM state, and hub-initiated timeout.
605 * @u2_params: exit latencies for USB3 U2 LPM state, and hub-initiated timeout.
606 * @lpm_disable_count: Ref count used by usb_disable_lpm() and usb_enable_lpm()
607 * to keep track of the number of functions that require USB 3.0 Link Power
608 * Management to be disabled for this usb_device. This count should only
609 * be manipulated by those functions, with the bandwidth_mutex is held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 *
Randy Dunlapf476fba2008-02-13 18:33:15 -0800611 * Notes:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 * Usbcore drivers should not set usbdev->state directly. Instead use
613 * usb_set_device_state().
614 */
615struct usb_device {
Randy Dunlapf476fba2008-02-13 18:33:15 -0800616 int devnum;
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -0700617 char devpath[16];
Sarah Sharp7206b002009-04-27 19:54:49 -0700618 u32 route;
Randy Dunlapf476fba2008-02-13 18:33:15 -0800619 enum usb_device_state state;
620 enum usb_device_speed speed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621
Randy Dunlapf476fba2008-02-13 18:33:15 -0800622 struct usb_tt *tt;
623 int ttport;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624
Randy Dunlapf476fba2008-02-13 18:33:15 -0800625 unsigned int toggle[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626
Randy Dunlapf476fba2008-02-13 18:33:15 -0800627 struct usb_device *parent;
628 struct usb_bus *bus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 struct usb_host_endpoint ep0;
630
Randy Dunlapf476fba2008-02-13 18:33:15 -0800631 struct device dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632
Randy Dunlapf476fba2008-02-13 18:33:15 -0800633 struct usb_device_descriptor descriptor;
Andiry Xu3148bf02011-09-23 14:19:47 -0700634 struct usb_host_bos *bos;
Randy Dunlapf476fba2008-02-13 18:33:15 -0800635 struct usb_host_config *config;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636
Randy Dunlapf476fba2008-02-13 18:33:15 -0800637 struct usb_host_config *actconfig;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 struct usb_host_endpoint *ep_in[16];
639 struct usb_host_endpoint *ep_out[16];
640
Randy Dunlapf476fba2008-02-13 18:33:15 -0800641 char **rawdescriptors;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642
Randy Dunlapf476fba2008-02-13 18:33:15 -0800643 unsigned short bus_mA;
644 u8 portnum;
645 u8 level;
Alan Stern55c52712005-11-23 12:03:12 -0500646
Randy Dunlapf476fba2008-02-13 18:33:15 -0800647 unsigned can_submit:1;
Randy Dunlapf476fba2008-02-13 18:33:15 -0800648 unsigned persist_enabled:1;
649 unsigned have_langid:1;
650 unsigned authorized:1;
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -0700651 unsigned authenticated:1;
Randy Dunlapf476fba2008-02-13 18:33:15 -0800652 unsigned wusb:1;
Andiry Xu1ff4df52011-09-23 14:19:48 -0700653 unsigned lpm_capable:1;
Andiry Xu65580b432011-09-23 14:19:52 -0700654 unsigned usb2_hw_lpm_capable:1;
Mathias Nymana558ccd2013-05-23 17:14:30 +0300655 unsigned usb2_hw_lpm_besl_capable:1;
Andiry Xu65580b432011-09-23 14:19:52 -0700656 unsigned usb2_hw_lpm_enabled:1;
Sarah Sharpde68bab2013-09-30 17:26:28 +0300657 unsigned usb2_hw_lpm_allowed:1;
Lu Baolubf5ce5b2015-11-14 16:26:32 +0800658 unsigned usb3_lpm_u1_enabled:1;
659 unsigned usb3_lpm_u2_enabled:1;
Randy Dunlapf476fba2008-02-13 18:33:15 -0800660 int string_langid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661
Alan Stern4f62efe2005-10-24 16:24:14 -0400662 /* static strings from the device */
Randy Dunlapf476fba2008-02-13 18:33:15 -0800663 char *product;
664 char *manufacturer;
665 char *serial;
Alan Stern4f62efe2005-10-24 16:24:14 -0400666
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 struct list_head filelist;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668
Randy Dunlapf476fba2008-02-13 18:33:15 -0800669 int maxchild;
Alan Stern645daaa2006-08-30 15:47:02 -0400670
Randy Dunlapf476fba2008-02-13 18:33:15 -0800671 u32 quirks;
672 atomic_t urbnum;
Alan Sternb5e795f2007-02-20 15:00:53 -0500673
Randy Dunlapf476fba2008-02-13 18:33:15 -0800674 unsigned long active_duration;
Sarah Sharp15123002007-12-21 16:54:15 -0800675
Alan Stern645daaa2006-08-30 15:47:02 -0400676#ifdef CONFIG_PM
Randy Dunlapf476fba2008-02-13 18:33:15 -0800677 unsigned long connect_time;
Alan Sternb5e795f2007-02-20 15:00:53 -0500678
Randy Dunlapf476fba2008-02-13 18:33:15 -0800679 unsigned do_remote_wakeup:1;
680 unsigned reset_resume:1;
Alan Sternbfd1e912012-10-19 11:03:39 -0400681 unsigned port_is_suspended:1;
Alan Stern645daaa2006-08-30 15:47:02 -0400682#endif
Inaky Perez-Gonzalezb1d8dfb2008-04-08 13:24:46 -0700683 struct wusb_dev *wusb_dev;
Sarah Sharpc6515272009-04-27 19:57:26 -0700684 int slot_id;
Matthew Garrett0846e7e2012-02-03 17:11:54 -0500685 enum usb_device_removable removable;
Mathias Nyman17f34862013-05-23 17:14:31 +0300686 struct usb2_lpm_parameters l1_params;
Sarah Sharp51e0a012012-02-20 12:02:19 -0800687 struct usb3_lpm_parameters u1_params;
688 struct usb3_lpm_parameters u2_params;
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -0700689 unsigned lpm_disable_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690};
691#define to_usb_device(d) container_of(d, struct usb_device, dev)
692
Matthew Wilcox1e429012010-04-30 13:11:30 -0600693static inline struct usb_device *interface_to_usbdev(struct usb_interface *intf)
694{
695 return to_usb_device(intf->dev.parent);
696}
697
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698extern struct usb_device *usb_get_dev(struct usb_device *dev);
699extern void usb_put_dev(struct usb_device *dev);
Lan Tianyuff823c72012-09-05 13:44:32 +0800700extern struct usb_device *usb_hub_find_child(struct usb_device *hdev,
701 int port1);
702
703/**
704 * usb_hub_for_each_child - iterate over all child devices on the hub
705 * @hdev: USB device belonging to the usb hub
706 * @port1: portnum associated with child device
707 * @child: child device pointer
708 */
709#define usb_hub_for_each_child(hdev, port1, child) \
710 for (port1 = 1, child = usb_hub_find_child(hdev, port1); \
Alan Stern969ddcf2012-10-19 11:03:02 -0400711 port1 <= hdev->maxchild; \
712 child = usb_hub_find_child(hdev, ++port1)) \
713 if (!child) continue; else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714
Alan Stern9ad3d6c2005-11-17 17:10:32 -0500715/* USB device locking */
Oliver Neukum7dd9cba2016-01-21 15:18:47 +0100716#define usb_lock_device(udev) device_lock(&(udev)->dev)
717#define usb_unlock_device(udev) device_unlock(&(udev)->dev)
718#define usb_lock_device_interruptible(udev) device_lock_interruptible(&(udev)->dev)
719#define usb_trylock_device(udev) device_trylock(&(udev)->dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720extern int usb_lock_device_for_reset(struct usb_device *udev,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300721 const struct usb_interface *iface);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722
723/* USB port reset for device reinitialization */
724extern int usb_reset_device(struct usb_device *dev);
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -0800725extern void usb_queue_reset_device(struct usb_interface *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726
Lan Tianyuf7ac7782012-09-05 13:44:36 +0800727#ifdef CONFIG_ACPI
728extern int usb_acpi_set_power_state(struct usb_device *hdev, int index,
729 bool enable);
730extern bool usb_acpi_power_manageable(struct usb_device *hdev, int index);
731#else
732static inline int usb_acpi_set_power_state(struct usb_device *hdev, int index,
733 bool enable) { return 0; }
734static inline bool usb_acpi_power_manageable(struct usb_device *hdev, int index)
735 { return true; }
736#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737
Alan Stern645daaa2006-08-30 15:47:02 -0400738/* USB autosuspend and autoresume */
Rafael J. Wysockiceb6c9c2014-11-29 23:47:05 +0100739#ifdef CONFIG_PM
Alan Stern9e18c822010-04-02 13:22:09 -0400740extern void usb_enable_autosuspend(struct usb_device *udev);
741extern void usb_disable_autosuspend(struct usb_device *udev);
Alan Stern088f7fe2010-01-08 12:56:54 -0500742
Alan Stern645daaa2006-08-30 15:47:02 -0400743extern int usb_autopm_get_interface(struct usb_interface *intf);
744extern void usb_autopm_put_interface(struct usb_interface *intf);
Alan Stern9ac39f22008-11-12 16:19:49 -0500745extern int usb_autopm_get_interface_async(struct usb_interface *intf);
746extern void usb_autopm_put_interface_async(struct usb_interface *intf);
Alan Stern9bbdf1e2010-01-08 12:57:28 -0500747extern void usb_autopm_get_interface_no_resume(struct usb_interface *intf);
748extern void usb_autopm_put_interface_no_suspend(struct usb_interface *intf);
Alan Stern692a1862006-10-30 17:07:51 -0500749
Alan Stern19410442007-03-27 13:33:59 -0400750static inline void usb_mark_last_busy(struct usb_device *udev)
751{
Ming Lei6ddf27c2010-11-15 15:57:30 -0500752 pm_runtime_mark_last_busy(&udev->dev);
Alan Stern19410442007-03-27 13:33:59 -0400753}
754
Alan Stern692a1862006-10-30 17:07:51 -0500755#else
756
Alan Stern088f7fe2010-01-08 12:56:54 -0500757static inline int usb_enable_autosuspend(struct usb_device *udev)
758{ return 0; }
759static inline int usb_disable_autosuspend(struct usb_device *udev)
760{ return 0; }
761
Alan Stern692a1862006-10-30 17:07:51 -0500762static inline int usb_autopm_get_interface(struct usb_interface *intf)
763{ return 0; }
Alan Stern9ac39f22008-11-12 16:19:49 -0500764static inline int usb_autopm_get_interface_async(struct usb_interface *intf)
765{ return 0; }
766
Alan Stern692a1862006-10-30 17:07:51 -0500767static inline void usb_autopm_put_interface(struct usb_interface *intf)
768{ }
Alan Stern9ac39f22008-11-12 16:19:49 -0500769static inline void usb_autopm_put_interface_async(struct usb_interface *intf)
770{ }
Alan Stern8e4ceb32009-12-07 13:01:37 -0500771static inline void usb_autopm_get_interface_no_resume(
772 struct usb_interface *intf)
Alan Stern692a1862006-10-30 17:07:51 -0500773{ }
Alan Stern8e4ceb32009-12-07 13:01:37 -0500774static inline void usb_autopm_put_interface_no_suspend(
775 struct usb_interface *intf)
Alan Stern692a1862006-10-30 17:07:51 -0500776{ }
Alan Stern19410442007-03-27 13:33:59 -0400777static inline void usb_mark_last_busy(struct usb_device *udev)
778{ }
Alan Stern692a1862006-10-30 17:07:51 -0500779#endif
Alan Stern645daaa2006-08-30 15:47:02 -0400780
Sarah Sharpe9261fb2012-05-21 08:29:01 -0700781extern int usb_disable_lpm(struct usb_device *udev);
782extern void usb_enable_lpm(struct usb_device *udev);
783/* Same as above, but these functions lock/unlock the bandwidth_mutex. */
784extern int usb_unlocked_disable_lpm(struct usb_device *udev);
785extern void usb_unlocked_enable_lpm(struct usb_device *udev);
786
Sarah Sharpf74631e2012-06-25 12:08:08 -0700787extern int usb_disable_ltm(struct usb_device *udev);
788extern void usb_enable_ltm(struct usb_device *udev);
789
Sarah Sharp024f1172012-07-05 17:17:24 -0700790static inline bool usb_device_supports_ltm(struct usb_device *udev)
791{
Oliver Neukumdd80b542016-04-20 15:39:11 +0200792 if (udev->speed < USB_SPEED_SUPER || !udev->bos || !udev->bos->ss_cap)
Sarah Sharp024f1172012-07-05 17:17:24 -0700793 return false;
794 return udev->bos->ss_cap->bmAttributes & USB_LTM_SUPPORT;
795}
796
Ming Leibcc48f12013-08-08 21:48:22 +0800797static inline bool usb_device_no_sg_constraint(struct usb_device *udev)
798{
799 return udev && udev->bus && udev->bus->no_sg_constraint;
800}
801
Sarah Sharp024f1172012-07-05 17:17:24 -0700802
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803/*-------------------------------------------------------------------------*/
804
805/* for drivers using iso endpoints */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800806extern int usb_get_current_frame_number(struct usb_device *usb_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807
Sarah Sharpeab1caf2010-04-05 10:55:58 -0700808/* Sets up a group of bulk endpoints to support multiple stream IDs. */
809extern int usb_alloc_streams(struct usb_interface *interface,
810 struct usb_host_endpoint **eps, unsigned int num_eps,
811 unsigned int num_streams, gfp_t mem_flags);
812
813/* Reverts a group of bulk endpoints back to not using stream IDs. */
Hans de Goede6c74dad2013-08-30 14:03:59 +0200814extern int usb_free_streams(struct usb_interface *interface,
Sarah Sharpeab1caf2010-04-05 10:55:58 -0700815 struct usb_host_endpoint **eps, unsigned int num_eps,
816 gfp_t mem_flags);
817
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818/* used these for multi-interface device registration */
819extern int usb_driver_claim_interface(struct usb_driver *driver,
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800820 struct usb_interface *iface, void *priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821
822/**
823 * usb_interface_claimed - returns true iff an interface is claimed
824 * @iface: the interface being checked
825 *
Yacine Belkadi626f0902013-08-02 20:10:04 +0200826 * Return: %true (nonzero) iff the interface is claimed, else %false
827 * (zero).
828 *
829 * Note:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830 * Callers must own the driver model's usb bus readlock. So driver
831 * probe() entries don't need extra locking, but other call contexts
832 * may need to explicitly claim that lock.
833 *
834 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800835static inline int usb_interface_claimed(struct usb_interface *iface)
836{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 return (iface->dev.driver != NULL);
838}
839
840extern void usb_driver_release_interface(struct usb_driver *driver,
841 struct usb_interface *iface);
842const struct usb_device_id *usb_match_id(struct usb_interface *interface,
843 const struct usb_device_id *id);
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +0100844extern int usb_match_one_id(struct usb_interface *interface,
845 const struct usb_device_id *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846
Julius Werner9b790912013-05-17 12:08:51 -0700847extern int usb_for_each_dev(void *data, int (*fn)(struct usb_device *, void *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848extern struct usb_interface *usb_find_interface(struct usb_driver *drv,
849 int minor);
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300850extern struct usb_interface *usb_ifnum_to_if(const struct usb_device *dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851 unsigned ifnum);
852extern struct usb_host_interface *usb_altnum_to_altsetting(
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300853 const struct usb_interface *intf, unsigned int altnum);
Sarah Sharp91017f92009-12-03 09:44:34 -0800854extern struct usb_host_interface *usb_find_alt_setting(
855 struct usb_host_config *config,
856 unsigned int iface_num,
857 unsigned int alt_num);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858
Valentina Manea6080cd02014-03-08 14:53:34 +0200859/* port claiming functions */
860int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
Valentina Manea9b6f0c42014-03-10 10:36:40 +0200861 struct usb_dev_state *owner);
Valentina Manea6080cd02014-03-08 14:53:34 +0200862int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
Valentina Manea9b6f0c42014-03-10 10:36:40 +0200863 struct usb_dev_state *owner);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864
865/**
866 * usb_make_path - returns stable device path in the usb tree
867 * @dev: the device whose path is being constructed
868 * @buf: where to put the string
869 * @size: how big is "buf"?
870 *
Yacine Belkadi626f0902013-08-02 20:10:04 +0200871 * Return: Length of the string (> 0) or negative if size was too small.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872 *
Yacine Belkadi626f0902013-08-02 20:10:04 +0200873 * Note:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874 * This identifier is intended to be "stable", reflecting physical paths in
875 * hardware such as physical bus addresses for host controllers or ports on
876 * USB hubs. That makes it stay the same until systems are physically
877 * reconfigured, by re-cabling a tree of USB devices or by moving USB host
878 * controllers. Adding and removing devices, including virtual root hubs
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300879 * in host controller driver modules, does not change these path identifiers;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880 * neither does rebooting or re-enumerating. These are more useful identifiers
881 * than changeable ("unstable") ones like bus numbers or device addresses.
882 *
883 * With a partial exception for devices connected to USB 2.0 root hubs, these
884 * identifiers are also predictable. So long as the device tree isn't changed,
885 * plugging any USB device into a given hub port always gives it the same path.
886 * Because of the use of "companion" controllers, devices connected to ports on
887 * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are
888 * high speed, and a different one if they are full or low speed.
889 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800890static inline int usb_make_path(struct usb_device *dev, char *buf, size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891{
892 int actual;
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800893 actual = snprintf(buf, size, "usb-%s-%s", dev->bus->bus_name,
894 dev->devpath);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895 return (actual >= (int)size) ? -1 : actual;
896}
897
898/*-------------------------------------------------------------------------*/
899
Alan Sternb724ae72005-10-24 15:36:00 -0400900#define USB_DEVICE_ID_MATCH_DEVICE \
901 (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
902#define USB_DEVICE_ID_MATCH_DEV_RANGE \
903 (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI)
904#define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
905 (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906#define USB_DEVICE_ID_MATCH_DEV_INFO \
Alan Sternb724ae72005-10-24 15:36:00 -0400907 (USB_DEVICE_ID_MATCH_DEV_CLASS | \
908 USB_DEVICE_ID_MATCH_DEV_SUBCLASS | \
909 USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910#define USB_DEVICE_ID_MATCH_INT_INFO \
Alan Sternb724ae72005-10-24 15:36:00 -0400911 (USB_DEVICE_ID_MATCH_INT_CLASS | \
912 USB_DEVICE_ID_MATCH_INT_SUBCLASS | \
913 USB_DEVICE_ID_MATCH_INT_PROTOCOL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914
915/**
916 * USB_DEVICE - macro used to describe a specific usb device
917 * @vend: the 16 bit USB Vendor ID
918 * @prod: the 16 bit USB Product ID
919 *
920 * This macro is used to create a struct usb_device_id that matches a
921 * specific device.
922 */
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -0700923#define USB_DEVICE(vend, prod) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800924 .match_flags = USB_DEVICE_ID_MATCH_DEVICE, \
925 .idVendor = (vend), \
926 .idProduct = (prod)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927/**
Randy Dunlapd0bcabc2008-02-29 22:03:07 -0800928 * USB_DEVICE_VER - describe a specific usb device with a version range
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 * @vend: the 16 bit USB Vendor ID
930 * @prod: the 16 bit USB Product ID
931 * @lo: the bcdDevice_lo value
932 * @hi: the bcdDevice_hi value
933 *
934 * This macro is used to create a struct usb_device_id that matches a
935 * specific device, with a version range.
936 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800937#define USB_DEVICE_VER(vend, prod, lo, hi) \
Alan Sternb724ae72005-10-24 15:36:00 -0400938 .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800939 .idVendor = (vend), \
940 .idProduct = (prod), \
941 .bcdDevice_lo = (lo), \
942 .bcdDevice_hi = (hi)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943
944/**
Bjørn Mork17b72fe2012-10-31 06:08:39 +0100945 * USB_DEVICE_INTERFACE_CLASS - describe a usb device with a specific interface class
946 * @vend: the 16 bit USB Vendor ID
947 * @prod: the 16 bit USB Product ID
948 * @cl: bInterfaceClass value
949 *
950 * This macro is used to create a struct usb_device_id that matches a
951 * specific interface class of devices.
952 */
953#define USB_DEVICE_INTERFACE_CLASS(vend, prod, cl) \
954 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
955 USB_DEVICE_ID_MATCH_INT_CLASS, \
956 .idVendor = (vend), \
957 .idProduct = (prod), \
958 .bInterfaceClass = (cl)
959
960/**
Randy Dunlapd0bcabc2008-02-29 22:03:07 -0800961 * USB_DEVICE_INTERFACE_PROTOCOL - describe a usb device with a specific interface protocol
Jan Kratochvilf836ac82007-05-09 00:26:15 -0400962 * @vend: the 16 bit USB Vendor ID
963 * @prod: the 16 bit USB Product ID
964 * @pr: bInterfaceProtocol value
965 *
966 * This macro is used to create a struct usb_device_id that matches a
967 * specific interface protocol of devices.
968 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800969#define USB_DEVICE_INTERFACE_PROTOCOL(vend, prod, pr) \
970 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
971 USB_DEVICE_ID_MATCH_INT_PROTOCOL, \
Jan Kratochvilf836ac82007-05-09 00:26:15 -0400972 .idVendor = (vend), \
973 .idProduct = (prod), \
974 .bInterfaceProtocol = (pr)
975
976/**
Bjørn Mork81df2d52012-05-18 21:27:43 +0200977 * USB_DEVICE_INTERFACE_NUMBER - describe a usb device with a specific interface number
978 * @vend: the 16 bit USB Vendor ID
979 * @prod: the 16 bit USB Product ID
980 * @num: bInterfaceNumber value
981 *
982 * This macro is used to create a struct usb_device_id that matches a
983 * specific interface number of devices.
984 */
985#define USB_DEVICE_INTERFACE_NUMBER(vend, prod, num) \
986 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
987 USB_DEVICE_ID_MATCH_INT_NUMBER, \
988 .idVendor = (vend), \
989 .idProduct = (prod), \
990 .bInterfaceNumber = (num)
991
992/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 * USB_DEVICE_INFO - macro used to describe a class of usb devices
994 * @cl: bDeviceClass value
995 * @sc: bDeviceSubClass value
996 * @pr: bDeviceProtocol value
997 *
998 * This macro is used to create a struct usb_device_id that matches a
999 * specific class of devices.
1000 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001001#define USB_DEVICE_INFO(cl, sc, pr) \
1002 .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, \
1003 .bDeviceClass = (cl), \
1004 .bDeviceSubClass = (sc), \
1005 .bDeviceProtocol = (pr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006
1007/**
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001008 * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009 * @cl: bInterfaceClass value
1010 * @sc: bInterfaceSubClass value
1011 * @pr: bInterfaceProtocol value
1012 *
1013 * This macro is used to create a struct usb_device_id that matches a
1014 * specific class of interfaces.
1015 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001016#define USB_INTERFACE_INFO(cl, sc, pr) \
1017 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, \
1018 .bInterfaceClass = (cl), \
1019 .bInterfaceSubClass = (sc), \
1020 .bInterfaceProtocol = (pr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021
Daniel Drake8538f962007-05-10 00:32:24 +01001022/**
Randy Dunlapd0bcabc2008-02-29 22:03:07 -08001023 * USB_DEVICE_AND_INTERFACE_INFO - describe a specific usb device with a class of usb interfaces
Daniel Drake8538f962007-05-10 00:32:24 +01001024 * @vend: the 16 bit USB Vendor ID
1025 * @prod: the 16 bit USB Product ID
1026 * @cl: bInterfaceClass value
1027 * @sc: bInterfaceSubClass value
1028 * @pr: bInterfaceProtocol value
1029 *
1030 * This macro is used to create a struct usb_device_id that matches a
1031 * specific device with a specific class of interfaces.
1032 *
1033 * This is especially useful when explicitly matching devices that have
1034 * vendor specific bDeviceClass values, but standards-compliant interfaces.
1035 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001036#define USB_DEVICE_AND_INTERFACE_INFO(vend, prod, cl, sc, pr) \
Daniel Drake8538f962007-05-10 00:32:24 +01001037 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO \
1038 | USB_DEVICE_ID_MATCH_DEVICE, \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001039 .idVendor = (vend), \
1040 .idProduct = (prod), \
Daniel Drake8538f962007-05-10 00:32:24 +01001041 .bInterfaceClass = (cl), \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001042 .bInterfaceSubClass = (sc), \
1043 .bInterfaceProtocol = (pr)
Daniel Drake8538f962007-05-10 00:32:24 +01001044
Gustavo Padovand81a5d12012-07-10 19:10:06 -03001045/**
1046 * USB_VENDOR_AND_INTERFACE_INFO - describe a specific usb vendor with a class of usb interfaces
1047 * @vend: the 16 bit USB Vendor ID
1048 * @cl: bInterfaceClass value
1049 * @sc: bInterfaceSubClass value
1050 * @pr: bInterfaceProtocol value
1051 *
1052 * This macro is used to create a struct usb_device_id that matches a
1053 * specific vendor with a specific class of interfaces.
1054 *
1055 * This is especially useful when explicitly matching devices that have
1056 * vendor specific bDeviceClass values, but standards-compliant interfaces.
1057 */
1058#define USB_VENDOR_AND_INTERFACE_INFO(vend, cl, sc, pr) \
1059 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO \
1060 | USB_DEVICE_ID_MATCH_VENDOR, \
1061 .idVendor = (vend), \
1062 .bInterfaceClass = (cl), \
1063 .bInterfaceSubClass = (sc), \
1064 .bInterfaceProtocol = (pr)
1065
Alan Sternb724ae72005-10-24 15:36:00 -04001066/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +01001068/* Stuff for dynamic usb ids */
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -08001069struct usb_dynids {
1070 spinlock_t lock;
1071 struct list_head list;
1072};
1073
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +01001074struct usb_dynid {
1075 struct list_head node;
1076 struct usb_device_id id;
1077};
1078
1079extern ssize_t usb_store_new_id(struct usb_dynids *dynids,
Wolfram Sang2fc82c22014-01-10 19:36:42 +01001080 const struct usb_device_id *id_table,
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +01001081 struct device_driver *driver,
1082 const char *buf, size_t count);
1083
Bjørn Morkef206f32012-05-13 12:35:00 +02001084extern ssize_t usb_show_dynids(struct usb_dynids *dynids, char *buf);
1085
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086/**
Alan Stern8bb54ab2006-07-01 22:08:49 -04001087 * struct usbdrv_wrap - wrapper for driver-model structure
1088 * @driver: The driver-model core driver structure.
1089 * @for_devices: Non-zero for device drivers, 0 for interface drivers.
1090 */
1091struct usbdrv_wrap {
1092 struct device_driver driver;
1093 int for_devices;
1094};
1095
1096/**
1097 * struct usb_driver - identifies USB interface driver to usbcore
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098 * @name: The driver name should be unique among USB drivers,
1099 * and should normally be the same as the module name.
1100 * @probe: Called to see if the driver is willing to manage a particular
1101 * interface on a device. If it is, probe returns zero and uses
Oliver Neukum7ef4f062008-04-10 15:15:37 +02001102 * usb_set_intfdata() to associate driver-specific data with the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103 * interface. It may also use usb_set_interface() to specify the
1104 * appropriate altsetting. If unwilling to manage the interface,
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001105 * return -ENODEV, if genuine IO errors occurred, an appropriate
Oliver Neukum7ef4f062008-04-10 15:15:37 +02001106 * negative errno value.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107 * @disconnect: Called when the interface is no longer accessible, usually
1108 * because its device has been (or is being) disconnected or the
1109 * driver module is being unloaded.
Randy Dunlapa91be2a2010-10-25 15:04:13 -07001110 * @unlocked_ioctl: Used for drivers that want to talk to userspace through
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111 * the "usbfs" filesystem. This lets devices provide ways to
1112 * expose information to user space regardless of where they
1113 * do (or don't) show up otherwise in the filesystem.
Ming Lei303f0842013-03-15 12:08:53 +08001114 * @suspend: Called when the device is going to be suspended by the
1115 * system either from system sleep or runtime suspend context. The
1116 * return value will be ignored in system sleep context, so do NOT
1117 * try to continue using the device if suspend fails in this case.
1118 * Instead, let the resume or reset-resume routine recover from
1119 * the failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120 * @resume: Called when the device is being resumed by the system.
Alan Sternf07600c2007-05-30 15:38:16 -04001121 * @reset_resume: Called when the suspended device has been reset instead
1122 * of being resumed.
Alan Stern6498d9d2011-04-28 10:45:24 -04001123 * @pre_reset: Called by usb_reset_device() when the device is about to be
1124 * reset. This routine must not return until the driver has no active
1125 * URBs for the device, and no more URBs may be submitted until the
1126 * post_reset method is called.
Ming Lei742120c2008-06-18 22:00:29 +08001127 * @post_reset: Called by usb_reset_device() after the device
Oliver Neukum7ef4f062008-04-10 15:15:37 +02001128 * has been reset
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129 * @id_table: USB drivers use ID table to support hotplugging.
1130 * Export this with MODULE_DEVICE_TABLE(usb,...). This must be set
1131 * or your driver's probe function will never get called.
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -08001132 * @dynids: used internally to hold the list of dynamically added device
1133 * ids for this driver.
Alan Stern8bb54ab2006-07-01 22:08:49 -04001134 * @drvwrap: Driver-model core structure wrapper.
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -08001135 * @no_dynamic_id: if set to 1, the USB core will not allow dynamic ids to be
1136 * added to this driver by preventing the sysfs file from being created.
Alan Stern645daaa2006-08-30 15:47:02 -04001137 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
1138 * for interfaces bound to this driver.
Alan Stern9da82bd2008-05-08 11:54:37 -04001139 * @soft_unbind: if set to 1, the USB core will not kill URBs and disable
1140 * endpoints before calling the driver's disconnect method.
Alan Stern6fb650d2016-04-29 15:25:17 -04001141 * @disable_hub_initiated_lpm: if set to 1, the USB core will not allow hubs
Sarah Sharp8afa4082012-04-23 10:08:51 -07001142 * to initiate lower power link state transitions when an idle timeout
1143 * occurs. Device-initiated USB 3.0 link PM will still be allowed.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144 *
Alan Stern8bb54ab2006-07-01 22:08:49 -04001145 * USB interface drivers must provide a name, probe() and disconnect()
1146 * methods, and an id_table. Other driver fields are optional.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147 *
1148 * The id_table is used in hotplugging. It holds a set of descriptors,
1149 * and specialized data may be associated with each entry. That table
1150 * is used by both user and kernel mode hotplugging support.
1151 *
1152 * The probe() and disconnect() methods are called in a context where
1153 * they can sleep, but they should avoid abusing the privilege. Most
1154 * work to connect to a device should be done when the device is opened,
1155 * and undone at the last close. The disconnect code needs to address
1156 * concurrency issues with respect to open() and close() methods, as
1157 * well as forcing all pending I/O requests to complete (by unlinking
1158 * them as necessary, and blocking until the unlinks complete).
1159 */
1160struct usb_driver {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001161 const char *name;
1162
1163 int (*probe) (struct usb_interface *intf,
1164 const struct usb_device_id *id);
1165
1166 void (*disconnect) (struct usb_interface *intf);
1167
Andi Kleenc532b292010-06-01 23:04:41 +02001168 int (*unlocked_ioctl) (struct usb_interface *intf, unsigned int code,
Alan Sternb724ae72005-10-24 15:36:00 -04001169 void *buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170
David Brownell27d72e82005-04-18 17:39:22 -07001171 int (*suspend) (struct usb_interface *intf, pm_message_t message);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172 int (*resume) (struct usb_interface *intf);
Alan Sternf07600c2007-05-30 15:38:16 -04001173 int (*reset_resume)(struct usb_interface *intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174
Alan Sternf07600c2007-05-30 15:38:16 -04001175 int (*pre_reset)(struct usb_interface *intf);
1176 int (*post_reset)(struct usb_interface *intf);
Alan Stern79efa092006-06-01 13:33:42 -04001177
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178 const struct usb_device_id *id_table;
1179
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -08001180 struct usb_dynids dynids;
Alan Stern8bb54ab2006-07-01 22:08:49 -04001181 struct usbdrv_wrap drvwrap;
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -08001182 unsigned int no_dynamic_id:1;
Alan Stern645daaa2006-08-30 15:47:02 -04001183 unsigned int supports_autosuspend:1;
Sarah Sharp8afa4082012-04-23 10:08:51 -07001184 unsigned int disable_hub_initiated_lpm:1;
Alan Stern9da82bd2008-05-08 11:54:37 -04001185 unsigned int soft_unbind:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186};
Alan Stern8bb54ab2006-07-01 22:08:49 -04001187#define to_usb_driver(d) container_of(d, struct usb_driver, drvwrap.driver)
1188
1189/**
1190 * struct usb_device_driver - identifies USB device driver to usbcore
1191 * @name: The driver name should be unique among USB drivers,
1192 * and should normally be the same as the module name.
1193 * @probe: Called to see if the driver is willing to manage a particular
1194 * device. If it is, probe returns zero and uses dev_set_drvdata()
1195 * to associate driver-specific data with the device. If unwilling
1196 * to manage the device, return a negative errno value.
1197 * @disconnect: Called when the device is no longer accessible, usually
1198 * because it has been (or is being) disconnected or the driver's
1199 * module is being unloaded.
1200 * @suspend: Called when the device is going to be suspended by the system.
1201 * @resume: Called when the device is being resumed by the system.
1202 * @drvwrap: Driver-model core structure wrapper.
Alan Stern645daaa2006-08-30 15:47:02 -04001203 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
1204 * for devices bound to this driver.
Alan Stern8bb54ab2006-07-01 22:08:49 -04001205 *
1206 * USB drivers must provide all the fields listed above except drvwrap.
1207 */
1208struct usb_device_driver {
1209 const char *name;
1210
1211 int (*probe) (struct usb_device *udev);
1212 void (*disconnect) (struct usb_device *udev);
1213
1214 int (*suspend) (struct usb_device *udev, pm_message_t message);
Alan Stern65bfd292008-11-25 16:39:18 -05001215 int (*resume) (struct usb_device *udev, pm_message_t message);
Alan Stern8bb54ab2006-07-01 22:08:49 -04001216 struct usbdrv_wrap drvwrap;
Alan Stern645daaa2006-08-30 15:47:02 -04001217 unsigned int supports_autosuspend:1;
Alan Stern8bb54ab2006-07-01 22:08:49 -04001218};
1219#define to_usb_device_driver(d) container_of(d, struct usb_device_driver, \
1220 drvwrap.driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221
1222extern struct bus_type usb_bus_type;
1223
1224/**
1225 * struct usb_class_driver - identifies a USB driver that wants to use the USB major number
Greg Kroah-Hartmand6e5bcf2005-06-20 21:15:16 -07001226 * @name: the usb class device name for this driver. Will show up in sysfs.
Kay Sieverse454cea2009-09-18 23:01:12 +02001227 * @devnode: Callback to provide a naming hint for a possible
Randy Dunlape376bbb2009-06-18 10:39:11 -07001228 * device node to create.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229 * @fops: pointer to the struct file_operations of this driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230 * @minor_base: the start of the minor range for this driver.
1231 *
1232 * This structure is used for the usb_register_dev() and
Amitesh Singh864e2fe2016-09-30 22:40:57 +05301233 * usb_deregister_dev() functions, to consolidate a number of the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234 * parameters used for them.
1235 */
1236struct usb_class_driver {
1237 char *name;
Al Viro2c9ede52011-07-23 20:24:48 -04001238 char *(*devnode)(struct device *dev, umode_t *mode);
Arjan van de Ven99ac48f2006-03-28 01:56:41 -08001239 const struct file_operations *fops;
Greg Kroah-Hartmand6e5bcf2005-06-20 21:15:16 -07001240 int minor_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241};
1242
1243/*
1244 * use these in module_init()/module_exit()
1245 * and don't forget MODULE_DEVICE_TABLE(usb, ...)
1246 */
Greg Kroah-Hartman80f745f2007-01-15 11:50:02 -08001247extern int usb_register_driver(struct usb_driver *, struct module *,
1248 const char *);
Paul Gortmakereb5589a2011-05-27 09:02:11 -04001249
1250/* use a define to avoid include chaining to get THIS_MODULE & friends */
1251#define usb_register(driver) \
1252 usb_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
1253
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254extern void usb_deregister(struct usb_driver *);
1255
Greg Kroah-Hartmanf3a6a4b2011-11-17 14:38:33 -08001256/**
1257 * module_usb_driver() - Helper macro for registering a USB driver
1258 * @__usb_driver: usb_driver struct
1259 *
1260 * Helper macro for USB drivers which do not do anything special in module
1261 * init/exit. This eliminates a lot of boilerplate. Each module may only
1262 * use this macro once, and calling it replaces module_init() and module_exit()
1263 */
1264#define module_usb_driver(__usb_driver) \
1265 module_driver(__usb_driver, usb_register, \
1266 usb_deregister)
1267
Alan Stern8bb54ab2006-07-01 22:08:49 -04001268extern int usb_register_device_driver(struct usb_device_driver *,
1269 struct module *);
1270extern void usb_deregister_device_driver(struct usb_device_driver *);
1271
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272extern int usb_register_dev(struct usb_interface *intf,
1273 struct usb_class_driver *class_driver);
1274extern void usb_deregister_dev(struct usb_interface *intf,
1275 struct usb_class_driver *class_driver);
1276
1277extern int usb_disabled(void);
1278
Alan Sternb724ae72005-10-24 15:36:00 -04001279/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280
1281/*
1282 * URB support, for asynchronous request completions
1283 */
1284
1285/*
1286 * urb->transfer_flags:
Alan Sternfea34092007-07-30 17:06:16 -04001287 *
1288 * Note: URB_DIR_IN/OUT is automatically set in usb_submit_urb().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289 */
1290#define URB_SHORT_NOT_OK 0x0001 /* report short reads as errors */
Alan Sterna03bede2012-10-01 10:31:53 -04001291#define URB_ISO_ASAP 0x0002 /* iso-only; use the first unexpired
1292 * slot in the schedule */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293#define URB_NO_TRANSFER_DMA_MAP 0x0004 /* urb->transfer_dma valid on submit */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294#define URB_NO_FSBR 0x0020 /* UHCI-specific */
Alan Sternb724ae72005-10-24 15:36:00 -04001295#define URB_ZERO_PACKET 0x0040 /* Finish bulk OUT with short packet */
1296#define URB_NO_INTERRUPT 0x0080 /* HINT: no non-error interrupt
1297 * needed */
Marcel Holtmann8b3b01c2007-06-13 08:02:11 +02001298#define URB_FREE_BUFFER 0x0100 /* Free transfer buffer with the URB */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299
Alan Sternff9c8952010-04-02 13:27:28 -04001300/* The following flags are used internally by usbcore and HCDs */
Alan Sternfea34092007-07-30 17:06:16 -04001301#define URB_DIR_IN 0x0200 /* Transfer from device to host */
1302#define URB_DIR_OUT 0
1303#define URB_DIR_MASK URB_DIR_IN
1304
Alan Sternff9c8952010-04-02 13:27:28 -04001305#define URB_DMA_MAP_SINGLE 0x00010000 /* Non-scatter-gather mapping */
1306#define URB_DMA_MAP_PAGE 0x00020000 /* HCD-unsupported S-G */
1307#define URB_DMA_MAP_SG 0x00040000 /* HCD-supported S-G */
1308#define URB_MAP_LOCAL 0x00080000 /* HCD-local-memory mapping */
1309#define URB_SETUP_MAP_SINGLE 0x00100000 /* Setup packet DMA mapped */
1310#define URB_SETUP_MAP_LOCAL 0x00200000 /* HCD-local setup packet */
1311#define URB_DMA_SG_COMBINED 0x00400000 /* S-G entries were combined */
Robert Morell2694a482011-01-26 19:06:48 -08001312#define URB_ALIGNED_TEMP_BUFFER 0x00800000 /* Temp buffer was alloc'd */
Alan Sternff9c8952010-04-02 13:27:28 -04001313
Linus Torvalds1da177e2005-04-16 15:20:36 -07001314struct usb_iso_packet_descriptor {
1315 unsigned int offset;
1316 unsigned int length; /* expected length */
1317 unsigned int actual_length;
Pete Zaitcevd1bbb602007-02-11 13:56:13 -08001318 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319};
1320
1321struct urb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322
Oliver Neukum51a2f072007-05-25 13:40:56 +02001323struct usb_anchor {
1324 struct list_head urb_list;
1325 wait_queue_head_t wait;
1326 spinlock_t lock;
Hans de Goede6ec41472013-10-09 17:01:41 +02001327 atomic_t suspend_wakeups;
Oliver Neukum6a2839b2008-07-29 16:18:47 +02001328 unsigned int poisoned:1;
Oliver Neukum51a2f072007-05-25 13:40:56 +02001329};
1330
1331static inline void init_usb_anchor(struct usb_anchor *anchor)
1332{
Hans de Goede9ef73db2013-10-09 17:01:40 +02001333 memset(anchor, 0, sizeof(*anchor));
Oliver Neukum51a2f072007-05-25 13:40:56 +02001334 INIT_LIST_HEAD(&anchor->urb_list);
1335 init_waitqueue_head(&anchor->wait);
1336 spin_lock_init(&anchor->lock);
1337}
1338
David Howells7d12e782006-10-05 14:55:46 +01001339typedef void (*usb_complete_t)(struct urb *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340
1341/**
1342 * struct urb - USB Request Block
1343 * @urb_list: For use by current owner of the URB.
Oliver Neukum51a2f072007-05-25 13:40:56 +02001344 * @anchor_list: membership in the list of an anchor
1345 * @anchor: to anchor URBs to a common mooring
Alan Stern5b653c72007-07-30 17:04:37 -04001346 * @ep: Points to the endpoint's data structure. Will eventually
1347 * replace @pipe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348 * @pipe: Holds endpoint number, direction, type, and more.
1349 * Create these values with the eight macros available;
1350 * usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl"
1351 * (control), "bulk", "int" (interrupt), or "iso" (isochronous).
1352 * For example usb_sndbulkpipe() or usb_rcvintpipe(). Endpoint
1353 * numbers range from zero to fifteen. Note that "in" endpoint two
1354 * is a different endpoint (and pipe) from "out" endpoint two.
1355 * The current configuration controls the existence, type, and
1356 * maximum packet size of any given endpoint.
Randy Dunlapc6ba1c22010-07-29 15:54:38 -07001357 * @stream_id: the endpoint's stream ID for bulk streams
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 * @dev: Identifies the USB device to perform the request.
1359 * @status: This is read in non-iso completion functions to get the
1360 * status of the particular request. ISO requests only use it
1361 * to tell whether the URB was unlinked; detailed status for
1362 * each frame is in the fields of the iso_frame-desc.
1363 * @transfer_flags: A variety of flags may be used to affect how URB
1364 * submission, unlinking, or operation are handled. Different
1365 * kinds of URB can use different flags.
Pete Zaitcev4e9e9202009-06-11 08:53:20 -06001366 * @transfer_buffer: This identifies the buffer to (or from) which the I/O
1367 * request will be performed unless URB_NO_TRANSFER_DMA_MAP is set
1368 * (however, do not leave garbage in transfer_buffer even then).
1369 * This buffer must be suitable for DMA; allocate it with
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370 * kmalloc() or equivalent. For transfers to "in" endpoints, contents
1371 * of this buffer will be modified. This buffer is used for the data
1372 * stage of control transfers.
1373 * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP,
1374 * the device driver is saying that it provided this DMA address,
1375 * which the host controller driver should use in preference to the
1376 * transfer_buffer.
Ming Lei10e232c2013-06-28 09:38:12 +08001377 * @sg: scatter gather buffer list, the buffer size of each element in
1378 * the list (except the last) must be divisible by the endpoint's
Ming Leibcc48f12013-08-08 21:48:22 +08001379 * max packet size if no_sg_constraint isn't set in 'struct usb_bus'
Randy Dunlap4d922612012-01-21 11:02:56 -08001380 * @num_mapped_sgs: (internal) number of mapped sg entries
Randy Dunlape376bbb2009-06-18 10:39:11 -07001381 * @num_sgs: number of entries in the sg list
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382 * @transfer_buffer_length: How big is transfer_buffer. The transfer may
1383 * be broken up into chunks according to the current maximum packet
1384 * size for the endpoint, which is a function of the configuration
1385 * and is encoded in the pipe. When the length is zero, neither
1386 * transfer_buffer nor transfer_dma is used.
1387 * @actual_length: This is read in non-iso completion functions, and
1388 * it tells how many bytes (out of transfer_buffer_length) were
1389 * transferred. It will normally be the same as requested, unless
1390 * either an error was reported or a short read was performed.
1391 * The URB_SHORT_NOT_OK transfer flag may be used to make such
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001392 * short reads be reported as errors.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393 * @setup_packet: Only used for control transfers, this points to eight bytes
1394 * of setup data. Control transfers always start by sending this data
1395 * to the device. Then transfer_buffer is read or written, if needed.
Alan Stern85bcb5e2010-04-30 16:35:37 -04001396 * @setup_dma: DMA pointer for the setup packet. The caller must not use
1397 * this field; setup_packet must point to a valid buffer.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398 * @start_frame: Returns the initial frame for isochronous transfers.
1399 * @number_of_packets: Lists the number of ISO transfer buffers.
1400 * @interval: Specifies the polling interval for interrupt or isochronous
Anand Gadiyar411c9402009-07-07 15:24:23 +05301401 * transfers. The units are frames (milliseconds) for full and low
Matthew Wilcoxf09a15e2010-03-16 12:55:44 -07001402 * speed devices, and microframes (1/8 millisecond) for highspeed
1403 * and SuperSpeed devices.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404 * @error_count: Returns the number of ISO transfers that reported errors.
1405 * @context: For use in completion functions. This normally points to
1406 * request-specific driver context.
1407 * @complete: Completion handler. This URB is passed as the parameter to the
1408 * completion function. The completion function may then do what
1409 * it likes with the URB, including resubmitting or freeing it.
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001410 * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411 * collect the transfer status for each buffer.
1412 *
1413 * This structure identifies USB transfer requests. URBs must be allocated by
1414 * calling usb_alloc_urb() and freed with a call to usb_free_urb().
1415 * Initialization may be done using various usb_fill_*_urb() functions. URBs
1416 * are submitted using usb_submit_urb(), and pending requests may be canceled
1417 * using usb_unlink_urb() or usb_kill_urb().
1418 *
1419 * Data Transfer Buffers:
1420 *
1421 * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise
1422 * taken from the general page pool. That is provided by transfer_buffer
1423 * (control requests also use setup_packet), and host controller drivers
1424 * perform a dma mapping (and unmapping) for each buffer transferred. Those
1425 * mapping operations can be expensive on some platforms (perhaps using a dma
1426 * bounce buffer or talking to an IOMMU),
1427 * although they're cheap on commodity x86 and ppc hardware.
1428 *
Alan Stern85bcb5e2010-04-30 16:35:37 -04001429 * Alternatively, drivers may pass the URB_NO_TRANSFER_DMA_MAP transfer flag,
1430 * which tells the host controller driver that no such mapping is needed for
1431 * the transfer_buffer since
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432 * the device driver is DMA-aware. For example, a device driver might
Daniel Mack073900a2010-04-12 13:17:25 +02001433 * allocate a DMA buffer with usb_alloc_coherent() or call usb_buffer_map().
Alan Stern85bcb5e2010-04-30 16:35:37 -04001434 * When this transfer flag is provided, host controller drivers will
1435 * attempt to use the dma address found in the transfer_dma
1436 * field rather than determining a dma address themselves.
Pete Zaitcev4e9e9202009-06-11 08:53:20 -06001437 *
1438 * Note that transfer_buffer must still be set if the controller
1439 * does not support DMA (as indicated by bus.uses_dma) and when talking
1440 * to root hub. If you have to trasfer between highmem zone and the device
1441 * on such controller, create a bounce buffer or bail out with an error.
1442 * If transfer_buffer cannot be set (is in highmem) and the controller is DMA
1443 * capable, assign NULL to it, so that usbmon knows not to use the value.
1444 * The setup_packet must always be set, so it cannot be located in highmem.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445 *
1446 * Initialization:
1447 *
1448 * All URBs submitted must initialize the dev, pipe, transfer_flags (may be
Alan Sternb375a042005-07-29 16:11:07 -04001449 * zero), and complete fields. All URBs must also initialize
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450 * transfer_buffer and transfer_buffer_length. They may provide the
1451 * URB_SHORT_NOT_OK transfer flag, indicating that short reads are
1452 * to be treated as errors; that flag is invalid for write requests.
1453 *
1454 * Bulk URBs may
1455 * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers
1456 * should always terminate with a short packet, even if it means adding an
1457 * extra zero length packet.
1458 *
Alan Stern85bcb5e2010-04-30 16:35:37 -04001459 * Control URBs must provide a valid pointer in the setup_packet field.
1460 * Unlike the transfer_buffer, the setup_packet may not be mapped for DMA
1461 * beforehand.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462 *
1463 * Interrupt URBs must provide an interval, saying how often (in milliseconds
1464 * or, for highspeed devices, 125 microsecond units)
1465 * to poll for transfers. After the URB has been submitted, the interval
1466 * field reflects how the transfer was actually scheduled.
1467 * The polling interval may be more frequent than requested.
1468 * For example, some controllers have a maximum interval of 32 milliseconds,
1469 * while others support intervals of up to 1024 milliseconds.
1470 * Isochronous URBs also have transfer intervals. (Note that for isochronous
1471 * endpoints, as well as high speed interrupt endpoints, the encoding of
1472 * the transfer interval in the endpoint descriptor is logarithmic.
1473 * Device drivers must convert that value to linear units themselves.)
1474 *
Alan Sterna03bede2012-10-01 10:31:53 -04001475 * If an isochronous endpoint queue isn't already running, the host
1476 * controller will schedule a new URB to start as soon as bandwidth
1477 * utilization allows. If the queue is running then a new URB will be
1478 * scheduled to start in the first transfer slot following the end of the
1479 * preceding URB, if that slot has not already expired. If the slot has
1480 * expired (which can happen when IRQ delivery is delayed for a long time),
1481 * the scheduling behavior depends on the URB_ISO_ASAP flag. If the flag
1482 * is clear then the URB will be scheduled to start in the expired slot,
1483 * implying that some of its packets will not be transferred; if the flag
1484 * is set then the URB will be scheduled in the first unexpired slot,
1485 * breaking the queue's synchronization. Upon URB completion, the
1486 * start_frame field will be set to the (micro)frame number in which the
1487 * transfer was scheduled. Ranges for frame counter values are HC-specific
1488 * and can go from as low as 256 to as high as 65536 frames.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489 *
1490 * Isochronous URBs have a different data transfer model, in part because
1491 * the quality of service is only "best effort". Callers provide specially
1492 * allocated URBs, with number_of_packets worth of iso_frame_desc structures
1493 * at the end. Each such packet is an individual ISO transfer. Isochronous
1494 * URBs are normally queued, submitted by drivers to arrange that
1495 * transfers are at least double buffered, and then explicitly resubmitted
1496 * in completion handlers, so
1497 * that data (such as audio or video) streams at as constant a rate as the
1498 * host controller scheduler can support.
1499 *
1500 * Completion Callbacks:
1501 *
1502 * The completion callback is made in_interrupt(), and one of the first
1503 * things that a completion handler should do is check the status field.
1504 * The status field is provided for all URBs. It is used to report
1505 * unlinked URBs, and status for all non-ISO transfers. It should not
1506 * be examined before the URB is returned to the completion handler.
1507 *
1508 * The context field is normally used to link URBs back to the relevant
1509 * driver or request state.
1510 *
1511 * When the completion callback is invoked for non-isochronous URBs, the
1512 * actual_length field tells how many bytes were transferred. This field
1513 * is updated even when the URB terminated with an error or was unlinked.
1514 *
1515 * ISO transfer status is reported in the status and actual_length fields
1516 * of the iso_frame_desc array, and the number of errors is reported in
1517 * error_count. Completion callbacks for ISO transfers will normally
1518 * (re)submit URBs to ensure a constant transfer rate.
Roman Kagan719df462005-05-06 00:55:56 +04001519 *
1520 * Note that even fields marked "public" should not be touched by the driver
1521 * when the urb is owned by the hcd, that is, since the call to
1522 * usb_submit_urb() till the entry into the completion routine.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001524struct urb {
Martin Waitzaeec46b2005-11-13 16:08:13 -08001525 /* private: usb core and host controller only fields in the urb */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526 struct kref kref; /* reference count of the URB */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527 void *hcpriv; /* private data for host controller */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528 atomic_t use_count; /* concurrent submissions counter */
Ming Lei49367d82008-12-12 21:38:45 +08001529 atomic_t reject; /* submissions will fail */
Alan Sterneb231052007-08-21 15:40:36 -04001530 int unlinked; /* unlink error code */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531
Martin Waitzaeec46b2005-11-13 16:08:13 -08001532 /* public: documented fields in the urb that can be used by drivers */
Alan Sternb724ae72005-10-24 15:36:00 -04001533 struct list_head urb_list; /* list head for use by the urb's
1534 * current owner */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001535 struct list_head anchor_list; /* the URB may be anchored */
Oliver Neukum51a2f072007-05-25 13:40:56 +02001536 struct usb_anchor *anchor;
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -07001537 struct usb_device *dev; /* (in) pointer to associated device */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001538 struct usb_host_endpoint *ep; /* (internal) pointer to endpoint */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539 unsigned int pipe; /* (in) pipe information */
Sarah Sharp94af1222010-04-02 15:34:10 -07001540 unsigned int stream_id; /* (in) stream ID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541 int status; /* (return) non-ISO status */
1542 unsigned int transfer_flags; /* (in) URB_SHORT_NOT_OK | ...*/
1543 void *transfer_buffer; /* (in) associated data buffer */
1544 dma_addr_t transfer_dma; /* (in) dma addr for transfer_buffer */
Matthew Wilcox910f8d02010-05-01 12:20:01 -06001545 struct scatterlist *sg; /* (in) scatter gather buffer list */
Clemens Ladischbc677d52011-12-03 23:41:31 +01001546 int num_mapped_sgs; /* (internal) mapped sg entries */
Sarah Sharpe04748e2009-04-27 19:59:01 -07001547 int num_sgs; /* (in) number of entries in the sg list */
Greg Kroah-Hartman16e2e5f2009-03-03 16:44:13 -08001548 u32 transfer_buffer_length; /* (in) data buffer length */
Greg Kroah-Hartman8c209e62009-03-06 21:31:03 -08001549 u32 actual_length; /* (return) actual transfer length */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550 unsigned char *setup_packet; /* (in) setup packet (control only) */
1551 dma_addr_t setup_dma; /* (in) dma addr for setup_packet */
1552 int start_frame; /* (modify) start frame (ISO) */
1553 int number_of_packets; /* (in) number of ISO packets */
Alan Sternb724ae72005-10-24 15:36:00 -04001554 int interval; /* (modify) transfer interval
1555 * (INT/ISO) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556 int error_count; /* (return) number of ISO errors */
1557 void *context; /* (in) context for completion */
1558 usb_complete_t complete; /* (in) completion routine */
Alan Sternb724ae72005-10-24 15:36:00 -04001559 struct usb_iso_packet_descriptor iso_frame_desc[0];
1560 /* (in) ISO ONLY */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561};
1562
Alan Sternb724ae72005-10-24 15:36:00 -04001563/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564
1565/**
1566 * usb_fill_control_urb - initializes a control urb
1567 * @urb: pointer to the urb to initialize.
1568 * @dev: pointer to the struct usb_device for this urb.
1569 * @pipe: the endpoint pipe
1570 * @setup_packet: pointer to the setup_packet buffer
1571 * @transfer_buffer: pointer to the transfer buffer
1572 * @buffer_length: length of the transfer buffer
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001573 * @complete_fn: pointer to the usb_complete_t function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574 * @context: what to set the urb context to.
1575 *
1576 * Initializes a control urb with the proper information needed to submit
1577 * it to a device.
1578 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001579static inline void usb_fill_control_urb(struct urb *urb,
1580 struct usb_device *dev,
1581 unsigned int pipe,
1582 unsigned char *setup_packet,
1583 void *transfer_buffer,
1584 int buffer_length,
1585 usb_complete_t complete_fn,
1586 void *context)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 urb->dev = dev;
1589 urb->pipe = pipe;
1590 urb->setup_packet = setup_packet;
1591 urb->transfer_buffer = transfer_buffer;
1592 urb->transfer_buffer_length = buffer_length;
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001593 urb->complete = complete_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594 urb->context = context;
1595}
1596
1597/**
1598 * usb_fill_bulk_urb - macro to help initialize a bulk urb
1599 * @urb: pointer to the urb to initialize.
1600 * @dev: pointer to the struct usb_device for this urb.
1601 * @pipe: the endpoint pipe
1602 * @transfer_buffer: pointer to the transfer buffer
1603 * @buffer_length: length of the transfer buffer
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001604 * @complete_fn: pointer to the usb_complete_t function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605 * @context: what to set the urb context to.
1606 *
1607 * Initializes a bulk urb with the proper information needed to submit it
1608 * to a device.
1609 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001610static inline void usb_fill_bulk_urb(struct urb *urb,
1611 struct usb_device *dev,
1612 unsigned int pipe,
1613 void *transfer_buffer,
1614 int buffer_length,
1615 usb_complete_t complete_fn,
1616 void *context)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 urb->dev = dev;
1619 urb->pipe = pipe;
1620 urb->transfer_buffer = transfer_buffer;
1621 urb->transfer_buffer_length = buffer_length;
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001622 urb->complete = complete_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623 urb->context = context;
1624}
1625
1626/**
1627 * usb_fill_int_urb - macro to help initialize a interrupt urb
1628 * @urb: pointer to the urb to initialize.
1629 * @dev: pointer to the struct usb_device for this urb.
1630 * @pipe: the endpoint pipe
1631 * @transfer_buffer: pointer to the transfer buffer
1632 * @buffer_length: length of the transfer buffer
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001633 * @complete_fn: pointer to the usb_complete_t function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634 * @context: what to set the urb context to.
1635 * @interval: what to set the urb interval to, encoded like
1636 * the endpoint descriptor's bInterval value.
1637 *
1638 * Initializes a interrupt urb with the proper information needed to submit
1639 * it to a device.
Matthew Wilcoxf09a15e2010-03-16 12:55:44 -07001640 *
Oliver Neukumfca504f2016-04-20 15:39:12 +02001641 * Note that High Speed and SuperSpeed(+) interrupt endpoints use a logarithmic
Matthew Wilcoxf09a15e2010-03-16 12:55:44 -07001642 * encoding of the endpoint interval, and express polling intervals in
1643 * microframes (eight per millisecond) rather than in frames (one per
1644 * millisecond).
1645 *
1646 * Wireless USB also uses the logarithmic encoding, but specifies it in units of
1647 * 128us instead of 125us. For Wireless USB devices, the interval is passed
1648 * through to the host controller, rather than being translated into microframe
1649 * units.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001651static inline void usb_fill_int_urb(struct urb *urb,
1652 struct usb_device *dev,
1653 unsigned int pipe,
1654 void *transfer_buffer,
1655 int buffer_length,
1656 usb_complete_t complete_fn,
1657 void *context,
1658 int interval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660 urb->dev = dev;
1661 urb->pipe = pipe;
1662 urb->transfer_buffer = transfer_buffer;
1663 urb->transfer_buffer_length = buffer_length;
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001664 urb->complete = complete_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665 urb->context = context;
Felipe Balbi42189d82013-07-02 10:50:15 +03001666
Oliver Neukumfca504f2016-04-20 15:39:12 +02001667 if (dev->speed == USB_SPEED_HIGH || dev->speed >= USB_SPEED_SUPER) {
Felipe Balbi42189d82013-07-02 10:50:15 +03001668 /* make sure interval is within allowed range */
1669 interval = clamp(interval, 1, 16);
1670
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671 urb->interval = 1 << (interval - 1);
Felipe Balbi42189d82013-07-02 10:50:15 +03001672 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673 urb->interval = interval;
Felipe Balbi42189d82013-07-02 10:50:15 +03001674 }
1675
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676 urb->start_frame = -1;
1677}
1678
1679extern void usb_init_urb(struct urb *urb);
Al Viro55016f12005-10-21 03:21:58 -04001680extern struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681extern void usb_free_urb(struct urb *urb);
1682#define usb_put_urb usb_free_urb
1683extern struct urb *usb_get_urb(struct urb *urb);
Al Viro55016f12005-10-21 03:21:58 -04001684extern int usb_submit_urb(struct urb *urb, gfp_t mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685extern int usb_unlink_urb(struct urb *urb);
1686extern void usb_kill_urb(struct urb *urb);
Oliver Neukum55b447b2008-07-29 15:26:15 +02001687extern void usb_poison_urb(struct urb *urb);
1688extern void usb_unpoison_urb(struct urb *urb);
Oliver Neukum8815bb02012-04-30 09:13:46 +02001689extern void usb_block_urb(struct urb *urb);
Oliver Neukum51a2f072007-05-25 13:40:56 +02001690extern void usb_kill_anchored_urbs(struct usb_anchor *anchor);
Oliver Neukum6a2839b2008-07-29 16:18:47 +02001691extern void usb_poison_anchored_urbs(struct usb_anchor *anchor);
Oliver Neukum856395d2008-12-18 09:17:49 +01001692extern void usb_unpoison_anchored_urbs(struct usb_anchor *anchor);
Oliver Neukumeda76952008-04-10 14:07:37 +02001693extern void usb_unlink_anchored_urbs(struct usb_anchor *anchor);
Hans de Goede6ec41472013-10-09 17:01:41 +02001694extern void usb_anchor_suspend_wakeups(struct usb_anchor *anchor);
1695extern void usb_anchor_resume_wakeups(struct usb_anchor *anchor);
Oliver Neukum51a2f072007-05-25 13:40:56 +02001696extern void usb_anchor_urb(struct urb *urb, struct usb_anchor *anchor);
1697extern void usb_unanchor_urb(struct urb *urb);
1698extern int usb_wait_anchor_empty_timeout(struct usb_anchor *anchor,
1699 unsigned int timeout);
Oliver Neukum19876252008-08-25 22:40:25 +02001700extern struct urb *usb_get_from_anchor(struct usb_anchor *anchor);
1701extern void usb_scuttle_anchored_urbs(struct usb_anchor *anchor);
1702extern int usb_anchor_empty(struct usb_anchor *anchor);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703
Oliver Neukum8815bb02012-04-30 09:13:46 +02001704#define usb_unblock_urb usb_unpoison_urb
1705
Alan Sternfea34092007-07-30 17:06:16 -04001706/**
1707 * usb_urb_dir_in - check if an URB describes an IN transfer
1708 * @urb: URB to be checked
1709 *
Yacine Belkadi626f0902013-08-02 20:10:04 +02001710 * Return: 1 if @urb describes an IN transfer (device-to-host),
Alan Sternfea34092007-07-30 17:06:16 -04001711 * otherwise 0.
1712 */
1713static inline int usb_urb_dir_in(struct urb *urb)
1714{
Alan Sternd617bc82007-08-02 15:04:52 -04001715 return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_IN;
Alan Sternfea34092007-07-30 17:06:16 -04001716}
1717
1718/**
1719 * usb_urb_dir_out - check if an URB describes an OUT transfer
1720 * @urb: URB to be checked
1721 *
Yacine Belkadi626f0902013-08-02 20:10:04 +02001722 * Return: 1 if @urb describes an OUT transfer (host-to-device),
Alan Sternfea34092007-07-30 17:06:16 -04001723 * otherwise 0.
1724 */
1725static inline int usb_urb_dir_out(struct urb *urb)
1726{
1727 return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_OUT;
1728}
1729
Takashi Iwaiebf7d032017-10-04 16:15:59 +02001730int usb_urb_ep_type_check(const struct urb *urb);
1731
Daniel Mack073900a2010-04-12 13:17:25 +02001732void *usb_alloc_coherent(struct usb_device *dev, size_t size,
Al Viro55016f12005-10-21 03:21:58 -04001733 gfp_t mem_flags, dma_addr_t *dma);
Daniel Mack073900a2010-04-12 13:17:25 +02001734void usb_free_coherent(struct usb_device *dev, size_t size,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001735 void *addr, dma_addr_t dma);
1736
1737#if 0
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001738struct urb *usb_buffer_map(struct urb *urb);
1739void usb_buffer_dmasync(struct urb *urb);
1740void usb_buffer_unmap(struct urb *urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741#endif
1742
1743struct scatterlist;
Alan Stern5e60a162007-07-30 17:07:21 -04001744int usb_buffer_map_sg(const struct usb_device *dev, int is_in,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -03001745 struct scatterlist *sg, int nents);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746#if 0
Alan Stern5e60a162007-07-30 17:07:21 -04001747void usb_buffer_dmasync_sg(const struct usb_device *dev, int is_in,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -03001748 struct scatterlist *sg, int n_hw_ents);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001749#endif
Alan Stern5e60a162007-07-30 17:07:21 -04001750void usb_buffer_unmap_sg(const struct usb_device *dev, int is_in,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -03001751 struct scatterlist *sg, int n_hw_ents);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001752
1753/*-------------------------------------------------------------------*
1754 * SYNCHRONOUS CALL SUPPORT *
1755 *-------------------------------------------------------------------*/
1756
1757extern int usb_control_msg(struct usb_device *dev, unsigned int pipe,
1758 __u8 request, __u8 requesttype, __u16 value, __u16 index,
1759 void *data, __u16 size, int timeout);
Greg Kroah-Hartman782a7a62006-05-19 13:20:20 -07001760extern int usb_interrupt_msg(struct usb_device *usb_dev, unsigned int pipe,
1761 void *data, int len, int *actual_length, int timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762extern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,
1763 void *data, int len, int *actual_length,
1764 int timeout);
1765
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766/* wrappers around usb_control_msg() for the most common standard requests */
1767extern int usb_get_descriptor(struct usb_device *dev, unsigned char desctype,
1768 unsigned char descindex, void *buf, int size);
1769extern int usb_get_status(struct usb_device *dev,
1770 int type, int target, void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771extern int usb_string(struct usb_device *dev, int index,
1772 char *buf, size_t size);
1773
1774/* wrappers that also update important state inside usbcore */
1775extern int usb_clear_halt(struct usb_device *dev, int pipe);
1776extern int usb_reset_configuration(struct usb_device *dev);
1777extern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate);
David Vrabel3444b262009-04-08 17:36:28 +00001778extern void usb_reset_endpoint(struct usb_device *dev, unsigned int epaddr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779
Alan Stern088dc272006-08-21 12:08:19 -04001780/* this request isn't really synchronous, but it belongs with the others */
1781extern int usb_driver_set_configuration(struct usb_device *udev, int config);
1782
Valentina Maneab7945b72014-01-23 23:12:29 +02001783/* choose and set configuration for device */
1784extern int usb_choose_configuration(struct usb_device *udev);
1785extern int usb_set_configuration(struct usb_device *dev, int configuration);
1786
Linus Torvalds1da177e2005-04-16 15:20:36 -07001787/*
1788 * timeouts, in milliseconds, used for sending/receiving control messages
1789 * they typically complete within a few frames (msec) after they're issued
1790 * USB identifies 5 second timeouts, maybe more in a few cases, and a few
1791 * slow devices (like some MGE Ellipse UPSes) actually push that limit.
1792 */
1793#define USB_CTRL_GET_TIMEOUT 5000
1794#define USB_CTRL_SET_TIMEOUT 5000
1795
1796
1797/**
1798 * struct usb_sg_request - support for scatter/gather I/O
1799 * @status: zero indicates success, else negative errno
1800 * @bytes: counts bytes transferred.
1801 *
1802 * These requests are initialized using usb_sg_init(), and then are used
1803 * as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most
1804 * members of the request object aren't for driver access.
1805 *
1806 * The status and bytecount values are valid only after usb_sg_wait()
1807 * returns. If the status is zero, then the bytecount matches the total
1808 * from the request.
1809 *
1810 * After an error completion, drivers may need to clear a halt condition
1811 * on the endpoint.
1812 */
1813struct usb_sg_request {
1814 int status;
1815 size_t bytes;
1816
Randy Dunlapbf92c192009-04-29 21:02:49 -07001817 /* private:
1818 * members below are private to usbcore,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819 * and are not provided for driver access!
1820 */
1821 spinlock_t lock;
1822
1823 struct usb_device *dev;
1824 int pipe;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001825
1826 int entries;
1827 struct urb **urbs;
1828
1829 int count;
1830 struct completion complete;
1831};
1832
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001833int usb_sg_init(
Linus Torvalds1da177e2005-04-16 15:20:36 -07001834 struct usb_sg_request *io,
1835 struct usb_device *dev,
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001836 unsigned pipe,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001837 unsigned period,
1838 struct scatterlist *sg,
1839 int nents,
1840 size_t length,
Al Viro55016f12005-10-21 03:21:58 -04001841 gfp_t mem_flags
Linus Torvalds1da177e2005-04-16 15:20:36 -07001842);
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001843void usb_sg_cancel(struct usb_sg_request *io);
1844void usb_sg_wait(struct usb_sg_request *io);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845
1846
Alan Sternb724ae72005-10-24 15:36:00 -04001847/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001848
1849/*
1850 * For various legacy reasons, Linux has a small cookie that's paired with
1851 * a struct usb_device to identify an endpoint queue. Queue characteristics
1852 * are defined by the endpoint's descriptor. This cookie is called a "pipe",
1853 * an unsigned int encoded as:
1854 *
1855 * - direction: bit 7 (0 = Host-to-Device [Out],
1856 * 1 = Device-to-Host [In] ...
1857 * like endpoint bEndpointAddress)
1858 * - device address: bits 8-14 ... bit positions known to uhci-hcd
1859 * - endpoint: bits 15-18 ... bit positions known to uhci-hcd
1860 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
1861 * 10 = control, 11 = bulk)
1862 *
1863 * Given the device address and endpoint descriptor, pipes are redundant.
1864 */
1865
1866/* NOTE: these are not the standard USB_ENDPOINT_XFER_* values!! */
1867/* (yet ... they're the values used by usbfs) */
1868#define PIPE_ISOCHRONOUS 0
1869#define PIPE_INTERRUPT 1
1870#define PIPE_CONTROL 2
1871#define PIPE_BULK 3
1872
1873#define usb_pipein(pipe) ((pipe) & USB_DIR_IN)
1874#define usb_pipeout(pipe) (!usb_pipein(pipe))
1875
1876#define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
1877#define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
1878
1879#define usb_pipetype(pipe) (((pipe) >> 30) & 3)
1880#define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
1881#define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
1882#define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
1883#define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
1884
Alan Sternb724ae72005-10-24 15:36:00 -04001885static inline unsigned int __create_pipe(struct usb_device *dev,
1886 unsigned int endpoint)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001887{
1888 return (dev->devnum << 8) | (endpoint << 15);
1889}
1890
1891/* Create various pipes... */
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -07001892#define usb_sndctrlpipe(dev, endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001893 ((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint))
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -07001894#define usb_rcvctrlpipe(dev, endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001895 ((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -07001896#define usb_sndisocpipe(dev, endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001897 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint))
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -07001898#define usb_rcvisocpipe(dev, endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001899 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -07001900#define usb_sndbulkpipe(dev, endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001901 ((PIPE_BULK << 30) | __create_pipe(dev, endpoint))
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -07001902#define usb_rcvbulkpipe(dev, endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001903 ((PIPE_BULK << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -07001904#define usb_sndintpipe(dev, endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001905 ((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint))
Greg Kroah-Hartman812219a2010-05-17 10:40:55 -07001906#define usb_rcvintpipe(dev, endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001907 ((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908
Matthew Wilcoxfe54b052010-04-30 13:11:29 -06001909static inline struct usb_host_endpoint *
1910usb_pipe_endpoint(struct usb_device *dev, unsigned int pipe)
1911{
1912 struct usb_host_endpoint **eps;
1913 eps = usb_pipein(pipe) ? dev->ep_in : dev->ep_out;
1914 return eps[usb_pipeendpoint(pipe)];
1915}
1916
Linus Torvalds1da177e2005-04-16 15:20:36 -07001917/*-------------------------------------------------------------------------*/
1918
1919static inline __u16
1920usb_maxpacket(struct usb_device *udev, int pipe, int is_out)
1921{
1922 struct usb_host_endpoint *ep;
1923 unsigned epnum = usb_pipeendpoint(pipe);
1924
1925 if (is_out) {
1926 WARN_ON(usb_pipein(pipe));
1927 ep = udev->ep_out[epnum];
1928 } else {
1929 WARN_ON(usb_pipeout(pipe));
1930 ep = udev->ep_in[epnum];
1931 }
1932 if (!ep)
1933 return 0;
1934
1935 /* NOTE: only 0x07ff bits are for packet size... */
Kuninori Morimoto29cc8892011-08-23 03:12:03 -07001936 return usb_endpoint_maxp(&ep->desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001937}
1938
Alan Sternb724ae72005-10-24 15:36:00 -04001939/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940
Johan Hovold2c4d6bf2011-11-10 14:58:26 +01001941/* translate USB error codes to codes user space understands */
1942static inline int usb_translate_errors(int error_code)
1943{
1944 switch (error_code) {
1945 case 0:
1946 case -ENOMEM:
1947 case -ENODEV:
Johan Hovold67c88382012-03-26 21:01:50 +02001948 case -EOPNOTSUPP:
Johan Hovold2c4d6bf2011-11-10 14:58:26 +01001949 return error_code;
1950 default:
1951 return -EIO;
1952 }
1953}
1954
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -07001955/* Events from the usb core */
1956#define USB_DEVICE_ADD 0x0001
1957#define USB_DEVICE_REMOVE 0x0002
1958#define USB_BUS_ADD 0x0003
1959#define USB_BUS_REMOVE 0x0004
1960extern void usb_register_notify(struct notifier_block *nb);
1961extern void usb_unregister_notify(struct notifier_block *nb);
1962
Greg Kroah-Hartman00048b82009-04-24 14:56:26 -07001963/* debugfs stuff */
1964extern struct dentry *usb_debug_root;
1965
Michal Sojka0cfbd322014-09-24 22:43:21 +02001966/* LED triggers */
1967enum usb_led_event {
1968 USB_LED_EVENT_HOST = 0,
1969 USB_LED_EVENT_GADGET = 1,
1970};
1971
1972#ifdef CONFIG_USB_LED_TRIG
1973extern void usb_led_activity(enum usb_led_event ev);
1974#else
1975static inline void usb_led_activity(enum usb_led_event ev) {}
1976#endif
1977
Linus Torvalds1da177e2005-04-16 15:20:36 -07001978#endif /* __KERNEL__ */
1979
1980#endif