4 #include <linux/mod_devicetable.h>
5 #include <linux/usb/ch9.h>
8 #define USB_DEVICE_MAJOR 189
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 */
27 /*-------------------------------------------------------------------------*/
30 * Host-side wrappers for standard USB descriptors ... these are parsed
31 * from the data provided by devices. Parsing turns them from a flat
32 * sequence of descriptors into a hierarchy:
34 * - devices have one (usually) or more configs;
35 * - configs have one (often) or more interfaces;
36 * - interfaces have one (usually) or more settings;
37 * - each interface setting has zero or (usually) more endpoints.
39 * And there might be other descriptors mixed in with those.
41 * Devices may also have class-specific or vendor-specific descriptors.
47 * struct usb_host_endpoint - host-side endpoint descriptor and queue
48 * @desc: descriptor for this endpoint, wMaxPacketSize in native byteorder
49 * @urb_list: urbs queued to this endpoint; maintained by usbcore
50 * @hcpriv: for use by HCD; typically holds hardware dma queue head (QH)
51 * with one or more transfer descriptors (TDs) per urb
52 * @ep_dev: ep_device for sysfs info
53 * @extra: descriptors following this endpoint in the configuration
54 * @extralen: how many bytes of "extra" are valid
55 * @enabled: URBs may be submitted to this endpoint
57 * USB requests are always queued to a given endpoint, identified by a
58 * descriptor within an active interface in a given USB configuration.
60 struct usb_host_endpoint {
61 struct usb_endpoint_descriptor desc;
62 struct list_head urb_list;
64 struct ep_device *ep_dev; /* For sysfs info */
66 unsigned char *extra; /* Extra descriptors */
71 /* host-side wrapper for one interface setting's parsed descriptors */
72 struct usb_host_interface {
73 struct usb_interface_descriptor desc;
75 /* array of desc.bNumEndpoint endpoints associated with this
76 * interface setting. these will be in no particular order.
78 struct usb_host_endpoint *endpoint;
80 char *string; /* iInterface string, if present */
81 unsigned char *extra; /* Extra descriptors */
85 enum usb_interface_condition {
86 USB_INTERFACE_UNBOUND = 0,
87 USB_INTERFACE_BINDING,
89 USB_INTERFACE_UNBINDING,
93 * struct usb_interface - what usb device drivers talk to
94 * @altsetting: array of interface structures, one for each alternate
95 * setting that may be selected. Each one includes a set of
96 * endpoint configurations. They will be in no particular order.
97 * @num_altsetting: number of altsettings defined.
98 * @cur_altsetting: the current altsetting.
99 * @intf_assoc: interface association descriptor
100 * @driver: the USB driver that is bound to this interface.
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 * @needs_remote_wakeup: flag set when the driver requires remote-wakeup
111 * capability during autosuspend.
112 * @dev: driver model's view of this device
113 * @usb_dev: if an interface is bound to the USB major, this will point
114 * to the sysfs representation for that device.
115 * @pm_usage_cnt: PM usage counter for this interface; autosuspend is not
116 * allowed unless the counter is 0.
118 * USB device drivers attach to interfaces on a physical device. Each
119 * interface encapsulates a single high level function, such as feeding
120 * an audio stream to a speaker or reporting a change in a volume control.
121 * Many USB devices only have one interface. The protocol used to talk to
122 * an interface's endpoints can be defined in a usb "class" specification,
123 * or by a product's vendor. The (default) control endpoint is part of
124 * every interface, but is never listed among the interface's descriptors.
126 * The driver that is bound to the interface can use standard driver model
127 * calls such as dev_get_drvdata() on the dev member of this structure.
129 * Each interface may have alternate settings. The initial configuration
130 * of a device sets altsetting 0, but the device driver can change
131 * that setting using usb_set_interface(). Alternate settings are often
132 * used to control the use of periodic endpoints, such as by having
133 * different endpoints use different amounts of reserved USB bandwidth.
134 * All standards-conformant USB devices that use isochronous endpoints
135 * will use them in non-default settings.
137 * The USB specification says that alternate setting numbers must run from
138 * 0 to one less than the total number of alternate settings. But some
139 * devices manage to mess this up, and the structures aren't necessarily
140 * stored in numerical order anyhow. Use usb_altnum_to_altsetting() to
141 * look up an alternate setting in the altsetting array based on its number.
143 struct usb_interface {
144 /* array of alternate settings for this interface,
145 * stored in no particular order */
146 struct usb_host_interface *altsetting;
148 struct usb_host_interface *cur_altsetting; /* the currently
149 * active alternate setting */
150 unsigned num_altsetting; /* number of alternate settings */
152 /* If there is an interface association descriptor then it will list
153 * the associated interfaces */
154 struct usb_interface_assoc_descriptor *intf_assoc;
156 int minor; /* minor number this interface is
158 enum usb_interface_condition condition; /* state of binding */
159 unsigned is_active:1; /* the interface is not suspended */
160 unsigned needs_remote_wakeup:1; /* driver requires remote wakeup */
162 struct device dev; /* interface specific device info */
163 struct device *usb_dev; /* pointer to the usb class's device, if any */
164 int pm_usage_cnt; /* usage counter for autosuspend */
166 #define to_usb_interface(d) container_of(d, struct usb_interface, dev)
167 #define interface_to_usbdev(intf) \
168 container_of(intf->dev.parent, struct usb_device, dev)
170 static inline void *usb_get_intfdata (struct usb_interface *intf)
172 return dev_get_drvdata (&intf->dev);
175 static inline void usb_set_intfdata (struct usb_interface *intf, void *data)
177 dev_set_drvdata(&intf->dev, data);
180 struct usb_interface *usb_get_intf(struct usb_interface *intf);
181 void usb_put_intf(struct usb_interface *intf);
183 /* this maximum is arbitrary */
184 #define USB_MAXINTERFACES 32
185 #define USB_MAXIADS USB_MAXINTERFACES/2
188 * struct usb_interface_cache - long-term representation of a device interface
189 * @num_altsetting: number of altsettings defined.
190 * @ref: reference counter.
191 * @altsetting: variable-length array of interface structures, one for
192 * each alternate setting that may be selected. Each one includes a
193 * set of endpoint configurations. They will be in no particular order.
195 * These structures persist for the lifetime of a usb_device, unlike
196 * struct usb_interface (which persists only as long as its configuration
197 * is installed). The altsetting arrays can be accessed through these
198 * structures at any time, permitting comparison of configurations and
199 * providing support for the /proc/bus/usb/devices pseudo-file.
201 struct usb_interface_cache {
202 unsigned num_altsetting; /* number of alternate settings */
203 struct kref ref; /* reference counter */
205 /* variable-length array of alternate settings for this interface,
206 * stored in no particular order */
207 struct usb_host_interface altsetting[0];
209 #define ref_to_usb_interface_cache(r) \
210 container_of(r, struct usb_interface_cache, ref)
211 #define altsetting_to_usb_interface_cache(a) \
212 container_of(a, struct usb_interface_cache, altsetting[0])
215 * struct usb_host_config - representation of a device's configuration
216 * @desc: the device's configuration descriptor.
217 * @string: pointer to the cached version of the iConfiguration string, if
218 * present for this configuration.
219 * @intf_assoc: list of any interface association descriptors in this config
220 * @interface: array of pointers to usb_interface structures, one for each
221 * interface in the configuration. The number of interfaces is stored
222 * in desc.bNumInterfaces. These pointers are valid only while the
223 * the configuration is active.
224 * @intf_cache: array of pointers to usb_interface_cache structures, one
225 * for each interface in the configuration. These structures exist
226 * for the entire life of the device.
227 * @extra: pointer to buffer containing all extra descriptors associated
228 * with this configuration (those preceding the first interface
230 * @extralen: length of the extra descriptors buffer.
232 * USB devices may have multiple configurations, but only one can be active
233 * at any time. Each encapsulates a different operational environment;
234 * for example, a dual-speed device would have separate configurations for
235 * full-speed and high-speed operation. The number of configurations
236 * available is stored in the device descriptor as bNumConfigurations.
238 * A configuration can contain multiple interfaces. Each corresponds to
239 * a different function of the USB device, and all are available whenever
240 * the configuration is active. The USB standard says that interfaces
241 * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot
242 * of devices get this wrong. In addition, the interface array is not
243 * guaranteed to be sorted in numerical order. Use usb_ifnum_to_if() to
244 * look up an interface entry based on its number.
246 * Device drivers should not attempt to activate configurations. The choice
247 * of which configuration to install is a policy decision based on such
248 * considerations as available power, functionality provided, and the user's
249 * desires (expressed through userspace tools). However, drivers can call
250 * usb_reset_configuration() to reinitialize the current configuration and
251 * all its interfaces.
253 struct usb_host_config {
254 struct usb_config_descriptor desc;
256 char *string; /* iConfiguration string, if present */
258 /* List of any Interface Association Descriptors in this
260 struct usb_interface_assoc_descriptor *intf_assoc[USB_MAXIADS];
262 /* the interfaces associated with this configuration,
263 * stored in no particular order */
264 struct usb_interface *interface[USB_MAXINTERFACES];
266 /* Interface information available even when this is not the
267 * active configuration */
268 struct usb_interface_cache *intf_cache[USB_MAXINTERFACES];
270 unsigned char *extra; /* Extra descriptors */
274 int __usb_get_extra_descriptor(char *buffer, unsigned size,
275 unsigned char type, void **ptr);
276 #define usb_get_extra_descriptor(ifpoint,type,ptr)\
277 __usb_get_extra_descriptor((ifpoint)->extra,(ifpoint)->extralen,\
280 /* ----------------------------------------------------------------------- */
282 /* USB device number allocation bitmap */
284 unsigned long devicemap[128 / (8*sizeof(unsigned long))];
288 * Allocated per bus (tree of devices) we have:
291 struct device *controller; /* host/master side hardware */
292 int busnum; /* Bus number (in order of reg) */
293 char *bus_name; /* stable id (PCI slot_name etc) */
294 u8 uses_dma; /* Does the host controller use DMA? */
295 u8 otg_port; /* 0, or number of OTG/HNP port */
296 unsigned is_b_host:1; /* true during some HNP roleswitches */
297 unsigned b_hnp_enable:1; /* OTG: did A-Host enable HNP? */
299 int devnum_next; /* Next open device number in
300 * round-robin allocation */
302 struct usb_devmap devmap; /* device address allocation map */
303 struct usb_device *root_hub; /* Root hub */
304 struct list_head bus_list; /* list of busses */
306 int bandwidth_allocated; /* on this bus: how much of the time
307 * reserved for periodic (intr/iso)
308 * requests is used, on average?
309 * Units: microseconds/frame.
310 * Limits: Full/low speed reserve 90%,
311 * while high speed reserves 80%.
313 int bandwidth_int_reqs; /* number of Interrupt requests */
314 int bandwidth_isoc_reqs; /* number of Isoc. requests */
316 #ifdef CONFIG_USB_DEVICEFS
317 struct dentry *usbfs_dentry; /* usbfs dentry entry for the bus */
319 struct class_device *class_dev; /* class device for this bus */
321 #if defined(CONFIG_USB_MON)
322 struct mon_bus *mon_bus; /* non-null when associated */
323 int monitored; /* non-zero when monitored */
327 /* ----------------------------------------------------------------------- */
329 /* This is arbitrary.
330 * From USB 2.0 spec Table 11-13, offset 7, a hub can
331 * have up to 255 ports. The most yet reported is 10.
333 * Current Wireless USB host hardware (Intel i1480 for example) allows
334 * up to 22 devices to connect. Upcoming hardware might raise that
335 * limit. Because the arrays need to add a bit for hub status data, we
336 * do 31, so plus one evens out to four bytes.
338 #define USB_MAXCHILDREN (31)
343 * struct usb_device - kernel's representation of a USB device
345 * FIXME: Write the kerneldoc!
347 * Usbcore drivers should not set usbdev->state directly. Instead use
348 * usb_set_device_state().
350 * @authorized: (user space) policy determines if we authorize this
351 * device to be used or not. By default, wired USB
352 * devices are authorized. WUSB devices are not, until we
353 * authorize them from user space. FIXME -- complete doc
356 int devnum; /* Address on USB bus */
357 char devpath [16]; /* Use in messages: /port/port/... */
358 enum usb_device_state state; /* configured, not attached, etc */
359 enum usb_device_speed speed; /* high/full/low (or error) */
361 struct usb_tt *tt; /* low/full speed dev, highspeed hub */
362 int ttport; /* device port on that tt hub */
364 unsigned int toggle[2]; /* one bit for each endpoint
365 * ([0] = IN, [1] = OUT) */
367 struct usb_device *parent; /* our hub, unless we're the root */
368 struct usb_bus *bus; /* Bus we're part of */
369 struct usb_host_endpoint ep0;
371 struct device dev; /* Generic device interface */
373 struct usb_device_descriptor descriptor;/* Descriptor */
374 struct usb_host_config *config; /* All of the configs */
376 struct usb_host_config *actconfig;/* the active configuration */
377 struct usb_host_endpoint *ep_in[16];
378 struct usb_host_endpoint *ep_out[16];
380 char **rawdescriptors; /* Raw descriptors for each config */
382 unsigned short bus_mA; /* Current available from the bus */
383 u8 portnum; /* Parent port number (origin 1) */
384 u8 level; /* Number of USB hub ancestors */
386 unsigned discon_suspended:1; /* Disconnected while suspended */
387 unsigned have_langid:1; /* whether string_langid is valid */
388 unsigned authorized:1; /* Policy has determined we can use it */
389 unsigned wusb:1; /* Device is Wireless USB */
390 int string_langid; /* language ID for strings */
392 /* static strings from the device */
393 char *product; /* iProduct string, if present */
394 char *manufacturer; /* iManufacturer string, if present */
395 char *serial; /* iSerialNumber string, if present */
397 struct list_head filelist;
398 #ifdef CONFIG_USB_DEVICE_CLASS
399 struct device *usb_classdev;
401 #ifdef CONFIG_USB_DEVICEFS
402 struct dentry *usbfs_dentry; /* usbfs dentry entry for the device */
405 * Child devices - these can be either new devices
406 * (if this is a hub device), or different instances
407 * of this same device.
409 * Each instance needs its own set of data structures.
412 int maxchild; /* Number of ports if hub */
413 struct usb_device *children[USB_MAXCHILDREN];
415 int pm_usage_cnt; /* usage counter for autosuspend */
416 u32 quirks; /* quirks of the whole device */
419 struct delayed_work autosuspend; /* for delayed autosuspends */
420 struct mutex pm_mutex; /* protects PM operations */
422 unsigned long last_busy; /* time of last use */
423 int autosuspend_delay; /* in jiffies */
425 unsigned auto_pm:1; /* autosuspend/resume in progress */
426 unsigned do_remote_wakeup:1; /* remote wakeup should be enabled */
427 unsigned reset_resume:1; /* needs reset instead of resume */
428 unsigned persist_enabled:1; /* USB_PERSIST enabled for this dev */
429 unsigned autosuspend_disabled:1; /* autosuspend and autoresume */
430 unsigned autoresume_disabled:1; /* disabled by the user */
433 #define to_usb_device(d) container_of(d, struct usb_device, dev)
435 extern struct usb_device *usb_get_dev(struct usb_device *dev);
436 extern void usb_put_dev(struct usb_device *dev);
438 /* USB device locking */
439 #define usb_lock_device(udev) down(&(udev)->dev.sem)
440 #define usb_unlock_device(udev) up(&(udev)->dev.sem)
441 #define usb_trylock_device(udev) down_trylock(&(udev)->dev.sem)
442 extern int usb_lock_device_for_reset(struct usb_device *udev,
443 const struct usb_interface *iface);
445 /* USB port reset for device reinitialization */
446 extern int usb_reset_device(struct usb_device *dev);
447 extern int usb_reset_composite_device(struct usb_device *dev,
448 struct usb_interface *iface);
450 extern struct usb_device *usb_find_device(u16 vendor_id, u16 product_id);
452 /* USB autosuspend and autoresume */
453 #ifdef CONFIG_USB_SUSPEND
454 extern int usb_autopm_set_interface(struct usb_interface *intf);
455 extern int usb_autopm_get_interface(struct usb_interface *intf);
456 extern void usb_autopm_put_interface(struct usb_interface *intf);
458 static inline void usb_autopm_enable(struct usb_interface *intf)
460 intf->pm_usage_cnt = 0;
461 usb_autopm_set_interface(intf);
464 static inline void usb_autopm_disable(struct usb_interface *intf)
466 intf->pm_usage_cnt = 1;
467 usb_autopm_set_interface(intf);
470 static inline void usb_mark_last_busy(struct usb_device *udev)
472 udev->last_busy = jiffies;
477 static inline int usb_autopm_set_interface(struct usb_interface *intf)
480 static inline int usb_autopm_get_interface(struct usb_interface *intf)
483 static inline void usb_autopm_put_interface(struct usb_interface *intf)
485 static inline void usb_autopm_enable(struct usb_interface *intf)
487 static inline void usb_autopm_disable(struct usb_interface *intf)
489 static inline void usb_mark_last_busy(struct usb_device *udev)
493 /*-------------------------------------------------------------------------*/
495 /* for drivers using iso endpoints */
496 extern int usb_get_current_frame_number (struct usb_device *usb_dev);
498 /* used these for multi-interface device registration */
499 extern int usb_driver_claim_interface(struct usb_driver *driver,
500 struct usb_interface *iface, void* priv);
503 * usb_interface_claimed - returns true iff an interface is claimed
504 * @iface: the interface being checked
506 * Returns true (nonzero) iff the interface is claimed, else false (zero).
507 * Callers must own the driver model's usb bus readlock. So driver
508 * probe() entries don't need extra locking, but other call contexts
509 * may need to explicitly claim that lock.
512 static inline int usb_interface_claimed(struct usb_interface *iface) {
513 return (iface->dev.driver != NULL);
516 extern void usb_driver_release_interface(struct usb_driver *driver,
517 struct usb_interface *iface);
518 const struct usb_device_id *usb_match_id(struct usb_interface *interface,
519 const struct usb_device_id *id);
520 extern int usb_match_one_id(struct usb_interface *interface,
521 const struct usb_device_id *id);
523 extern struct usb_interface *usb_find_interface(struct usb_driver *drv,
525 extern struct usb_interface *usb_ifnum_to_if(const struct usb_device *dev,
527 extern struct usb_host_interface *usb_altnum_to_altsetting(
528 const struct usb_interface *intf, unsigned int altnum);
532 * usb_make_path - returns stable device path in the usb tree
533 * @dev: the device whose path is being constructed
534 * @buf: where to put the string
535 * @size: how big is "buf"?
537 * Returns length of the string (> 0) or negative if size was too small.
539 * This identifier is intended to be "stable", reflecting physical paths in
540 * hardware such as physical bus addresses for host controllers or ports on
541 * USB hubs. That makes it stay the same until systems are physically
542 * reconfigured, by re-cabling a tree of USB devices or by moving USB host
543 * controllers. Adding and removing devices, including virtual root hubs
544 * in host controller driver modules, does not change these path identifers;
545 * neither does rebooting or re-enumerating. These are more useful identifiers
546 * than changeable ("unstable") ones like bus numbers or device addresses.
548 * With a partial exception for devices connected to USB 2.0 root hubs, these
549 * identifiers are also predictable. So long as the device tree isn't changed,
550 * plugging any USB device into a given hub port always gives it the same path.
551 * Because of the use of "companion" controllers, devices connected to ports on
552 * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are
553 * high speed, and a different one if they are full or low speed.
555 static inline int usb_make_path (struct usb_device *dev, char *buf,
559 actual = snprintf (buf, size, "usb-%s-%s", dev->bus->bus_name,
561 return (actual >= (int)size) ? -1 : actual;
564 /*-------------------------------------------------------------------------*/
567 * usb_endpoint_num - get the endpoint's number
568 * @epd: endpoint to be checked
570 * Returns @epd's number: 0 to 15.
572 static inline int usb_endpoint_num(const struct usb_endpoint_descriptor *epd)
574 return epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
578 * usb_endpoint_type - get the endpoint's transfer type
579 * @epd: endpoint to be checked
581 * Returns one of USB_ENDPOINT_XFER_{CONTROL, ISOC, BULK, INT} according
582 * to @epd's transfer type.
584 static inline int usb_endpoint_type(const struct usb_endpoint_descriptor *epd)
586 return epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
590 * usb_endpoint_dir_in - check if the endpoint has IN direction
591 * @epd: endpoint to be checked
593 * Returns true if the endpoint is of type IN, otherwise it returns false.
595 static inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor *epd)
597 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN);
601 * usb_endpoint_dir_out - check if the endpoint has OUT direction
602 * @epd: endpoint to be checked
604 * Returns true if the endpoint is of type OUT, otherwise it returns false.
606 static inline int usb_endpoint_dir_out(const struct usb_endpoint_descriptor *epd)
608 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT);
612 * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type
613 * @epd: endpoint to be checked
615 * Returns true if the endpoint is of type bulk, otherwise it returns false.
617 static inline int usb_endpoint_xfer_bulk(const struct usb_endpoint_descriptor *epd)
619 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
620 USB_ENDPOINT_XFER_BULK);
624 * usb_endpoint_xfer_control - check if the endpoint has control transfer type
625 * @epd: endpoint to be checked
627 * Returns true if the endpoint is of type control, otherwise it returns false.
629 static inline int usb_endpoint_xfer_control(const struct usb_endpoint_descriptor *epd)
631 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
632 USB_ENDPOINT_XFER_CONTROL);
636 * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type
637 * @epd: endpoint to be checked
639 * Returns true if the endpoint is of type interrupt, otherwise it returns
642 static inline int usb_endpoint_xfer_int(const struct usb_endpoint_descriptor *epd)
644 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
645 USB_ENDPOINT_XFER_INT);
649 * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type
650 * @epd: endpoint to be checked
652 * Returns true if the endpoint is of type isochronous, otherwise it returns
655 static inline int usb_endpoint_xfer_isoc(const struct usb_endpoint_descriptor *epd)
657 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
658 USB_ENDPOINT_XFER_ISOC);
662 * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN
663 * @epd: endpoint to be checked
665 * Returns true if the endpoint has bulk transfer type and IN direction,
666 * otherwise it returns false.
668 static inline int usb_endpoint_is_bulk_in(const struct usb_endpoint_descriptor *epd)
670 return (usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_in(epd));
674 * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT
675 * @epd: endpoint to be checked
677 * Returns true if the endpoint has bulk transfer type and OUT direction,
678 * otherwise it returns false.
680 static inline int usb_endpoint_is_bulk_out(const struct usb_endpoint_descriptor *epd)
682 return (usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_out(epd));
686 * usb_endpoint_is_int_in - check if the endpoint is interrupt IN
687 * @epd: endpoint to be checked
689 * Returns true if the endpoint has interrupt transfer type and IN direction,
690 * otherwise it returns false.
692 static inline int usb_endpoint_is_int_in(const struct usb_endpoint_descriptor *epd)
694 return (usb_endpoint_xfer_int(epd) && usb_endpoint_dir_in(epd));
698 * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT
699 * @epd: endpoint to be checked
701 * Returns true if the endpoint has interrupt transfer type and OUT direction,
702 * otherwise it returns false.
704 static inline int usb_endpoint_is_int_out(const struct usb_endpoint_descriptor *epd)
706 return (usb_endpoint_xfer_int(epd) && usb_endpoint_dir_out(epd));
710 * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN
711 * @epd: endpoint to be checked
713 * Returns true if the endpoint has isochronous transfer type and IN direction,
714 * otherwise it returns false.
716 static inline int usb_endpoint_is_isoc_in(const struct usb_endpoint_descriptor *epd)
718 return (usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_in(epd));
722 * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT
723 * @epd: endpoint to be checked
725 * Returns true if the endpoint has isochronous transfer type and OUT direction,
726 * otherwise it returns false.
728 static inline int usb_endpoint_is_isoc_out(const struct usb_endpoint_descriptor *epd)
730 return (usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_out(epd));
733 /*-------------------------------------------------------------------------*/
735 #define USB_DEVICE_ID_MATCH_DEVICE \
736 (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
737 #define USB_DEVICE_ID_MATCH_DEV_RANGE \
738 (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI)
739 #define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
740 (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE)
741 #define USB_DEVICE_ID_MATCH_DEV_INFO \
742 (USB_DEVICE_ID_MATCH_DEV_CLASS | \
743 USB_DEVICE_ID_MATCH_DEV_SUBCLASS | \
744 USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
745 #define USB_DEVICE_ID_MATCH_INT_INFO \
746 (USB_DEVICE_ID_MATCH_INT_CLASS | \
747 USB_DEVICE_ID_MATCH_INT_SUBCLASS | \
748 USB_DEVICE_ID_MATCH_INT_PROTOCOL)
751 * USB_DEVICE - macro used to describe a specific usb device
752 * @vend: the 16 bit USB Vendor ID
753 * @prod: the 16 bit USB Product ID
755 * This macro is used to create a struct usb_device_id that matches a
758 #define USB_DEVICE(vend,prod) \
759 .match_flags = USB_DEVICE_ID_MATCH_DEVICE, .idVendor = (vend), \
762 * USB_DEVICE_VER - macro used to describe a specific usb device with a
764 * @vend: the 16 bit USB Vendor ID
765 * @prod: the 16 bit USB Product ID
766 * @lo: the bcdDevice_lo value
767 * @hi: the bcdDevice_hi value
769 * This macro is used to create a struct usb_device_id that matches a
770 * specific device, with a version range.
772 #define USB_DEVICE_VER(vend,prod,lo,hi) \
773 .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, \
774 .idVendor = (vend), .idProduct = (prod), \
775 .bcdDevice_lo = (lo), .bcdDevice_hi = (hi)
778 * USB_DEVICE_INTERFACE_PROTOCOL - macro used to describe a usb
779 * device with a specific interface protocol
780 * @vend: the 16 bit USB Vendor ID
781 * @prod: the 16 bit USB Product ID
782 * @pr: bInterfaceProtocol value
784 * This macro is used to create a struct usb_device_id that matches a
785 * specific interface protocol of devices.
787 #define USB_DEVICE_INTERFACE_PROTOCOL(vend,prod,pr) \
788 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_INT_PROTOCOL, \
789 .idVendor = (vend), \
790 .idProduct = (prod), \
791 .bInterfaceProtocol = (pr)
794 * USB_DEVICE_INFO - macro used to describe a class of usb devices
795 * @cl: bDeviceClass value
796 * @sc: bDeviceSubClass value
797 * @pr: bDeviceProtocol value
799 * This macro is used to create a struct usb_device_id that matches a
800 * specific class of devices.
802 #define USB_DEVICE_INFO(cl,sc,pr) \
803 .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, .bDeviceClass = (cl), \
804 .bDeviceSubClass = (sc), .bDeviceProtocol = (pr)
807 * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces
808 * @cl: bInterfaceClass value
809 * @sc: bInterfaceSubClass value
810 * @pr: bInterfaceProtocol value
812 * This macro is used to create a struct usb_device_id that matches a
813 * specific class of interfaces.
815 #define USB_INTERFACE_INFO(cl,sc,pr) \
816 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, .bInterfaceClass = (cl), \
817 .bInterfaceSubClass = (sc), .bInterfaceProtocol = (pr)
820 * USB_DEVICE_AND_INTERFACE_INFO - macro used to describe a specific usb device
821 * with a class of usb interfaces
822 * @vend: the 16 bit USB Vendor ID
823 * @prod: the 16 bit USB Product ID
824 * @cl: bInterfaceClass value
825 * @sc: bInterfaceSubClass value
826 * @pr: bInterfaceProtocol value
828 * This macro is used to create a struct usb_device_id that matches a
829 * specific device with a specific class of interfaces.
831 * This is especially useful when explicitly matching devices that have
832 * vendor specific bDeviceClass values, but standards-compliant interfaces.
834 #define USB_DEVICE_AND_INTERFACE_INFO(vend,prod,cl,sc,pr) \
835 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO \
836 | USB_DEVICE_ID_MATCH_DEVICE, \
837 .idVendor = (vend), .idProduct = (prod), \
838 .bInterfaceClass = (cl), \
839 .bInterfaceSubClass = (sc), .bInterfaceProtocol = (pr)
841 /* ----------------------------------------------------------------------- */
843 /* Stuff for dynamic usb ids */
846 struct list_head list;
850 struct list_head node;
851 struct usb_device_id id;
854 extern ssize_t usb_store_new_id(struct usb_dynids *dynids,
855 struct device_driver *driver,
856 const char *buf, size_t count);
859 * struct usbdrv_wrap - wrapper for driver-model structure
860 * @driver: The driver-model core driver structure.
861 * @for_devices: Non-zero for device drivers, 0 for interface drivers.
864 struct device_driver driver;
869 * struct usb_driver - identifies USB interface 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 * @probe: Called to see if the driver is willing to manage a particular
873 * interface on a device. If it is, probe returns zero and uses
874 * dev_set_drvdata() to associate driver-specific data with the
875 * interface. It may also use usb_set_interface() to specify the
876 * appropriate altsetting. If unwilling to manage the interface,
877 * return a negative errno value.
878 * @disconnect: Called when the interface is no longer accessible, usually
879 * because its device has been (or is being) disconnected or the
880 * driver module is being unloaded.
881 * @ioctl: Used for drivers that want to talk to userspace through
882 * the "usbfs" filesystem. This lets devices provide ways to
883 * expose information to user space regardless of where they
884 * do (or don't) show up otherwise in the filesystem.
885 * @suspend: Called when the device is going to be suspended by the system.
886 * @resume: Called when the device is being resumed by the system.
887 * @reset_resume: Called when the suspended device has been reset instead
889 * @pre_reset: Called by usb_reset_composite_device() when the device
890 * is about to be reset.
891 * @post_reset: Called by usb_reset_composite_device() after the device
892 * has been reset, or in lieu of @resume following a reset-resume
893 * (i.e., the device is reset instead of being resumed, as might
894 * happen if power was lost). The second argument tells which is
896 * @id_table: USB drivers use ID table to support hotplugging.
897 * Export this with MODULE_DEVICE_TABLE(usb,...). This must be set
898 * or your driver's probe function will never get called.
899 * @dynids: used internally to hold the list of dynamically added device
900 * ids for this driver.
901 * @drvwrap: Driver-model core structure wrapper.
902 * @no_dynamic_id: if set to 1, the USB core will not allow dynamic ids to be
903 * added to this driver by preventing the sysfs file from being created.
904 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
905 * for interfaces bound to this driver.
907 * USB interface drivers must provide a name, probe() and disconnect()
908 * methods, and an id_table. Other driver fields are optional.
910 * The id_table is used in hotplugging. It holds a set of descriptors,
911 * and specialized data may be associated with each entry. That table
912 * is used by both user and kernel mode hotplugging support.
914 * The probe() and disconnect() methods are called in a context where
915 * they can sleep, but they should avoid abusing the privilege. Most
916 * work to connect to a device should be done when the device is opened,
917 * and undone at the last close. The disconnect code needs to address
918 * concurrency issues with respect to open() and close() methods, as
919 * well as forcing all pending I/O requests to complete (by unlinking
920 * them as necessary, and blocking until the unlinks complete).
925 int (*probe) (struct usb_interface *intf,
926 const struct usb_device_id *id);
928 void (*disconnect) (struct usb_interface *intf);
930 int (*ioctl) (struct usb_interface *intf, unsigned int code,
933 int (*suspend) (struct usb_interface *intf, pm_message_t message);
934 int (*resume) (struct usb_interface *intf);
935 int (*reset_resume)(struct usb_interface *intf);
937 int (*pre_reset)(struct usb_interface *intf);
938 int (*post_reset)(struct usb_interface *intf);
940 const struct usb_device_id *id_table;
942 struct usb_dynids dynids;
943 struct usbdrv_wrap drvwrap;
944 unsigned int no_dynamic_id:1;
945 unsigned int supports_autosuspend:1;
947 #define to_usb_driver(d) container_of(d, struct usb_driver, drvwrap.driver)
950 * struct usb_device_driver - identifies USB device driver to usbcore
951 * @name: The driver name should be unique among USB drivers,
952 * and should normally be the same as the module name.
953 * @probe: Called to see if the driver is willing to manage a particular
954 * device. If it is, probe returns zero and uses dev_set_drvdata()
955 * to associate driver-specific data with the device. If unwilling
956 * to manage the device, return a negative errno value.
957 * @disconnect: Called when the device is no longer accessible, usually
958 * because it has been (or is being) disconnected or the driver's
959 * module is being unloaded.
960 * @suspend: Called when the device is going to be suspended by the system.
961 * @resume: Called when the device is being resumed by the system.
962 * @drvwrap: Driver-model core structure wrapper.
963 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
964 * for devices bound to this driver.
966 * USB drivers must provide all the fields listed above except drvwrap.
968 struct usb_device_driver {
971 int (*probe) (struct usb_device *udev);
972 void (*disconnect) (struct usb_device *udev);
974 int (*suspend) (struct usb_device *udev, pm_message_t message);
975 int (*resume) (struct usb_device *udev);
976 struct usbdrv_wrap drvwrap;
977 unsigned int supports_autosuspend:1;
979 #define to_usb_device_driver(d) container_of(d, struct usb_device_driver, \
982 extern struct bus_type usb_bus_type;
985 * struct usb_class_driver - identifies a USB driver that wants to use the USB major number
986 * @name: the usb class device name for this driver. Will show up in sysfs.
987 * @fops: pointer to the struct file_operations of this driver.
988 * @minor_base: the start of the minor range for this driver.
990 * This structure is used for the usb_register_dev() and
991 * usb_unregister_dev() functions, to consolidate a number of the
992 * parameters used for them.
994 struct usb_class_driver {
996 const struct file_operations *fops;
1001 * use these in module_init()/module_exit()
1002 * and don't forget MODULE_DEVICE_TABLE(usb, ...)
1004 extern int usb_register_driver(struct usb_driver *, struct module *,
1006 static inline int usb_register(struct usb_driver *driver)
1008 return usb_register_driver(driver, THIS_MODULE, KBUILD_MODNAME);
1010 extern void usb_deregister(struct usb_driver *);
1012 extern int usb_register_device_driver(struct usb_device_driver *,
1014 extern void usb_deregister_device_driver(struct usb_device_driver *);
1016 extern int usb_register_dev(struct usb_interface *intf,
1017 struct usb_class_driver *class_driver);
1018 extern void usb_deregister_dev(struct usb_interface *intf,
1019 struct usb_class_driver *class_driver);
1021 extern int usb_disabled(void);
1023 /* ----------------------------------------------------------------------- */
1026 * URB support, for asynchronous request completions
1030 * urb->transfer_flags:
1032 * Note: URB_DIR_IN/OUT is automatically set in usb_submit_urb().
1034 #define URB_SHORT_NOT_OK 0x0001 /* report short reads as errors */
1035 #define URB_ISO_ASAP 0x0002 /* iso-only, urb->start_frame
1037 #define URB_NO_TRANSFER_DMA_MAP 0x0004 /* urb->transfer_dma valid on submit */
1038 #define URB_NO_SETUP_DMA_MAP 0x0008 /* urb->setup_dma valid on submit */
1039 #define URB_NO_FSBR 0x0020 /* UHCI-specific */
1040 #define URB_ZERO_PACKET 0x0040 /* Finish bulk OUT with short packet */
1041 #define URB_NO_INTERRUPT 0x0080 /* HINT: no non-error interrupt
1043 #define URB_FREE_BUFFER 0x0100 /* Free transfer buffer with the URB */
1045 #define URB_DIR_IN 0x0200 /* Transfer from device to host */
1046 #define URB_DIR_OUT 0
1047 #define URB_DIR_MASK URB_DIR_IN
1049 struct usb_iso_packet_descriptor {
1050 unsigned int offset;
1051 unsigned int length; /* expected length */
1052 unsigned int actual_length;
1059 struct list_head urb_list;
1060 wait_queue_head_t wait;
1064 static inline void init_usb_anchor(struct usb_anchor *anchor)
1066 INIT_LIST_HEAD(&anchor->urb_list);
1067 init_waitqueue_head(&anchor->wait);
1068 spin_lock_init(&anchor->lock);
1071 typedef void (*usb_complete_t)(struct urb *);
1074 * struct urb - USB Request Block
1075 * @urb_list: For use by current owner of the URB.
1076 * @anchor_list: membership in the list of an anchor
1077 * @anchor: to anchor URBs to a common mooring
1078 * @ep: Points to the endpoint's data structure. Will eventually
1080 * @pipe: Holds endpoint number, direction, type, and more.
1081 * Create these values with the eight macros available;
1082 * usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl"
1083 * (control), "bulk", "int" (interrupt), or "iso" (isochronous).
1084 * For example usb_sndbulkpipe() or usb_rcvintpipe(). Endpoint
1085 * numbers range from zero to fifteen. Note that "in" endpoint two
1086 * is a different endpoint (and pipe) from "out" endpoint two.
1087 * The current configuration controls the existence, type, and
1088 * maximum packet size of any given endpoint.
1089 * @dev: Identifies the USB device to perform the request.
1090 * @status: This is read in non-iso completion functions to get the
1091 * status of the particular request. ISO requests only use it
1092 * to tell whether the URB was unlinked; detailed status for
1093 * each frame is in the fields of the iso_frame-desc.
1094 * @transfer_flags: A variety of flags may be used to affect how URB
1095 * submission, unlinking, or operation are handled. Different
1096 * kinds of URB can use different flags.
1097 * @transfer_buffer: This identifies the buffer to (or from) which
1098 * the I/O request will be performed (unless URB_NO_TRANSFER_DMA_MAP
1099 * is set). This buffer must be suitable for DMA; allocate it with
1100 * kmalloc() or equivalent. For transfers to "in" endpoints, contents
1101 * of this buffer will be modified. This buffer is used for the data
1102 * stage of control transfers.
1103 * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP,
1104 * the device driver is saying that it provided this DMA address,
1105 * which the host controller driver should use in preference to the
1107 * @transfer_buffer_length: How big is transfer_buffer. The transfer may
1108 * be broken up into chunks according to the current maximum packet
1109 * size for the endpoint, which is a function of the configuration
1110 * and is encoded in the pipe. When the length is zero, neither
1111 * transfer_buffer nor transfer_dma is used.
1112 * @actual_length: This is read in non-iso completion functions, and
1113 * it tells how many bytes (out of transfer_buffer_length) were
1114 * transferred. It will normally be the same as requested, unless
1115 * either an error was reported or a short read was performed.
1116 * The URB_SHORT_NOT_OK transfer flag may be used to make such
1117 * short reads be reported as errors.
1118 * @setup_packet: Only used for control transfers, this points to eight bytes
1119 * of setup data. Control transfers always start by sending this data
1120 * to the device. Then transfer_buffer is read or written, if needed.
1121 * @setup_dma: For control transfers with URB_NO_SETUP_DMA_MAP set, the
1122 * device driver has provided this DMA address for the setup packet.
1123 * The host controller driver should use this in preference to
1125 * @start_frame: Returns the initial frame for isochronous transfers.
1126 * @number_of_packets: Lists the number of ISO transfer buffers.
1127 * @interval: Specifies the polling interval for interrupt or isochronous
1128 * transfers. The units are frames (milliseconds) for for full and low
1129 * speed devices, and microframes (1/8 millisecond) for highspeed ones.
1130 * @error_count: Returns the number of ISO transfers that reported errors.
1131 * @context: For use in completion functions. This normally points to
1132 * request-specific driver context.
1133 * @complete: Completion handler. This URB is passed as the parameter to the
1134 * completion function. The completion function may then do what
1135 * it likes with the URB, including resubmitting or freeing it.
1136 * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to
1137 * collect the transfer status for each buffer.
1139 * This structure identifies USB transfer requests. URBs must be allocated by
1140 * calling usb_alloc_urb() and freed with a call to usb_free_urb().
1141 * Initialization may be done using various usb_fill_*_urb() functions. URBs
1142 * are submitted using usb_submit_urb(), and pending requests may be canceled
1143 * using usb_unlink_urb() or usb_kill_urb().
1145 * Data Transfer Buffers:
1147 * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise
1148 * taken from the general page pool. That is provided by transfer_buffer
1149 * (control requests also use setup_packet), and host controller drivers
1150 * perform a dma mapping (and unmapping) for each buffer transferred. Those
1151 * mapping operations can be expensive on some platforms (perhaps using a dma
1152 * bounce buffer or talking to an IOMMU),
1153 * although they're cheap on commodity x86 and ppc hardware.
1155 * Alternatively, drivers may pass the URB_NO_xxx_DMA_MAP transfer flags,
1156 * which tell the host controller driver that no such mapping is needed since
1157 * the device driver is DMA-aware. For example, a device driver might
1158 * allocate a DMA buffer with usb_buffer_alloc() or call usb_buffer_map().
1159 * When these transfer flags are provided, host controller drivers will
1160 * attempt to use the dma addresses found in the transfer_dma and/or
1161 * setup_dma fields rather than determining a dma address themselves. (Note
1162 * that transfer_buffer and setup_packet must still be set because not all
1163 * host controllers use DMA, nor do virtual root hubs).
1167 * All URBs submitted must initialize the dev, pipe, transfer_flags (may be
1168 * zero), and complete fields. All URBs must also initialize
1169 * transfer_buffer and transfer_buffer_length. They may provide the
1170 * URB_SHORT_NOT_OK transfer flag, indicating that short reads are
1171 * to be treated as errors; that flag is invalid for write requests.
1174 * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers
1175 * should always terminate with a short packet, even if it means adding an
1176 * extra zero length packet.
1178 * Control URBs must provide a setup_packet. The setup_packet and
1179 * transfer_buffer may each be mapped for DMA or not, independently of
1180 * the other. The transfer_flags bits URB_NO_TRANSFER_DMA_MAP and
1181 * URB_NO_SETUP_DMA_MAP indicate which buffers have already been mapped.
1182 * URB_NO_SETUP_DMA_MAP is ignored for non-control URBs.
1184 * Interrupt URBs must provide an interval, saying how often (in milliseconds
1185 * or, for highspeed devices, 125 microsecond units)
1186 * to poll for transfers. After the URB has been submitted, the interval
1187 * field reflects how the transfer was actually scheduled.
1188 * The polling interval may be more frequent than requested.
1189 * For example, some controllers have a maximum interval of 32 milliseconds,
1190 * while others support intervals of up to 1024 milliseconds.
1191 * Isochronous URBs also have transfer intervals. (Note that for isochronous
1192 * endpoints, as well as high speed interrupt endpoints, the encoding of
1193 * the transfer interval in the endpoint descriptor is logarithmic.
1194 * Device drivers must convert that value to linear units themselves.)
1196 * Isochronous URBs normally use the URB_ISO_ASAP transfer flag, telling
1197 * the host controller to schedule the transfer as soon as bandwidth
1198 * utilization allows, and then set start_frame to reflect the actual frame
1199 * selected during submission. Otherwise drivers must specify the start_frame
1200 * and handle the case where the transfer can't begin then. However, drivers
1201 * won't know how bandwidth is currently allocated, and while they can
1202 * find the current frame using usb_get_current_frame_number () they can't
1203 * know the range for that frame number. (Ranges for frame counter values
1204 * are HC-specific, and can go from 256 to 65536 frames from "now".)
1206 * Isochronous URBs have a different data transfer model, in part because
1207 * the quality of service is only "best effort". Callers provide specially
1208 * allocated URBs, with number_of_packets worth of iso_frame_desc structures
1209 * at the end. Each such packet is an individual ISO transfer. Isochronous
1210 * URBs are normally queued, submitted by drivers to arrange that
1211 * transfers are at least double buffered, and then explicitly resubmitted
1212 * in completion handlers, so
1213 * that data (such as audio or video) streams at as constant a rate as the
1214 * host controller scheduler can support.
1216 * Completion Callbacks:
1218 * The completion callback is made in_interrupt(), and one of the first
1219 * things that a completion handler should do is check the status field.
1220 * The status field is provided for all URBs. It is used to report
1221 * unlinked URBs, and status for all non-ISO transfers. It should not
1222 * be examined before the URB is returned to the completion handler.
1224 * The context field is normally used to link URBs back to the relevant
1225 * driver or request state.
1227 * When the completion callback is invoked for non-isochronous URBs, the
1228 * actual_length field tells how many bytes were transferred. This field
1229 * is updated even when the URB terminated with an error or was unlinked.
1231 * ISO transfer status is reported in the status and actual_length fields
1232 * of the iso_frame_desc array, and the number of errors is reported in
1233 * error_count. Completion callbacks for ISO transfers will normally
1234 * (re)submit URBs to ensure a constant transfer rate.
1236 * Note that even fields marked "public" should not be touched by the driver
1237 * when the urb is owned by the hcd, that is, since the call to
1238 * usb_submit_urb() till the entry into the completion routine.
1242 /* private: usb core and host controller only fields in the urb */
1243 struct kref kref; /* reference count of the URB */
1244 spinlock_t lock; /* lock for the URB */
1245 void *hcpriv; /* private data for host controller */
1246 atomic_t use_count; /* concurrent submissions counter */
1247 u8 reject; /* submissions will fail */
1248 int unlinked; /* unlink error code */
1250 /* public: documented fields in the urb that can be used by drivers */
1251 struct list_head urb_list; /* list head for use by the urb's
1253 struct list_head anchor_list; /* the URB may be anchored by the driver */
1254 struct usb_anchor *anchor;
1255 struct usb_device *dev; /* (in) pointer to associated device */
1256 struct usb_host_endpoint *ep; /* (internal) pointer to endpoint struct */
1257 unsigned int pipe; /* (in) pipe information */
1258 int status; /* (return) non-ISO status */
1259 unsigned int transfer_flags; /* (in) URB_SHORT_NOT_OK | ...*/
1260 void *transfer_buffer; /* (in) associated data buffer */
1261 dma_addr_t transfer_dma; /* (in) dma addr for transfer_buffer */
1262 int transfer_buffer_length; /* (in) data buffer length */
1263 int actual_length; /* (return) actual transfer length */
1264 unsigned char *setup_packet; /* (in) setup packet (control only) */
1265 dma_addr_t setup_dma; /* (in) dma addr for setup_packet */
1266 int start_frame; /* (modify) start frame (ISO) */
1267 int number_of_packets; /* (in) number of ISO packets */
1268 int interval; /* (modify) transfer interval
1270 int error_count; /* (return) number of ISO errors */
1271 void *context; /* (in) context for completion */
1272 usb_complete_t complete; /* (in) completion routine */
1273 struct usb_iso_packet_descriptor iso_frame_desc[0];
1277 /* ----------------------------------------------------------------------- */
1280 * usb_fill_control_urb - initializes a control urb
1281 * @urb: pointer to the urb to initialize.
1282 * @dev: pointer to the struct usb_device for this urb.
1283 * @pipe: the endpoint pipe
1284 * @setup_packet: pointer to the setup_packet buffer
1285 * @transfer_buffer: pointer to the transfer buffer
1286 * @buffer_length: length of the transfer buffer
1287 * @complete_fn: pointer to the usb_complete_t function
1288 * @context: what to set the urb context to.
1290 * Initializes a control urb with the proper information needed to submit
1293 static inline void usb_fill_control_urb (struct urb *urb,
1294 struct usb_device *dev,
1296 unsigned char *setup_packet,
1297 void *transfer_buffer,
1299 usb_complete_t complete_fn,
1302 spin_lock_init(&urb->lock);
1305 urb->setup_packet = setup_packet;
1306 urb->transfer_buffer = transfer_buffer;
1307 urb->transfer_buffer_length = buffer_length;
1308 urb->complete = complete_fn;
1309 urb->context = context;
1313 * usb_fill_bulk_urb - macro to help initialize a bulk urb
1314 * @urb: pointer to the urb to initialize.
1315 * @dev: pointer to the struct usb_device for this urb.
1316 * @pipe: the endpoint pipe
1317 * @transfer_buffer: pointer to the transfer buffer
1318 * @buffer_length: length of the transfer buffer
1319 * @complete_fn: pointer to the usb_complete_t function
1320 * @context: what to set the urb context to.
1322 * Initializes a bulk urb with the proper information needed to submit it
1325 static inline void usb_fill_bulk_urb (struct urb *urb,
1326 struct usb_device *dev,
1328 void *transfer_buffer,
1330 usb_complete_t complete_fn,
1333 spin_lock_init(&urb->lock);
1336 urb->transfer_buffer = transfer_buffer;
1337 urb->transfer_buffer_length = buffer_length;
1338 urb->complete = complete_fn;
1339 urb->context = context;
1343 * usb_fill_int_urb - macro to help initialize a interrupt urb
1344 * @urb: pointer to the urb to initialize.
1345 * @dev: pointer to the struct usb_device for this urb.
1346 * @pipe: the endpoint pipe
1347 * @transfer_buffer: pointer to the transfer buffer
1348 * @buffer_length: length of the transfer buffer
1349 * @complete_fn: pointer to the usb_complete_t function
1350 * @context: what to set the urb context to.
1351 * @interval: what to set the urb interval to, encoded like
1352 * the endpoint descriptor's bInterval value.
1354 * Initializes a interrupt urb with the proper information needed to submit
1356 * Note that high speed interrupt endpoints use a logarithmic encoding of
1357 * the endpoint interval, and express polling intervals in microframes
1358 * (eight per millisecond) rather than in frames (one per millisecond).
1360 static inline void usb_fill_int_urb (struct urb *urb,
1361 struct usb_device *dev,
1363 void *transfer_buffer,
1365 usb_complete_t complete_fn,
1369 spin_lock_init(&urb->lock);
1372 urb->transfer_buffer = transfer_buffer;
1373 urb->transfer_buffer_length = buffer_length;
1374 urb->complete = complete_fn;
1375 urb->context = context;
1376 if (dev->speed == USB_SPEED_HIGH)
1377 urb->interval = 1 << (interval - 1);
1379 urb->interval = interval;
1380 urb->start_frame = -1;
1383 extern void usb_init_urb(struct urb *urb);
1384 extern struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags);
1385 extern void usb_free_urb(struct urb *urb);
1386 #define usb_put_urb usb_free_urb
1387 extern struct urb *usb_get_urb(struct urb *urb);
1388 extern int usb_submit_urb(struct urb *urb, gfp_t mem_flags);
1389 extern int usb_unlink_urb(struct urb *urb);
1390 extern void usb_kill_urb(struct urb *urb);
1391 extern void usb_kill_anchored_urbs(struct usb_anchor *anchor);
1392 extern void usb_anchor_urb(struct urb *urb, struct usb_anchor *anchor);
1393 extern void usb_unanchor_urb(struct urb *urb);
1394 extern int usb_wait_anchor_empty_timeout(struct usb_anchor *anchor,
1395 unsigned int timeout);
1398 * usb_urb_dir_in - check if an URB describes an IN transfer
1399 * @urb: URB to be checked
1401 * Returns 1 if @urb describes an IN transfer (device-to-host),
1404 static inline int usb_urb_dir_in(struct urb *urb)
1406 return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_IN;
1410 * usb_urb_dir_out - check if an URB describes an OUT transfer
1411 * @urb: URB to be checked
1413 * Returns 1 if @urb describes an OUT transfer (host-to-device),
1416 static inline int usb_urb_dir_out(struct urb *urb)
1418 return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_OUT;
1421 void *usb_buffer_alloc (struct usb_device *dev, size_t size,
1422 gfp_t mem_flags, dma_addr_t *dma);
1423 void usb_buffer_free (struct usb_device *dev, size_t size,
1424 void *addr, dma_addr_t dma);
1427 struct urb *usb_buffer_map (struct urb *urb);
1428 void usb_buffer_dmasync (struct urb *urb);
1429 void usb_buffer_unmap (struct urb *urb);
1433 int usb_buffer_map_sg(const struct usb_device *dev, int is_in,
1434 struct scatterlist *sg, int nents);
1436 void usb_buffer_dmasync_sg(const struct usb_device *dev, int is_in,
1437 struct scatterlist *sg, int n_hw_ents);
1439 void usb_buffer_unmap_sg(const struct usb_device *dev, int is_in,
1440 struct scatterlist *sg, int n_hw_ents);
1442 /*-------------------------------------------------------------------*
1443 * SYNCHRONOUS CALL SUPPORT *
1444 *-------------------------------------------------------------------*/
1446 extern int usb_control_msg(struct usb_device *dev, unsigned int pipe,
1447 __u8 request, __u8 requesttype, __u16 value, __u16 index,
1448 void *data, __u16 size, int timeout);
1449 extern int usb_interrupt_msg(struct usb_device *usb_dev, unsigned int pipe,
1450 void *data, int len, int *actual_length, int timeout);
1451 extern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,
1452 void *data, int len, int *actual_length,
1455 /* wrappers around usb_control_msg() for the most common standard requests */
1456 extern int usb_get_descriptor(struct usb_device *dev, unsigned char desctype,
1457 unsigned char descindex, void *buf, int size);
1458 extern int usb_get_status(struct usb_device *dev,
1459 int type, int target, void *data);
1460 extern int usb_string(struct usb_device *dev, int index,
1461 char *buf, size_t size);
1463 /* wrappers that also update important state inside usbcore */
1464 extern int usb_clear_halt(struct usb_device *dev, int pipe);
1465 extern int usb_reset_configuration(struct usb_device *dev);
1466 extern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate);
1468 /* this request isn't really synchronous, but it belongs with the others */
1469 extern int usb_driver_set_configuration(struct usb_device *udev, int config);
1472 * timeouts, in milliseconds, used for sending/receiving control messages
1473 * they typically complete within a few frames (msec) after they're issued
1474 * USB identifies 5 second timeouts, maybe more in a few cases, and a few
1475 * slow devices (like some MGE Ellipse UPSes) actually push that limit.
1477 #define USB_CTRL_GET_TIMEOUT 5000
1478 #define USB_CTRL_SET_TIMEOUT 5000
1482 * struct usb_sg_request - support for scatter/gather I/O
1483 * @status: zero indicates success, else negative errno
1484 * @bytes: counts bytes transferred.
1486 * These requests are initialized using usb_sg_init(), and then are used
1487 * as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most
1488 * members of the request object aren't for driver access.
1490 * The status and bytecount values are valid only after usb_sg_wait()
1491 * returns. If the status is zero, then the bytecount matches the total
1494 * After an error completion, drivers may need to clear a halt condition
1497 struct usb_sg_request {
1502 * members below are private: to usbcore,
1503 * and are not provided for driver access!
1507 struct usb_device *dev;
1509 struct scatterlist *sg;
1516 struct completion complete;
1520 struct usb_sg_request *io,
1521 struct usb_device *dev,
1524 struct scatterlist *sg,
1529 void usb_sg_cancel (struct usb_sg_request *io);
1530 void usb_sg_wait (struct usb_sg_request *io);
1533 /* ----------------------------------------------------------------------- */
1536 * For various legacy reasons, Linux has a small cookie that's paired with
1537 * a struct usb_device to identify an endpoint queue. Queue characteristics
1538 * are defined by the endpoint's descriptor. This cookie is called a "pipe",
1539 * an unsigned int encoded as:
1541 * - direction: bit 7 (0 = Host-to-Device [Out],
1542 * 1 = Device-to-Host [In] ...
1543 * like endpoint bEndpointAddress)
1544 * - device address: bits 8-14 ... bit positions known to uhci-hcd
1545 * - endpoint: bits 15-18 ... bit positions known to uhci-hcd
1546 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
1547 * 10 = control, 11 = bulk)
1549 * Given the device address and endpoint descriptor, pipes are redundant.
1552 /* NOTE: these are not the standard USB_ENDPOINT_XFER_* values!! */
1553 /* (yet ... they're the values used by usbfs) */
1554 #define PIPE_ISOCHRONOUS 0
1555 #define PIPE_INTERRUPT 1
1556 #define PIPE_CONTROL 2
1559 #define usb_pipein(pipe) ((pipe) & USB_DIR_IN)
1560 #define usb_pipeout(pipe) (!usb_pipein(pipe))
1562 #define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
1563 #define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
1565 #define usb_pipetype(pipe) (((pipe) >> 30) & 3)
1566 #define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
1567 #define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
1568 #define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
1569 #define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
1571 /* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
1572 #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
1573 #define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep)))
1574 #define usb_settoggle(dev, ep, out, bit) \
1575 ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \
1579 static inline unsigned int __create_pipe(struct usb_device *dev,
1580 unsigned int endpoint)
1582 return (dev->devnum << 8) | (endpoint << 15);
1585 /* Create various pipes... */
1586 #define usb_sndctrlpipe(dev,endpoint) \
1587 ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint))
1588 #define usb_rcvctrlpipe(dev,endpoint) \
1589 ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1590 #define usb_sndisocpipe(dev,endpoint) \
1591 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint))
1592 #define usb_rcvisocpipe(dev,endpoint) \
1593 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1594 #define usb_sndbulkpipe(dev,endpoint) \
1595 ((PIPE_BULK << 30) | __create_pipe(dev,endpoint))
1596 #define usb_rcvbulkpipe(dev,endpoint) \
1597 ((PIPE_BULK << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1598 #define usb_sndintpipe(dev,endpoint) \
1599 ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint))
1600 #define usb_rcvintpipe(dev,endpoint) \
1601 ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1603 /*-------------------------------------------------------------------------*/
1606 usb_maxpacket(struct usb_device *udev, int pipe, int is_out)
1608 struct usb_host_endpoint *ep;
1609 unsigned epnum = usb_pipeendpoint(pipe);
1612 WARN_ON(usb_pipein(pipe));
1613 ep = udev->ep_out[epnum];
1615 WARN_ON(usb_pipeout(pipe));
1616 ep = udev->ep_in[epnum];
1621 /* NOTE: only 0x07ff bits are for packet size... */
1622 return le16_to_cpu(ep->desc.wMaxPacketSize);
1625 /* ----------------------------------------------------------------------- */
1627 /* Events from the usb core */
1628 #define USB_DEVICE_ADD 0x0001
1629 #define USB_DEVICE_REMOVE 0x0002
1630 #define USB_BUS_ADD 0x0003
1631 #define USB_BUS_REMOVE 0x0004
1632 extern void usb_register_notify(struct notifier_block *nb);
1633 extern void usb_unregister_notify(struct notifier_block *nb);
1636 #define dbg(format, arg...) printk(KERN_DEBUG "%s: " format "\n" , \
1639 #define dbg(format, arg...) do {} while (0)
1642 #define err(format, arg...) printk(KERN_ERR "%s: " format "\n" , \
1644 #define info(format, arg...) printk(KERN_INFO "%s: " format "\n" , \
1646 #define warn(format, arg...) printk(KERN_WARNING "%s: " format "\n" , \
1650 #endif /* __KERNEL__ */