USB: flush outstanding URBs when suspending
[linux-2.6.git] / include / linux / usb.h
1 #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
8 #define USB_DEVICE_MAJOR                189
9
10
11 #ifdef __KERNEL__
12
13 #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 */
22 #include <linux/mutex.h>        /* for struct mutex */
23
24 struct usb_device;
25 struct 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 struct ep_device;
45
46 /**
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
52  * @ep_dev: ep_device for sysfs info
53  * @extra: descriptors following this endpoint in the configuration
54  * @extralen: how many bytes of "extra" are valid
55  * @enabled: URBs may be submitted to this endpoint
56  *
57  * USB requests are always queued to a given endpoint, identified by a
58  * descriptor within an active interface in a given USB configuration.
59  */
60 struct usb_host_endpoint {
61         struct usb_endpoint_descriptor  desc;
62         struct list_head                urb_list;
63         void                            *hcpriv;
64         struct ep_device                *ep_dev;        /* For sysfs info */
65
66         unsigned char *extra;   /* Extra descriptors */
67         int extralen;
68         int enabled;
69 };
70
71 /* host-side wrapper for one interface setting's parsed descriptors */
72 struct usb_host_interface {
73         struct usb_interface_descriptor desc;
74
75         /* array of desc.bNumEndpoint endpoints associated with this
76          * interface setting.  these will be in no particular order.
77          */
78         struct usb_host_endpoint *endpoint;
79
80         char *string;           /* iInterface string, if present */
81         unsigned char *extra;   /* Extra descriptors */
82         int extralen;
83 };
84
85 enum usb_interface_condition {
86         USB_INTERFACE_UNBOUND = 0,
87         USB_INTERFACE_BINDING,
88         USB_INTERFACE_BOUND,
89         USB_INTERFACE_UNBINDING,
90 };
91
92 /**
93  * struct usb_interface - what usb device drivers talk to
94  * @altsetting: array of interface structures, one for each alternate
95  *      setting that may be selected.  Each one includes a set of
96  *      endpoint configurations.  They will be in no particular order.
97  * @num_altsetting: number of altsettings defined.
98  * @cur_altsetting: the current altsetting.
99  * @intf_assoc: interface association descriptor
100  * @driver: the USB driver that is bound to this interface.
101  * @minor: the minor number assigned to this interface, if this
102  *      interface is bound to a driver that uses the USB major number.
103  *      If this interface does not use the USB major, this field should
104  *      be unused.  The driver should set this value in the probe()
105  *      function of the driver, after it has been assigned a minor
106  *      number from the USB core by calling usb_register_dev().
107  * @condition: binding state of the interface: not bound, binding
108  *      (in probe()), bound to a driver, or unbinding (in disconnect())
109  * @is_active: flag set when the interface is bound and not suspended.
110  * @needs_remote_wakeup: flag set when the driver requires remote-wakeup
111  *      capability during autosuspend.
112  * @dev: driver model's view of this device
113  * @usb_dev: if an interface is bound to the USB major, this will point
114  *      to the sysfs representation for that device.
115  * @pm_usage_cnt: PM usage counter for this interface; autosuspend is not
116  *      allowed unless the counter is 0.
117  *
118  * USB device drivers attach to interfaces on a physical device.  Each
119  * interface encapsulates a single high level function, such as feeding
120  * an audio stream to a speaker or reporting a change in a volume control.
121  * Many USB devices only have one interface.  The protocol used to talk to
122  * an interface's endpoints can be defined in a usb "class" specification,
123  * or by a product's vendor.  The (default) control endpoint is part of
124  * every interface, but is never listed among the interface's descriptors.
125  *
126  * The driver that is bound to the interface can use standard driver model
127  * calls such as dev_get_drvdata() on the dev member of this structure.
128  *
129  * Each interface may have alternate settings.  The initial configuration
130  * of a device sets altsetting 0, but the device driver can change
131  * that setting using usb_set_interface().  Alternate settings are often
132  * used to control the use of periodic endpoints, such as by having
133  * different endpoints use different amounts of reserved USB bandwidth.
134  * All standards-conformant USB devices that use isochronous endpoints
135  * will use them in non-default settings.
136  *
137  * The USB specification says that alternate setting numbers must run from
138  * 0 to one less than the total number of alternate settings.  But some
139  * devices manage to mess this up, and the structures aren't necessarily
140  * stored in numerical order anyhow.  Use usb_altnum_to_altsetting() to
141  * look up an alternate setting in the altsetting array based on its number.
142  */
143 struct usb_interface {
144         /* array of alternate settings for this interface,
145          * stored in no particular order */
146         struct usb_host_interface *altsetting;
147
148         struct usb_host_interface *cur_altsetting;      /* the currently
149                                          * active alternate setting */
150         unsigned num_altsetting;        /* number of alternate settings */
151
152         /* If there is an interface association descriptor then it will list
153          * the associated interfaces */
154         struct usb_interface_assoc_descriptor *intf_assoc;
155
156         int minor;                      /* minor number this interface is
157                                          * bound to */
158         enum usb_interface_condition condition;         /* state of binding */
159         unsigned is_active:1;           /* the interface is not suspended */
160         unsigned needs_remote_wakeup:1; /* driver requires remote wakeup */
161
162         struct device dev;              /* interface specific device info */
163         struct device *usb_dev;         /* pointer to the usb class's device, if any */
164         int pm_usage_cnt;               /* usage counter for autosuspend */
165 };
166 #define to_usb_interface(d) container_of(d, struct usb_interface, dev)
167 #define interface_to_usbdev(intf) \
168         container_of(intf->dev.parent, struct usb_device, dev)
169
170 static inline void *usb_get_intfdata (struct usb_interface *intf)
171 {
172         return dev_get_drvdata (&intf->dev);
173 }
174
175 static inline void usb_set_intfdata (struct usb_interface *intf, void *data)
176 {
177         dev_set_drvdata(&intf->dev, data);
178 }
179
180 struct usb_interface *usb_get_intf(struct usb_interface *intf);
181 void usb_put_intf(struct usb_interface *intf);
182
183 /* this maximum is arbitrary */
184 #define USB_MAXINTERFACES       32
185 #define USB_MAXIADS             USB_MAXINTERFACES/2
186
187 /**
188  * struct usb_interface_cache - long-term representation of a device interface
189  * @num_altsetting: number of altsettings defined.
190  * @ref: reference counter.
191  * @altsetting: variable-length array of interface structures, one for
192  *      each alternate setting that may be selected.  Each one includes a
193  *      set of endpoint configurations.  They will be in no particular order.
194  *
195  * These structures persist for the lifetime of a usb_device, unlike
196  * struct usb_interface (which persists only as long as its configuration
197  * is installed).  The altsetting arrays can be accessed through these
198  * structures at any time, permitting comparison of configurations and
199  * providing support for the /proc/bus/usb/devices pseudo-file.
200  */
201 struct usb_interface_cache {
202         unsigned num_altsetting;        /* number of alternate settings */
203         struct kref ref;                /* reference counter */
204
205         /* variable-length array of alternate settings for this interface,
206          * stored in no particular order */
207         struct usb_host_interface altsetting[0];
208 };
209 #define ref_to_usb_interface_cache(r) \
210                 container_of(r, struct usb_interface_cache, ref)
211 #define altsetting_to_usb_interface_cache(a) \
212                 container_of(a, struct usb_interface_cache, altsetting[0])
213
214 /**
215  * struct usb_host_config - representation of a device's configuration
216  * @desc: the device's configuration descriptor.
217  * @string: pointer to the cached version of the iConfiguration string, if
218  *      present for this configuration.
219  * @intf_assoc: list of any interface association descriptors in this config
220  * @interface: array of pointers to usb_interface structures, one for each
221  *      interface in the configuration.  The number of interfaces is stored
222  *      in desc.bNumInterfaces.  These pointers are valid only while the
223  *      the configuration is active.
224  * @intf_cache: array of pointers to usb_interface_cache structures, one
225  *      for each interface in the configuration.  These structures exist
226  *      for the entire life of the device.
227  * @extra: pointer to buffer containing all extra descriptors associated
228  *      with this configuration (those preceding the first interface
229  *      descriptor).
230  * @extralen: length of the extra descriptors buffer.
231  *
232  * USB devices may have multiple configurations, but only one can be active
233  * at any time.  Each encapsulates a different operational environment;
234  * for example, a dual-speed device would have separate configurations for
235  * full-speed and high-speed operation.  The number of configurations
236  * available is stored in the device descriptor as bNumConfigurations.
237  *
238  * A configuration can contain multiple interfaces.  Each corresponds to
239  * a different function of the USB device, and all are available whenever
240  * the configuration is active.  The USB standard says that interfaces
241  * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot
242  * of devices get this wrong.  In addition, the interface array is not
243  * guaranteed to be sorted in numerical order.  Use usb_ifnum_to_if() to
244  * look up an interface entry based on its number.
245  *
246  * Device drivers should not attempt to activate configurations.  The choice
247  * of which configuration to install is a policy decision based on such
248  * considerations as available power, functionality provided, and the user's
249  * desires (expressed through userspace tools).  However, drivers can call
250  * usb_reset_configuration() to reinitialize the current configuration and
251  * all its interfaces.
252  */
253 struct usb_host_config {
254         struct usb_config_descriptor    desc;
255
256         char *string;           /* iConfiguration string, if present */
257
258         /* List of any Interface Association Descriptors in this
259          * configuration. */
260         struct usb_interface_assoc_descriptor *intf_assoc[USB_MAXIADS];
261
262         /* the interfaces associated with this configuration,
263          * stored in no particular order */
264         struct usb_interface *interface[USB_MAXINTERFACES];
265
266         /* Interface information available even when this is not the
267          * active configuration */
268         struct usb_interface_cache *intf_cache[USB_MAXINTERFACES];
269
270         unsigned char *extra;   /* Extra descriptors */
271         int extralen;
272 };
273
274 int __usb_get_extra_descriptor(char *buffer, unsigned size,
275         unsigned char type, void **ptr);
276 #define usb_get_extra_descriptor(ifpoint,type,ptr)\
277         __usb_get_extra_descriptor((ifpoint)->extra,(ifpoint)->extralen,\
278                 type,(void**)ptr)
279
280 /* ----------------------------------------------------------------------- */
281
282 /* USB device number allocation bitmap */
283 struct usb_devmap {
284         unsigned long devicemap[128 / (8*sizeof(unsigned long))];
285 };
286
287 /*
288  * Allocated per bus (tree of devices) we have:
289  */
290 struct usb_bus {
291         struct device *controller;      /* host/master side hardware */
292         int busnum;                     /* Bus number (in order of reg) */
293         char *bus_name;                 /* stable id (PCI slot_name etc) */
294         u8 uses_dma;                    /* Does the host controller use DMA? */
295         u8 otg_port;                    /* 0, or number of OTG/HNP port */
296         unsigned is_b_host:1;           /* true during some HNP roleswitches */
297         unsigned b_hnp_enable:1;        /* OTG: did A-Host enable HNP? */
298
299         int devnum_next;                /* Next open device number in
300                                          * round-robin allocation */
301
302         struct usb_devmap devmap;       /* device address allocation map */
303         struct usb_device *root_hub;    /* Root hub */
304         struct list_head bus_list;      /* list of busses */
305
306         int bandwidth_allocated;        /* on this bus: how much of the time
307                                          * reserved for periodic (intr/iso)
308                                          * requests is used, on average?
309                                          * Units: microseconds/frame.
310                                          * Limits: Full/low speed reserve 90%,
311                                          * while high speed reserves 80%.
312                                          */
313         int bandwidth_int_reqs;         /* number of Interrupt requests */
314         int bandwidth_isoc_reqs;        /* number of Isoc. requests */
315
316 #ifdef CONFIG_USB_DEVICEFS
317         struct dentry *usbfs_dentry;    /* usbfs dentry entry for the bus */
318 #endif
319         struct class_device *class_dev; /* class device for this bus */
320
321 #if defined(CONFIG_USB_MON)
322         struct mon_bus *mon_bus;        /* non-null when associated */
323         int monitored;                  /* non-zero when monitored */
324 #endif
325 };
326
327 /* ----------------------------------------------------------------------- */
328
329 /* This is arbitrary.
330  * From USB 2.0 spec Table 11-13, offset 7, a hub can
331  * have up to 255 ports. The most yet reported is 10.
332  *
333  * Current Wireless USB host hardware (Intel i1480 for example) allows
334  * up to 22 devices to connect. Upcoming hardware might raise that
335  * limit. Because the arrays need to add a bit for hub status data, we
336  * do 31, so plus one evens out to four bytes.
337  */
338 #define USB_MAXCHILDREN         (31)
339
340 struct usb_tt;
341
342 /*
343  * struct usb_device - kernel's representation of a USB device
344  *
345  * FIXME: Write the kerneldoc!
346  *
347  * Usbcore drivers should not set usbdev->state directly.  Instead use
348  * usb_set_device_state().
349  *
350  * @authorized: (user space) policy determines if we authorize this
351  *              device to be used or not. By default, wired USB
352  *              devices are authorized. WUSB devices are not, until we
353  *              authorize them from user space. FIXME -- complete doc
354  */
355 struct usb_device {
356         int             devnum;         /* Address on USB bus */
357         char            devpath [16];   /* Use in messages: /port/port/... */
358         enum usb_device_state   state;  /* configured, not attached, etc */
359         enum usb_device_speed   speed;  /* high/full/low (or error) */
360
361         struct usb_tt   *tt;            /* low/full speed dev, highspeed hub */
362         int             ttport;         /* device port on that tt hub */
363
364         unsigned int toggle[2];         /* one bit for each endpoint
365                                          * ([0] = IN, [1] = OUT) */
366
367         struct usb_device *parent;      /* our hub, unless we're the root */
368         struct usb_bus *bus;            /* Bus we're part of */
369         struct usb_host_endpoint ep0;
370
371         struct device dev;              /* Generic device interface */
372
373         struct usb_device_descriptor descriptor;/* Descriptor */
374         struct usb_host_config *config; /* All of the configs */
375
376         struct usb_host_config *actconfig;/* the active configuration */
377         struct usb_host_endpoint *ep_in[16];
378         struct usb_host_endpoint *ep_out[16];
379
380         char **rawdescriptors;          /* Raw descriptors for each config */
381
382         unsigned short bus_mA;          /* Current available from the bus */
383         u8 portnum;                     /* Parent port number (origin 1) */
384         u8 level;                       /* Number of USB hub ancestors */
385
386         unsigned can_submit:1;          /* URBs may be submitted */
387         unsigned discon_suspended:1;    /* Disconnected while suspended */
388         unsigned have_langid:1;         /* whether string_langid is valid */
389         unsigned authorized:1;          /* Policy has determined we can use it */
390         unsigned wusb:1;                /* Device is Wireless USB */
391         int string_langid;              /* language ID for strings */
392
393         /* static strings from the device */
394         char *product;                  /* iProduct string, if present */
395         char *manufacturer;             /* iManufacturer string, if present */
396         char *serial;                   /* iSerialNumber string, if present */
397
398         struct list_head filelist;
399 #ifdef CONFIG_USB_DEVICE_CLASS
400         struct device *usb_classdev;
401 #endif
402 #ifdef CONFIG_USB_DEVICEFS
403         struct dentry *usbfs_dentry;    /* usbfs dentry entry for the device */
404 #endif
405         /*
406          * Child devices - these can be either new devices
407          * (if this is a hub device), or different instances
408          * of this same device.
409          *
410          * Each instance needs its own set of data structures.
411          */
412
413         int maxchild;                   /* Number of ports if hub */
414         struct usb_device *children[USB_MAXCHILDREN];
415
416         int pm_usage_cnt;               /* usage counter for autosuspend */
417         u32 quirks;                     /* quirks of the whole device */
418
419 #ifdef CONFIG_PM
420         struct delayed_work autosuspend; /* for delayed autosuspends */
421         struct mutex pm_mutex;          /* protects PM operations */
422
423         unsigned long last_busy;        /* time of last use */
424         int autosuspend_delay;          /* in jiffies */
425
426         unsigned auto_pm:1;             /* autosuspend/resume in progress */
427         unsigned do_remote_wakeup:1;    /* remote wakeup should be enabled */
428         unsigned reset_resume:1;        /* needs reset instead of resume */
429         unsigned persist_enabled:1;     /* USB_PERSIST enabled for this dev */
430         unsigned autosuspend_disabled:1; /* autosuspend and autoresume */
431         unsigned autoresume_disabled:1;  /*  disabled by the user */
432 #endif
433 };
434 #define to_usb_device(d) container_of(d, struct usb_device, dev)
435
436 extern struct usb_device *usb_get_dev(struct usb_device *dev);
437 extern void usb_put_dev(struct usb_device *dev);
438
439 /* USB device locking */
440 #define usb_lock_device(udev)           down(&(udev)->dev.sem)
441 #define usb_unlock_device(udev)         up(&(udev)->dev.sem)
442 #define usb_trylock_device(udev)        down_trylock(&(udev)->dev.sem)
443 extern int usb_lock_device_for_reset(struct usb_device *udev,
444                                      const struct usb_interface *iface);
445
446 /* USB port reset for device reinitialization */
447 extern int usb_reset_device(struct usb_device *dev);
448 extern int usb_reset_composite_device(struct usb_device *dev,
449                 struct usb_interface *iface);
450
451 extern struct usb_device *usb_find_device(u16 vendor_id, u16 product_id);
452
453 /* USB autosuspend and autoresume */
454 #ifdef CONFIG_USB_SUSPEND
455 extern int usb_autopm_set_interface(struct usb_interface *intf);
456 extern int usb_autopm_get_interface(struct usb_interface *intf);
457 extern void usb_autopm_put_interface(struct usb_interface *intf);
458
459 static inline void usb_autopm_enable(struct usb_interface *intf)
460 {
461         intf->pm_usage_cnt = 0;
462         usb_autopm_set_interface(intf);
463 }
464
465 static inline void usb_autopm_disable(struct usb_interface *intf)
466 {
467         intf->pm_usage_cnt = 1;
468         usb_autopm_set_interface(intf);
469 }
470
471 static inline void usb_mark_last_busy(struct usb_device *udev)
472 {
473         udev->last_busy = jiffies;
474 }
475
476 #else
477
478 static inline int usb_autopm_set_interface(struct usb_interface *intf)
479 { return 0; }
480
481 static inline int usb_autopm_get_interface(struct usb_interface *intf)
482 { return 0; }
483
484 static inline void usb_autopm_put_interface(struct usb_interface *intf)
485 { }
486 static inline void usb_autopm_enable(struct usb_interface *intf)
487 { }
488 static inline void usb_autopm_disable(struct usb_interface *intf)
489 { }
490 static inline void usb_mark_last_busy(struct usb_device *udev)
491 { }
492 #endif
493
494 /*-------------------------------------------------------------------------*/
495
496 /* for drivers using iso endpoints */
497 extern int usb_get_current_frame_number (struct usb_device *usb_dev);
498
499 /* used these for multi-interface device registration */
500 extern int usb_driver_claim_interface(struct usb_driver *driver,
501                         struct usb_interface *iface, void* priv);
502
503 /**
504  * usb_interface_claimed - returns true iff an interface is claimed
505  * @iface: the interface being checked
506  *
507  * Returns true (nonzero) iff the interface is claimed, else false (zero).
508  * Callers must own the driver model's usb bus readlock.  So driver
509  * probe() entries don't need extra locking, but other call contexts
510  * may need to explicitly claim that lock.
511  *
512  */
513 static inline int usb_interface_claimed(struct usb_interface *iface) {
514         return (iface->dev.driver != NULL);
515 }
516
517 extern void usb_driver_release_interface(struct usb_driver *driver,
518                         struct usb_interface *iface);
519 const struct usb_device_id *usb_match_id(struct usb_interface *interface,
520                                          const struct usb_device_id *id);
521 extern int usb_match_one_id(struct usb_interface *interface,
522                             const struct usb_device_id *id);
523
524 extern struct usb_interface *usb_find_interface(struct usb_driver *drv,
525                 int minor);
526 extern struct usb_interface *usb_ifnum_to_if(const struct usb_device *dev,
527                 unsigned ifnum);
528 extern struct usb_host_interface *usb_altnum_to_altsetting(
529                 const struct usb_interface *intf, unsigned int altnum);
530
531
532 /**
533  * usb_make_path - returns stable device path in the usb tree
534  * @dev: the device whose path is being constructed
535  * @buf: where to put the string
536  * @size: how big is "buf"?
537  *
538  * Returns length of the string (> 0) or negative if size was too small.
539  *
540  * This identifier is intended to be "stable", reflecting physical paths in
541  * hardware such as physical bus addresses for host controllers or ports on
542  * USB hubs.  That makes it stay the same until systems are physically
543  * reconfigured, by re-cabling a tree of USB devices or by moving USB host
544  * controllers.  Adding and removing devices, including virtual root hubs
545  * in host controller driver modules, does not change these path identifers;
546  * neither does rebooting or re-enumerating.  These are more useful identifiers
547  * than changeable ("unstable") ones like bus numbers or device addresses.
548  *
549  * With a partial exception for devices connected to USB 2.0 root hubs, these
550  * identifiers are also predictable.  So long as the device tree isn't changed,
551  * plugging any USB device into a given hub port always gives it the same path.
552  * Because of the use of "companion" controllers, devices connected to ports on
553  * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are
554  * high speed, and a different one if they are full or low speed.
555  */
556 static inline int usb_make_path (struct usb_device *dev, char *buf,
557                 size_t size)
558 {
559         int actual;
560         actual = snprintf (buf, size, "usb-%s-%s", dev->bus->bus_name,
561                         dev->devpath);
562         return (actual >= (int)size) ? -1 : actual;
563 }
564
565 /*-------------------------------------------------------------------------*/
566
567 /**
568  * usb_endpoint_num - get the endpoint's number
569  * @epd: endpoint to be checked
570  *
571  * Returns @epd's number: 0 to 15.
572  */
573 static inline int usb_endpoint_num(const struct usb_endpoint_descriptor *epd)
574 {
575         return epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
576 }
577
578 /**
579  * usb_endpoint_type - get the endpoint's transfer type
580  * @epd: endpoint to be checked
581  *
582  * Returns one of USB_ENDPOINT_XFER_{CONTROL, ISOC, BULK, INT} according
583  * to @epd's transfer type.
584  */
585 static inline int usb_endpoint_type(const struct usb_endpoint_descriptor *epd)
586 {
587         return epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
588 }
589
590 /**
591  * usb_endpoint_dir_in - check if the endpoint has IN direction
592  * @epd: endpoint to be checked
593  *
594  * Returns true if the endpoint is of type IN, otherwise it returns false.
595  */
596 static inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor *epd)
597 {
598         return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN);
599 }
600
601 /**
602  * usb_endpoint_dir_out - check if the endpoint has OUT direction
603  * @epd: endpoint to be checked
604  *
605  * Returns true if the endpoint is of type OUT, otherwise it returns false.
606  */
607 static inline int usb_endpoint_dir_out(const struct usb_endpoint_descriptor *epd)
608 {
609         return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT);
610 }
611
612 /**
613  * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type
614  * @epd: endpoint to be checked
615  *
616  * Returns true if the endpoint is of type bulk, otherwise it returns false.
617  */
618 static inline int usb_endpoint_xfer_bulk(const struct usb_endpoint_descriptor *epd)
619 {
620         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
621                 USB_ENDPOINT_XFER_BULK);
622 }
623
624 /**
625  * usb_endpoint_xfer_control - check if the endpoint has control transfer type
626  * @epd: endpoint to be checked
627  *
628  * Returns true if the endpoint is of type control, otherwise it returns false.
629  */
630 static inline int usb_endpoint_xfer_control(const struct usb_endpoint_descriptor *epd)
631 {
632         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
633                 USB_ENDPOINT_XFER_CONTROL);
634 }
635
636 /**
637  * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type
638  * @epd: endpoint to be checked
639  *
640  * Returns true if the endpoint is of type interrupt, otherwise it returns
641  * false.
642  */
643 static inline int usb_endpoint_xfer_int(const struct usb_endpoint_descriptor *epd)
644 {
645         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
646                 USB_ENDPOINT_XFER_INT);
647 }
648
649 /**
650  * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type
651  * @epd: endpoint to be checked
652  *
653  * Returns true if the endpoint is of type isochronous, otherwise it returns
654  * false.
655  */
656 static inline int usb_endpoint_xfer_isoc(const struct usb_endpoint_descriptor *epd)
657 {
658         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
659                 USB_ENDPOINT_XFER_ISOC);
660 }
661
662 /**
663  * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN
664  * @epd: endpoint to be checked
665  *
666  * Returns true if the endpoint has bulk transfer type and IN direction,
667  * otherwise it returns false.
668  */
669 static inline int usb_endpoint_is_bulk_in(const struct usb_endpoint_descriptor *epd)
670 {
671         return (usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_in(epd));
672 }
673
674 /**
675  * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT
676  * @epd: endpoint to be checked
677  *
678  * Returns true if the endpoint has bulk transfer type and OUT direction,
679  * otherwise it returns false.
680  */
681 static inline int usb_endpoint_is_bulk_out(const struct usb_endpoint_descriptor *epd)
682 {
683         return (usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_out(epd));
684 }
685
686 /**
687  * usb_endpoint_is_int_in - check if the endpoint is interrupt IN
688  * @epd: endpoint to be checked
689  *
690  * Returns true if the endpoint has interrupt transfer type and IN direction,
691  * otherwise it returns false.
692  */
693 static inline int usb_endpoint_is_int_in(const struct usb_endpoint_descriptor *epd)
694 {
695         return (usb_endpoint_xfer_int(epd) && usb_endpoint_dir_in(epd));
696 }
697
698 /**
699  * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT
700  * @epd: endpoint to be checked
701  *
702  * Returns true if the endpoint has interrupt transfer type and OUT direction,
703  * otherwise it returns false.
704  */
705 static inline int usb_endpoint_is_int_out(const struct usb_endpoint_descriptor *epd)
706 {
707         return (usb_endpoint_xfer_int(epd) && usb_endpoint_dir_out(epd));
708 }
709
710 /**
711  * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN
712  * @epd: endpoint to be checked
713  *
714  * Returns true if the endpoint has isochronous transfer type and IN direction,
715  * otherwise it returns false.
716  */
717 static inline int usb_endpoint_is_isoc_in(const struct usb_endpoint_descriptor *epd)
718 {
719         return (usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_in(epd));
720 }
721
722 /**
723  * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT
724  * @epd: endpoint to be checked
725  *
726  * Returns true if the endpoint has isochronous transfer type and OUT direction,
727  * otherwise it returns false.
728  */
729 static inline int usb_endpoint_is_isoc_out(const struct usb_endpoint_descriptor *epd)
730 {
731         return (usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_out(epd));
732 }
733
734 /*-------------------------------------------------------------------------*/
735
736 #define USB_DEVICE_ID_MATCH_DEVICE \
737                 (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
738 #define USB_DEVICE_ID_MATCH_DEV_RANGE \
739                 (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI)
740 #define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
741                 (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE)
742 #define USB_DEVICE_ID_MATCH_DEV_INFO \
743                 (USB_DEVICE_ID_MATCH_DEV_CLASS | \
744                 USB_DEVICE_ID_MATCH_DEV_SUBCLASS | \
745                 USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
746 #define USB_DEVICE_ID_MATCH_INT_INFO \
747                 (USB_DEVICE_ID_MATCH_INT_CLASS | \
748                 USB_DEVICE_ID_MATCH_INT_SUBCLASS | \
749                 USB_DEVICE_ID_MATCH_INT_PROTOCOL)
750
751 /**
752  * USB_DEVICE - macro used to describe a specific usb device
753  * @vend: the 16 bit USB Vendor ID
754  * @prod: the 16 bit USB Product ID
755  *
756  * This macro is used to create a struct usb_device_id that matches a
757  * specific device.
758  */
759 #define USB_DEVICE(vend,prod) \
760         .match_flags = USB_DEVICE_ID_MATCH_DEVICE, .idVendor = (vend), \
761                         .idProduct = (prod)
762 /**
763  * USB_DEVICE_VER - macro used to describe a specific usb device with a
764  *              version range
765  * @vend: the 16 bit USB Vendor ID
766  * @prod: the 16 bit USB Product ID
767  * @lo: the bcdDevice_lo value
768  * @hi: the bcdDevice_hi value
769  *
770  * This macro is used to create a struct usb_device_id that matches a
771  * specific device, with a version range.
772  */
773 #define USB_DEVICE_VER(vend,prod,lo,hi) \
774         .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, \
775         .idVendor = (vend), .idProduct = (prod), \
776         .bcdDevice_lo = (lo), .bcdDevice_hi = (hi)
777
778 /**
779  * USB_DEVICE_INTERFACE_PROTOCOL - macro used to describe a usb
780  *              device with a specific interface protocol
781  * @vend: the 16 bit USB Vendor ID
782  * @prod: the 16 bit USB Product ID
783  * @pr: bInterfaceProtocol value
784  *
785  * This macro is used to create a struct usb_device_id that matches a
786  * specific interface protocol of devices.
787  */
788 #define USB_DEVICE_INTERFACE_PROTOCOL(vend,prod,pr) \
789         .match_flags = USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_INT_PROTOCOL, \
790         .idVendor = (vend), \
791         .idProduct = (prod), \
792         .bInterfaceProtocol = (pr)
793
794 /**
795  * USB_DEVICE_INFO - macro used to describe a class of usb devices
796  * @cl: bDeviceClass value
797  * @sc: bDeviceSubClass value
798  * @pr: bDeviceProtocol value
799  *
800  * This macro is used to create a struct usb_device_id that matches a
801  * specific class of devices.
802  */
803 #define USB_DEVICE_INFO(cl,sc,pr) \
804         .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, .bDeviceClass = (cl), \
805         .bDeviceSubClass = (sc), .bDeviceProtocol = (pr)
806
807 /**
808  * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces 
809  * @cl: bInterfaceClass value
810  * @sc: bInterfaceSubClass value
811  * @pr: bInterfaceProtocol value
812  *
813  * This macro is used to create a struct usb_device_id that matches a
814  * specific class of interfaces.
815  */
816 #define USB_INTERFACE_INFO(cl,sc,pr) \
817         .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, .bInterfaceClass = (cl), \
818         .bInterfaceSubClass = (sc), .bInterfaceProtocol = (pr)
819
820 /**
821  * USB_DEVICE_AND_INTERFACE_INFO - macro used to describe a specific usb device
822  *              with a class of usb interfaces
823  * @vend: the 16 bit USB Vendor ID
824  * @prod: the 16 bit USB Product ID
825  * @cl: bInterfaceClass value
826  * @sc: bInterfaceSubClass value
827  * @pr: bInterfaceProtocol value
828  *
829  * This macro is used to create a struct usb_device_id that matches a
830  * specific device with a specific class of interfaces.
831  *
832  * This is especially useful when explicitly matching devices that have
833  * vendor specific bDeviceClass values, but standards-compliant interfaces.
834  */
835 #define USB_DEVICE_AND_INTERFACE_INFO(vend,prod,cl,sc,pr) \
836         .match_flags = USB_DEVICE_ID_MATCH_INT_INFO \
837                 | USB_DEVICE_ID_MATCH_DEVICE, \
838         .idVendor = (vend), .idProduct = (prod), \
839         .bInterfaceClass = (cl), \
840         .bInterfaceSubClass = (sc), .bInterfaceProtocol = (pr)
841
842 /* ----------------------------------------------------------------------- */
843
844 /* Stuff for dynamic usb ids */
845 struct usb_dynids {
846         spinlock_t lock;
847         struct list_head list;
848 };
849
850 struct usb_dynid {
851         struct list_head node;
852         struct usb_device_id id;
853 };
854
855 extern ssize_t usb_store_new_id(struct usb_dynids *dynids,
856                                 struct device_driver *driver,
857                                 const char *buf, size_t count);
858
859 /**
860  * struct usbdrv_wrap - wrapper for driver-model structure
861  * @driver: The driver-model core driver structure.
862  * @for_devices: Non-zero for device drivers, 0 for interface drivers.
863  */
864 struct usbdrv_wrap {
865         struct device_driver driver;
866         int for_devices;
867 };
868
869 /**
870  * struct usb_driver - identifies USB interface driver to usbcore
871  * @name: The driver name should be unique among USB drivers,
872  *      and should normally be the same as the module name.
873  * @probe: Called to see if the driver is willing to manage a particular
874  *      interface on a device.  If it is, probe returns zero and uses
875  *      dev_set_drvdata() to associate driver-specific data with the
876  *      interface.  It may also use usb_set_interface() to specify the
877  *      appropriate altsetting.  If unwilling to manage the interface,
878  *      return a negative errno value.
879  * @disconnect: Called when the interface is no longer accessible, usually
880  *      because its device has been (or is being) disconnected or the
881  *      driver module is being unloaded.
882  * @ioctl: Used for drivers that want to talk to userspace through
883  *      the "usbfs" filesystem.  This lets devices provide ways to
884  *      expose information to user space regardless of where they
885  *      do (or don't) show up otherwise in the filesystem.
886  * @suspend: Called when the device is going to be suspended by the system.
887  * @resume: Called when the device is being resumed by the system.
888  * @reset_resume: Called when the suspended device has been reset instead
889  *      of being resumed.
890  * @pre_reset: Called by usb_reset_composite_device() when the device
891  *      is about to be reset.
892  * @post_reset: Called by usb_reset_composite_device() after the device
893  *      has been reset, or in lieu of @resume following a reset-resume
894  *      (i.e., the device is reset instead of being resumed, as might
895  *      happen if power was lost).  The second argument tells which is
896  *      the reason.
897  * @id_table: USB drivers use ID table to support hotplugging.
898  *      Export this with MODULE_DEVICE_TABLE(usb,...).  This must be set
899  *      or your driver's probe function will never get called.
900  * @dynids: used internally to hold the list of dynamically added device
901  *      ids for this driver.
902  * @drvwrap: Driver-model core structure wrapper.
903  * @no_dynamic_id: if set to 1, the USB core will not allow dynamic ids to be
904  *      added to this driver by preventing the sysfs file from being created.
905  * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
906  *      for interfaces bound to this driver.
907  *
908  * USB interface drivers must provide a name, probe() and disconnect()
909  * methods, and an id_table.  Other driver fields are optional.
910  *
911  * The id_table is used in hotplugging.  It holds a set of descriptors,
912  * and specialized data may be associated with each entry.  That table
913  * is used by both user and kernel mode hotplugging support.
914  *
915  * The probe() and disconnect() methods are called in a context where
916  * they can sleep, but they should avoid abusing the privilege.  Most
917  * work to connect to a device should be done when the device is opened,
918  * and undone at the last close.  The disconnect code needs to address
919  * concurrency issues with respect to open() and close() methods, as
920  * well as forcing all pending I/O requests to complete (by unlinking
921  * them as necessary, and blocking until the unlinks complete).
922  */
923 struct usb_driver {
924         const char *name;
925
926         int (*probe) (struct usb_interface *intf,
927                       const struct usb_device_id *id);
928
929         void (*disconnect) (struct usb_interface *intf);
930
931         int (*ioctl) (struct usb_interface *intf, unsigned int code,
932                         void *buf);
933
934         int (*suspend) (struct usb_interface *intf, pm_message_t message);
935         int (*resume) (struct usb_interface *intf);
936         int (*reset_resume)(struct usb_interface *intf);
937
938         int (*pre_reset)(struct usb_interface *intf);
939         int (*post_reset)(struct usb_interface *intf);
940
941         const struct usb_device_id *id_table;
942
943         struct usb_dynids dynids;
944         struct usbdrv_wrap drvwrap;
945         unsigned int no_dynamic_id:1;
946         unsigned int supports_autosuspend:1;
947 };
948 #define to_usb_driver(d) container_of(d, struct usb_driver, drvwrap.driver)
949
950 /**
951  * struct usb_device_driver - identifies USB device driver to usbcore
952  * @name: The driver name should be unique among USB drivers,
953  *      and should normally be the same as the module name.
954  * @probe: Called to see if the driver is willing to manage a particular
955  *      device.  If it is, probe returns zero and uses dev_set_drvdata()
956  *      to associate driver-specific data with the device.  If unwilling
957  *      to manage the device, return a negative errno value.
958  * @disconnect: Called when the device is no longer accessible, usually
959  *      because it has been (or is being) disconnected or the driver's
960  *      module is being unloaded.
961  * @suspend: Called when the device is going to be suspended by the system.
962  * @resume: Called when the device is being resumed by the system.
963  * @drvwrap: Driver-model core structure wrapper.
964  * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
965  *      for devices bound to this driver.
966  *
967  * USB drivers must provide all the fields listed above except drvwrap.
968  */
969 struct usb_device_driver {
970         const char *name;
971
972         int (*probe) (struct usb_device *udev);
973         void (*disconnect) (struct usb_device *udev);
974
975         int (*suspend) (struct usb_device *udev, pm_message_t message);
976         int (*resume) (struct usb_device *udev);
977         struct usbdrv_wrap drvwrap;
978         unsigned int supports_autosuspend:1;
979 };
980 #define to_usb_device_driver(d) container_of(d, struct usb_device_driver, \
981                 drvwrap.driver)
982
983 extern struct bus_type usb_bus_type;
984
985 /**
986  * struct usb_class_driver - identifies a USB driver that wants to use the USB major number
987  * @name: the usb class device name for this driver.  Will show up in sysfs.
988  * @fops: pointer to the struct file_operations of this driver.
989  * @minor_base: the start of the minor range for this driver.
990  *
991  * This structure is used for the usb_register_dev() and
992  * usb_unregister_dev() functions, to consolidate a number of the
993  * parameters used for them.
994  */
995 struct usb_class_driver {
996         char *name;
997         const struct file_operations *fops;
998         int minor_base;
999 };
1000
1001 /*
1002  * use these in module_init()/module_exit()
1003  * and don't forget MODULE_DEVICE_TABLE(usb, ...)
1004  */
1005 extern int usb_register_driver(struct usb_driver *, struct module *,
1006                                const char *);
1007 static inline int usb_register(struct usb_driver *driver)
1008 {
1009         return usb_register_driver(driver, THIS_MODULE, KBUILD_MODNAME);
1010 }
1011 extern void usb_deregister(struct usb_driver *);
1012
1013 extern int usb_register_device_driver(struct usb_device_driver *,
1014                         struct module *);
1015 extern void usb_deregister_device_driver(struct usb_device_driver *);
1016
1017 extern int usb_register_dev(struct usb_interface *intf,
1018                             struct usb_class_driver *class_driver);
1019 extern void usb_deregister_dev(struct usb_interface *intf,
1020                                struct usb_class_driver *class_driver);
1021
1022 extern int usb_disabled(void);
1023
1024 /* ----------------------------------------------------------------------- */
1025
1026 /*
1027  * URB support, for asynchronous request completions
1028  */
1029
1030 /*
1031  * urb->transfer_flags:
1032  *
1033  * Note: URB_DIR_IN/OUT is automatically set in usb_submit_urb().
1034  */
1035 #define URB_SHORT_NOT_OK        0x0001  /* report short reads as errors */
1036 #define URB_ISO_ASAP            0x0002  /* iso-only, urb->start_frame
1037                                          * ignored */
1038 #define URB_NO_TRANSFER_DMA_MAP 0x0004  /* urb->transfer_dma valid on submit */
1039 #define URB_NO_SETUP_DMA_MAP    0x0008  /* urb->setup_dma valid on submit */
1040 #define URB_NO_FSBR             0x0020  /* UHCI-specific */
1041 #define URB_ZERO_PACKET         0x0040  /* Finish bulk OUT with short packet */
1042 #define URB_NO_INTERRUPT        0x0080  /* HINT: no non-error interrupt
1043                                          * needed */
1044 #define URB_FREE_BUFFER         0x0100  /* Free transfer buffer with the URB */
1045
1046 #define URB_DIR_IN              0x0200  /* Transfer from device to host */
1047 #define URB_DIR_OUT             0
1048 #define URB_DIR_MASK            URB_DIR_IN
1049
1050 struct usb_iso_packet_descriptor {
1051         unsigned int offset;
1052         unsigned int length;            /* expected length */
1053         unsigned int actual_length;
1054         int status;
1055 };
1056
1057 struct urb;
1058
1059 struct usb_anchor {
1060         struct list_head urb_list;
1061         wait_queue_head_t wait;
1062         spinlock_t lock;
1063 };
1064
1065 static inline void init_usb_anchor(struct usb_anchor *anchor)
1066 {
1067         INIT_LIST_HEAD(&anchor->urb_list);
1068         init_waitqueue_head(&anchor->wait);
1069         spin_lock_init(&anchor->lock);
1070 }
1071
1072 typedef void (*usb_complete_t)(struct urb *);
1073
1074 /**
1075  * struct urb - USB Request Block
1076  * @urb_list: For use by current owner of the URB.
1077  * @anchor_list: membership in the list of an anchor
1078  * @anchor: to anchor URBs to a common mooring
1079  * @ep: Points to the endpoint's data structure.  Will eventually
1080  *      replace @pipe.
1081  * @pipe: Holds endpoint number, direction, type, and more.
1082  *      Create these values with the eight macros available;
1083  *      usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl"
1084  *      (control), "bulk", "int" (interrupt), or "iso" (isochronous).
1085  *      For example usb_sndbulkpipe() or usb_rcvintpipe().  Endpoint
1086  *      numbers range from zero to fifteen.  Note that "in" endpoint two
1087  *      is a different endpoint (and pipe) from "out" endpoint two.
1088  *      The current configuration controls the existence, type, and
1089  *      maximum packet size of any given endpoint.
1090  * @dev: Identifies the USB device to perform the request.
1091  * @status: This is read in non-iso completion functions to get the
1092  *      status of the particular request.  ISO requests only use it
1093  *      to tell whether the URB was unlinked; detailed status for
1094  *      each frame is in the fields of the iso_frame-desc.
1095  * @transfer_flags: A variety of flags may be used to affect how URB
1096  *      submission, unlinking, or operation are handled.  Different
1097  *      kinds of URB can use different flags.
1098  * @transfer_buffer:  This identifies the buffer to (or from) which
1099  *      the I/O request will be performed (unless URB_NO_TRANSFER_DMA_MAP
1100  *      is set).  This buffer must be suitable for DMA; allocate it with
1101  *      kmalloc() or equivalent.  For transfers to "in" endpoints, contents
1102  *      of this buffer will be modified.  This buffer is used for the data
1103  *      stage of control transfers.
1104  * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP,
1105  *      the device driver is saying that it provided this DMA address,
1106  *      which the host controller driver should use in preference to the
1107  *      transfer_buffer.
1108  * @transfer_buffer_length: How big is transfer_buffer.  The transfer may
1109  *      be broken up into chunks according to the current maximum packet
1110  *      size for the endpoint, which is a function of the configuration
1111  *      and is encoded in the pipe.  When the length is zero, neither
1112  *      transfer_buffer nor transfer_dma is used.
1113  * @actual_length: This is read in non-iso completion functions, and
1114  *      it tells how many bytes (out of transfer_buffer_length) were
1115  *      transferred.  It will normally be the same as requested, unless
1116  *      either an error was reported or a short read was performed.
1117  *      The URB_SHORT_NOT_OK transfer flag may be used to make such
1118  *      short reads be reported as errors. 
1119  * @setup_packet: Only used for control transfers, this points to eight bytes
1120  *      of setup data.  Control transfers always start by sending this data
1121  *      to the device.  Then transfer_buffer is read or written, if needed.
1122  * @setup_dma: For control transfers with URB_NO_SETUP_DMA_MAP set, the
1123  *      device driver has provided this DMA address for the setup packet.
1124  *      The host controller driver should use this in preference to
1125  *      setup_packet.
1126  * @start_frame: Returns the initial frame for isochronous transfers.
1127  * @number_of_packets: Lists the number of ISO transfer buffers.
1128  * @interval: Specifies the polling interval for interrupt or isochronous
1129  *      transfers.  The units are frames (milliseconds) for for full and low
1130  *      speed devices, and microframes (1/8 millisecond) for highspeed ones.
1131  * @error_count: Returns the number of ISO transfers that reported errors.
1132  * @context: For use in completion functions.  This normally points to
1133  *      request-specific driver context.
1134  * @complete: Completion handler. This URB is passed as the parameter to the
1135  *      completion function.  The completion function may then do what
1136  *      it likes with the URB, including resubmitting or freeing it.
1137  * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to 
1138  *      collect the transfer status for each buffer.
1139  *
1140  * This structure identifies USB transfer requests.  URBs must be allocated by
1141  * calling usb_alloc_urb() and freed with a call to usb_free_urb().
1142  * Initialization may be done using various usb_fill_*_urb() functions.  URBs
1143  * are submitted using usb_submit_urb(), and pending requests may be canceled
1144  * using usb_unlink_urb() or usb_kill_urb().
1145  *
1146  * Data Transfer Buffers:
1147  *
1148  * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise
1149  * taken from the general page pool.  That is provided by transfer_buffer
1150  * (control requests also use setup_packet), and host controller drivers
1151  * perform a dma mapping (and unmapping) for each buffer transferred.  Those
1152  * mapping operations can be expensive on some platforms (perhaps using a dma
1153  * bounce buffer or talking to an IOMMU),
1154  * although they're cheap on commodity x86 and ppc hardware.
1155  *
1156  * Alternatively, drivers may pass the URB_NO_xxx_DMA_MAP transfer flags,
1157  * which tell the host controller driver that no such mapping is needed since
1158  * the device driver is DMA-aware.  For example, a device driver might
1159  * allocate a DMA buffer with usb_buffer_alloc() or call usb_buffer_map().
1160  * When these transfer flags are provided, host controller drivers will
1161  * attempt to use the dma addresses found in the transfer_dma and/or
1162  * setup_dma fields rather than determining a dma address themselves.  (Note
1163  * that transfer_buffer and setup_packet must still be set because not all
1164  * host controllers use DMA, nor do virtual root hubs).
1165  *
1166  * Initialization:
1167  *
1168  * All URBs submitted must initialize the dev, pipe, transfer_flags (may be
1169  * zero), and complete fields.  All URBs must also initialize
1170  * transfer_buffer and transfer_buffer_length.  They may provide the
1171  * URB_SHORT_NOT_OK transfer flag, indicating that short reads are
1172  * to be treated as errors; that flag is invalid for write requests.
1173  *
1174  * Bulk URBs may
1175  * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers
1176  * should always terminate with a short packet, even if it means adding an
1177  * extra zero length packet.
1178  *
1179  * Control URBs must provide a setup_packet.  The setup_packet and
1180  * transfer_buffer may each be mapped for DMA or not, independently of
1181  * the other.  The transfer_flags bits URB_NO_TRANSFER_DMA_MAP and
1182  * URB_NO_SETUP_DMA_MAP indicate which buffers have already been mapped.
1183  * URB_NO_SETUP_DMA_MAP is ignored for non-control URBs.
1184  *
1185  * Interrupt URBs must provide an interval, saying how often (in milliseconds
1186  * or, for highspeed devices, 125 microsecond units)
1187  * to poll for transfers.  After the URB has been submitted, the interval
1188  * field reflects how the transfer was actually scheduled.
1189  * The polling interval may be more frequent than requested.
1190  * For example, some controllers have a maximum interval of 32 milliseconds,
1191  * while others support intervals of up to 1024 milliseconds.
1192  * Isochronous URBs also have transfer intervals.  (Note that for isochronous
1193  * endpoints, as well as high speed interrupt endpoints, the encoding of
1194  * the transfer interval in the endpoint descriptor is logarithmic.
1195  * Device drivers must convert that value to linear units themselves.)
1196  *
1197  * Isochronous URBs normally use the URB_ISO_ASAP transfer flag, telling
1198  * the host controller to schedule the transfer as soon as bandwidth
1199  * utilization allows, and then set start_frame to reflect the actual frame
1200  * selected during submission.  Otherwise drivers must specify the start_frame
1201  * and handle the case where the transfer can't begin then.  However, drivers
1202  * won't know how bandwidth is currently allocated, and while they can
1203  * find the current frame using usb_get_current_frame_number () they can't
1204  * know the range for that frame number.  (Ranges for frame counter values
1205  * are HC-specific, and can go from 256 to 65536 frames from "now".)
1206  *
1207  * Isochronous URBs have a different data transfer model, in part because
1208  * the quality of service is only "best effort".  Callers provide specially
1209  * allocated URBs, with number_of_packets worth of iso_frame_desc structures
1210  * at the end.  Each such packet is an individual ISO transfer.  Isochronous
1211  * URBs are normally queued, submitted by drivers to arrange that
1212  * transfers are at least double buffered, and then explicitly resubmitted
1213  * in completion handlers, so
1214  * that data (such as audio or video) streams at as constant a rate as the
1215  * host controller scheduler can support.
1216  *
1217  * Completion Callbacks:
1218  *
1219  * The completion callback is made in_interrupt(), and one of the first
1220  * things that a completion handler should do is check the status field.
1221  * The status field is provided for all URBs.  It is used to report
1222  * unlinked URBs, and status for all non-ISO transfers.  It should not
1223  * be examined before the URB is returned to the completion handler.
1224  *
1225  * The context field is normally used to link URBs back to the relevant
1226  * driver or request state.
1227  *
1228  * When the completion callback is invoked for non-isochronous URBs, the
1229  * actual_length field tells how many bytes were transferred.  This field
1230  * is updated even when the URB terminated with an error or was unlinked.
1231  *
1232  * ISO transfer status is reported in the status and actual_length fields
1233  * of the iso_frame_desc array, and the number of errors is reported in
1234  * error_count.  Completion callbacks for ISO transfers will normally
1235  * (re)submit URBs to ensure a constant transfer rate.
1236  *
1237  * Note that even fields marked "public" should not be touched by the driver
1238  * when the urb is owned by the hcd, that is, since the call to
1239  * usb_submit_urb() till the entry into the completion routine.
1240  */
1241 struct urb
1242 {
1243         /* private: usb core and host controller only fields in the urb */
1244         struct kref kref;               /* reference count of the URB */
1245         void *hcpriv;                   /* private data for host controller */
1246         atomic_t use_count;             /* concurrent submissions counter */
1247         u8 reject;                      /* submissions will fail */
1248         int unlinked;                   /* unlink error code */
1249
1250         /* public: documented fields in the urb that can be used by drivers */
1251         struct list_head urb_list;      /* list head for use by the urb's
1252                                          * current owner */
1253         struct list_head anchor_list;   /* the URB may be anchored by the driver */
1254         struct usb_anchor *anchor;
1255         struct usb_device *dev;         /* (in) pointer to associated device */
1256         struct usb_host_endpoint *ep;   /* (internal) pointer to endpoint struct */
1257         unsigned int pipe;              /* (in) pipe information */
1258         int status;                     /* (return) non-ISO status */
1259         unsigned int transfer_flags;    /* (in) URB_SHORT_NOT_OK | ...*/
1260         void *transfer_buffer;          /* (in) associated data buffer */
1261         dma_addr_t transfer_dma;        /* (in) dma addr for transfer_buffer */
1262         int transfer_buffer_length;     /* (in) data buffer length */
1263         int actual_length;              /* (return) actual transfer length */
1264         unsigned char *setup_packet;    /* (in) setup packet (control only) */
1265         dma_addr_t setup_dma;           /* (in) dma addr for setup_packet */
1266         int start_frame;                /* (modify) start frame (ISO) */
1267         int number_of_packets;          /* (in) number of ISO packets */
1268         int interval;                   /* (modify) transfer interval
1269                                          * (INT/ISO) */
1270         int error_count;                /* (return) number of ISO errors */
1271         void *context;                  /* (in) context for completion */
1272         usb_complete_t complete;        /* (in) completion routine */
1273         struct usb_iso_packet_descriptor iso_frame_desc[0];
1274                                         /* (in) ISO ONLY */
1275 };
1276
1277 /* ----------------------------------------------------------------------- */
1278
1279 /**
1280  * usb_fill_control_urb - initializes a control urb
1281  * @urb: pointer to the urb to initialize.
1282  * @dev: pointer to the struct usb_device for this urb.
1283  * @pipe: the endpoint pipe
1284  * @setup_packet: pointer to the setup_packet buffer
1285  * @transfer_buffer: pointer to the transfer buffer
1286  * @buffer_length: length of the transfer buffer
1287  * @complete_fn: pointer to the usb_complete_t function
1288  * @context: what to set the urb context to.
1289  *
1290  * Initializes a control urb with the proper information needed to submit
1291  * it to a device.
1292  */
1293 static inline void usb_fill_control_urb (struct urb *urb,
1294                                          struct usb_device *dev,
1295                                          unsigned int pipe,
1296                                          unsigned char *setup_packet,
1297                                          void *transfer_buffer,
1298                                          int buffer_length,
1299                                          usb_complete_t complete_fn,
1300                                          void *context)
1301 {
1302         urb->dev = dev;
1303         urb->pipe = pipe;
1304         urb->setup_packet = setup_packet;
1305         urb->transfer_buffer = transfer_buffer;
1306         urb->transfer_buffer_length = buffer_length;
1307         urb->complete = complete_fn;
1308         urb->context = context;
1309 }
1310
1311 /**
1312  * usb_fill_bulk_urb - macro to help initialize a bulk urb
1313  * @urb: pointer to the urb to initialize.
1314  * @dev: pointer to the struct usb_device for this urb.
1315  * @pipe: the endpoint pipe
1316  * @transfer_buffer: pointer to the transfer buffer
1317  * @buffer_length: length of the transfer buffer
1318  * @complete_fn: pointer to the usb_complete_t function
1319  * @context: what to set the urb context to.
1320  *
1321  * Initializes a bulk urb with the proper information needed to submit it
1322  * to a device.
1323  */
1324 static inline void usb_fill_bulk_urb (struct urb *urb,
1325                                       struct usb_device *dev,
1326                                       unsigned int pipe,
1327                                       void *transfer_buffer,
1328                                       int buffer_length,
1329                                       usb_complete_t complete_fn,
1330                                       void *context)
1331 {
1332         urb->dev = dev;
1333         urb->pipe = pipe;
1334         urb->transfer_buffer = transfer_buffer;
1335         urb->transfer_buffer_length = buffer_length;
1336         urb->complete = complete_fn;
1337         urb->context = context;
1338 }
1339
1340 /**
1341  * usb_fill_int_urb - macro to help initialize a interrupt urb
1342  * @urb: pointer to the urb to initialize.
1343  * @dev: pointer to the struct usb_device for this urb.
1344  * @pipe: the endpoint pipe
1345  * @transfer_buffer: pointer to the transfer buffer
1346  * @buffer_length: length of the transfer buffer
1347  * @complete_fn: pointer to the usb_complete_t function
1348  * @context: what to set the urb context to.
1349  * @interval: what to set the urb interval to, encoded like
1350  *      the endpoint descriptor's bInterval value.
1351  *
1352  * Initializes a interrupt urb with the proper information needed to submit
1353  * it to a device.
1354  * Note that high speed interrupt endpoints use a logarithmic encoding of
1355  * the endpoint interval, and express polling intervals in microframes
1356  * (eight per millisecond) rather than in frames (one per millisecond).
1357  */
1358 static inline void usb_fill_int_urb (struct urb *urb,
1359                                      struct usb_device *dev,
1360                                      unsigned int pipe,
1361                                      void *transfer_buffer,
1362                                      int buffer_length,
1363                                      usb_complete_t complete_fn,
1364                                      void *context,
1365                                      int interval)
1366 {
1367         urb->dev = dev;
1368         urb->pipe = pipe;
1369         urb->transfer_buffer = transfer_buffer;
1370         urb->transfer_buffer_length = buffer_length;
1371         urb->complete = complete_fn;
1372         urb->context = context;
1373         if (dev->speed == USB_SPEED_HIGH)
1374                 urb->interval = 1 << (interval - 1);
1375         else
1376                 urb->interval = interval;
1377         urb->start_frame = -1;
1378 }
1379
1380 extern void usb_init_urb(struct urb *urb);
1381 extern struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags);
1382 extern void usb_free_urb(struct urb *urb);
1383 #define usb_put_urb usb_free_urb
1384 extern struct urb *usb_get_urb(struct urb *urb);
1385 extern int usb_submit_urb(struct urb *urb, gfp_t mem_flags);
1386 extern int usb_unlink_urb(struct urb *urb);
1387 extern void usb_kill_urb(struct urb *urb);
1388 extern void usb_kill_anchored_urbs(struct usb_anchor *anchor);
1389 extern void usb_anchor_urb(struct urb *urb, struct usb_anchor *anchor);
1390 extern void usb_unanchor_urb(struct urb *urb);
1391 extern int usb_wait_anchor_empty_timeout(struct usb_anchor *anchor,
1392                                          unsigned int timeout);
1393
1394 /**
1395  * usb_urb_dir_in - check if an URB describes an IN transfer
1396  * @urb: URB to be checked
1397  *
1398  * Returns 1 if @urb describes an IN transfer (device-to-host),
1399  * otherwise 0.
1400  */
1401 static inline int usb_urb_dir_in(struct urb *urb)
1402 {
1403         return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_IN;
1404 }
1405
1406 /**
1407  * usb_urb_dir_out - check if an URB describes an OUT transfer
1408  * @urb: URB to be checked
1409  *
1410  * Returns 1 if @urb describes an OUT transfer (host-to-device),
1411  * otherwise 0.
1412  */
1413 static inline int usb_urb_dir_out(struct urb *urb)
1414 {
1415         return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_OUT;
1416 }
1417
1418 void *usb_buffer_alloc (struct usb_device *dev, size_t size,
1419         gfp_t mem_flags, dma_addr_t *dma);
1420 void usb_buffer_free (struct usb_device *dev, size_t size,
1421         void *addr, dma_addr_t dma);
1422
1423 #if 0
1424 struct urb *usb_buffer_map (struct urb *urb);
1425 void usb_buffer_dmasync (struct urb *urb);
1426 void usb_buffer_unmap (struct urb *urb);
1427 #endif
1428
1429 struct scatterlist;
1430 int usb_buffer_map_sg(const struct usb_device *dev, int is_in,
1431                       struct scatterlist *sg, int nents);
1432 #if 0
1433 void usb_buffer_dmasync_sg(const struct usb_device *dev, int is_in,
1434                            struct scatterlist *sg, int n_hw_ents);
1435 #endif
1436 void usb_buffer_unmap_sg(const struct usb_device *dev, int is_in,
1437                          struct scatterlist *sg, int n_hw_ents);
1438
1439 /*-------------------------------------------------------------------*
1440  *                         SYNCHRONOUS CALL SUPPORT                  *
1441  *-------------------------------------------------------------------*/
1442
1443 extern int usb_control_msg(struct usb_device *dev, unsigned int pipe,
1444         __u8 request, __u8 requesttype, __u16 value, __u16 index,
1445         void *data, __u16 size, int timeout);
1446 extern int usb_interrupt_msg(struct usb_device *usb_dev, unsigned int pipe,
1447         void *data, int len, int *actual_length, int timeout);
1448 extern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,
1449         void *data, int len, int *actual_length,
1450         int timeout);
1451
1452 /* wrappers around usb_control_msg() for the most common standard requests */
1453 extern int usb_get_descriptor(struct usb_device *dev, unsigned char desctype,
1454         unsigned char descindex, void *buf, int size);
1455 extern int usb_get_status(struct usb_device *dev,
1456         int type, int target, void *data);
1457 extern int usb_string(struct usb_device *dev, int index,
1458         char *buf, size_t size);
1459
1460 /* wrappers that also update important state inside usbcore */
1461 extern int usb_clear_halt(struct usb_device *dev, int pipe);
1462 extern int usb_reset_configuration(struct usb_device *dev);
1463 extern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate);
1464
1465 /* this request isn't really synchronous, but it belongs with the others */
1466 extern int usb_driver_set_configuration(struct usb_device *udev, int config);
1467
1468 /*
1469  * timeouts, in milliseconds, used for sending/receiving control messages
1470  * they typically complete within a few frames (msec) after they're issued
1471  * USB identifies 5 second timeouts, maybe more in a few cases, and a few
1472  * slow devices (like some MGE Ellipse UPSes) actually push that limit.
1473  */
1474 #define USB_CTRL_GET_TIMEOUT    5000
1475 #define USB_CTRL_SET_TIMEOUT    5000
1476
1477
1478 /**
1479  * struct usb_sg_request - support for scatter/gather I/O
1480  * @status: zero indicates success, else negative errno
1481  * @bytes: counts bytes transferred.
1482  *
1483  * These requests are initialized using usb_sg_init(), and then are used
1484  * as request handles passed to usb_sg_wait() or usb_sg_cancel().  Most
1485  * members of the request object aren't for driver access.
1486  *
1487  * The status and bytecount values are valid only after usb_sg_wait()
1488  * returns.  If the status is zero, then the bytecount matches the total
1489  * from the request.
1490  *
1491  * After an error completion, drivers may need to clear a halt condition
1492  * on the endpoint.
1493  */
1494 struct usb_sg_request {
1495         int                     status;
1496         size_t                  bytes;
1497
1498         /* 
1499          * members below are private: to usbcore,
1500          * and are not provided for driver access!
1501          */
1502         spinlock_t              lock;
1503
1504         struct usb_device       *dev;
1505         int                     pipe;
1506         struct scatterlist      *sg;
1507         int                     nents;
1508
1509         int                     entries;
1510         struct urb              **urbs;
1511
1512         int                     count;
1513         struct completion       complete;
1514 };
1515
1516 int usb_sg_init (
1517         struct usb_sg_request   *io,
1518         struct usb_device       *dev,
1519         unsigned                pipe, 
1520         unsigned                period,
1521         struct scatterlist      *sg,
1522         int                     nents,
1523         size_t                  length,
1524         gfp_t                   mem_flags
1525 );
1526 void usb_sg_cancel (struct usb_sg_request *io);
1527 void usb_sg_wait (struct usb_sg_request *io);
1528
1529
1530 /* ----------------------------------------------------------------------- */
1531
1532 /*
1533  * For various legacy reasons, Linux has a small cookie that's paired with
1534  * a struct usb_device to identify an endpoint queue.  Queue characteristics
1535  * are defined by the endpoint's descriptor.  This cookie is called a "pipe",
1536  * an unsigned int encoded as:
1537  *
1538  *  - direction:        bit 7           (0 = Host-to-Device [Out],
1539  *                                       1 = Device-to-Host [In] ...
1540  *                                      like endpoint bEndpointAddress)
1541  *  - device address:   bits 8-14       ... bit positions known to uhci-hcd
1542  *  - endpoint:         bits 15-18      ... bit positions known to uhci-hcd
1543  *  - pipe type:        bits 30-31      (00 = isochronous, 01 = interrupt,
1544  *                                       10 = control, 11 = bulk)
1545  *
1546  * Given the device address and endpoint descriptor, pipes are redundant.
1547  */
1548
1549 /* NOTE:  these are not the standard USB_ENDPOINT_XFER_* values!! */
1550 /* (yet ... they're the values used by usbfs) */
1551 #define PIPE_ISOCHRONOUS                0
1552 #define PIPE_INTERRUPT                  1
1553 #define PIPE_CONTROL                    2
1554 #define PIPE_BULK                       3
1555
1556 #define usb_pipein(pipe)        ((pipe) & USB_DIR_IN)
1557 #define usb_pipeout(pipe)       (!usb_pipein(pipe))
1558
1559 #define usb_pipedevice(pipe)    (((pipe) >> 8) & 0x7f)
1560 #define usb_pipeendpoint(pipe)  (((pipe) >> 15) & 0xf)
1561
1562 #define usb_pipetype(pipe)      (((pipe) >> 30) & 3)
1563 #define usb_pipeisoc(pipe)      (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
1564 #define usb_pipeint(pipe)       (usb_pipetype((pipe)) == PIPE_INTERRUPT)
1565 #define usb_pipecontrol(pipe)   (usb_pipetype((pipe)) == PIPE_CONTROL)
1566 #define usb_pipebulk(pipe)      (usb_pipetype((pipe)) == PIPE_BULK)
1567
1568 /* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
1569 #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
1570 #define usb_dotoggle(dev, ep, out)  ((dev)->toggle[out] ^= (1 << (ep)))
1571 #define usb_settoggle(dev, ep, out, bit) \
1572                 ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \
1573                  ((bit) << (ep)))
1574
1575
1576 static inline unsigned int __create_pipe(struct usb_device *dev,
1577                 unsigned int endpoint)
1578 {
1579         return (dev->devnum << 8) | (endpoint << 15);
1580 }
1581
1582 /* Create various pipes... */
1583 #define usb_sndctrlpipe(dev,endpoint)   \
1584         ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint))
1585 #define usb_rcvctrlpipe(dev,endpoint)   \
1586         ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1587 #define usb_sndisocpipe(dev,endpoint)   \
1588         ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint))
1589 #define usb_rcvisocpipe(dev,endpoint)   \
1590         ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1591 #define usb_sndbulkpipe(dev,endpoint)   \
1592         ((PIPE_BULK << 30) | __create_pipe(dev,endpoint))
1593 #define usb_rcvbulkpipe(dev,endpoint)   \
1594         ((PIPE_BULK << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1595 #define usb_sndintpipe(dev,endpoint)    \
1596         ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint))
1597 #define usb_rcvintpipe(dev,endpoint)    \
1598         ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1599
1600 /*-------------------------------------------------------------------------*/
1601
1602 static inline __u16
1603 usb_maxpacket(struct usb_device *udev, int pipe, int is_out)
1604 {
1605         struct usb_host_endpoint        *ep;
1606         unsigned                        epnum = usb_pipeendpoint(pipe);
1607
1608         if (is_out) {
1609                 WARN_ON(usb_pipein(pipe));
1610                 ep = udev->ep_out[epnum];
1611         } else {
1612                 WARN_ON(usb_pipeout(pipe));
1613                 ep = udev->ep_in[epnum];
1614         }
1615         if (!ep)
1616                 return 0;
1617
1618         /* NOTE:  only 0x07ff bits are for packet size... */
1619         return le16_to_cpu(ep->desc.wMaxPacketSize);
1620 }
1621
1622 /* ----------------------------------------------------------------------- */
1623
1624 /* Events from the usb core */
1625 #define USB_DEVICE_ADD          0x0001
1626 #define USB_DEVICE_REMOVE       0x0002
1627 #define USB_BUS_ADD             0x0003
1628 #define USB_BUS_REMOVE          0x0004
1629 extern void usb_register_notify(struct notifier_block *nb);
1630 extern void usb_unregister_notify(struct notifier_block *nb);
1631
1632 #ifdef DEBUG
1633 #define dbg(format, arg...) printk(KERN_DEBUG "%s: " format "\n" , \
1634         __FILE__ , ## arg)
1635 #else
1636 #define dbg(format, arg...) do {} while (0)
1637 #endif
1638
1639 #define err(format, arg...) printk(KERN_ERR "%s: " format "\n" , \
1640         __FILE__ , ## arg)
1641 #define info(format, arg...) printk(KERN_INFO "%s: " format "\n" , \
1642         __FILE__ , ## arg)
1643 #define warn(format, arg...) printk(KERN_WARNING "%s: " format "\n" , \
1644         __FILE__ , ## arg)
1645
1646
1647 #endif  /* __KERNEL__ */
1648
1649 #endif