blob: c6b2ab41b9080a748ce23e6b2e210ae40428e609 [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.
39 *
40 * And there might be other descriptors mixed in with those.
41 *
42 * Devices may also have class-specific or vendor-specific descriptors.
43 */
44
Greg Kroah-Hartman9bde7492006-06-14 12:14:34 -070045struct ep_device;
46
Linus Torvalds1da177e2005-04-16 15:20:36 -070047/**
48 * struct usb_host_endpoint - host-side endpoint descriptor and queue
49 * @desc: descriptor for this endpoint, wMaxPacketSize in native byteorder
50 * @urb_list: urbs queued to this endpoint; maintained by usbcore
51 * @hcpriv: for use by HCD; typically holds hardware dma queue head (QH)
52 * with one or more transfer descriptors (TDs) per urb
Randy Dunlap7fac9a32006-06-22 15:12:41 -070053 * @ep_dev: ep_device for sysfs info
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 * @extra: descriptors following this endpoint in the configuration
55 * @extralen: how many bytes of "extra" are valid
Alan Sternbdd016b2007-07-30 17:05:22 -040056 * @enabled: URBs may be submitted to this endpoint
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 *
58 * USB requests are always queued to a given endpoint, identified by a
59 * descriptor within an active interface in a given USB configuration.
60 */
61struct usb_host_endpoint {
62 struct usb_endpoint_descriptor desc;
63 struct list_head urb_list;
64 void *hcpriv;
Greg Kroah-Hartman9bde7492006-06-14 12:14:34 -070065 struct ep_device *ep_dev; /* For sysfs info */
Linus Torvalds1da177e2005-04-16 15:20:36 -070066
67 unsigned char *extra; /* Extra descriptors */
68 int extralen;
Alan Sternbdd016b2007-07-30 17:05:22 -040069 int enabled;
Linus Torvalds1da177e2005-04-16 15:20:36 -070070};
71
72/* host-side wrapper for one interface setting's parsed descriptors */
73struct usb_host_interface {
74 struct usb_interface_descriptor desc;
75
76 /* array of desc.bNumEndpoint endpoints associated with this
77 * interface setting. these will be in no particular order.
78 */
79 struct usb_host_endpoint *endpoint;
80
81 char *string; /* iInterface string, if present */
82 unsigned char *extra; /* Extra descriptors */
83 int extralen;
84};
85
86enum usb_interface_condition {
87 USB_INTERFACE_UNBOUND = 0,
88 USB_INTERFACE_BINDING,
89 USB_INTERFACE_BOUND,
90 USB_INTERFACE_UNBINDING,
91};
92
93/**
94 * struct usb_interface - what usb device drivers talk to
95 * @altsetting: array of interface structures, one for each alternate
96 * setting that may be selected. Each one includes a set of
97 * endpoint configurations. They will be in no particular order.
Linus Torvalds1da177e2005-04-16 15:20:36 -070098 * @cur_altsetting: the current altsetting.
Lei Mingd6d914f2008-02-25 18:07:28 +080099 * @num_altsetting: number of altsettings defined.
Randy Dunlap3f423782007-07-19 10:21:37 -0700100 * @intf_assoc: interface association descriptor
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101 * @minor: the minor number assigned to this interface, if this
102 * interface is bound to a driver that uses the USB major number.
103 * If this interface does not use the USB major, this field should
104 * be unused. The driver should set this value in the probe()
105 * function of the driver, after it has been assigned a minor
106 * number from the USB core by calling usb_register_dev().
107 * @condition: binding state of the interface: not bound, binding
108 * (in probe()), bound to a driver, or unbinding (in disconnect())
Alan Stern4d064c02006-07-01 22:11:44 -0400109 * @is_active: flag set when the interface is bound and not suspended.
Randy Dunlapf88ed902007-12-03 14:14:16 -0800110 * @sysfs_files_created: sysfs attributes exist
Alan Stern3b23dd62008-12-05 14:10:34 -0500111 * @ep_devs_created: endpoint child pseudo-devices exist
Alan Stern352d0262008-10-29 15:16:58 -0400112 * @unregistering: flag set when the interface is being unregistered
Alan Stern645daaa2006-08-30 15:47:02 -0400113 * @needs_remote_wakeup: flag set when the driver requires remote-wakeup
114 * capability during autosuspend.
Alan Stern55151d72008-08-12 14:33:59 -0400115 * @needs_altsetting0: flag set when a set-interface request for altsetting 0
116 * has been deferred.
Alan Sternf4f4d582008-07-28 10:39:28 -0400117 * @needs_binding: flag set when the driver should be re-probed or unbound
118 * following a reset or suspend operation it doesn't support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 * @dev: driver model's view of this device
Greg Kroah-Hartman0873c762006-06-20 13:09:50 -0700120 * @usb_dev: if an interface is bound to the USB major, this will point
121 * to the sysfs representation for that device.
Alan Stern645daaa2006-08-30 15:47:02 -0400122 * @pm_usage_cnt: PM usage counter for this interface; autosuspend is not
123 * allowed unless the counter is 0.
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -0800124 * @reset_ws: Used for scheduling resets from atomic context.
125 * @reset_running: set to 1 if the interface is currently running a
126 * queued reset so that usb_cancel_queued_reset() doesn't try to
127 * remove from the workqueue when running inside the worker
128 * thread. See __usb_queue_reset_device().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 *
130 * USB device drivers attach to interfaces on a physical device. Each
131 * interface encapsulates a single high level function, such as feeding
132 * an audio stream to a speaker or reporting a change in a volume control.
133 * Many USB devices only have one interface. The protocol used to talk to
134 * an interface's endpoints can be defined in a usb "class" specification,
135 * or by a product's vendor. The (default) control endpoint is part of
136 * every interface, but is never listed among the interface's descriptors.
137 *
138 * The driver that is bound to the interface can use standard driver model
139 * calls such as dev_get_drvdata() on the dev member of this structure.
140 *
141 * Each interface may have alternate settings. The initial configuration
142 * of a device sets altsetting 0, but the device driver can change
143 * that setting using usb_set_interface(). Alternate settings are often
Michael Opdenacker59c51592007-05-09 08:57:56 +0200144 * used to control the use of periodic endpoints, such as by having
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 * different endpoints use different amounts of reserved USB bandwidth.
146 * All standards-conformant USB devices that use isochronous endpoints
147 * will use them in non-default settings.
148 *
149 * The USB specification says that alternate setting numbers must run from
150 * 0 to one less than the total number of alternate settings. But some
151 * devices manage to mess this up, and the structures aren't necessarily
152 * stored in numerical order anyhow. Use usb_altnum_to_altsetting() to
153 * look up an alternate setting in the altsetting array based on its number.
154 */
155struct usb_interface {
156 /* array of alternate settings for this interface,
157 * stored in no particular order */
158 struct usb_host_interface *altsetting;
159
160 struct usb_host_interface *cur_altsetting; /* the currently
161 * active alternate setting */
162 unsigned num_altsetting; /* number of alternate settings */
163
Craig W. Nadler165fe972007-06-15 23:14:35 -0400164 /* If there is an interface association descriptor then it will list
165 * the associated interfaces */
166 struct usb_interface_assoc_descriptor *intf_assoc;
167
Alan Sternb724ae72005-10-24 15:36:00 -0400168 int minor; /* minor number this interface is
169 * bound to */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 enum usb_interface_condition condition; /* state of binding */
Alan Stern4d064c02006-07-01 22:11:44 -0400171 unsigned is_active:1; /* the interface is not suspended */
Alan Stern7e615592007-11-06 11:43:42 -0500172 unsigned sysfs_files_created:1; /* the sysfs attributes exist */
Alan Stern3b23dd62008-12-05 14:10:34 -0500173 unsigned ep_devs_created:1; /* endpoint "devices" exist */
Alan Stern352d0262008-10-29 15:16:58 -0400174 unsigned unregistering:1; /* unregistration is in progress */
Alan Stern645daaa2006-08-30 15:47:02 -0400175 unsigned needs_remote_wakeup:1; /* driver requires remote wakeup */
Alan Stern55151d72008-08-12 14:33:59 -0400176 unsigned needs_altsetting0:1; /* switch to altsetting 0 is pending */
Alan Stern78d9a482008-06-23 16:00:40 -0400177 unsigned needs_binding:1; /* needs delayed unbind/rebind */
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -0800178 unsigned reset_running:1;
Alan Stern4d064c02006-07-01 22:11:44 -0400179
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 struct device dev; /* interface specific device info */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800181 struct device *usb_dev;
Alan Stern645daaa2006-08-30 15:47:02 -0400182 int pm_usage_cnt; /* usage counter for autosuspend */
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -0800183 struct work_struct reset_ws; /* for resets in atomic context */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184};
185#define to_usb_interface(d) container_of(d, struct usb_interface, dev)
186#define interface_to_usbdev(intf) \
187 container_of(intf->dev.parent, struct usb_device, dev)
188
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800189static inline void *usb_get_intfdata(struct usb_interface *intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190{
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800191 return dev_get_drvdata(&intf->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192}
193
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800194static inline void usb_set_intfdata(struct usb_interface *intf, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195{
196 dev_set_drvdata(&intf->dev, data);
197}
198
199struct usb_interface *usb_get_intf(struct usb_interface *intf);
200void usb_put_intf(struct usb_interface *intf);
201
202/* this maximum is arbitrary */
203#define USB_MAXINTERFACES 32
Craig W. Nadler165fe972007-06-15 23:14:35 -0400204#define USB_MAXIADS USB_MAXINTERFACES/2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
206/**
207 * struct usb_interface_cache - long-term representation of a device interface
208 * @num_altsetting: number of altsettings defined.
209 * @ref: reference counter.
210 * @altsetting: variable-length array of interface structures, one for
211 * each alternate setting that may be selected. Each one includes a
212 * set of endpoint configurations. They will be in no particular order.
213 *
214 * These structures persist for the lifetime of a usb_device, unlike
215 * struct usb_interface (which persists only as long as its configuration
216 * is installed). The altsetting arrays can be accessed through these
217 * structures at any time, permitting comparison of configurations and
218 * providing support for the /proc/bus/usb/devices pseudo-file.
219 */
220struct usb_interface_cache {
221 unsigned num_altsetting; /* number of alternate settings */
222 struct kref ref; /* reference counter */
223
224 /* variable-length array of alternate settings for this interface,
225 * stored in no particular order */
226 struct usb_host_interface altsetting[0];
227};
228#define ref_to_usb_interface_cache(r) \
229 container_of(r, struct usb_interface_cache, ref)
230#define altsetting_to_usb_interface_cache(a) \
231 container_of(a, struct usb_interface_cache, altsetting[0])
232
233/**
234 * struct usb_host_config - representation of a device's configuration
235 * @desc: the device's configuration descriptor.
236 * @string: pointer to the cached version of the iConfiguration string, if
237 * present for this configuration.
Randy Dunlap3f423782007-07-19 10:21:37 -0700238 * @intf_assoc: list of any interface association descriptors in this config
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 * @interface: array of pointers to usb_interface structures, one for each
240 * interface in the configuration. The number of interfaces is stored
241 * in desc.bNumInterfaces. These pointers are valid only while the
242 * the configuration is active.
243 * @intf_cache: array of pointers to usb_interface_cache structures, one
244 * for each interface in the configuration. These structures exist
245 * for the entire life of the device.
246 * @extra: pointer to buffer containing all extra descriptors associated
247 * with this configuration (those preceding the first interface
248 * descriptor).
249 * @extralen: length of the extra descriptors buffer.
250 *
251 * USB devices may have multiple configurations, but only one can be active
252 * at any time. Each encapsulates a different operational environment;
253 * for example, a dual-speed device would have separate configurations for
254 * full-speed and high-speed operation. The number of configurations
255 * available is stored in the device descriptor as bNumConfigurations.
256 *
257 * A configuration can contain multiple interfaces. Each corresponds to
258 * a different function of the USB device, and all are available whenever
259 * the configuration is active. The USB standard says that interfaces
260 * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot
261 * of devices get this wrong. In addition, the interface array is not
262 * guaranteed to be sorted in numerical order. Use usb_ifnum_to_if() to
263 * look up an interface entry based on its number.
264 *
265 * Device drivers should not attempt to activate configurations. The choice
266 * of which configuration to install is a policy decision based on such
267 * considerations as available power, functionality provided, and the user's
Kay Sievers312c0042005-11-16 09:00:00 +0100268 * desires (expressed through userspace tools). However, drivers can call
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 * usb_reset_configuration() to reinitialize the current configuration and
270 * all its interfaces.
271 */
272struct usb_host_config {
273 struct usb_config_descriptor desc;
274
Alan Stern4f62efe2005-10-24 16:24:14 -0400275 char *string; /* iConfiguration string, if present */
Craig W. Nadler165fe972007-06-15 23:14:35 -0400276
277 /* List of any Interface Association Descriptors in this
278 * configuration. */
279 struct usb_interface_assoc_descriptor *intf_assoc[USB_MAXIADS];
280
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 /* the interfaces associated with this configuration,
282 * stored in no particular order */
283 struct usb_interface *interface[USB_MAXINTERFACES];
284
285 /* Interface information available even when this is not the
286 * active configuration */
287 struct usb_interface_cache *intf_cache[USB_MAXINTERFACES];
288
289 unsigned char *extra; /* Extra descriptors */
290 int extralen;
291};
292
293int __usb_get_extra_descriptor(char *buffer, unsigned size,
294 unsigned char type, void **ptr);
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800295#define usb_get_extra_descriptor(ifpoint, type, ptr) \
296 __usb_get_extra_descriptor((ifpoint)->extra, \
297 (ifpoint)->extralen, \
298 type, (void **)ptr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299
Alan Sternb724ae72005-10-24 15:36:00 -0400300/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302/* USB device number allocation bitmap */
303struct usb_devmap {
304 unsigned long devicemap[128 / (8*sizeof(unsigned long))];
305};
306
307/*
308 * Allocated per bus (tree of devices) we have:
309 */
310struct usb_bus {
311 struct device *controller; /* host/master side hardware */
312 int busnum; /* Bus number (in order of reg) */
Greg Kroah-Hartman1b26da12008-07-02 12:46:22 -0700313 const char *bus_name; /* stable id (PCI slot_name etc) */
Alan Sterndd990f12006-08-30 11:29:56 -0400314 u8 uses_dma; /* Does the host controller use DMA? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 u8 otg_port; /* 0, or number of OTG/HNP port */
316 unsigned is_b_host:1; /* true during some HNP roleswitches */
317 unsigned b_hnp_enable:1; /* OTG: did A-Host enable HNP? */
318
Alan Sternb724ae72005-10-24 15:36:00 -0400319 int devnum_next; /* Next open device number in
320 * round-robin allocation */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321
322 struct usb_devmap devmap; /* device address allocation map */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 struct usb_device *root_hub; /* Root hub */
324 struct list_head bus_list; /* list of busses */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325
326 int bandwidth_allocated; /* on this bus: how much of the time
327 * reserved for periodic (intr/iso)
328 * requests is used, on average?
329 * Units: microseconds/frame.
330 * Limits: Full/low speed reserve 90%,
331 * while high speed reserves 80%.
332 */
333 int bandwidth_int_reqs; /* number of Interrupt requests */
334 int bandwidth_isoc_reqs; /* number of Isoc. requests */
335
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100336#ifdef CONFIG_USB_DEVICEFS
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 struct dentry *usbfs_dentry; /* usbfs dentry entry for the bus */
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100338#endif
Tony Jones5a3201b2007-09-11 14:07:31 -0700339 struct device *dev; /* device for this bus */
Alan Sternb724ae72005-10-24 15:36:00 -0400340
Pete Zaitcevf150fa12008-11-13 21:31:21 -0700341#if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 struct mon_bus *mon_bus; /* non-null when associated */
343 int monitored; /* non-zero when monitored */
344#endif
345};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346
Alan Sternb724ae72005-10-24 15:36:00 -0400347/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348
349/* This is arbitrary.
350 * From USB 2.0 spec Table 11-13, offset 7, a hub can
351 * have up to 255 ports. The most yet reported is 10.
inaky@linux.intel.com43705252006-10-11 20:05:58 -0700352 *
353 * Current Wireless USB host hardware (Intel i1480 for example) allows
354 * up to 22 devices to connect. Upcoming hardware might raise that
355 * limit. Because the arrays need to add a bit for hub status data, we
356 * do 31, so plus one evens out to four bytes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 */
inaky@linux.intel.com43705252006-10-11 20:05:58 -0700358#define USB_MAXCHILDREN (31)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359
360struct usb_tt;
361
Randy Dunlapf476fba2008-02-13 18:33:15 -0800362/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 * struct usb_device - kernel's representation of a USB device
Randy Dunlapf476fba2008-02-13 18:33:15 -0800364 * @devnum: device number; address on a USB bus
365 * @devpath: device ID string for use in messages (e.g., /port/...)
366 * @state: device state: configured, not attached, etc.
367 * @speed: device speed: high/full/low (or error)
368 * @tt: Transaction Translator info; used with low/full speed dev, highspeed hub
369 * @ttport: device port on that tt hub
370 * @toggle: one bit for each endpoint, with ([0] = IN, [1] = OUT) endpoints
371 * @parent: our hub, unless we're the root
372 * @bus: bus we're part of
373 * @ep0: endpoint 0 data (default control pipe)
374 * @dev: generic device interface
375 * @descriptor: USB device descriptor
376 * @config: all of the device's configs
377 * @actconfig: the active configuration
378 * @ep_in: array of IN endpoints
379 * @ep_out: array of OUT endpoints
380 * @rawdescriptors: raw descriptors for each config
381 * @bus_mA: Current available from the bus
382 * @portnum: parent port number (origin 1)
383 * @level: number of USB hub ancestors
384 * @can_submit: URBs may be submitted
385 * @discon_suspended: disconnected while suspended
386 * @persist_enabled: USB_PERSIST enabled for this device
387 * @have_langid: whether string_langid is valid
388 * @authorized: policy has said we can use it;
389 * (user space) policy determines if we authorize this device to be
390 * used or not. By default, wired USB devices are authorized.
391 * WUSB devices are not, until we authorize them from user space.
392 * FIXME -- complete doc
Inaky Perez-Gonzalez3b52f122008-04-08 13:24:46 -0700393 * @authenticated: Crypto authentication passed
Randy Dunlapf476fba2008-02-13 18:33:15 -0800394 * @wusb: device is Wireless USB
395 * @string_langid: language ID for strings
396 * @product: iProduct string, if present (static)
397 * @manufacturer: iManufacturer string, if present (static)
398 * @serial: iSerialNumber string, if present (static)
399 * @filelist: usbfs files that are open to this device
400 * @usb_classdev: USB class device that was created for usbfs device
401 * access from userspace
402 * @usbfs_dentry: usbfs dentry entry for the device
403 * @maxchild: number of ports if hub
404 * @children: child devices - USB devices that are attached to this hub
405 * @pm_usage_cnt: usage counter for autosuspend
406 * @quirks: quirks of the whole device
407 * @urbnum: number of URBs submitted for the whole device
408 * @active_duration: total time device is not suspended
409 * @autosuspend: for delayed autosuspends
Alan Stern9ac39f22008-11-12 16:19:49 -0500410 * @autoresume: for autoresumes requested while in_interrupt
Randy Dunlapf476fba2008-02-13 18:33:15 -0800411 * @pm_mutex: protects PM operations
412 * @last_busy: time of last use
413 * @autosuspend_delay: in jiffies
414 * @connect_time: time device was first connected
415 * @auto_pm: autosuspend/resume in progress
416 * @do_remote_wakeup: remote wakeup should be enabled
417 * @reset_resume: needs reset instead of resume
418 * @autosuspend_disabled: autosuspend disabled by the user
419 * @autoresume_disabled: autoresume disabled by the user
420 * @skip_sys_resume: skip the next system resume
Inaky Perez-Gonzalez11e76ae2009-01-08 12:52:19 -0800421 * @wusb_dev: if this is a Wireless USB device, link to the WUSB
422 * specific data for the device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 *
Randy Dunlapf476fba2008-02-13 18:33:15 -0800424 * Notes:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 * Usbcore drivers should not set usbdev->state directly. Instead use
426 * usb_set_device_state().
427 */
428struct usb_device {
Randy Dunlapf476fba2008-02-13 18:33:15 -0800429 int devnum;
430 char devpath [16];
431 enum usb_device_state state;
432 enum usb_device_speed speed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433
Randy Dunlapf476fba2008-02-13 18:33:15 -0800434 struct usb_tt *tt;
435 int ttport;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436
Randy Dunlapf476fba2008-02-13 18:33:15 -0800437 unsigned int toggle[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438
Randy Dunlapf476fba2008-02-13 18:33:15 -0800439 struct usb_device *parent;
440 struct usb_bus *bus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 struct usb_host_endpoint ep0;
442
Randy Dunlapf476fba2008-02-13 18:33:15 -0800443 struct device dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444
Randy Dunlapf476fba2008-02-13 18:33:15 -0800445 struct usb_device_descriptor descriptor;
446 struct usb_host_config *config;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447
Randy Dunlapf476fba2008-02-13 18:33:15 -0800448 struct usb_host_config *actconfig;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 struct usb_host_endpoint *ep_in[16];
450 struct usb_host_endpoint *ep_out[16];
451
Randy Dunlapf476fba2008-02-13 18:33:15 -0800452 char **rawdescriptors;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453
Randy Dunlapf476fba2008-02-13 18:33:15 -0800454 unsigned short bus_mA;
455 u8 portnum;
456 u8 level;
Alan Stern55c52712005-11-23 12:03:12 -0500457
Randy Dunlapf476fba2008-02-13 18:33:15 -0800458 unsigned can_submit:1;
459 unsigned discon_suspended:1;
460 unsigned persist_enabled:1;
461 unsigned have_langid:1;
462 unsigned authorized:1;
Inaky Perez-Gonzalez3b52f122008-04-08 13:24:46 -0700463 unsigned authenticated:1;
Randy Dunlapf476fba2008-02-13 18:33:15 -0800464 unsigned wusb:1;
465 int string_langid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466
Alan Stern4f62efe2005-10-24 16:24:14 -0400467 /* static strings from the device */
Randy Dunlapf476fba2008-02-13 18:33:15 -0800468 char *product;
469 char *manufacturer;
470 char *serial;
Alan Stern4f62efe2005-10-24 16:24:14 -0400471
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 struct list_head filelist;
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100473#ifdef CONFIG_USB_DEVICE_CLASS
474 struct device *usb_classdev;
475#endif
476#ifdef CONFIG_USB_DEVICEFS
Randy Dunlapf476fba2008-02-13 18:33:15 -0800477 struct dentry *usbfs_dentry;
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100478#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479
Randy Dunlapf476fba2008-02-13 18:33:15 -0800480 int maxchild;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 struct usb_device *children[USB_MAXCHILDREN];
Alan Stern645daaa2006-08-30 15:47:02 -0400482
Randy Dunlapf476fba2008-02-13 18:33:15 -0800483 int pm_usage_cnt;
484 u32 quirks;
485 atomic_t urbnum;
Alan Sternb5e795f2007-02-20 15:00:53 -0500486
Randy Dunlapf476fba2008-02-13 18:33:15 -0800487 unsigned long active_duration;
Sarah Sharp15123002007-12-21 16:54:15 -0800488
Alan Stern645daaa2006-08-30 15:47:02 -0400489#ifdef CONFIG_PM
Randy Dunlapf476fba2008-02-13 18:33:15 -0800490 struct delayed_work autosuspend;
Alan Stern9ac39f22008-11-12 16:19:49 -0500491 struct work_struct autoresume;
Randy Dunlapf476fba2008-02-13 18:33:15 -0800492 struct mutex pm_mutex;
Alan Stern645daaa2006-08-30 15:47:02 -0400493
Randy Dunlapf476fba2008-02-13 18:33:15 -0800494 unsigned long last_busy;
495 int autosuspend_delay;
496 unsigned long connect_time;
Alan Sternb5e795f2007-02-20 15:00:53 -0500497
Randy Dunlapf476fba2008-02-13 18:33:15 -0800498 unsigned auto_pm:1;
499 unsigned do_remote_wakeup:1;
500 unsigned reset_resume:1;
501 unsigned autosuspend_disabled:1;
502 unsigned autoresume_disabled:1;
503 unsigned skip_sys_resume:1;
Alan Stern645daaa2006-08-30 15:47:02 -0400504#endif
Inaky Perez-Gonzalezb1d8dfb2008-04-08 13:24:46 -0700505 struct wusb_dev *wusb_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506};
507#define to_usb_device(d) container_of(d, struct usb_device, dev)
508
509extern struct usb_device *usb_get_dev(struct usb_device *dev);
510extern void usb_put_dev(struct usb_device *dev);
511
Alan Stern9ad3d6c2005-11-17 17:10:32 -0500512/* USB device locking */
513#define usb_lock_device(udev) down(&(udev)->dev.sem)
514#define usb_unlock_device(udev) up(&(udev)->dev.sem)
515#define usb_trylock_device(udev) down_trylock(&(udev)->dev.sem)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516extern int usb_lock_device_for_reset(struct usb_device *udev,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300517 const struct usb_interface *iface);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518
519/* USB port reset for device reinitialization */
520extern int usb_reset_device(struct usb_device *dev);
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -0800521extern void usb_queue_reset_device(struct usb_interface *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522
523extern struct usb_device *usb_find_device(u16 vendor_id, u16 product_id);
524
Alan Stern645daaa2006-08-30 15:47:02 -0400525/* USB autosuspend and autoresume */
526#ifdef CONFIG_USB_SUSPEND
Alan Stern692a1862006-10-30 17:07:51 -0500527extern int usb_autopm_set_interface(struct usb_interface *intf);
Alan Stern645daaa2006-08-30 15:47:02 -0400528extern int usb_autopm_get_interface(struct usb_interface *intf);
529extern void usb_autopm_put_interface(struct usb_interface *intf);
Alan Stern9ac39f22008-11-12 16:19:49 -0500530extern int usb_autopm_get_interface_async(struct usb_interface *intf);
531extern void usb_autopm_put_interface_async(struct usb_interface *intf);
Alan Stern645daaa2006-08-30 15:47:02 -0400532
Alan Stern692a1862006-10-30 17:07:51 -0500533static inline void usb_autopm_enable(struct usb_interface *intf)
534{
535 intf->pm_usage_cnt = 0;
536 usb_autopm_set_interface(intf);
537}
Alan Stern645daaa2006-08-30 15:47:02 -0400538
Alan Stern692a1862006-10-30 17:07:51 -0500539static inline void usb_autopm_disable(struct usb_interface *intf)
540{
541 intf->pm_usage_cnt = 1;
542 usb_autopm_set_interface(intf);
543}
544
Alan Stern19410442007-03-27 13:33:59 -0400545static inline void usb_mark_last_busy(struct usb_device *udev)
546{
547 udev->last_busy = jiffies;
548}
549
Alan Stern692a1862006-10-30 17:07:51 -0500550#else
551
552static inline int usb_autopm_set_interface(struct usb_interface *intf)
553{ return 0; }
554
555static inline int usb_autopm_get_interface(struct usb_interface *intf)
556{ return 0; }
557
Alan Stern9ac39f22008-11-12 16:19:49 -0500558static inline int usb_autopm_get_interface_async(struct usb_interface *intf)
559{ return 0; }
560
Alan Stern692a1862006-10-30 17:07:51 -0500561static inline void usb_autopm_put_interface(struct usb_interface *intf)
562{ }
Alan Stern9ac39f22008-11-12 16:19:49 -0500563static inline void usb_autopm_put_interface_async(struct usb_interface *intf)
564{ }
Alan Stern692a1862006-10-30 17:07:51 -0500565static inline void usb_autopm_enable(struct usb_interface *intf)
566{ }
567static inline void usb_autopm_disable(struct usb_interface *intf)
568{ }
Alan Stern19410442007-03-27 13:33:59 -0400569static inline void usb_mark_last_busy(struct usb_device *udev)
570{ }
Alan Stern692a1862006-10-30 17:07:51 -0500571#endif
Alan Stern645daaa2006-08-30 15:47:02 -0400572
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573/*-------------------------------------------------------------------------*/
574
575/* for drivers using iso endpoints */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800576extern int usb_get_current_frame_number(struct usb_device *usb_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577
578/* used these for multi-interface device registration */
579extern int usb_driver_claim_interface(struct usb_driver *driver,
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800580 struct usb_interface *iface, void *priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581
582/**
583 * usb_interface_claimed - returns true iff an interface is claimed
584 * @iface: the interface being checked
585 *
586 * Returns true (nonzero) iff the interface is claimed, else false (zero).
587 * Callers must own the driver model's usb bus readlock. So driver
588 * probe() entries don't need extra locking, but other call contexts
589 * may need to explicitly claim that lock.
590 *
591 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800592static inline int usb_interface_claimed(struct usb_interface *iface)
593{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 return (iface->dev.driver != NULL);
595}
596
597extern void usb_driver_release_interface(struct usb_driver *driver,
598 struct usb_interface *iface);
599const struct usb_device_id *usb_match_id(struct usb_interface *interface,
600 const struct usb_device_id *id);
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +0100601extern int usb_match_one_id(struct usb_interface *interface,
602 const struct usb_device_id *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603
604extern struct usb_interface *usb_find_interface(struct usb_driver *drv,
605 int minor);
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300606extern struct usb_interface *usb_ifnum_to_if(const struct usb_device *dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 unsigned ifnum);
608extern struct usb_host_interface *usb_altnum_to_altsetting(
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300609 const struct usb_interface *intf, unsigned int altnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610
611
612/**
613 * usb_make_path - returns stable device path in the usb tree
614 * @dev: the device whose path is being constructed
615 * @buf: where to put the string
616 * @size: how big is "buf"?
617 *
618 * Returns length of the string (> 0) or negative if size was too small.
619 *
620 * This identifier is intended to be "stable", reflecting physical paths in
621 * hardware such as physical bus addresses for host controllers or ports on
622 * USB hubs. That makes it stay the same until systems are physically
623 * reconfigured, by re-cabling a tree of USB devices or by moving USB host
624 * controllers. Adding and removing devices, including virtual root hubs
625 * in host controller driver modules, does not change these path identifers;
626 * neither does rebooting or re-enumerating. These are more useful identifiers
627 * than changeable ("unstable") ones like bus numbers or device addresses.
628 *
629 * With a partial exception for devices connected to USB 2.0 root hubs, these
630 * identifiers are also predictable. So long as the device tree isn't changed,
631 * plugging any USB device into a given hub port always gives it the same path.
632 * Because of the use of "companion" controllers, devices connected to ports on
633 * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are
634 * high speed, and a different one if they are full or low speed.
635 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800636static inline int usb_make_path(struct usb_device *dev, char *buf, size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637{
638 int actual;
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800639 actual = snprintf(buf, size, "usb-%s-%s", dev->bus->bus_name,
640 dev->devpath);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 return (actual >= (int)size) ? -1 : actual;
642}
643
644/*-------------------------------------------------------------------------*/
645
Alan Sternb724ae72005-10-24 15:36:00 -0400646#define USB_DEVICE_ID_MATCH_DEVICE \
647 (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
648#define USB_DEVICE_ID_MATCH_DEV_RANGE \
649 (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI)
650#define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
651 (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652#define USB_DEVICE_ID_MATCH_DEV_INFO \
Alan Sternb724ae72005-10-24 15:36:00 -0400653 (USB_DEVICE_ID_MATCH_DEV_CLASS | \
654 USB_DEVICE_ID_MATCH_DEV_SUBCLASS | \
655 USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656#define USB_DEVICE_ID_MATCH_INT_INFO \
Alan Sternb724ae72005-10-24 15:36:00 -0400657 (USB_DEVICE_ID_MATCH_INT_CLASS | \
658 USB_DEVICE_ID_MATCH_INT_SUBCLASS | \
659 USB_DEVICE_ID_MATCH_INT_PROTOCOL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660
661/**
662 * USB_DEVICE - macro used to describe a specific usb device
663 * @vend: the 16 bit USB Vendor ID
664 * @prod: the 16 bit USB Product ID
665 *
666 * This macro is used to create a struct usb_device_id that matches a
667 * specific device.
668 */
669#define USB_DEVICE(vend,prod) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800670 .match_flags = USB_DEVICE_ID_MATCH_DEVICE, \
671 .idVendor = (vend), \
672 .idProduct = (prod)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673/**
Randy Dunlapd0bcabc2008-02-29 22:03:07 -0800674 * USB_DEVICE_VER - describe a specific usb device with a version range
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 * @vend: the 16 bit USB Vendor ID
676 * @prod: the 16 bit USB Product ID
677 * @lo: the bcdDevice_lo value
678 * @hi: the bcdDevice_hi value
679 *
680 * This macro is used to create a struct usb_device_id that matches a
681 * specific device, with a version range.
682 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800683#define USB_DEVICE_VER(vend, prod, lo, hi) \
Alan Sternb724ae72005-10-24 15:36:00 -0400684 .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800685 .idVendor = (vend), \
686 .idProduct = (prod), \
687 .bcdDevice_lo = (lo), \
688 .bcdDevice_hi = (hi)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689
690/**
Randy Dunlapd0bcabc2008-02-29 22:03:07 -0800691 * USB_DEVICE_INTERFACE_PROTOCOL - describe a usb device with a specific interface protocol
Jan Kratochvilf836ac82007-05-09 00:26:15 -0400692 * @vend: the 16 bit USB Vendor ID
693 * @prod: the 16 bit USB Product ID
694 * @pr: bInterfaceProtocol value
695 *
696 * This macro is used to create a struct usb_device_id that matches a
697 * specific interface protocol of devices.
698 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800699#define USB_DEVICE_INTERFACE_PROTOCOL(vend, prod, pr) \
700 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
701 USB_DEVICE_ID_MATCH_INT_PROTOCOL, \
Jan Kratochvilf836ac82007-05-09 00:26:15 -0400702 .idVendor = (vend), \
703 .idProduct = (prod), \
704 .bInterfaceProtocol = (pr)
705
706/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707 * USB_DEVICE_INFO - macro used to describe a class of usb devices
708 * @cl: bDeviceClass value
709 * @sc: bDeviceSubClass value
710 * @pr: bDeviceProtocol value
711 *
712 * This macro is used to create a struct usb_device_id that matches a
713 * specific class of devices.
714 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800715#define USB_DEVICE_INFO(cl, sc, pr) \
716 .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, \
717 .bDeviceClass = (cl), \
718 .bDeviceSubClass = (sc), \
719 .bDeviceProtocol = (pr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720
721/**
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800722 * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 * @cl: bInterfaceClass value
724 * @sc: bInterfaceSubClass value
725 * @pr: bInterfaceProtocol value
726 *
727 * This macro is used to create a struct usb_device_id that matches a
728 * specific class of interfaces.
729 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800730#define USB_INTERFACE_INFO(cl, sc, pr) \
731 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, \
732 .bInterfaceClass = (cl), \
733 .bInterfaceSubClass = (sc), \
734 .bInterfaceProtocol = (pr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735
Daniel Drake8538f962007-05-10 00:32:24 +0100736/**
Randy Dunlapd0bcabc2008-02-29 22:03:07 -0800737 * USB_DEVICE_AND_INTERFACE_INFO - describe a specific usb device with a class of usb interfaces
Daniel Drake8538f962007-05-10 00:32:24 +0100738 * @vend: the 16 bit USB Vendor ID
739 * @prod: the 16 bit USB Product ID
740 * @cl: bInterfaceClass value
741 * @sc: bInterfaceSubClass value
742 * @pr: bInterfaceProtocol value
743 *
744 * This macro is used to create a struct usb_device_id that matches a
745 * specific device with a specific class of interfaces.
746 *
747 * This is especially useful when explicitly matching devices that have
748 * vendor specific bDeviceClass values, but standards-compliant interfaces.
749 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800750#define USB_DEVICE_AND_INTERFACE_INFO(vend, prod, cl, sc, pr) \
Daniel Drake8538f962007-05-10 00:32:24 +0100751 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO \
752 | USB_DEVICE_ID_MATCH_DEVICE, \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800753 .idVendor = (vend), \
754 .idProduct = (prod), \
Daniel Drake8538f962007-05-10 00:32:24 +0100755 .bInterfaceClass = (cl), \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800756 .bInterfaceSubClass = (sc), \
757 .bInterfaceProtocol = (pr)
Daniel Drake8538f962007-05-10 00:32:24 +0100758
Alan Sternb724ae72005-10-24 15:36:00 -0400759/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +0100761/* Stuff for dynamic usb ids */
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800762struct usb_dynids {
763 spinlock_t lock;
764 struct list_head list;
765};
766
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +0100767struct usb_dynid {
768 struct list_head node;
769 struct usb_device_id id;
770};
771
772extern ssize_t usb_store_new_id(struct usb_dynids *dynids,
773 struct device_driver *driver,
774 const char *buf, size_t count);
775
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776/**
Alan Stern8bb54ab2006-07-01 22:08:49 -0400777 * struct usbdrv_wrap - wrapper for driver-model structure
778 * @driver: The driver-model core driver structure.
779 * @for_devices: Non-zero for device drivers, 0 for interface drivers.
780 */
781struct usbdrv_wrap {
782 struct device_driver driver;
783 int for_devices;
784};
785
786/**
787 * struct usb_driver - identifies USB interface driver to usbcore
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 * @name: The driver name should be unique among USB drivers,
789 * and should normally be the same as the module name.
790 * @probe: Called to see if the driver is willing to manage a particular
791 * interface on a device. If it is, probe returns zero and uses
Oliver Neukum7ef4f062008-04-10 15:15:37 +0200792 * usb_set_intfdata() to associate driver-specific data with the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793 * interface. It may also use usb_set_interface() to specify the
794 * appropriate altsetting. If unwilling to manage the interface,
Oliver Neukum7ef4f062008-04-10 15:15:37 +0200795 * return -ENODEV, if genuine IO errors occured, an appropriate
796 * negative errno value.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 * @disconnect: Called when the interface is no longer accessible, usually
798 * because its device has been (or is being) disconnected or the
799 * driver module is being unloaded.
800 * @ioctl: Used for drivers that want to talk to userspace through
801 * the "usbfs" filesystem. This lets devices provide ways to
802 * expose information to user space regardless of where they
803 * do (or don't) show up otherwise in the filesystem.
804 * @suspend: Called when the device is going to be suspended by the system.
805 * @resume: Called when the device is being resumed by the system.
Alan Sternf07600c2007-05-30 15:38:16 -0400806 * @reset_resume: Called when the suspended device has been reset instead
807 * of being resumed.
Ming Lei742120c2008-06-18 22:00:29 +0800808 * @pre_reset: Called by usb_reset_device() when the device
Alan Stern79efa092006-06-01 13:33:42 -0400809 * is about to be reset.
Ming Lei742120c2008-06-18 22:00:29 +0800810 * @post_reset: Called by usb_reset_device() after the device
Oliver Neukum7ef4f062008-04-10 15:15:37 +0200811 * has been reset
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 * @id_table: USB drivers use ID table to support hotplugging.
813 * Export this with MODULE_DEVICE_TABLE(usb,...). This must be set
814 * or your driver's probe function will never get called.
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800815 * @dynids: used internally to hold the list of dynamically added device
816 * ids for this driver.
Alan Stern8bb54ab2006-07-01 22:08:49 -0400817 * @drvwrap: Driver-model core structure wrapper.
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -0800818 * @no_dynamic_id: if set to 1, the USB core will not allow dynamic ids to be
819 * added to this driver by preventing the sysfs file from being created.
Alan Stern645daaa2006-08-30 15:47:02 -0400820 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
821 * for interfaces bound to this driver.
Alan Stern9da82bd2008-05-08 11:54:37 -0400822 * @soft_unbind: if set to 1, the USB core will not kill URBs and disable
823 * endpoints before calling the driver's disconnect method.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 *
Alan Stern8bb54ab2006-07-01 22:08:49 -0400825 * USB interface drivers must provide a name, probe() and disconnect()
826 * methods, and an id_table. Other driver fields are optional.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 *
828 * The id_table is used in hotplugging. It holds a set of descriptors,
829 * and specialized data may be associated with each entry. That table
830 * is used by both user and kernel mode hotplugging support.
831 *
832 * The probe() and disconnect() methods are called in a context where
833 * they can sleep, but they should avoid abusing the privilege. Most
834 * work to connect to a device should be done when the device is opened,
835 * and undone at the last close. The disconnect code needs to address
836 * concurrency issues with respect to open() and close() methods, as
837 * well as forcing all pending I/O requests to complete (by unlinking
838 * them as necessary, and blocking until the unlinks complete).
839 */
840struct usb_driver {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 const char *name;
842
843 int (*probe) (struct usb_interface *intf,
844 const struct usb_device_id *id);
845
846 void (*disconnect) (struct usb_interface *intf);
847
Alan Sternb724ae72005-10-24 15:36:00 -0400848 int (*ioctl) (struct usb_interface *intf, unsigned int code,
849 void *buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850
David Brownell27d72e82005-04-18 17:39:22 -0700851 int (*suspend) (struct usb_interface *intf, pm_message_t message);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852 int (*resume) (struct usb_interface *intf);
Alan Sternf07600c2007-05-30 15:38:16 -0400853 int (*reset_resume)(struct usb_interface *intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854
Alan Sternf07600c2007-05-30 15:38:16 -0400855 int (*pre_reset)(struct usb_interface *intf);
856 int (*post_reset)(struct usb_interface *intf);
Alan Stern79efa092006-06-01 13:33:42 -0400857
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 const struct usb_device_id *id_table;
859
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800860 struct usb_dynids dynids;
Alan Stern8bb54ab2006-07-01 22:08:49 -0400861 struct usbdrv_wrap drvwrap;
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -0800862 unsigned int no_dynamic_id:1;
Alan Stern645daaa2006-08-30 15:47:02 -0400863 unsigned int supports_autosuspend:1;
Alan Stern9da82bd2008-05-08 11:54:37 -0400864 unsigned int soft_unbind:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865};
Alan Stern8bb54ab2006-07-01 22:08:49 -0400866#define to_usb_driver(d) container_of(d, struct usb_driver, drvwrap.driver)
867
868/**
869 * struct usb_device_driver - identifies USB device driver to usbcore
870 * @name: The driver name should be unique among USB drivers,
871 * and should normally be the same as the module name.
872 * @probe: Called to see if the driver is willing to manage a particular
873 * device. If it is, probe returns zero and uses dev_set_drvdata()
874 * to associate driver-specific data with the device. If unwilling
875 * to manage the device, return a negative errno value.
876 * @disconnect: Called when the device is no longer accessible, usually
877 * because it has been (or is being) disconnected or the driver's
878 * module is being unloaded.
879 * @suspend: Called when the device is going to be suspended by the system.
880 * @resume: Called when the device is being resumed by the system.
881 * @drvwrap: Driver-model core structure wrapper.
Alan Stern645daaa2006-08-30 15:47:02 -0400882 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
883 * for devices bound to this driver.
Alan Stern8bb54ab2006-07-01 22:08:49 -0400884 *
885 * USB drivers must provide all the fields listed above except drvwrap.
886 */
887struct usb_device_driver {
888 const char *name;
889
890 int (*probe) (struct usb_device *udev);
891 void (*disconnect) (struct usb_device *udev);
892
893 int (*suspend) (struct usb_device *udev, pm_message_t message);
Alan Stern65bfd292008-11-25 16:39:18 -0500894 int (*resume) (struct usb_device *udev, pm_message_t message);
Alan Stern8bb54ab2006-07-01 22:08:49 -0400895 struct usbdrv_wrap drvwrap;
Alan Stern645daaa2006-08-30 15:47:02 -0400896 unsigned int supports_autosuspend:1;
Alan Stern8bb54ab2006-07-01 22:08:49 -0400897};
898#define to_usb_device_driver(d) container_of(d, struct usb_device_driver, \
899 drvwrap.driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900
901extern struct bus_type usb_bus_type;
902
903/**
904 * struct usb_class_driver - identifies a USB driver that wants to use the USB major number
Greg Kroah-Hartmand6e5bcf2005-06-20 21:15:16 -0700905 * @name: the usb class device name for this driver. Will show up in sysfs.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906 * @fops: pointer to the struct file_operations of this driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 * @minor_base: the start of the minor range for this driver.
908 *
909 * This structure is used for the usb_register_dev() and
910 * usb_unregister_dev() functions, to consolidate a number of the
911 * parameters used for them.
912 */
913struct usb_class_driver {
914 char *name;
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800915 const struct file_operations *fops;
Greg Kroah-Hartmand6e5bcf2005-06-20 21:15:16 -0700916 int minor_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917};
918
919/*
920 * use these in module_init()/module_exit()
921 * and don't forget MODULE_DEVICE_TABLE(usb, ...)
922 */
Greg Kroah-Hartman80f745f2007-01-15 11:50:02 -0800923extern int usb_register_driver(struct usb_driver *, struct module *,
924 const char *);
Greg Kroah-Hartman2143acc2005-11-21 14:53:03 -0800925static inline int usb_register(struct usb_driver *driver)
926{
Greg Kroah-Hartman80f745f2007-01-15 11:50:02 -0800927 return usb_register_driver(driver, THIS_MODULE, KBUILD_MODNAME);
Greg Kroah-Hartman2143acc2005-11-21 14:53:03 -0800928}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929extern void usb_deregister(struct usb_driver *);
930
Alan Stern8bb54ab2006-07-01 22:08:49 -0400931extern int usb_register_device_driver(struct usb_device_driver *,
932 struct module *);
933extern void usb_deregister_device_driver(struct usb_device_driver *);
934
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935extern int usb_register_dev(struct usb_interface *intf,
936 struct usb_class_driver *class_driver);
937extern void usb_deregister_dev(struct usb_interface *intf,
938 struct usb_class_driver *class_driver);
939
940extern int usb_disabled(void);
941
Alan Sternb724ae72005-10-24 15:36:00 -0400942/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943
944/*
945 * URB support, for asynchronous request completions
946 */
947
948/*
949 * urb->transfer_flags:
Alan Sternfea34092007-07-30 17:06:16 -0400950 *
951 * Note: URB_DIR_IN/OUT is automatically set in usb_submit_urb().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952 */
953#define URB_SHORT_NOT_OK 0x0001 /* report short reads as errors */
Alan Sternb724ae72005-10-24 15:36:00 -0400954#define URB_ISO_ASAP 0x0002 /* iso-only, urb->start_frame
955 * ignored */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956#define URB_NO_TRANSFER_DMA_MAP 0x0004 /* urb->transfer_dma valid on submit */
957#define URB_NO_SETUP_DMA_MAP 0x0008 /* urb->setup_dma valid on submit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958#define URB_NO_FSBR 0x0020 /* UHCI-specific */
Alan Sternb724ae72005-10-24 15:36:00 -0400959#define URB_ZERO_PACKET 0x0040 /* Finish bulk OUT with short packet */
960#define URB_NO_INTERRUPT 0x0080 /* HINT: no non-error interrupt
961 * needed */
Marcel Holtmann8b3b01c2007-06-13 08:02:11 +0200962#define URB_FREE_BUFFER 0x0100 /* Free transfer buffer with the URB */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963
Alan Sternfea34092007-07-30 17:06:16 -0400964#define URB_DIR_IN 0x0200 /* Transfer from device to host */
965#define URB_DIR_OUT 0
966#define URB_DIR_MASK URB_DIR_IN
967
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968struct usb_iso_packet_descriptor {
969 unsigned int offset;
970 unsigned int length; /* expected length */
971 unsigned int actual_length;
Pete Zaitcevd1bbb602007-02-11 13:56:13 -0800972 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973};
974
975struct urb;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976
Oliver Neukum51a2f072007-05-25 13:40:56 +0200977struct usb_anchor {
978 struct list_head urb_list;
979 wait_queue_head_t wait;
980 spinlock_t lock;
Oliver Neukum6a2839b2008-07-29 16:18:47 +0200981 unsigned int poisoned:1;
Oliver Neukum51a2f072007-05-25 13:40:56 +0200982};
983
984static inline void init_usb_anchor(struct usb_anchor *anchor)
985{
986 INIT_LIST_HEAD(&anchor->urb_list);
987 init_waitqueue_head(&anchor->wait);
988 spin_lock_init(&anchor->lock);
989}
990
David Howells7d12e782006-10-05 14:55:46 +0100991typedef void (*usb_complete_t)(struct urb *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992
993/**
994 * struct urb - USB Request Block
995 * @urb_list: For use by current owner of the URB.
Oliver Neukum51a2f072007-05-25 13:40:56 +0200996 * @anchor_list: membership in the list of an anchor
997 * @anchor: to anchor URBs to a common mooring
Alan Stern5b653c72007-07-30 17:04:37 -0400998 * @ep: Points to the endpoint's data structure. Will eventually
999 * replace @pipe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000 * @pipe: Holds endpoint number, direction, type, and more.
1001 * Create these values with the eight macros available;
1002 * usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl"
1003 * (control), "bulk", "int" (interrupt), or "iso" (isochronous).
1004 * For example usb_sndbulkpipe() or usb_rcvintpipe(). Endpoint
1005 * numbers range from zero to fifteen. Note that "in" endpoint two
1006 * is a different endpoint (and pipe) from "out" endpoint two.
1007 * The current configuration controls the existence, type, and
1008 * maximum packet size of any given endpoint.
1009 * @dev: Identifies the USB device to perform the request.
1010 * @status: This is read in non-iso completion functions to get the
1011 * status of the particular request. ISO requests only use it
1012 * to tell whether the URB was unlinked; detailed status for
1013 * each frame is in the fields of the iso_frame-desc.
1014 * @transfer_flags: A variety of flags may be used to affect how URB
1015 * submission, unlinking, or operation are handled. Different
1016 * kinds of URB can use different flags.
1017 * @transfer_buffer: This identifies the buffer to (or from) which
1018 * the I/O request will be performed (unless URB_NO_TRANSFER_DMA_MAP
1019 * is set). This buffer must be suitable for DMA; allocate it with
1020 * kmalloc() or equivalent. For transfers to "in" endpoints, contents
1021 * of this buffer will be modified. This buffer is used for the data
1022 * stage of control transfers.
1023 * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP,
1024 * the device driver is saying that it provided this DMA address,
1025 * which the host controller driver should use in preference to the
1026 * transfer_buffer.
1027 * @transfer_buffer_length: How big is transfer_buffer. The transfer may
1028 * be broken up into chunks according to the current maximum packet
1029 * size for the endpoint, which is a function of the configuration
1030 * and is encoded in the pipe. When the length is zero, neither
1031 * transfer_buffer nor transfer_dma is used.
1032 * @actual_length: This is read in non-iso completion functions, and
1033 * it tells how many bytes (out of transfer_buffer_length) were
1034 * transferred. It will normally be the same as requested, unless
1035 * either an error was reported or a short read was performed.
1036 * The URB_SHORT_NOT_OK transfer flag may be used to make such
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001037 * short reads be reported as errors.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038 * @setup_packet: Only used for control transfers, this points to eight bytes
1039 * of setup data. Control transfers always start by sending this data
1040 * to the device. Then transfer_buffer is read or written, if needed.
1041 * @setup_dma: For control transfers with URB_NO_SETUP_DMA_MAP set, the
1042 * device driver has provided this DMA address for the setup packet.
1043 * The host controller driver should use this in preference to
1044 * setup_packet.
1045 * @start_frame: Returns the initial frame for isochronous transfers.
1046 * @number_of_packets: Lists the number of ISO transfer buffers.
1047 * @interval: Specifies the polling interval for interrupt or isochronous
1048 * transfers. The units are frames (milliseconds) for for full and low
1049 * speed devices, and microframes (1/8 millisecond) for highspeed ones.
1050 * @error_count: Returns the number of ISO transfers that reported errors.
1051 * @context: For use in completion functions. This normally points to
1052 * request-specific driver context.
1053 * @complete: Completion handler. This URB is passed as the parameter to the
1054 * completion function. The completion function may then do what
1055 * it likes with the URB, including resubmitting or freeing it.
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001056 * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057 * collect the transfer status for each buffer.
1058 *
1059 * This structure identifies USB transfer requests. URBs must be allocated by
1060 * calling usb_alloc_urb() and freed with a call to usb_free_urb().
1061 * Initialization may be done using various usb_fill_*_urb() functions. URBs
1062 * are submitted using usb_submit_urb(), and pending requests may be canceled
1063 * using usb_unlink_urb() or usb_kill_urb().
1064 *
1065 * Data Transfer Buffers:
1066 *
1067 * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise
1068 * taken from the general page pool. That is provided by transfer_buffer
1069 * (control requests also use setup_packet), and host controller drivers
1070 * perform a dma mapping (and unmapping) for each buffer transferred. Those
1071 * mapping operations can be expensive on some platforms (perhaps using a dma
1072 * bounce buffer or talking to an IOMMU),
1073 * although they're cheap on commodity x86 and ppc hardware.
1074 *
1075 * Alternatively, drivers may pass the URB_NO_xxx_DMA_MAP transfer flags,
1076 * which tell the host controller driver that no such mapping is needed since
1077 * the device driver is DMA-aware. For example, a device driver might
1078 * allocate a DMA buffer with usb_buffer_alloc() or call usb_buffer_map().
1079 * When these transfer flags are provided, host controller drivers will
1080 * attempt to use the dma addresses found in the transfer_dma and/or
1081 * setup_dma fields rather than determining a dma address themselves. (Note
1082 * that transfer_buffer and setup_packet must still be set because not all
1083 * host controllers use DMA, nor do virtual root hubs).
1084 *
1085 * Initialization:
1086 *
1087 * All URBs submitted must initialize the dev, pipe, transfer_flags (may be
Alan Sternb375a042005-07-29 16:11:07 -04001088 * zero), and complete fields. All URBs must also initialize
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089 * transfer_buffer and transfer_buffer_length. They may provide the
1090 * URB_SHORT_NOT_OK transfer flag, indicating that short reads are
1091 * to be treated as errors; that flag is invalid for write requests.
1092 *
1093 * Bulk URBs may
1094 * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers
1095 * should always terminate with a short packet, even if it means adding an
1096 * extra zero length packet.
1097 *
1098 * Control URBs must provide a setup_packet. The setup_packet and
1099 * transfer_buffer may each be mapped for DMA or not, independently of
1100 * the other. The transfer_flags bits URB_NO_TRANSFER_DMA_MAP and
1101 * URB_NO_SETUP_DMA_MAP indicate which buffers have already been mapped.
1102 * URB_NO_SETUP_DMA_MAP is ignored for non-control URBs.
1103 *
1104 * Interrupt URBs must provide an interval, saying how often (in milliseconds
1105 * or, for highspeed devices, 125 microsecond units)
1106 * to poll for transfers. After the URB has been submitted, the interval
1107 * field reflects how the transfer was actually scheduled.
1108 * The polling interval may be more frequent than requested.
1109 * For example, some controllers have a maximum interval of 32 milliseconds,
1110 * while others support intervals of up to 1024 milliseconds.
1111 * Isochronous URBs also have transfer intervals. (Note that for isochronous
1112 * endpoints, as well as high speed interrupt endpoints, the encoding of
1113 * the transfer interval in the endpoint descriptor is logarithmic.
1114 * Device drivers must convert that value to linear units themselves.)
1115 *
1116 * Isochronous URBs normally use the URB_ISO_ASAP transfer flag, telling
1117 * the host controller to schedule the transfer as soon as bandwidth
1118 * utilization allows, and then set start_frame to reflect the actual frame
1119 * selected during submission. Otherwise drivers must specify the start_frame
1120 * and handle the case where the transfer can't begin then. However, drivers
1121 * won't know how bandwidth is currently allocated, and while they can
1122 * find the current frame using usb_get_current_frame_number () they can't
1123 * know the range for that frame number. (Ranges for frame counter values
1124 * are HC-specific, and can go from 256 to 65536 frames from "now".)
1125 *
1126 * Isochronous URBs have a different data transfer model, in part because
1127 * the quality of service is only "best effort". Callers provide specially
1128 * allocated URBs, with number_of_packets worth of iso_frame_desc structures
1129 * at the end. Each such packet is an individual ISO transfer. Isochronous
1130 * URBs are normally queued, submitted by drivers to arrange that
1131 * transfers are at least double buffered, and then explicitly resubmitted
1132 * in completion handlers, so
1133 * that data (such as audio or video) streams at as constant a rate as the
1134 * host controller scheduler can support.
1135 *
1136 * Completion Callbacks:
1137 *
1138 * The completion callback is made in_interrupt(), and one of the first
1139 * things that a completion handler should do is check the status field.
1140 * The status field is provided for all URBs. It is used to report
1141 * unlinked URBs, and status for all non-ISO transfers. It should not
1142 * be examined before the URB is returned to the completion handler.
1143 *
1144 * The context field is normally used to link URBs back to the relevant
1145 * driver or request state.
1146 *
1147 * When the completion callback is invoked for non-isochronous URBs, the
1148 * actual_length field tells how many bytes were transferred. This field
1149 * is updated even when the URB terminated with an error or was unlinked.
1150 *
1151 * ISO transfer status is reported in the status and actual_length fields
1152 * of the iso_frame_desc array, and the number of errors is reported in
1153 * error_count. Completion callbacks for ISO transfers will normally
1154 * (re)submit URBs to ensure a constant transfer rate.
Roman Kagan719df462005-05-06 00:55:56 +04001155 *
1156 * Note that even fields marked "public" should not be touched by the driver
1157 * when the urb is owned by the hcd, that is, since the call to
1158 * usb_submit_urb() till the entry into the completion routine.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001160struct urb {
Martin Waitzaeec46b2005-11-13 16:08:13 -08001161 /* private: usb core and host controller only fields in the urb */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162 struct kref kref; /* reference count of the URB */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163 void *hcpriv; /* private data for host controller */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164 atomic_t use_count; /* concurrent submissions counter */
Ming Lei49367d82008-12-12 21:38:45 +08001165 atomic_t reject; /* submissions will fail */
Alan Sterneb231052007-08-21 15:40:36 -04001166 int unlinked; /* unlink error code */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167
Martin Waitzaeec46b2005-11-13 16:08:13 -08001168 /* public: documented fields in the urb that can be used by drivers */
Alan Sternb724ae72005-10-24 15:36:00 -04001169 struct list_head urb_list; /* list head for use by the urb's
1170 * current owner */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001171 struct list_head anchor_list; /* the URB may be anchored */
Oliver Neukum51a2f072007-05-25 13:40:56 +02001172 struct usb_anchor *anchor;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173 struct usb_device *dev; /* (in) pointer to associated device */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001174 struct usb_host_endpoint *ep; /* (internal) pointer to endpoint */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175 unsigned int pipe; /* (in) pipe information */
1176 int status; /* (return) non-ISO status */
1177 unsigned int transfer_flags; /* (in) URB_SHORT_NOT_OK | ...*/
1178 void *transfer_buffer; /* (in) associated data buffer */
1179 dma_addr_t transfer_dma; /* (in) dma addr for transfer_buffer */
Greg Kroah-Hartman16e2e5f2009-03-03 16:44:13 -08001180 u32 transfer_buffer_length; /* (in) data buffer length */
Greg Kroah-Hartman8c209e62009-03-06 21:31:03 -08001181 u32 actual_length; /* (return) actual transfer length */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182 unsigned char *setup_packet; /* (in) setup packet (control only) */
1183 dma_addr_t setup_dma; /* (in) dma addr for setup_packet */
1184 int start_frame; /* (modify) start frame (ISO) */
1185 int number_of_packets; /* (in) number of ISO packets */
Alan Sternb724ae72005-10-24 15:36:00 -04001186 int interval; /* (modify) transfer interval
1187 * (INT/ISO) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188 int error_count; /* (return) number of ISO errors */
1189 void *context; /* (in) context for completion */
1190 usb_complete_t complete; /* (in) completion routine */
Alan Sternb724ae72005-10-24 15:36:00 -04001191 struct usb_iso_packet_descriptor iso_frame_desc[0];
1192 /* (in) ISO ONLY */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193};
1194
Alan Sternb724ae72005-10-24 15:36:00 -04001195/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196
1197/**
1198 * usb_fill_control_urb - initializes a control urb
1199 * @urb: pointer to the urb to initialize.
1200 * @dev: pointer to the struct usb_device for this urb.
1201 * @pipe: the endpoint pipe
1202 * @setup_packet: pointer to the setup_packet buffer
1203 * @transfer_buffer: pointer to the transfer buffer
1204 * @buffer_length: length of the transfer buffer
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001205 * @complete_fn: pointer to the usb_complete_t function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 * @context: what to set the urb context to.
1207 *
1208 * Initializes a control urb with the proper information needed to submit
1209 * it to a device.
1210 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001211static inline void usb_fill_control_urb(struct urb *urb,
1212 struct usb_device *dev,
1213 unsigned int pipe,
1214 unsigned char *setup_packet,
1215 void *transfer_buffer,
1216 int buffer_length,
1217 usb_complete_t complete_fn,
1218 void *context)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220 urb->dev = dev;
1221 urb->pipe = pipe;
1222 urb->setup_packet = setup_packet;
1223 urb->transfer_buffer = transfer_buffer;
1224 urb->transfer_buffer_length = buffer_length;
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001225 urb->complete = complete_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226 urb->context = context;
1227}
1228
1229/**
1230 * usb_fill_bulk_urb - macro to help initialize a bulk urb
1231 * @urb: pointer to the urb to initialize.
1232 * @dev: pointer to the struct usb_device for this urb.
1233 * @pipe: the endpoint pipe
1234 * @transfer_buffer: pointer to the transfer buffer
1235 * @buffer_length: length of the transfer buffer
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001236 * @complete_fn: pointer to the usb_complete_t function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237 * @context: what to set the urb context to.
1238 *
1239 * Initializes a bulk urb with the proper information needed to submit it
1240 * to a device.
1241 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001242static inline void usb_fill_bulk_urb(struct urb *urb,
1243 struct usb_device *dev,
1244 unsigned int pipe,
1245 void *transfer_buffer,
1246 int buffer_length,
1247 usb_complete_t complete_fn,
1248 void *context)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250 urb->dev = dev;
1251 urb->pipe = pipe;
1252 urb->transfer_buffer = transfer_buffer;
1253 urb->transfer_buffer_length = buffer_length;
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001254 urb->complete = complete_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255 urb->context = context;
1256}
1257
1258/**
1259 * usb_fill_int_urb - macro to help initialize a interrupt urb
1260 * @urb: pointer to the urb to initialize.
1261 * @dev: pointer to the struct usb_device for this urb.
1262 * @pipe: the endpoint pipe
1263 * @transfer_buffer: pointer to the transfer buffer
1264 * @buffer_length: length of the transfer buffer
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001265 * @complete_fn: pointer to the usb_complete_t function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266 * @context: what to set the urb context to.
1267 * @interval: what to set the urb interval to, encoded like
1268 * the endpoint descriptor's bInterval value.
1269 *
1270 * Initializes a interrupt urb with the proper information needed to submit
1271 * it to a device.
1272 * Note that high speed interrupt endpoints use a logarithmic encoding of
1273 * the endpoint interval, and express polling intervals in microframes
1274 * (eight per millisecond) rather than in frames (one per millisecond).
1275 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001276static inline void usb_fill_int_urb(struct urb *urb,
1277 struct usb_device *dev,
1278 unsigned int pipe,
1279 void *transfer_buffer,
1280 int buffer_length,
1281 usb_complete_t complete_fn,
1282 void *context,
1283 int interval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285 urb->dev = dev;
1286 urb->pipe = pipe;
1287 urb->transfer_buffer = transfer_buffer;
1288 urb->transfer_buffer_length = buffer_length;
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001289 urb->complete = complete_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290 urb->context = context;
1291 if (dev->speed == USB_SPEED_HIGH)
1292 urb->interval = 1 << (interval - 1);
1293 else
1294 urb->interval = interval;
1295 urb->start_frame = -1;
1296}
1297
1298extern void usb_init_urb(struct urb *urb);
Al Viro55016f12005-10-21 03:21:58 -04001299extern struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300extern void usb_free_urb(struct urb *urb);
1301#define usb_put_urb usb_free_urb
1302extern struct urb *usb_get_urb(struct urb *urb);
Al Viro55016f12005-10-21 03:21:58 -04001303extern int usb_submit_urb(struct urb *urb, gfp_t mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304extern int usb_unlink_urb(struct urb *urb);
1305extern void usb_kill_urb(struct urb *urb);
Oliver Neukum55b447b2008-07-29 15:26:15 +02001306extern void usb_poison_urb(struct urb *urb);
1307extern void usb_unpoison_urb(struct urb *urb);
Oliver Neukum51a2f072007-05-25 13:40:56 +02001308extern void usb_kill_anchored_urbs(struct usb_anchor *anchor);
Oliver Neukum6a2839b2008-07-29 16:18:47 +02001309extern void usb_poison_anchored_urbs(struct usb_anchor *anchor);
Oliver Neukum856395d2008-12-18 09:17:49 +01001310extern void usb_unpoison_anchored_urbs(struct usb_anchor *anchor);
Oliver Neukumeda76952008-04-10 14:07:37 +02001311extern void usb_unlink_anchored_urbs(struct usb_anchor *anchor);
Oliver Neukum51a2f072007-05-25 13:40:56 +02001312extern void usb_anchor_urb(struct urb *urb, struct usb_anchor *anchor);
1313extern void usb_unanchor_urb(struct urb *urb);
1314extern int usb_wait_anchor_empty_timeout(struct usb_anchor *anchor,
1315 unsigned int timeout);
Oliver Neukum19876252008-08-25 22:40:25 +02001316extern struct urb *usb_get_from_anchor(struct usb_anchor *anchor);
1317extern void usb_scuttle_anchored_urbs(struct usb_anchor *anchor);
1318extern int usb_anchor_empty(struct usb_anchor *anchor);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319
Alan Sternfea34092007-07-30 17:06:16 -04001320/**
1321 * usb_urb_dir_in - check if an URB describes an IN transfer
1322 * @urb: URB to be checked
1323 *
1324 * Returns 1 if @urb describes an IN transfer (device-to-host),
1325 * otherwise 0.
1326 */
1327static inline int usb_urb_dir_in(struct urb *urb)
1328{
Alan Sternd617bc82007-08-02 15:04:52 -04001329 return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_IN;
Alan Sternfea34092007-07-30 17:06:16 -04001330}
1331
1332/**
1333 * usb_urb_dir_out - check if an URB describes an OUT transfer
1334 * @urb: URB to be checked
1335 *
1336 * Returns 1 if @urb describes an OUT transfer (host-to-device),
1337 * otherwise 0.
1338 */
1339static inline int usb_urb_dir_out(struct urb *urb)
1340{
1341 return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_OUT;
1342}
1343
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001344void *usb_buffer_alloc(struct usb_device *dev, size_t size,
Al Viro55016f12005-10-21 03:21:58 -04001345 gfp_t mem_flags, dma_addr_t *dma);
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001346void usb_buffer_free(struct usb_device *dev, size_t size,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347 void *addr, dma_addr_t dma);
1348
1349#if 0
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001350struct urb *usb_buffer_map(struct urb *urb);
1351void usb_buffer_dmasync(struct urb *urb);
1352void usb_buffer_unmap(struct urb *urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353#endif
1354
1355struct scatterlist;
Alan Stern5e60a162007-07-30 17:07:21 -04001356int usb_buffer_map_sg(const struct usb_device *dev, int is_in,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -03001357 struct scatterlist *sg, int nents);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358#if 0
Alan Stern5e60a162007-07-30 17:07:21 -04001359void usb_buffer_dmasync_sg(const struct usb_device *dev, int is_in,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -03001360 struct scatterlist *sg, int n_hw_ents);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361#endif
Alan Stern5e60a162007-07-30 17:07:21 -04001362void usb_buffer_unmap_sg(const struct usb_device *dev, int is_in,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -03001363 struct scatterlist *sg, int n_hw_ents);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364
1365/*-------------------------------------------------------------------*
1366 * SYNCHRONOUS CALL SUPPORT *
1367 *-------------------------------------------------------------------*/
1368
1369extern int usb_control_msg(struct usb_device *dev, unsigned int pipe,
1370 __u8 request, __u8 requesttype, __u16 value, __u16 index,
1371 void *data, __u16 size, int timeout);
Greg Kroah-Hartman782a7a62006-05-19 13:20:20 -07001372extern int usb_interrupt_msg(struct usb_device *usb_dev, unsigned int pipe,
1373 void *data, int len, int *actual_length, int timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374extern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,
1375 void *data, int len, int *actual_length,
1376 int timeout);
1377
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378/* wrappers around usb_control_msg() for the most common standard requests */
1379extern int usb_get_descriptor(struct usb_device *dev, unsigned char desctype,
1380 unsigned char descindex, void *buf, int size);
1381extern int usb_get_status(struct usb_device *dev,
1382 int type, int target, void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383extern int usb_string(struct usb_device *dev, int index,
1384 char *buf, size_t size);
1385
1386/* wrappers that also update important state inside usbcore */
1387extern int usb_clear_halt(struct usb_device *dev, int pipe);
1388extern int usb_reset_configuration(struct usb_device *dev);
1389extern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate);
1390
Alan Stern088dc272006-08-21 12:08:19 -04001391/* this request isn't really synchronous, but it belongs with the others */
1392extern int usb_driver_set_configuration(struct usb_device *udev, int config);
1393
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394/*
1395 * timeouts, in milliseconds, used for sending/receiving control messages
1396 * they typically complete within a few frames (msec) after they're issued
1397 * USB identifies 5 second timeouts, maybe more in a few cases, and a few
1398 * slow devices (like some MGE Ellipse UPSes) actually push that limit.
1399 */
1400#define USB_CTRL_GET_TIMEOUT 5000
1401#define USB_CTRL_SET_TIMEOUT 5000
1402
1403
1404/**
1405 * struct usb_sg_request - support for scatter/gather I/O
1406 * @status: zero indicates success, else negative errno
1407 * @bytes: counts bytes transferred.
1408 *
1409 * These requests are initialized using usb_sg_init(), and then are used
1410 * as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most
1411 * members of the request object aren't for driver access.
1412 *
1413 * The status and bytecount values are valid only after usb_sg_wait()
1414 * returns. If the status is zero, then the bytecount matches the total
1415 * from the request.
1416 *
1417 * After an error completion, drivers may need to clear a halt condition
1418 * on the endpoint.
1419 */
1420struct usb_sg_request {
1421 int status;
1422 size_t bytes;
1423
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001424 /*
Martin Waitzaeec46b2005-11-13 16:08:13 -08001425 * members below are private: to usbcore,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426 * and are not provided for driver access!
1427 */
1428 spinlock_t lock;
1429
1430 struct usb_device *dev;
1431 int pipe;
1432 struct scatterlist *sg;
1433 int nents;
1434
1435 int entries;
1436 struct urb **urbs;
1437
1438 int count;
1439 struct completion complete;
1440};
1441
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001442int usb_sg_init(
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443 struct usb_sg_request *io,
1444 struct usb_device *dev,
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001445 unsigned pipe,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446 unsigned period,
1447 struct scatterlist *sg,
1448 int nents,
1449 size_t length,
Al Viro55016f12005-10-21 03:21:58 -04001450 gfp_t mem_flags
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451);
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001452void usb_sg_cancel(struct usb_sg_request *io);
1453void usb_sg_wait(struct usb_sg_request *io);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454
1455
Alan Sternb724ae72005-10-24 15:36:00 -04001456/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457
1458/*
1459 * For various legacy reasons, Linux has a small cookie that's paired with
1460 * a struct usb_device to identify an endpoint queue. Queue characteristics
1461 * are defined by the endpoint's descriptor. This cookie is called a "pipe",
1462 * an unsigned int encoded as:
1463 *
1464 * - direction: bit 7 (0 = Host-to-Device [Out],
1465 * 1 = Device-to-Host [In] ...
1466 * like endpoint bEndpointAddress)
1467 * - device address: bits 8-14 ... bit positions known to uhci-hcd
1468 * - endpoint: bits 15-18 ... bit positions known to uhci-hcd
1469 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
1470 * 10 = control, 11 = bulk)
1471 *
1472 * Given the device address and endpoint descriptor, pipes are redundant.
1473 */
1474
1475/* NOTE: these are not the standard USB_ENDPOINT_XFER_* values!! */
1476/* (yet ... they're the values used by usbfs) */
1477#define PIPE_ISOCHRONOUS 0
1478#define PIPE_INTERRUPT 1
1479#define PIPE_CONTROL 2
1480#define PIPE_BULK 3
1481
1482#define usb_pipein(pipe) ((pipe) & USB_DIR_IN)
1483#define usb_pipeout(pipe) (!usb_pipein(pipe))
1484
1485#define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
1486#define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
1487
1488#define usb_pipetype(pipe) (((pipe) >> 30) & 3)
1489#define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
1490#define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
1491#define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
1492#define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
1493
1494/* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
1495#define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
1496#define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep)))
Alan Sternb724ae72005-10-24 15:36:00 -04001497#define usb_settoggle(dev, ep, out, bit) \
1498 ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \
1499 ((bit) << (ep)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500
1501
Alan Sternb724ae72005-10-24 15:36:00 -04001502static inline unsigned int __create_pipe(struct usb_device *dev,
1503 unsigned int endpoint)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504{
1505 return (dev->devnum << 8) | (endpoint << 15);
1506}
1507
1508/* Create various pipes... */
Alan Sternb724ae72005-10-24 15:36:00 -04001509#define usb_sndctrlpipe(dev,endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001510 ((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint))
Alan Sternb724ae72005-10-24 15:36:00 -04001511#define usb_rcvctrlpipe(dev,endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001512 ((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
Alan Sternb724ae72005-10-24 15:36:00 -04001513#define usb_sndisocpipe(dev,endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001514 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint))
Alan Sternb724ae72005-10-24 15:36:00 -04001515#define usb_rcvisocpipe(dev,endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001516 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
Alan Sternb724ae72005-10-24 15:36:00 -04001517#define usb_sndbulkpipe(dev,endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001518 ((PIPE_BULK << 30) | __create_pipe(dev, endpoint))
Alan Sternb724ae72005-10-24 15:36:00 -04001519#define usb_rcvbulkpipe(dev,endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001520 ((PIPE_BULK << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
Alan Sternb724ae72005-10-24 15:36:00 -04001521#define usb_sndintpipe(dev,endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001522 ((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint))
Alan Sternb724ae72005-10-24 15:36:00 -04001523#define usb_rcvintpipe(dev,endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001524 ((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525
1526/*-------------------------------------------------------------------------*/
1527
1528static inline __u16
1529usb_maxpacket(struct usb_device *udev, int pipe, int is_out)
1530{
1531 struct usb_host_endpoint *ep;
1532 unsigned epnum = usb_pipeendpoint(pipe);
1533
1534 if (is_out) {
1535 WARN_ON(usb_pipein(pipe));
1536 ep = udev->ep_out[epnum];
1537 } else {
1538 WARN_ON(usb_pipeout(pipe));
1539 ep = udev->ep_in[epnum];
1540 }
1541 if (!ep)
1542 return 0;
1543
1544 /* NOTE: only 0x07ff bits are for packet size... */
1545 return le16_to_cpu(ep->desc.wMaxPacketSize);
1546}
1547
Alan Sternb724ae72005-10-24 15:36:00 -04001548/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -07001550/* Events from the usb core */
1551#define USB_DEVICE_ADD 0x0001
1552#define USB_DEVICE_REMOVE 0x0002
1553#define USB_BUS_ADD 0x0003
1554#define USB_BUS_REMOVE 0x0004
1555extern void usb_register_notify(struct notifier_block *nb);
1556extern void usb_unregister_notify(struct notifier_block *nb);
1557
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558#ifdef DEBUG
Alan Sternb724ae72005-10-24 15:36:00 -04001559#define dbg(format, arg...) printk(KERN_DEBUG "%s: " format "\n" , \
1560 __FILE__ , ## arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561#else
1562#define dbg(format, arg...) do {} while (0)
1563#endif
1564
Tilman Schmidtf66396b2008-03-13 19:51:42 +01001565#define err(format, arg...) printk(KERN_ERR KBUILD_MODNAME ": " \
1566 format "\n" , ## arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567
1568#endif /* __KERNEL__ */
1569
1570#endif