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