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