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