blob: a51f34e805727636daa9378d560e4e2adf1a16ff [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;
26
27/*-------------------------------------------------------------------------*/
28
29/*
30 * Host-side wrappers for standard USB descriptors ... these are parsed
31 * from the data provided by devices. Parsing turns them from a flat
32 * sequence of descriptors into a hierarchy:
33 *
34 * - devices have one (usually) or more configs;
35 * - configs have one (often) or more interfaces;
36 * - interfaces have one (usually) or more settings;
37 * - each interface setting has zero or (usually) more endpoints.
38 *
39 * And there might be other descriptors mixed in with those.
40 *
41 * Devices may also have class-specific or vendor-specific descriptors.
42 */
43
Greg Kroah-Hartman9bde7492006-06-14 12:14:34 -070044struct ep_device;
45
Linus Torvalds1da177e2005-04-16 15:20:36 -070046/**
47 * struct usb_host_endpoint - host-side endpoint descriptor and queue
48 * @desc: descriptor for this endpoint, wMaxPacketSize in native byteorder
49 * @urb_list: urbs queued to this endpoint; maintained by usbcore
50 * @hcpriv: for use by HCD; typically holds hardware dma queue head (QH)
51 * with one or more transfer descriptors (TDs) per urb
Randy Dunlap7fac9a32006-06-22 15:12:41 -070052 * @ep_dev: ep_device for sysfs info
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 * @extra: descriptors following this endpoint in the configuration
54 * @extralen: how many bytes of "extra" are valid
Alan Sternbdd016b2007-07-30 17:05:22 -040055 * @enabled: URBs may be submitted to this endpoint
Linus Torvalds1da177e2005-04-16 15:20:36 -070056 *
57 * USB requests are always queued to a given endpoint, identified by a
58 * descriptor within an active interface in a given USB configuration.
59 */
60struct usb_host_endpoint {
61 struct usb_endpoint_descriptor desc;
62 struct list_head urb_list;
63 void *hcpriv;
Greg Kroah-Hartman9bde7492006-06-14 12:14:34 -070064 struct ep_device *ep_dev; /* For sysfs info */
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
66 unsigned char *extra; /* Extra descriptors */
67 int extralen;
Alan Sternbdd016b2007-07-30 17:05:22 -040068 int enabled;
Linus Torvalds1da177e2005-04-16 15:20:36 -070069};
70
71/* host-side wrapper for one interface setting's parsed descriptors */
72struct usb_host_interface {
73 struct usb_interface_descriptor desc;
74
75 /* array of desc.bNumEndpoint endpoints associated with this
76 * interface setting. these will be in no particular order.
77 */
78 struct usb_host_endpoint *endpoint;
79
80 char *string; /* iInterface string, if present */
81 unsigned char *extra; /* Extra descriptors */
82 int extralen;
83};
84
85enum usb_interface_condition {
86 USB_INTERFACE_UNBOUND = 0,
87 USB_INTERFACE_BINDING,
88 USB_INTERFACE_BOUND,
89 USB_INTERFACE_UNBINDING,
90};
91
92/**
93 * struct usb_interface - what usb device drivers talk to
94 * @altsetting: array of interface structures, one for each alternate
95 * setting that may be selected. Each one includes a set of
96 * endpoint configurations. They will be in no particular order.
97 * @num_altsetting: number of altsettings defined.
98 * @cur_altsetting: the current altsetting.
Randy Dunlap3f423782007-07-19 10:21:37 -070099 * @intf_assoc: interface association descriptor
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 * @driver: the USB driver that is bound to this interface.
101 * @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.
Alan Stern645daaa2006-08-30 15:47:02 -0400110 * @needs_remote_wakeup: flag set when the driver requires remote-wakeup
111 * capability during autosuspend.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 * @dev: driver model's view of this device
Greg Kroah-Hartman0873c762006-06-20 13:09:50 -0700113 * @usb_dev: if an interface is bound to the USB major, this will point
114 * to the sysfs representation for that device.
Alan Stern645daaa2006-08-30 15:47:02 -0400115 * @pm_usage_cnt: PM usage counter for this interface; autosuspend is not
116 * allowed unless the counter is 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 *
118 * USB device drivers attach to interfaces on a physical device. Each
119 * interface encapsulates a single high level function, such as feeding
120 * an audio stream to a speaker or reporting a change in a volume control.
121 * Many USB devices only have one interface. The protocol used to talk to
122 * an interface's endpoints can be defined in a usb "class" specification,
123 * or by a product's vendor. The (default) control endpoint is part of
124 * every interface, but is never listed among the interface's descriptors.
125 *
126 * The driver that is bound to the interface can use standard driver model
127 * calls such as dev_get_drvdata() on the dev member of this structure.
128 *
129 * Each interface may have alternate settings. The initial configuration
130 * of a device sets altsetting 0, but the device driver can change
131 * that setting using usb_set_interface(). Alternate settings are often
Michael Opdenacker59c51592007-05-09 08:57:56 +0200132 * used to control the use of periodic endpoints, such as by having
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 * different endpoints use different amounts of reserved USB bandwidth.
134 * All standards-conformant USB devices that use isochronous endpoints
135 * will use them in non-default settings.
136 *
137 * The USB specification says that alternate setting numbers must run from
138 * 0 to one less than the total number of alternate settings. But some
139 * devices manage to mess this up, and the structures aren't necessarily
140 * stored in numerical order anyhow. Use usb_altnum_to_altsetting() to
141 * look up an alternate setting in the altsetting array based on its number.
142 */
143struct usb_interface {
144 /* array of alternate settings for this interface,
145 * stored in no particular order */
146 struct usb_host_interface *altsetting;
147
148 struct usb_host_interface *cur_altsetting; /* the currently
149 * active alternate setting */
150 unsigned num_altsetting; /* number of alternate settings */
151
Craig W. Nadler165fe972007-06-15 23:14:35 -0400152 /* If there is an interface association descriptor then it will list
153 * the associated interfaces */
154 struct usb_interface_assoc_descriptor *intf_assoc;
155
Alan Sternb724ae72005-10-24 15:36:00 -0400156 int minor; /* minor number this interface is
157 * bound to */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 enum usb_interface_condition condition; /* state of binding */
Alan Stern4d064c02006-07-01 22:11:44 -0400159 unsigned is_active:1; /* the interface is not suspended */
Alan Stern645daaa2006-08-30 15:47:02 -0400160 unsigned needs_remote_wakeup:1; /* driver requires remote wakeup */
Alan Stern4d064c02006-07-01 22:11:44 -0400161
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 struct device dev; /* interface specific device info */
Greg Kroah-Hartman0873c762006-06-20 13:09:50 -0700163 struct device *usb_dev; /* pointer to the usb class's device, if any */
Alan Stern645daaa2006-08-30 15:47:02 -0400164 int pm_usage_cnt; /* usage counter for autosuspend */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165};
166#define to_usb_interface(d) container_of(d, struct usb_interface, dev)
167#define interface_to_usbdev(intf) \
168 container_of(intf->dev.parent, struct usb_device, dev)
169
170static inline void *usb_get_intfdata (struct usb_interface *intf)
171{
172 return dev_get_drvdata (&intf->dev);
173}
174
175static inline void usb_set_intfdata (struct usb_interface *intf, void *data)
176{
177 dev_set_drvdata(&intf->dev, data);
178}
179
180struct usb_interface *usb_get_intf(struct usb_interface *intf);
181void usb_put_intf(struct usb_interface *intf);
182
183/* this maximum is arbitrary */
184#define USB_MAXINTERFACES 32
Craig W. Nadler165fe972007-06-15 23:14:35 -0400185#define USB_MAXIADS USB_MAXINTERFACES/2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
187/**
188 * struct usb_interface_cache - long-term representation of a device interface
189 * @num_altsetting: number of altsettings defined.
190 * @ref: reference counter.
191 * @altsetting: variable-length array of interface structures, one for
192 * each alternate setting that may be selected. Each one includes a
193 * set of endpoint configurations. They will be in no particular order.
194 *
195 * These structures persist for the lifetime of a usb_device, unlike
196 * struct usb_interface (which persists only as long as its configuration
197 * is installed). The altsetting arrays can be accessed through these
198 * structures at any time, permitting comparison of configurations and
199 * providing support for the /proc/bus/usb/devices pseudo-file.
200 */
201struct usb_interface_cache {
202 unsigned num_altsetting; /* number of alternate settings */
203 struct kref ref; /* reference counter */
204
205 /* variable-length array of alternate settings for this interface,
206 * stored in no particular order */
207 struct usb_host_interface altsetting[0];
208};
209#define ref_to_usb_interface_cache(r) \
210 container_of(r, struct usb_interface_cache, ref)
211#define altsetting_to_usb_interface_cache(a) \
212 container_of(a, struct usb_interface_cache, altsetting[0])
213
214/**
215 * struct usb_host_config - representation of a device's configuration
216 * @desc: the device's configuration descriptor.
217 * @string: pointer to the cached version of the iConfiguration string, if
218 * present for this configuration.
Randy Dunlap3f423782007-07-19 10:21:37 -0700219 * @intf_assoc: list of any interface association descriptors in this config
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 * @interface: array of pointers to usb_interface structures, one for each
221 * interface in the configuration. The number of interfaces is stored
222 * in desc.bNumInterfaces. These pointers are valid only while the
223 * the configuration is active.
224 * @intf_cache: array of pointers to usb_interface_cache structures, one
225 * for each interface in the configuration. These structures exist
226 * for the entire life of the device.
227 * @extra: pointer to buffer containing all extra descriptors associated
228 * with this configuration (those preceding the first interface
229 * descriptor).
230 * @extralen: length of the extra descriptors buffer.
231 *
232 * USB devices may have multiple configurations, but only one can be active
233 * at any time. Each encapsulates a different operational environment;
234 * for example, a dual-speed device would have separate configurations for
235 * full-speed and high-speed operation. The number of configurations
236 * available is stored in the device descriptor as bNumConfigurations.
237 *
238 * A configuration can contain multiple interfaces. Each corresponds to
239 * a different function of the USB device, and all are available whenever
240 * the configuration is active. The USB standard says that interfaces
241 * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot
242 * of devices get this wrong. In addition, the interface array is not
243 * guaranteed to be sorted in numerical order. Use usb_ifnum_to_if() to
244 * look up an interface entry based on its number.
245 *
246 * Device drivers should not attempt to activate configurations. The choice
247 * of which configuration to install is a policy decision based on such
248 * considerations as available power, functionality provided, and the user's
Kay Sievers312c0042005-11-16 09:00:00 +0100249 * desires (expressed through userspace tools). However, drivers can call
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 * usb_reset_configuration() to reinitialize the current configuration and
251 * all its interfaces.
252 */
253struct usb_host_config {
254 struct usb_config_descriptor desc;
255
Alan Stern4f62efe2005-10-24 16:24:14 -0400256 char *string; /* iConfiguration string, if present */
Craig W. Nadler165fe972007-06-15 23:14:35 -0400257
258 /* List of any Interface Association Descriptors in this
259 * configuration. */
260 struct usb_interface_assoc_descriptor *intf_assoc[USB_MAXIADS];
261
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 /* the interfaces associated with this configuration,
263 * stored in no particular order */
264 struct usb_interface *interface[USB_MAXINTERFACES];
265
266 /* Interface information available even when this is not the
267 * active configuration */
268 struct usb_interface_cache *intf_cache[USB_MAXINTERFACES];
269
270 unsigned char *extra; /* Extra descriptors */
271 int extralen;
272};
273
274int __usb_get_extra_descriptor(char *buffer, unsigned size,
275 unsigned char type, void **ptr);
276#define usb_get_extra_descriptor(ifpoint,type,ptr)\
277 __usb_get_extra_descriptor((ifpoint)->extra,(ifpoint)->extralen,\
278 type,(void**)ptr)
279
Alan Sternb724ae72005-10-24 15:36:00 -0400280/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282/* USB device number allocation bitmap */
283struct usb_devmap {
284 unsigned long devicemap[128 / (8*sizeof(unsigned long))];
285};
286
287/*
288 * Allocated per bus (tree of devices) we have:
289 */
290struct usb_bus {
291 struct device *controller; /* host/master side hardware */
292 int busnum; /* Bus number (in order of reg) */
293 char *bus_name; /* stable id (PCI slot_name etc) */
Alan Sterndd990f12006-08-30 11:29:56 -0400294 u8 uses_dma; /* Does the host controller use DMA? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 u8 otg_port; /* 0, or number of OTG/HNP port */
296 unsigned is_b_host:1; /* true during some HNP roleswitches */
297 unsigned b_hnp_enable:1; /* OTG: did A-Host enable HNP? */
298
Alan Sternb724ae72005-10-24 15:36:00 -0400299 int devnum_next; /* Next open device number in
300 * round-robin allocation */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301
302 struct usb_devmap devmap; /* device address allocation map */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 struct usb_device *root_hub; /* Root hub */
304 struct list_head bus_list; /* list of busses */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305
306 int bandwidth_allocated; /* on this bus: how much of the time
307 * reserved for periodic (intr/iso)
308 * requests is used, on average?
309 * Units: microseconds/frame.
310 * Limits: Full/low speed reserve 90%,
311 * while high speed reserves 80%.
312 */
313 int bandwidth_int_reqs; /* number of Interrupt requests */
314 int bandwidth_isoc_reqs; /* number of Isoc. requests */
315
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100316#ifdef CONFIG_USB_DEVICEFS
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 struct dentry *usbfs_dentry; /* usbfs dentry entry for the bus */
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100318#endif
gregkh@suse.de8561b102005-03-15 15:10:13 -0800319 struct class_device *class_dev; /* class device for this bus */
Alan Sternb724ae72005-10-24 15:36:00 -0400320
Adrian Bunk4749f322005-06-23 11:36:56 +0200321#if defined(CONFIG_USB_MON)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 struct mon_bus *mon_bus; /* non-null when associated */
323 int monitored; /* non-zero when monitored */
324#endif
325};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326
Alan Sternb724ae72005-10-24 15:36:00 -0400327/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328
329/* This is arbitrary.
330 * From USB 2.0 spec Table 11-13, offset 7, a hub can
331 * have up to 255 ports. The most yet reported is 10.
inaky@linux.intel.com43705252006-10-11 20:05:58 -0700332 *
333 * Current Wireless USB host hardware (Intel i1480 for example) allows
334 * up to 22 devices to connect. Upcoming hardware might raise that
335 * limit. Because the arrays need to add a bit for hub status data, we
336 * do 31, so plus one evens out to four bytes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 */
inaky@linux.intel.com43705252006-10-11 20:05:58 -0700338#define USB_MAXCHILDREN (31)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339
340struct usb_tt;
341
342/*
343 * struct usb_device - kernel's representation of a USB device
344 *
345 * FIXME: Write the kerneldoc!
346 *
347 * Usbcore drivers should not set usbdev->state directly. Instead use
348 * usb_set_device_state().
349 */
350struct usb_device {
351 int devnum; /* Address on USB bus */
352 char devpath [16]; /* Use in messages: /port/port/... */
353 enum usb_device_state state; /* configured, not attached, etc */
354 enum usb_device_speed speed; /* high/full/low (or error) */
355
356 struct usb_tt *tt; /* low/full speed dev, highspeed hub */
357 int ttport; /* device port on that tt hub */
358
Alan Sternb724ae72005-10-24 15:36:00 -0400359 unsigned int toggle[2]; /* one bit for each endpoint
360 * ([0] = IN, [1] = OUT) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361
362 struct usb_device *parent; /* our hub, unless we're the root */
363 struct usb_bus *bus; /* Bus we're part of */
364 struct usb_host_endpoint ep0;
365
366 struct device dev; /* Generic device interface */
367
368 struct usb_device_descriptor descriptor;/* Descriptor */
369 struct usb_host_config *config; /* All of the configs */
370
371 struct usb_host_config *actconfig;/* the active configuration */
372 struct usb_host_endpoint *ep_in[16];
373 struct usb_host_endpoint *ep_out[16];
374
375 char **rawdescriptors; /* Raw descriptors for each config */
376
Alan Stern55c52712005-11-23 12:03:12 -0500377 unsigned short bus_mA; /* Current available from the bus */
Alan Stern12c3da32005-11-23 12:09:52 -0500378 u8 portnum; /* Parent port number (origin 1) */
Alan Sternb6956ff2006-08-30 15:46:48 -0400379 u8 level; /* Number of USB hub ancestors */
Alan Stern55c52712005-11-23 12:03:12 -0500380
Alan Sternee49fb52006-11-22 16:55:54 -0500381 unsigned discon_suspended:1; /* Disconnected while suspended */
Alan Sternce361582006-11-20 11:12:22 -0500382 unsigned have_langid:1; /* whether string_langid is valid */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 int string_langid; /* language ID for strings */
384
Alan Stern4f62efe2005-10-24 16:24:14 -0400385 /* static strings from the device */
386 char *product; /* iProduct string, if present */
387 char *manufacturer; /* iManufacturer string, if present */
388 char *serial; /* iSerialNumber string, if present */
389
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 struct list_head filelist;
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100391#ifdef CONFIG_USB_DEVICE_CLASS
392 struct device *usb_classdev;
393#endif
394#ifdef CONFIG_USB_DEVICEFS
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 struct dentry *usbfs_dentry; /* usbfs dentry entry for the device */
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100396#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 /*
398 * Child devices - these can be either new devices
399 * (if this is a hub device), or different instances
400 * of this same device.
401 *
402 * Each instance needs its own set of data structures.
403 */
404
405 int maxchild; /* Number of ports if hub */
406 struct usb_device *children[USB_MAXCHILDREN];
Alan Stern645daaa2006-08-30 15:47:02 -0400407
Alan Sterne0318eb2006-09-26 14:50:20 -0400408 int pm_usage_cnt; /* usage counter for autosuspend */
Oliver Neukum7ceec1f2007-01-26 14:26:21 +0100409 u32 quirks; /* quirks of the whole device */
Alan Sternb5e795f2007-02-20 15:00:53 -0500410
Alan Stern645daaa2006-08-30 15:47:02 -0400411#ifdef CONFIG_PM
David Howellsc4028952006-11-22 14:57:56 +0000412 struct delayed_work autosuspend; /* for delayed autosuspends */
Alan Stern645daaa2006-08-30 15:47:02 -0400413 struct mutex pm_mutex; /* protects PM operations */
Alan Stern645daaa2006-08-30 15:47:02 -0400414
Alan Stern19410442007-03-27 13:33:59 -0400415 unsigned long last_busy; /* time of last use */
Alan Sterneaafbc32007-03-13 16:39:15 -0400416 int autosuspend_delay; /* in jiffies */
Alan Sternb5e795f2007-02-20 15:00:53 -0500417
Alan Stern645daaa2006-08-30 15:47:02 -0400418 unsigned auto_pm:1; /* autosuspend/resume in progress */
419 unsigned do_remote_wakeup:1; /* remote wakeup should be enabled */
Alan Stern0458d5b2007-05-04 11:52:20 -0400420 unsigned reset_resume:1; /* needs reset instead of resume */
Alan Sternb41a60e2007-05-30 15:39:33 -0400421 unsigned persist_enabled:1; /* USB_PERSIST enabled for this dev */
Alan Stern2add5222007-03-20 14:59:39 -0400422 unsigned autosuspend_disabled:1; /* autosuspend and autoresume */
423 unsigned autoresume_disabled:1; /* disabled by the user */
Alan Stern645daaa2006-08-30 15:47:02 -0400424#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425};
426#define to_usb_device(d) container_of(d, struct usb_device, dev)
427
428extern struct usb_device *usb_get_dev(struct usb_device *dev);
429extern void usb_put_dev(struct usb_device *dev);
430
Alan Stern9ad3d6c2005-11-17 17:10:32 -0500431/* USB device locking */
432#define usb_lock_device(udev) down(&(udev)->dev.sem)
433#define usb_unlock_device(udev) up(&(udev)->dev.sem)
434#define usb_trylock_device(udev) down_trylock(&(udev)->dev.sem)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435extern int usb_lock_device_for_reset(struct usb_device *udev,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300436 const struct usb_interface *iface);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437
438/* USB port reset for device reinitialization */
439extern int usb_reset_device(struct usb_device *dev);
Alan Stern79efa092006-06-01 13:33:42 -0400440extern int usb_reset_composite_device(struct usb_device *dev,
441 struct usb_interface *iface);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442
443extern struct usb_device *usb_find_device(u16 vendor_id, u16 product_id);
444
Alan Stern645daaa2006-08-30 15:47:02 -0400445/* USB autosuspend and autoresume */
446#ifdef CONFIG_USB_SUSPEND
Alan Stern692a1862006-10-30 17:07:51 -0500447extern int usb_autopm_set_interface(struct usb_interface *intf);
Alan Stern645daaa2006-08-30 15:47:02 -0400448extern int usb_autopm_get_interface(struct usb_interface *intf);
449extern void usb_autopm_put_interface(struct usb_interface *intf);
450
Alan Stern692a1862006-10-30 17:07:51 -0500451static inline void usb_autopm_enable(struct usb_interface *intf)
452{
453 intf->pm_usage_cnt = 0;
454 usb_autopm_set_interface(intf);
455}
Alan Stern645daaa2006-08-30 15:47:02 -0400456
Alan Stern692a1862006-10-30 17:07:51 -0500457static inline void usb_autopm_disable(struct usb_interface *intf)
458{
459 intf->pm_usage_cnt = 1;
460 usb_autopm_set_interface(intf);
461}
462
Alan Stern19410442007-03-27 13:33:59 -0400463static inline void usb_mark_last_busy(struct usb_device *udev)
464{
465 udev->last_busy = jiffies;
466}
467
Alan Stern692a1862006-10-30 17:07:51 -0500468#else
469
470static inline int usb_autopm_set_interface(struct usb_interface *intf)
471{ return 0; }
472
473static inline int usb_autopm_get_interface(struct usb_interface *intf)
474{ return 0; }
475
476static inline void usb_autopm_put_interface(struct usb_interface *intf)
477{ }
478static inline void usb_autopm_enable(struct usb_interface *intf)
479{ }
480static inline void usb_autopm_disable(struct usb_interface *intf)
481{ }
Alan Stern19410442007-03-27 13:33:59 -0400482static inline void usb_mark_last_busy(struct usb_device *udev)
483{ }
Alan Stern692a1862006-10-30 17:07:51 -0500484#endif
Alan Stern645daaa2006-08-30 15:47:02 -0400485
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486/*-------------------------------------------------------------------------*/
487
488/* for drivers using iso endpoints */
489extern int usb_get_current_frame_number (struct usb_device *usb_dev);
490
491/* used these for multi-interface device registration */
492extern int usb_driver_claim_interface(struct usb_driver *driver,
493 struct usb_interface *iface, void* priv);
494
495/**
496 * usb_interface_claimed - returns true iff an interface is claimed
497 * @iface: the interface being checked
498 *
499 * Returns true (nonzero) iff the interface is claimed, else false (zero).
500 * Callers must own the driver model's usb bus readlock. So driver
501 * probe() entries don't need extra locking, but other call contexts
502 * may need to explicitly claim that lock.
503 *
504 */
505static inline int usb_interface_claimed(struct usb_interface *iface) {
506 return (iface->dev.driver != NULL);
507}
508
509extern void usb_driver_release_interface(struct usb_driver *driver,
510 struct usb_interface *iface);
511const struct usb_device_id *usb_match_id(struct usb_interface *interface,
512 const struct usb_device_id *id);
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +0100513extern int usb_match_one_id(struct usb_interface *interface,
514 const struct usb_device_id *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515
516extern struct usb_interface *usb_find_interface(struct usb_driver *drv,
517 int minor);
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300518extern struct usb_interface *usb_ifnum_to_if(const struct usb_device *dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 unsigned ifnum);
520extern struct usb_host_interface *usb_altnum_to_altsetting(
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300521 const struct usb_interface *intf, unsigned int altnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522
523
524/**
525 * usb_make_path - returns stable device path in the usb tree
526 * @dev: the device whose path is being constructed
527 * @buf: where to put the string
528 * @size: how big is "buf"?
529 *
530 * Returns length of the string (> 0) or negative if size was too small.
531 *
532 * This identifier is intended to be "stable", reflecting physical paths in
533 * hardware such as physical bus addresses for host controllers or ports on
534 * USB hubs. That makes it stay the same until systems are physically
535 * reconfigured, by re-cabling a tree of USB devices or by moving USB host
536 * controllers. Adding and removing devices, including virtual root hubs
537 * in host controller driver modules, does not change these path identifers;
538 * neither does rebooting or re-enumerating. These are more useful identifiers
539 * than changeable ("unstable") ones like bus numbers or device addresses.
540 *
541 * With a partial exception for devices connected to USB 2.0 root hubs, these
542 * identifiers are also predictable. So long as the device tree isn't changed,
543 * plugging any USB device into a given hub port always gives it the same path.
544 * Because of the use of "companion" controllers, devices connected to ports on
545 * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are
546 * high speed, and a different one if they are full or low speed.
547 */
Alan Sternb724ae72005-10-24 15:36:00 -0400548static inline int usb_make_path (struct usb_device *dev, char *buf,
549 size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550{
551 int actual;
Alan Sternb724ae72005-10-24 15:36:00 -0400552 actual = snprintf (buf, size, "usb-%s-%s", dev->bus->bus_name,
553 dev->devpath);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 return (actual >= (int)size) ? -1 : actual;
555}
556
557/*-------------------------------------------------------------------------*/
558
Luiz Fernando N. Capitulino0c1ac4f2006-10-30 14:53:03 -0300559/**
Alan Stern5b653c72007-07-30 17:04:37 -0400560 * usb_endpoint_num - get the endpoint's number
561 * @epd: endpoint to be checked
562 *
563 * Returns @epd's number: 0 to 15.
564 */
565static inline int usb_endpoint_num(const struct usb_endpoint_descriptor *epd)
566{
567 return epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
568}
569
570/**
571 * usb_endpoint_type - get the endpoint's transfer type
572 * @epd: endpoint to be checked
573 *
574 * Returns one of USB_ENDPOINT_XFER_{CONTROL, ISOC, BULK, INT} according
575 * to @epd's transfer type.
576 */
577static inline int usb_endpoint_type(const struct usb_endpoint_descriptor *epd)
578{
579 return epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
580}
581
582/**
Luiz Fernando N. Capitulino0c1ac4f2006-10-30 14:53:03 -0300583 * usb_endpoint_dir_in - check if the endpoint has IN direction
584 * @epd: endpoint to be checked
585 *
586 * Returns true if the endpoint is of type IN, otherwise it returns false.
587 */
588static inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor *epd)
589{
590 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN);
591}
592
593/**
594 * usb_endpoint_dir_out - check if the endpoint has OUT direction
595 * @epd: endpoint to be checked
596 *
597 * Returns true if the endpoint is of type OUT, otherwise it returns false.
598 */
599static inline int usb_endpoint_dir_out(const struct usb_endpoint_descriptor *epd)
600{
601 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT);
602}
603
604/**
605 * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type
606 * @epd: endpoint to be checked
607 *
608 * Returns true if the endpoint is of type bulk, otherwise it returns false.
609 */
610static inline int usb_endpoint_xfer_bulk(const struct usb_endpoint_descriptor *epd)
611{
612 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
613 USB_ENDPOINT_XFER_BULK);
614}
615
616/**
Sarah Baileya8ef36b2006-12-23 23:14:58 -0800617 * usb_endpoint_xfer_control - check if the endpoint has control transfer type
618 * @epd: endpoint to be checked
619 *
620 * Returns true if the endpoint is of type control, otherwise it returns false.
621 */
622static inline int usb_endpoint_xfer_control(const struct usb_endpoint_descriptor *epd)
623{
624 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
625 USB_ENDPOINT_XFER_CONTROL);
626}
627
628/**
Luiz Fernando N. Capitulino0c1ac4f2006-10-30 14:53:03 -0300629 * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type
630 * @epd: endpoint to be checked
631 *
632 * Returns true if the endpoint is of type interrupt, otherwise it returns
633 * false.
634 */
635static inline int usb_endpoint_xfer_int(const struct usb_endpoint_descriptor *epd)
636{
637 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
638 USB_ENDPOINT_XFER_INT);
639}
640
641/**
642 * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type
643 * @epd: endpoint to be checked
644 *
645 * Returns true if the endpoint is of type isochronous, otherwise it returns
646 * false.
647 */
648static inline int usb_endpoint_xfer_isoc(const struct usb_endpoint_descriptor *epd)
649{
650 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
651 USB_ENDPOINT_XFER_ISOC);
652}
653
654/**
655 * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN
656 * @epd: endpoint to be checked
657 *
658 * Returns true if the endpoint has bulk transfer type and IN direction,
659 * otherwise it returns false.
660 */
661static inline int usb_endpoint_is_bulk_in(const struct usb_endpoint_descriptor *epd)
662{
663 return (usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_in(epd));
664}
665
666/**
667 * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT
668 * @epd: endpoint to be checked
669 *
670 * Returns true if the endpoint has bulk transfer type and OUT direction,
671 * otherwise it returns false.
672 */
673static inline int usb_endpoint_is_bulk_out(const struct usb_endpoint_descriptor *epd)
674{
675 return (usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_out(epd));
676}
677
678/**
679 * usb_endpoint_is_int_in - check if the endpoint is interrupt IN
680 * @epd: endpoint to be checked
681 *
682 * Returns true if the endpoint has interrupt transfer type and IN direction,
683 * otherwise it returns false.
684 */
685static inline int usb_endpoint_is_int_in(const struct usb_endpoint_descriptor *epd)
686{
687 return (usb_endpoint_xfer_int(epd) && usb_endpoint_dir_in(epd));
688}
689
690/**
691 * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT
692 * @epd: endpoint to be checked
693 *
694 * Returns true if the endpoint has interrupt transfer type and OUT direction,
695 * otherwise it returns false.
696 */
697static inline int usb_endpoint_is_int_out(const struct usb_endpoint_descriptor *epd)
698{
699 return (usb_endpoint_xfer_int(epd) && usb_endpoint_dir_out(epd));
700}
701
702/**
703 * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN
704 * @epd: endpoint to be checked
705 *
706 * Returns true if the endpoint has isochronous transfer type and IN direction,
707 * otherwise it returns false.
708 */
709static inline int usb_endpoint_is_isoc_in(const struct usb_endpoint_descriptor *epd)
710{
711 return (usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_in(epd));
712}
713
714/**
715 * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT
716 * @epd: endpoint to be checked
717 *
718 * Returns true if the endpoint has isochronous transfer type and OUT direction,
719 * otherwise it returns false.
720 */
721static inline int usb_endpoint_is_isoc_out(const struct usb_endpoint_descriptor *epd)
722{
723 return (usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_out(epd));
724}
Luiz Fernando N. Capitulinob7cfaaa2006-09-27 11:58:53 -0700725
726/*-------------------------------------------------------------------------*/
727
Alan Sternb724ae72005-10-24 15:36:00 -0400728#define USB_DEVICE_ID_MATCH_DEVICE \
729 (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
730#define USB_DEVICE_ID_MATCH_DEV_RANGE \
731 (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI)
732#define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
733 (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734#define USB_DEVICE_ID_MATCH_DEV_INFO \
Alan Sternb724ae72005-10-24 15:36:00 -0400735 (USB_DEVICE_ID_MATCH_DEV_CLASS | \
736 USB_DEVICE_ID_MATCH_DEV_SUBCLASS | \
737 USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738#define USB_DEVICE_ID_MATCH_INT_INFO \
Alan Sternb724ae72005-10-24 15:36:00 -0400739 (USB_DEVICE_ID_MATCH_INT_CLASS | \
740 USB_DEVICE_ID_MATCH_INT_SUBCLASS | \
741 USB_DEVICE_ID_MATCH_INT_PROTOCOL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742
743/**
744 * USB_DEVICE - macro used to describe a specific usb device
745 * @vend: the 16 bit USB Vendor ID
746 * @prod: the 16 bit USB Product ID
747 *
748 * This macro is used to create a struct usb_device_id that matches a
749 * specific device.
750 */
751#define USB_DEVICE(vend,prod) \
Alan Sternb724ae72005-10-24 15:36:00 -0400752 .match_flags = USB_DEVICE_ID_MATCH_DEVICE, .idVendor = (vend), \
753 .idProduct = (prod)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754/**
Alan Sternb724ae72005-10-24 15:36:00 -0400755 * USB_DEVICE_VER - macro used to describe a specific usb device with a
756 * version range
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 * @vend: the 16 bit USB Vendor ID
758 * @prod: the 16 bit USB Product ID
759 * @lo: the bcdDevice_lo value
760 * @hi: the bcdDevice_hi value
761 *
762 * This macro is used to create a struct usb_device_id that matches a
763 * specific device, with a version range.
764 */
765#define USB_DEVICE_VER(vend,prod,lo,hi) \
Alan Sternb724ae72005-10-24 15:36:00 -0400766 .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, \
767 .idVendor = (vend), .idProduct = (prod), \
768 .bcdDevice_lo = (lo), .bcdDevice_hi = (hi)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769
770/**
Jan Kratochvilf836ac82007-05-09 00:26:15 -0400771 * USB_DEVICE_INTERFACE_PROTOCOL - macro used to describe a usb
772 * device with a specific interface protocol
773 * @vend: the 16 bit USB Vendor ID
774 * @prod: the 16 bit USB Product ID
775 * @pr: bInterfaceProtocol value
776 *
777 * This macro is used to create a struct usb_device_id that matches a
778 * specific interface protocol of devices.
779 */
780#define USB_DEVICE_INTERFACE_PROTOCOL(vend,prod,pr) \
781 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_INT_PROTOCOL, \
782 .idVendor = (vend), \
783 .idProduct = (prod), \
784 .bInterfaceProtocol = (pr)
785
786/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 * USB_DEVICE_INFO - macro used to describe a class of usb devices
788 * @cl: bDeviceClass value
789 * @sc: bDeviceSubClass value
790 * @pr: bDeviceProtocol value
791 *
792 * This macro is used to create a struct usb_device_id that matches a
793 * specific class of devices.
794 */
795#define USB_DEVICE_INFO(cl,sc,pr) \
Alan Sternb724ae72005-10-24 15:36:00 -0400796 .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, .bDeviceClass = (cl), \
797 .bDeviceSubClass = (sc), .bDeviceProtocol = (pr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798
799/**
800 * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces
801 * @cl: bInterfaceClass value
802 * @sc: bInterfaceSubClass value
803 * @pr: bInterfaceProtocol value
804 *
805 * This macro is used to create a struct usb_device_id that matches a
806 * specific class of interfaces.
807 */
808#define USB_INTERFACE_INFO(cl,sc,pr) \
Alan Sternb724ae72005-10-24 15:36:00 -0400809 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, .bInterfaceClass = (cl), \
810 .bInterfaceSubClass = (sc), .bInterfaceProtocol = (pr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811
Daniel Drake8538f962007-05-10 00:32:24 +0100812/**
813 * USB_DEVICE_AND_INTERFACE_INFO - macro used to describe a specific usb device
814 * with a class of usb interfaces
815 * @vend: the 16 bit USB Vendor ID
816 * @prod: the 16 bit USB Product ID
817 * @cl: bInterfaceClass value
818 * @sc: bInterfaceSubClass value
819 * @pr: bInterfaceProtocol value
820 *
821 * This macro is used to create a struct usb_device_id that matches a
822 * specific device with a specific class of interfaces.
823 *
824 * This is especially useful when explicitly matching devices that have
825 * vendor specific bDeviceClass values, but standards-compliant interfaces.
826 */
827#define USB_DEVICE_AND_INTERFACE_INFO(vend,prod,cl,sc,pr) \
828 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO \
829 | USB_DEVICE_ID_MATCH_DEVICE, \
830 .idVendor = (vend), .idProduct = (prod), \
831 .bInterfaceClass = (cl), \
832 .bInterfaceSubClass = (sc), .bInterfaceProtocol = (pr)
833
Alan Sternb724ae72005-10-24 15:36:00 -0400834/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +0100836/* Stuff for dynamic usb ids */
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800837struct usb_dynids {
838 spinlock_t lock;
839 struct list_head list;
840};
841
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +0100842struct usb_dynid {
843 struct list_head node;
844 struct usb_device_id id;
845};
846
847extern ssize_t usb_store_new_id(struct usb_dynids *dynids,
848 struct device_driver *driver,
849 const char *buf, size_t count);
850
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851/**
Alan Stern8bb54ab2006-07-01 22:08:49 -0400852 * struct usbdrv_wrap - wrapper for driver-model structure
853 * @driver: The driver-model core driver structure.
854 * @for_devices: Non-zero for device drivers, 0 for interface drivers.
855 */
856struct usbdrv_wrap {
857 struct device_driver driver;
858 int for_devices;
859};
860
861/**
862 * struct usb_driver - identifies USB interface driver to usbcore
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863 * @name: The driver name should be unique among USB drivers,
864 * and should normally be the same as the module name.
865 * @probe: Called to see if the driver is willing to manage a particular
866 * interface on a device. If it is, probe returns zero and uses
867 * dev_set_drvdata() to associate driver-specific data with the
868 * interface. It may also use usb_set_interface() to specify the
869 * appropriate altsetting. If unwilling to manage the interface,
870 * return a negative errno value.
871 * @disconnect: Called when the interface is no longer accessible, usually
872 * because its device has been (or is being) disconnected or the
873 * driver module is being unloaded.
874 * @ioctl: Used for drivers that want to talk to userspace through
875 * the "usbfs" filesystem. This lets devices provide ways to
876 * expose information to user space regardless of where they
877 * do (or don't) show up otherwise in the filesystem.
878 * @suspend: Called when the device is going to be suspended by the system.
879 * @resume: Called when the device is being resumed by the system.
Alan Sternf07600c2007-05-30 15:38:16 -0400880 * @reset_resume: Called when the suspended device has been reset instead
881 * of being resumed.
Alan Stern79efa092006-06-01 13:33:42 -0400882 * @pre_reset: Called by usb_reset_composite_device() when the device
883 * is about to be reset.
884 * @post_reset: Called by usb_reset_composite_device() after the device
Alan Stern0458d5b2007-05-04 11:52:20 -0400885 * has been reset, or in lieu of @resume following a reset-resume
886 * (i.e., the device is reset instead of being resumed, as might
887 * happen if power was lost). The second argument tells which is
888 * the reason.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 * @id_table: USB drivers use ID table to support hotplugging.
890 * Export this with MODULE_DEVICE_TABLE(usb,...). This must be set
891 * or your driver's probe function will never get called.
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800892 * @dynids: used internally to hold the list of dynamically added device
893 * ids for this driver.
Alan Stern8bb54ab2006-07-01 22:08:49 -0400894 * @drvwrap: Driver-model core structure wrapper.
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -0800895 * @no_dynamic_id: if set to 1, the USB core will not allow dynamic ids to be
896 * added to this driver by preventing the sysfs file from being created.
Alan Stern645daaa2006-08-30 15:47:02 -0400897 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
898 * for interfaces bound to this driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899 *
Alan Stern8bb54ab2006-07-01 22:08:49 -0400900 * USB interface drivers must provide a name, probe() and disconnect()
901 * methods, and an id_table. Other driver fields are optional.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902 *
903 * The id_table is used in hotplugging. It holds a set of descriptors,
904 * and specialized data may be associated with each entry. That table
905 * is used by both user and kernel mode hotplugging support.
906 *
907 * The probe() and disconnect() methods are called in a context where
908 * they can sleep, but they should avoid abusing the privilege. Most
909 * work to connect to a device should be done when the device is opened,
910 * and undone at the last close. The disconnect code needs to address
911 * concurrency issues with respect to open() and close() methods, as
912 * well as forcing all pending I/O requests to complete (by unlinking
913 * them as necessary, and blocking until the unlinks complete).
914 */
915struct usb_driver {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916 const char *name;
917
918 int (*probe) (struct usb_interface *intf,
919 const struct usb_device_id *id);
920
921 void (*disconnect) (struct usb_interface *intf);
922
Alan Sternb724ae72005-10-24 15:36:00 -0400923 int (*ioctl) (struct usb_interface *intf, unsigned int code,
924 void *buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925
David Brownell27d72e82005-04-18 17:39:22 -0700926 int (*suspend) (struct usb_interface *intf, pm_message_t message);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 int (*resume) (struct usb_interface *intf);
Alan Sternf07600c2007-05-30 15:38:16 -0400928 int (*reset_resume)(struct usb_interface *intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929
Alan Sternf07600c2007-05-30 15:38:16 -0400930 int (*pre_reset)(struct usb_interface *intf);
931 int (*post_reset)(struct usb_interface *intf);
Alan Stern79efa092006-06-01 13:33:42 -0400932
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 const struct usb_device_id *id_table;
934
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800935 struct usb_dynids dynids;
Alan Stern8bb54ab2006-07-01 22:08:49 -0400936 struct usbdrv_wrap drvwrap;
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -0800937 unsigned int no_dynamic_id:1;
Alan Stern645daaa2006-08-30 15:47:02 -0400938 unsigned int supports_autosuspend:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939};
Alan Stern8bb54ab2006-07-01 22:08:49 -0400940#define to_usb_driver(d) container_of(d, struct usb_driver, drvwrap.driver)
941
942/**
943 * struct usb_device_driver - identifies USB device driver to usbcore
944 * @name: The driver name should be unique among USB drivers,
945 * and should normally be the same as the module name.
946 * @probe: Called to see if the driver is willing to manage a particular
947 * device. If it is, probe returns zero and uses dev_set_drvdata()
948 * to associate driver-specific data with the device. If unwilling
949 * to manage the device, return a negative errno value.
950 * @disconnect: Called when the device is no longer accessible, usually
951 * because it has been (or is being) disconnected or the driver's
952 * module is being unloaded.
953 * @suspend: Called when the device is going to be suspended by the system.
954 * @resume: Called when the device is being resumed by the system.
955 * @drvwrap: Driver-model core structure wrapper.
Alan Stern645daaa2006-08-30 15:47:02 -0400956 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
957 * for devices bound to this driver.
Alan Stern8bb54ab2006-07-01 22:08:49 -0400958 *
959 * USB drivers must provide all the fields listed above except drvwrap.
960 */
961struct usb_device_driver {
962 const char *name;
963
964 int (*probe) (struct usb_device *udev);
965 void (*disconnect) (struct usb_device *udev);
966
967 int (*suspend) (struct usb_device *udev, pm_message_t message);
968 int (*resume) (struct usb_device *udev);
969 struct usbdrv_wrap drvwrap;
Alan Stern645daaa2006-08-30 15:47:02 -0400970 unsigned int supports_autosuspend:1;
Alan Stern8bb54ab2006-07-01 22:08:49 -0400971};
972#define to_usb_device_driver(d) container_of(d, struct usb_device_driver, \
973 drvwrap.driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974
975extern struct bus_type usb_bus_type;
976
977/**
978 * struct usb_class_driver - identifies a USB driver that wants to use the USB major number
Greg Kroah-Hartmand6e5bcf2005-06-20 21:15:16 -0700979 * @name: the usb class device name for this driver. Will show up in sysfs.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 * @fops: pointer to the struct file_operations of this driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 * @minor_base: the start of the minor range for this driver.
982 *
983 * This structure is used for the usb_register_dev() and
984 * usb_unregister_dev() functions, to consolidate a number of the
985 * parameters used for them.
986 */
987struct usb_class_driver {
988 char *name;
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800989 const struct file_operations *fops;
Greg Kroah-Hartmand6e5bcf2005-06-20 21:15:16 -0700990 int minor_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991};
992
993/*
994 * use these in module_init()/module_exit()
995 * and don't forget MODULE_DEVICE_TABLE(usb, ...)
996 */
Greg Kroah-Hartman80f745f2007-01-15 11:50:02 -0800997extern int usb_register_driver(struct usb_driver *, struct module *,
998 const char *);
Greg Kroah-Hartman2143acc2005-11-21 14:53:03 -0800999static inline int usb_register(struct usb_driver *driver)
1000{
Greg Kroah-Hartman80f745f2007-01-15 11:50:02 -08001001 return usb_register_driver(driver, THIS_MODULE, KBUILD_MODNAME);
Greg Kroah-Hartman2143acc2005-11-21 14:53:03 -08001002}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003extern void usb_deregister(struct usb_driver *);
1004
Alan Stern8bb54ab2006-07-01 22:08:49 -04001005extern int usb_register_device_driver(struct usb_device_driver *,
1006 struct module *);
1007extern void usb_deregister_device_driver(struct usb_device_driver *);
1008
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009extern int usb_register_dev(struct usb_interface *intf,
1010 struct usb_class_driver *class_driver);
1011extern void usb_deregister_dev(struct usb_interface *intf,
1012 struct usb_class_driver *class_driver);
1013
1014extern int usb_disabled(void);
1015
Alan Sternb724ae72005-10-24 15:36:00 -04001016/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017
1018/*
1019 * URB support, for asynchronous request completions
1020 */
1021
1022/*
1023 * urb->transfer_flags:
Alan Sternfea34092007-07-30 17:06:16 -04001024 *
1025 * Note: URB_DIR_IN/OUT is automatically set in usb_submit_urb().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026 */
1027#define URB_SHORT_NOT_OK 0x0001 /* report short reads as errors */
Alan Sternb724ae72005-10-24 15:36:00 -04001028#define URB_ISO_ASAP 0x0002 /* iso-only, urb->start_frame
1029 * ignored */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030#define URB_NO_TRANSFER_DMA_MAP 0x0004 /* urb->transfer_dma valid on submit */
1031#define URB_NO_SETUP_DMA_MAP 0x0008 /* urb->setup_dma valid on submit */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032#define URB_NO_FSBR 0x0020 /* UHCI-specific */
Alan Sternb724ae72005-10-24 15:36:00 -04001033#define URB_ZERO_PACKET 0x0040 /* Finish bulk OUT with short packet */
1034#define URB_NO_INTERRUPT 0x0080 /* HINT: no non-error interrupt
1035 * needed */
Marcel Holtmann8b3b01c2007-06-13 08:02:11 +02001036#define URB_FREE_BUFFER 0x0100 /* Free transfer buffer with the URB */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037
Alan Sternfea34092007-07-30 17:06:16 -04001038#define URB_DIR_IN 0x0200 /* Transfer from device to host */
1039#define URB_DIR_OUT 0
1040#define URB_DIR_MASK URB_DIR_IN
1041
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042struct usb_iso_packet_descriptor {
1043 unsigned int offset;
1044 unsigned int length; /* expected length */
1045 unsigned int actual_length;
Pete Zaitcevd1bbb602007-02-11 13:56:13 -08001046 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047};
1048
1049struct urb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050
Oliver Neukum51a2f072007-05-25 13:40:56 +02001051struct usb_anchor {
1052 struct list_head urb_list;
1053 wait_queue_head_t wait;
1054 spinlock_t lock;
1055};
1056
1057static inline void init_usb_anchor(struct usb_anchor *anchor)
1058{
1059 INIT_LIST_HEAD(&anchor->urb_list);
1060 init_waitqueue_head(&anchor->wait);
1061 spin_lock_init(&anchor->lock);
1062}
1063
David Howells7d12e782006-10-05 14:55:46 +01001064typedef void (*usb_complete_t)(struct urb *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065
1066/**
1067 * struct urb - USB Request Block
1068 * @urb_list: For use by current owner of the URB.
Oliver Neukum51a2f072007-05-25 13:40:56 +02001069 * @anchor_list: membership in the list of an anchor
1070 * @anchor: to anchor URBs to a common mooring
Alan Stern5b653c72007-07-30 17:04:37 -04001071 * @ep: Points to the endpoint's data structure. Will eventually
1072 * replace @pipe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073 * @pipe: Holds endpoint number, direction, type, and more.
1074 * Create these values with the eight macros available;
1075 * usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl"
1076 * (control), "bulk", "int" (interrupt), or "iso" (isochronous).
1077 * For example usb_sndbulkpipe() or usb_rcvintpipe(). Endpoint
1078 * numbers range from zero to fifteen. Note that "in" endpoint two
1079 * is a different endpoint (and pipe) from "out" endpoint two.
1080 * The current configuration controls the existence, type, and
1081 * maximum packet size of any given endpoint.
1082 * @dev: Identifies the USB device to perform the request.
1083 * @status: This is read in non-iso completion functions to get the
1084 * status of the particular request. ISO requests only use it
1085 * to tell whether the URB was unlinked; detailed status for
1086 * each frame is in the fields of the iso_frame-desc.
1087 * @transfer_flags: A variety of flags may be used to affect how URB
1088 * submission, unlinking, or operation are handled. Different
1089 * kinds of URB can use different flags.
1090 * @transfer_buffer: This identifies the buffer to (or from) which
1091 * the I/O request will be performed (unless URB_NO_TRANSFER_DMA_MAP
1092 * is set). This buffer must be suitable for DMA; allocate it with
1093 * kmalloc() or equivalent. For transfers to "in" endpoints, contents
1094 * of this buffer will be modified. This buffer is used for the data
1095 * stage of control transfers.
1096 * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP,
1097 * the device driver is saying that it provided this DMA address,
1098 * which the host controller driver should use in preference to the
1099 * transfer_buffer.
1100 * @transfer_buffer_length: How big is transfer_buffer. The transfer may
1101 * be broken up into chunks according to the current maximum packet
1102 * size for the endpoint, which is a function of the configuration
1103 * and is encoded in the pipe. When the length is zero, neither
1104 * transfer_buffer nor transfer_dma is used.
1105 * @actual_length: This is read in non-iso completion functions, and
1106 * it tells how many bytes (out of transfer_buffer_length) were
1107 * transferred. It will normally be the same as requested, unless
1108 * either an error was reported or a short read was performed.
1109 * The URB_SHORT_NOT_OK transfer flag may be used to make such
1110 * short reads be reported as errors.
1111 * @setup_packet: Only used for control transfers, this points to eight bytes
1112 * of setup data. Control transfers always start by sending this data
1113 * to the device. Then transfer_buffer is read or written, if needed.
1114 * @setup_dma: For control transfers with URB_NO_SETUP_DMA_MAP set, the
1115 * device driver has provided this DMA address for the setup packet.
1116 * The host controller driver should use this in preference to
1117 * setup_packet.
1118 * @start_frame: Returns the initial frame for isochronous transfers.
1119 * @number_of_packets: Lists the number of ISO transfer buffers.
1120 * @interval: Specifies the polling interval for interrupt or isochronous
1121 * transfers. The units are frames (milliseconds) for for full and low
1122 * speed devices, and microframes (1/8 millisecond) for highspeed ones.
1123 * @error_count: Returns the number of ISO transfers that reported errors.
1124 * @context: For use in completion functions. This normally points to
1125 * request-specific driver context.
1126 * @complete: Completion handler. This URB is passed as the parameter to the
1127 * completion function. The completion function may then do what
1128 * it likes with the URB, including resubmitting or freeing it.
1129 * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to
1130 * collect the transfer status for each buffer.
1131 *
1132 * This structure identifies USB transfer requests. URBs must be allocated by
1133 * calling usb_alloc_urb() and freed with a call to usb_free_urb().
1134 * Initialization may be done using various usb_fill_*_urb() functions. URBs
1135 * are submitted using usb_submit_urb(), and pending requests may be canceled
1136 * using usb_unlink_urb() or usb_kill_urb().
1137 *
1138 * Data Transfer Buffers:
1139 *
1140 * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise
1141 * taken from the general page pool. That is provided by transfer_buffer
1142 * (control requests also use setup_packet), and host controller drivers
1143 * perform a dma mapping (and unmapping) for each buffer transferred. Those
1144 * mapping operations can be expensive on some platforms (perhaps using a dma
1145 * bounce buffer or talking to an IOMMU),
1146 * although they're cheap on commodity x86 and ppc hardware.
1147 *
1148 * Alternatively, drivers may pass the URB_NO_xxx_DMA_MAP transfer flags,
1149 * which tell the host controller driver that no such mapping is needed since
1150 * the device driver is DMA-aware. For example, a device driver might
1151 * allocate a DMA buffer with usb_buffer_alloc() or call usb_buffer_map().
1152 * When these transfer flags are provided, host controller drivers will
1153 * attempt to use the dma addresses found in the transfer_dma and/or
1154 * setup_dma fields rather than determining a dma address themselves. (Note
1155 * that transfer_buffer and setup_packet must still be set because not all
1156 * host controllers use DMA, nor do virtual root hubs).
1157 *
1158 * Initialization:
1159 *
1160 * All URBs submitted must initialize the dev, pipe, transfer_flags (may be
Alan Sternb375a042005-07-29 16:11:07 -04001161 * zero), and complete fields. All URBs must also initialize
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162 * transfer_buffer and transfer_buffer_length. They may provide the
1163 * URB_SHORT_NOT_OK transfer flag, indicating that short reads are
1164 * to be treated as errors; that flag is invalid for write requests.
1165 *
1166 * Bulk URBs may
1167 * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers
1168 * should always terminate with a short packet, even if it means adding an
1169 * extra zero length packet.
1170 *
1171 * Control URBs must provide a setup_packet. The setup_packet and
1172 * transfer_buffer may each be mapped for DMA or not, independently of
1173 * the other. The transfer_flags bits URB_NO_TRANSFER_DMA_MAP and
1174 * URB_NO_SETUP_DMA_MAP indicate which buffers have already been mapped.
1175 * URB_NO_SETUP_DMA_MAP is ignored for non-control URBs.
1176 *
1177 * Interrupt URBs must provide an interval, saying how often (in milliseconds
1178 * or, for highspeed devices, 125 microsecond units)
1179 * to poll for transfers. After the URB has been submitted, the interval
1180 * field reflects how the transfer was actually scheduled.
1181 * The polling interval may be more frequent than requested.
1182 * For example, some controllers have a maximum interval of 32 milliseconds,
1183 * while others support intervals of up to 1024 milliseconds.
1184 * Isochronous URBs also have transfer intervals. (Note that for isochronous
1185 * endpoints, as well as high speed interrupt endpoints, the encoding of
1186 * the transfer interval in the endpoint descriptor is logarithmic.
1187 * Device drivers must convert that value to linear units themselves.)
1188 *
1189 * Isochronous URBs normally use the URB_ISO_ASAP transfer flag, telling
1190 * the host controller to schedule the transfer as soon as bandwidth
1191 * utilization allows, and then set start_frame to reflect the actual frame
1192 * selected during submission. Otherwise drivers must specify the start_frame
1193 * and handle the case where the transfer can't begin then. However, drivers
1194 * won't know how bandwidth is currently allocated, and while they can
1195 * find the current frame using usb_get_current_frame_number () they can't
1196 * know the range for that frame number. (Ranges for frame counter values
1197 * are HC-specific, and can go from 256 to 65536 frames from "now".)
1198 *
1199 * Isochronous URBs have a different data transfer model, in part because
1200 * the quality of service is only "best effort". Callers provide specially
1201 * allocated URBs, with number_of_packets worth of iso_frame_desc structures
1202 * at the end. Each such packet is an individual ISO transfer. Isochronous
1203 * URBs are normally queued, submitted by drivers to arrange that
1204 * transfers are at least double buffered, and then explicitly resubmitted
1205 * in completion handlers, so
1206 * that data (such as audio or video) streams at as constant a rate as the
1207 * host controller scheduler can support.
1208 *
1209 * Completion Callbacks:
1210 *
1211 * The completion callback is made in_interrupt(), and one of the first
1212 * things that a completion handler should do is check the status field.
1213 * The status field is provided for all URBs. It is used to report
1214 * unlinked URBs, and status for all non-ISO transfers. It should not
1215 * be examined before the URB is returned to the completion handler.
1216 *
1217 * The context field is normally used to link URBs back to the relevant
1218 * driver or request state.
1219 *
1220 * When the completion callback is invoked for non-isochronous URBs, the
1221 * actual_length field tells how many bytes were transferred. This field
1222 * is updated even when the URB terminated with an error or was unlinked.
1223 *
1224 * ISO transfer status is reported in the status and actual_length fields
1225 * of the iso_frame_desc array, and the number of errors is reported in
1226 * error_count. Completion callbacks for ISO transfers will normally
1227 * (re)submit URBs to ensure a constant transfer rate.
Roman Kagan719df462005-05-06 00:55:56 +04001228 *
1229 * Note that even fields marked "public" should not be touched by the driver
1230 * when the urb is owned by the hcd, that is, since the call to
1231 * usb_submit_urb() till the entry into the completion routine.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232 */
1233struct urb
1234{
Martin Waitzaeec46b2005-11-13 16:08:13 -08001235 /* private: usb core and host controller only fields in the urb */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236 struct kref kref; /* reference count of the URB */
1237 spinlock_t lock; /* lock for the URB */
1238 void *hcpriv; /* private data for host controller */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239 atomic_t use_count; /* concurrent submissions counter */
1240 u8 reject; /* submissions will fail */
1241
Martin Waitzaeec46b2005-11-13 16:08:13 -08001242 /* public: documented fields in the urb that can be used by drivers */
Alan Sternb724ae72005-10-24 15:36:00 -04001243 struct list_head urb_list; /* list head for use by the urb's
1244 * current owner */
Oliver Neukum51a2f072007-05-25 13:40:56 +02001245 struct list_head anchor_list; /* the URB may be anchored by the driver */
1246 struct usb_anchor *anchor;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247 struct usb_device *dev; /* (in) pointer to associated device */
Alan Stern5b653c72007-07-30 17:04:37 -04001248 struct usb_host_endpoint *ep; /* (internal) pointer to endpoint struct */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249 unsigned int pipe; /* (in) pipe information */
1250 int status; /* (return) non-ISO status */
1251 unsigned int transfer_flags; /* (in) URB_SHORT_NOT_OK | ...*/
1252 void *transfer_buffer; /* (in) associated data buffer */
1253 dma_addr_t transfer_dma; /* (in) dma addr for transfer_buffer */
1254 int transfer_buffer_length; /* (in) data buffer length */
1255 int actual_length; /* (return) actual transfer length */
1256 unsigned char *setup_packet; /* (in) setup packet (control only) */
1257 dma_addr_t setup_dma; /* (in) dma addr for setup_packet */
1258 int start_frame; /* (modify) start frame (ISO) */
1259 int number_of_packets; /* (in) number of ISO packets */
Alan Sternb724ae72005-10-24 15:36:00 -04001260 int interval; /* (modify) transfer interval
1261 * (INT/ISO) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262 int error_count; /* (return) number of ISO errors */
1263 void *context; /* (in) context for completion */
1264 usb_complete_t complete; /* (in) completion routine */
Alan Sternb724ae72005-10-24 15:36:00 -04001265 struct usb_iso_packet_descriptor iso_frame_desc[0];
1266 /* (in) ISO ONLY */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267};
1268
Alan Sternb724ae72005-10-24 15:36:00 -04001269/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270
1271/**
1272 * usb_fill_control_urb - initializes a control urb
1273 * @urb: pointer to the urb to initialize.
1274 * @dev: pointer to the struct usb_device for this urb.
1275 * @pipe: the endpoint pipe
1276 * @setup_packet: pointer to the setup_packet buffer
1277 * @transfer_buffer: pointer to the transfer buffer
1278 * @buffer_length: length of the transfer buffer
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001279 * @complete_fn: pointer to the usb_complete_t function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280 * @context: what to set the urb context to.
1281 *
1282 * Initializes a control urb with the proper information needed to submit
1283 * it to a device.
1284 */
1285static inline void usb_fill_control_urb (struct urb *urb,
1286 struct usb_device *dev,
1287 unsigned int pipe,
1288 unsigned char *setup_packet,
1289 void *transfer_buffer,
1290 int buffer_length,
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001291 usb_complete_t complete_fn,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292 void *context)
1293{
1294 spin_lock_init(&urb->lock);
1295 urb->dev = dev;
1296 urb->pipe = pipe;
1297 urb->setup_packet = setup_packet;
1298 urb->transfer_buffer = transfer_buffer;
1299 urb->transfer_buffer_length = buffer_length;
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001300 urb->complete = complete_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301 urb->context = context;
1302}
1303
1304/**
1305 * usb_fill_bulk_urb - macro to help initialize a bulk urb
1306 * @urb: pointer to the urb to initialize.
1307 * @dev: pointer to the struct usb_device for this urb.
1308 * @pipe: the endpoint pipe
1309 * @transfer_buffer: pointer to the transfer buffer
1310 * @buffer_length: length of the transfer buffer
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001311 * @complete_fn: pointer to the usb_complete_t function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312 * @context: what to set the urb context to.
1313 *
1314 * Initializes a bulk urb with the proper information needed to submit it
1315 * to a device.
1316 */
1317static inline void usb_fill_bulk_urb (struct urb *urb,
1318 struct usb_device *dev,
1319 unsigned int pipe,
1320 void *transfer_buffer,
1321 int buffer_length,
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001322 usb_complete_t complete_fn,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323 void *context)
1324{
1325 spin_lock_init(&urb->lock);
1326 urb->dev = dev;
1327 urb->pipe = pipe;
1328 urb->transfer_buffer = transfer_buffer;
1329 urb->transfer_buffer_length = buffer_length;
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001330 urb->complete = complete_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331 urb->context = context;
1332}
1333
1334/**
1335 * usb_fill_int_urb - macro to help initialize a interrupt urb
1336 * @urb: pointer to the urb to initialize.
1337 * @dev: pointer to the struct usb_device for this urb.
1338 * @pipe: the endpoint pipe
1339 * @transfer_buffer: pointer to the transfer buffer
1340 * @buffer_length: length of the transfer buffer
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001341 * @complete_fn: pointer to the usb_complete_t function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342 * @context: what to set the urb context to.
1343 * @interval: what to set the urb interval to, encoded like
1344 * the endpoint descriptor's bInterval value.
1345 *
1346 * Initializes a interrupt urb with the proper information needed to submit
1347 * it to a device.
1348 * Note that high speed interrupt endpoints use a logarithmic encoding of
1349 * the endpoint interval, and express polling intervals in microframes
1350 * (eight per millisecond) rather than in frames (one per millisecond).
1351 */
1352static inline void usb_fill_int_urb (struct urb *urb,
1353 struct usb_device *dev,
1354 unsigned int pipe,
1355 void *transfer_buffer,
1356 int buffer_length,
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001357 usb_complete_t complete_fn,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 void *context,
1359 int interval)
1360{
1361 spin_lock_init(&urb->lock);
1362 urb->dev = dev;
1363 urb->pipe = pipe;
1364 urb->transfer_buffer = transfer_buffer;
1365 urb->transfer_buffer_length = buffer_length;
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001366 urb->complete = complete_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367 urb->context = context;
1368 if (dev->speed == USB_SPEED_HIGH)
1369 urb->interval = 1 << (interval - 1);
1370 else
1371 urb->interval = interval;
1372 urb->start_frame = -1;
1373}
1374
1375extern void usb_init_urb(struct urb *urb);
Al Viro55016f12005-10-21 03:21:58 -04001376extern struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377extern void usb_free_urb(struct urb *urb);
1378#define usb_put_urb usb_free_urb
1379extern struct urb *usb_get_urb(struct urb *urb);
Al Viro55016f12005-10-21 03:21:58 -04001380extern int usb_submit_urb(struct urb *urb, gfp_t mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381extern int usb_unlink_urb(struct urb *urb);
1382extern void usb_kill_urb(struct urb *urb);
Oliver Neukum51a2f072007-05-25 13:40:56 +02001383extern void usb_kill_anchored_urbs(struct usb_anchor *anchor);
1384extern void usb_anchor_urb(struct urb *urb, struct usb_anchor *anchor);
1385extern void usb_unanchor_urb(struct urb *urb);
1386extern int usb_wait_anchor_empty_timeout(struct usb_anchor *anchor,
1387 unsigned int timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388
Alan Sternfea34092007-07-30 17:06:16 -04001389/**
1390 * usb_urb_dir_in - check if an URB describes an IN transfer
1391 * @urb: URB to be checked
1392 *
1393 * Returns 1 if @urb describes an IN transfer (device-to-host),
1394 * otherwise 0.
1395 */
1396static inline int usb_urb_dir_in(struct urb *urb)
1397{
Alan Sternd617bc82007-08-02 15:04:52 -04001398 return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_IN;
Alan Sternfea34092007-07-30 17:06:16 -04001399}
1400
1401/**
1402 * usb_urb_dir_out - check if an URB describes an OUT transfer
1403 * @urb: URB to be checked
1404 *
1405 * Returns 1 if @urb describes an OUT transfer (host-to-device),
1406 * otherwise 0.
1407 */
1408static inline int usb_urb_dir_out(struct urb *urb)
1409{
1410 return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_OUT;
1411}
1412
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413void *usb_buffer_alloc (struct usb_device *dev, size_t size,
Al Viro55016f12005-10-21 03:21:58 -04001414 gfp_t mem_flags, dma_addr_t *dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415void usb_buffer_free (struct usb_device *dev, size_t size,
1416 void *addr, dma_addr_t dma);
1417
1418#if 0
1419struct urb *usb_buffer_map (struct urb *urb);
1420void usb_buffer_dmasync (struct urb *urb);
1421void usb_buffer_unmap (struct urb *urb);
1422#endif
1423
1424struct scatterlist;
Alan Stern5e60a162007-07-30 17:07:21 -04001425int usb_buffer_map_sg(const struct usb_device *dev, int is_in,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -03001426 struct scatterlist *sg, int nents);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427#if 0
Alan Stern5e60a162007-07-30 17:07:21 -04001428void usb_buffer_dmasync_sg(const struct usb_device *dev, int is_in,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -03001429 struct scatterlist *sg, int n_hw_ents);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430#endif
Alan Stern5e60a162007-07-30 17:07:21 -04001431void usb_buffer_unmap_sg(const struct usb_device *dev, int is_in,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -03001432 struct scatterlist *sg, int n_hw_ents);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433
1434/*-------------------------------------------------------------------*
1435 * SYNCHRONOUS CALL SUPPORT *
1436 *-------------------------------------------------------------------*/
1437
1438extern int usb_control_msg(struct usb_device *dev, unsigned int pipe,
1439 __u8 request, __u8 requesttype, __u16 value, __u16 index,
1440 void *data, __u16 size, int timeout);
Greg Kroah-Hartman782a7a62006-05-19 13:20:20 -07001441extern int usb_interrupt_msg(struct usb_device *usb_dev, unsigned int pipe,
1442 void *data, int len, int *actual_length, int timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443extern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,
1444 void *data, int len, int *actual_length,
1445 int timeout);
1446
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447/* wrappers around usb_control_msg() for the most common standard requests */
1448extern int usb_get_descriptor(struct usb_device *dev, unsigned char desctype,
1449 unsigned char descindex, void *buf, int size);
1450extern int usb_get_status(struct usb_device *dev,
1451 int type, int target, void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452extern int usb_string(struct usb_device *dev, int index,
1453 char *buf, size_t size);
1454
1455/* wrappers that also update important state inside usbcore */
1456extern int usb_clear_halt(struct usb_device *dev, int pipe);
1457extern int usb_reset_configuration(struct usb_device *dev);
1458extern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate);
1459
Alan Stern088dc272006-08-21 12:08:19 -04001460/* this request isn't really synchronous, but it belongs with the others */
1461extern int usb_driver_set_configuration(struct usb_device *udev, int config);
1462
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463/*
1464 * timeouts, in milliseconds, used for sending/receiving control messages
1465 * they typically complete within a few frames (msec) after they're issued
1466 * USB identifies 5 second timeouts, maybe more in a few cases, and a few
1467 * slow devices (like some MGE Ellipse UPSes) actually push that limit.
1468 */
1469#define USB_CTRL_GET_TIMEOUT 5000
1470#define USB_CTRL_SET_TIMEOUT 5000
1471
1472
1473/**
1474 * struct usb_sg_request - support for scatter/gather I/O
1475 * @status: zero indicates success, else negative errno
1476 * @bytes: counts bytes transferred.
1477 *
1478 * These requests are initialized using usb_sg_init(), and then are used
1479 * as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most
1480 * members of the request object aren't for driver access.
1481 *
1482 * The status and bytecount values are valid only after usb_sg_wait()
1483 * returns. If the status is zero, then the bytecount matches the total
1484 * from the request.
1485 *
1486 * After an error completion, drivers may need to clear a halt condition
1487 * on the endpoint.
1488 */
1489struct usb_sg_request {
1490 int status;
1491 size_t bytes;
1492
1493 /*
Martin Waitzaeec46b2005-11-13 16:08:13 -08001494 * members below are private: to usbcore,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495 * and are not provided for driver access!
1496 */
1497 spinlock_t lock;
1498
1499 struct usb_device *dev;
1500 int pipe;
1501 struct scatterlist *sg;
1502 int nents;
1503
1504 int entries;
1505 struct urb **urbs;
1506
1507 int count;
1508 struct completion complete;
1509};
1510
1511int usb_sg_init (
1512 struct usb_sg_request *io,
1513 struct usb_device *dev,
1514 unsigned pipe,
1515 unsigned period,
1516 struct scatterlist *sg,
1517 int nents,
1518 size_t length,
Al Viro55016f12005-10-21 03:21:58 -04001519 gfp_t mem_flags
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520);
1521void usb_sg_cancel (struct usb_sg_request *io);
1522void usb_sg_wait (struct usb_sg_request *io);
1523
1524
Alan Sternb724ae72005-10-24 15:36:00 -04001525/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526
1527/*
1528 * For various legacy reasons, Linux has a small cookie that's paired with
1529 * a struct usb_device to identify an endpoint queue. Queue characteristics
1530 * are defined by the endpoint's descriptor. This cookie is called a "pipe",
1531 * an unsigned int encoded as:
1532 *
1533 * - direction: bit 7 (0 = Host-to-Device [Out],
1534 * 1 = Device-to-Host [In] ...
1535 * like endpoint bEndpointAddress)
1536 * - device address: bits 8-14 ... bit positions known to uhci-hcd
1537 * - endpoint: bits 15-18 ... bit positions known to uhci-hcd
1538 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
1539 * 10 = control, 11 = bulk)
1540 *
1541 * Given the device address and endpoint descriptor, pipes are redundant.
1542 */
1543
1544/* NOTE: these are not the standard USB_ENDPOINT_XFER_* values!! */
1545/* (yet ... they're the values used by usbfs) */
1546#define PIPE_ISOCHRONOUS 0
1547#define PIPE_INTERRUPT 1
1548#define PIPE_CONTROL 2
1549#define PIPE_BULK 3
1550
1551#define usb_pipein(pipe) ((pipe) & USB_DIR_IN)
1552#define usb_pipeout(pipe) (!usb_pipein(pipe))
1553
1554#define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
1555#define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
1556
1557#define usb_pipetype(pipe) (((pipe) >> 30) & 3)
1558#define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
1559#define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
1560#define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
1561#define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
1562
1563/* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
1564#define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
1565#define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep)))
Alan Sternb724ae72005-10-24 15:36:00 -04001566#define usb_settoggle(dev, ep, out, bit) \
1567 ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \
1568 ((bit) << (ep)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569
1570
Alan Sternb724ae72005-10-24 15:36:00 -04001571static inline unsigned int __create_pipe(struct usb_device *dev,
1572 unsigned int endpoint)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573{
1574 return (dev->devnum << 8) | (endpoint << 15);
1575}
1576
1577/* Create various pipes... */
Alan Sternb724ae72005-10-24 15:36:00 -04001578#define usb_sndctrlpipe(dev,endpoint) \
1579 ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint))
1580#define usb_rcvctrlpipe(dev,endpoint) \
1581 ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1582#define usb_sndisocpipe(dev,endpoint) \
1583 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint))
1584#define usb_rcvisocpipe(dev,endpoint) \
1585 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1586#define usb_sndbulkpipe(dev,endpoint) \
1587 ((PIPE_BULK << 30) | __create_pipe(dev,endpoint))
1588#define usb_rcvbulkpipe(dev,endpoint) \
1589 ((PIPE_BULK << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1590#define usb_sndintpipe(dev,endpoint) \
1591 ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint))
1592#define usb_rcvintpipe(dev,endpoint) \
1593 ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594
1595/*-------------------------------------------------------------------------*/
1596
1597static inline __u16
1598usb_maxpacket(struct usb_device *udev, int pipe, int is_out)
1599{
1600 struct usb_host_endpoint *ep;
1601 unsigned epnum = usb_pipeendpoint(pipe);
1602
1603 if (is_out) {
1604 WARN_ON(usb_pipein(pipe));
1605 ep = udev->ep_out[epnum];
1606 } else {
1607 WARN_ON(usb_pipeout(pipe));
1608 ep = udev->ep_in[epnum];
1609 }
1610 if (!ep)
1611 return 0;
1612
1613 /* NOTE: only 0x07ff bits are for packet size... */
1614 return le16_to_cpu(ep->desc.wMaxPacketSize);
1615}
1616
Alan Sternb724ae72005-10-24 15:36:00 -04001617/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -07001619/* Events from the usb core */
1620#define USB_DEVICE_ADD 0x0001
1621#define USB_DEVICE_REMOVE 0x0002
1622#define USB_BUS_ADD 0x0003
1623#define USB_BUS_REMOVE 0x0004
1624extern void usb_register_notify(struct notifier_block *nb);
1625extern void usb_unregister_notify(struct notifier_block *nb);
1626
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627#ifdef DEBUG
Alan Sternb724ae72005-10-24 15:36:00 -04001628#define dbg(format, arg...) printk(KERN_DEBUG "%s: " format "\n" , \
1629 __FILE__ , ## arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630#else
1631#define dbg(format, arg...) do {} while (0)
1632#endif
1633
Alan Sternb724ae72005-10-24 15:36:00 -04001634#define err(format, arg...) printk(KERN_ERR "%s: " format "\n" , \
1635 __FILE__ , ## arg)
1636#define info(format, arg...) printk(KERN_INFO "%s: " format "\n" , \
1637 __FILE__ , ## arg)
1638#define warn(format, arg...) printk(KERN_WARNING "%s: " format "\n" , \
1639 __FILE__ , ## arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640
1641
1642#endif /* __KERNEL__ */
1643
1644#endif