blob: 8d5829936bc4ec1d6af094081d6108b3eb63498e [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>
5#include <linux/usb_ch9.h>
6
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
13#include <linux/config.h>
14#include <linux/errno.h> /* for -ENODEV */
15#include <linux/delay.h> /* for mdelay() */
16#include <linux/interrupt.h> /* for in_interrupt() */
17#include <linux/list.h> /* for struct list_head */
18#include <linux/kref.h> /* for struct kref */
19#include <linux/device.h> /* for struct device */
20#include <linux/fs.h> /* for struct file_operations */
21#include <linux/completion.h> /* for struct completion */
22#include <linux/sched.h> /* for current && schedule_timeout */
23
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
44/**
45 * struct usb_host_endpoint - host-side endpoint descriptor and queue
46 * @desc: descriptor for this endpoint, wMaxPacketSize in native byteorder
47 * @urb_list: urbs queued to this endpoint; maintained by usbcore
48 * @hcpriv: for use by HCD; typically holds hardware dma queue head (QH)
49 * with one or more transfer descriptors (TDs) per urb
Randy Dunlap8dd396e2005-11-23 15:45:53 -080050 * @kobj: kobject for sysfs info
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 * @extra: descriptors following this endpoint in the configuration
52 * @extralen: how many bytes of "extra" are valid
53 *
54 * USB requests are always queued to a given endpoint, identified by a
55 * descriptor within an active interface in a given USB configuration.
56 */
57struct usb_host_endpoint {
58 struct usb_endpoint_descriptor desc;
59 struct list_head urb_list;
60 void *hcpriv;
Alan Sternbe69e5b2005-10-25 15:56:06 -040061 struct kobject *kobj; /* For sysfs info */
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
63 unsigned char *extra; /* Extra descriptors */
64 int extralen;
65};
66
67/* host-side wrapper for one interface setting's parsed descriptors */
68struct usb_host_interface {
69 struct usb_interface_descriptor desc;
70
71 /* array of desc.bNumEndpoint endpoints associated with this
72 * interface setting. these will be in no particular order.
73 */
74 struct usb_host_endpoint *endpoint;
75
76 char *string; /* iInterface string, if present */
77 unsigned char *extra; /* Extra descriptors */
78 int extralen;
79};
80
81enum usb_interface_condition {
82 USB_INTERFACE_UNBOUND = 0,
83 USB_INTERFACE_BINDING,
84 USB_INTERFACE_BOUND,
85 USB_INTERFACE_UNBINDING,
86};
87
88/**
89 * struct usb_interface - what usb device drivers talk to
90 * @altsetting: array of interface structures, one for each alternate
91 * setting that may be selected. Each one includes a set of
92 * endpoint configurations. They will be in no particular order.
93 * @num_altsetting: number of altsettings defined.
94 * @cur_altsetting: the current altsetting.
95 * @driver: the USB driver that is bound to this interface.
96 * @minor: the minor number assigned to this interface, if this
97 * interface is bound to a driver that uses the USB major number.
98 * If this interface does not use the USB major, this field should
99 * be unused. The driver should set this value in the probe()
100 * function of the driver, after it has been assigned a minor
101 * number from the USB core by calling usb_register_dev().
102 * @condition: binding state of the interface: not bound, binding
103 * (in probe()), bound to a driver, or unbinding (in disconnect())
104 * @dev: driver model's view of this device
105 * @class_dev: driver model's class view of this device.
106 *
107 * USB device drivers attach to interfaces on a physical device. Each
108 * interface encapsulates a single high level function, such as feeding
109 * an audio stream to a speaker or reporting a change in a volume control.
110 * Many USB devices only have one interface. The protocol used to talk to
111 * an interface's endpoints can be defined in a usb "class" specification,
112 * or by a product's vendor. The (default) control endpoint is part of
113 * every interface, but is never listed among the interface's descriptors.
114 *
115 * The driver that is bound to the interface can use standard driver model
116 * calls such as dev_get_drvdata() on the dev member of this structure.
117 *
118 * Each interface may have alternate settings. The initial configuration
119 * of a device sets altsetting 0, but the device driver can change
120 * that setting using usb_set_interface(). Alternate settings are often
121 * used to control the the use of periodic endpoints, such as by having
122 * different endpoints use different amounts of reserved USB bandwidth.
123 * All standards-conformant USB devices that use isochronous endpoints
124 * will use them in non-default settings.
125 *
126 * The USB specification says that alternate setting numbers must run from
127 * 0 to one less than the total number of alternate settings. But some
128 * devices manage to mess this up, and the structures aren't necessarily
129 * stored in numerical order anyhow. Use usb_altnum_to_altsetting() to
130 * look up an alternate setting in the altsetting array based on its number.
131 */
132struct usb_interface {
133 /* array of alternate settings for this interface,
134 * stored in no particular order */
135 struct usb_host_interface *altsetting;
136
137 struct usb_host_interface *cur_altsetting; /* the currently
138 * active alternate setting */
139 unsigned num_altsetting; /* number of alternate settings */
140
Alan Sternb724ae72005-10-24 15:36:00 -0400141 int minor; /* minor number this interface is
142 * bound to */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 enum usb_interface_condition condition; /* state of binding */
144 struct device dev; /* interface specific device info */
145 struct class_device *class_dev;
146};
147#define to_usb_interface(d) container_of(d, struct usb_interface, dev)
148#define interface_to_usbdev(intf) \
149 container_of(intf->dev.parent, struct usb_device, dev)
150
151static inline void *usb_get_intfdata (struct usb_interface *intf)
152{
153 return dev_get_drvdata (&intf->dev);
154}
155
156static inline void usb_set_intfdata (struct usb_interface *intf, void *data)
157{
158 dev_set_drvdata(&intf->dev, data);
159}
160
161struct usb_interface *usb_get_intf(struct usb_interface *intf);
162void usb_put_intf(struct usb_interface *intf);
163
164/* this maximum is arbitrary */
165#define USB_MAXINTERFACES 32
166
167/**
168 * struct usb_interface_cache - long-term representation of a device interface
169 * @num_altsetting: number of altsettings defined.
170 * @ref: reference counter.
171 * @altsetting: variable-length array of interface structures, one for
172 * each alternate setting that may be selected. Each one includes a
173 * set of endpoint configurations. They will be in no particular order.
174 *
175 * These structures persist for the lifetime of a usb_device, unlike
176 * struct usb_interface (which persists only as long as its configuration
177 * is installed). The altsetting arrays can be accessed through these
178 * structures at any time, permitting comparison of configurations and
179 * providing support for the /proc/bus/usb/devices pseudo-file.
180 */
181struct usb_interface_cache {
182 unsigned num_altsetting; /* number of alternate settings */
183 struct kref ref; /* reference counter */
184
185 /* variable-length array of alternate settings for this interface,
186 * stored in no particular order */
187 struct usb_host_interface altsetting[0];
188};
189#define ref_to_usb_interface_cache(r) \
190 container_of(r, struct usb_interface_cache, ref)
191#define altsetting_to_usb_interface_cache(a) \
192 container_of(a, struct usb_interface_cache, altsetting[0])
193
194/**
195 * struct usb_host_config - representation of a device's configuration
196 * @desc: the device's configuration descriptor.
197 * @string: pointer to the cached version of the iConfiguration string, if
198 * present for this configuration.
199 * @interface: array of pointers to usb_interface structures, one for each
200 * interface in the configuration. The number of interfaces is stored
201 * in desc.bNumInterfaces. These pointers are valid only while the
202 * the configuration is active.
203 * @intf_cache: array of pointers to usb_interface_cache structures, one
204 * for each interface in the configuration. These structures exist
205 * for the entire life of the device.
206 * @extra: pointer to buffer containing all extra descriptors associated
207 * with this configuration (those preceding the first interface
208 * descriptor).
209 * @extralen: length of the extra descriptors buffer.
210 *
211 * USB devices may have multiple configurations, but only one can be active
212 * at any time. Each encapsulates a different operational environment;
213 * for example, a dual-speed device would have separate configurations for
214 * full-speed and high-speed operation. The number of configurations
215 * available is stored in the device descriptor as bNumConfigurations.
216 *
217 * A configuration can contain multiple interfaces. Each corresponds to
218 * a different function of the USB device, and all are available whenever
219 * the configuration is active. The USB standard says that interfaces
220 * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot
221 * of devices get this wrong. In addition, the interface array is not
222 * guaranteed to be sorted in numerical order. Use usb_ifnum_to_if() to
223 * look up an interface entry based on its number.
224 *
225 * Device drivers should not attempt to activate configurations. The choice
226 * of which configuration to install is a policy decision based on such
227 * considerations as available power, functionality provided, and the user's
228 * desires (expressed through hotplug scripts). However, drivers can call
229 * usb_reset_configuration() to reinitialize the current configuration and
230 * all its interfaces.
231 */
232struct usb_host_config {
233 struct usb_config_descriptor desc;
234
Alan Stern4f62efe2005-10-24 16:24:14 -0400235 char *string; /* iConfiguration string, if present */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 /* the interfaces associated with this configuration,
237 * stored in no particular order */
238 struct usb_interface *interface[USB_MAXINTERFACES];
239
240 /* Interface information available even when this is not the
241 * active configuration */
242 struct usb_interface_cache *intf_cache[USB_MAXINTERFACES];
243
244 unsigned char *extra; /* Extra descriptors */
245 int extralen;
246};
247
248int __usb_get_extra_descriptor(char *buffer, unsigned size,
249 unsigned char type, void **ptr);
250#define usb_get_extra_descriptor(ifpoint,type,ptr)\
251 __usb_get_extra_descriptor((ifpoint)->extra,(ifpoint)->extralen,\
252 type,(void**)ptr)
253
Alan Sternb724ae72005-10-24 15:36:00 -0400254/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
256struct usb_operations;
257
258/* USB device number allocation bitmap */
259struct usb_devmap {
260 unsigned long devicemap[128 / (8*sizeof(unsigned long))];
261};
262
263/*
264 * Allocated per bus (tree of devices) we have:
265 */
266struct usb_bus {
267 struct device *controller; /* host/master side hardware */
268 int busnum; /* Bus number (in order of reg) */
269 char *bus_name; /* stable id (PCI slot_name etc) */
270 u8 otg_port; /* 0, or number of OTG/HNP port */
271 unsigned is_b_host:1; /* true during some HNP roleswitches */
272 unsigned b_hnp_enable:1; /* OTG: did A-Host enable HNP? */
273
Alan Sternb724ae72005-10-24 15:36:00 -0400274 int devnum_next; /* Next open device number in
275 * round-robin allocation */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276
277 struct usb_devmap devmap; /* device address allocation map */
278 struct usb_operations *op; /* Operations (specific to the HC) */
279 struct usb_device *root_hub; /* Root hub */
280 struct list_head bus_list; /* list of busses */
281 void *hcpriv; /* Host Controller private data */
282
283 int bandwidth_allocated; /* on this bus: how much of the time
284 * reserved for periodic (intr/iso)
285 * requests is used, on average?
286 * Units: microseconds/frame.
287 * Limits: Full/low speed reserve 90%,
288 * while high speed reserves 80%.
289 */
290 int bandwidth_int_reqs; /* number of Interrupt requests */
291 int bandwidth_isoc_reqs; /* number of Isoc. requests */
292
293 struct dentry *usbfs_dentry; /* usbfs dentry entry for the bus */
294
gregkh@suse.de8561b102005-03-15 15:10:13 -0800295 struct class_device *class_dev; /* class device for this bus */
Alan Sternb724ae72005-10-24 15:36:00 -0400296 struct kref kref; /* reference counting for this bus */
297 void (*release)(struct usb_bus *bus);
298
Adrian Bunk4749f322005-06-23 11:36:56 +0200299#if defined(CONFIG_USB_MON)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 struct mon_bus *mon_bus; /* non-null when associated */
301 int monitored; /* non-zero when monitored */
302#endif
303};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304
Alan Sternb724ae72005-10-24 15:36:00 -0400305/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306
307/* This is arbitrary.
308 * From USB 2.0 spec Table 11-13, offset 7, a hub can
309 * have up to 255 ports. The most yet reported is 10.
310 */
311#define USB_MAXCHILDREN (16)
312
313struct usb_tt;
314
315/*
316 * struct usb_device - kernel's representation of a USB device
317 *
318 * FIXME: Write the kerneldoc!
319 *
320 * Usbcore drivers should not set usbdev->state directly. Instead use
321 * usb_set_device_state().
322 */
323struct usb_device {
324 int devnum; /* Address on USB bus */
325 char devpath [16]; /* Use in messages: /port/port/... */
326 enum usb_device_state state; /* configured, not attached, etc */
327 enum usb_device_speed speed; /* high/full/low (or error) */
328
329 struct usb_tt *tt; /* low/full speed dev, highspeed hub */
330 int ttport; /* device port on that tt hub */
331
332 struct semaphore serialize;
333
Alan Sternb724ae72005-10-24 15:36:00 -0400334 unsigned int toggle[2]; /* one bit for each endpoint
335 * ([0] = IN, [1] = OUT) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336
337 struct usb_device *parent; /* our hub, unless we're the root */
338 struct usb_bus *bus; /* Bus we're part of */
339 struct usb_host_endpoint ep0;
340
341 struct device dev; /* Generic device interface */
342
343 struct usb_device_descriptor descriptor;/* Descriptor */
344 struct usb_host_config *config; /* All of the configs */
345
346 struct usb_host_config *actconfig;/* the active configuration */
347 struct usb_host_endpoint *ep_in[16];
348 struct usb_host_endpoint *ep_out[16];
349
350 char **rawdescriptors; /* Raw descriptors for each config */
351
Alan Sternb724ae72005-10-24 15:36:00 -0400352 int have_langid; /* whether string_langid is valid */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 int string_langid; /* language ID for strings */
354
Alan Stern4f62efe2005-10-24 16:24:14 -0400355 /* static strings from the device */
356 char *product; /* iProduct string, if present */
357 char *manufacturer; /* iManufacturer string, if present */
358 char *serial; /* iSerialNumber string, if present */
359
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 struct list_head filelist;
Kay Sieversfbf82fd2005-07-31 01:05:53 +0200361 struct class_device *class_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 struct dentry *usbfs_dentry; /* usbfs dentry entry for the device */
363
364 /*
365 * Child devices - these can be either new devices
366 * (if this is a hub device), or different instances
367 * of this same device.
368 *
369 * Each instance needs its own set of data structures.
370 */
371
372 int maxchild; /* Number of ports if hub */
373 struct usb_device *children[USB_MAXCHILDREN];
374};
375#define to_usb_device(d) container_of(d, struct usb_device, dev)
376
377extern struct usb_device *usb_get_dev(struct usb_device *dev);
378extern void usb_put_dev(struct usb_device *dev);
379
380extern void usb_lock_device(struct usb_device *udev);
381extern int usb_trylock_device(struct usb_device *udev);
382extern int usb_lock_device_for_reset(struct usb_device *udev,
383 struct usb_interface *iface);
384extern void usb_unlock_device(struct usb_device *udev);
385
386/* USB port reset for device reinitialization */
387extern int usb_reset_device(struct usb_device *dev);
388
389extern struct usb_device *usb_find_device(u16 vendor_id, u16 product_id);
390
391/*-------------------------------------------------------------------------*/
392
393/* for drivers using iso endpoints */
394extern int usb_get_current_frame_number (struct usb_device *usb_dev);
395
396/* used these for multi-interface device registration */
397extern int usb_driver_claim_interface(struct usb_driver *driver,
398 struct usb_interface *iface, void* priv);
399
400/**
401 * usb_interface_claimed - returns true iff an interface is claimed
402 * @iface: the interface being checked
403 *
404 * Returns true (nonzero) iff the interface is claimed, else false (zero).
405 * Callers must own the driver model's usb bus readlock. So driver
406 * probe() entries don't need extra locking, but other call contexts
407 * may need to explicitly claim that lock.
408 *
409 */
410static inline int usb_interface_claimed(struct usb_interface *iface) {
411 return (iface->dev.driver != NULL);
412}
413
414extern void usb_driver_release_interface(struct usb_driver *driver,
415 struct usb_interface *iface);
416const struct usb_device_id *usb_match_id(struct usb_interface *interface,
417 const struct usb_device_id *id);
418
419extern struct usb_interface *usb_find_interface(struct usb_driver *drv,
420 int minor);
421extern struct usb_interface *usb_ifnum_to_if(struct usb_device *dev,
422 unsigned ifnum);
423extern struct usb_host_interface *usb_altnum_to_altsetting(
424 struct usb_interface *intf, unsigned int altnum);
425
426
427/**
428 * usb_make_path - returns stable device path in the usb tree
429 * @dev: the device whose path is being constructed
430 * @buf: where to put the string
431 * @size: how big is "buf"?
432 *
433 * Returns length of the string (> 0) or negative if size was too small.
434 *
435 * This identifier is intended to be "stable", reflecting physical paths in
436 * hardware such as physical bus addresses for host controllers or ports on
437 * USB hubs. That makes it stay the same until systems are physically
438 * reconfigured, by re-cabling a tree of USB devices or by moving USB host
439 * controllers. Adding and removing devices, including virtual root hubs
440 * in host controller driver modules, does not change these path identifers;
441 * neither does rebooting or re-enumerating. These are more useful identifiers
442 * than changeable ("unstable") ones like bus numbers or device addresses.
443 *
444 * With a partial exception for devices connected to USB 2.0 root hubs, these
445 * identifiers are also predictable. So long as the device tree isn't changed,
446 * plugging any USB device into a given hub port always gives it the same path.
447 * Because of the use of "companion" controllers, devices connected to ports on
448 * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are
449 * high speed, and a different one if they are full or low speed.
450 */
Alan Sternb724ae72005-10-24 15:36:00 -0400451static inline int usb_make_path (struct usb_device *dev, char *buf,
452 size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453{
454 int actual;
Alan Sternb724ae72005-10-24 15:36:00 -0400455 actual = snprintf (buf, size, "usb-%s-%s", dev->bus->bus_name,
456 dev->devpath);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 return (actual >= (int)size) ? -1 : actual;
458}
459
460/*-------------------------------------------------------------------------*/
461
Alan Sternb724ae72005-10-24 15:36:00 -0400462#define USB_DEVICE_ID_MATCH_DEVICE \
463 (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
464#define USB_DEVICE_ID_MATCH_DEV_RANGE \
465 (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI)
466#define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
467 (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468#define USB_DEVICE_ID_MATCH_DEV_INFO \
Alan Sternb724ae72005-10-24 15:36:00 -0400469 (USB_DEVICE_ID_MATCH_DEV_CLASS | \
470 USB_DEVICE_ID_MATCH_DEV_SUBCLASS | \
471 USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472#define USB_DEVICE_ID_MATCH_INT_INFO \
Alan Sternb724ae72005-10-24 15:36:00 -0400473 (USB_DEVICE_ID_MATCH_INT_CLASS | \
474 USB_DEVICE_ID_MATCH_INT_SUBCLASS | \
475 USB_DEVICE_ID_MATCH_INT_PROTOCOL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476
477/**
478 * USB_DEVICE - macro used to describe a specific usb device
479 * @vend: the 16 bit USB Vendor ID
480 * @prod: the 16 bit USB Product ID
481 *
482 * This macro is used to create a struct usb_device_id that matches a
483 * specific device.
484 */
485#define USB_DEVICE(vend,prod) \
Alan Sternb724ae72005-10-24 15:36:00 -0400486 .match_flags = USB_DEVICE_ID_MATCH_DEVICE, .idVendor = (vend), \
487 .idProduct = (prod)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488/**
Alan Sternb724ae72005-10-24 15:36:00 -0400489 * USB_DEVICE_VER - macro used to describe a specific usb device with a
490 * version range
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 * @vend: the 16 bit USB Vendor ID
492 * @prod: the 16 bit USB Product ID
493 * @lo: the bcdDevice_lo value
494 * @hi: the bcdDevice_hi value
495 *
496 * This macro is used to create a struct usb_device_id that matches a
497 * specific device, with a version range.
498 */
499#define USB_DEVICE_VER(vend,prod,lo,hi) \
Alan Sternb724ae72005-10-24 15:36:00 -0400500 .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, \
501 .idVendor = (vend), .idProduct = (prod), \
502 .bcdDevice_lo = (lo), .bcdDevice_hi = (hi)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503
504/**
505 * USB_DEVICE_INFO - macro used to describe a class of usb devices
506 * @cl: bDeviceClass value
507 * @sc: bDeviceSubClass value
508 * @pr: bDeviceProtocol value
509 *
510 * This macro is used to create a struct usb_device_id that matches a
511 * specific class of devices.
512 */
513#define USB_DEVICE_INFO(cl,sc,pr) \
Alan Sternb724ae72005-10-24 15:36:00 -0400514 .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, .bDeviceClass = (cl), \
515 .bDeviceSubClass = (sc), .bDeviceProtocol = (pr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516
517/**
518 * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces
519 * @cl: bInterfaceClass value
520 * @sc: bInterfaceSubClass value
521 * @pr: bInterfaceProtocol value
522 *
523 * This macro is used to create a struct usb_device_id that matches a
524 * specific class of interfaces.
525 */
526#define USB_INTERFACE_INFO(cl,sc,pr) \
Alan Sternb724ae72005-10-24 15:36:00 -0400527 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, .bInterfaceClass = (cl), \
528 .bInterfaceSubClass = (sc), .bInterfaceProtocol = (pr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529
Alan Sternb724ae72005-10-24 15:36:00 -0400530/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800532struct usb_dynids {
533 spinlock_t lock;
534 struct list_head list;
535};
536
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537/**
538 * struct usb_driver - identifies USB driver to usbcore
539 * @owner: Pointer to the module owner of this driver; initialize
540 * it using THIS_MODULE.
541 * @name: The driver name should be unique among USB drivers,
542 * and should normally be the same as the module name.
543 * @probe: Called to see if the driver is willing to manage a particular
544 * interface on a device. If it is, probe returns zero and uses
545 * dev_set_drvdata() to associate driver-specific data with the
546 * interface. It may also use usb_set_interface() to specify the
547 * appropriate altsetting. If unwilling to manage the interface,
548 * return a negative errno value.
549 * @disconnect: Called when the interface is no longer accessible, usually
550 * because its device has been (or is being) disconnected or the
551 * driver module is being unloaded.
552 * @ioctl: Used for drivers that want to talk to userspace through
553 * the "usbfs" filesystem. This lets devices provide ways to
554 * expose information to user space regardless of where they
555 * do (or don't) show up otherwise in the filesystem.
556 * @suspend: Called when the device is going to be suspended by the system.
557 * @resume: Called when the device is being resumed by the system.
558 * @id_table: USB drivers use ID table to support hotplugging.
559 * Export this with MODULE_DEVICE_TABLE(usb,...). This must be set
560 * or your driver's probe function will never get called.
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800561 * @dynids: used internally to hold the list of dynamically added device
562 * ids for this driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 * @driver: the driver model core driver structure.
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -0800564 * @no_dynamic_id: if set to 1, the USB core will not allow dynamic ids to be
565 * added to this driver by preventing the sysfs file from being created.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 *
567 * USB drivers must provide a name, probe() and disconnect() methods,
568 * and an id_table. Other driver fields are optional.
569 *
570 * The id_table is used in hotplugging. It holds a set of descriptors,
571 * and specialized data may be associated with each entry. That table
572 * is used by both user and kernel mode hotplugging support.
573 *
574 * The probe() and disconnect() methods are called in a context where
575 * they can sleep, but they should avoid abusing the privilege. Most
576 * work to connect to a device should be done when the device is opened,
577 * and undone at the last close. The disconnect code needs to address
578 * concurrency issues with respect to open() and close() methods, as
579 * well as forcing all pending I/O requests to complete (by unlinking
580 * them as necessary, and blocking until the unlinks complete).
581 */
582struct usb_driver {
583 struct module *owner;
584
585 const char *name;
586
587 int (*probe) (struct usb_interface *intf,
588 const struct usb_device_id *id);
589
590 void (*disconnect) (struct usb_interface *intf);
591
Alan Sternb724ae72005-10-24 15:36:00 -0400592 int (*ioctl) (struct usb_interface *intf, unsigned int code,
593 void *buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594
David Brownell27d72e82005-04-18 17:39:22 -0700595 int (*suspend) (struct usb_interface *intf, pm_message_t message);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 int (*resume) (struct usb_interface *intf);
597
598 const struct usb_device_id *id_table;
599
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800600 struct usb_dynids dynids;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 struct device_driver driver;
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -0800602 unsigned int no_dynamic_id:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603};
604#define to_usb_driver(d) container_of(d, struct usb_driver, driver)
605
606extern struct bus_type usb_bus_type;
607
608/**
609 * struct usb_class_driver - identifies a USB driver that wants to use the USB major number
Greg Kroah-Hartmand6e5bcf2005-06-20 21:15:16 -0700610 * @name: the usb class device name for this driver. Will show up in sysfs.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 * @fops: pointer to the struct file_operations of this driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 * @minor_base: the start of the minor range for this driver.
613 *
614 * This structure is used for the usb_register_dev() and
615 * usb_unregister_dev() functions, to consolidate a number of the
616 * parameters used for them.
617 */
618struct usb_class_driver {
619 char *name;
620 struct file_operations *fops;
Greg Kroah-Hartmand6e5bcf2005-06-20 21:15:16 -0700621 int minor_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622};
623
624/*
625 * use these in module_init()/module_exit()
626 * and don't forget MODULE_DEVICE_TABLE(usb, ...)
627 */
628extern int usb_register(struct usb_driver *);
629extern void usb_deregister(struct usb_driver *);
630
631extern int usb_register_dev(struct usb_interface *intf,
632 struct usb_class_driver *class_driver);
633extern void usb_deregister_dev(struct usb_interface *intf,
634 struct usb_class_driver *class_driver);
635
636extern int usb_disabled(void);
637
Alan Sternb724ae72005-10-24 15:36:00 -0400638/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639
640/*
641 * URB support, for asynchronous request completions
642 */
643
644/*
645 * urb->transfer_flags:
646 */
647#define URB_SHORT_NOT_OK 0x0001 /* report short reads as errors */
Alan Sternb724ae72005-10-24 15:36:00 -0400648#define URB_ISO_ASAP 0x0002 /* iso-only, urb->start_frame
649 * ignored */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650#define URB_NO_TRANSFER_DMA_MAP 0x0004 /* urb->transfer_dma valid on submit */
651#define URB_NO_SETUP_DMA_MAP 0x0008 /* urb->setup_dma valid on submit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652#define URB_NO_FSBR 0x0020 /* UHCI-specific */
Alan Sternb724ae72005-10-24 15:36:00 -0400653#define URB_ZERO_PACKET 0x0040 /* Finish bulk OUT with short packet */
654#define URB_NO_INTERRUPT 0x0080 /* HINT: no non-error interrupt
655 * needed */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656
657struct usb_iso_packet_descriptor {
658 unsigned int offset;
659 unsigned int length; /* expected length */
660 unsigned int actual_length;
661 unsigned int status;
662};
663
664struct urb;
665struct pt_regs;
666
667typedef void (*usb_complete_t)(struct urb *, struct pt_regs *);
668
669/**
670 * struct urb - USB Request Block
671 * @urb_list: For use by current owner of the URB.
672 * @pipe: Holds endpoint number, direction, type, and more.
673 * Create these values with the eight macros available;
674 * usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl"
675 * (control), "bulk", "int" (interrupt), or "iso" (isochronous).
676 * For example usb_sndbulkpipe() or usb_rcvintpipe(). Endpoint
677 * numbers range from zero to fifteen. Note that "in" endpoint two
678 * is a different endpoint (and pipe) from "out" endpoint two.
679 * The current configuration controls the existence, type, and
680 * maximum packet size of any given endpoint.
681 * @dev: Identifies the USB device to perform the request.
682 * @status: This is read in non-iso completion functions to get the
683 * status of the particular request. ISO requests only use it
684 * to tell whether the URB was unlinked; detailed status for
685 * each frame is in the fields of the iso_frame-desc.
686 * @transfer_flags: A variety of flags may be used to affect how URB
687 * submission, unlinking, or operation are handled. Different
688 * kinds of URB can use different flags.
689 * @transfer_buffer: This identifies the buffer to (or from) which
690 * the I/O request will be performed (unless URB_NO_TRANSFER_DMA_MAP
691 * is set). This buffer must be suitable for DMA; allocate it with
692 * kmalloc() or equivalent. For transfers to "in" endpoints, contents
693 * of this buffer will be modified. This buffer is used for the data
694 * stage of control transfers.
695 * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP,
696 * the device driver is saying that it provided this DMA address,
697 * which the host controller driver should use in preference to the
698 * transfer_buffer.
699 * @transfer_buffer_length: How big is transfer_buffer. The transfer may
700 * be broken up into chunks according to the current maximum packet
701 * size for the endpoint, which is a function of the configuration
702 * and is encoded in the pipe. When the length is zero, neither
703 * transfer_buffer nor transfer_dma is used.
704 * @actual_length: This is read in non-iso completion functions, and
705 * it tells how many bytes (out of transfer_buffer_length) were
706 * transferred. It will normally be the same as requested, unless
707 * either an error was reported or a short read was performed.
708 * The URB_SHORT_NOT_OK transfer flag may be used to make such
709 * short reads be reported as errors.
710 * @setup_packet: Only used for control transfers, this points to eight bytes
711 * of setup data. Control transfers always start by sending this data
712 * to the device. Then transfer_buffer is read or written, if needed.
713 * @setup_dma: For control transfers with URB_NO_SETUP_DMA_MAP set, the
714 * device driver has provided this DMA address for the setup packet.
715 * The host controller driver should use this in preference to
716 * setup_packet.
717 * @start_frame: Returns the initial frame for isochronous transfers.
718 * @number_of_packets: Lists the number of ISO transfer buffers.
719 * @interval: Specifies the polling interval for interrupt or isochronous
720 * transfers. The units are frames (milliseconds) for for full and low
721 * speed devices, and microframes (1/8 millisecond) for highspeed ones.
722 * @error_count: Returns the number of ISO transfers that reported errors.
723 * @context: For use in completion functions. This normally points to
724 * request-specific driver context.
725 * @complete: Completion handler. This URB is passed as the parameter to the
726 * completion function. The completion function may then do what
727 * it likes with the URB, including resubmitting or freeing it.
728 * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to
729 * collect the transfer status for each buffer.
730 *
731 * This structure identifies USB transfer requests. URBs must be allocated by
732 * calling usb_alloc_urb() and freed with a call to usb_free_urb().
733 * Initialization may be done using various usb_fill_*_urb() functions. URBs
734 * are submitted using usb_submit_urb(), and pending requests may be canceled
735 * using usb_unlink_urb() or usb_kill_urb().
736 *
737 * Data Transfer Buffers:
738 *
739 * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise
740 * taken from the general page pool. That is provided by transfer_buffer
741 * (control requests also use setup_packet), and host controller drivers
742 * perform a dma mapping (and unmapping) for each buffer transferred. Those
743 * mapping operations can be expensive on some platforms (perhaps using a dma
744 * bounce buffer or talking to an IOMMU),
745 * although they're cheap on commodity x86 and ppc hardware.
746 *
747 * Alternatively, drivers may pass the URB_NO_xxx_DMA_MAP transfer flags,
748 * which tell the host controller driver that no such mapping is needed since
749 * the device driver is DMA-aware. For example, a device driver might
750 * allocate a DMA buffer with usb_buffer_alloc() or call usb_buffer_map().
751 * When these transfer flags are provided, host controller drivers will
752 * attempt to use the dma addresses found in the transfer_dma and/or
753 * setup_dma fields rather than determining a dma address themselves. (Note
754 * that transfer_buffer and setup_packet must still be set because not all
755 * host controllers use DMA, nor do virtual root hubs).
756 *
757 * Initialization:
758 *
759 * All URBs submitted must initialize the dev, pipe, transfer_flags (may be
Alan Sternb375a042005-07-29 16:11:07 -0400760 * zero), and complete fields. All URBs must also initialize
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 * transfer_buffer and transfer_buffer_length. They may provide the
762 * URB_SHORT_NOT_OK transfer flag, indicating that short reads are
763 * to be treated as errors; that flag is invalid for write requests.
764 *
765 * Bulk URBs may
766 * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers
767 * should always terminate with a short packet, even if it means adding an
768 * extra zero length packet.
769 *
770 * Control URBs must provide a setup_packet. The setup_packet and
771 * transfer_buffer may each be mapped for DMA or not, independently of
772 * the other. The transfer_flags bits URB_NO_TRANSFER_DMA_MAP and
773 * URB_NO_SETUP_DMA_MAP indicate which buffers have already been mapped.
774 * URB_NO_SETUP_DMA_MAP is ignored for non-control URBs.
775 *
776 * Interrupt URBs must provide an interval, saying how often (in milliseconds
777 * or, for highspeed devices, 125 microsecond units)
778 * to poll for transfers. After the URB has been submitted, the interval
779 * field reflects how the transfer was actually scheduled.
780 * The polling interval may be more frequent than requested.
781 * For example, some controllers have a maximum interval of 32 milliseconds,
782 * while others support intervals of up to 1024 milliseconds.
783 * Isochronous URBs also have transfer intervals. (Note that for isochronous
784 * endpoints, as well as high speed interrupt endpoints, the encoding of
785 * the transfer interval in the endpoint descriptor is logarithmic.
786 * Device drivers must convert that value to linear units themselves.)
787 *
788 * Isochronous URBs normally use the URB_ISO_ASAP transfer flag, telling
789 * the host controller to schedule the transfer as soon as bandwidth
790 * utilization allows, and then set start_frame to reflect the actual frame
791 * selected during submission. Otherwise drivers must specify the start_frame
792 * and handle the case where the transfer can't begin then. However, drivers
793 * won't know how bandwidth is currently allocated, and while they can
794 * find the current frame using usb_get_current_frame_number () they can't
795 * know the range for that frame number. (Ranges for frame counter values
796 * are HC-specific, and can go from 256 to 65536 frames from "now".)
797 *
798 * Isochronous URBs have a different data transfer model, in part because
799 * the quality of service is only "best effort". Callers provide specially
800 * allocated URBs, with number_of_packets worth of iso_frame_desc structures
801 * at the end. Each such packet is an individual ISO transfer. Isochronous
802 * URBs are normally queued, submitted by drivers to arrange that
803 * transfers are at least double buffered, and then explicitly resubmitted
804 * in completion handlers, so
805 * that data (such as audio or video) streams at as constant a rate as the
806 * host controller scheduler can support.
807 *
808 * Completion Callbacks:
809 *
810 * The completion callback is made in_interrupt(), and one of the first
811 * things that a completion handler should do is check the status field.
812 * The status field is provided for all URBs. It is used to report
813 * unlinked URBs, and status for all non-ISO transfers. It should not
814 * be examined before the URB is returned to the completion handler.
815 *
816 * The context field is normally used to link URBs back to the relevant
817 * driver or request state.
818 *
819 * When the completion callback is invoked for non-isochronous URBs, the
820 * actual_length field tells how many bytes were transferred. This field
821 * is updated even when the URB terminated with an error or was unlinked.
822 *
823 * ISO transfer status is reported in the status and actual_length fields
824 * of the iso_frame_desc array, and the number of errors is reported in
825 * error_count. Completion callbacks for ISO transfers will normally
826 * (re)submit URBs to ensure a constant transfer rate.
Roman Kagan719df462005-05-06 00:55:56 +0400827 *
828 * Note that even fields marked "public" should not be touched by the driver
829 * when the urb is owned by the hcd, that is, since the call to
830 * usb_submit_urb() till the entry into the completion routine.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 */
832struct urb
833{
Martin Waitzaeec46b2005-11-13 16:08:13 -0800834 /* private: usb core and host controller only fields in the urb */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 struct kref kref; /* reference count of the URB */
836 spinlock_t lock; /* lock for the URB */
837 void *hcpriv; /* private data for host controller */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838 int bandwidth; /* bandwidth for INT/ISO request */
839 atomic_t use_count; /* concurrent submissions counter */
840 u8 reject; /* submissions will fail */
841
Martin Waitzaeec46b2005-11-13 16:08:13 -0800842 /* public: documented fields in the urb that can be used by drivers */
Alan Sternb724ae72005-10-24 15:36:00 -0400843 struct list_head urb_list; /* list head for use by the urb's
844 * current owner */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 struct usb_device *dev; /* (in) pointer to associated device */
846 unsigned int pipe; /* (in) pipe information */
847 int status; /* (return) non-ISO status */
848 unsigned int transfer_flags; /* (in) URB_SHORT_NOT_OK | ...*/
849 void *transfer_buffer; /* (in) associated data buffer */
850 dma_addr_t transfer_dma; /* (in) dma addr for transfer_buffer */
851 int transfer_buffer_length; /* (in) data buffer length */
852 int actual_length; /* (return) actual transfer length */
853 unsigned char *setup_packet; /* (in) setup packet (control only) */
854 dma_addr_t setup_dma; /* (in) dma addr for setup_packet */
855 int start_frame; /* (modify) start frame (ISO) */
856 int number_of_packets; /* (in) number of ISO packets */
Alan Sternb724ae72005-10-24 15:36:00 -0400857 int interval; /* (modify) transfer interval
858 * (INT/ISO) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 int error_count; /* (return) number of ISO errors */
860 void *context; /* (in) context for completion */
861 usb_complete_t complete; /* (in) completion routine */
Alan Sternb724ae72005-10-24 15:36:00 -0400862 struct usb_iso_packet_descriptor iso_frame_desc[0];
863 /* (in) ISO ONLY */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864};
865
Alan Sternb724ae72005-10-24 15:36:00 -0400866/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867
868/**
869 * usb_fill_control_urb - initializes a control urb
870 * @urb: pointer to the urb to initialize.
871 * @dev: pointer to the struct usb_device for this urb.
872 * @pipe: the endpoint pipe
873 * @setup_packet: pointer to the setup_packet buffer
874 * @transfer_buffer: pointer to the transfer buffer
875 * @buffer_length: length of the transfer buffer
876 * @complete: pointer to the usb_complete_t function
877 * @context: what to set the urb context to.
878 *
879 * Initializes a control urb with the proper information needed to submit
880 * it to a device.
881 */
882static inline void usb_fill_control_urb (struct urb *urb,
883 struct usb_device *dev,
884 unsigned int pipe,
885 unsigned char *setup_packet,
886 void *transfer_buffer,
887 int buffer_length,
888 usb_complete_t complete,
889 void *context)
890{
891 spin_lock_init(&urb->lock);
892 urb->dev = dev;
893 urb->pipe = pipe;
894 urb->setup_packet = setup_packet;
895 urb->transfer_buffer = transfer_buffer;
896 urb->transfer_buffer_length = buffer_length;
897 urb->complete = complete;
898 urb->context = context;
899}
900
901/**
902 * usb_fill_bulk_urb - macro to help initialize a bulk urb
903 * @urb: pointer to the urb to initialize.
904 * @dev: pointer to the struct usb_device for this urb.
905 * @pipe: the endpoint pipe
906 * @transfer_buffer: pointer to the transfer buffer
907 * @buffer_length: length of the transfer buffer
908 * @complete: pointer to the usb_complete_t function
909 * @context: what to set the urb context to.
910 *
911 * Initializes a bulk urb with the proper information needed to submit it
912 * to a device.
913 */
914static inline void usb_fill_bulk_urb (struct urb *urb,
915 struct usb_device *dev,
916 unsigned int pipe,
917 void *transfer_buffer,
918 int buffer_length,
919 usb_complete_t complete,
920 void *context)
921{
922 spin_lock_init(&urb->lock);
923 urb->dev = dev;
924 urb->pipe = pipe;
925 urb->transfer_buffer = transfer_buffer;
926 urb->transfer_buffer_length = buffer_length;
927 urb->complete = complete;
928 urb->context = context;
929}
930
931/**
932 * usb_fill_int_urb - macro to help initialize a interrupt urb
933 * @urb: pointer to the urb to initialize.
934 * @dev: pointer to the struct usb_device for this urb.
935 * @pipe: the endpoint pipe
936 * @transfer_buffer: pointer to the transfer buffer
937 * @buffer_length: length of the transfer buffer
938 * @complete: pointer to the usb_complete_t function
939 * @context: what to set the urb context to.
940 * @interval: what to set the urb interval to, encoded like
941 * the endpoint descriptor's bInterval value.
942 *
943 * Initializes a interrupt urb with the proper information needed to submit
944 * it to a device.
945 * Note that high speed interrupt endpoints use a logarithmic encoding of
946 * the endpoint interval, and express polling intervals in microframes
947 * (eight per millisecond) rather than in frames (one per millisecond).
948 */
949static inline void usb_fill_int_urb (struct urb *urb,
950 struct usb_device *dev,
951 unsigned int pipe,
952 void *transfer_buffer,
953 int buffer_length,
954 usb_complete_t complete,
955 void *context,
956 int interval)
957{
958 spin_lock_init(&urb->lock);
959 urb->dev = dev;
960 urb->pipe = pipe;
961 urb->transfer_buffer = transfer_buffer;
962 urb->transfer_buffer_length = buffer_length;
963 urb->complete = complete;
964 urb->context = context;
965 if (dev->speed == USB_SPEED_HIGH)
966 urb->interval = 1 << (interval - 1);
967 else
968 urb->interval = interval;
969 urb->start_frame = -1;
970}
971
972extern void usb_init_urb(struct urb *urb);
Al Viro55016f12005-10-21 03:21:58 -0400973extern struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974extern void usb_free_urb(struct urb *urb);
975#define usb_put_urb usb_free_urb
976extern struct urb *usb_get_urb(struct urb *urb);
Al Viro55016f12005-10-21 03:21:58 -0400977extern int usb_submit_urb(struct urb *urb, gfp_t mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978extern int usb_unlink_urb(struct urb *urb);
979extern void usb_kill_urb(struct urb *urb);
980
981#define HAVE_USB_BUFFERS
982void *usb_buffer_alloc (struct usb_device *dev, size_t size,
Al Viro55016f12005-10-21 03:21:58 -0400983 gfp_t mem_flags, dma_addr_t *dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984void usb_buffer_free (struct usb_device *dev, size_t size,
985 void *addr, dma_addr_t dma);
986
987#if 0
988struct urb *usb_buffer_map (struct urb *urb);
989void usb_buffer_dmasync (struct urb *urb);
990void usb_buffer_unmap (struct urb *urb);
991#endif
992
993struct scatterlist;
994int usb_buffer_map_sg (struct usb_device *dev, unsigned pipe,
995 struct scatterlist *sg, int nents);
996#if 0
997void usb_buffer_dmasync_sg (struct usb_device *dev, unsigned pipe,
998 struct scatterlist *sg, int n_hw_ents);
999#endif
1000void usb_buffer_unmap_sg (struct usb_device *dev, unsigned pipe,
1001 struct scatterlist *sg, int n_hw_ents);
1002
1003/*-------------------------------------------------------------------*
1004 * SYNCHRONOUS CALL SUPPORT *
1005 *-------------------------------------------------------------------*/
1006
1007extern int usb_control_msg(struct usb_device *dev, unsigned int pipe,
1008 __u8 request, __u8 requesttype, __u16 value, __u16 index,
1009 void *data, __u16 size, int timeout);
1010extern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,
1011 void *data, int len, int *actual_length,
1012 int timeout);
1013
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014/* wrappers around usb_control_msg() for the most common standard requests */
1015extern int usb_get_descriptor(struct usb_device *dev, unsigned char desctype,
1016 unsigned char descindex, void *buf, int size);
1017extern int usb_get_status(struct usb_device *dev,
1018 int type, int target, void *data);
1019extern int usb_get_string(struct usb_device *dev,
1020 unsigned short langid, unsigned char index, void *buf, int size);
1021extern int usb_string(struct usb_device *dev, int index,
1022 char *buf, size_t size);
1023
1024/* wrappers that also update important state inside usbcore */
1025extern int usb_clear_halt(struct usb_device *dev, int pipe);
1026extern int usb_reset_configuration(struct usb_device *dev);
1027extern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate);
1028
1029/*
1030 * timeouts, in milliseconds, used for sending/receiving control messages
1031 * they typically complete within a few frames (msec) after they're issued
1032 * USB identifies 5 second timeouts, maybe more in a few cases, and a few
1033 * slow devices (like some MGE Ellipse UPSes) actually push that limit.
1034 */
1035#define USB_CTRL_GET_TIMEOUT 5000
1036#define USB_CTRL_SET_TIMEOUT 5000
1037
1038
1039/**
1040 * struct usb_sg_request - support for scatter/gather I/O
1041 * @status: zero indicates success, else negative errno
1042 * @bytes: counts bytes transferred.
1043 *
1044 * These requests are initialized using usb_sg_init(), and then are used
1045 * as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most
1046 * members of the request object aren't for driver access.
1047 *
1048 * The status and bytecount values are valid only after usb_sg_wait()
1049 * returns. If the status is zero, then the bytecount matches the total
1050 * from the request.
1051 *
1052 * After an error completion, drivers may need to clear a halt condition
1053 * on the endpoint.
1054 */
1055struct usb_sg_request {
1056 int status;
1057 size_t bytes;
1058
1059 /*
Martin Waitzaeec46b2005-11-13 16:08:13 -08001060 * members below are private: to usbcore,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061 * and are not provided for driver access!
1062 */
1063 spinlock_t lock;
1064
1065 struct usb_device *dev;
1066 int pipe;
1067 struct scatterlist *sg;
1068 int nents;
1069
1070 int entries;
1071 struct urb **urbs;
1072
1073 int count;
1074 struct completion complete;
1075};
1076
1077int usb_sg_init (
1078 struct usb_sg_request *io,
1079 struct usb_device *dev,
1080 unsigned pipe,
1081 unsigned period,
1082 struct scatterlist *sg,
1083 int nents,
1084 size_t length,
Al Viro55016f12005-10-21 03:21:58 -04001085 gfp_t mem_flags
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086);
1087void usb_sg_cancel (struct usb_sg_request *io);
1088void usb_sg_wait (struct usb_sg_request *io);
1089
1090
Alan Sternb724ae72005-10-24 15:36:00 -04001091/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092
1093/*
1094 * For various legacy reasons, Linux has a small cookie that's paired with
1095 * a struct usb_device to identify an endpoint queue. Queue characteristics
1096 * are defined by the endpoint's descriptor. This cookie is called a "pipe",
1097 * an unsigned int encoded as:
1098 *
1099 * - direction: bit 7 (0 = Host-to-Device [Out],
1100 * 1 = Device-to-Host [In] ...
1101 * like endpoint bEndpointAddress)
1102 * - device address: bits 8-14 ... bit positions known to uhci-hcd
1103 * - endpoint: bits 15-18 ... bit positions known to uhci-hcd
1104 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
1105 * 10 = control, 11 = bulk)
1106 *
1107 * Given the device address and endpoint descriptor, pipes are redundant.
1108 */
1109
1110/* NOTE: these are not the standard USB_ENDPOINT_XFER_* values!! */
1111/* (yet ... they're the values used by usbfs) */
1112#define PIPE_ISOCHRONOUS 0
1113#define PIPE_INTERRUPT 1
1114#define PIPE_CONTROL 2
1115#define PIPE_BULK 3
1116
1117#define usb_pipein(pipe) ((pipe) & USB_DIR_IN)
1118#define usb_pipeout(pipe) (!usb_pipein(pipe))
1119
1120#define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
1121#define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
1122
1123#define usb_pipetype(pipe) (((pipe) >> 30) & 3)
1124#define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
1125#define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
1126#define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
1127#define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
1128
1129/* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
1130#define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
1131#define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep)))
Alan Sternb724ae72005-10-24 15:36:00 -04001132#define usb_settoggle(dev, ep, out, bit) \
1133 ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \
1134 ((bit) << (ep)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135
1136
Alan Sternb724ae72005-10-24 15:36:00 -04001137static inline unsigned int __create_pipe(struct usb_device *dev,
1138 unsigned int endpoint)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139{
1140 return (dev->devnum << 8) | (endpoint << 15);
1141}
1142
1143/* Create various pipes... */
Alan Sternb724ae72005-10-24 15:36:00 -04001144#define usb_sndctrlpipe(dev,endpoint) \
1145 ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint))
1146#define usb_rcvctrlpipe(dev,endpoint) \
1147 ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1148#define usb_sndisocpipe(dev,endpoint) \
1149 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint))
1150#define usb_rcvisocpipe(dev,endpoint) \
1151 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1152#define usb_sndbulkpipe(dev,endpoint) \
1153 ((PIPE_BULK << 30) | __create_pipe(dev,endpoint))
1154#define usb_rcvbulkpipe(dev,endpoint) \
1155 ((PIPE_BULK << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1156#define usb_sndintpipe(dev,endpoint) \
1157 ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint))
1158#define usb_rcvintpipe(dev,endpoint) \
1159 ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160
1161/*-------------------------------------------------------------------------*/
1162
1163static inline __u16
1164usb_maxpacket(struct usb_device *udev, int pipe, int is_out)
1165{
1166 struct usb_host_endpoint *ep;
1167 unsigned epnum = usb_pipeendpoint(pipe);
1168
1169 if (is_out) {
1170 WARN_ON(usb_pipein(pipe));
1171 ep = udev->ep_out[epnum];
1172 } else {
1173 WARN_ON(usb_pipeout(pipe));
1174 ep = udev->ep_in[epnum];
1175 }
1176 if (!ep)
1177 return 0;
1178
1179 /* NOTE: only 0x07ff bits are for packet size... */
1180 return le16_to_cpu(ep->desc.wMaxPacketSize);
1181}
1182
Alan Sternb724ae72005-10-24 15:36:00 -04001183/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -07001185/* Events from the usb core */
1186#define USB_DEVICE_ADD 0x0001
1187#define USB_DEVICE_REMOVE 0x0002
1188#define USB_BUS_ADD 0x0003
1189#define USB_BUS_REMOVE 0x0004
1190extern void usb_register_notify(struct notifier_block *nb);
1191extern void usb_unregister_notify(struct notifier_block *nb);
1192
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193#ifdef DEBUG
Alan Sternb724ae72005-10-24 15:36:00 -04001194#define dbg(format, arg...) printk(KERN_DEBUG "%s: " format "\n" , \
1195 __FILE__ , ## arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196#else
1197#define dbg(format, arg...) do {} while (0)
1198#endif
1199
Alan Sternb724ae72005-10-24 15:36:00 -04001200#define err(format, arg...) printk(KERN_ERR "%s: " format "\n" , \
1201 __FILE__ , ## arg)
1202#define info(format, arg...) printk(KERN_INFO "%s: " format "\n" , \
1203 __FILE__ , ## arg)
1204#define warn(format, arg...) printk(KERN_WARNING "%s: " format "\n" , \
1205 __FILE__ , ## arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206
1207
1208#endif /* __KERNEL__ */
1209
1210#endif