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