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