blob: f9e4445d5b53fe00c06d9fa154059a2499d31402 [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
55 *
56 * USB requests are always queued to a given endpoint, identified by a
57 * descriptor within an active interface in a given USB configuration.
58 */
59struct usb_host_endpoint {
60 struct usb_endpoint_descriptor desc;
61 struct list_head urb_list;
62 void *hcpriv;
Greg Kroah-Hartman9bde7492006-06-14 12:14:34 -070063 struct ep_device *ep_dev; /* For sysfs info */
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
65 unsigned char *extra; /* Extra descriptors */
66 int extralen;
67};
68
69/* host-side wrapper for one interface setting's parsed descriptors */
70struct usb_host_interface {
71 struct usb_interface_descriptor desc;
72
73 /* array of desc.bNumEndpoint endpoints associated with this
74 * interface setting. these will be in no particular order.
75 */
76 struct usb_host_endpoint *endpoint;
77
78 char *string; /* iInterface string, if present */
79 unsigned char *extra; /* Extra descriptors */
80 int extralen;
81};
82
83enum usb_interface_condition {
84 USB_INTERFACE_UNBOUND = 0,
85 USB_INTERFACE_BINDING,
86 USB_INTERFACE_BOUND,
87 USB_INTERFACE_UNBINDING,
88};
89
90/**
91 * struct usb_interface - what usb device drivers talk to
92 * @altsetting: array of interface structures, one for each alternate
93 * setting that may be selected. Each one includes a set of
94 * endpoint configurations. They will be in no particular order.
95 * @num_altsetting: number of altsettings defined.
96 * @cur_altsetting: the current altsetting.
97 * @driver: the USB driver that is bound to this interface.
98 * @minor: the minor number assigned to this interface, if this
99 * interface is bound to a driver that uses the USB major number.
100 * If this interface does not use the USB major, this field should
101 * be unused. The driver should set this value in the probe()
102 * function of the driver, after it has been assigned a minor
103 * number from the USB core by calling usb_register_dev().
104 * @condition: binding state of the interface: not bound, binding
105 * (in probe()), bound to a driver, or unbinding (in disconnect())
Alan Stern4d064c02006-07-01 22:11:44 -0400106 * @is_active: flag set when the interface is bound and not suspended.
Alan Stern645daaa2006-08-30 15:47:02 -0400107 * @needs_remote_wakeup: flag set when the driver requires remote-wakeup
108 * capability during autosuspend.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 * @dev: driver model's view of this device
Greg Kroah-Hartman0873c762006-06-20 13:09:50 -0700110 * @usb_dev: if an interface is bound to the USB major, this will point
111 * to the sysfs representation for that device.
Alan Stern645daaa2006-08-30 15:47:02 -0400112 * @pm_usage_cnt: PM usage counter for this interface; autosuspend is not
113 * allowed unless the counter is 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 *
115 * USB device drivers attach to interfaces on a physical device. Each
116 * interface encapsulates a single high level function, such as feeding
117 * an audio stream to a speaker or reporting a change in a volume control.
118 * Many USB devices only have one interface. The protocol used to talk to
119 * an interface's endpoints can be defined in a usb "class" specification,
120 * or by a product's vendor. The (default) control endpoint is part of
121 * every interface, but is never listed among the interface's descriptors.
122 *
123 * The driver that is bound to the interface can use standard driver model
124 * calls such as dev_get_drvdata() on the dev member of this structure.
125 *
126 * Each interface may have alternate settings. The initial configuration
127 * of a device sets altsetting 0, but the device driver can change
128 * that setting using usb_set_interface(). Alternate settings are often
129 * used to control the the use of periodic endpoints, such as by having
130 * different endpoints use different amounts of reserved USB bandwidth.
131 * All standards-conformant USB devices that use isochronous endpoints
132 * will use them in non-default settings.
133 *
134 * The USB specification says that alternate setting numbers must run from
135 * 0 to one less than the total number of alternate settings. But some
136 * devices manage to mess this up, and the structures aren't necessarily
137 * stored in numerical order anyhow. Use usb_altnum_to_altsetting() to
138 * look up an alternate setting in the altsetting array based on its number.
139 */
140struct usb_interface {
141 /* array of alternate settings for this interface,
142 * stored in no particular order */
143 struct usb_host_interface *altsetting;
144
145 struct usb_host_interface *cur_altsetting; /* the currently
146 * active alternate setting */
147 unsigned num_altsetting; /* number of alternate settings */
148
Alan Sternb724ae72005-10-24 15:36:00 -0400149 int minor; /* minor number this interface is
150 * bound to */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 enum usb_interface_condition condition; /* state of binding */
Alan Stern4d064c02006-07-01 22:11:44 -0400152 unsigned is_active:1; /* the interface is not suspended */
Alan Stern645daaa2006-08-30 15:47:02 -0400153 unsigned needs_remote_wakeup:1; /* driver requires remote wakeup */
Alan Stern4d064c02006-07-01 22:11:44 -0400154
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 struct device dev; /* interface specific device info */
Greg Kroah-Hartman0873c762006-06-20 13:09:50 -0700156 struct device *usb_dev; /* pointer to the usb class's device, if any */
Alan Stern645daaa2006-08-30 15:47:02 -0400157 int pm_usage_cnt; /* usage counter for autosuspend */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158};
159#define to_usb_interface(d) container_of(d, struct usb_interface, dev)
160#define interface_to_usbdev(intf) \
161 container_of(intf->dev.parent, struct usb_device, dev)
162
163static inline void *usb_get_intfdata (struct usb_interface *intf)
164{
165 return dev_get_drvdata (&intf->dev);
166}
167
168static inline void usb_set_intfdata (struct usb_interface *intf, void *data)
169{
170 dev_set_drvdata(&intf->dev, data);
171}
172
173struct usb_interface *usb_get_intf(struct usb_interface *intf);
174void usb_put_intf(struct usb_interface *intf);
175
176/* this maximum is arbitrary */
177#define USB_MAXINTERFACES 32
178
179/**
180 * struct usb_interface_cache - long-term representation of a device interface
181 * @num_altsetting: number of altsettings defined.
182 * @ref: reference counter.
183 * @altsetting: variable-length array of interface structures, one for
184 * each alternate setting that may be selected. Each one includes a
185 * set of endpoint configurations. They will be in no particular order.
186 *
187 * These structures persist for the lifetime of a usb_device, unlike
188 * struct usb_interface (which persists only as long as its configuration
189 * is installed). The altsetting arrays can be accessed through these
190 * structures at any time, permitting comparison of configurations and
191 * providing support for the /proc/bus/usb/devices pseudo-file.
192 */
193struct usb_interface_cache {
194 unsigned num_altsetting; /* number of alternate settings */
195 struct kref ref; /* reference counter */
196
197 /* variable-length array of alternate settings for this interface,
198 * stored in no particular order */
199 struct usb_host_interface altsetting[0];
200};
201#define ref_to_usb_interface_cache(r) \
202 container_of(r, struct usb_interface_cache, ref)
203#define altsetting_to_usb_interface_cache(a) \
204 container_of(a, struct usb_interface_cache, altsetting[0])
205
206/**
207 * struct usb_host_config - representation of a device's configuration
208 * @desc: the device's configuration descriptor.
209 * @string: pointer to the cached version of the iConfiguration string, if
210 * present for this configuration.
211 * @interface: array of pointers to usb_interface structures, one for each
212 * interface in the configuration. The number of interfaces is stored
213 * in desc.bNumInterfaces. These pointers are valid only while the
214 * the configuration is active.
215 * @intf_cache: array of pointers to usb_interface_cache structures, one
216 * for each interface in the configuration. These structures exist
217 * for the entire life of the device.
218 * @extra: pointer to buffer containing all extra descriptors associated
219 * with this configuration (those preceding the first interface
220 * descriptor).
221 * @extralen: length of the extra descriptors buffer.
222 *
223 * USB devices may have multiple configurations, but only one can be active
224 * at any time. Each encapsulates a different operational environment;
225 * for example, a dual-speed device would have separate configurations for
226 * full-speed and high-speed operation. The number of configurations
227 * available is stored in the device descriptor as bNumConfigurations.
228 *
229 * A configuration can contain multiple interfaces. Each corresponds to
230 * a different function of the USB device, and all are available whenever
231 * the configuration is active. The USB standard says that interfaces
232 * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot
233 * of devices get this wrong. In addition, the interface array is not
234 * guaranteed to be sorted in numerical order. Use usb_ifnum_to_if() to
235 * look up an interface entry based on its number.
236 *
237 * Device drivers should not attempt to activate configurations. The choice
238 * of which configuration to install is a policy decision based on such
239 * considerations as available power, functionality provided, and the user's
Kay Sievers312c0042005-11-16 09:00:00 +0100240 * desires (expressed through userspace tools). However, drivers can call
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 * usb_reset_configuration() to reinitialize the current configuration and
242 * all its interfaces.
243 */
244struct usb_host_config {
245 struct usb_config_descriptor desc;
246
Alan Stern4f62efe2005-10-24 16:24:14 -0400247 char *string; /* iConfiguration string, if present */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 /* the interfaces associated with this configuration,
249 * stored in no particular order */
250 struct usb_interface *interface[USB_MAXINTERFACES];
251
252 /* Interface information available even when this is not the
253 * active configuration */
254 struct usb_interface_cache *intf_cache[USB_MAXINTERFACES];
255
256 unsigned char *extra; /* Extra descriptors */
257 int extralen;
258};
259
260int __usb_get_extra_descriptor(char *buffer, unsigned size,
261 unsigned char type, void **ptr);
262#define usb_get_extra_descriptor(ifpoint,type,ptr)\
263 __usb_get_extra_descriptor((ifpoint)->extra,(ifpoint)->extralen,\
264 type,(void**)ptr)
265
Alan Sternb724ae72005-10-24 15:36:00 -0400266/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268/* USB device number allocation bitmap */
269struct usb_devmap {
270 unsigned long devicemap[128 / (8*sizeof(unsigned long))];
271};
272
273/*
274 * Allocated per bus (tree of devices) we have:
275 */
276struct usb_bus {
277 struct device *controller; /* host/master side hardware */
278 int busnum; /* Bus number (in order of reg) */
279 char *bus_name; /* stable id (PCI slot_name etc) */
Alan Sterndd990f12006-08-30 11:29:56 -0400280 u8 uses_dma; /* Does the host controller use DMA? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 u8 otg_port; /* 0, or number of OTG/HNP port */
282 unsigned is_b_host:1; /* true during some HNP roleswitches */
283 unsigned b_hnp_enable:1; /* OTG: did A-Host enable HNP? */
284
Alan Sternb724ae72005-10-24 15:36:00 -0400285 int devnum_next; /* Next open device number in
286 * round-robin allocation */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287
288 struct usb_devmap devmap; /* device address allocation map */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 struct usb_device *root_hub; /* Root hub */
290 struct list_head bus_list; /* list of busses */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
292 int bandwidth_allocated; /* on this bus: how much of the time
293 * reserved for periodic (intr/iso)
294 * requests is used, on average?
295 * Units: microseconds/frame.
296 * Limits: Full/low speed reserve 90%,
297 * while high speed reserves 80%.
298 */
299 int bandwidth_int_reqs; /* number of Interrupt requests */
300 int bandwidth_isoc_reqs; /* number of Isoc. requests */
301
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100302#ifdef CONFIG_USB_DEVICEFS
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 struct dentry *usbfs_dentry; /* usbfs dentry entry for the bus */
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100304#endif
gregkh@suse.de8561b102005-03-15 15:10:13 -0800305 struct class_device *class_dev; /* class device for this bus */
Alan Sternb724ae72005-10-24 15:36:00 -0400306
Adrian Bunk4749f322005-06-23 11:36:56 +0200307#if defined(CONFIG_USB_MON)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 struct mon_bus *mon_bus; /* non-null when associated */
309 int monitored; /* non-zero when monitored */
310#endif
311};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312
Alan Sternb724ae72005-10-24 15:36:00 -0400313/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314
315/* This is arbitrary.
316 * From USB 2.0 spec Table 11-13, offset 7, a hub can
317 * have up to 255 ports. The most yet reported is 10.
inaky@linux.intel.com43705252006-10-11 20:05:58 -0700318 *
319 * Current Wireless USB host hardware (Intel i1480 for example) allows
320 * up to 22 devices to connect. Upcoming hardware might raise that
321 * limit. Because the arrays need to add a bit for hub status data, we
322 * do 31, so plus one evens out to four bytes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 */
inaky@linux.intel.com43705252006-10-11 20:05:58 -0700324#define USB_MAXCHILDREN (31)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325
326struct usb_tt;
327
328/*
329 * struct usb_device - kernel's representation of a USB device
330 *
331 * FIXME: Write the kerneldoc!
332 *
333 * Usbcore drivers should not set usbdev->state directly. Instead use
334 * usb_set_device_state().
335 */
336struct usb_device {
337 int devnum; /* Address on USB bus */
338 char devpath [16]; /* Use in messages: /port/port/... */
339 enum usb_device_state state; /* configured, not attached, etc */
340 enum usb_device_speed speed; /* high/full/low (or error) */
341
342 struct usb_tt *tt; /* low/full speed dev, highspeed hub */
343 int ttport; /* device port on that tt hub */
344
Alan Sternb724ae72005-10-24 15:36:00 -0400345 unsigned int toggle[2]; /* one bit for each endpoint
346 * ([0] = IN, [1] = OUT) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347
348 struct usb_device *parent; /* our hub, unless we're the root */
349 struct usb_bus *bus; /* Bus we're part of */
350 struct usb_host_endpoint ep0;
351
352 struct device dev; /* Generic device interface */
353
354 struct usb_device_descriptor descriptor;/* Descriptor */
355 struct usb_host_config *config; /* All of the configs */
356
357 struct usb_host_config *actconfig;/* the active configuration */
358 struct usb_host_endpoint *ep_in[16];
359 struct usb_host_endpoint *ep_out[16];
360
361 char **rawdescriptors; /* Raw descriptors for each config */
362
Alan Stern55c52712005-11-23 12:03:12 -0500363 unsigned short bus_mA; /* Current available from the bus */
Alan Stern12c3da32005-11-23 12:09:52 -0500364 u8 portnum; /* Parent port number (origin 1) */
Alan Sternb6956ff2006-08-30 15:46:48 -0400365 u8 level; /* Number of USB hub ancestors */
Alan Stern55c52712005-11-23 12:03:12 -0500366
Alan Sternee49fb52006-11-22 16:55:54 -0500367 unsigned discon_suspended:1; /* Disconnected while suspended */
Alan Sternce361582006-11-20 11:12:22 -0500368 unsigned have_langid:1; /* whether string_langid is valid */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 int string_langid; /* language ID for strings */
370
Alan Stern4f62efe2005-10-24 16:24:14 -0400371 /* static strings from the device */
372 char *product; /* iProduct string, if present */
373 char *manufacturer; /* iManufacturer string, if present */
374 char *serial; /* iSerialNumber string, if present */
375
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 struct list_head filelist;
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100377#ifdef CONFIG_USB_DEVICE_CLASS
378 struct device *usb_classdev;
379#endif
380#ifdef CONFIG_USB_DEVICEFS
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 struct dentry *usbfs_dentry; /* usbfs dentry entry for the device */
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100382#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 /*
384 * Child devices - these can be either new devices
385 * (if this is a hub device), or different instances
386 * of this same device.
387 *
388 * Each instance needs its own set of data structures.
389 */
390
391 int maxchild; /* Number of ports if hub */
392 struct usb_device *children[USB_MAXCHILDREN];
Alan Stern645daaa2006-08-30 15:47:02 -0400393
Alan Sterne0318eb2006-09-26 14:50:20 -0400394 int pm_usage_cnt; /* usage counter for autosuspend */
Oliver Neukum7ceec1f2007-01-26 14:26:21 +0100395 u32 quirks; /* quirks of the whole device */
Alan Sternb5e795f2007-02-20 15:00:53 -0500396
Alan Stern645daaa2006-08-30 15:47:02 -0400397#ifdef CONFIG_PM
David Howellsc4028952006-11-22 14:57:56 +0000398 struct delayed_work autosuspend; /* for delayed autosuspends */
Alan Stern645daaa2006-08-30 15:47:02 -0400399 struct mutex pm_mutex; /* protects PM operations */
Alan Stern645daaa2006-08-30 15:47:02 -0400400
Alan Sterneaafbc32007-03-13 16:39:15 -0400401 int autosuspend_delay; /* in jiffies */
Alan Sternb5e795f2007-02-20 15:00:53 -0500402
Alan Stern645daaa2006-08-30 15:47:02 -0400403 unsigned auto_pm:1; /* autosuspend/resume in progress */
404 unsigned do_remote_wakeup:1; /* remote wakeup should be enabled */
Alan Stern2add5222007-03-20 14:59:39 -0400405 unsigned autosuspend_disabled:1; /* autosuspend and autoresume */
406 unsigned autoresume_disabled:1; /* disabled by the user */
Alan Stern645daaa2006-08-30 15:47:02 -0400407#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408};
409#define to_usb_device(d) container_of(d, struct usb_device, dev)
410
411extern struct usb_device *usb_get_dev(struct usb_device *dev);
412extern void usb_put_dev(struct usb_device *dev);
413
Alan Stern9ad3d6c2005-11-17 17:10:32 -0500414/* USB device locking */
415#define usb_lock_device(udev) down(&(udev)->dev.sem)
416#define usb_unlock_device(udev) up(&(udev)->dev.sem)
417#define usb_trylock_device(udev) down_trylock(&(udev)->dev.sem)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418extern int usb_lock_device_for_reset(struct usb_device *udev,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300419 const struct usb_interface *iface);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420
421/* USB port reset for device reinitialization */
422extern int usb_reset_device(struct usb_device *dev);
Alan Stern79efa092006-06-01 13:33:42 -0400423extern int usb_reset_composite_device(struct usb_device *dev,
424 struct usb_interface *iface);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425
426extern struct usb_device *usb_find_device(u16 vendor_id, u16 product_id);
427
Alan Stern645daaa2006-08-30 15:47:02 -0400428/* USB autosuspend and autoresume */
429#ifdef CONFIG_USB_SUSPEND
Alan Stern692a1862006-10-30 17:07:51 -0500430extern int usb_autopm_set_interface(struct usb_interface *intf);
Alan Stern645daaa2006-08-30 15:47:02 -0400431extern int usb_autopm_get_interface(struct usb_interface *intf);
432extern void usb_autopm_put_interface(struct usb_interface *intf);
433
Alan Stern692a1862006-10-30 17:07:51 -0500434static inline void usb_autopm_enable(struct usb_interface *intf)
435{
436 intf->pm_usage_cnt = 0;
437 usb_autopm_set_interface(intf);
438}
Alan Stern645daaa2006-08-30 15:47:02 -0400439
Alan Stern692a1862006-10-30 17:07:51 -0500440static inline void usb_autopm_disable(struct usb_interface *intf)
441{
442 intf->pm_usage_cnt = 1;
443 usb_autopm_set_interface(intf);
444}
445
446#else
447
448static inline int usb_autopm_set_interface(struct usb_interface *intf)
449{ return 0; }
450
451static inline int usb_autopm_get_interface(struct usb_interface *intf)
452{ return 0; }
453
454static inline void usb_autopm_put_interface(struct usb_interface *intf)
455{ }
456static inline void usb_autopm_enable(struct usb_interface *intf)
457{ }
458static inline void usb_autopm_disable(struct usb_interface *intf)
459{ }
460#endif
Alan Stern645daaa2006-08-30 15:47:02 -0400461
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462/*-------------------------------------------------------------------------*/
463
464/* for drivers using iso endpoints */
465extern int usb_get_current_frame_number (struct usb_device *usb_dev);
466
467/* used these for multi-interface device registration */
468extern int usb_driver_claim_interface(struct usb_driver *driver,
469 struct usb_interface *iface, void* priv);
470
471/**
472 * usb_interface_claimed - returns true iff an interface is claimed
473 * @iface: the interface being checked
474 *
475 * Returns true (nonzero) iff the interface is claimed, else false (zero).
476 * Callers must own the driver model's usb bus readlock. So driver
477 * probe() entries don't need extra locking, but other call contexts
478 * may need to explicitly claim that lock.
479 *
480 */
481static inline int usb_interface_claimed(struct usb_interface *iface) {
482 return (iface->dev.driver != NULL);
483}
484
485extern void usb_driver_release_interface(struct usb_driver *driver,
486 struct usb_interface *iface);
487const struct usb_device_id *usb_match_id(struct usb_interface *interface,
488 const struct usb_device_id *id);
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +0100489extern int usb_match_one_id(struct usb_interface *interface,
490 const struct usb_device_id *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491
492extern struct usb_interface *usb_find_interface(struct usb_driver *drv,
493 int minor);
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300494extern struct usb_interface *usb_ifnum_to_if(const struct usb_device *dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 unsigned ifnum);
496extern struct usb_host_interface *usb_altnum_to_altsetting(
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300497 const struct usb_interface *intf, unsigned int altnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498
499
500/**
501 * usb_make_path - returns stable device path in the usb tree
502 * @dev: the device whose path is being constructed
503 * @buf: where to put the string
504 * @size: how big is "buf"?
505 *
506 * Returns length of the string (> 0) or negative if size was too small.
507 *
508 * This identifier is intended to be "stable", reflecting physical paths in
509 * hardware such as physical bus addresses for host controllers or ports on
510 * USB hubs. That makes it stay the same until systems are physically
511 * reconfigured, by re-cabling a tree of USB devices or by moving USB host
512 * controllers. Adding and removing devices, including virtual root hubs
513 * in host controller driver modules, does not change these path identifers;
514 * neither does rebooting or re-enumerating. These are more useful identifiers
515 * than changeable ("unstable") ones like bus numbers or device addresses.
516 *
517 * With a partial exception for devices connected to USB 2.0 root hubs, these
518 * identifiers are also predictable. So long as the device tree isn't changed,
519 * plugging any USB device into a given hub port always gives it the same path.
520 * Because of the use of "companion" controllers, devices connected to ports on
521 * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are
522 * high speed, and a different one if they are full or low speed.
523 */
Alan Sternb724ae72005-10-24 15:36:00 -0400524static inline int usb_make_path (struct usb_device *dev, char *buf,
525 size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526{
527 int actual;
Alan Sternb724ae72005-10-24 15:36:00 -0400528 actual = snprintf (buf, size, "usb-%s-%s", dev->bus->bus_name,
529 dev->devpath);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 return (actual >= (int)size) ? -1 : actual;
531}
532
533/*-------------------------------------------------------------------------*/
534
Luiz Fernando N. Capitulino0c1ac4f2006-10-30 14:53:03 -0300535/**
536 * usb_endpoint_dir_in - check if the endpoint has IN direction
537 * @epd: endpoint to be checked
538 *
539 * Returns true if the endpoint is of type IN, otherwise it returns false.
540 */
541static inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor *epd)
542{
543 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN);
544}
545
546/**
547 * usb_endpoint_dir_out - check if the endpoint has OUT direction
548 * @epd: endpoint to be checked
549 *
550 * Returns true if the endpoint is of type OUT, otherwise it returns false.
551 */
552static inline int usb_endpoint_dir_out(const struct usb_endpoint_descriptor *epd)
553{
554 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT);
555}
556
557/**
558 * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type
559 * @epd: endpoint to be checked
560 *
561 * Returns true if the endpoint is of type bulk, otherwise it returns false.
562 */
563static inline int usb_endpoint_xfer_bulk(const struct usb_endpoint_descriptor *epd)
564{
565 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
566 USB_ENDPOINT_XFER_BULK);
567}
568
569/**
Sarah Baileya8ef36b2006-12-23 23:14:58 -0800570 * usb_endpoint_xfer_control - check if the endpoint has control transfer type
571 * @epd: endpoint to be checked
572 *
573 * Returns true if the endpoint is of type control, otherwise it returns false.
574 */
575static inline int usb_endpoint_xfer_control(const struct usb_endpoint_descriptor *epd)
576{
577 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
578 USB_ENDPOINT_XFER_CONTROL);
579}
580
581/**
Luiz Fernando N. Capitulino0c1ac4f2006-10-30 14:53:03 -0300582 * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type
583 * @epd: endpoint to be checked
584 *
585 * Returns true if the endpoint is of type interrupt, otherwise it returns
586 * false.
587 */
588static inline int usb_endpoint_xfer_int(const struct usb_endpoint_descriptor *epd)
589{
590 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
591 USB_ENDPOINT_XFER_INT);
592}
593
594/**
595 * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type
596 * @epd: endpoint to be checked
597 *
598 * Returns true if the endpoint is of type isochronous, otherwise it returns
599 * false.
600 */
601static inline int usb_endpoint_xfer_isoc(const struct usb_endpoint_descriptor *epd)
602{
603 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
604 USB_ENDPOINT_XFER_ISOC);
605}
606
607/**
608 * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN
609 * @epd: endpoint to be checked
610 *
611 * Returns true if the endpoint has bulk transfer type and IN direction,
612 * otherwise it returns false.
613 */
614static inline int usb_endpoint_is_bulk_in(const struct usb_endpoint_descriptor *epd)
615{
616 return (usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_in(epd));
617}
618
619/**
620 * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT
621 * @epd: endpoint to be checked
622 *
623 * Returns true if the endpoint has bulk transfer type and OUT direction,
624 * otherwise it returns false.
625 */
626static inline int usb_endpoint_is_bulk_out(const struct usb_endpoint_descriptor *epd)
627{
628 return (usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_out(epd));
629}
630
631/**
632 * usb_endpoint_is_int_in - check if the endpoint is interrupt IN
633 * @epd: endpoint to be checked
634 *
635 * Returns true if the endpoint has interrupt transfer type and IN direction,
636 * otherwise it returns false.
637 */
638static inline int usb_endpoint_is_int_in(const struct usb_endpoint_descriptor *epd)
639{
640 return (usb_endpoint_xfer_int(epd) && usb_endpoint_dir_in(epd));
641}
642
643/**
644 * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT
645 * @epd: endpoint to be checked
646 *
647 * Returns true if the endpoint has interrupt transfer type and OUT direction,
648 * otherwise it returns false.
649 */
650static inline int usb_endpoint_is_int_out(const struct usb_endpoint_descriptor *epd)
651{
652 return (usb_endpoint_xfer_int(epd) && usb_endpoint_dir_out(epd));
653}
654
655/**
656 * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN
657 * @epd: endpoint to be checked
658 *
659 * Returns true if the endpoint has isochronous transfer type and IN direction,
660 * otherwise it returns false.
661 */
662static inline int usb_endpoint_is_isoc_in(const struct usb_endpoint_descriptor *epd)
663{
664 return (usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_in(epd));
665}
666
667/**
668 * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT
669 * @epd: endpoint to be checked
670 *
671 * Returns true if the endpoint has isochronous transfer type and OUT direction,
672 * otherwise it returns false.
673 */
674static inline int usb_endpoint_is_isoc_out(const struct usb_endpoint_descriptor *epd)
675{
676 return (usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_out(epd));
677}
Luiz Fernando N. Capitulinob7cfaaa2006-09-27 11:58:53 -0700678
679/*-------------------------------------------------------------------------*/
680
Alan Sternb724ae72005-10-24 15:36:00 -0400681#define USB_DEVICE_ID_MATCH_DEVICE \
682 (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
683#define USB_DEVICE_ID_MATCH_DEV_RANGE \
684 (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI)
685#define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
686 (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687#define USB_DEVICE_ID_MATCH_DEV_INFO \
Alan Sternb724ae72005-10-24 15:36:00 -0400688 (USB_DEVICE_ID_MATCH_DEV_CLASS | \
689 USB_DEVICE_ID_MATCH_DEV_SUBCLASS | \
690 USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691#define USB_DEVICE_ID_MATCH_INT_INFO \
Alan Sternb724ae72005-10-24 15:36:00 -0400692 (USB_DEVICE_ID_MATCH_INT_CLASS | \
693 USB_DEVICE_ID_MATCH_INT_SUBCLASS | \
694 USB_DEVICE_ID_MATCH_INT_PROTOCOL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695
696/**
697 * USB_DEVICE - macro used to describe a specific usb device
698 * @vend: the 16 bit USB Vendor ID
699 * @prod: the 16 bit USB Product ID
700 *
701 * This macro is used to create a struct usb_device_id that matches a
702 * specific device.
703 */
704#define USB_DEVICE(vend,prod) \
Alan Sternb724ae72005-10-24 15:36:00 -0400705 .match_flags = USB_DEVICE_ID_MATCH_DEVICE, .idVendor = (vend), \
706 .idProduct = (prod)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707/**
Alan Sternb724ae72005-10-24 15:36:00 -0400708 * USB_DEVICE_VER - macro used to describe a specific usb device with a
709 * version range
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710 * @vend: the 16 bit USB Vendor ID
711 * @prod: the 16 bit USB Product ID
712 * @lo: the bcdDevice_lo value
713 * @hi: the bcdDevice_hi value
714 *
715 * This macro is used to create a struct usb_device_id that matches a
716 * specific device, with a version range.
717 */
718#define USB_DEVICE_VER(vend,prod,lo,hi) \
Alan Sternb724ae72005-10-24 15:36:00 -0400719 .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, \
720 .idVendor = (vend), .idProduct = (prod), \
721 .bcdDevice_lo = (lo), .bcdDevice_hi = (hi)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722
723/**
724 * USB_DEVICE_INFO - macro used to describe a class of usb devices
725 * @cl: bDeviceClass value
726 * @sc: bDeviceSubClass value
727 * @pr: bDeviceProtocol value
728 *
729 * This macro is used to create a struct usb_device_id that matches a
730 * specific class of devices.
731 */
732#define USB_DEVICE_INFO(cl,sc,pr) \
Alan Sternb724ae72005-10-24 15:36:00 -0400733 .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, .bDeviceClass = (cl), \
734 .bDeviceSubClass = (sc), .bDeviceProtocol = (pr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735
736/**
737 * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces
738 * @cl: bInterfaceClass value
739 * @sc: bInterfaceSubClass value
740 * @pr: bInterfaceProtocol value
741 *
742 * This macro is used to create a struct usb_device_id that matches a
743 * specific class of interfaces.
744 */
745#define USB_INTERFACE_INFO(cl,sc,pr) \
Alan Sternb724ae72005-10-24 15:36:00 -0400746 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, .bInterfaceClass = (cl), \
747 .bInterfaceSubClass = (sc), .bInterfaceProtocol = (pr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748
Alan Sternb724ae72005-10-24 15:36:00 -0400749/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +0100751/* Stuff for dynamic usb ids */
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800752struct usb_dynids {
753 spinlock_t lock;
754 struct list_head list;
755};
756
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +0100757struct usb_dynid {
758 struct list_head node;
759 struct usb_device_id id;
760};
761
762extern ssize_t usb_store_new_id(struct usb_dynids *dynids,
763 struct device_driver *driver,
764 const char *buf, size_t count);
765
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766/**
Alan Stern8bb54ab2006-07-01 22:08:49 -0400767 * struct usbdrv_wrap - wrapper for driver-model structure
768 * @driver: The driver-model core driver structure.
769 * @for_devices: Non-zero for device drivers, 0 for interface drivers.
770 */
771struct usbdrv_wrap {
772 struct device_driver driver;
773 int for_devices;
774};
775
776/**
777 * struct usb_driver - identifies USB interface driver to usbcore
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 * @name: The driver name should be unique among USB drivers,
779 * and should normally be the same as the module name.
780 * @probe: Called to see if the driver is willing to manage a particular
781 * interface on a device. If it is, probe returns zero and uses
782 * dev_set_drvdata() to associate driver-specific data with the
783 * interface. It may also use usb_set_interface() to specify the
784 * appropriate altsetting. If unwilling to manage the interface,
785 * return a negative errno value.
786 * @disconnect: Called when the interface is no longer accessible, usually
787 * because its device has been (or is being) disconnected or the
788 * driver module is being unloaded.
789 * @ioctl: Used for drivers that want to talk to userspace through
790 * the "usbfs" filesystem. This lets devices provide ways to
791 * expose information to user space regardless of where they
792 * do (or don't) show up otherwise in the filesystem.
793 * @suspend: Called when the device is going to be suspended by the system.
794 * @resume: Called when the device is being resumed by the system.
Alan Stern79efa092006-06-01 13:33:42 -0400795 * @pre_reset: Called by usb_reset_composite_device() when the device
796 * is about to be reset.
797 * @post_reset: Called by usb_reset_composite_device() after the device
798 * has been reset.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 * @id_table: USB drivers use ID table to support hotplugging.
800 * Export this with MODULE_DEVICE_TABLE(usb,...). This must be set
801 * or your driver's probe function will never get called.
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800802 * @dynids: used internally to hold the list of dynamically added device
803 * ids for this driver.
Alan Stern8bb54ab2006-07-01 22:08:49 -0400804 * @drvwrap: Driver-model core structure wrapper.
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -0800805 * @no_dynamic_id: if set to 1, the USB core will not allow dynamic ids to be
806 * added to this driver by preventing the sysfs file from being created.
Alan Stern645daaa2006-08-30 15:47:02 -0400807 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
808 * for interfaces bound to this driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 *
Alan Stern8bb54ab2006-07-01 22:08:49 -0400810 * USB interface drivers must provide a name, probe() and disconnect()
811 * methods, and an id_table. Other driver fields are optional.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 *
813 * The id_table is used in hotplugging. It holds a set of descriptors,
814 * and specialized data may be associated with each entry. That table
815 * is used by both user and kernel mode hotplugging support.
816 *
817 * The probe() and disconnect() methods are called in a context where
818 * they can sleep, but they should avoid abusing the privilege. Most
819 * work to connect to a device should be done when the device is opened,
820 * and undone at the last close. The disconnect code needs to address
821 * concurrency issues with respect to open() and close() methods, as
822 * well as forcing all pending I/O requests to complete (by unlinking
823 * them as necessary, and blocking until the unlinks complete).
824 */
825struct usb_driver {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 const char *name;
827
828 int (*probe) (struct usb_interface *intf,
829 const struct usb_device_id *id);
830
831 void (*disconnect) (struct usb_interface *intf);
832
Alan Sternb724ae72005-10-24 15:36:00 -0400833 int (*ioctl) (struct usb_interface *intf, unsigned int code,
834 void *buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835
David Brownell27d72e82005-04-18 17:39:22 -0700836 int (*suspend) (struct usb_interface *intf, pm_message_t message);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 int (*resume) (struct usb_interface *intf);
838
Alan Stern79efa092006-06-01 13:33:42 -0400839 void (*pre_reset) (struct usb_interface *intf);
840 void (*post_reset) (struct usb_interface *intf);
841
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842 const struct usb_device_id *id_table;
843
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800844 struct usb_dynids dynids;
Alan Stern8bb54ab2006-07-01 22:08:49 -0400845 struct usbdrv_wrap drvwrap;
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -0800846 unsigned int no_dynamic_id:1;
Alan Stern645daaa2006-08-30 15:47:02 -0400847 unsigned int supports_autosuspend:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848};
Alan Stern8bb54ab2006-07-01 22:08:49 -0400849#define to_usb_driver(d) container_of(d, struct usb_driver, drvwrap.driver)
850
851/**
852 * struct usb_device_driver - identifies USB device driver to usbcore
853 * @name: The driver name should be unique among USB drivers,
854 * and should normally be the same as the module name.
855 * @probe: Called to see if the driver is willing to manage a particular
856 * device. If it is, probe returns zero and uses dev_set_drvdata()
857 * to associate driver-specific data with the device. If unwilling
858 * to manage the device, return a negative errno value.
859 * @disconnect: Called when the device is no longer accessible, usually
860 * because it has been (or is being) disconnected or the driver's
861 * module is being unloaded.
862 * @suspend: Called when the device is going to be suspended by the system.
863 * @resume: Called when the device is being resumed by the system.
864 * @drvwrap: Driver-model core structure wrapper.
Alan Stern645daaa2006-08-30 15:47:02 -0400865 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
866 * for devices bound to this driver.
Alan Stern8bb54ab2006-07-01 22:08:49 -0400867 *
868 * USB drivers must provide all the fields listed above except drvwrap.
869 */
870struct usb_device_driver {
871 const char *name;
872
873 int (*probe) (struct usb_device *udev);
874 void (*disconnect) (struct usb_device *udev);
875
876 int (*suspend) (struct usb_device *udev, pm_message_t message);
877 int (*resume) (struct usb_device *udev);
878 struct usbdrv_wrap drvwrap;
Alan Stern645daaa2006-08-30 15:47:02 -0400879 unsigned int supports_autosuspend:1;
Alan Stern8bb54ab2006-07-01 22:08:49 -0400880};
881#define to_usb_device_driver(d) container_of(d, struct usb_device_driver, \
882 drvwrap.driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883
884extern struct bus_type usb_bus_type;
885
886/**
887 * struct usb_class_driver - identifies a USB driver that wants to use the USB major number
Greg Kroah-Hartmand6e5bcf2005-06-20 21:15:16 -0700888 * @name: the usb class device name for this driver. Will show up in sysfs.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 * @fops: pointer to the struct file_operations of this driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890 * @minor_base: the start of the minor range for this driver.
891 *
892 * This structure is used for the usb_register_dev() and
893 * usb_unregister_dev() functions, to consolidate a number of the
894 * parameters used for them.
895 */
896struct usb_class_driver {
897 char *name;
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800898 const struct file_operations *fops;
Greg Kroah-Hartmand6e5bcf2005-06-20 21:15:16 -0700899 int minor_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900};
901
902/*
903 * use these in module_init()/module_exit()
904 * and don't forget MODULE_DEVICE_TABLE(usb, ...)
905 */
Greg Kroah-Hartman80f745f2007-01-15 11:50:02 -0800906extern int usb_register_driver(struct usb_driver *, struct module *,
907 const char *);
Greg Kroah-Hartman2143acc2005-11-21 14:53:03 -0800908static inline int usb_register(struct usb_driver *driver)
909{
Greg Kroah-Hartman80f745f2007-01-15 11:50:02 -0800910 return usb_register_driver(driver, THIS_MODULE, KBUILD_MODNAME);
Greg Kroah-Hartman2143acc2005-11-21 14:53:03 -0800911}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912extern void usb_deregister(struct usb_driver *);
913
Alan Stern8bb54ab2006-07-01 22:08:49 -0400914extern int usb_register_device_driver(struct usb_device_driver *,
915 struct module *);
916extern void usb_deregister_device_driver(struct usb_device_driver *);
917
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918extern int usb_register_dev(struct usb_interface *intf,
919 struct usb_class_driver *class_driver);
920extern void usb_deregister_dev(struct usb_interface *intf,
921 struct usb_class_driver *class_driver);
922
923extern int usb_disabled(void);
924
Alan Sternb724ae72005-10-24 15:36:00 -0400925/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926
927/*
928 * URB support, for asynchronous request completions
929 */
930
931/*
932 * urb->transfer_flags:
933 */
934#define URB_SHORT_NOT_OK 0x0001 /* report short reads as errors */
Alan Sternb724ae72005-10-24 15:36:00 -0400935#define URB_ISO_ASAP 0x0002 /* iso-only, urb->start_frame
936 * ignored */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937#define URB_NO_TRANSFER_DMA_MAP 0x0004 /* urb->transfer_dma valid on submit */
938#define URB_NO_SETUP_DMA_MAP 0x0008 /* urb->setup_dma valid on submit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939#define URB_NO_FSBR 0x0020 /* UHCI-specific */
Alan Sternb724ae72005-10-24 15:36:00 -0400940#define URB_ZERO_PACKET 0x0040 /* Finish bulk OUT with short packet */
941#define URB_NO_INTERRUPT 0x0080 /* HINT: no non-error interrupt
942 * needed */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943
944struct usb_iso_packet_descriptor {
945 unsigned int offset;
946 unsigned int length; /* expected length */
947 unsigned int actual_length;
Pete Zaitcevd1bbb602007-02-11 13:56:13 -0800948 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949};
950
951struct urb;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952
David Howells7d12e782006-10-05 14:55:46 +0100953typedef void (*usb_complete_t)(struct urb *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954
955/**
956 * struct urb - USB Request Block
957 * @urb_list: For use by current owner of the URB.
958 * @pipe: Holds endpoint number, direction, type, and more.
959 * Create these values with the eight macros available;
960 * usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl"
961 * (control), "bulk", "int" (interrupt), or "iso" (isochronous).
962 * For example usb_sndbulkpipe() or usb_rcvintpipe(). Endpoint
963 * numbers range from zero to fifteen. Note that "in" endpoint two
964 * is a different endpoint (and pipe) from "out" endpoint two.
965 * The current configuration controls the existence, type, and
966 * maximum packet size of any given endpoint.
967 * @dev: Identifies the USB device to perform the request.
968 * @status: This is read in non-iso completion functions to get the
969 * status of the particular request. ISO requests only use it
970 * to tell whether the URB was unlinked; detailed status for
971 * each frame is in the fields of the iso_frame-desc.
972 * @transfer_flags: A variety of flags may be used to affect how URB
973 * submission, unlinking, or operation are handled. Different
974 * kinds of URB can use different flags.
975 * @transfer_buffer: This identifies the buffer to (or from) which
976 * the I/O request will be performed (unless URB_NO_TRANSFER_DMA_MAP
977 * is set). This buffer must be suitable for DMA; allocate it with
978 * kmalloc() or equivalent. For transfers to "in" endpoints, contents
979 * of this buffer will be modified. This buffer is used for the data
980 * stage of control transfers.
981 * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP,
982 * the device driver is saying that it provided this DMA address,
983 * which the host controller driver should use in preference to the
984 * transfer_buffer.
985 * @transfer_buffer_length: How big is transfer_buffer. The transfer may
986 * be broken up into chunks according to the current maximum packet
987 * size for the endpoint, which is a function of the configuration
988 * and is encoded in the pipe. When the length is zero, neither
989 * transfer_buffer nor transfer_dma is used.
990 * @actual_length: This is read in non-iso completion functions, and
991 * it tells how many bytes (out of transfer_buffer_length) were
992 * transferred. It will normally be the same as requested, unless
993 * either an error was reported or a short read was performed.
994 * The URB_SHORT_NOT_OK transfer flag may be used to make such
995 * short reads be reported as errors.
996 * @setup_packet: Only used for control transfers, this points to eight bytes
997 * of setup data. Control transfers always start by sending this data
998 * to the device. Then transfer_buffer is read or written, if needed.
999 * @setup_dma: For control transfers with URB_NO_SETUP_DMA_MAP set, the
1000 * device driver has provided this DMA address for the setup packet.
1001 * The host controller driver should use this in preference to
1002 * setup_packet.
1003 * @start_frame: Returns the initial frame for isochronous transfers.
1004 * @number_of_packets: Lists the number of ISO transfer buffers.
1005 * @interval: Specifies the polling interval for interrupt or isochronous
1006 * transfers. The units are frames (milliseconds) for for full and low
1007 * speed devices, and microframes (1/8 millisecond) for highspeed ones.
1008 * @error_count: Returns the number of ISO transfers that reported errors.
1009 * @context: For use in completion functions. This normally points to
1010 * request-specific driver context.
1011 * @complete: Completion handler. This URB is passed as the parameter to the
1012 * completion function. The completion function may then do what
1013 * it likes with the URB, including resubmitting or freeing it.
1014 * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to
1015 * collect the transfer status for each buffer.
1016 *
1017 * This structure identifies USB transfer requests. URBs must be allocated by
1018 * calling usb_alloc_urb() and freed with a call to usb_free_urb().
1019 * Initialization may be done using various usb_fill_*_urb() functions. URBs
1020 * are submitted using usb_submit_urb(), and pending requests may be canceled
1021 * using usb_unlink_urb() or usb_kill_urb().
1022 *
1023 * Data Transfer Buffers:
1024 *
1025 * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise
1026 * taken from the general page pool. That is provided by transfer_buffer
1027 * (control requests also use setup_packet), and host controller drivers
1028 * perform a dma mapping (and unmapping) for each buffer transferred. Those
1029 * mapping operations can be expensive on some platforms (perhaps using a dma
1030 * bounce buffer or talking to an IOMMU),
1031 * although they're cheap on commodity x86 and ppc hardware.
1032 *
1033 * Alternatively, drivers may pass the URB_NO_xxx_DMA_MAP transfer flags,
1034 * which tell the host controller driver that no such mapping is needed since
1035 * the device driver is DMA-aware. For example, a device driver might
1036 * allocate a DMA buffer with usb_buffer_alloc() or call usb_buffer_map().
1037 * When these transfer flags are provided, host controller drivers will
1038 * attempt to use the dma addresses found in the transfer_dma and/or
1039 * setup_dma fields rather than determining a dma address themselves. (Note
1040 * that transfer_buffer and setup_packet must still be set because not all
1041 * host controllers use DMA, nor do virtual root hubs).
1042 *
1043 * Initialization:
1044 *
1045 * All URBs submitted must initialize the dev, pipe, transfer_flags (may be
Alan Sternb375a042005-07-29 16:11:07 -04001046 * zero), and complete fields. All URBs must also initialize
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047 * transfer_buffer and transfer_buffer_length. They may provide the
1048 * URB_SHORT_NOT_OK transfer flag, indicating that short reads are
1049 * to be treated as errors; that flag is invalid for write requests.
1050 *
1051 * Bulk URBs may
1052 * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers
1053 * should always terminate with a short packet, even if it means adding an
1054 * extra zero length packet.
1055 *
1056 * Control URBs must provide a setup_packet. The setup_packet and
1057 * transfer_buffer may each be mapped for DMA or not, independently of
1058 * the other. The transfer_flags bits URB_NO_TRANSFER_DMA_MAP and
1059 * URB_NO_SETUP_DMA_MAP indicate which buffers have already been mapped.
1060 * URB_NO_SETUP_DMA_MAP is ignored for non-control URBs.
1061 *
1062 * Interrupt URBs must provide an interval, saying how often (in milliseconds
1063 * or, for highspeed devices, 125 microsecond units)
1064 * to poll for transfers. After the URB has been submitted, the interval
1065 * field reflects how the transfer was actually scheduled.
1066 * The polling interval may be more frequent than requested.
1067 * For example, some controllers have a maximum interval of 32 milliseconds,
1068 * while others support intervals of up to 1024 milliseconds.
1069 * Isochronous URBs also have transfer intervals. (Note that for isochronous
1070 * endpoints, as well as high speed interrupt endpoints, the encoding of
1071 * the transfer interval in the endpoint descriptor is logarithmic.
1072 * Device drivers must convert that value to linear units themselves.)
1073 *
1074 * Isochronous URBs normally use the URB_ISO_ASAP transfer flag, telling
1075 * the host controller to schedule the transfer as soon as bandwidth
1076 * utilization allows, and then set start_frame to reflect the actual frame
1077 * selected during submission. Otherwise drivers must specify the start_frame
1078 * and handle the case where the transfer can't begin then. However, drivers
1079 * won't know how bandwidth is currently allocated, and while they can
1080 * find the current frame using usb_get_current_frame_number () they can't
1081 * know the range for that frame number. (Ranges for frame counter values
1082 * are HC-specific, and can go from 256 to 65536 frames from "now".)
1083 *
1084 * Isochronous URBs have a different data transfer model, in part because
1085 * the quality of service is only "best effort". Callers provide specially
1086 * allocated URBs, with number_of_packets worth of iso_frame_desc structures
1087 * at the end. Each such packet is an individual ISO transfer. Isochronous
1088 * URBs are normally queued, submitted by drivers to arrange that
1089 * transfers are at least double buffered, and then explicitly resubmitted
1090 * in completion handlers, so
1091 * that data (such as audio or video) streams at as constant a rate as the
1092 * host controller scheduler can support.
1093 *
1094 * Completion Callbacks:
1095 *
1096 * The completion callback is made in_interrupt(), and one of the first
1097 * things that a completion handler should do is check the status field.
1098 * The status field is provided for all URBs. It is used to report
1099 * unlinked URBs, and status for all non-ISO transfers. It should not
1100 * be examined before the URB is returned to the completion handler.
1101 *
1102 * The context field is normally used to link URBs back to the relevant
1103 * driver or request state.
1104 *
1105 * When the completion callback is invoked for non-isochronous URBs, the
1106 * actual_length field tells how many bytes were transferred. This field
1107 * is updated even when the URB terminated with an error or was unlinked.
1108 *
1109 * ISO transfer status is reported in the status and actual_length fields
1110 * of the iso_frame_desc array, and the number of errors is reported in
1111 * error_count. Completion callbacks for ISO transfers will normally
1112 * (re)submit URBs to ensure a constant transfer rate.
Roman Kagan719df462005-05-06 00:55:56 +04001113 *
1114 * Note that even fields marked "public" should not be touched by the driver
1115 * when the urb is owned by the hcd, that is, since the call to
1116 * usb_submit_urb() till the entry into the completion routine.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117 */
1118struct urb
1119{
Martin Waitzaeec46b2005-11-13 16:08:13 -08001120 /* private: usb core and host controller only fields in the urb */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121 struct kref kref; /* reference count of the URB */
1122 spinlock_t lock; /* lock for the URB */
1123 void *hcpriv; /* private data for host controller */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124 atomic_t use_count; /* concurrent submissions counter */
1125 u8 reject; /* submissions will fail */
1126
Martin Waitzaeec46b2005-11-13 16:08:13 -08001127 /* public: documented fields in the urb that can be used by drivers */
Alan Sternb724ae72005-10-24 15:36:00 -04001128 struct list_head urb_list; /* list head for use by the urb's
1129 * current owner */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130 struct usb_device *dev; /* (in) pointer to associated device */
1131 unsigned int pipe; /* (in) pipe information */
1132 int status; /* (return) non-ISO status */
1133 unsigned int transfer_flags; /* (in) URB_SHORT_NOT_OK | ...*/
1134 void *transfer_buffer; /* (in) associated data buffer */
1135 dma_addr_t transfer_dma; /* (in) dma addr for transfer_buffer */
1136 int transfer_buffer_length; /* (in) data buffer length */
1137 int actual_length; /* (return) actual transfer length */
1138 unsigned char *setup_packet; /* (in) setup packet (control only) */
1139 dma_addr_t setup_dma; /* (in) dma addr for setup_packet */
1140 int start_frame; /* (modify) start frame (ISO) */
1141 int number_of_packets; /* (in) number of ISO packets */
Alan Sternb724ae72005-10-24 15:36:00 -04001142 int interval; /* (modify) transfer interval
1143 * (INT/ISO) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144 int error_count; /* (return) number of ISO errors */
1145 void *context; /* (in) context for completion */
1146 usb_complete_t complete; /* (in) completion routine */
Alan Sternb724ae72005-10-24 15:36:00 -04001147 struct usb_iso_packet_descriptor iso_frame_desc[0];
1148 /* (in) ISO ONLY */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149};
1150
Alan Sternb724ae72005-10-24 15:36:00 -04001151/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152
1153/**
1154 * usb_fill_control_urb - initializes a control urb
1155 * @urb: pointer to the urb to initialize.
1156 * @dev: pointer to the struct usb_device for this urb.
1157 * @pipe: the endpoint pipe
1158 * @setup_packet: pointer to the setup_packet buffer
1159 * @transfer_buffer: pointer to the transfer buffer
1160 * @buffer_length: length of the transfer buffer
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001161 * @complete_fn: pointer to the usb_complete_t function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162 * @context: what to set the urb context to.
1163 *
1164 * Initializes a control urb with the proper information needed to submit
1165 * it to a device.
1166 */
1167static inline void usb_fill_control_urb (struct urb *urb,
1168 struct usb_device *dev,
1169 unsigned int pipe,
1170 unsigned char *setup_packet,
1171 void *transfer_buffer,
1172 int buffer_length,
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001173 usb_complete_t complete_fn,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174 void *context)
1175{
1176 spin_lock_init(&urb->lock);
1177 urb->dev = dev;
1178 urb->pipe = pipe;
1179 urb->setup_packet = setup_packet;
1180 urb->transfer_buffer = transfer_buffer;
1181 urb->transfer_buffer_length = buffer_length;
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001182 urb->complete = complete_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183 urb->context = context;
1184}
1185
1186/**
1187 * usb_fill_bulk_urb - macro to help initialize a bulk urb
1188 * @urb: pointer to the urb to initialize.
1189 * @dev: pointer to the struct usb_device for this urb.
1190 * @pipe: the endpoint pipe
1191 * @transfer_buffer: pointer to the transfer buffer
1192 * @buffer_length: length of the transfer buffer
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001193 * @complete_fn: pointer to the usb_complete_t function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194 * @context: what to set the urb context to.
1195 *
1196 * Initializes a bulk urb with the proper information needed to submit it
1197 * to a device.
1198 */
1199static inline void usb_fill_bulk_urb (struct urb *urb,
1200 struct usb_device *dev,
1201 unsigned int pipe,
1202 void *transfer_buffer,
1203 int buffer_length,
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001204 usb_complete_t complete_fn,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205 void *context)
1206{
1207 spin_lock_init(&urb->lock);
1208 urb->dev = dev;
1209 urb->pipe = pipe;
1210 urb->transfer_buffer = transfer_buffer;
1211 urb->transfer_buffer_length = buffer_length;
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001212 urb->complete = complete_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213 urb->context = context;
1214}
1215
1216/**
1217 * usb_fill_int_urb - macro to help initialize a interrupt urb
1218 * @urb: pointer to the urb to initialize.
1219 * @dev: pointer to the struct usb_device for this urb.
1220 * @pipe: the endpoint pipe
1221 * @transfer_buffer: pointer to the transfer buffer
1222 * @buffer_length: length of the transfer buffer
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001223 * @complete_fn: pointer to the usb_complete_t function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224 * @context: what to set the urb context to.
1225 * @interval: what to set the urb interval to, encoded like
1226 * the endpoint descriptor's bInterval value.
1227 *
1228 * Initializes a interrupt urb with the proper information needed to submit
1229 * it to a device.
1230 * Note that high speed interrupt endpoints use a logarithmic encoding of
1231 * the endpoint interval, and express polling intervals in microframes
1232 * (eight per millisecond) rather than in frames (one per millisecond).
1233 */
1234static inline void usb_fill_int_urb (struct urb *urb,
1235 struct usb_device *dev,
1236 unsigned int pipe,
1237 void *transfer_buffer,
1238 int buffer_length,
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001239 usb_complete_t complete_fn,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240 void *context,
1241 int interval)
1242{
1243 spin_lock_init(&urb->lock);
1244 urb->dev = dev;
1245 urb->pipe = pipe;
1246 urb->transfer_buffer = transfer_buffer;
1247 urb->transfer_buffer_length = buffer_length;
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001248 urb->complete = complete_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249 urb->context = context;
1250 if (dev->speed == USB_SPEED_HIGH)
1251 urb->interval = 1 << (interval - 1);
1252 else
1253 urb->interval = interval;
1254 urb->start_frame = -1;
1255}
1256
1257extern void usb_init_urb(struct urb *urb);
Al Viro55016f12005-10-21 03:21:58 -04001258extern struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259extern void usb_free_urb(struct urb *urb);
1260#define usb_put_urb usb_free_urb
1261extern struct urb *usb_get_urb(struct urb *urb);
Al Viro55016f12005-10-21 03:21:58 -04001262extern int usb_submit_urb(struct urb *urb, gfp_t mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263extern int usb_unlink_urb(struct urb *urb);
1264extern void usb_kill_urb(struct urb *urb);
1265
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266void *usb_buffer_alloc (struct usb_device *dev, size_t size,
Al Viro55016f12005-10-21 03:21:58 -04001267 gfp_t mem_flags, dma_addr_t *dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268void usb_buffer_free (struct usb_device *dev, size_t size,
1269 void *addr, dma_addr_t dma);
1270
1271#if 0
1272struct urb *usb_buffer_map (struct urb *urb);
1273void usb_buffer_dmasync (struct urb *urb);
1274void usb_buffer_unmap (struct urb *urb);
1275#endif
1276
1277struct scatterlist;
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -03001278int usb_buffer_map_sg(const struct usb_device *dev, unsigned pipe,
1279 struct scatterlist *sg, int nents);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280#if 0
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -03001281void usb_buffer_dmasync_sg(const struct usb_device *dev, unsigned pipe,
1282 struct scatterlist *sg, int n_hw_ents);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283#endif
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -03001284void usb_buffer_unmap_sg(const struct usb_device *dev, unsigned pipe,
1285 struct scatterlist *sg, int n_hw_ents);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286
1287/*-------------------------------------------------------------------*
1288 * SYNCHRONOUS CALL SUPPORT *
1289 *-------------------------------------------------------------------*/
1290
1291extern int usb_control_msg(struct usb_device *dev, unsigned int pipe,
1292 __u8 request, __u8 requesttype, __u16 value, __u16 index,
1293 void *data, __u16 size, int timeout);
Greg Kroah-Hartman782a7a62006-05-19 13:20:20 -07001294extern int usb_interrupt_msg(struct usb_device *usb_dev, unsigned int pipe,
1295 void *data, int len, int *actual_length, int timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296extern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,
1297 void *data, int len, int *actual_length,
1298 int timeout);
1299
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300/* wrappers around usb_control_msg() for the most common standard requests */
1301extern int usb_get_descriptor(struct usb_device *dev, unsigned char desctype,
1302 unsigned char descindex, void *buf, int size);
1303extern int usb_get_status(struct usb_device *dev,
1304 int type, int target, void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305extern int usb_string(struct usb_device *dev, int index,
1306 char *buf, size_t size);
1307
1308/* wrappers that also update important state inside usbcore */
1309extern int usb_clear_halt(struct usb_device *dev, int pipe);
1310extern int usb_reset_configuration(struct usb_device *dev);
1311extern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate);
1312
Alan Stern088dc272006-08-21 12:08:19 -04001313/* this request isn't really synchronous, but it belongs with the others */
1314extern int usb_driver_set_configuration(struct usb_device *udev, int config);
1315
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316/*
1317 * timeouts, in milliseconds, used for sending/receiving control messages
1318 * they typically complete within a few frames (msec) after they're issued
1319 * USB identifies 5 second timeouts, maybe more in a few cases, and a few
1320 * slow devices (like some MGE Ellipse UPSes) actually push that limit.
1321 */
1322#define USB_CTRL_GET_TIMEOUT 5000
1323#define USB_CTRL_SET_TIMEOUT 5000
1324
1325
1326/**
1327 * struct usb_sg_request - support for scatter/gather I/O
1328 * @status: zero indicates success, else negative errno
1329 * @bytes: counts bytes transferred.
1330 *
1331 * These requests are initialized using usb_sg_init(), and then are used
1332 * as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most
1333 * members of the request object aren't for driver access.
1334 *
1335 * The status and bytecount values are valid only after usb_sg_wait()
1336 * returns. If the status is zero, then the bytecount matches the total
1337 * from the request.
1338 *
1339 * After an error completion, drivers may need to clear a halt condition
1340 * on the endpoint.
1341 */
1342struct usb_sg_request {
1343 int status;
1344 size_t bytes;
1345
1346 /*
Martin Waitzaeec46b2005-11-13 16:08:13 -08001347 * members below are private: to usbcore,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348 * and are not provided for driver access!
1349 */
1350 spinlock_t lock;
1351
1352 struct usb_device *dev;
1353 int pipe;
1354 struct scatterlist *sg;
1355 int nents;
1356
1357 int entries;
1358 struct urb **urbs;
1359
1360 int count;
1361 struct completion complete;
1362};
1363
1364int usb_sg_init (
1365 struct usb_sg_request *io,
1366 struct usb_device *dev,
1367 unsigned pipe,
1368 unsigned period,
1369 struct scatterlist *sg,
1370 int nents,
1371 size_t length,
Al Viro55016f12005-10-21 03:21:58 -04001372 gfp_t mem_flags
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373);
1374void usb_sg_cancel (struct usb_sg_request *io);
1375void usb_sg_wait (struct usb_sg_request *io);
1376
1377
Alan Sternb724ae72005-10-24 15:36:00 -04001378/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379
1380/*
1381 * For various legacy reasons, Linux has a small cookie that's paired with
1382 * a struct usb_device to identify an endpoint queue. Queue characteristics
1383 * are defined by the endpoint's descriptor. This cookie is called a "pipe",
1384 * an unsigned int encoded as:
1385 *
1386 * - direction: bit 7 (0 = Host-to-Device [Out],
1387 * 1 = Device-to-Host [In] ...
1388 * like endpoint bEndpointAddress)
1389 * - device address: bits 8-14 ... bit positions known to uhci-hcd
1390 * - endpoint: bits 15-18 ... bit positions known to uhci-hcd
1391 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
1392 * 10 = control, 11 = bulk)
1393 *
1394 * Given the device address and endpoint descriptor, pipes are redundant.
1395 */
1396
1397/* NOTE: these are not the standard USB_ENDPOINT_XFER_* values!! */
1398/* (yet ... they're the values used by usbfs) */
1399#define PIPE_ISOCHRONOUS 0
1400#define PIPE_INTERRUPT 1
1401#define PIPE_CONTROL 2
1402#define PIPE_BULK 3
1403
1404#define usb_pipein(pipe) ((pipe) & USB_DIR_IN)
1405#define usb_pipeout(pipe) (!usb_pipein(pipe))
1406
1407#define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
1408#define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
1409
1410#define usb_pipetype(pipe) (((pipe) >> 30) & 3)
1411#define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
1412#define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
1413#define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
1414#define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
1415
1416/* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
1417#define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
1418#define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep)))
Alan Sternb724ae72005-10-24 15:36:00 -04001419#define usb_settoggle(dev, ep, out, bit) \
1420 ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \
1421 ((bit) << (ep)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422
1423
Alan Sternb724ae72005-10-24 15:36:00 -04001424static inline unsigned int __create_pipe(struct usb_device *dev,
1425 unsigned int endpoint)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426{
1427 return (dev->devnum << 8) | (endpoint << 15);
1428}
1429
1430/* Create various pipes... */
Alan Sternb724ae72005-10-24 15:36:00 -04001431#define usb_sndctrlpipe(dev,endpoint) \
1432 ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint))
1433#define usb_rcvctrlpipe(dev,endpoint) \
1434 ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1435#define usb_sndisocpipe(dev,endpoint) \
1436 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint))
1437#define usb_rcvisocpipe(dev,endpoint) \
1438 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1439#define usb_sndbulkpipe(dev,endpoint) \
1440 ((PIPE_BULK << 30) | __create_pipe(dev,endpoint))
1441#define usb_rcvbulkpipe(dev,endpoint) \
1442 ((PIPE_BULK << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1443#define usb_sndintpipe(dev,endpoint) \
1444 ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint))
1445#define usb_rcvintpipe(dev,endpoint) \
1446 ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447
1448/*-------------------------------------------------------------------------*/
1449
1450static inline __u16
1451usb_maxpacket(struct usb_device *udev, int pipe, int is_out)
1452{
1453 struct usb_host_endpoint *ep;
1454 unsigned epnum = usb_pipeendpoint(pipe);
1455
1456 if (is_out) {
1457 WARN_ON(usb_pipein(pipe));
1458 ep = udev->ep_out[epnum];
1459 } else {
1460 WARN_ON(usb_pipeout(pipe));
1461 ep = udev->ep_in[epnum];
1462 }
1463 if (!ep)
1464 return 0;
1465
1466 /* NOTE: only 0x07ff bits are for packet size... */
1467 return le16_to_cpu(ep->desc.wMaxPacketSize);
1468}
1469
Alan Sternb724ae72005-10-24 15:36:00 -04001470/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -07001472/* Events from the usb core */
1473#define USB_DEVICE_ADD 0x0001
1474#define USB_DEVICE_REMOVE 0x0002
1475#define USB_BUS_ADD 0x0003
1476#define USB_BUS_REMOVE 0x0004
1477extern void usb_register_notify(struct notifier_block *nb);
1478extern void usb_unregister_notify(struct notifier_block *nb);
1479
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480#ifdef DEBUG
Alan Sternb724ae72005-10-24 15:36:00 -04001481#define dbg(format, arg...) printk(KERN_DEBUG "%s: " format "\n" , \
1482 __FILE__ , ## arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483#else
1484#define dbg(format, arg...) do {} while (0)
1485#endif
1486
Alan Sternb724ae72005-10-24 15:36:00 -04001487#define err(format, arg...) printk(KERN_ERR "%s: " format "\n" , \
1488 __FILE__ , ## arg)
1489#define info(format, arg...) printk(KERN_INFO "%s: " format "\n" , \
1490 __FILE__ , ## arg)
1491#define warn(format, arg...) printk(KERN_WARNING "%s: " format "\n" , \
1492 __FILE__ , ## arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493
1494
1495#endif /* __KERNEL__ */
1496
1497#endif