blob: 739f1fd1cc15187a40868ea0cb6c32e888fe8bea [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef __LINUX_USB_H
2#define __LINUX_USB_H
3
4#include <linux/mod_devicetable.h>
David Brownell5f848132006-12-16 15:34:53 -08005#include <linux/usb/ch9.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006
7#define USB_MAJOR 180
Kay Sieversfbf82fd2005-07-31 01:05:53 +02008#define USB_DEVICE_MAJOR 189
Linus Torvalds1da177e2005-04-16 15:20:36 -07009
10
11#ifdef __KERNEL__
12
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/errno.h> /* for -ENODEV */
14#include <linux/delay.h> /* for mdelay() */
15#include <linux/interrupt.h> /* for in_interrupt() */
16#include <linux/list.h> /* for struct list_head */
17#include <linux/kref.h> /* for struct kref */
18#include <linux/device.h> /* for struct device */
19#include <linux/fs.h> /* for struct file_operations */
20#include <linux/completion.h> /* for struct completion */
21#include <linux/sched.h> /* for current && schedule_timeout */
Alan Stern645daaa2006-08-30 15:47:02 -040022#include <linux/mutex.h> /* for struct mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
24struct usb_device;
25struct usb_driver;
Inaky Perez-Gonzalezb1d8dfb2008-04-08 13:24:46 -070026struct wusb_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070027
28/*-------------------------------------------------------------------------*/
29
30/*
31 * Host-side wrappers for standard USB descriptors ... these are parsed
32 * from the data provided by devices. Parsing turns them from a flat
33 * sequence of descriptors into a hierarchy:
34 *
35 * - devices have one (usually) or more configs;
36 * - configs have one (often) or more interfaces;
37 * - interfaces have one (usually) or more settings;
38 * - each interface setting has zero or (usually) more endpoints.
Sarah Sharp663c30d2009-04-27 19:58:14 -070039 * - a SuperSpeed endpoint has a companion descriptor
Linus Torvalds1da177e2005-04-16 15:20:36 -070040 *
41 * And there might be other descriptors mixed in with those.
42 *
43 * Devices may also have class-specific or vendor-specific descriptors.
44 */
45
Greg Kroah-Hartman9bde7492006-06-14 12:14:34 -070046struct ep_device;
47
Sarah Sharp663c30d2009-04-27 19:58:14 -070048/* For SS devices */
49/**
Sarah Sharpf0058c62009-04-29 19:06:20 -070050 * struct usb_host_ss_ep_comp - Valid for SuperSpeed devices only
Sarah Sharp663c30d2009-04-27 19:58:14 -070051 * @desc: endpoint companion descriptor, wMaxPacketSize in native byteorder
52 * @extra: descriptors following this endpoint companion descriptor
53 * @extralen: how many bytes of "extra" are valid
54 */
Sarah Sharpf0058c62009-04-29 19:06:20 -070055struct usb_host_ss_ep_comp {
56 struct usb_ss_ep_comp_descriptor desc;
57 unsigned char *extra; /* Extra descriptors */
58 int extralen;
Sarah Sharp663c30d2009-04-27 19:58:14 -070059};
60
Linus Torvalds1da177e2005-04-16 15:20:36 -070061/**
62 * struct usb_host_endpoint - host-side endpoint descriptor and queue
63 * @desc: descriptor for this endpoint, wMaxPacketSize in native byteorder
64 * @urb_list: urbs queued to this endpoint; maintained by usbcore
65 * @hcpriv: for use by HCD; typically holds hardware dma queue head (QH)
66 * with one or more transfer descriptors (TDs) per urb
Randy Dunlap7fac9a32006-06-22 15:12:41 -070067 * @ep_dev: ep_device for sysfs info
Sarah Sharpf0058c62009-04-29 19:06:20 -070068 * @ss_ep_comp: companion descriptor information for this endpoint
Linus Torvalds1da177e2005-04-16 15:20:36 -070069 * @extra: descriptors following this endpoint in the configuration
70 * @extralen: how many bytes of "extra" are valid
Alan Sternbdd016b2007-07-30 17:05:22 -040071 * @enabled: URBs may be submitted to this endpoint
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 *
73 * USB requests are always queued to a given endpoint, identified by a
74 * descriptor within an active interface in a given USB configuration.
75 */
76struct usb_host_endpoint {
77 struct usb_endpoint_descriptor desc;
78 struct list_head urb_list;
79 void *hcpriv;
Greg Kroah-Hartman9bde7492006-06-14 12:14:34 -070080 struct ep_device *ep_dev; /* For sysfs info */
Sarah Sharpf0058c62009-04-29 19:06:20 -070081 struct usb_host_ss_ep_comp *ss_ep_comp; /* For SS devices */
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
83 unsigned char *extra; /* Extra descriptors */
84 int extralen;
Alan Sternbdd016b2007-07-30 17:05:22 -040085 int enabled;
Linus Torvalds1da177e2005-04-16 15:20:36 -070086};
87
88/* host-side wrapper for one interface setting's parsed descriptors */
89struct usb_host_interface {
90 struct usb_interface_descriptor desc;
91
92 /* array of desc.bNumEndpoint endpoints associated with this
93 * interface setting. these will be in no particular order.
94 */
95 struct usb_host_endpoint *endpoint;
96
97 char *string; /* iInterface string, if present */
98 unsigned char *extra; /* Extra descriptors */
99 int extralen;
100};
101
102enum usb_interface_condition {
103 USB_INTERFACE_UNBOUND = 0,
104 USB_INTERFACE_BINDING,
105 USB_INTERFACE_BOUND,
106 USB_INTERFACE_UNBINDING,
107};
108
109/**
110 * struct usb_interface - what usb device drivers talk to
111 * @altsetting: array of interface structures, one for each alternate
112 * setting that may be selected. Each one includes a set of
113 * endpoint configurations. They will be in no particular order.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 * @cur_altsetting: the current altsetting.
Lei Mingd6d914f2008-02-25 18:07:28 +0800115 * @num_altsetting: number of altsettings defined.
Randy Dunlap3f423782007-07-19 10:21:37 -0700116 * @intf_assoc: interface association descriptor
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 * @minor: the minor number assigned to this interface, if this
118 * interface is bound to a driver that uses the USB major number.
119 * If this interface does not use the USB major, this field should
120 * be unused. The driver should set this value in the probe()
121 * function of the driver, after it has been assigned a minor
122 * number from the USB core by calling usb_register_dev().
123 * @condition: binding state of the interface: not bound, binding
124 * (in probe()), bound to a driver, or unbinding (in disconnect())
Randy Dunlapf88ed902007-12-03 14:14:16 -0800125 * @sysfs_files_created: sysfs attributes exist
Alan Stern3b23dd62008-12-05 14:10:34 -0500126 * @ep_devs_created: endpoint child pseudo-devices exist
Alan Stern352d0262008-10-29 15:16:58 -0400127 * @unregistering: flag set when the interface is being unregistered
Alan Stern645daaa2006-08-30 15:47:02 -0400128 * @needs_remote_wakeup: flag set when the driver requires remote-wakeup
129 * capability during autosuspend.
Alan Stern55151d72008-08-12 14:33:59 -0400130 * @needs_altsetting0: flag set when a set-interface request for altsetting 0
131 * has been deferred.
Alan Sternf4f4d582008-07-28 10:39:28 -0400132 * @needs_binding: flag set when the driver should be re-probed or unbound
133 * following a reset or suspend operation it doesn't support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 * @dev: driver model's view of this device
Greg Kroah-Hartman0873c762006-06-20 13:09:50 -0700135 * @usb_dev: if an interface is bound to the USB major, this will point
136 * to the sysfs representation for that device.
Alan Stern9bbdf1e2010-01-08 12:57:28 -0500137 * @pm_usage_cnt: PM usage counter for this interface
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -0800138 * @reset_ws: Used for scheduling resets from atomic context.
139 * @reset_running: set to 1 if the interface is currently running a
140 * queued reset so that usb_cancel_queued_reset() doesn't try to
141 * remove from the workqueue when running inside the worker
142 * thread. See __usb_queue_reset_device().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 *
144 * USB device drivers attach to interfaces on a physical device. Each
145 * interface encapsulates a single high level function, such as feeding
146 * an audio stream to a speaker or reporting a change in a volume control.
147 * Many USB devices only have one interface. The protocol used to talk to
148 * an interface's endpoints can be defined in a usb "class" specification,
149 * or by a product's vendor. The (default) control endpoint is part of
150 * every interface, but is never listed among the interface's descriptors.
151 *
152 * The driver that is bound to the interface can use standard driver model
153 * calls such as dev_get_drvdata() on the dev member of this structure.
154 *
155 * Each interface may have alternate settings. The initial configuration
156 * of a device sets altsetting 0, but the device driver can change
157 * that setting using usb_set_interface(). Alternate settings are often
Michael Opdenacker59c51592007-05-09 08:57:56 +0200158 * used to control the use of periodic endpoints, such as by having
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 * different endpoints use different amounts of reserved USB bandwidth.
160 * All standards-conformant USB devices that use isochronous endpoints
161 * will use them in non-default settings.
162 *
163 * The USB specification says that alternate setting numbers must run from
164 * 0 to one less than the total number of alternate settings. But some
165 * devices manage to mess this up, and the structures aren't necessarily
166 * stored in numerical order anyhow. Use usb_altnum_to_altsetting() to
167 * look up an alternate setting in the altsetting array based on its number.
168 */
169struct usb_interface {
170 /* array of alternate settings for this interface,
171 * stored in no particular order */
172 struct usb_host_interface *altsetting;
173
174 struct usb_host_interface *cur_altsetting; /* the currently
175 * active alternate setting */
176 unsigned num_altsetting; /* number of alternate settings */
177
Craig W. Nadler165fe972007-06-15 23:14:35 -0400178 /* If there is an interface association descriptor then it will list
179 * the associated interfaces */
180 struct usb_interface_assoc_descriptor *intf_assoc;
181
Alan Sternb724ae72005-10-24 15:36:00 -0400182 int minor; /* minor number this interface is
183 * bound to */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 enum usb_interface_condition condition; /* state of binding */
Alan Stern7e615592007-11-06 11:43:42 -0500185 unsigned sysfs_files_created:1; /* the sysfs attributes exist */
Alan Stern3b23dd62008-12-05 14:10:34 -0500186 unsigned ep_devs_created:1; /* endpoint "devices" exist */
Alan Stern352d0262008-10-29 15:16:58 -0400187 unsigned unregistering:1; /* unregistration is in progress */
Alan Stern645daaa2006-08-30 15:47:02 -0400188 unsigned needs_remote_wakeup:1; /* driver requires remote wakeup */
Alan Stern55151d72008-08-12 14:33:59 -0400189 unsigned needs_altsetting0:1; /* switch to altsetting 0 is pending */
Alan Stern78d9a482008-06-23 16:00:40 -0400190 unsigned needs_binding:1; /* needs delayed unbind/rebind */
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -0800191 unsigned reset_running:1;
Sarah Sharp04a723e2010-01-06 10:16:51 -0800192 unsigned resetting_device:1; /* true: bandwidth alloc after reset */
Alan Stern4d064c02006-07-01 22:11:44 -0400193
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 struct device dev; /* interface specific device info */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800195 struct device *usb_dev;
Alan Sternccf5b802009-06-29 11:00:01 -0400196 atomic_t pm_usage_cnt; /* usage counter for autosuspend */
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -0800197 struct work_struct reset_ws; /* for resets in atomic context */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198};
199#define to_usb_interface(d) container_of(d, struct usb_interface, dev)
200#define interface_to_usbdev(intf) \
201 container_of(intf->dev.parent, struct usb_device, dev)
202
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800203static inline void *usb_get_intfdata(struct usb_interface *intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204{
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800205 return dev_get_drvdata(&intf->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206}
207
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800208static inline void usb_set_intfdata(struct usb_interface *intf, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209{
210 dev_set_drvdata(&intf->dev, data);
211}
212
213struct usb_interface *usb_get_intf(struct usb_interface *intf);
214void usb_put_intf(struct usb_interface *intf);
215
216/* this maximum is arbitrary */
217#define USB_MAXINTERFACES 32
Craig W. Nadler165fe972007-06-15 23:14:35 -0400218#define USB_MAXIADS USB_MAXINTERFACES/2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219
220/**
221 * struct usb_interface_cache - long-term representation of a device interface
222 * @num_altsetting: number of altsettings defined.
223 * @ref: reference counter.
224 * @altsetting: variable-length array of interface structures, one for
225 * each alternate setting that may be selected. Each one includes a
226 * set of endpoint configurations. They will be in no particular order.
227 *
228 * These structures persist for the lifetime of a usb_device, unlike
229 * struct usb_interface (which persists only as long as its configuration
230 * is installed). The altsetting arrays can be accessed through these
231 * structures at any time, permitting comparison of configurations and
232 * providing support for the /proc/bus/usb/devices pseudo-file.
233 */
234struct usb_interface_cache {
235 unsigned num_altsetting; /* number of alternate settings */
236 struct kref ref; /* reference counter */
237
238 /* variable-length array of alternate settings for this interface,
239 * stored in no particular order */
240 struct usb_host_interface altsetting[0];
241};
242#define ref_to_usb_interface_cache(r) \
243 container_of(r, struct usb_interface_cache, ref)
244#define altsetting_to_usb_interface_cache(a) \
245 container_of(a, struct usb_interface_cache, altsetting[0])
246
247/**
248 * struct usb_host_config - representation of a device's configuration
249 * @desc: the device's configuration descriptor.
250 * @string: pointer to the cached version of the iConfiguration string, if
251 * present for this configuration.
Randy Dunlap3f423782007-07-19 10:21:37 -0700252 * @intf_assoc: list of any interface association descriptors in this config
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 * @interface: array of pointers to usb_interface structures, one for each
254 * interface in the configuration. The number of interfaces is stored
255 * in desc.bNumInterfaces. These pointers are valid only while the
256 * the configuration is active.
257 * @intf_cache: array of pointers to usb_interface_cache structures, one
258 * for each interface in the configuration. These structures exist
259 * for the entire life of the device.
260 * @extra: pointer to buffer containing all extra descriptors associated
261 * with this configuration (those preceding the first interface
262 * descriptor).
263 * @extralen: length of the extra descriptors buffer.
264 *
265 * USB devices may have multiple configurations, but only one can be active
266 * at any time. Each encapsulates a different operational environment;
267 * for example, a dual-speed device would have separate configurations for
268 * full-speed and high-speed operation. The number of configurations
269 * available is stored in the device descriptor as bNumConfigurations.
270 *
271 * A configuration can contain multiple interfaces. Each corresponds to
272 * a different function of the USB device, and all are available whenever
273 * the configuration is active. The USB standard says that interfaces
274 * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot
275 * of devices get this wrong. In addition, the interface array is not
276 * guaranteed to be sorted in numerical order. Use usb_ifnum_to_if() to
277 * look up an interface entry based on its number.
278 *
279 * Device drivers should not attempt to activate configurations. The choice
280 * of which configuration to install is a policy decision based on such
281 * considerations as available power, functionality provided, and the user's
Kay Sievers312c0042005-11-16 09:00:00 +0100282 * desires (expressed through userspace tools). However, drivers can call
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 * usb_reset_configuration() to reinitialize the current configuration and
284 * all its interfaces.
285 */
286struct usb_host_config {
287 struct usb_config_descriptor desc;
288
Alan Stern4f62efe2005-10-24 16:24:14 -0400289 char *string; /* iConfiguration string, if present */
Craig W. Nadler165fe972007-06-15 23:14:35 -0400290
291 /* List of any Interface Association Descriptors in this
292 * configuration. */
293 struct usb_interface_assoc_descriptor *intf_assoc[USB_MAXIADS];
294
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 /* the interfaces associated with this configuration,
296 * stored in no particular order */
297 struct usb_interface *interface[USB_MAXINTERFACES];
298
299 /* Interface information available even when this is not the
300 * active configuration */
301 struct usb_interface_cache *intf_cache[USB_MAXINTERFACES];
302
303 unsigned char *extra; /* Extra descriptors */
304 int extralen;
305};
306
307int __usb_get_extra_descriptor(char *buffer, unsigned size,
308 unsigned char type, void **ptr);
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800309#define usb_get_extra_descriptor(ifpoint, type, ptr) \
310 __usb_get_extra_descriptor((ifpoint)->extra, \
311 (ifpoint)->extralen, \
312 type, (void **)ptr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
Alan Sternb724ae72005-10-24 15:36:00 -0400314/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316/* USB device number allocation bitmap */
317struct usb_devmap {
318 unsigned long devicemap[128 / (8*sizeof(unsigned long))];
319};
320
321/*
322 * Allocated per bus (tree of devices) we have:
323 */
324struct usb_bus {
325 struct device *controller; /* host/master side hardware */
326 int busnum; /* Bus number (in order of reg) */
Greg Kroah-Hartman1b26da12008-07-02 12:46:22 -0700327 const char *bus_name; /* stable id (PCI slot_name etc) */
Alan Sterndd990f12006-08-30 11:29:56 -0400328 u8 uses_dma; /* Does the host controller use DMA? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 u8 otg_port; /* 0, or number of OTG/HNP port */
330 unsigned is_b_host:1; /* true during some HNP roleswitches */
331 unsigned b_hnp_enable:1; /* OTG: did A-Host enable HNP? */
David Vrabel4c1bd3d2009-08-24 14:44:30 +0100332 unsigned sg_tablesize; /* 0 or largest number of sg list entries */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333
Alan Sternb724ae72005-10-24 15:36:00 -0400334 int devnum_next; /* Next open device number in
335 * round-robin allocation */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336
337 struct usb_devmap devmap; /* device address allocation map */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338 struct usb_device *root_hub; /* Root hub */
Alan Stern6d19c002010-02-12 12:21:11 +0100339 struct usb_bus *hs_companion; /* Companion EHCI bus, if any */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 struct list_head bus_list; /* list of busses */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341
342 int bandwidth_allocated; /* on this bus: how much of the time
343 * reserved for periodic (intr/iso)
344 * requests is used, on average?
345 * Units: microseconds/frame.
346 * Limits: Full/low speed reserve 90%,
347 * while high speed reserves 80%.
348 */
349 int bandwidth_int_reqs; /* number of Interrupt requests */
350 int bandwidth_isoc_reqs; /* number of Isoc. requests */
351
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100352#ifdef CONFIG_USB_DEVICEFS
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 struct dentry *usbfs_dentry; /* usbfs dentry entry for the bus */
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100354#endif
Alan Sternb724ae72005-10-24 15:36:00 -0400355
Pete Zaitcevf150fa12008-11-13 21:31:21 -0700356#if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 struct mon_bus *mon_bus; /* non-null when associated */
358 int monitored; /* non-zero when monitored */
359#endif
360};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361
Alan Sternb724ae72005-10-24 15:36:00 -0400362/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363
364/* This is arbitrary.
365 * From USB 2.0 spec Table 11-13, offset 7, a hub can
366 * have up to 255 ports. The most yet reported is 10.
inaky@linux.intel.com43705252006-10-11 20:05:58 -0700367 *
368 * Current Wireless USB host hardware (Intel i1480 for example) allows
369 * up to 22 devices to connect. Upcoming hardware might raise that
370 * limit. Because the arrays need to add a bit for hub status data, we
371 * do 31, so plus one evens out to four bytes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 */
inaky@linux.intel.com43705252006-10-11 20:05:58 -0700373#define USB_MAXCHILDREN (31)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
375struct usb_tt;
376
Randy Dunlapf476fba2008-02-13 18:33:15 -0800377/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 * struct usb_device - kernel's representation of a USB device
Randy Dunlapf476fba2008-02-13 18:33:15 -0800379 * @devnum: device number; address on a USB bus
380 * @devpath: device ID string for use in messages (e.g., /port/...)
Sarah Sharp7206b002009-04-27 19:54:49 -0700381 * @route: tree topology hex string for use with xHCI
Randy Dunlapf476fba2008-02-13 18:33:15 -0800382 * @state: device state: configured, not attached, etc.
383 * @speed: device speed: high/full/low (or error)
384 * @tt: Transaction Translator info; used with low/full speed dev, highspeed hub
385 * @ttport: device port on that tt hub
386 * @toggle: one bit for each endpoint, with ([0] = IN, [1] = OUT) endpoints
387 * @parent: our hub, unless we're the root
388 * @bus: bus we're part of
389 * @ep0: endpoint 0 data (default control pipe)
390 * @dev: generic device interface
391 * @descriptor: USB device descriptor
392 * @config: all of the device's configs
393 * @actconfig: the active configuration
394 * @ep_in: array of IN endpoints
395 * @ep_out: array of OUT endpoints
396 * @rawdescriptors: raw descriptors for each config
397 * @bus_mA: Current available from the bus
398 * @portnum: parent port number (origin 1)
399 * @level: number of USB hub ancestors
400 * @can_submit: URBs may be submitted
Randy Dunlapf476fba2008-02-13 18:33:15 -0800401 * @persist_enabled: USB_PERSIST enabled for this device
402 * @have_langid: whether string_langid is valid
403 * @authorized: policy has said we can use it;
404 * (user space) policy determines if we authorize this device to be
405 * used or not. By default, wired USB devices are authorized.
406 * WUSB devices are not, until we authorize them from user space.
407 * FIXME -- complete doc
Inaky Perez-Gonzalez3b52f122008-04-08 13:24:46 -0700408 * @authenticated: Crypto authentication passed
Randy Dunlapf476fba2008-02-13 18:33:15 -0800409 * @wusb: device is Wireless USB
410 * @string_langid: language ID for strings
411 * @product: iProduct string, if present (static)
412 * @manufacturer: iManufacturer string, if present (static)
413 * @serial: iSerialNumber string, if present (static)
414 * @filelist: usbfs files that are open to this device
415 * @usb_classdev: USB class device that was created for usbfs device
416 * access from userspace
417 * @usbfs_dentry: usbfs dentry entry for the device
418 * @maxchild: number of ports if hub
419 * @children: child devices - USB devices that are attached to this hub
Randy Dunlapf476fba2008-02-13 18:33:15 -0800420 * @quirks: quirks of the whole device
421 * @urbnum: number of URBs submitted for the whole device
422 * @active_duration: total time device is not suspended
Randy Dunlapf476fba2008-02-13 18:33:15 -0800423 * @last_busy: time of last use
424 * @autosuspend_delay: in jiffies
425 * @connect_time: time device was first connected
Randy Dunlapf476fba2008-02-13 18:33:15 -0800426 * @do_remote_wakeup: remote wakeup should be enabled
427 * @reset_resume: needs reset instead of resume
428 * @autosuspend_disabled: autosuspend disabled by the user
Inaky Perez-Gonzalez11e76ae2009-01-08 12:52:19 -0800429 * @wusb_dev: if this is a Wireless USB device, link to the WUSB
430 * specific data for the device.
Sarah Sharpc6515272009-04-27 19:57:26 -0700431 * @slot_id: Slot ID assigned by xHCI
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 *
Randy Dunlapf476fba2008-02-13 18:33:15 -0800433 * Notes:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 * Usbcore drivers should not set usbdev->state directly. Instead use
435 * usb_set_device_state().
436 */
437struct usb_device {
Randy Dunlapf476fba2008-02-13 18:33:15 -0800438 int devnum;
439 char devpath [16];
Sarah Sharp7206b002009-04-27 19:54:49 -0700440 u32 route;
Randy Dunlapf476fba2008-02-13 18:33:15 -0800441 enum usb_device_state state;
442 enum usb_device_speed speed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443
Randy Dunlapf476fba2008-02-13 18:33:15 -0800444 struct usb_tt *tt;
445 int ttport;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446
Randy Dunlapf476fba2008-02-13 18:33:15 -0800447 unsigned int toggle[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448
Randy Dunlapf476fba2008-02-13 18:33:15 -0800449 struct usb_device *parent;
450 struct usb_bus *bus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 struct usb_host_endpoint ep0;
452
Randy Dunlapf476fba2008-02-13 18:33:15 -0800453 struct device dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454
Randy Dunlapf476fba2008-02-13 18:33:15 -0800455 struct usb_device_descriptor descriptor;
456 struct usb_host_config *config;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457
Randy Dunlapf476fba2008-02-13 18:33:15 -0800458 struct usb_host_config *actconfig;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 struct usb_host_endpoint *ep_in[16];
460 struct usb_host_endpoint *ep_out[16];
461
Randy Dunlapf476fba2008-02-13 18:33:15 -0800462 char **rawdescriptors;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463
Randy Dunlapf476fba2008-02-13 18:33:15 -0800464 unsigned short bus_mA;
465 u8 portnum;
466 u8 level;
Alan Stern55c52712005-11-23 12:03:12 -0500467
Randy Dunlapf476fba2008-02-13 18:33:15 -0800468 unsigned can_submit:1;
Randy Dunlapf476fba2008-02-13 18:33:15 -0800469 unsigned persist_enabled:1;
470 unsigned have_langid:1;
471 unsigned authorized:1;
Inaky Perez-Gonzalez3b52f122008-04-08 13:24:46 -0700472 unsigned authenticated:1;
Randy Dunlapf476fba2008-02-13 18:33:15 -0800473 unsigned wusb:1;
474 int string_langid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475
Alan Stern4f62efe2005-10-24 16:24:14 -0400476 /* static strings from the device */
Randy Dunlapf476fba2008-02-13 18:33:15 -0800477 char *product;
478 char *manufacturer;
479 char *serial;
Alan Stern4f62efe2005-10-24 16:24:14 -0400480
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 struct list_head filelist;
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100482#ifdef CONFIG_USB_DEVICE_CLASS
483 struct device *usb_classdev;
484#endif
485#ifdef CONFIG_USB_DEVICEFS
Randy Dunlapf476fba2008-02-13 18:33:15 -0800486 struct dentry *usbfs_dentry;
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100487#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488
Randy Dunlapf476fba2008-02-13 18:33:15 -0800489 int maxchild;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 struct usb_device *children[USB_MAXCHILDREN];
Alan Stern645daaa2006-08-30 15:47:02 -0400491
Randy Dunlapf476fba2008-02-13 18:33:15 -0800492 u32 quirks;
493 atomic_t urbnum;
Alan Sternb5e795f2007-02-20 15:00:53 -0500494
Randy Dunlapf476fba2008-02-13 18:33:15 -0800495 unsigned long active_duration;
Sarah Sharp15123002007-12-21 16:54:15 -0800496
Alan Stern645daaa2006-08-30 15:47:02 -0400497#ifdef CONFIG_PM
Randy Dunlapf476fba2008-02-13 18:33:15 -0800498 unsigned long last_busy;
499 int autosuspend_delay;
500 unsigned long connect_time;
Alan Sternb5e795f2007-02-20 15:00:53 -0500501
Randy Dunlapf476fba2008-02-13 18:33:15 -0800502 unsigned do_remote_wakeup:1;
503 unsigned reset_resume:1;
504 unsigned autosuspend_disabled:1;
Alan Stern645daaa2006-08-30 15:47:02 -0400505#endif
Inaky Perez-Gonzalezb1d8dfb2008-04-08 13:24:46 -0700506 struct wusb_dev *wusb_dev;
Sarah Sharpc6515272009-04-27 19:57:26 -0700507 int slot_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508};
509#define to_usb_device(d) container_of(d, struct usb_device, dev)
510
511extern struct usb_device *usb_get_dev(struct usb_device *dev);
512extern void usb_put_dev(struct usb_device *dev);
513
Alan Stern9ad3d6c2005-11-17 17:10:32 -0500514/* USB device locking */
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800515#define usb_lock_device(udev) device_lock(&(udev)->dev)
516#define usb_unlock_device(udev) device_unlock(&(udev)->dev)
517#define usb_trylock_device(udev) device_trylock(&(udev)->dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518extern int usb_lock_device_for_reset(struct usb_device *udev,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300519 const struct usb_interface *iface);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520
521/* USB port reset for device reinitialization */
522extern int usb_reset_device(struct usb_device *dev);
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -0800523extern void usb_queue_reset_device(struct usb_interface *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524
525extern struct usb_device *usb_find_device(u16 vendor_id, u16 product_id);
526
Alan Stern645daaa2006-08-30 15:47:02 -0400527/* USB autosuspend and autoresume */
528#ifdef CONFIG_USB_SUSPEND
Alan Stern088f7fe2010-01-08 12:56:54 -0500529extern int usb_enable_autosuspend(struct usb_device *udev);
530extern int usb_disable_autosuspend(struct usb_device *udev);
531
Alan Stern645daaa2006-08-30 15:47:02 -0400532extern int usb_autopm_get_interface(struct usb_interface *intf);
533extern void usb_autopm_put_interface(struct usb_interface *intf);
Alan Stern9ac39f22008-11-12 16:19:49 -0500534extern int usb_autopm_get_interface_async(struct usb_interface *intf);
535extern void usb_autopm_put_interface_async(struct usb_interface *intf);
Alan Stern9bbdf1e2010-01-08 12:57:28 -0500536extern void usb_autopm_get_interface_no_resume(struct usb_interface *intf);
537extern void usb_autopm_put_interface_no_suspend(struct usb_interface *intf);
Alan Stern692a1862006-10-30 17:07:51 -0500538
Alan Stern19410442007-03-27 13:33:59 -0400539static inline void usb_mark_last_busy(struct usb_device *udev)
540{
541 udev->last_busy = jiffies;
542}
543
Alan Stern692a1862006-10-30 17:07:51 -0500544#else
545
Alan Stern088f7fe2010-01-08 12:56:54 -0500546static inline int usb_enable_autosuspend(struct usb_device *udev)
547{ return 0; }
548static inline int usb_disable_autosuspend(struct usb_device *udev)
549{ return 0; }
550
Alan Stern692a1862006-10-30 17:07:51 -0500551static inline int usb_autopm_get_interface(struct usb_interface *intf)
552{ return 0; }
Alan Stern9ac39f22008-11-12 16:19:49 -0500553static inline int usb_autopm_get_interface_async(struct usb_interface *intf)
554{ return 0; }
555
Alan Stern692a1862006-10-30 17:07:51 -0500556static inline void usb_autopm_put_interface(struct usb_interface *intf)
557{ }
Alan Stern9ac39f22008-11-12 16:19:49 -0500558static inline void usb_autopm_put_interface_async(struct usb_interface *intf)
559{ }
Alan Stern8e4ceb32009-12-07 13:01:37 -0500560static inline void usb_autopm_get_interface_no_resume(
561 struct usb_interface *intf)
Alan Stern692a1862006-10-30 17:07:51 -0500562{ }
Alan Stern8e4ceb32009-12-07 13:01:37 -0500563static inline void usb_autopm_put_interface_no_suspend(
564 struct usb_interface *intf)
Alan Stern692a1862006-10-30 17:07:51 -0500565{ }
Alan Stern19410442007-03-27 13:33:59 -0400566static inline void usb_mark_last_busy(struct usb_device *udev)
567{ }
Alan Stern692a1862006-10-30 17:07:51 -0500568#endif
Alan Stern645daaa2006-08-30 15:47:02 -0400569
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570/*-------------------------------------------------------------------------*/
571
572/* for drivers using iso endpoints */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800573extern int usb_get_current_frame_number(struct usb_device *usb_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574
575/* used these for multi-interface device registration */
576extern int usb_driver_claim_interface(struct usb_driver *driver,
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800577 struct usb_interface *iface, void *priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578
579/**
580 * usb_interface_claimed - returns true iff an interface is claimed
581 * @iface: the interface being checked
582 *
583 * Returns true (nonzero) iff the interface is claimed, else false (zero).
584 * Callers must own the driver model's usb bus readlock. So driver
585 * probe() entries don't need extra locking, but other call contexts
586 * may need to explicitly claim that lock.
587 *
588 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800589static inline int usb_interface_claimed(struct usb_interface *iface)
590{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 return (iface->dev.driver != NULL);
592}
593
594extern void usb_driver_release_interface(struct usb_driver *driver,
595 struct usb_interface *iface);
596const struct usb_device_id *usb_match_id(struct usb_interface *interface,
597 const struct usb_device_id *id);
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +0100598extern int usb_match_one_id(struct usb_interface *interface,
599 const struct usb_device_id *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600
601extern struct usb_interface *usb_find_interface(struct usb_driver *drv,
602 int minor);
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300603extern struct usb_interface *usb_ifnum_to_if(const struct usb_device *dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 unsigned ifnum);
605extern struct usb_host_interface *usb_altnum_to_altsetting(
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300606 const struct usb_interface *intf, unsigned int altnum);
Sarah Sharp91017f92009-12-03 09:44:34 -0800607extern struct usb_host_interface *usb_find_alt_setting(
608 struct usb_host_config *config,
609 unsigned int iface_num,
610 unsigned int alt_num);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611
612
613/**
614 * usb_make_path - returns stable device path in the usb tree
615 * @dev: the device whose path is being constructed
616 * @buf: where to put the string
617 * @size: how big is "buf"?
618 *
619 * Returns length of the string (> 0) or negative if size was too small.
620 *
621 * This identifier is intended to be "stable", reflecting physical paths in
622 * hardware such as physical bus addresses for host controllers or ports on
623 * USB hubs. That makes it stay the same until systems are physically
624 * reconfigured, by re-cabling a tree of USB devices or by moving USB host
625 * controllers. Adding and removing devices, including virtual root hubs
626 * in host controller driver modules, does not change these path identifers;
627 * neither does rebooting or re-enumerating. These are more useful identifiers
628 * than changeable ("unstable") ones like bus numbers or device addresses.
629 *
630 * With a partial exception for devices connected to USB 2.0 root hubs, these
631 * identifiers are also predictable. So long as the device tree isn't changed,
632 * plugging any USB device into a given hub port always gives it the same path.
633 * Because of the use of "companion" controllers, devices connected to ports on
634 * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are
635 * high speed, and a different one if they are full or low speed.
636 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800637static inline int usb_make_path(struct usb_device *dev, char *buf, size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638{
639 int actual;
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800640 actual = snprintf(buf, size, "usb-%s-%s", dev->bus->bus_name,
641 dev->devpath);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 return (actual >= (int)size) ? -1 : actual;
643}
644
645/*-------------------------------------------------------------------------*/
646
Alan Sternb724ae72005-10-24 15:36:00 -0400647#define USB_DEVICE_ID_MATCH_DEVICE \
648 (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
649#define USB_DEVICE_ID_MATCH_DEV_RANGE \
650 (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI)
651#define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
652 (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653#define USB_DEVICE_ID_MATCH_DEV_INFO \
Alan Sternb724ae72005-10-24 15:36:00 -0400654 (USB_DEVICE_ID_MATCH_DEV_CLASS | \
655 USB_DEVICE_ID_MATCH_DEV_SUBCLASS | \
656 USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657#define USB_DEVICE_ID_MATCH_INT_INFO \
Alan Sternb724ae72005-10-24 15:36:00 -0400658 (USB_DEVICE_ID_MATCH_INT_CLASS | \
659 USB_DEVICE_ID_MATCH_INT_SUBCLASS | \
660 USB_DEVICE_ID_MATCH_INT_PROTOCOL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661
662/**
663 * USB_DEVICE - macro used to describe a specific usb device
664 * @vend: the 16 bit USB Vendor ID
665 * @prod: the 16 bit USB Product ID
666 *
667 * This macro is used to create a struct usb_device_id that matches a
668 * specific device.
669 */
670#define USB_DEVICE(vend,prod) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800671 .match_flags = USB_DEVICE_ID_MATCH_DEVICE, \
672 .idVendor = (vend), \
673 .idProduct = (prod)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674/**
Randy Dunlapd0bcabc2008-02-29 22:03:07 -0800675 * USB_DEVICE_VER - describe a specific usb device with a version range
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 * @vend: the 16 bit USB Vendor ID
677 * @prod: the 16 bit USB Product ID
678 * @lo: the bcdDevice_lo value
679 * @hi: the bcdDevice_hi value
680 *
681 * This macro is used to create a struct usb_device_id that matches a
682 * specific device, with a version range.
683 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800684#define USB_DEVICE_VER(vend, prod, lo, hi) \
Alan Sternb724ae72005-10-24 15:36:00 -0400685 .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800686 .idVendor = (vend), \
687 .idProduct = (prod), \
688 .bcdDevice_lo = (lo), \
689 .bcdDevice_hi = (hi)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690
691/**
Randy Dunlapd0bcabc2008-02-29 22:03:07 -0800692 * USB_DEVICE_INTERFACE_PROTOCOL - describe a usb device with a specific interface protocol
Jan Kratochvilf836ac82007-05-09 00:26:15 -0400693 * @vend: the 16 bit USB Vendor ID
694 * @prod: the 16 bit USB Product ID
695 * @pr: bInterfaceProtocol value
696 *
697 * This macro is used to create a struct usb_device_id that matches a
698 * specific interface protocol of devices.
699 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800700#define USB_DEVICE_INTERFACE_PROTOCOL(vend, prod, pr) \
701 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
702 USB_DEVICE_ID_MATCH_INT_PROTOCOL, \
Jan Kratochvilf836ac82007-05-09 00:26:15 -0400703 .idVendor = (vend), \
704 .idProduct = (prod), \
705 .bInterfaceProtocol = (pr)
706
707/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 * USB_DEVICE_INFO - macro used to describe a class of usb devices
709 * @cl: bDeviceClass value
710 * @sc: bDeviceSubClass value
711 * @pr: bDeviceProtocol value
712 *
713 * This macro is used to create a struct usb_device_id that matches a
714 * specific class of devices.
715 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800716#define USB_DEVICE_INFO(cl, sc, pr) \
717 .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, \
718 .bDeviceClass = (cl), \
719 .bDeviceSubClass = (sc), \
720 .bDeviceProtocol = (pr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721
722/**
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800723 * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 * @cl: bInterfaceClass value
725 * @sc: bInterfaceSubClass value
726 * @pr: bInterfaceProtocol value
727 *
728 * This macro is used to create a struct usb_device_id that matches a
729 * specific class of interfaces.
730 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800731#define USB_INTERFACE_INFO(cl, sc, pr) \
732 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, \
733 .bInterfaceClass = (cl), \
734 .bInterfaceSubClass = (sc), \
735 .bInterfaceProtocol = (pr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736
Daniel Drake8538f962007-05-10 00:32:24 +0100737/**
Randy Dunlapd0bcabc2008-02-29 22:03:07 -0800738 * USB_DEVICE_AND_INTERFACE_INFO - describe a specific usb device with a class of usb interfaces
Daniel Drake8538f962007-05-10 00:32:24 +0100739 * @vend: the 16 bit USB Vendor ID
740 * @prod: the 16 bit USB Product ID
741 * @cl: bInterfaceClass value
742 * @sc: bInterfaceSubClass value
743 * @pr: bInterfaceProtocol value
744 *
745 * This macro is used to create a struct usb_device_id that matches a
746 * specific device with a specific class of interfaces.
747 *
748 * This is especially useful when explicitly matching devices that have
749 * vendor specific bDeviceClass values, but standards-compliant interfaces.
750 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800751#define USB_DEVICE_AND_INTERFACE_INFO(vend, prod, cl, sc, pr) \
Daniel Drake8538f962007-05-10 00:32:24 +0100752 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO \
753 | USB_DEVICE_ID_MATCH_DEVICE, \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800754 .idVendor = (vend), \
755 .idProduct = (prod), \
Daniel Drake8538f962007-05-10 00:32:24 +0100756 .bInterfaceClass = (cl), \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800757 .bInterfaceSubClass = (sc), \
758 .bInterfaceProtocol = (pr)
Daniel Drake8538f962007-05-10 00:32:24 +0100759
Alan Sternb724ae72005-10-24 15:36:00 -0400760/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +0100762/* Stuff for dynamic usb ids */
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800763struct usb_dynids {
764 spinlock_t lock;
765 struct list_head list;
766};
767
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +0100768struct usb_dynid {
769 struct list_head node;
770 struct usb_device_id id;
771};
772
773extern ssize_t usb_store_new_id(struct usb_dynids *dynids,
774 struct device_driver *driver,
775 const char *buf, size_t count);
776
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777/**
Alan Stern8bb54ab2006-07-01 22:08:49 -0400778 * struct usbdrv_wrap - wrapper for driver-model structure
779 * @driver: The driver-model core driver structure.
780 * @for_devices: Non-zero for device drivers, 0 for interface drivers.
781 */
782struct usbdrv_wrap {
783 struct device_driver driver;
784 int for_devices;
785};
786
787/**
788 * struct usb_driver - identifies USB interface driver to usbcore
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 * @name: The driver name should be unique among USB drivers,
790 * and should normally be the same as the module name.
791 * @probe: Called to see if the driver is willing to manage a particular
792 * interface on a device. If it is, probe returns zero and uses
Oliver Neukum7ef4f062008-04-10 15:15:37 +0200793 * usb_set_intfdata() to associate driver-specific data with the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 * interface. It may also use usb_set_interface() to specify the
795 * appropriate altsetting. If unwilling to manage the interface,
Oliver Neukum7ef4f062008-04-10 15:15:37 +0200796 * return -ENODEV, if genuine IO errors occured, an appropriate
797 * negative errno value.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798 * @disconnect: Called when the interface is no longer accessible, usually
799 * because its device has been (or is being) disconnected or the
800 * driver module is being unloaded.
801 * @ioctl: Used for drivers that want to talk to userspace through
802 * the "usbfs" filesystem. This lets devices provide ways to
803 * expose information to user space regardless of where they
804 * do (or don't) show up otherwise in the filesystem.
805 * @suspend: Called when the device is going to be suspended by the system.
806 * @resume: Called when the device is being resumed by the system.
Alan Sternf07600c2007-05-30 15:38:16 -0400807 * @reset_resume: Called when the suspended device has been reset instead
808 * of being resumed.
Ming Lei742120c2008-06-18 22:00:29 +0800809 * @pre_reset: Called by usb_reset_device() when the device
Alan Stern79efa092006-06-01 13:33:42 -0400810 * is about to be reset.
Ming Lei742120c2008-06-18 22:00:29 +0800811 * @post_reset: Called by usb_reset_device() after the device
Oliver Neukum7ef4f062008-04-10 15:15:37 +0200812 * has been reset
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 * @id_table: USB drivers use ID table to support hotplugging.
814 * Export this with MODULE_DEVICE_TABLE(usb,...). This must be set
815 * or your driver's probe function will never get called.
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800816 * @dynids: used internally to hold the list of dynamically added device
817 * ids for this driver.
Alan Stern8bb54ab2006-07-01 22:08:49 -0400818 * @drvwrap: Driver-model core structure wrapper.
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -0800819 * @no_dynamic_id: if set to 1, the USB core will not allow dynamic ids to be
820 * added to this driver by preventing the sysfs file from being created.
Alan Stern645daaa2006-08-30 15:47:02 -0400821 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
822 * for interfaces bound to this driver.
Alan Stern9da82bd2008-05-08 11:54:37 -0400823 * @soft_unbind: if set to 1, the USB core will not kill URBs and disable
824 * endpoints before calling the driver's disconnect method.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 *
Alan Stern8bb54ab2006-07-01 22:08:49 -0400826 * USB interface drivers must provide a name, probe() and disconnect()
827 * methods, and an id_table. Other driver fields are optional.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 *
829 * The id_table is used in hotplugging. It holds a set of descriptors,
830 * and specialized data may be associated with each entry. That table
831 * is used by both user and kernel mode hotplugging support.
832 *
833 * The probe() and disconnect() methods are called in a context where
834 * they can sleep, but they should avoid abusing the privilege. Most
835 * work to connect to a device should be done when the device is opened,
836 * and undone at the last close. The disconnect code needs to address
837 * concurrency issues with respect to open() and close() methods, as
838 * well as forcing all pending I/O requests to complete (by unlinking
839 * them as necessary, and blocking until the unlinks complete).
840 */
841struct usb_driver {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842 const char *name;
843
844 int (*probe) (struct usb_interface *intf,
845 const struct usb_device_id *id);
846
847 void (*disconnect) (struct usb_interface *intf);
848
Alan Sternb724ae72005-10-24 15:36:00 -0400849 int (*ioctl) (struct usb_interface *intf, unsigned int code,
850 void *buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851
David Brownell27d72e82005-04-18 17:39:22 -0700852 int (*suspend) (struct usb_interface *intf, pm_message_t message);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 int (*resume) (struct usb_interface *intf);
Alan Sternf07600c2007-05-30 15:38:16 -0400854 int (*reset_resume)(struct usb_interface *intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855
Alan Sternf07600c2007-05-30 15:38:16 -0400856 int (*pre_reset)(struct usb_interface *intf);
857 int (*post_reset)(struct usb_interface *intf);
Alan Stern79efa092006-06-01 13:33:42 -0400858
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 const struct usb_device_id *id_table;
860
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800861 struct usb_dynids dynids;
Alan Stern8bb54ab2006-07-01 22:08:49 -0400862 struct usbdrv_wrap drvwrap;
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -0800863 unsigned int no_dynamic_id:1;
Alan Stern645daaa2006-08-30 15:47:02 -0400864 unsigned int supports_autosuspend:1;
Alan Stern9da82bd2008-05-08 11:54:37 -0400865 unsigned int soft_unbind:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866};
Alan Stern8bb54ab2006-07-01 22:08:49 -0400867#define to_usb_driver(d) container_of(d, struct usb_driver, drvwrap.driver)
868
869/**
870 * struct usb_device_driver - identifies USB device driver to usbcore
871 * @name: The driver name should be unique among USB drivers,
872 * and should normally be the same as the module name.
873 * @probe: Called to see if the driver is willing to manage a particular
874 * device. If it is, probe returns zero and uses dev_set_drvdata()
875 * to associate driver-specific data with the device. If unwilling
876 * to manage the device, return a negative errno value.
877 * @disconnect: Called when the device is no longer accessible, usually
878 * because it has been (or is being) disconnected or the driver's
879 * module is being unloaded.
880 * @suspend: Called when the device is going to be suspended by the system.
881 * @resume: Called when the device is being resumed by the system.
882 * @drvwrap: Driver-model core structure wrapper.
Alan Stern645daaa2006-08-30 15:47:02 -0400883 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
884 * for devices bound to this driver.
Alan Stern8bb54ab2006-07-01 22:08:49 -0400885 *
886 * USB drivers must provide all the fields listed above except drvwrap.
887 */
888struct usb_device_driver {
889 const char *name;
890
891 int (*probe) (struct usb_device *udev);
892 void (*disconnect) (struct usb_device *udev);
893
894 int (*suspend) (struct usb_device *udev, pm_message_t message);
Alan Stern65bfd292008-11-25 16:39:18 -0500895 int (*resume) (struct usb_device *udev, pm_message_t message);
Alan Stern8bb54ab2006-07-01 22:08:49 -0400896 struct usbdrv_wrap drvwrap;
Alan Stern645daaa2006-08-30 15:47:02 -0400897 unsigned int supports_autosuspend:1;
Alan Stern8bb54ab2006-07-01 22:08:49 -0400898};
899#define to_usb_device_driver(d) container_of(d, struct usb_device_driver, \
900 drvwrap.driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901
902extern struct bus_type usb_bus_type;
903
904/**
905 * struct usb_class_driver - identifies a USB driver that wants to use the USB major number
Greg Kroah-Hartmand6e5bcf2005-06-20 21:15:16 -0700906 * @name: the usb class device name for this driver. Will show up in sysfs.
Kay Sieverse454cea2009-09-18 23:01:12 +0200907 * @devnode: Callback to provide a naming hint for a possible
Randy Dunlape376bbb2009-06-18 10:39:11 -0700908 * device node to create.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909 * @fops: pointer to the struct file_operations of this driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910 * @minor_base: the start of the minor range for this driver.
911 *
912 * This structure is used for the usb_register_dev() and
913 * usb_unregister_dev() functions, to consolidate a number of the
914 * parameters used for them.
915 */
916struct usb_class_driver {
917 char *name;
Kay Sieverse454cea2009-09-18 23:01:12 +0200918 char *(*devnode)(struct device *dev, mode_t *mode);
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800919 const struct file_operations *fops;
Greg Kroah-Hartmand6e5bcf2005-06-20 21:15:16 -0700920 int minor_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921};
922
923/*
924 * use these in module_init()/module_exit()
925 * and don't forget MODULE_DEVICE_TABLE(usb, ...)
926 */
Greg Kroah-Hartman80f745f2007-01-15 11:50:02 -0800927extern int usb_register_driver(struct usb_driver *, struct module *,
928 const char *);
Greg Kroah-Hartman2143acc2005-11-21 14:53:03 -0800929static inline int usb_register(struct usb_driver *driver)
930{
Greg Kroah-Hartman80f745f2007-01-15 11:50:02 -0800931 return usb_register_driver(driver, THIS_MODULE, KBUILD_MODNAME);
Greg Kroah-Hartman2143acc2005-11-21 14:53:03 -0800932}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933extern void usb_deregister(struct usb_driver *);
934
Alan Stern8bb54ab2006-07-01 22:08:49 -0400935extern int usb_register_device_driver(struct usb_device_driver *,
936 struct module *);
937extern void usb_deregister_device_driver(struct usb_device_driver *);
938
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939extern int usb_register_dev(struct usb_interface *intf,
940 struct usb_class_driver *class_driver);
941extern void usb_deregister_dev(struct usb_interface *intf,
942 struct usb_class_driver *class_driver);
943
944extern int usb_disabled(void);
945
Alan Sternb724ae72005-10-24 15:36:00 -0400946/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947
948/*
949 * URB support, for asynchronous request completions
950 */
951
952/*
953 * urb->transfer_flags:
Alan Sternfea34092007-07-30 17:06:16 -0400954 *
955 * Note: URB_DIR_IN/OUT is automatically set in usb_submit_urb().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956 */
957#define URB_SHORT_NOT_OK 0x0001 /* report short reads as errors */
Alan Sternb724ae72005-10-24 15:36:00 -0400958#define URB_ISO_ASAP 0x0002 /* iso-only, urb->start_frame
959 * ignored */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960#define URB_NO_TRANSFER_DMA_MAP 0x0004 /* urb->transfer_dma valid on submit */
961#define URB_NO_SETUP_DMA_MAP 0x0008 /* urb->setup_dma valid on submit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962#define URB_NO_FSBR 0x0020 /* UHCI-specific */
Alan Sternb724ae72005-10-24 15:36:00 -0400963#define URB_ZERO_PACKET 0x0040 /* Finish bulk OUT with short packet */
964#define URB_NO_INTERRUPT 0x0080 /* HINT: no non-error interrupt
965 * needed */
Marcel Holtmann8b3b01c2007-06-13 08:02:11 +0200966#define URB_FREE_BUFFER 0x0100 /* Free transfer buffer with the URB */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967
Alan Sternfea34092007-07-30 17:06:16 -0400968#define URB_DIR_IN 0x0200 /* Transfer from device to host */
969#define URB_DIR_OUT 0
970#define URB_DIR_MASK URB_DIR_IN
971
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972struct usb_iso_packet_descriptor {
973 unsigned int offset;
974 unsigned int length; /* expected length */
975 unsigned int actual_length;
Pete Zaitcevd1bbb602007-02-11 13:56:13 -0800976 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977};
978
979struct urb;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980
Oliver Neukum51a2f072007-05-25 13:40:56 +0200981struct usb_anchor {
982 struct list_head urb_list;
983 wait_queue_head_t wait;
984 spinlock_t lock;
Oliver Neukum6a2839b2008-07-29 16:18:47 +0200985 unsigned int poisoned:1;
Oliver Neukum51a2f072007-05-25 13:40:56 +0200986};
987
988static inline void init_usb_anchor(struct usb_anchor *anchor)
989{
990 INIT_LIST_HEAD(&anchor->urb_list);
991 init_waitqueue_head(&anchor->wait);
992 spin_lock_init(&anchor->lock);
993}
994
David Howells7d12e782006-10-05 14:55:46 +0100995typedef void (*usb_complete_t)(struct urb *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996
997/**
998 * struct urb - USB Request Block
999 * @urb_list: For use by current owner of the URB.
Oliver Neukum51a2f072007-05-25 13:40:56 +02001000 * @anchor_list: membership in the list of an anchor
1001 * @anchor: to anchor URBs to a common mooring
Alan Stern5b653c72007-07-30 17:04:37 -04001002 * @ep: Points to the endpoint's data structure. Will eventually
1003 * replace @pipe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004 * @pipe: Holds endpoint number, direction, type, and more.
1005 * Create these values with the eight macros available;
1006 * usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl"
1007 * (control), "bulk", "int" (interrupt), or "iso" (isochronous).
1008 * For example usb_sndbulkpipe() or usb_rcvintpipe(). Endpoint
1009 * numbers range from zero to fifteen. Note that "in" endpoint two
1010 * is a different endpoint (and pipe) from "out" endpoint two.
1011 * The current configuration controls the existence, type, and
1012 * maximum packet size of any given endpoint.
1013 * @dev: Identifies the USB device to perform the request.
1014 * @status: This is read in non-iso completion functions to get the
1015 * status of the particular request. ISO requests only use it
1016 * to tell whether the URB was unlinked; detailed status for
1017 * each frame is in the fields of the iso_frame-desc.
1018 * @transfer_flags: A variety of flags may be used to affect how URB
1019 * submission, unlinking, or operation are handled. Different
1020 * kinds of URB can use different flags.
Pete Zaitcev4e9e9202009-06-11 08:53:20 -06001021 * @transfer_buffer: This identifies the buffer to (or from) which the I/O
1022 * request will be performed unless URB_NO_TRANSFER_DMA_MAP is set
1023 * (however, do not leave garbage in transfer_buffer even then).
1024 * This buffer must be suitable for DMA; allocate it with
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025 * kmalloc() or equivalent. For transfers to "in" endpoints, contents
1026 * of this buffer will be modified. This buffer is used for the data
1027 * stage of control transfers.
1028 * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP,
1029 * the device driver is saying that it provided this DMA address,
1030 * which the host controller driver should use in preference to the
1031 * transfer_buffer.
Randy Dunlape376bbb2009-06-18 10:39:11 -07001032 * @sg: scatter gather buffer list
1033 * @num_sgs: number of entries in the sg list
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034 * @transfer_buffer_length: How big is transfer_buffer. The transfer may
1035 * be broken up into chunks according to the current maximum packet
1036 * size for the endpoint, which is a function of the configuration
1037 * and is encoded in the pipe. When the length is zero, neither
1038 * transfer_buffer nor transfer_dma is used.
1039 * @actual_length: This is read in non-iso completion functions, and
1040 * it tells how many bytes (out of transfer_buffer_length) were
1041 * transferred. It will normally be the same as requested, unless
1042 * either an error was reported or a short read was performed.
1043 * The URB_SHORT_NOT_OK transfer flag may be used to make such
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001044 * short reads be reported as errors.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045 * @setup_packet: Only used for control transfers, this points to eight bytes
1046 * of setup data. Control transfers always start by sending this data
1047 * to the device. Then transfer_buffer is read or written, if needed.
1048 * @setup_dma: For control transfers with URB_NO_SETUP_DMA_MAP set, the
1049 * device driver has provided this DMA address for the setup packet.
1050 * The host controller driver should use this in preference to
Sarah Sharp6d65b782009-04-27 19:57:50 -07001051 * setup_packet, but the HCD may chose to ignore the address if it must
1052 * copy the setup packet into internal structures. Therefore, setup_packet
1053 * must always point to a valid buffer.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054 * @start_frame: Returns the initial frame for isochronous transfers.
1055 * @number_of_packets: Lists the number of ISO transfer buffers.
1056 * @interval: Specifies the polling interval for interrupt or isochronous
Anand Gadiyar411c9402009-07-07 15:24:23 +05301057 * transfers. The units are frames (milliseconds) for full and low
Matthew Wilcoxf09a15e2010-03-16 12:55:44 -07001058 * speed devices, and microframes (1/8 millisecond) for highspeed
1059 * and SuperSpeed devices.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060 * @error_count: Returns the number of ISO transfers that reported errors.
1061 * @context: For use in completion functions. This normally points to
1062 * request-specific driver context.
1063 * @complete: Completion handler. This URB is passed as the parameter to the
1064 * completion function. The completion function may then do what
1065 * it likes with the URB, including resubmitting or freeing it.
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001066 * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067 * collect the transfer status for each buffer.
1068 *
1069 * This structure identifies USB transfer requests. URBs must be allocated by
1070 * calling usb_alloc_urb() and freed with a call to usb_free_urb().
1071 * Initialization may be done using various usb_fill_*_urb() functions. URBs
1072 * are submitted using usb_submit_urb(), and pending requests may be canceled
1073 * using usb_unlink_urb() or usb_kill_urb().
1074 *
1075 * Data Transfer Buffers:
1076 *
1077 * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise
1078 * taken from the general page pool. That is provided by transfer_buffer
1079 * (control requests also use setup_packet), and host controller drivers
1080 * perform a dma mapping (and unmapping) for each buffer transferred. Those
1081 * mapping operations can be expensive on some platforms (perhaps using a dma
1082 * bounce buffer or talking to an IOMMU),
1083 * although they're cheap on commodity x86 and ppc hardware.
1084 *
1085 * Alternatively, drivers may pass the URB_NO_xxx_DMA_MAP transfer flags,
1086 * which tell the host controller driver that no such mapping is needed since
1087 * the device driver is DMA-aware. For example, a device driver might
Daniel Mack073900a2010-04-12 13:17:25 +02001088 * allocate a DMA buffer with usb_alloc_coherent() or call usb_buffer_map().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089 * When these transfer flags are provided, host controller drivers will
1090 * attempt to use the dma addresses found in the transfer_dma and/or
Pete Zaitcev4e9e9202009-06-11 08:53:20 -06001091 * setup_dma fields rather than determining a dma address themselves.
1092 *
1093 * Note that transfer_buffer must still be set if the controller
1094 * does not support DMA (as indicated by bus.uses_dma) and when talking
1095 * to root hub. If you have to trasfer between highmem zone and the device
1096 * on such controller, create a bounce buffer or bail out with an error.
1097 * If transfer_buffer cannot be set (is in highmem) and the controller is DMA
1098 * capable, assign NULL to it, so that usbmon knows not to use the value.
1099 * The setup_packet must always be set, so it cannot be located in highmem.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100 *
1101 * Initialization:
1102 *
1103 * All URBs submitted must initialize the dev, pipe, transfer_flags (may be
Alan Sternb375a042005-07-29 16:11:07 -04001104 * zero), and complete fields. All URBs must also initialize
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105 * transfer_buffer and transfer_buffer_length. They may provide the
1106 * URB_SHORT_NOT_OK transfer flag, indicating that short reads are
1107 * to be treated as errors; that flag is invalid for write requests.
1108 *
1109 * Bulk URBs may
1110 * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers
1111 * should always terminate with a short packet, even if it means adding an
1112 * extra zero length packet.
1113 *
1114 * Control URBs must provide a setup_packet. The setup_packet and
1115 * transfer_buffer may each be mapped for DMA or not, independently of
1116 * the other. The transfer_flags bits URB_NO_TRANSFER_DMA_MAP and
1117 * URB_NO_SETUP_DMA_MAP indicate which buffers have already been mapped.
1118 * URB_NO_SETUP_DMA_MAP is ignored for non-control URBs.
1119 *
1120 * Interrupt URBs must provide an interval, saying how often (in milliseconds
1121 * or, for highspeed devices, 125 microsecond units)
1122 * to poll for transfers. After the URB has been submitted, the interval
1123 * field reflects how the transfer was actually scheduled.
1124 * The polling interval may be more frequent than requested.
1125 * For example, some controllers have a maximum interval of 32 milliseconds,
1126 * while others support intervals of up to 1024 milliseconds.
1127 * Isochronous URBs also have transfer intervals. (Note that for isochronous
1128 * endpoints, as well as high speed interrupt endpoints, the encoding of
1129 * the transfer interval in the endpoint descriptor is logarithmic.
1130 * Device drivers must convert that value to linear units themselves.)
1131 *
1132 * Isochronous URBs normally use the URB_ISO_ASAP transfer flag, telling
1133 * the host controller to schedule the transfer as soon as bandwidth
1134 * utilization allows, and then set start_frame to reflect the actual frame
1135 * selected during submission. Otherwise drivers must specify the start_frame
1136 * and handle the case where the transfer can't begin then. However, drivers
1137 * won't know how bandwidth is currently allocated, and while they can
1138 * find the current frame using usb_get_current_frame_number () they can't
1139 * know the range for that frame number. (Ranges for frame counter values
1140 * are HC-specific, and can go from 256 to 65536 frames from "now".)
1141 *
1142 * Isochronous URBs have a different data transfer model, in part because
1143 * the quality of service is only "best effort". Callers provide specially
1144 * allocated URBs, with number_of_packets worth of iso_frame_desc structures
1145 * at the end. Each such packet is an individual ISO transfer. Isochronous
1146 * URBs are normally queued, submitted by drivers to arrange that
1147 * transfers are at least double buffered, and then explicitly resubmitted
1148 * in completion handlers, so
1149 * that data (such as audio or video) streams at as constant a rate as the
1150 * host controller scheduler can support.
1151 *
1152 * Completion Callbacks:
1153 *
1154 * The completion callback is made in_interrupt(), and one of the first
1155 * things that a completion handler should do is check the status field.
1156 * The status field is provided for all URBs. It is used to report
1157 * unlinked URBs, and status for all non-ISO transfers. It should not
1158 * be examined before the URB is returned to the completion handler.
1159 *
1160 * The context field is normally used to link URBs back to the relevant
1161 * driver or request state.
1162 *
1163 * When the completion callback is invoked for non-isochronous URBs, the
1164 * actual_length field tells how many bytes were transferred. This field
1165 * is updated even when the URB terminated with an error or was unlinked.
1166 *
1167 * ISO transfer status is reported in the status and actual_length fields
1168 * of the iso_frame_desc array, and the number of errors is reported in
1169 * error_count. Completion callbacks for ISO transfers will normally
1170 * (re)submit URBs to ensure a constant transfer rate.
Roman Kagan719df462005-05-06 00:55:56 +04001171 *
1172 * Note that even fields marked "public" should not be touched by the driver
1173 * when the urb is owned by the hcd, that is, since the call to
1174 * usb_submit_urb() till the entry into the completion routine.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001176struct urb {
Martin Waitzaeec46b2005-11-13 16:08:13 -08001177 /* private: usb core and host controller only fields in the urb */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178 struct kref kref; /* reference count of the URB */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 void *hcpriv; /* private data for host controller */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180 atomic_t use_count; /* concurrent submissions counter */
Ming Lei49367d82008-12-12 21:38:45 +08001181 atomic_t reject; /* submissions will fail */
Alan Sterneb231052007-08-21 15:40:36 -04001182 int unlinked; /* unlink error code */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183
Martin Waitzaeec46b2005-11-13 16:08:13 -08001184 /* public: documented fields in the urb that can be used by drivers */
Alan Sternb724ae72005-10-24 15:36:00 -04001185 struct list_head urb_list; /* list head for use by the urb's
1186 * current owner */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001187 struct list_head anchor_list; /* the URB may be anchored */
Oliver Neukum51a2f072007-05-25 13:40:56 +02001188 struct usb_anchor *anchor;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189 struct usb_device *dev; /* (in) pointer to associated device */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001190 struct usb_host_endpoint *ep; /* (internal) pointer to endpoint */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191 unsigned int pipe; /* (in) pipe information */
1192 int status; /* (return) non-ISO status */
1193 unsigned int transfer_flags; /* (in) URB_SHORT_NOT_OK | ...*/
1194 void *transfer_buffer; /* (in) associated data buffer */
1195 dma_addr_t transfer_dma; /* (in) dma addr for transfer_buffer */
Sarah Sharpe04748e2009-04-27 19:59:01 -07001196 struct usb_sg_request *sg; /* (in) scatter gather buffer list */
1197 int num_sgs; /* (in) number of entries in the sg list */
Greg Kroah-Hartman16e2e5f2009-03-03 16:44:13 -08001198 u32 transfer_buffer_length; /* (in) data buffer length */
Greg Kroah-Hartman8c209e62009-03-06 21:31:03 -08001199 u32 actual_length; /* (return) actual transfer length */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200 unsigned char *setup_packet; /* (in) setup packet (control only) */
1201 dma_addr_t setup_dma; /* (in) dma addr for setup_packet */
1202 int start_frame; /* (modify) start frame (ISO) */
1203 int number_of_packets; /* (in) number of ISO packets */
Alan Sternb724ae72005-10-24 15:36:00 -04001204 int interval; /* (modify) transfer interval
1205 * (INT/ISO) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 int error_count; /* (return) number of ISO errors */
1207 void *context; /* (in) context for completion */
1208 usb_complete_t complete; /* (in) completion routine */
Alan Sternb724ae72005-10-24 15:36:00 -04001209 struct usb_iso_packet_descriptor iso_frame_desc[0];
1210 /* (in) ISO ONLY */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211};
1212
Alan Sternb724ae72005-10-24 15:36:00 -04001213/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214
1215/**
1216 * usb_fill_control_urb - initializes a control urb
1217 * @urb: pointer to the urb to initialize.
1218 * @dev: pointer to the struct usb_device for this urb.
1219 * @pipe: the endpoint pipe
1220 * @setup_packet: pointer to the setup_packet buffer
1221 * @transfer_buffer: pointer to the transfer buffer
1222 * @buffer_length: length of the transfer buffer
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001223 * @complete_fn: pointer to the usb_complete_t function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224 * @context: what to set the urb context to.
1225 *
1226 * Initializes a control urb with the proper information needed to submit
1227 * it to a device.
1228 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001229static inline void usb_fill_control_urb(struct urb *urb,
1230 struct usb_device *dev,
1231 unsigned int pipe,
1232 unsigned char *setup_packet,
1233 void *transfer_buffer,
1234 int buffer_length,
1235 usb_complete_t complete_fn,
1236 void *context)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238 urb->dev = dev;
1239 urb->pipe = pipe;
1240 urb->setup_packet = setup_packet;
1241 urb->transfer_buffer = transfer_buffer;
1242 urb->transfer_buffer_length = buffer_length;
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001243 urb->complete = complete_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244 urb->context = context;
1245}
1246
1247/**
1248 * usb_fill_bulk_urb - macro to help initialize a bulk urb
1249 * @urb: pointer to the urb to initialize.
1250 * @dev: pointer to the struct usb_device for this urb.
1251 * @pipe: the endpoint pipe
1252 * @transfer_buffer: pointer to the transfer buffer
1253 * @buffer_length: length of the transfer buffer
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001254 * @complete_fn: pointer to the usb_complete_t function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255 * @context: what to set the urb context to.
1256 *
1257 * Initializes a bulk urb with the proper information needed to submit it
1258 * to a device.
1259 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001260static inline void usb_fill_bulk_urb(struct urb *urb,
1261 struct usb_device *dev,
1262 unsigned int pipe,
1263 void *transfer_buffer,
1264 int buffer_length,
1265 usb_complete_t complete_fn,
1266 void *context)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268 urb->dev = dev;
1269 urb->pipe = pipe;
1270 urb->transfer_buffer = transfer_buffer;
1271 urb->transfer_buffer_length = buffer_length;
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001272 urb->complete = complete_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273 urb->context = context;
1274}
1275
1276/**
1277 * usb_fill_int_urb - macro to help initialize a interrupt urb
1278 * @urb: pointer to the urb to initialize.
1279 * @dev: pointer to the struct usb_device for this urb.
1280 * @pipe: the endpoint pipe
1281 * @transfer_buffer: pointer to the transfer buffer
1282 * @buffer_length: length of the transfer buffer
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001283 * @complete_fn: pointer to the usb_complete_t function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284 * @context: what to set the urb context to.
1285 * @interval: what to set the urb interval to, encoded like
1286 * the endpoint descriptor's bInterval value.
1287 *
1288 * Initializes a interrupt urb with the proper information needed to submit
1289 * it to a device.
Matthew Wilcoxf09a15e2010-03-16 12:55:44 -07001290 *
1291 * Note that High Speed and SuperSpeed interrupt endpoints use a logarithmic
1292 * encoding of the endpoint interval, and express polling intervals in
1293 * microframes (eight per millisecond) rather than in frames (one per
1294 * millisecond).
1295 *
1296 * Wireless USB also uses the logarithmic encoding, but specifies it in units of
1297 * 128us instead of 125us. For Wireless USB devices, the interval is passed
1298 * through to the host controller, rather than being translated into microframe
1299 * units.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001301static inline void usb_fill_int_urb(struct urb *urb,
1302 struct usb_device *dev,
1303 unsigned int pipe,
1304 void *transfer_buffer,
1305 int buffer_length,
1306 usb_complete_t complete_fn,
1307 void *context,
1308 int interval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310 urb->dev = dev;
1311 urb->pipe = pipe;
1312 urb->transfer_buffer = transfer_buffer;
1313 urb->transfer_buffer_length = buffer_length;
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001314 urb->complete = complete_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315 urb->context = context;
Matthew Wilcoxf09a15e2010-03-16 12:55:44 -07001316 if (dev->speed == USB_SPEED_HIGH || dev->speed == USB_SPEED_SUPER)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317 urb->interval = 1 << (interval - 1);
1318 else
1319 urb->interval = interval;
1320 urb->start_frame = -1;
1321}
1322
1323extern void usb_init_urb(struct urb *urb);
Al Viro55016f12005-10-21 03:21:58 -04001324extern struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325extern void usb_free_urb(struct urb *urb);
1326#define usb_put_urb usb_free_urb
1327extern struct urb *usb_get_urb(struct urb *urb);
Al Viro55016f12005-10-21 03:21:58 -04001328extern int usb_submit_urb(struct urb *urb, gfp_t mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329extern int usb_unlink_urb(struct urb *urb);
1330extern void usb_kill_urb(struct urb *urb);
Oliver Neukum55b447b2008-07-29 15:26:15 +02001331extern void usb_poison_urb(struct urb *urb);
1332extern void usb_unpoison_urb(struct urb *urb);
Oliver Neukum51a2f072007-05-25 13:40:56 +02001333extern void usb_kill_anchored_urbs(struct usb_anchor *anchor);
Oliver Neukum6a2839b2008-07-29 16:18:47 +02001334extern void usb_poison_anchored_urbs(struct usb_anchor *anchor);
Oliver Neukum856395d2008-12-18 09:17:49 +01001335extern void usb_unpoison_anchored_urbs(struct usb_anchor *anchor);
Oliver Neukumeda76952008-04-10 14:07:37 +02001336extern void usb_unlink_anchored_urbs(struct usb_anchor *anchor);
Oliver Neukum51a2f072007-05-25 13:40:56 +02001337extern void usb_anchor_urb(struct urb *urb, struct usb_anchor *anchor);
1338extern void usb_unanchor_urb(struct urb *urb);
1339extern int usb_wait_anchor_empty_timeout(struct usb_anchor *anchor,
1340 unsigned int timeout);
Oliver Neukum19876252008-08-25 22:40:25 +02001341extern struct urb *usb_get_from_anchor(struct usb_anchor *anchor);
1342extern void usb_scuttle_anchored_urbs(struct usb_anchor *anchor);
1343extern int usb_anchor_empty(struct usb_anchor *anchor);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344
Alan Sternfea34092007-07-30 17:06:16 -04001345/**
1346 * usb_urb_dir_in - check if an URB describes an IN transfer
1347 * @urb: URB to be checked
1348 *
1349 * Returns 1 if @urb describes an IN transfer (device-to-host),
1350 * otherwise 0.
1351 */
1352static inline int usb_urb_dir_in(struct urb *urb)
1353{
Alan Sternd617bc82007-08-02 15:04:52 -04001354 return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_IN;
Alan Sternfea34092007-07-30 17:06:16 -04001355}
1356
1357/**
1358 * usb_urb_dir_out - check if an URB describes an OUT transfer
1359 * @urb: URB to be checked
1360 *
1361 * Returns 1 if @urb describes an OUT transfer (host-to-device),
1362 * otherwise 0.
1363 */
1364static inline int usb_urb_dir_out(struct urb *urb)
1365{
1366 return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_OUT;
1367}
1368
Daniel Mack073900a2010-04-12 13:17:25 +02001369void *usb_alloc_coherent(struct usb_device *dev, size_t size,
Al Viro55016f12005-10-21 03:21:58 -04001370 gfp_t mem_flags, dma_addr_t *dma);
Daniel Mack073900a2010-04-12 13:17:25 +02001371void usb_free_coherent(struct usb_device *dev, size_t size,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001372 void *addr, dma_addr_t dma);
1373
Daniel Mack073900a2010-04-12 13:17:25 +02001374/* Compatible macros while we switch over */
1375static inline void *usb_buffer_alloc(struct usb_device *dev, size_t size,
1376 gfp_t mem_flags, dma_addr_t *dma)
1377{
1378 return usb_alloc_coherent(dev, size, mem_flags, dma);
1379}
1380static inline void usb_buffer_free(struct usb_device *dev, size_t size,
1381 void *addr, dma_addr_t dma)
1382{
1383 return usb_free_coherent(dev, size, addr, dma);
1384}
1385
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386#if 0
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001387struct urb *usb_buffer_map(struct urb *urb);
1388void usb_buffer_dmasync(struct urb *urb);
1389void usb_buffer_unmap(struct urb *urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390#endif
1391
1392struct scatterlist;
Alan Stern5e60a162007-07-30 17:07:21 -04001393int usb_buffer_map_sg(const struct usb_device *dev, int is_in,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -03001394 struct scatterlist *sg, int nents);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395#if 0
Alan Stern5e60a162007-07-30 17:07:21 -04001396void usb_buffer_dmasync_sg(const struct usb_device *dev, int is_in,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -03001397 struct scatterlist *sg, int n_hw_ents);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398#endif
Alan Stern5e60a162007-07-30 17:07:21 -04001399void usb_buffer_unmap_sg(const struct usb_device *dev, int is_in,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -03001400 struct scatterlist *sg, int n_hw_ents);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401
1402/*-------------------------------------------------------------------*
1403 * SYNCHRONOUS CALL SUPPORT *
1404 *-------------------------------------------------------------------*/
1405
1406extern int usb_control_msg(struct usb_device *dev, unsigned int pipe,
1407 __u8 request, __u8 requesttype, __u16 value, __u16 index,
1408 void *data, __u16 size, int timeout);
Greg Kroah-Hartman782a7a62006-05-19 13:20:20 -07001409extern int usb_interrupt_msg(struct usb_device *usb_dev, unsigned int pipe,
1410 void *data, int len, int *actual_length, int timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411extern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,
1412 void *data, int len, int *actual_length,
1413 int timeout);
1414
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415/* wrappers around usb_control_msg() for the most common standard requests */
1416extern int usb_get_descriptor(struct usb_device *dev, unsigned char desctype,
1417 unsigned char descindex, void *buf, int size);
1418extern int usb_get_status(struct usb_device *dev,
1419 int type, int target, void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420extern int usb_string(struct usb_device *dev, int index,
1421 char *buf, size_t size);
1422
1423/* wrappers that also update important state inside usbcore */
1424extern int usb_clear_halt(struct usb_device *dev, int pipe);
1425extern int usb_reset_configuration(struct usb_device *dev);
1426extern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate);
David Vrabel3444b262009-04-08 17:36:28 +00001427extern void usb_reset_endpoint(struct usb_device *dev, unsigned int epaddr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428
Alan Stern088dc272006-08-21 12:08:19 -04001429/* this request isn't really synchronous, but it belongs with the others */
1430extern int usb_driver_set_configuration(struct usb_device *udev, int config);
1431
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432/*
1433 * timeouts, in milliseconds, used for sending/receiving control messages
1434 * they typically complete within a few frames (msec) after they're issued
1435 * USB identifies 5 second timeouts, maybe more in a few cases, and a few
1436 * slow devices (like some MGE Ellipse UPSes) actually push that limit.
1437 */
1438#define USB_CTRL_GET_TIMEOUT 5000
1439#define USB_CTRL_SET_TIMEOUT 5000
1440
1441
1442/**
1443 * struct usb_sg_request - support for scatter/gather I/O
1444 * @status: zero indicates success, else negative errno
1445 * @bytes: counts bytes transferred.
1446 *
1447 * These requests are initialized using usb_sg_init(), and then are used
1448 * as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most
1449 * members of the request object aren't for driver access.
1450 *
1451 * The status and bytecount values are valid only after usb_sg_wait()
1452 * returns. If the status is zero, then the bytecount matches the total
1453 * from the request.
1454 *
1455 * After an error completion, drivers may need to clear a halt condition
1456 * on the endpoint.
1457 */
1458struct usb_sg_request {
1459 int status;
1460 size_t bytes;
1461
Randy Dunlapbf92c192009-04-29 21:02:49 -07001462 /* private:
1463 * members below are private to usbcore,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464 * and are not provided for driver access!
1465 */
1466 spinlock_t lock;
1467
1468 struct usb_device *dev;
1469 int pipe;
1470 struct scatterlist *sg;
1471 int nents;
1472
1473 int entries;
1474 struct urb **urbs;
1475
1476 int count;
1477 struct completion complete;
1478};
1479
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001480int usb_sg_init(
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481 struct usb_sg_request *io,
1482 struct usb_device *dev,
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001483 unsigned pipe,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484 unsigned period,
1485 struct scatterlist *sg,
1486 int nents,
1487 size_t length,
Al Viro55016f12005-10-21 03:21:58 -04001488 gfp_t mem_flags
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489);
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001490void usb_sg_cancel(struct usb_sg_request *io);
1491void usb_sg_wait(struct usb_sg_request *io);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492
1493
Alan Sternb724ae72005-10-24 15:36:00 -04001494/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495
1496/*
1497 * For various legacy reasons, Linux has a small cookie that's paired with
1498 * a struct usb_device to identify an endpoint queue. Queue characteristics
1499 * are defined by the endpoint's descriptor. This cookie is called a "pipe",
1500 * an unsigned int encoded as:
1501 *
1502 * - direction: bit 7 (0 = Host-to-Device [Out],
1503 * 1 = Device-to-Host [In] ...
1504 * like endpoint bEndpointAddress)
1505 * - device address: bits 8-14 ... bit positions known to uhci-hcd
1506 * - endpoint: bits 15-18 ... bit positions known to uhci-hcd
1507 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
1508 * 10 = control, 11 = bulk)
1509 *
1510 * Given the device address and endpoint descriptor, pipes are redundant.
1511 */
1512
1513/* NOTE: these are not the standard USB_ENDPOINT_XFER_* values!! */
1514/* (yet ... they're the values used by usbfs) */
1515#define PIPE_ISOCHRONOUS 0
1516#define PIPE_INTERRUPT 1
1517#define PIPE_CONTROL 2
1518#define PIPE_BULK 3
1519
1520#define usb_pipein(pipe) ((pipe) & USB_DIR_IN)
1521#define usb_pipeout(pipe) (!usb_pipein(pipe))
1522
1523#define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
1524#define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
1525
1526#define usb_pipetype(pipe) (((pipe) >> 30) & 3)
1527#define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
1528#define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
1529#define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
1530#define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
1531
Alan Sternb724ae72005-10-24 15:36:00 -04001532static inline unsigned int __create_pipe(struct usb_device *dev,
1533 unsigned int endpoint)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534{
1535 return (dev->devnum << 8) | (endpoint << 15);
1536}
1537
1538/* Create various pipes... */
Alan Sternb724ae72005-10-24 15:36:00 -04001539#define usb_sndctrlpipe(dev,endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001540 ((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint))
Alan Sternb724ae72005-10-24 15:36:00 -04001541#define usb_rcvctrlpipe(dev,endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001542 ((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
Alan Sternb724ae72005-10-24 15:36:00 -04001543#define usb_sndisocpipe(dev,endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001544 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint))
Alan Sternb724ae72005-10-24 15:36:00 -04001545#define usb_rcvisocpipe(dev,endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001546 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
Alan Sternb724ae72005-10-24 15:36:00 -04001547#define usb_sndbulkpipe(dev,endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001548 ((PIPE_BULK << 30) | __create_pipe(dev, endpoint))
Alan Sternb724ae72005-10-24 15:36:00 -04001549#define usb_rcvbulkpipe(dev,endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001550 ((PIPE_BULK << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
Alan Sternb724ae72005-10-24 15:36:00 -04001551#define usb_sndintpipe(dev,endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001552 ((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint))
Alan Sternb724ae72005-10-24 15:36:00 -04001553#define usb_rcvintpipe(dev,endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001554 ((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555
1556/*-------------------------------------------------------------------------*/
1557
1558static inline __u16
1559usb_maxpacket(struct usb_device *udev, int pipe, int is_out)
1560{
1561 struct usb_host_endpoint *ep;
1562 unsigned epnum = usb_pipeendpoint(pipe);
1563
1564 if (is_out) {
1565 WARN_ON(usb_pipein(pipe));
1566 ep = udev->ep_out[epnum];
1567 } else {
1568 WARN_ON(usb_pipeout(pipe));
1569 ep = udev->ep_in[epnum];
1570 }
1571 if (!ep)
1572 return 0;
1573
1574 /* NOTE: only 0x07ff bits are for packet size... */
1575 return le16_to_cpu(ep->desc.wMaxPacketSize);
1576}
1577
Alan Sternb724ae72005-10-24 15:36:00 -04001578/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -07001580/* Events from the usb core */
1581#define USB_DEVICE_ADD 0x0001
1582#define USB_DEVICE_REMOVE 0x0002
1583#define USB_BUS_ADD 0x0003
1584#define USB_BUS_REMOVE 0x0004
1585extern void usb_register_notify(struct notifier_block *nb);
1586extern void usb_unregister_notify(struct notifier_block *nb);
1587
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588#ifdef DEBUG
Joe Perchesefcbd3d2010-02-05 18:09:49 -08001589#define dbg(format, arg...) \
1590 printk(KERN_DEBUG "%s: " format "\n", __FILE__, ##arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591#else
Joe Perchesefcbd3d2010-02-05 18:09:49 -08001592#define dbg(format, arg...) \
1593do { \
1594 if (0) \
1595 printk(KERN_DEBUG "%s: " format "\n", __FILE__, ##arg); \
1596} while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597#endif
1598
Joe Perchesefcbd3d2010-02-05 18:09:49 -08001599#define err(format, arg...) \
1600 printk(KERN_ERR KBUILD_MODNAME ": " format "\n", ##arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601
Greg Kroah-Hartman00048b82009-04-24 14:56:26 -07001602/* debugfs stuff */
1603extern struct dentry *usb_debug_root;
1604
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605#endif /* __KERNEL__ */
1606
1607#endif