blob: 8bc81bffc1954e6b7a7d2e20bd18f7e1632e350a [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 Stern352d0262008-10-29 15:16:58 -0400111 * @unregistering: flag set when the interface is being unregistered
Alan Stern645daaa2006-08-30 15:47:02 -0400112 * @needs_remote_wakeup: flag set when the driver requires remote-wakeup
113 * capability during autosuspend.
Alan Stern55151d72008-08-12 14:33:59 -0400114 * @needs_altsetting0: flag set when a set-interface request for altsetting 0
115 * has been deferred.
Alan Sternf4f4d582008-07-28 10:39:28 -0400116 * @needs_binding: flag set when the driver should be re-probed or unbound
117 * following a reset or suspend operation it doesn't support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 * @dev: driver model's view of this device
Greg Kroah-Hartman0873c762006-06-20 13:09:50 -0700119 * @usb_dev: if an interface is bound to the USB major, this will point
120 * to the sysfs representation for that device.
Alan Stern645daaa2006-08-30 15:47:02 -0400121 * @pm_usage_cnt: PM usage counter for this interface; autosuspend is not
122 * allowed unless the counter is 0.
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -0800123 * @reset_ws: Used for scheduling resets from atomic context.
124 * @reset_running: set to 1 if the interface is currently running a
125 * queued reset so that usb_cancel_queued_reset() doesn't try to
126 * remove from the workqueue when running inside the worker
127 * thread. See __usb_queue_reset_device().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 *
129 * USB device drivers attach to interfaces on a physical device. Each
130 * interface encapsulates a single high level function, such as feeding
131 * an audio stream to a speaker or reporting a change in a volume control.
132 * Many USB devices only have one interface. The protocol used to talk to
133 * an interface's endpoints can be defined in a usb "class" specification,
134 * or by a product's vendor. The (default) control endpoint is part of
135 * every interface, but is never listed among the interface's descriptors.
136 *
137 * The driver that is bound to the interface can use standard driver model
138 * calls such as dev_get_drvdata() on the dev member of this structure.
139 *
140 * Each interface may have alternate settings. The initial configuration
141 * of a device sets altsetting 0, but the device driver can change
142 * that setting using usb_set_interface(). Alternate settings are often
Michael Opdenacker59c51592007-05-09 08:57:56 +0200143 * used to control the use of periodic endpoints, such as by having
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 * different endpoints use different amounts of reserved USB bandwidth.
145 * All standards-conformant USB devices that use isochronous endpoints
146 * will use them in non-default settings.
147 *
148 * The USB specification says that alternate setting numbers must run from
149 * 0 to one less than the total number of alternate settings. But some
150 * devices manage to mess this up, and the structures aren't necessarily
151 * stored in numerical order anyhow. Use usb_altnum_to_altsetting() to
152 * look up an alternate setting in the altsetting array based on its number.
153 */
154struct usb_interface {
155 /* array of alternate settings for this interface,
156 * stored in no particular order */
157 struct usb_host_interface *altsetting;
158
159 struct usb_host_interface *cur_altsetting; /* the currently
160 * active alternate setting */
161 unsigned num_altsetting; /* number of alternate settings */
162
Craig W. Nadler165fe972007-06-15 23:14:35 -0400163 /* If there is an interface association descriptor then it will list
164 * the associated interfaces */
165 struct usb_interface_assoc_descriptor *intf_assoc;
166
Alan Sternb724ae72005-10-24 15:36:00 -0400167 int minor; /* minor number this interface is
168 * bound to */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 enum usb_interface_condition condition; /* state of binding */
Alan Stern4d064c02006-07-01 22:11:44 -0400170 unsigned is_active:1; /* the interface is not suspended */
Alan Stern7e615592007-11-06 11:43:42 -0500171 unsigned sysfs_files_created:1; /* the sysfs attributes exist */
Alan Stern352d0262008-10-29 15:16:58 -0400172 unsigned unregistering:1; /* unregistration is in progress */
Alan Stern645daaa2006-08-30 15:47:02 -0400173 unsigned needs_remote_wakeup:1; /* driver requires remote wakeup */
Alan Stern55151d72008-08-12 14:33:59 -0400174 unsigned needs_altsetting0:1; /* switch to altsetting 0 is pending */
Alan Stern78d9a482008-06-23 16:00:40 -0400175 unsigned needs_binding:1; /* needs delayed unbind/rebind */
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -0800176 unsigned reset_running:1;
Alan Stern4d064c02006-07-01 22:11:44 -0400177
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 struct device dev; /* interface specific device info */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800179 struct device *usb_dev;
Alan Stern645daaa2006-08-30 15:47:02 -0400180 int pm_usage_cnt; /* usage counter for autosuspend */
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -0800181 struct work_struct reset_ws; /* for resets in atomic context */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182};
183#define to_usb_interface(d) container_of(d, struct usb_interface, dev)
184#define interface_to_usbdev(intf) \
185 container_of(intf->dev.parent, struct usb_device, dev)
186
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800187static inline void *usb_get_intfdata(struct usb_interface *intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188{
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800189 return dev_get_drvdata(&intf->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190}
191
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800192static inline void usb_set_intfdata(struct usb_interface *intf, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193{
194 dev_set_drvdata(&intf->dev, data);
195}
196
197struct usb_interface *usb_get_intf(struct usb_interface *intf);
198void usb_put_intf(struct usb_interface *intf);
199
200/* this maximum is arbitrary */
201#define USB_MAXINTERFACES 32
Craig W. Nadler165fe972007-06-15 23:14:35 -0400202#define USB_MAXIADS USB_MAXINTERFACES/2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203
204/**
205 * struct usb_interface_cache - long-term representation of a device interface
206 * @num_altsetting: number of altsettings defined.
207 * @ref: reference counter.
208 * @altsetting: variable-length array of interface structures, one for
209 * each alternate setting that may be selected. Each one includes a
210 * set of endpoint configurations. They will be in no particular order.
211 *
212 * These structures persist for the lifetime of a usb_device, unlike
213 * struct usb_interface (which persists only as long as its configuration
214 * is installed). The altsetting arrays can be accessed through these
215 * structures at any time, permitting comparison of configurations and
216 * providing support for the /proc/bus/usb/devices pseudo-file.
217 */
218struct usb_interface_cache {
219 unsigned num_altsetting; /* number of alternate settings */
220 struct kref ref; /* reference counter */
221
222 /* variable-length array of alternate settings for this interface,
223 * stored in no particular order */
224 struct usb_host_interface altsetting[0];
225};
226#define ref_to_usb_interface_cache(r) \
227 container_of(r, struct usb_interface_cache, ref)
228#define altsetting_to_usb_interface_cache(a) \
229 container_of(a, struct usb_interface_cache, altsetting[0])
230
231/**
232 * struct usb_host_config - representation of a device's configuration
233 * @desc: the device's configuration descriptor.
234 * @string: pointer to the cached version of the iConfiguration string, if
235 * present for this configuration.
Randy Dunlap3f423782007-07-19 10:21:37 -0700236 * @intf_assoc: list of any interface association descriptors in this config
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 * @interface: array of pointers to usb_interface structures, one for each
238 * interface in the configuration. The number of interfaces is stored
239 * in desc.bNumInterfaces. These pointers are valid only while the
240 * the configuration is active.
241 * @intf_cache: array of pointers to usb_interface_cache structures, one
242 * for each interface in the configuration. These structures exist
243 * for the entire life of the device.
244 * @extra: pointer to buffer containing all extra descriptors associated
245 * with this configuration (those preceding the first interface
246 * descriptor).
247 * @extralen: length of the extra descriptors buffer.
248 *
249 * USB devices may have multiple configurations, but only one can be active
250 * at any time. Each encapsulates a different operational environment;
251 * for example, a dual-speed device would have separate configurations for
252 * full-speed and high-speed operation. The number of configurations
253 * available is stored in the device descriptor as bNumConfigurations.
254 *
255 * A configuration can contain multiple interfaces. Each corresponds to
256 * a different function of the USB device, and all are available whenever
257 * the configuration is active. The USB standard says that interfaces
258 * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot
259 * of devices get this wrong. In addition, the interface array is not
260 * guaranteed to be sorted in numerical order. Use usb_ifnum_to_if() to
261 * look up an interface entry based on its number.
262 *
263 * Device drivers should not attempt to activate configurations. The choice
264 * of which configuration to install is a policy decision based on such
265 * considerations as available power, functionality provided, and the user's
Kay Sievers312c0042005-11-16 09:00:00 +0100266 * desires (expressed through userspace tools). However, drivers can call
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 * usb_reset_configuration() to reinitialize the current configuration and
268 * all its interfaces.
269 */
270struct usb_host_config {
271 struct usb_config_descriptor desc;
272
Alan Stern4f62efe2005-10-24 16:24:14 -0400273 char *string; /* iConfiguration string, if present */
Craig W. Nadler165fe972007-06-15 23:14:35 -0400274
275 /* List of any Interface Association Descriptors in this
276 * configuration. */
277 struct usb_interface_assoc_descriptor *intf_assoc[USB_MAXIADS];
278
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 /* the interfaces associated with this configuration,
280 * stored in no particular order */
281 struct usb_interface *interface[USB_MAXINTERFACES];
282
283 /* Interface information available even when this is not the
284 * active configuration */
285 struct usb_interface_cache *intf_cache[USB_MAXINTERFACES];
286
287 unsigned char *extra; /* Extra descriptors */
288 int extralen;
289};
290
291int __usb_get_extra_descriptor(char *buffer, unsigned size,
292 unsigned char type, void **ptr);
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800293#define usb_get_extra_descriptor(ifpoint, type, ptr) \
294 __usb_get_extra_descriptor((ifpoint)->extra, \
295 (ifpoint)->extralen, \
296 type, (void **)ptr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297
Alan Sternb724ae72005-10-24 15:36:00 -0400298/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300/* USB device number allocation bitmap */
301struct usb_devmap {
302 unsigned long devicemap[128 / (8*sizeof(unsigned long))];
303};
304
305/*
306 * Allocated per bus (tree of devices) we have:
307 */
308struct usb_bus {
309 struct device *controller; /* host/master side hardware */
310 int busnum; /* Bus number (in order of reg) */
Greg Kroah-Hartman1b26da12008-07-02 12:46:22 -0700311 const char *bus_name; /* stable id (PCI slot_name etc) */
Alan Sterndd990f12006-08-30 11:29:56 -0400312 u8 uses_dma; /* Does the host controller use DMA? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 u8 otg_port; /* 0, or number of OTG/HNP port */
314 unsigned is_b_host:1; /* true during some HNP roleswitches */
315 unsigned b_hnp_enable:1; /* OTG: did A-Host enable HNP? */
316
Alan Sternb724ae72005-10-24 15:36:00 -0400317 int devnum_next; /* Next open device number in
318 * round-robin allocation */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319
320 struct usb_devmap devmap; /* device address allocation map */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 struct usb_device *root_hub; /* Root hub */
322 struct list_head bus_list; /* list of busses */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323
324 int bandwidth_allocated; /* on this bus: how much of the time
325 * reserved for periodic (intr/iso)
326 * requests is used, on average?
327 * Units: microseconds/frame.
328 * Limits: Full/low speed reserve 90%,
329 * while high speed reserves 80%.
330 */
331 int bandwidth_int_reqs; /* number of Interrupt requests */
332 int bandwidth_isoc_reqs; /* number of Isoc. requests */
333
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100334#ifdef CONFIG_USB_DEVICEFS
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 struct dentry *usbfs_dentry; /* usbfs dentry entry for the bus */
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100336#endif
Tony Jones5a3201b2007-09-11 14:07:31 -0700337 struct device *dev; /* device for this bus */
Alan Sternb724ae72005-10-24 15:36:00 -0400338
Pete Zaitcevf150fa12008-11-13 21:31:21 -0700339#if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 struct mon_bus *mon_bus; /* non-null when associated */
341 int monitored; /* non-zero when monitored */
342#endif
343};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344
Alan Sternb724ae72005-10-24 15:36:00 -0400345/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346
347/* This is arbitrary.
348 * From USB 2.0 spec Table 11-13, offset 7, a hub can
349 * have up to 255 ports. The most yet reported is 10.
inaky@linux.intel.com43705252006-10-11 20:05:58 -0700350 *
351 * Current Wireless USB host hardware (Intel i1480 for example) allows
352 * up to 22 devices to connect. Upcoming hardware might raise that
353 * limit. Because the arrays need to add a bit for hub status data, we
354 * do 31, so plus one evens out to four bytes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 */
inaky@linux.intel.com43705252006-10-11 20:05:58 -0700356#define USB_MAXCHILDREN (31)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357
358struct usb_tt;
359
Randy Dunlapf476fba2008-02-13 18:33:15 -0800360/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361 * struct usb_device - kernel's representation of a USB device
Randy Dunlapf476fba2008-02-13 18:33:15 -0800362 * @devnum: device number; address on a USB bus
363 * @devpath: device ID string for use in messages (e.g., /port/...)
364 * @state: device state: configured, not attached, etc.
365 * @speed: device speed: high/full/low (or error)
366 * @tt: Transaction Translator info; used with low/full speed dev, highspeed hub
367 * @ttport: device port on that tt hub
368 * @toggle: one bit for each endpoint, with ([0] = IN, [1] = OUT) endpoints
369 * @parent: our hub, unless we're the root
370 * @bus: bus we're part of
371 * @ep0: endpoint 0 data (default control pipe)
372 * @dev: generic device interface
373 * @descriptor: USB device descriptor
374 * @config: all of the device's configs
375 * @actconfig: the active configuration
376 * @ep_in: array of IN endpoints
377 * @ep_out: array of OUT endpoints
378 * @rawdescriptors: raw descriptors for each config
379 * @bus_mA: Current available from the bus
380 * @portnum: parent port number (origin 1)
381 * @level: number of USB hub ancestors
382 * @can_submit: URBs may be submitted
383 * @discon_suspended: disconnected while suspended
384 * @persist_enabled: USB_PERSIST enabled for this device
385 * @have_langid: whether string_langid is valid
386 * @authorized: policy has said we can use it;
387 * (user space) policy determines if we authorize this device to be
388 * used or not. By default, wired USB devices are authorized.
389 * WUSB devices are not, until we authorize them from user space.
390 * FIXME -- complete doc
Inaky Perez-Gonzalez3b52f122008-04-08 13:24:46 -0700391 * @authenticated: Crypto authentication passed
Randy Dunlapf476fba2008-02-13 18:33:15 -0800392 * @wusb: device is Wireless USB
393 * @string_langid: language ID for strings
394 * @product: iProduct string, if present (static)
395 * @manufacturer: iManufacturer string, if present (static)
396 * @serial: iSerialNumber string, if present (static)
397 * @filelist: usbfs files that are open to this device
398 * @usb_classdev: USB class device that was created for usbfs device
399 * access from userspace
400 * @usbfs_dentry: usbfs dentry entry for the device
401 * @maxchild: number of ports if hub
402 * @children: child devices - USB devices that are attached to this hub
403 * @pm_usage_cnt: usage counter for autosuspend
404 * @quirks: quirks of the whole device
405 * @urbnum: number of URBs submitted for the whole device
406 * @active_duration: total time device is not suspended
407 * @autosuspend: for delayed autosuspends
Alan Stern9ac39f22008-11-12 16:19:49 -0500408 * @autoresume: for autoresumes requested while in_interrupt
Randy Dunlapf476fba2008-02-13 18:33:15 -0800409 * @pm_mutex: protects PM operations
410 * @last_busy: time of last use
411 * @autosuspend_delay: in jiffies
412 * @connect_time: time device was first connected
413 * @auto_pm: autosuspend/resume in progress
414 * @do_remote_wakeup: remote wakeup should be enabled
415 * @reset_resume: needs reset instead of resume
416 * @autosuspend_disabled: autosuspend disabled by the user
417 * @autoresume_disabled: autoresume disabled by the user
418 * @skip_sys_resume: skip the next system resume
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 *
Randy Dunlapf476fba2008-02-13 18:33:15 -0800420 * Notes:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 * Usbcore drivers should not set usbdev->state directly. Instead use
422 * usb_set_device_state().
423 */
424struct usb_device {
Randy Dunlapf476fba2008-02-13 18:33:15 -0800425 int devnum;
426 char devpath [16];
427 enum usb_device_state state;
428 enum usb_device_speed speed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429
Randy Dunlapf476fba2008-02-13 18:33:15 -0800430 struct usb_tt *tt;
431 int ttport;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432
Randy Dunlapf476fba2008-02-13 18:33:15 -0800433 unsigned int toggle[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434
Randy Dunlapf476fba2008-02-13 18:33:15 -0800435 struct usb_device *parent;
436 struct usb_bus *bus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 struct usb_host_endpoint ep0;
438
Randy Dunlapf476fba2008-02-13 18:33:15 -0800439 struct device dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440
Randy Dunlapf476fba2008-02-13 18:33:15 -0800441 struct usb_device_descriptor descriptor;
442 struct usb_host_config *config;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443
Randy Dunlapf476fba2008-02-13 18:33:15 -0800444 struct usb_host_config *actconfig;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 struct usb_host_endpoint *ep_in[16];
446 struct usb_host_endpoint *ep_out[16];
447
Randy Dunlapf476fba2008-02-13 18:33:15 -0800448 char **rawdescriptors;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449
Randy Dunlapf476fba2008-02-13 18:33:15 -0800450 unsigned short bus_mA;
451 u8 portnum;
452 u8 level;
Alan Stern55c52712005-11-23 12:03:12 -0500453
Randy Dunlapf476fba2008-02-13 18:33:15 -0800454 unsigned can_submit:1;
455 unsigned discon_suspended:1;
456 unsigned persist_enabled:1;
457 unsigned have_langid:1;
458 unsigned authorized:1;
Inaky Perez-Gonzalez3b52f122008-04-08 13:24:46 -0700459 unsigned authenticated:1;
Randy Dunlapf476fba2008-02-13 18:33:15 -0800460 unsigned wusb:1;
461 int string_langid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462
Alan Stern4f62efe2005-10-24 16:24:14 -0400463 /* static strings from the device */
Randy Dunlapf476fba2008-02-13 18:33:15 -0800464 char *product;
465 char *manufacturer;
466 char *serial;
Alan Stern4f62efe2005-10-24 16:24:14 -0400467
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 struct list_head filelist;
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100469#ifdef CONFIG_USB_DEVICE_CLASS
470 struct device *usb_classdev;
471#endif
472#ifdef CONFIG_USB_DEVICEFS
Randy Dunlapf476fba2008-02-13 18:33:15 -0800473 struct dentry *usbfs_dentry;
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100474#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475
Randy Dunlapf476fba2008-02-13 18:33:15 -0800476 int maxchild;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 struct usb_device *children[USB_MAXCHILDREN];
Alan Stern645daaa2006-08-30 15:47:02 -0400478
Randy Dunlapf476fba2008-02-13 18:33:15 -0800479 int pm_usage_cnt;
480 u32 quirks;
481 atomic_t urbnum;
Alan Sternb5e795f2007-02-20 15:00:53 -0500482
Randy Dunlapf476fba2008-02-13 18:33:15 -0800483 unsigned long active_duration;
Sarah Sharp15123002007-12-21 16:54:15 -0800484
Alan Stern645daaa2006-08-30 15:47:02 -0400485#ifdef CONFIG_PM
Randy Dunlapf476fba2008-02-13 18:33:15 -0800486 struct delayed_work autosuspend;
Alan Stern9ac39f22008-11-12 16:19:49 -0500487 struct work_struct autoresume;
Randy Dunlapf476fba2008-02-13 18:33:15 -0800488 struct mutex pm_mutex;
Alan Stern645daaa2006-08-30 15:47:02 -0400489
Randy Dunlapf476fba2008-02-13 18:33:15 -0800490 unsigned long last_busy;
491 int autosuspend_delay;
492 unsigned long connect_time;
Alan Sternb5e795f2007-02-20 15:00:53 -0500493
Randy Dunlapf476fba2008-02-13 18:33:15 -0800494 unsigned auto_pm:1;
495 unsigned do_remote_wakeup:1;
496 unsigned reset_resume:1;
497 unsigned autosuspend_disabled:1;
498 unsigned autoresume_disabled:1;
499 unsigned skip_sys_resume:1;
Alan Stern645daaa2006-08-30 15:47:02 -0400500#endif
Inaky Perez-Gonzalezb1d8dfb2008-04-08 13:24:46 -0700501 struct wusb_dev *wusb_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502};
503#define to_usb_device(d) container_of(d, struct usb_device, dev)
504
505extern struct usb_device *usb_get_dev(struct usb_device *dev);
506extern void usb_put_dev(struct usb_device *dev);
507
Alan Stern9ad3d6c2005-11-17 17:10:32 -0500508/* USB device locking */
509#define usb_lock_device(udev) down(&(udev)->dev.sem)
510#define usb_unlock_device(udev) up(&(udev)->dev.sem)
511#define usb_trylock_device(udev) down_trylock(&(udev)->dev.sem)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512extern int usb_lock_device_for_reset(struct usb_device *udev,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300513 const struct usb_interface *iface);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514
515/* USB port reset for device reinitialization */
516extern int usb_reset_device(struct usb_device *dev);
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -0800517extern void usb_queue_reset_device(struct usb_interface *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518
519extern struct usb_device *usb_find_device(u16 vendor_id, u16 product_id);
520
Alan Stern645daaa2006-08-30 15:47:02 -0400521/* USB autosuspend and autoresume */
522#ifdef CONFIG_USB_SUSPEND
Alan Stern692a1862006-10-30 17:07:51 -0500523extern int usb_autopm_set_interface(struct usb_interface *intf);
Alan Stern645daaa2006-08-30 15:47:02 -0400524extern int usb_autopm_get_interface(struct usb_interface *intf);
525extern void usb_autopm_put_interface(struct usb_interface *intf);
Alan Stern9ac39f22008-11-12 16:19:49 -0500526extern int usb_autopm_get_interface_async(struct usb_interface *intf);
527extern void usb_autopm_put_interface_async(struct usb_interface *intf);
Alan Stern645daaa2006-08-30 15:47:02 -0400528
Alan Stern692a1862006-10-30 17:07:51 -0500529static inline void usb_autopm_enable(struct usb_interface *intf)
530{
531 intf->pm_usage_cnt = 0;
532 usb_autopm_set_interface(intf);
533}
Alan Stern645daaa2006-08-30 15:47:02 -0400534
Alan Stern692a1862006-10-30 17:07:51 -0500535static inline void usb_autopm_disable(struct usb_interface *intf)
536{
537 intf->pm_usage_cnt = 1;
538 usb_autopm_set_interface(intf);
539}
540
Alan Stern19410442007-03-27 13:33:59 -0400541static inline void usb_mark_last_busy(struct usb_device *udev)
542{
543 udev->last_busy = jiffies;
544}
545
Alan Stern692a1862006-10-30 17:07:51 -0500546#else
547
548static inline int usb_autopm_set_interface(struct usb_interface *intf)
549{ return 0; }
550
551static inline int usb_autopm_get_interface(struct usb_interface *intf)
552{ return 0; }
553
Alan Stern9ac39f22008-11-12 16:19:49 -0500554static inline int usb_autopm_get_interface_async(struct usb_interface *intf)
555{ return 0; }
556
Alan Stern692a1862006-10-30 17:07:51 -0500557static inline void usb_autopm_put_interface(struct usb_interface *intf)
558{ }
Alan Stern9ac39f22008-11-12 16:19:49 -0500559static inline void usb_autopm_put_interface_async(struct usb_interface *intf)
560{ }
Alan Stern692a1862006-10-30 17:07:51 -0500561static inline void usb_autopm_enable(struct usb_interface *intf)
562{ }
563static inline void usb_autopm_disable(struct usb_interface *intf)
564{ }
Alan Stern19410442007-03-27 13:33:59 -0400565static inline void usb_mark_last_busy(struct usb_device *udev)
566{ }
Alan Stern692a1862006-10-30 17:07:51 -0500567#endif
Alan Stern645daaa2006-08-30 15:47:02 -0400568
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569/*-------------------------------------------------------------------------*/
570
571/* for drivers using iso endpoints */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800572extern int usb_get_current_frame_number(struct usb_device *usb_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573
574/* used these for multi-interface device registration */
575extern int usb_driver_claim_interface(struct usb_driver *driver,
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800576 struct usb_interface *iface, void *priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577
578/**
579 * usb_interface_claimed - returns true iff an interface is claimed
580 * @iface: the interface being checked
581 *
582 * Returns true (nonzero) iff the interface is claimed, else false (zero).
583 * Callers must own the driver model's usb bus readlock. So driver
584 * probe() entries don't need extra locking, but other call contexts
585 * may need to explicitly claim that lock.
586 *
587 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800588static inline int usb_interface_claimed(struct usb_interface *iface)
589{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 return (iface->dev.driver != NULL);
591}
592
593extern void usb_driver_release_interface(struct usb_driver *driver,
594 struct usb_interface *iface);
595const struct usb_device_id *usb_match_id(struct usb_interface *interface,
596 const struct usb_device_id *id);
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +0100597extern int usb_match_one_id(struct usb_interface *interface,
598 const struct usb_device_id *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599
600extern struct usb_interface *usb_find_interface(struct usb_driver *drv,
601 int minor);
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300602extern struct usb_interface *usb_ifnum_to_if(const struct usb_device *dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 unsigned ifnum);
604extern struct usb_host_interface *usb_altnum_to_altsetting(
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300605 const struct usb_interface *intf, unsigned int altnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606
607
608/**
609 * usb_make_path - returns stable device path in the usb tree
610 * @dev: the device whose path is being constructed
611 * @buf: where to put the string
612 * @size: how big is "buf"?
613 *
614 * Returns length of the string (> 0) or negative if size was too small.
615 *
616 * This identifier is intended to be "stable", reflecting physical paths in
617 * hardware such as physical bus addresses for host controllers or ports on
618 * USB hubs. That makes it stay the same until systems are physically
619 * reconfigured, by re-cabling a tree of USB devices or by moving USB host
620 * controllers. Adding and removing devices, including virtual root hubs
621 * in host controller driver modules, does not change these path identifers;
622 * neither does rebooting or re-enumerating. These are more useful identifiers
623 * than changeable ("unstable") ones like bus numbers or device addresses.
624 *
625 * With a partial exception for devices connected to USB 2.0 root hubs, these
626 * identifiers are also predictable. So long as the device tree isn't changed,
627 * plugging any USB device into a given hub port always gives it the same path.
628 * Because of the use of "companion" controllers, devices connected to ports on
629 * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are
630 * high speed, and a different one if they are full or low speed.
631 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800632static inline int usb_make_path(struct usb_device *dev, char *buf, size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633{
634 int actual;
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800635 actual = snprintf(buf, size, "usb-%s-%s", dev->bus->bus_name,
636 dev->devpath);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637 return (actual >= (int)size) ? -1 : actual;
638}
639
640/*-------------------------------------------------------------------------*/
641
Luiz Fernando N. Capitulino0c1ac4f2006-10-30 14:53:03 -0300642/**
Alan Stern5b653c72007-07-30 17:04:37 -0400643 * usb_endpoint_num - get the endpoint's number
644 * @epd: endpoint to be checked
645 *
646 * Returns @epd's number: 0 to 15.
647 */
648static inline int usb_endpoint_num(const struct usb_endpoint_descriptor *epd)
649{
650 return epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
651}
652
653/**
654 * usb_endpoint_type - get the endpoint's transfer type
655 * @epd: endpoint to be checked
656 *
657 * Returns one of USB_ENDPOINT_XFER_{CONTROL, ISOC, BULK, INT} according
658 * to @epd's transfer type.
659 */
660static inline int usb_endpoint_type(const struct usb_endpoint_descriptor *epd)
661{
662 return epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
663}
664
665/**
Luiz Fernando N. Capitulino0c1ac4f2006-10-30 14:53:03 -0300666 * usb_endpoint_dir_in - check if the endpoint has IN direction
667 * @epd: endpoint to be checked
668 *
669 * Returns true if the endpoint is of type IN, otherwise it returns false.
670 */
671static inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor *epd)
672{
673 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN);
674}
675
676/**
677 * usb_endpoint_dir_out - check if the endpoint has OUT direction
678 * @epd: endpoint to be checked
679 *
680 * Returns true if the endpoint is of type OUT, otherwise it returns false.
681 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800682static inline int usb_endpoint_dir_out(
683 const struct usb_endpoint_descriptor *epd)
Luiz Fernando N. Capitulino0c1ac4f2006-10-30 14:53:03 -0300684{
685 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT);
686}
687
688/**
689 * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type
690 * @epd: endpoint to be checked
691 *
692 * Returns true if the endpoint is of type bulk, otherwise it returns false.
693 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800694static inline int usb_endpoint_xfer_bulk(
695 const struct usb_endpoint_descriptor *epd)
Luiz Fernando N. Capitulino0c1ac4f2006-10-30 14:53:03 -0300696{
697 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
698 USB_ENDPOINT_XFER_BULK);
699}
700
701/**
Sarah Baileya8ef36b2006-12-23 23:14:58 -0800702 * usb_endpoint_xfer_control - check if the endpoint has control transfer type
703 * @epd: endpoint to be checked
704 *
705 * Returns true if the endpoint is of type control, otherwise it returns false.
706 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800707static inline int usb_endpoint_xfer_control(
708 const struct usb_endpoint_descriptor *epd)
Sarah Baileya8ef36b2006-12-23 23:14:58 -0800709{
710 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
711 USB_ENDPOINT_XFER_CONTROL);
712}
713
714/**
Luiz Fernando N. Capitulino0c1ac4f2006-10-30 14:53:03 -0300715 * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type
716 * @epd: endpoint to be checked
717 *
718 * Returns true if the endpoint is of type interrupt, otherwise it returns
719 * false.
720 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800721static inline int usb_endpoint_xfer_int(
722 const struct usb_endpoint_descriptor *epd)
Luiz Fernando N. Capitulino0c1ac4f2006-10-30 14:53:03 -0300723{
724 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
725 USB_ENDPOINT_XFER_INT);
726}
727
728/**
729 * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type
730 * @epd: endpoint to be checked
731 *
732 * Returns true if the endpoint is of type isochronous, otherwise it returns
733 * false.
734 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800735static inline int usb_endpoint_xfer_isoc(
736 const struct usb_endpoint_descriptor *epd)
Luiz Fernando N. Capitulino0c1ac4f2006-10-30 14:53:03 -0300737{
738 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
739 USB_ENDPOINT_XFER_ISOC);
740}
741
742/**
743 * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN
744 * @epd: endpoint to be checked
745 *
746 * Returns true if the endpoint has bulk transfer type and IN direction,
747 * otherwise it returns false.
748 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800749static inline int usb_endpoint_is_bulk_in(
750 const struct usb_endpoint_descriptor *epd)
Luiz Fernando N. Capitulino0c1ac4f2006-10-30 14:53:03 -0300751{
752 return (usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_in(epd));
753}
754
755/**
756 * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT
757 * @epd: endpoint to be checked
758 *
759 * Returns true if the endpoint has bulk transfer type and OUT direction,
760 * otherwise it returns false.
761 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800762static inline int usb_endpoint_is_bulk_out(
763 const struct usb_endpoint_descriptor *epd)
Luiz Fernando N. Capitulino0c1ac4f2006-10-30 14:53:03 -0300764{
765 return (usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_out(epd));
766}
767
768/**
769 * usb_endpoint_is_int_in - check if the endpoint is interrupt IN
770 * @epd: endpoint to be checked
771 *
772 * Returns true if the endpoint has interrupt transfer type and IN direction,
773 * otherwise it returns false.
774 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800775static inline int usb_endpoint_is_int_in(
776 const struct usb_endpoint_descriptor *epd)
Luiz Fernando N. Capitulino0c1ac4f2006-10-30 14:53:03 -0300777{
778 return (usb_endpoint_xfer_int(epd) && usb_endpoint_dir_in(epd));
779}
780
781/**
782 * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT
783 * @epd: endpoint to be checked
784 *
785 * Returns true if the endpoint has interrupt transfer type and OUT direction,
786 * otherwise it returns false.
787 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800788static inline int usb_endpoint_is_int_out(
789 const struct usb_endpoint_descriptor *epd)
Luiz Fernando N. Capitulino0c1ac4f2006-10-30 14:53:03 -0300790{
791 return (usb_endpoint_xfer_int(epd) && usb_endpoint_dir_out(epd));
792}
793
794/**
795 * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN
796 * @epd: endpoint to be checked
797 *
798 * Returns true if the endpoint has isochronous transfer type and IN direction,
799 * otherwise it returns false.
800 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800801static inline int usb_endpoint_is_isoc_in(
802 const struct usb_endpoint_descriptor *epd)
Luiz Fernando N. Capitulino0c1ac4f2006-10-30 14:53:03 -0300803{
804 return (usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_in(epd));
805}
806
807/**
808 * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT
809 * @epd: endpoint to be checked
810 *
811 * Returns true if the endpoint has isochronous transfer type and OUT direction,
812 * otherwise it returns false.
813 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800814static inline int usb_endpoint_is_isoc_out(
815 const struct usb_endpoint_descriptor *epd)
Luiz Fernando N. Capitulino0c1ac4f2006-10-30 14:53:03 -0300816{
817 return (usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_out(epd));
818}
Luiz Fernando N. Capitulinob7cfaaa2006-09-27 11:58:53 -0700819
820/*-------------------------------------------------------------------------*/
821
Alan Sternb724ae72005-10-24 15:36:00 -0400822#define USB_DEVICE_ID_MATCH_DEVICE \
823 (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
824#define USB_DEVICE_ID_MATCH_DEV_RANGE \
825 (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI)
826#define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
827 (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828#define USB_DEVICE_ID_MATCH_DEV_INFO \
Alan Sternb724ae72005-10-24 15:36:00 -0400829 (USB_DEVICE_ID_MATCH_DEV_CLASS | \
830 USB_DEVICE_ID_MATCH_DEV_SUBCLASS | \
831 USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832#define USB_DEVICE_ID_MATCH_INT_INFO \
Alan Sternb724ae72005-10-24 15:36:00 -0400833 (USB_DEVICE_ID_MATCH_INT_CLASS | \
834 USB_DEVICE_ID_MATCH_INT_SUBCLASS | \
835 USB_DEVICE_ID_MATCH_INT_PROTOCOL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836
837/**
838 * USB_DEVICE - macro used to describe a specific usb device
839 * @vend: the 16 bit USB Vendor ID
840 * @prod: the 16 bit USB Product ID
841 *
842 * This macro is used to create a struct usb_device_id that matches a
843 * specific device.
844 */
845#define USB_DEVICE(vend,prod) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800846 .match_flags = USB_DEVICE_ID_MATCH_DEVICE, \
847 .idVendor = (vend), \
848 .idProduct = (prod)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849/**
Randy Dunlapd0bcabc2008-02-29 22:03:07 -0800850 * USB_DEVICE_VER - describe a specific usb device with a version range
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851 * @vend: the 16 bit USB Vendor ID
852 * @prod: the 16 bit USB Product ID
853 * @lo: the bcdDevice_lo value
854 * @hi: the bcdDevice_hi value
855 *
856 * This macro is used to create a struct usb_device_id that matches a
857 * specific device, with a version range.
858 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800859#define USB_DEVICE_VER(vend, prod, lo, hi) \
Alan Sternb724ae72005-10-24 15:36:00 -0400860 .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800861 .idVendor = (vend), \
862 .idProduct = (prod), \
863 .bcdDevice_lo = (lo), \
864 .bcdDevice_hi = (hi)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865
866/**
Randy Dunlapd0bcabc2008-02-29 22:03:07 -0800867 * USB_DEVICE_INTERFACE_PROTOCOL - describe a usb device with a specific interface protocol
Jan Kratochvilf836ac82007-05-09 00:26:15 -0400868 * @vend: the 16 bit USB Vendor ID
869 * @prod: the 16 bit USB Product ID
870 * @pr: bInterfaceProtocol value
871 *
872 * This macro is used to create a struct usb_device_id that matches a
873 * specific interface protocol of devices.
874 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800875#define USB_DEVICE_INTERFACE_PROTOCOL(vend, prod, pr) \
876 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
877 USB_DEVICE_ID_MATCH_INT_PROTOCOL, \
Jan Kratochvilf836ac82007-05-09 00:26:15 -0400878 .idVendor = (vend), \
879 .idProduct = (prod), \
880 .bInterfaceProtocol = (pr)
881
882/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883 * USB_DEVICE_INFO - macro used to describe a class of usb devices
884 * @cl: bDeviceClass value
885 * @sc: bDeviceSubClass value
886 * @pr: bDeviceProtocol value
887 *
888 * This macro is used to create a struct usb_device_id that matches a
889 * specific class of devices.
890 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800891#define USB_DEVICE_INFO(cl, sc, pr) \
892 .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, \
893 .bDeviceClass = (cl), \
894 .bDeviceSubClass = (sc), \
895 .bDeviceProtocol = (pr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896
897/**
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800898 * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899 * @cl: bInterfaceClass value
900 * @sc: bInterfaceSubClass value
901 * @pr: bInterfaceProtocol value
902 *
903 * This macro is used to create a struct usb_device_id that matches a
904 * specific class of interfaces.
905 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800906#define USB_INTERFACE_INFO(cl, sc, pr) \
907 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, \
908 .bInterfaceClass = (cl), \
909 .bInterfaceSubClass = (sc), \
910 .bInterfaceProtocol = (pr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911
Daniel Drake8538f962007-05-10 00:32:24 +0100912/**
Randy Dunlapd0bcabc2008-02-29 22:03:07 -0800913 * USB_DEVICE_AND_INTERFACE_INFO - describe a specific usb device with a class of usb interfaces
Daniel Drake8538f962007-05-10 00:32:24 +0100914 * @vend: the 16 bit USB Vendor ID
915 * @prod: the 16 bit USB Product ID
916 * @cl: bInterfaceClass value
917 * @sc: bInterfaceSubClass value
918 * @pr: bInterfaceProtocol value
919 *
920 * This macro is used to create a struct usb_device_id that matches a
921 * specific device with a specific class of interfaces.
922 *
923 * This is especially useful when explicitly matching devices that have
924 * vendor specific bDeviceClass values, but standards-compliant interfaces.
925 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800926#define USB_DEVICE_AND_INTERFACE_INFO(vend, prod, cl, sc, pr) \
Daniel Drake8538f962007-05-10 00:32:24 +0100927 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO \
928 | USB_DEVICE_ID_MATCH_DEVICE, \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800929 .idVendor = (vend), \
930 .idProduct = (prod), \
Daniel Drake8538f962007-05-10 00:32:24 +0100931 .bInterfaceClass = (cl), \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -0800932 .bInterfaceSubClass = (sc), \
933 .bInterfaceProtocol = (pr)
Daniel Drake8538f962007-05-10 00:32:24 +0100934
Alan Sternb724ae72005-10-24 15:36:00 -0400935/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +0100937/* Stuff for dynamic usb ids */
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800938struct usb_dynids {
939 spinlock_t lock;
940 struct list_head list;
941};
942
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +0100943struct usb_dynid {
944 struct list_head node;
945 struct usb_device_id id;
946};
947
948extern ssize_t usb_store_new_id(struct usb_dynids *dynids,
949 struct device_driver *driver,
950 const char *buf, size_t count);
951
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952/**
Alan Stern8bb54ab2006-07-01 22:08:49 -0400953 * struct usbdrv_wrap - wrapper for driver-model structure
954 * @driver: The driver-model core driver structure.
955 * @for_devices: Non-zero for device drivers, 0 for interface drivers.
956 */
957struct usbdrv_wrap {
958 struct device_driver driver;
959 int for_devices;
960};
961
962/**
963 * struct usb_driver - identifies USB interface driver to usbcore
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964 * @name: The driver name should be unique among USB drivers,
965 * and should normally be the same as the module name.
966 * @probe: Called to see if the driver is willing to manage a particular
967 * interface on a device. If it is, probe returns zero and uses
Oliver Neukum7ef4f062008-04-10 15:15:37 +0200968 * usb_set_intfdata() to associate driver-specific data with the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 * interface. It may also use usb_set_interface() to specify the
970 * appropriate altsetting. If unwilling to manage the interface,
Oliver Neukum7ef4f062008-04-10 15:15:37 +0200971 * return -ENODEV, if genuine IO errors occured, an appropriate
972 * negative errno value.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973 * @disconnect: Called when the interface is no longer accessible, usually
974 * because its device has been (or is being) disconnected or the
975 * driver module is being unloaded.
976 * @ioctl: Used for drivers that want to talk to userspace through
977 * the "usbfs" filesystem. This lets devices provide ways to
978 * expose information to user space regardless of where they
979 * do (or don't) show up otherwise in the filesystem.
980 * @suspend: Called when the device is going to be suspended by the system.
981 * @resume: Called when the device is being resumed by the system.
Alan Sternf07600c2007-05-30 15:38:16 -0400982 * @reset_resume: Called when the suspended device has been reset instead
983 * of being resumed.
Ming Lei742120c2008-06-18 22:00:29 +0800984 * @pre_reset: Called by usb_reset_device() when the device
Alan Stern79efa092006-06-01 13:33:42 -0400985 * is about to be reset.
Ming Lei742120c2008-06-18 22:00:29 +0800986 * @post_reset: Called by usb_reset_device() after the device
Oliver Neukum7ef4f062008-04-10 15:15:37 +0200987 * has been reset
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988 * @id_table: USB drivers use ID table to support hotplugging.
989 * Export this with MODULE_DEVICE_TABLE(usb,...). This must be set
990 * or your driver's probe function will never get called.
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800991 * @dynids: used internally to hold the list of dynamically added device
992 * ids for this driver.
Alan Stern8bb54ab2006-07-01 22:08:49 -0400993 * @drvwrap: Driver-model core structure wrapper.
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -0800994 * @no_dynamic_id: if set to 1, the USB core will not allow dynamic ids to be
995 * added to this driver by preventing the sysfs file from being created.
Alan Stern645daaa2006-08-30 15:47:02 -0400996 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
997 * for interfaces bound to this driver.
Alan Stern9da82bd2008-05-08 11:54:37 -0400998 * @soft_unbind: if set to 1, the USB core will not kill URBs and disable
999 * endpoints before calling the driver's disconnect method.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000 *
Alan Stern8bb54ab2006-07-01 22:08:49 -04001001 * USB interface drivers must provide a name, probe() and disconnect()
1002 * methods, and an id_table. Other driver fields are optional.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003 *
1004 * The id_table is used in hotplugging. It holds a set of descriptors,
1005 * and specialized data may be associated with each entry. That table
1006 * is used by both user and kernel mode hotplugging support.
1007 *
1008 * The probe() and disconnect() methods are called in a context where
1009 * they can sleep, but they should avoid abusing the privilege. Most
1010 * work to connect to a device should be done when the device is opened,
1011 * and undone at the last close. The disconnect code needs to address
1012 * concurrency issues with respect to open() and close() methods, as
1013 * well as forcing all pending I/O requests to complete (by unlinking
1014 * them as necessary, and blocking until the unlinks complete).
1015 */
1016struct usb_driver {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017 const char *name;
1018
1019 int (*probe) (struct usb_interface *intf,
1020 const struct usb_device_id *id);
1021
1022 void (*disconnect) (struct usb_interface *intf);
1023
Alan Sternb724ae72005-10-24 15:36:00 -04001024 int (*ioctl) (struct usb_interface *intf, unsigned int code,
1025 void *buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026
David Brownell27d72e82005-04-18 17:39:22 -07001027 int (*suspend) (struct usb_interface *intf, pm_message_t message);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028 int (*resume) (struct usb_interface *intf);
Alan Sternf07600c2007-05-30 15:38:16 -04001029 int (*reset_resume)(struct usb_interface *intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030
Alan Sternf07600c2007-05-30 15:38:16 -04001031 int (*pre_reset)(struct usb_interface *intf);
1032 int (*post_reset)(struct usb_interface *intf);
Alan Stern79efa092006-06-01 13:33:42 -04001033
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034 const struct usb_device_id *id_table;
1035
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -08001036 struct usb_dynids dynids;
Alan Stern8bb54ab2006-07-01 22:08:49 -04001037 struct usbdrv_wrap drvwrap;
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -08001038 unsigned int no_dynamic_id:1;
Alan Stern645daaa2006-08-30 15:47:02 -04001039 unsigned int supports_autosuspend:1;
Alan Stern9da82bd2008-05-08 11:54:37 -04001040 unsigned int soft_unbind:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041};
Alan Stern8bb54ab2006-07-01 22:08:49 -04001042#define to_usb_driver(d) container_of(d, struct usb_driver, drvwrap.driver)
1043
1044/**
1045 * struct usb_device_driver - identifies USB device driver to usbcore
1046 * @name: The driver name should be unique among USB drivers,
1047 * and should normally be the same as the module name.
1048 * @probe: Called to see if the driver is willing to manage a particular
1049 * device. If it is, probe returns zero and uses dev_set_drvdata()
1050 * to associate driver-specific data with the device. If unwilling
1051 * to manage the device, return a negative errno value.
1052 * @disconnect: Called when the device is no longer accessible, usually
1053 * because it has been (or is being) disconnected or the driver's
1054 * module is being unloaded.
1055 * @suspend: Called when the device is going to be suspended by the system.
1056 * @resume: Called when the device is being resumed by the system.
1057 * @drvwrap: Driver-model core structure wrapper.
Alan Stern645daaa2006-08-30 15:47:02 -04001058 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
1059 * for devices bound to this driver.
Alan Stern8bb54ab2006-07-01 22:08:49 -04001060 *
1061 * USB drivers must provide all the fields listed above except drvwrap.
1062 */
1063struct usb_device_driver {
1064 const char *name;
1065
1066 int (*probe) (struct usb_device *udev);
1067 void (*disconnect) (struct usb_device *udev);
1068
1069 int (*suspend) (struct usb_device *udev, pm_message_t message);
1070 int (*resume) (struct usb_device *udev);
1071 struct usbdrv_wrap drvwrap;
Alan Stern645daaa2006-08-30 15:47:02 -04001072 unsigned int supports_autosuspend:1;
Alan Stern8bb54ab2006-07-01 22:08:49 -04001073};
1074#define to_usb_device_driver(d) container_of(d, struct usb_device_driver, \
1075 drvwrap.driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076
1077extern struct bus_type usb_bus_type;
1078
1079/**
1080 * struct usb_class_driver - identifies a USB driver that wants to use the USB major number
Greg Kroah-Hartmand6e5bcf2005-06-20 21:15:16 -07001081 * @name: the usb class device name for this driver. Will show up in sysfs.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082 * @fops: pointer to the struct file_operations of this driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083 * @minor_base: the start of the minor range for this driver.
1084 *
1085 * This structure is used for the usb_register_dev() and
1086 * usb_unregister_dev() functions, to consolidate a number of the
1087 * parameters used for them.
1088 */
1089struct usb_class_driver {
1090 char *name;
Arjan van de Ven99ac48f2006-03-28 01:56:41 -08001091 const struct file_operations *fops;
Greg Kroah-Hartmand6e5bcf2005-06-20 21:15:16 -07001092 int minor_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093};
1094
1095/*
1096 * use these in module_init()/module_exit()
1097 * and don't forget MODULE_DEVICE_TABLE(usb, ...)
1098 */
Greg Kroah-Hartman80f745f2007-01-15 11:50:02 -08001099extern int usb_register_driver(struct usb_driver *, struct module *,
1100 const char *);
Greg Kroah-Hartman2143acc2005-11-21 14:53:03 -08001101static inline int usb_register(struct usb_driver *driver)
1102{
Greg Kroah-Hartman80f745f2007-01-15 11:50:02 -08001103 return usb_register_driver(driver, THIS_MODULE, KBUILD_MODNAME);
Greg Kroah-Hartman2143acc2005-11-21 14:53:03 -08001104}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105extern void usb_deregister(struct usb_driver *);
1106
Alan Stern8bb54ab2006-07-01 22:08:49 -04001107extern int usb_register_device_driver(struct usb_device_driver *,
1108 struct module *);
1109extern void usb_deregister_device_driver(struct usb_device_driver *);
1110
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111extern int usb_register_dev(struct usb_interface *intf,
1112 struct usb_class_driver *class_driver);
1113extern void usb_deregister_dev(struct usb_interface *intf,
1114 struct usb_class_driver *class_driver);
1115
1116extern int usb_disabled(void);
1117
Alan Sternb724ae72005-10-24 15:36:00 -04001118/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119
1120/*
1121 * URB support, for asynchronous request completions
1122 */
1123
1124/*
1125 * urb->transfer_flags:
Alan Sternfea34092007-07-30 17:06:16 -04001126 *
1127 * Note: URB_DIR_IN/OUT is automatically set in usb_submit_urb().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128 */
1129#define URB_SHORT_NOT_OK 0x0001 /* report short reads as errors */
Alan Sternb724ae72005-10-24 15:36:00 -04001130#define URB_ISO_ASAP 0x0002 /* iso-only, urb->start_frame
1131 * ignored */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001132#define URB_NO_TRANSFER_DMA_MAP 0x0004 /* urb->transfer_dma valid on submit */
1133#define URB_NO_SETUP_DMA_MAP 0x0008 /* urb->setup_dma valid on submit */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134#define URB_NO_FSBR 0x0020 /* UHCI-specific */
Alan Sternb724ae72005-10-24 15:36:00 -04001135#define URB_ZERO_PACKET 0x0040 /* Finish bulk OUT with short packet */
1136#define URB_NO_INTERRUPT 0x0080 /* HINT: no non-error interrupt
1137 * needed */
Marcel Holtmann8b3b01c2007-06-13 08:02:11 +02001138#define URB_FREE_BUFFER 0x0100 /* Free transfer buffer with the URB */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139
Alan Sternfea34092007-07-30 17:06:16 -04001140#define URB_DIR_IN 0x0200 /* Transfer from device to host */
1141#define URB_DIR_OUT 0
1142#define URB_DIR_MASK URB_DIR_IN
1143
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144struct usb_iso_packet_descriptor {
1145 unsigned int offset;
1146 unsigned int length; /* expected length */
1147 unsigned int actual_length;
Pete Zaitcevd1bbb602007-02-11 13:56:13 -08001148 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149};
1150
1151struct urb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152
Oliver Neukum51a2f072007-05-25 13:40:56 +02001153struct usb_anchor {
1154 struct list_head urb_list;
1155 wait_queue_head_t wait;
1156 spinlock_t lock;
Oliver Neukum6a2839b2008-07-29 16:18:47 +02001157 unsigned int poisoned:1;
Oliver Neukum51a2f072007-05-25 13:40:56 +02001158};
1159
1160static inline void init_usb_anchor(struct usb_anchor *anchor)
1161{
1162 INIT_LIST_HEAD(&anchor->urb_list);
1163 init_waitqueue_head(&anchor->wait);
1164 spin_lock_init(&anchor->lock);
1165}
1166
David Howells7d12e782006-10-05 14:55:46 +01001167typedef void (*usb_complete_t)(struct urb *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168
1169/**
1170 * struct urb - USB Request Block
1171 * @urb_list: For use by current owner of the URB.
Oliver Neukum51a2f072007-05-25 13:40:56 +02001172 * @anchor_list: membership in the list of an anchor
1173 * @anchor: to anchor URBs to a common mooring
Alan Stern5b653c72007-07-30 17:04:37 -04001174 * @ep: Points to the endpoint's data structure. Will eventually
1175 * replace @pipe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176 * @pipe: Holds endpoint number, direction, type, and more.
1177 * Create these values with the eight macros available;
1178 * usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl"
1179 * (control), "bulk", "int" (interrupt), or "iso" (isochronous).
1180 * For example usb_sndbulkpipe() or usb_rcvintpipe(). Endpoint
1181 * numbers range from zero to fifteen. Note that "in" endpoint two
1182 * is a different endpoint (and pipe) from "out" endpoint two.
1183 * The current configuration controls the existence, type, and
1184 * maximum packet size of any given endpoint.
1185 * @dev: Identifies the USB device to perform the request.
1186 * @status: This is read in non-iso completion functions to get the
1187 * status of the particular request. ISO requests only use it
1188 * to tell whether the URB was unlinked; detailed status for
1189 * each frame is in the fields of the iso_frame-desc.
1190 * @transfer_flags: A variety of flags may be used to affect how URB
1191 * submission, unlinking, or operation are handled. Different
1192 * kinds of URB can use different flags.
1193 * @transfer_buffer: This identifies the buffer to (or from) which
1194 * the I/O request will be performed (unless URB_NO_TRANSFER_DMA_MAP
1195 * is set). This buffer must be suitable for DMA; allocate it with
1196 * kmalloc() or equivalent. For transfers to "in" endpoints, contents
1197 * of this buffer will be modified. This buffer is used for the data
1198 * stage of control transfers.
1199 * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP,
1200 * the device driver is saying that it provided this DMA address,
1201 * which the host controller driver should use in preference to the
1202 * transfer_buffer.
1203 * @transfer_buffer_length: How big is transfer_buffer. The transfer may
1204 * be broken up into chunks according to the current maximum packet
1205 * size for the endpoint, which is a function of the configuration
1206 * and is encoded in the pipe. When the length is zero, neither
1207 * transfer_buffer nor transfer_dma is used.
1208 * @actual_length: This is read in non-iso completion functions, and
1209 * it tells how many bytes (out of transfer_buffer_length) were
1210 * transferred. It will normally be the same as requested, unless
1211 * either an error was reported or a short read was performed.
1212 * The URB_SHORT_NOT_OK transfer flag may be used to make such
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001213 * short reads be reported as errors.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214 * @setup_packet: Only used for control transfers, this points to eight bytes
1215 * of setup data. Control transfers always start by sending this data
1216 * to the device. Then transfer_buffer is read or written, if needed.
1217 * @setup_dma: For control transfers with URB_NO_SETUP_DMA_MAP set, the
1218 * device driver has provided this DMA address for the setup packet.
1219 * The host controller driver should use this in preference to
1220 * setup_packet.
1221 * @start_frame: Returns the initial frame for isochronous transfers.
1222 * @number_of_packets: Lists the number of ISO transfer buffers.
1223 * @interval: Specifies the polling interval for interrupt or isochronous
1224 * transfers. The units are frames (milliseconds) for for full and low
1225 * speed devices, and microframes (1/8 millisecond) for highspeed ones.
1226 * @error_count: Returns the number of ISO transfers that reported errors.
1227 * @context: For use in completion functions. This normally points to
1228 * request-specific driver context.
1229 * @complete: Completion handler. This URB is passed as the parameter to the
1230 * completion function. The completion function may then do what
1231 * it likes with the URB, including resubmitting or freeing it.
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001232 * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233 * collect the transfer status for each buffer.
1234 *
1235 * This structure identifies USB transfer requests. URBs must be allocated by
1236 * calling usb_alloc_urb() and freed with a call to usb_free_urb().
1237 * Initialization may be done using various usb_fill_*_urb() functions. URBs
1238 * are submitted using usb_submit_urb(), and pending requests may be canceled
1239 * using usb_unlink_urb() or usb_kill_urb().
1240 *
1241 * Data Transfer Buffers:
1242 *
1243 * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise
1244 * taken from the general page pool. That is provided by transfer_buffer
1245 * (control requests also use setup_packet), and host controller drivers
1246 * perform a dma mapping (and unmapping) for each buffer transferred. Those
1247 * mapping operations can be expensive on some platforms (perhaps using a dma
1248 * bounce buffer or talking to an IOMMU),
1249 * although they're cheap on commodity x86 and ppc hardware.
1250 *
1251 * Alternatively, drivers may pass the URB_NO_xxx_DMA_MAP transfer flags,
1252 * which tell the host controller driver that no such mapping is needed since
1253 * the device driver is DMA-aware. For example, a device driver might
1254 * allocate a DMA buffer with usb_buffer_alloc() or call usb_buffer_map().
1255 * When these transfer flags are provided, host controller drivers will
1256 * attempt to use the dma addresses found in the transfer_dma and/or
1257 * setup_dma fields rather than determining a dma address themselves. (Note
1258 * that transfer_buffer and setup_packet must still be set because not all
1259 * host controllers use DMA, nor do virtual root hubs).
1260 *
1261 * Initialization:
1262 *
1263 * All URBs submitted must initialize the dev, pipe, transfer_flags (may be
Alan Sternb375a042005-07-29 16:11:07 -04001264 * zero), and complete fields. All URBs must also initialize
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265 * transfer_buffer and transfer_buffer_length. They may provide the
1266 * URB_SHORT_NOT_OK transfer flag, indicating that short reads are
1267 * to be treated as errors; that flag is invalid for write requests.
1268 *
1269 * Bulk URBs may
1270 * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers
1271 * should always terminate with a short packet, even if it means adding an
1272 * extra zero length packet.
1273 *
1274 * Control URBs must provide a setup_packet. The setup_packet and
1275 * transfer_buffer may each be mapped for DMA or not, independently of
1276 * the other. The transfer_flags bits URB_NO_TRANSFER_DMA_MAP and
1277 * URB_NO_SETUP_DMA_MAP indicate which buffers have already been mapped.
1278 * URB_NO_SETUP_DMA_MAP is ignored for non-control URBs.
1279 *
1280 * Interrupt URBs must provide an interval, saying how often (in milliseconds
1281 * or, for highspeed devices, 125 microsecond units)
1282 * to poll for transfers. After the URB has been submitted, the interval
1283 * field reflects how the transfer was actually scheduled.
1284 * The polling interval may be more frequent than requested.
1285 * For example, some controllers have a maximum interval of 32 milliseconds,
1286 * while others support intervals of up to 1024 milliseconds.
1287 * Isochronous URBs also have transfer intervals. (Note that for isochronous
1288 * endpoints, as well as high speed interrupt endpoints, the encoding of
1289 * the transfer interval in the endpoint descriptor is logarithmic.
1290 * Device drivers must convert that value to linear units themselves.)
1291 *
1292 * Isochronous URBs normally use the URB_ISO_ASAP transfer flag, telling
1293 * the host controller to schedule the transfer as soon as bandwidth
1294 * utilization allows, and then set start_frame to reflect the actual frame
1295 * selected during submission. Otherwise drivers must specify the start_frame
1296 * and handle the case where the transfer can't begin then. However, drivers
1297 * won't know how bandwidth is currently allocated, and while they can
1298 * find the current frame using usb_get_current_frame_number () they can't
1299 * know the range for that frame number. (Ranges for frame counter values
1300 * are HC-specific, and can go from 256 to 65536 frames from "now".)
1301 *
1302 * Isochronous URBs have a different data transfer model, in part because
1303 * the quality of service is only "best effort". Callers provide specially
1304 * allocated URBs, with number_of_packets worth of iso_frame_desc structures
1305 * at the end. Each such packet is an individual ISO transfer. Isochronous
1306 * URBs are normally queued, submitted by drivers to arrange that
1307 * transfers are at least double buffered, and then explicitly resubmitted
1308 * in completion handlers, so
1309 * that data (such as audio or video) streams at as constant a rate as the
1310 * host controller scheduler can support.
1311 *
1312 * Completion Callbacks:
1313 *
1314 * The completion callback is made in_interrupt(), and one of the first
1315 * things that a completion handler should do is check the status field.
1316 * The status field is provided for all URBs. It is used to report
1317 * unlinked URBs, and status for all non-ISO transfers. It should not
1318 * be examined before the URB is returned to the completion handler.
1319 *
1320 * The context field is normally used to link URBs back to the relevant
1321 * driver or request state.
1322 *
1323 * When the completion callback is invoked for non-isochronous URBs, the
1324 * actual_length field tells how many bytes were transferred. This field
1325 * is updated even when the URB terminated with an error or was unlinked.
1326 *
1327 * ISO transfer status is reported in the status and actual_length fields
1328 * of the iso_frame_desc array, and the number of errors is reported in
1329 * error_count. Completion callbacks for ISO transfers will normally
1330 * (re)submit URBs to ensure a constant transfer rate.
Roman Kagan719df462005-05-06 00:55:56 +04001331 *
1332 * Note that even fields marked "public" should not be touched by the driver
1333 * when the urb is owned by the hcd, that is, since the call to
1334 * usb_submit_urb() till the entry into the completion routine.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001336struct urb {
Martin Waitzaeec46b2005-11-13 16:08:13 -08001337 /* private: usb core and host controller only fields in the urb */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 struct kref kref; /* reference count of the URB */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339 void *hcpriv; /* private data for host controller */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340 atomic_t use_count; /* concurrent submissions counter */
1341 u8 reject; /* submissions will fail */
Alan Sterneb231052007-08-21 15:40:36 -04001342 int unlinked; /* unlink error code */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343
Martin Waitzaeec46b2005-11-13 16:08:13 -08001344 /* public: documented fields in the urb that can be used by drivers */
Alan Sternb724ae72005-10-24 15:36:00 -04001345 struct list_head urb_list; /* list head for use by the urb's
1346 * current owner */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001347 struct list_head anchor_list; /* the URB may be anchored */
Oliver Neukum51a2f072007-05-25 13:40:56 +02001348 struct usb_anchor *anchor;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349 struct usb_device *dev; /* (in) pointer to associated device */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001350 struct usb_host_endpoint *ep; /* (internal) pointer to endpoint */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 unsigned int pipe; /* (in) pipe information */
1352 int status; /* (return) non-ISO status */
1353 unsigned int transfer_flags; /* (in) URB_SHORT_NOT_OK | ...*/
1354 void *transfer_buffer; /* (in) associated data buffer */
1355 dma_addr_t transfer_dma; /* (in) dma addr for transfer_buffer */
1356 int transfer_buffer_length; /* (in) data buffer length */
1357 int actual_length; /* (return) actual transfer length */
1358 unsigned char *setup_packet; /* (in) setup packet (control only) */
1359 dma_addr_t setup_dma; /* (in) dma addr for setup_packet */
1360 int start_frame; /* (modify) start frame (ISO) */
1361 int number_of_packets; /* (in) number of ISO packets */
Alan Sternb724ae72005-10-24 15:36:00 -04001362 int interval; /* (modify) transfer interval
1363 * (INT/ISO) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364 int error_count; /* (return) number of ISO errors */
1365 void *context; /* (in) context for completion */
1366 usb_complete_t complete; /* (in) completion routine */
Alan Sternb724ae72005-10-24 15:36:00 -04001367 struct usb_iso_packet_descriptor iso_frame_desc[0];
1368 /* (in) ISO ONLY */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369};
1370
Alan Sternb724ae72005-10-24 15:36:00 -04001371/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001372
1373/**
1374 * usb_fill_control_urb - initializes a control urb
1375 * @urb: pointer to the urb to initialize.
1376 * @dev: pointer to the struct usb_device for this urb.
1377 * @pipe: the endpoint pipe
1378 * @setup_packet: pointer to the setup_packet buffer
1379 * @transfer_buffer: pointer to the transfer buffer
1380 * @buffer_length: length of the transfer buffer
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001381 * @complete_fn: pointer to the usb_complete_t function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382 * @context: what to set the urb context to.
1383 *
1384 * Initializes a control urb with the proper information needed to submit
1385 * it to a device.
1386 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001387static inline void usb_fill_control_urb(struct urb *urb,
1388 struct usb_device *dev,
1389 unsigned int pipe,
1390 unsigned char *setup_packet,
1391 void *transfer_buffer,
1392 int buffer_length,
1393 usb_complete_t complete_fn,
1394 void *context)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396 urb->dev = dev;
1397 urb->pipe = pipe;
1398 urb->setup_packet = setup_packet;
1399 urb->transfer_buffer = transfer_buffer;
1400 urb->transfer_buffer_length = buffer_length;
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001401 urb->complete = complete_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402 urb->context = context;
1403}
1404
1405/**
1406 * usb_fill_bulk_urb - macro to help initialize a bulk urb
1407 * @urb: pointer to the urb to initialize.
1408 * @dev: pointer to the struct usb_device for this urb.
1409 * @pipe: the endpoint pipe
1410 * @transfer_buffer: pointer to the transfer buffer
1411 * @buffer_length: length of the transfer buffer
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001412 * @complete_fn: pointer to the usb_complete_t function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413 * @context: what to set the urb context to.
1414 *
1415 * Initializes a bulk urb with the proper information needed to submit it
1416 * to a device.
1417 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001418static inline void usb_fill_bulk_urb(struct urb *urb,
1419 struct usb_device *dev,
1420 unsigned int pipe,
1421 void *transfer_buffer,
1422 int buffer_length,
1423 usb_complete_t complete_fn,
1424 void *context)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426 urb->dev = dev;
1427 urb->pipe = pipe;
1428 urb->transfer_buffer = transfer_buffer;
1429 urb->transfer_buffer_length = buffer_length;
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001430 urb->complete = complete_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431 urb->context = context;
1432}
1433
1434/**
1435 * usb_fill_int_urb - macro to help initialize a interrupt urb
1436 * @urb: pointer to the urb to initialize.
1437 * @dev: pointer to the struct usb_device for this urb.
1438 * @pipe: the endpoint pipe
1439 * @transfer_buffer: pointer to the transfer buffer
1440 * @buffer_length: length of the transfer buffer
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001441 * @complete_fn: pointer to the usb_complete_t function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442 * @context: what to set the urb context to.
1443 * @interval: what to set the urb interval to, encoded like
1444 * the endpoint descriptor's bInterval value.
1445 *
1446 * Initializes a interrupt urb with the proper information needed to submit
1447 * it to a device.
1448 * Note that high speed interrupt endpoints use a logarithmic encoding of
1449 * the endpoint interval, and express polling intervals in microframes
1450 * (eight per millisecond) rather than in frames (one per millisecond).
1451 */
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001452static inline void usb_fill_int_urb(struct urb *urb,
1453 struct usb_device *dev,
1454 unsigned int pipe,
1455 void *transfer_buffer,
1456 int buffer_length,
1457 usb_complete_t complete_fn,
1458 void *context,
1459 int interval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461 urb->dev = dev;
1462 urb->pipe = pipe;
1463 urb->transfer_buffer = transfer_buffer;
1464 urb->transfer_buffer_length = buffer_length;
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001465 urb->complete = complete_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466 urb->context = context;
1467 if (dev->speed == USB_SPEED_HIGH)
1468 urb->interval = 1 << (interval - 1);
1469 else
1470 urb->interval = interval;
1471 urb->start_frame = -1;
1472}
1473
1474extern void usb_init_urb(struct urb *urb);
Al Viro55016f12005-10-21 03:21:58 -04001475extern struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476extern void usb_free_urb(struct urb *urb);
1477#define usb_put_urb usb_free_urb
1478extern struct urb *usb_get_urb(struct urb *urb);
Al Viro55016f12005-10-21 03:21:58 -04001479extern int usb_submit_urb(struct urb *urb, gfp_t mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480extern int usb_unlink_urb(struct urb *urb);
1481extern void usb_kill_urb(struct urb *urb);
Oliver Neukum55b447b2008-07-29 15:26:15 +02001482extern void usb_poison_urb(struct urb *urb);
1483extern void usb_unpoison_urb(struct urb *urb);
Oliver Neukum51a2f072007-05-25 13:40:56 +02001484extern void usb_kill_anchored_urbs(struct usb_anchor *anchor);
Oliver Neukum6a2839b2008-07-29 16:18:47 +02001485extern void usb_poison_anchored_urbs(struct usb_anchor *anchor);
Oliver Neukumeda76952008-04-10 14:07:37 +02001486extern void usb_unlink_anchored_urbs(struct usb_anchor *anchor);
Oliver Neukum51a2f072007-05-25 13:40:56 +02001487extern void usb_anchor_urb(struct urb *urb, struct usb_anchor *anchor);
1488extern void usb_unanchor_urb(struct urb *urb);
1489extern int usb_wait_anchor_empty_timeout(struct usb_anchor *anchor,
1490 unsigned int timeout);
Oliver Neukum19876252008-08-25 22:40:25 +02001491extern struct urb *usb_get_from_anchor(struct usb_anchor *anchor);
1492extern void usb_scuttle_anchored_urbs(struct usb_anchor *anchor);
1493extern int usb_anchor_empty(struct usb_anchor *anchor);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494
Alan Sternfea34092007-07-30 17:06:16 -04001495/**
1496 * usb_urb_dir_in - check if an URB describes an IN transfer
1497 * @urb: URB to be checked
1498 *
1499 * Returns 1 if @urb describes an IN transfer (device-to-host),
1500 * otherwise 0.
1501 */
1502static inline int usb_urb_dir_in(struct urb *urb)
1503{
Alan Sternd617bc82007-08-02 15:04:52 -04001504 return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_IN;
Alan Sternfea34092007-07-30 17:06:16 -04001505}
1506
1507/**
1508 * usb_urb_dir_out - check if an URB describes an OUT transfer
1509 * @urb: URB to be checked
1510 *
1511 * Returns 1 if @urb describes an OUT transfer (host-to-device),
1512 * otherwise 0.
1513 */
1514static inline int usb_urb_dir_out(struct urb *urb)
1515{
1516 return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_OUT;
1517}
1518
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001519void *usb_buffer_alloc(struct usb_device *dev, size_t size,
Al Viro55016f12005-10-21 03:21:58 -04001520 gfp_t mem_flags, dma_addr_t *dma);
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001521void usb_buffer_free(struct usb_device *dev, size_t size,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522 void *addr, dma_addr_t dma);
1523
1524#if 0
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001525struct urb *usb_buffer_map(struct urb *urb);
1526void usb_buffer_dmasync(struct urb *urb);
1527void usb_buffer_unmap(struct urb *urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528#endif
1529
1530struct scatterlist;
Alan Stern5e60a162007-07-30 17:07:21 -04001531int usb_buffer_map_sg(const struct usb_device *dev, int is_in,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -03001532 struct scatterlist *sg, int nents);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533#if 0
Alan Stern5e60a162007-07-30 17:07:21 -04001534void usb_buffer_dmasync_sg(const struct usb_device *dev, int is_in,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -03001535 struct scatterlist *sg, int n_hw_ents);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536#endif
Alan Stern5e60a162007-07-30 17:07:21 -04001537void usb_buffer_unmap_sg(const struct usb_device *dev, int is_in,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -03001538 struct scatterlist *sg, int n_hw_ents);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539
1540/*-------------------------------------------------------------------*
1541 * SYNCHRONOUS CALL SUPPORT *
1542 *-------------------------------------------------------------------*/
1543
1544extern int usb_control_msg(struct usb_device *dev, unsigned int pipe,
1545 __u8 request, __u8 requesttype, __u16 value, __u16 index,
1546 void *data, __u16 size, int timeout);
Greg Kroah-Hartman782a7a62006-05-19 13:20:20 -07001547extern int usb_interrupt_msg(struct usb_device *usb_dev, unsigned int pipe,
1548 void *data, int len, int *actual_length, int timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549extern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,
1550 void *data, int len, int *actual_length,
1551 int timeout);
1552
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553/* wrappers around usb_control_msg() for the most common standard requests */
1554extern int usb_get_descriptor(struct usb_device *dev, unsigned char desctype,
1555 unsigned char descindex, void *buf, int size);
1556extern int usb_get_status(struct usb_device *dev,
1557 int type, int target, void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558extern int usb_string(struct usb_device *dev, int index,
1559 char *buf, size_t size);
1560
1561/* wrappers that also update important state inside usbcore */
1562extern int usb_clear_halt(struct usb_device *dev, int pipe);
1563extern int usb_reset_configuration(struct usb_device *dev);
1564extern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate);
1565
Alan Stern088dc272006-08-21 12:08:19 -04001566/* this request isn't really synchronous, but it belongs with the others */
1567extern int usb_driver_set_configuration(struct usb_device *udev, int config);
1568
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569/*
1570 * timeouts, in milliseconds, used for sending/receiving control messages
1571 * they typically complete within a few frames (msec) after they're issued
1572 * USB identifies 5 second timeouts, maybe more in a few cases, and a few
1573 * slow devices (like some MGE Ellipse UPSes) actually push that limit.
1574 */
1575#define USB_CTRL_GET_TIMEOUT 5000
1576#define USB_CTRL_SET_TIMEOUT 5000
1577
1578
1579/**
1580 * struct usb_sg_request - support for scatter/gather I/O
1581 * @status: zero indicates success, else negative errno
1582 * @bytes: counts bytes transferred.
1583 *
1584 * These requests are initialized using usb_sg_init(), and then are used
1585 * as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most
1586 * members of the request object aren't for driver access.
1587 *
1588 * The status and bytecount values are valid only after usb_sg_wait()
1589 * returns. If the status is zero, then the bytecount matches the total
1590 * from the request.
1591 *
1592 * After an error completion, drivers may need to clear a halt condition
1593 * on the endpoint.
1594 */
1595struct usb_sg_request {
1596 int status;
1597 size_t bytes;
1598
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001599 /*
Martin Waitzaeec46b2005-11-13 16:08:13 -08001600 * members below are private: to usbcore,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601 * and are not provided for driver access!
1602 */
1603 spinlock_t lock;
1604
1605 struct usb_device *dev;
1606 int pipe;
1607 struct scatterlist *sg;
1608 int nents;
1609
1610 int entries;
1611 struct urb **urbs;
1612
1613 int count;
1614 struct completion complete;
1615};
1616
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001617int usb_sg_init(
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 struct usb_sg_request *io,
1619 struct usb_device *dev,
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001620 unsigned pipe,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621 unsigned period,
1622 struct scatterlist *sg,
1623 int nents,
1624 size_t length,
Al Viro55016f12005-10-21 03:21:58 -04001625 gfp_t mem_flags
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626);
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001627void usb_sg_cancel(struct usb_sg_request *io);
1628void usb_sg_wait(struct usb_sg_request *io);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629
1630
Alan Sternb724ae72005-10-24 15:36:00 -04001631/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632
1633/*
1634 * For various legacy reasons, Linux has a small cookie that's paired with
1635 * a struct usb_device to identify an endpoint queue. Queue characteristics
1636 * are defined by the endpoint's descriptor. This cookie is called a "pipe",
1637 * an unsigned int encoded as:
1638 *
1639 * - direction: bit 7 (0 = Host-to-Device [Out],
1640 * 1 = Device-to-Host [In] ...
1641 * like endpoint bEndpointAddress)
1642 * - device address: bits 8-14 ... bit positions known to uhci-hcd
1643 * - endpoint: bits 15-18 ... bit positions known to uhci-hcd
1644 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
1645 * 10 = control, 11 = bulk)
1646 *
1647 * Given the device address and endpoint descriptor, pipes are redundant.
1648 */
1649
1650/* NOTE: these are not the standard USB_ENDPOINT_XFER_* values!! */
1651/* (yet ... they're the values used by usbfs) */
1652#define PIPE_ISOCHRONOUS 0
1653#define PIPE_INTERRUPT 1
1654#define PIPE_CONTROL 2
1655#define PIPE_BULK 3
1656
1657#define usb_pipein(pipe) ((pipe) & USB_DIR_IN)
1658#define usb_pipeout(pipe) (!usb_pipein(pipe))
1659
1660#define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
1661#define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
1662
1663#define usb_pipetype(pipe) (((pipe) >> 30) & 3)
1664#define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
1665#define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
1666#define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
1667#define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
1668
1669/* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
1670#define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
1671#define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep)))
Alan Sternb724ae72005-10-24 15:36:00 -04001672#define usb_settoggle(dev, ep, out, bit) \
1673 ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \
1674 ((bit) << (ep)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675
1676
Alan Sternb724ae72005-10-24 15:36:00 -04001677static inline unsigned int __create_pipe(struct usb_device *dev,
1678 unsigned int endpoint)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679{
1680 return (dev->devnum << 8) | (endpoint << 15);
1681}
1682
1683/* Create various pipes... */
Alan Sternb724ae72005-10-24 15:36:00 -04001684#define usb_sndctrlpipe(dev,endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001685 ((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint))
Alan Sternb724ae72005-10-24 15:36:00 -04001686#define usb_rcvctrlpipe(dev,endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001687 ((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
Alan Sternb724ae72005-10-24 15:36:00 -04001688#define usb_sndisocpipe(dev,endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001689 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint))
Alan Sternb724ae72005-10-24 15:36:00 -04001690#define usb_rcvisocpipe(dev,endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001691 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
Alan Sternb724ae72005-10-24 15:36:00 -04001692#define usb_sndbulkpipe(dev,endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001693 ((PIPE_BULK << 30) | __create_pipe(dev, endpoint))
Alan Sternb724ae72005-10-24 15:36:00 -04001694#define usb_rcvbulkpipe(dev,endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001695 ((PIPE_BULK << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
Alan Sternb724ae72005-10-24 15:36:00 -04001696#define usb_sndintpipe(dev,endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001697 ((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint))
Alan Sternb724ae72005-10-24 15:36:00 -04001698#define usb_rcvintpipe(dev,endpoint) \
Greg Kroah-Hartman969ab2e2008-01-30 15:20:32 -08001699 ((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700
1701/*-------------------------------------------------------------------------*/
1702
1703static inline __u16
1704usb_maxpacket(struct usb_device *udev, int pipe, int is_out)
1705{
1706 struct usb_host_endpoint *ep;
1707 unsigned epnum = usb_pipeendpoint(pipe);
1708
1709 if (is_out) {
1710 WARN_ON(usb_pipein(pipe));
1711 ep = udev->ep_out[epnum];
1712 } else {
1713 WARN_ON(usb_pipeout(pipe));
1714 ep = udev->ep_in[epnum];
1715 }
1716 if (!ep)
1717 return 0;
1718
1719 /* NOTE: only 0x07ff bits are for packet size... */
1720 return le16_to_cpu(ep->desc.wMaxPacketSize);
1721}
1722
Alan Sternb724ae72005-10-24 15:36:00 -04001723/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001724
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -07001725/* Events from the usb core */
1726#define USB_DEVICE_ADD 0x0001
1727#define USB_DEVICE_REMOVE 0x0002
1728#define USB_BUS_ADD 0x0003
1729#define USB_BUS_REMOVE 0x0004
1730extern void usb_register_notify(struct notifier_block *nb);
1731extern void usb_unregister_notify(struct notifier_block *nb);
1732
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733#ifdef DEBUG
Alan Sternb724ae72005-10-24 15:36:00 -04001734#define dbg(format, arg...) printk(KERN_DEBUG "%s: " format "\n" , \
1735 __FILE__ , ## arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736#else
1737#define dbg(format, arg...) do {} while (0)
1738#endif
1739
Tilman Schmidtf66396b2008-03-13 19:51:42 +01001740#define err(format, arg...) printk(KERN_ERR KBUILD_MODNAME ": " \
1741 format "\n" , ## arg)
1742#define info(format, arg...) printk(KERN_INFO KBUILD_MODNAME ": " \
1743 format "\n" , ## arg)
1744#define warn(format, arg...) printk(KERN_WARNING KBUILD_MODNAME ": " \
1745 format "\n" , ## arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746
1747#endif /* __KERNEL__ */
1748
1749#endif