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