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 */
23 #include <linux/pm_runtime.h> /* for runtime PM */
29 /*-------------------------------------------------------------------------*/
32 * Host-side wrappers for standard USB descriptors ... these are parsed
33 * from the data provided by devices. Parsing turns them from a flat
34 * sequence of descriptors into a hierarchy:
36 * - devices have one (usually) or more configs;
37 * - configs have one (often) or more interfaces;
38 * - interfaces have one (usually) or more settings;
39 * - each interface setting has zero or (usually) more endpoints.
40 * - a SuperSpeed endpoint has a companion descriptor
42 * And there might be other descriptors mixed in with those.
44 * Devices may also have class-specific or vendor-specific descriptors.
50 * struct usb_host_endpoint - host-side endpoint descriptor and queue
51 * @desc: descriptor for this endpoint, wMaxPacketSize in native byteorder
52 * @ss_ep_comp: SuperSpeed companion descriptor for this endpoint
53 * @urb_list: urbs queued to this endpoint; maintained by usbcore
54 * @hcpriv: for use by HCD; typically holds hardware dma queue head (QH)
55 * with one or more transfer descriptors (TDs) per urb
56 * @ep_dev: ep_device for sysfs info
57 * @extra: descriptors following this endpoint in the configuration
58 * @extralen: how many bytes of "extra" are valid
59 * @enabled: URBs may be submitted to this endpoint
61 * USB requests are always queued to a given endpoint, identified by a
62 * descriptor within an active interface in a given USB configuration.
64 struct usb_host_endpoint {
65 struct usb_endpoint_descriptor desc;
66 struct usb_ss_ep_comp_descriptor ss_ep_comp;
67 struct list_head urb_list;
69 struct ep_device *ep_dev; /* For sysfs info */
71 unsigned char *extra; /* Extra descriptors */
76 /* host-side wrapper for one interface setting's parsed descriptors */
77 struct usb_host_interface {
78 struct usb_interface_descriptor desc;
80 /* array of desc.bNumEndpoint endpoints associated with this
81 * interface setting. these will be in no particular order.
83 struct usb_host_endpoint *endpoint;
85 char *string; /* iInterface string, if present */
86 unsigned char *extra; /* Extra descriptors */
90 enum usb_interface_condition {
91 USB_INTERFACE_UNBOUND = 0,
92 USB_INTERFACE_BINDING,
94 USB_INTERFACE_UNBINDING,
98 * struct usb_interface - what usb device drivers talk to
99 * @altsetting: array of interface structures, one for each alternate
100 * setting that may be selected. Each one includes a set of
101 * endpoint configurations. They will be in no particular order.
102 * @cur_altsetting: the current altsetting.
103 * @num_altsetting: number of altsettings defined.
104 * @intf_assoc: interface association descriptor
105 * @minor: the minor number assigned to this interface, if this
106 * interface is bound to a driver that uses the USB major number.
107 * If this interface does not use the USB major, this field should
108 * be unused. The driver should set this value in the probe()
109 * function of the driver, after it has been assigned a minor
110 * number from the USB core by calling usb_register_dev().
111 * @condition: binding state of the interface: not bound, binding
112 * (in probe()), bound to a driver, or unbinding (in disconnect())
113 * @sysfs_files_created: sysfs attributes exist
114 * @ep_devs_created: endpoint child pseudo-devices exist
115 * @unregistering: flag set when the interface is being unregistered
116 * @needs_remote_wakeup: flag set when the driver requires remote-wakeup
117 * capability during autosuspend.
118 * @needs_altsetting0: flag set when a set-interface request for altsetting 0
120 * @needs_binding: flag set when the driver should be re-probed or unbound
121 * following a reset or suspend operation it doesn't support.
122 * @dev: driver model's view of this device
123 * @usb_dev: if an interface is bound to the USB major, this will point
124 * to the sysfs representation for that device.
125 * @pm_usage_cnt: PM usage counter for this interface
126 * @reset_ws: Used for scheduling resets from atomic context.
127 * @reset_running: set to 1 if the interface is currently running a
128 * queued reset so that usb_cancel_queued_reset() doesn't try to
129 * remove from the workqueue when running inside the worker
130 * thread. See __usb_queue_reset_device().
131 * @resetting_device: USB core reset the device, so use alt setting 0 as
132 * current; needs bandwidth alloc after reset.
134 * USB device drivers attach to interfaces on a physical device. Each
135 * interface encapsulates a single high level function, such as feeding
136 * an audio stream to a speaker or reporting a change in a volume control.
137 * Many USB devices only have one interface. The protocol used to talk to
138 * an interface's endpoints can be defined in a usb "class" specification,
139 * or by a product's vendor. The (default) control endpoint is part of
140 * every interface, but is never listed among the interface's descriptors.
142 * The driver that is bound to the interface can use standard driver model
143 * calls such as dev_get_drvdata() on the dev member of this structure.
145 * Each interface may have alternate settings. The initial configuration
146 * of a device sets altsetting 0, but the device driver can change
147 * that setting using usb_set_interface(). Alternate settings are often
148 * used to control the use of periodic endpoints, such as by having
149 * different endpoints use different amounts of reserved USB bandwidth.
150 * All standards-conformant USB devices that use isochronous endpoints
151 * will use them in non-default settings.
153 * The USB specification says that alternate setting numbers must run from
154 * 0 to one less than the total number of alternate settings. But some
155 * devices manage to mess this up, and the structures aren't necessarily
156 * stored in numerical order anyhow. Use usb_altnum_to_altsetting() to
157 * look up an alternate setting in the altsetting array based on its number.
159 struct usb_interface {
160 /* array of alternate settings for this interface,
161 * stored in no particular order */
162 struct usb_host_interface *altsetting;
164 struct usb_host_interface *cur_altsetting; /* the currently
165 * active alternate setting */
166 unsigned num_altsetting; /* number of alternate settings */
168 /* If there is an interface association descriptor then it will list
169 * the associated interfaces */
170 struct usb_interface_assoc_descriptor *intf_assoc;
172 int minor; /* minor number this interface is
174 enum usb_interface_condition condition; /* state of binding */
175 unsigned sysfs_files_created:1; /* the sysfs attributes exist */
176 unsigned ep_devs_created:1; /* endpoint "devices" exist */
177 unsigned unregistering:1; /* unregistration is in progress */
178 unsigned needs_remote_wakeup:1; /* driver requires remote wakeup */
179 unsigned needs_altsetting0:1; /* switch to altsetting 0 is pending */
180 unsigned needs_binding:1; /* needs delayed unbind/rebind */
181 unsigned reset_running:1;
182 unsigned resetting_device:1; /* true: bandwidth alloc after reset */
184 struct device dev; /* interface specific device info */
185 struct device *usb_dev;
186 atomic_t pm_usage_cnt; /* usage counter for autosuspend */
187 struct work_struct reset_ws; /* for resets in atomic context */
189 #define to_usb_interface(d) container_of(d, struct usb_interface, dev)
191 static inline void *usb_get_intfdata(struct usb_interface *intf)
193 return dev_get_drvdata(&intf->dev);
196 static inline void usb_set_intfdata(struct usb_interface *intf, void *data)
198 dev_set_drvdata(&intf->dev, data);
201 struct usb_interface *usb_get_intf(struct usb_interface *intf);
202 void usb_put_intf(struct usb_interface *intf);
204 /* this maximum is arbitrary */
205 #define USB_MAXINTERFACES 32
206 #define USB_MAXIADS (USB_MAXINTERFACES/2)
209 * struct usb_interface_cache - long-term representation of a device interface
210 * @num_altsetting: number of altsettings defined.
211 * @ref: reference counter.
212 * @altsetting: variable-length array of interface structures, one for
213 * each alternate setting that may be selected. Each one includes a
214 * set of endpoint configurations. They will be in no particular order.
216 * These structures persist for the lifetime of a usb_device, unlike
217 * struct usb_interface (which persists only as long as its configuration
218 * is installed). The altsetting arrays can be accessed through these
219 * structures at any time, permitting comparison of configurations and
220 * providing support for the /proc/bus/usb/devices pseudo-file.
222 struct usb_interface_cache {
223 unsigned num_altsetting; /* number of alternate settings */
224 struct kref ref; /* reference counter */
226 /* variable-length array of alternate settings for this interface,
227 * stored in no particular order */
228 struct usb_host_interface altsetting[0];
230 #define ref_to_usb_interface_cache(r) \
231 container_of(r, struct usb_interface_cache, ref)
232 #define altsetting_to_usb_interface_cache(a) \
233 container_of(a, struct usb_interface_cache, altsetting[0])
236 * struct usb_host_config - representation of a device's configuration
237 * @desc: the device's configuration descriptor.
238 * @string: pointer to the cached version of the iConfiguration string, if
239 * present for this configuration.
240 * @intf_assoc: list of any interface association descriptors in this config
241 * @interface: array of pointers to usb_interface structures, one for each
242 * interface in the configuration. The number of interfaces is stored
243 * in desc.bNumInterfaces. These pointers are valid only while the
244 * the configuration is active.
245 * @intf_cache: array of pointers to usb_interface_cache structures, one
246 * for each interface in the configuration. These structures exist
247 * for the entire life of the device.
248 * @extra: pointer to buffer containing all extra descriptors associated
249 * with this configuration (those preceding the first interface
251 * @extralen: length of the extra descriptors buffer.
253 * USB devices may have multiple configurations, but only one can be active
254 * at any time. Each encapsulates a different operational environment;
255 * for example, a dual-speed device would have separate configurations for
256 * full-speed and high-speed operation. The number of configurations
257 * available is stored in the device descriptor as bNumConfigurations.
259 * A configuration can contain multiple interfaces. Each corresponds to
260 * a different function of the USB device, and all are available whenever
261 * the configuration is active. The USB standard says that interfaces
262 * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot
263 * of devices get this wrong. In addition, the interface array is not
264 * guaranteed to be sorted in numerical order. Use usb_ifnum_to_if() to
265 * look up an interface entry based on its number.
267 * Device drivers should not attempt to activate configurations. The choice
268 * of which configuration to install is a policy decision based on such
269 * considerations as available power, functionality provided, and the user's
270 * desires (expressed through userspace tools). However, drivers can call
271 * usb_reset_configuration() to reinitialize the current configuration and
272 * all its interfaces.
274 struct usb_host_config {
275 struct usb_config_descriptor desc;
277 char *string; /* iConfiguration string, if present */
279 /* List of any Interface Association Descriptors in this
281 struct usb_interface_assoc_descriptor *intf_assoc[USB_MAXIADS];
283 /* the interfaces associated with this configuration,
284 * stored in no particular order */
285 struct usb_interface *interface[USB_MAXINTERFACES];
287 /* Interface information available even when this is not the
288 * active configuration */
289 struct usb_interface_cache *intf_cache[USB_MAXINTERFACES];
291 unsigned char *extra; /* Extra descriptors */
295 /* USB2.0 and USB3.0 device BOS descriptor set */
296 struct usb_host_bos {
297 struct usb_bos_descriptor *desc;
299 /* wireless cap descriptor is handled by wusb */
300 struct usb_ext_cap_descriptor *ext_cap;
301 struct usb_ss_cap_descriptor *ss_cap;
302 struct usb_ss_container_id_descriptor *ss_id;
305 int __usb_get_extra_descriptor(char *buffer, unsigned size,
306 unsigned char type, void **ptr);
307 #define usb_get_extra_descriptor(ifpoint, type, ptr) \
308 __usb_get_extra_descriptor((ifpoint)->extra, \
309 (ifpoint)->extralen, \
312 /* ----------------------------------------------------------------------- */
314 /* USB device number allocation bitmap */
316 unsigned long devicemap[128 / (8*sizeof(unsigned long))];
320 * Allocated per bus (tree of devices) we have:
323 struct device *controller; /* host/master side hardware */
324 int busnum; /* Bus number (in order of reg) */
325 const char *bus_name; /* stable id (PCI slot_name etc) */
326 u8 uses_dma; /* Does the host controller use DMA? */
327 u8 uses_pio_for_control; /*
328 * Does the host controller use PIO
329 * for control transfers?
331 u8 otg_port; /* 0, or number of OTG/HNP port */
332 unsigned is_b_host:1; /* true during some HNP roleswitches */
333 unsigned b_hnp_enable:1; /* OTG: did A-Host enable HNP? */
334 unsigned sg_tablesize; /* 0 or largest number of sg list entries */
336 int devnum_next; /* Next open device number in
337 * round-robin allocation */
339 struct usb_devmap devmap; /* device address allocation map */
340 struct usb_device *root_hub; /* Root hub */
341 struct usb_bus *hs_companion; /* Companion EHCI bus, if any */
342 struct list_head bus_list; /* list of busses */
344 int bandwidth_allocated; /* on this bus: how much of the time
345 * reserved for periodic (intr/iso)
346 * requests is used, on average?
347 * Units: microseconds/frame.
348 * Limits: Full/low speed reserve 90%,
349 * while high speed reserves 80%.
351 int bandwidth_int_reqs; /* number of Interrupt requests */
352 int bandwidth_isoc_reqs; /* number of Isoc. requests */
354 #if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
355 struct mon_bus *mon_bus; /* non-null when associated */
356 int monitored; /* non-zero when monitored */
360 /* ----------------------------------------------------------------------- */
362 /* This is arbitrary.
363 * From USB 2.0 spec Table 11-13, offset 7, a hub can
364 * have up to 255 ports. The most yet reported is 10.
366 * Current Wireless USB host hardware (Intel i1480 for example) allows
367 * up to 22 devices to connect. Upcoming hardware might raise that
368 * limit. Because the arrays need to add a bit for hub status data, we
369 * do 31, so plus one evens out to four bytes.
371 #define USB_MAXCHILDREN (31)
375 enum usb_device_removable {
376 USB_DEVICE_REMOVABLE_UNKNOWN = 0,
377 USB_DEVICE_REMOVABLE,
382 * USB 3.0 Link Power Management (LPM) parameters.
384 * PEL and SEL are USB 3.0 Link PM latencies for device-initiated LPM exit.
385 * MEL is the USB 3.0 Link PM latency for host-initiated LPM exit.
386 * All three are stored in nanoseconds.
388 struct usb3_lpm_parameters {
390 * Maximum exit latency (MEL) for the host to send a packet to the
391 * device (either a Ping for isoc endpoints, or a data packet for
392 * interrupt endpoints), the hubs to decode the packet, and for all hubs
393 * in the path to transition the links to U0.
397 * Maximum exit latency for a device-initiated LPM transition to bring
398 * all links into U0. Abbreviated as "PEL" in section 9.4.12 of the USB
399 * 3.0 spec, with no explanation of what "P" stands for. "Path"?
404 * The System Exit Latency (SEL) includes PEL, and three other
405 * latencies. After a device initiates a U0 transition, it will take
406 * some time from when the device sends the ERDY to when it will finally
407 * receive the data packet. Basically, SEL should be the worse-case
408 * latency from when a device starts initiating a U0 transition to when
415 * struct usb_device - kernel's representation of a USB device
416 * @devnum: device number; address on a USB bus
417 * @devpath: device ID string for use in messages (e.g., /port/...)
418 * @route: tree topology hex string for use with xHCI
419 * @state: device state: configured, not attached, etc.
420 * @speed: device speed: high/full/low (or error)
421 * @tt: Transaction Translator info; used with low/full speed dev, highspeed hub
422 * @ttport: device port on that tt hub
423 * @toggle: one bit for each endpoint, with ([0] = IN, [1] = OUT) endpoints
424 * @parent: our hub, unless we're the root
425 * @bus: bus we're part of
426 * @ep0: endpoint 0 data (default control pipe)
427 * @dev: generic device interface
428 * @descriptor: USB device descriptor
429 * @bos: USB device BOS descriptor set
430 * @config: all of the device's configs
431 * @actconfig: the active configuration
432 * @ep_in: array of IN endpoints
433 * @ep_out: array of OUT endpoints
434 * @rawdescriptors: raw descriptors for each config
435 * @bus_mA: Current available from the bus
436 * @portnum: parent port number (origin 1)
437 * @level: number of USB hub ancestors
438 * @can_submit: URBs may be submitted
439 * @persist_enabled: USB_PERSIST enabled for this device
440 * @have_langid: whether string_langid is valid
441 * @authorized: policy has said we can use it;
442 * (user space) policy determines if we authorize this device to be
443 * used or not. By default, wired USB devices are authorized.
444 * WUSB devices are not, until we authorize them from user space.
445 * FIXME -- complete doc
446 * @authenticated: Crypto authentication passed
447 * @wusb: device is Wireless USB
448 * @lpm_capable: device supports LPM
449 * @usb2_hw_lpm_capable: device can perform USB2 hardware LPM
450 * @usb2_hw_lpm_enabled: USB2 hardware LPM enabled
451 * @string_langid: language ID for strings
452 * @product: iProduct string, if present (static)
453 * @manufacturer: iManufacturer string, if present (static)
454 * @serial: iSerialNumber string, if present (static)
455 * @filelist: usbfs files that are open to this device
456 * @usb_classdev: USB class device that was created for usbfs device
457 * access from userspace
458 * @usbfs_dentry: usbfs dentry entry for the device
459 * @maxchild: number of ports if hub
460 * @children: child devices - USB devices that are attached to this hub
461 * @quirks: quirks of the whole device
462 * @urbnum: number of URBs submitted for the whole device
463 * @active_duration: total time device is not suspended
464 * @connect_time: time device was first connected
465 * @do_remote_wakeup: remote wakeup should be enabled
466 * @reset_resume: needs reset instead of resume
467 * @wusb_dev: if this is a Wireless USB device, link to the WUSB
468 * specific data for the device.
469 * @slot_id: Slot ID assigned by xHCI
470 * @removable: Device can be physically removed from this port
471 * @u1_params: exit latencies for U1 (USB 3.0 LPM).
472 * @u2_params: exit latencies for U2 (USB 3.0 LPM).
475 * Usbcore drivers should not set usbdev->state directly. Instead use
476 * usb_set_device_state().
482 enum usb_device_state state;
483 enum usb_device_speed speed;
488 unsigned int toggle[2];
490 struct usb_device *parent;
492 struct usb_host_endpoint ep0;
496 struct usb_device_descriptor descriptor;
497 struct usb_host_bos *bos;
498 struct usb_host_config *config;
500 struct usb_host_config *actconfig;
501 struct usb_host_endpoint *ep_in[16];
502 struct usb_host_endpoint *ep_out[16];
504 char **rawdescriptors;
506 unsigned short bus_mA;
510 unsigned can_submit:1;
511 unsigned persist_enabled:1;
512 unsigned have_langid:1;
513 unsigned authorized:1;
514 unsigned authenticated:1;
516 unsigned lpm_capable:1;
517 unsigned usb2_hw_lpm_capable:1;
518 unsigned usb2_hw_lpm_enabled:1;
521 /* static strings from the device */
526 struct list_head filelist;
529 struct usb_device **children;
534 unsigned long active_duration;
537 unsigned long connect_time;
539 unsigned do_remote_wakeup:1;
540 unsigned reset_resume:1;
542 struct wusb_dev *wusb_dev;
544 enum usb_device_removable removable;
545 struct usb3_lpm_parameters u1_params;
546 struct usb3_lpm_parameters u2_params;
548 #define to_usb_device(d) container_of(d, struct usb_device, dev)
550 static inline struct usb_device *interface_to_usbdev(struct usb_interface *intf)
552 return to_usb_device(intf->dev.parent);
555 extern struct usb_device *usb_get_dev(struct usb_device *dev);
556 extern void usb_put_dev(struct usb_device *dev);
558 /* USB device locking */
559 #define usb_lock_device(udev) device_lock(&(udev)->dev)
560 #define usb_unlock_device(udev) device_unlock(&(udev)->dev)
561 #define usb_trylock_device(udev) device_trylock(&(udev)->dev)
562 extern int usb_lock_device_for_reset(struct usb_device *udev,
563 const struct usb_interface *iface);
565 /* USB port reset for device reinitialization */
566 extern int usb_reset_device(struct usb_device *dev);
567 extern void usb_queue_reset_device(struct usb_interface *dev);
570 /* USB autosuspend and autoresume */
571 #ifdef CONFIG_USB_SUSPEND
572 extern void usb_enable_autosuspend(struct usb_device *udev);
573 extern void usb_disable_autosuspend(struct usb_device *udev);
575 extern int usb_autopm_get_interface(struct usb_interface *intf);
576 extern void usb_autopm_put_interface(struct usb_interface *intf);
577 extern int usb_autopm_get_interface_async(struct usb_interface *intf);
578 extern void usb_autopm_put_interface_async(struct usb_interface *intf);
579 extern void usb_autopm_get_interface_no_resume(struct usb_interface *intf);
580 extern void usb_autopm_put_interface_no_suspend(struct usb_interface *intf);
582 static inline void usb_mark_last_busy(struct usb_device *udev)
584 pm_runtime_mark_last_busy(&udev->dev);
589 static inline int usb_enable_autosuspend(struct usb_device *udev)
591 static inline int usb_disable_autosuspend(struct usb_device *udev)
594 static inline int usb_autopm_get_interface(struct usb_interface *intf)
596 static inline int usb_autopm_get_interface_async(struct usb_interface *intf)
599 static inline void usb_autopm_put_interface(struct usb_interface *intf)
601 static inline void usb_autopm_put_interface_async(struct usb_interface *intf)
603 static inline void usb_autopm_get_interface_no_resume(
604 struct usb_interface *intf)
606 static inline void usb_autopm_put_interface_no_suspend(
607 struct usb_interface *intf)
609 static inline void usb_mark_last_busy(struct usb_device *udev)
613 /*-------------------------------------------------------------------------*/
615 /* for drivers using iso endpoints */
616 extern int usb_get_current_frame_number(struct usb_device *usb_dev);
618 /* Sets up a group of bulk endpoints to support multiple stream IDs. */
619 extern int usb_alloc_streams(struct usb_interface *interface,
620 struct usb_host_endpoint **eps, unsigned int num_eps,
621 unsigned int num_streams, gfp_t mem_flags);
623 /* Reverts a group of bulk endpoints back to not using stream IDs. */
624 extern void usb_free_streams(struct usb_interface *interface,
625 struct usb_host_endpoint **eps, unsigned int num_eps,
628 /* used these for multi-interface device registration */
629 extern int usb_driver_claim_interface(struct usb_driver *driver,
630 struct usb_interface *iface, void *priv);
633 * usb_interface_claimed - returns true iff an interface is claimed
634 * @iface: the interface being checked
636 * Returns true (nonzero) iff the interface is claimed, else false (zero).
637 * Callers must own the driver model's usb bus readlock. So driver
638 * probe() entries don't need extra locking, but other call contexts
639 * may need to explicitly claim that lock.
642 static inline int usb_interface_claimed(struct usb_interface *iface)
644 return (iface->dev.driver != NULL);
647 extern void usb_driver_release_interface(struct usb_driver *driver,
648 struct usb_interface *iface);
649 const struct usb_device_id *usb_match_id(struct usb_interface *interface,
650 const struct usb_device_id *id);
651 extern int usb_match_one_id(struct usb_interface *interface,
652 const struct usb_device_id *id);
654 extern struct usb_interface *usb_find_interface(struct usb_driver *drv,
656 extern struct usb_interface *usb_ifnum_to_if(const struct usb_device *dev,
658 extern struct usb_host_interface *usb_altnum_to_altsetting(
659 const struct usb_interface *intf, unsigned int altnum);
660 extern struct usb_host_interface *usb_find_alt_setting(
661 struct usb_host_config *config,
662 unsigned int iface_num,
663 unsigned int alt_num);
667 * usb_make_path - returns stable device path in the usb tree
668 * @dev: the device whose path is being constructed
669 * @buf: where to put the string
670 * @size: how big is "buf"?
672 * Returns length of the string (> 0) or negative if size was too small.
674 * This identifier is intended to be "stable", reflecting physical paths in
675 * hardware such as physical bus addresses for host controllers or ports on
676 * USB hubs. That makes it stay the same until systems are physically
677 * reconfigured, by re-cabling a tree of USB devices or by moving USB host
678 * controllers. Adding and removing devices, including virtual root hubs
679 * in host controller driver modules, does not change these path identifiers;
680 * neither does rebooting or re-enumerating. These are more useful identifiers
681 * than changeable ("unstable") ones like bus numbers or device addresses.
683 * With a partial exception for devices connected to USB 2.0 root hubs, these
684 * identifiers are also predictable. So long as the device tree isn't changed,
685 * plugging any USB device into a given hub port always gives it the same path.
686 * Because of the use of "companion" controllers, devices connected to ports on
687 * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are
688 * high speed, and a different one if they are full or low speed.
690 static inline int usb_make_path(struct usb_device *dev, char *buf, size_t size)
693 actual = snprintf(buf, size, "usb-%s-%s", dev->bus->bus_name,
695 return (actual >= (int)size) ? -1 : actual;
698 /*-------------------------------------------------------------------------*/
700 #define USB_DEVICE_ID_MATCH_DEVICE \
701 (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
702 #define USB_DEVICE_ID_MATCH_DEV_RANGE \
703 (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI)
704 #define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
705 (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE)
706 #define USB_DEVICE_ID_MATCH_DEV_INFO \
707 (USB_DEVICE_ID_MATCH_DEV_CLASS | \
708 USB_DEVICE_ID_MATCH_DEV_SUBCLASS | \
709 USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
710 #define USB_DEVICE_ID_MATCH_INT_INFO \
711 (USB_DEVICE_ID_MATCH_INT_CLASS | \
712 USB_DEVICE_ID_MATCH_INT_SUBCLASS | \
713 USB_DEVICE_ID_MATCH_INT_PROTOCOL)
716 * USB_DEVICE - macro used to describe a specific usb device
717 * @vend: the 16 bit USB Vendor ID
718 * @prod: the 16 bit USB Product ID
720 * This macro is used to create a struct usb_device_id that matches a
723 #define USB_DEVICE(vend, prod) \
724 .match_flags = USB_DEVICE_ID_MATCH_DEVICE, \
725 .idVendor = (vend), \
728 * USB_DEVICE_VER - describe a specific usb device with a version range
729 * @vend: the 16 bit USB Vendor ID
730 * @prod: the 16 bit USB Product ID
731 * @lo: the bcdDevice_lo value
732 * @hi: the bcdDevice_hi value
734 * This macro is used to create a struct usb_device_id that matches a
735 * specific device, with a version range.
737 #define USB_DEVICE_VER(vend, prod, lo, hi) \
738 .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, \
739 .idVendor = (vend), \
740 .idProduct = (prod), \
741 .bcdDevice_lo = (lo), \
745 * USB_DEVICE_INTERFACE_PROTOCOL - describe a usb device with a specific interface protocol
746 * @vend: the 16 bit USB Vendor ID
747 * @prod: the 16 bit USB Product ID
748 * @pr: bInterfaceProtocol value
750 * This macro is used to create a struct usb_device_id that matches a
751 * specific interface protocol of devices.
753 #define USB_DEVICE_INTERFACE_PROTOCOL(vend, prod, pr) \
754 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
755 USB_DEVICE_ID_MATCH_INT_PROTOCOL, \
756 .idVendor = (vend), \
757 .idProduct = (prod), \
758 .bInterfaceProtocol = (pr)
761 * USB_DEVICE_INFO - macro used to describe a class of usb devices
762 * @cl: bDeviceClass value
763 * @sc: bDeviceSubClass value
764 * @pr: bDeviceProtocol value
766 * This macro is used to create a struct usb_device_id that matches a
767 * specific class of devices.
769 #define USB_DEVICE_INFO(cl, sc, pr) \
770 .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, \
771 .bDeviceClass = (cl), \
772 .bDeviceSubClass = (sc), \
773 .bDeviceProtocol = (pr)
776 * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces
777 * @cl: bInterfaceClass value
778 * @sc: bInterfaceSubClass value
779 * @pr: bInterfaceProtocol value
781 * This macro is used to create a struct usb_device_id that matches a
782 * specific class of interfaces.
784 #define USB_INTERFACE_INFO(cl, sc, pr) \
785 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, \
786 .bInterfaceClass = (cl), \
787 .bInterfaceSubClass = (sc), \
788 .bInterfaceProtocol = (pr)
791 * USB_DEVICE_AND_INTERFACE_INFO - describe a specific usb device with a class of usb interfaces
792 * @vend: the 16 bit USB Vendor ID
793 * @prod: the 16 bit USB Product ID
794 * @cl: bInterfaceClass value
795 * @sc: bInterfaceSubClass value
796 * @pr: bInterfaceProtocol value
798 * This macro is used to create a struct usb_device_id that matches a
799 * specific device with a specific class of interfaces.
801 * This is especially useful when explicitly matching devices that have
802 * vendor specific bDeviceClass values, but standards-compliant interfaces.
804 #define USB_DEVICE_AND_INTERFACE_INFO(vend, prod, cl, sc, pr) \
805 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO \
806 | USB_DEVICE_ID_MATCH_DEVICE, \
807 .idVendor = (vend), \
808 .idProduct = (prod), \
809 .bInterfaceClass = (cl), \
810 .bInterfaceSubClass = (sc), \
811 .bInterfaceProtocol = (pr)
813 /* ----------------------------------------------------------------------- */
815 /* Stuff for dynamic usb ids */
818 struct list_head list;
822 struct list_head node;
823 struct usb_device_id id;
826 extern ssize_t usb_store_new_id(struct usb_dynids *dynids,
827 struct device_driver *driver,
828 const char *buf, size_t count);
830 extern ssize_t usb_show_dynids(struct usb_dynids *dynids, char *buf);
833 * struct usbdrv_wrap - wrapper for driver-model structure
834 * @driver: The driver-model core driver structure.
835 * @for_devices: Non-zero for device drivers, 0 for interface drivers.
838 struct device_driver driver;
843 * struct usb_driver - identifies USB interface driver to usbcore
844 * @name: The driver name should be unique among USB drivers,
845 * and should normally be the same as the module name.
846 * @probe: Called to see if the driver is willing to manage a particular
847 * interface on a device. If it is, probe returns zero and uses
848 * usb_set_intfdata() to associate driver-specific data with the
849 * interface. It may also use usb_set_interface() to specify the
850 * appropriate altsetting. If unwilling to manage the interface,
851 * return -ENODEV, if genuine IO errors occurred, an appropriate
852 * negative errno value.
853 * @disconnect: Called when the interface is no longer accessible, usually
854 * because its device has been (or is being) disconnected or the
855 * driver module is being unloaded.
856 * @unlocked_ioctl: Used for drivers that want to talk to userspace through
857 * the "usbfs" filesystem. This lets devices provide ways to
858 * expose information to user space regardless of where they
859 * do (or don't) show up otherwise in the filesystem.
860 * @suspend: Called when the device is going to be suspended by the system.
861 * @resume: Called when the device is being resumed by the system.
862 * @reset_resume: Called when the suspended device has been reset instead
864 * @pre_reset: Called by usb_reset_device() when the device is about to be
865 * reset. This routine must not return until the driver has no active
866 * URBs for the device, and no more URBs may be submitted until the
867 * post_reset method is called.
868 * @post_reset: Called by usb_reset_device() after the device
870 * @id_table: USB drivers use ID table to support hotplugging.
871 * Export this with MODULE_DEVICE_TABLE(usb,...). This must be set
872 * or your driver's probe function will never get called.
873 * @dynids: used internally to hold the list of dynamically added device
874 * ids for this driver.
875 * @drvwrap: Driver-model core structure wrapper.
876 * @no_dynamic_id: if set to 1, the USB core will not allow dynamic ids to be
877 * added to this driver by preventing the sysfs file from being created.
878 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
879 * for interfaces bound to this driver.
880 * @soft_unbind: if set to 1, the USB core will not kill URBs and disable
881 * endpoints before calling the driver's disconnect method.
882 * @disable_hub_initiated_lpm: if set to 0, the USB core will not allow hubs
883 * to initiate lower power link state transitions when an idle timeout
884 * occurs. Device-initiated USB 3.0 link PM will still be allowed.
886 * USB interface drivers must provide a name, probe() and disconnect()
887 * methods, and an id_table. Other driver fields are optional.
889 * The id_table is used in hotplugging. It holds a set of descriptors,
890 * and specialized data may be associated with each entry. That table
891 * is used by both user and kernel mode hotplugging support.
893 * The probe() and disconnect() methods are called in a context where
894 * they can sleep, but they should avoid abusing the privilege. Most
895 * work to connect to a device should be done when the device is opened,
896 * and undone at the last close. The disconnect code needs to address
897 * concurrency issues with respect to open() and close() methods, as
898 * well as forcing all pending I/O requests to complete (by unlinking
899 * them as necessary, and blocking until the unlinks complete).
904 int (*probe) (struct usb_interface *intf,
905 const struct usb_device_id *id);
907 void (*disconnect) (struct usb_interface *intf);
909 int (*unlocked_ioctl) (struct usb_interface *intf, unsigned int code,
912 int (*suspend) (struct usb_interface *intf, pm_message_t message);
913 int (*resume) (struct usb_interface *intf);
914 int (*reset_resume)(struct usb_interface *intf);
916 int (*pre_reset)(struct usb_interface *intf);
917 int (*post_reset)(struct usb_interface *intf);
919 const struct usb_device_id *id_table;
921 struct usb_dynids dynids;
922 struct usbdrv_wrap drvwrap;
923 unsigned int no_dynamic_id:1;
924 unsigned int supports_autosuspend:1;
925 unsigned int disable_hub_initiated_lpm:1;
926 unsigned int soft_unbind:1;
928 #define to_usb_driver(d) container_of(d, struct usb_driver, drvwrap.driver)
931 * struct usb_device_driver - identifies USB device driver to usbcore
932 * @name: The driver name should be unique among USB drivers,
933 * and should normally be the same as the module name.
934 * @probe: Called to see if the driver is willing to manage a particular
935 * device. If it is, probe returns zero and uses dev_set_drvdata()
936 * to associate driver-specific data with the device. If unwilling
937 * to manage the device, return a negative errno value.
938 * @disconnect: Called when the device is no longer accessible, usually
939 * because it has been (or is being) disconnected or the driver's
940 * module is being unloaded.
941 * @suspend: Called when the device is going to be suspended by the system.
942 * @resume: Called when the device is being resumed by the system.
943 * @drvwrap: Driver-model core structure wrapper.
944 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
945 * for devices bound to this driver.
947 * USB drivers must provide all the fields listed above except drvwrap.
949 struct usb_device_driver {
952 int (*probe) (struct usb_device *udev);
953 void (*disconnect) (struct usb_device *udev);
955 int (*suspend) (struct usb_device *udev, pm_message_t message);
956 int (*resume) (struct usb_device *udev, pm_message_t message);
957 struct usbdrv_wrap drvwrap;
958 unsigned int supports_autosuspend:1;
960 #define to_usb_device_driver(d) container_of(d, struct usb_device_driver, \
963 extern struct bus_type usb_bus_type;
966 * struct usb_class_driver - identifies a USB driver that wants to use the USB major number
967 * @name: the usb class device name for this driver. Will show up in sysfs.
968 * @devnode: Callback to provide a naming hint for a possible
969 * device node to create.
970 * @fops: pointer to the struct file_operations of this driver.
971 * @minor_base: the start of the minor range for this driver.
973 * This structure is used for the usb_register_dev() and
974 * usb_unregister_dev() functions, to consolidate a number of the
975 * parameters used for them.
977 struct usb_class_driver {
979 char *(*devnode)(struct device *dev, umode_t *mode);
980 const struct file_operations *fops;
985 * use these in module_init()/module_exit()
986 * and don't forget MODULE_DEVICE_TABLE(usb, ...)
988 extern int usb_register_driver(struct usb_driver *, struct module *,
991 /* use a define to avoid include chaining to get THIS_MODULE & friends */
992 #define usb_register(driver) \
993 usb_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
995 extern void usb_deregister(struct usb_driver *);
998 * module_usb_driver() - Helper macro for registering a USB driver
999 * @__usb_driver: usb_driver struct
1001 * Helper macro for USB drivers which do not do anything special in module
1002 * init/exit. This eliminates a lot of boilerplate. Each module may only
1003 * use this macro once, and calling it replaces module_init() and module_exit()
1005 #define module_usb_driver(__usb_driver) \
1006 module_driver(__usb_driver, usb_register, \
1009 extern int usb_register_device_driver(struct usb_device_driver *,
1011 extern void usb_deregister_device_driver(struct usb_device_driver *);
1013 extern int usb_register_dev(struct usb_interface *intf,
1014 struct usb_class_driver *class_driver);
1015 extern void usb_deregister_dev(struct usb_interface *intf,
1016 struct usb_class_driver *class_driver);
1018 extern int usb_disabled(void);
1020 /* ----------------------------------------------------------------------- */
1023 * URB support, for asynchronous request completions
1027 * urb->transfer_flags:
1029 * Note: URB_DIR_IN/OUT is automatically set in usb_submit_urb().
1031 #define URB_SHORT_NOT_OK 0x0001 /* report short reads as errors */
1032 #define URB_ISO_ASAP 0x0002 /* iso-only, urb->start_frame
1034 #define URB_NO_TRANSFER_DMA_MAP 0x0004 /* urb->transfer_dma valid on submit */
1035 #define URB_NO_FSBR 0x0020 /* UHCI-specific */
1036 #define URB_ZERO_PACKET 0x0040 /* Finish bulk OUT with short packet */
1037 #define URB_NO_INTERRUPT 0x0080 /* HINT: no non-error interrupt
1039 #define URB_FREE_BUFFER 0x0100 /* Free transfer buffer with the URB */
1041 /* The following flags are used internally by usbcore and HCDs */
1042 #define URB_DIR_IN 0x0200 /* Transfer from device to host */
1043 #define URB_DIR_OUT 0
1044 #define URB_DIR_MASK URB_DIR_IN
1046 #define URB_DMA_MAP_SINGLE 0x00010000 /* Non-scatter-gather mapping */
1047 #define URB_DMA_MAP_PAGE 0x00020000 /* HCD-unsupported S-G */
1048 #define URB_DMA_MAP_SG 0x00040000 /* HCD-supported S-G */
1049 #define URB_MAP_LOCAL 0x00080000 /* HCD-local-memory mapping */
1050 #define URB_SETUP_MAP_SINGLE 0x00100000 /* Setup packet DMA mapped */
1051 #define URB_SETUP_MAP_LOCAL 0x00200000 /* HCD-local setup packet */
1052 #define URB_DMA_SG_COMBINED 0x00400000 /* S-G entries were combined */
1053 #define URB_ALIGNED_TEMP_BUFFER 0x00800000 /* Temp buffer was alloc'd */
1055 struct usb_iso_packet_descriptor {
1056 unsigned int offset;
1057 unsigned int length; /* expected length */
1058 unsigned int actual_length;
1065 struct list_head urb_list;
1066 wait_queue_head_t wait;
1068 unsigned int poisoned:1;
1071 static inline void init_usb_anchor(struct usb_anchor *anchor)
1073 INIT_LIST_HEAD(&anchor->urb_list);
1074 init_waitqueue_head(&anchor->wait);
1075 spin_lock_init(&anchor->lock);
1078 typedef void (*usb_complete_t)(struct urb *);
1081 * struct urb - USB Request Block
1082 * @urb_list: For use by current owner of the URB.
1083 * @anchor_list: membership in the list of an anchor
1084 * @anchor: to anchor URBs to a common mooring
1085 * @ep: Points to the endpoint's data structure. Will eventually
1087 * @pipe: Holds endpoint number, direction, type, and more.
1088 * Create these values with the eight macros available;
1089 * usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl"
1090 * (control), "bulk", "int" (interrupt), or "iso" (isochronous).
1091 * For example usb_sndbulkpipe() or usb_rcvintpipe(). Endpoint
1092 * numbers range from zero to fifteen. Note that "in" endpoint two
1093 * is a different endpoint (and pipe) from "out" endpoint two.
1094 * The current configuration controls the existence, type, and
1095 * maximum packet size of any given endpoint.
1096 * @stream_id: the endpoint's stream ID for bulk streams
1097 * @dev: Identifies the USB device to perform the request.
1098 * @status: This is read in non-iso completion functions to get the
1099 * status of the particular request. ISO requests only use it
1100 * to tell whether the URB was unlinked; detailed status for
1101 * each frame is in the fields of the iso_frame-desc.
1102 * @transfer_flags: A variety of flags may be used to affect how URB
1103 * submission, unlinking, or operation are handled. Different
1104 * kinds of URB can use different flags.
1105 * @transfer_buffer: This identifies the buffer to (or from) which the I/O
1106 * request will be performed unless URB_NO_TRANSFER_DMA_MAP is set
1107 * (however, do not leave garbage in transfer_buffer even then).
1108 * This buffer must be suitable for DMA; allocate it with
1109 * kmalloc() or equivalent. For transfers to "in" endpoints, contents
1110 * of this buffer will be modified. This buffer is used for the data
1111 * stage of control transfers.
1112 * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP,
1113 * the device driver is saying that it provided this DMA address,
1114 * which the host controller driver should use in preference to the
1116 * @sg: scatter gather buffer list
1117 * @num_mapped_sgs: (internal) number of mapped sg entries
1118 * @num_sgs: number of entries in the sg list
1119 * @transfer_buffer_length: How big is transfer_buffer. The transfer may
1120 * be broken up into chunks according to the current maximum packet
1121 * size for the endpoint, which is a function of the configuration
1122 * and is encoded in the pipe. When the length is zero, neither
1123 * transfer_buffer nor transfer_dma is used.
1124 * @actual_length: This is read in non-iso completion functions, and
1125 * it tells how many bytes (out of transfer_buffer_length) were
1126 * transferred. It will normally be the same as requested, unless
1127 * either an error was reported or a short read was performed.
1128 * The URB_SHORT_NOT_OK transfer flag may be used to make such
1129 * short reads be reported as errors.
1130 * @setup_packet: Only used for control transfers, this points to eight bytes
1131 * of setup data. Control transfers always start by sending this data
1132 * to the device. Then transfer_buffer is read or written, if needed.
1133 * @setup_dma: DMA pointer for the setup packet. The caller must not use
1134 * this field; setup_packet must point to a valid buffer.
1135 * @start_frame: Returns the initial frame for isochronous transfers.
1136 * @number_of_packets: Lists the number of ISO transfer buffers.
1137 * @interval: Specifies the polling interval for interrupt or isochronous
1138 * transfers. The units are frames (milliseconds) for full and low
1139 * speed devices, and microframes (1/8 millisecond) for highspeed
1140 * and SuperSpeed devices.
1141 * @error_count: Returns the number of ISO transfers that reported errors.
1142 * @context: For use in completion functions. This normally points to
1143 * request-specific driver context.
1144 * @complete: Completion handler. This URB is passed as the parameter to the
1145 * completion function. The completion function may then do what
1146 * it likes with the URB, including resubmitting or freeing it.
1147 * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to
1148 * collect the transfer status for each buffer.
1150 * This structure identifies USB transfer requests. URBs must be allocated by
1151 * calling usb_alloc_urb() and freed with a call to usb_free_urb().
1152 * Initialization may be done using various usb_fill_*_urb() functions. URBs
1153 * are submitted using usb_submit_urb(), and pending requests may be canceled
1154 * using usb_unlink_urb() or usb_kill_urb().
1156 * Data Transfer Buffers:
1158 * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise
1159 * taken from the general page pool. That is provided by transfer_buffer
1160 * (control requests also use setup_packet), and host controller drivers
1161 * perform a dma mapping (and unmapping) for each buffer transferred. Those
1162 * mapping operations can be expensive on some platforms (perhaps using a dma
1163 * bounce buffer or talking to an IOMMU),
1164 * although they're cheap on commodity x86 and ppc hardware.
1166 * Alternatively, drivers may pass the URB_NO_TRANSFER_DMA_MAP transfer flag,
1167 * which tells the host controller driver that no such mapping is needed for
1168 * the transfer_buffer since
1169 * the device driver is DMA-aware. For example, a device driver might
1170 * allocate a DMA buffer with usb_alloc_coherent() or call usb_buffer_map().
1171 * When this transfer flag is provided, host controller drivers will
1172 * attempt to use the dma address found in the transfer_dma
1173 * field rather than determining a dma address themselves.
1175 * Note that transfer_buffer must still be set if the controller
1176 * does not support DMA (as indicated by bus.uses_dma) and when talking
1177 * to root hub. If you have to trasfer between highmem zone and the device
1178 * on such controller, create a bounce buffer or bail out with an error.
1179 * If transfer_buffer cannot be set (is in highmem) and the controller is DMA
1180 * capable, assign NULL to it, so that usbmon knows not to use the value.
1181 * The setup_packet must always be set, so it cannot be located in highmem.
1185 * All URBs submitted must initialize the dev, pipe, transfer_flags (may be
1186 * zero), and complete fields. All URBs must also initialize
1187 * transfer_buffer and transfer_buffer_length. They may provide the
1188 * URB_SHORT_NOT_OK transfer flag, indicating that short reads are
1189 * to be treated as errors; that flag is invalid for write requests.
1192 * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers
1193 * should always terminate with a short packet, even if it means adding an
1194 * extra zero length packet.
1196 * Control URBs must provide a valid pointer in the setup_packet field.
1197 * Unlike the transfer_buffer, the setup_packet may not be mapped for DMA
1200 * Interrupt URBs must provide an interval, saying how often (in milliseconds
1201 * or, for highspeed devices, 125 microsecond units)
1202 * to poll for transfers. After the URB has been submitted, the interval
1203 * field reflects how the transfer was actually scheduled.
1204 * The polling interval may be more frequent than requested.
1205 * For example, some controllers have a maximum interval of 32 milliseconds,
1206 * while others support intervals of up to 1024 milliseconds.
1207 * Isochronous URBs also have transfer intervals. (Note that for isochronous
1208 * endpoints, as well as high speed interrupt endpoints, the encoding of
1209 * the transfer interval in the endpoint descriptor is logarithmic.
1210 * Device drivers must convert that value to linear units themselves.)
1212 * Isochronous URBs normally use the URB_ISO_ASAP transfer flag, telling
1213 * the host controller to schedule the transfer as soon as bandwidth
1214 * utilization allows, and then set start_frame to reflect the actual frame
1215 * selected during submission. Otherwise drivers must specify the start_frame
1216 * and handle the case where the transfer can't begin then. However, drivers
1217 * won't know how bandwidth is currently allocated, and while they can
1218 * find the current frame using usb_get_current_frame_number () they can't
1219 * know the range for that frame number. (Ranges for frame counter values
1220 * are HC-specific, and can go from 256 to 65536 frames from "now".)
1222 * Isochronous URBs have a different data transfer model, in part because
1223 * the quality of service is only "best effort". Callers provide specially
1224 * allocated URBs, with number_of_packets worth of iso_frame_desc structures
1225 * at the end. Each such packet is an individual ISO transfer. Isochronous
1226 * URBs are normally queued, submitted by drivers to arrange that
1227 * transfers are at least double buffered, and then explicitly resubmitted
1228 * in completion handlers, so
1229 * that data (such as audio or video) streams at as constant a rate as the
1230 * host controller scheduler can support.
1232 * Completion Callbacks:
1234 * The completion callback is made in_interrupt(), and one of the first
1235 * things that a completion handler should do is check the status field.
1236 * The status field is provided for all URBs. It is used to report
1237 * unlinked URBs, and status for all non-ISO transfers. It should not
1238 * be examined before the URB is returned to the completion handler.
1240 * The context field is normally used to link URBs back to the relevant
1241 * driver or request state.
1243 * When the completion callback is invoked for non-isochronous URBs, the
1244 * actual_length field tells how many bytes were transferred. This field
1245 * is updated even when the URB terminated with an error or was unlinked.
1247 * ISO transfer status is reported in the status and actual_length fields
1248 * of the iso_frame_desc array, and the number of errors is reported in
1249 * error_count. Completion callbacks for ISO transfers will normally
1250 * (re)submit URBs to ensure a constant transfer rate.
1252 * Note that even fields marked "public" should not be touched by the driver
1253 * when the urb is owned by the hcd, that is, since the call to
1254 * usb_submit_urb() till the entry into the completion routine.
1257 /* private: usb core and host controller only fields in the urb */
1258 struct kref kref; /* reference count of the URB */
1259 void *hcpriv; /* private data for host controller */
1260 atomic_t use_count; /* concurrent submissions counter */
1261 atomic_t reject; /* submissions will fail */
1262 int unlinked; /* unlink error code */
1264 /* public: documented fields in the urb that can be used by drivers */
1265 struct list_head urb_list; /* list head for use by the urb's
1267 struct list_head anchor_list; /* the URB may be anchored */
1268 struct usb_anchor *anchor;
1269 struct usb_device *dev; /* (in) pointer to associated device */
1270 struct usb_host_endpoint *ep; /* (internal) pointer to endpoint */
1271 unsigned int pipe; /* (in) pipe information */
1272 unsigned int stream_id; /* (in) stream ID */
1273 int status; /* (return) non-ISO status */
1274 unsigned int transfer_flags; /* (in) URB_SHORT_NOT_OK | ...*/
1275 void *transfer_buffer; /* (in) associated data buffer */
1276 dma_addr_t transfer_dma; /* (in) dma addr for transfer_buffer */
1277 struct scatterlist *sg; /* (in) scatter gather buffer list */
1278 int num_mapped_sgs; /* (internal) mapped sg entries */
1279 int num_sgs; /* (in) number of entries in the sg list */
1280 u32 transfer_buffer_length; /* (in) data buffer length */
1281 u32 actual_length; /* (return) actual transfer length */
1282 unsigned char *setup_packet; /* (in) setup packet (control only) */
1283 dma_addr_t setup_dma; /* (in) dma addr for setup_packet */
1284 int start_frame; /* (modify) start frame (ISO) */
1285 int number_of_packets; /* (in) number of ISO packets */
1286 int interval; /* (modify) transfer interval
1288 int error_count; /* (return) number of ISO errors */
1289 void *context; /* (in) context for completion */
1290 usb_complete_t complete; /* (in) completion routine */
1291 struct usb_iso_packet_descriptor iso_frame_desc[0];
1295 /* ----------------------------------------------------------------------- */
1298 * usb_fill_control_urb - initializes a control urb
1299 * @urb: pointer to the urb to initialize.
1300 * @dev: pointer to the struct usb_device for this urb.
1301 * @pipe: the endpoint pipe
1302 * @setup_packet: pointer to the setup_packet buffer
1303 * @transfer_buffer: pointer to the transfer buffer
1304 * @buffer_length: length of the transfer buffer
1305 * @complete_fn: pointer to the usb_complete_t function
1306 * @context: what to set the urb context to.
1308 * Initializes a control urb with the proper information needed to submit
1311 static inline void usb_fill_control_urb(struct urb *urb,
1312 struct usb_device *dev,
1314 unsigned char *setup_packet,
1315 void *transfer_buffer,
1317 usb_complete_t complete_fn,
1322 urb->setup_packet = setup_packet;
1323 urb->transfer_buffer = transfer_buffer;
1324 urb->transfer_buffer_length = buffer_length;
1325 urb->complete = complete_fn;
1326 urb->context = context;
1330 * usb_fill_bulk_urb - macro to help initialize a bulk urb
1331 * @urb: pointer to the urb to initialize.
1332 * @dev: pointer to the struct usb_device for this urb.
1333 * @pipe: the endpoint pipe
1334 * @transfer_buffer: pointer to the transfer buffer
1335 * @buffer_length: length of the transfer buffer
1336 * @complete_fn: pointer to the usb_complete_t function
1337 * @context: what to set the urb context to.
1339 * Initializes a bulk urb with the proper information needed to submit it
1342 static inline void usb_fill_bulk_urb(struct urb *urb,
1343 struct usb_device *dev,
1345 void *transfer_buffer,
1347 usb_complete_t complete_fn,
1352 urb->transfer_buffer = transfer_buffer;
1353 urb->transfer_buffer_length = buffer_length;
1354 urb->complete = complete_fn;
1355 urb->context = context;
1359 * usb_fill_int_urb - macro to help initialize a interrupt urb
1360 * @urb: pointer to the urb to initialize.
1361 * @dev: pointer to the struct usb_device for this urb.
1362 * @pipe: the endpoint pipe
1363 * @transfer_buffer: pointer to the transfer buffer
1364 * @buffer_length: length of the transfer buffer
1365 * @complete_fn: pointer to the usb_complete_t function
1366 * @context: what to set the urb context to.
1367 * @interval: what to set the urb interval to, encoded like
1368 * the endpoint descriptor's bInterval value.
1370 * Initializes a interrupt urb with the proper information needed to submit
1373 * Note that High Speed and SuperSpeed interrupt endpoints use a logarithmic
1374 * encoding of the endpoint interval, and express polling intervals in
1375 * microframes (eight per millisecond) rather than in frames (one per
1378 * Wireless USB also uses the logarithmic encoding, but specifies it in units of
1379 * 128us instead of 125us. For Wireless USB devices, the interval is passed
1380 * through to the host controller, rather than being translated into microframe
1383 static inline void usb_fill_int_urb(struct urb *urb,
1384 struct usb_device *dev,
1386 void *transfer_buffer,
1388 usb_complete_t complete_fn,
1394 urb->transfer_buffer = transfer_buffer;
1395 urb->transfer_buffer_length = buffer_length;
1396 urb->complete = complete_fn;
1397 urb->context = context;
1398 if (dev->speed == USB_SPEED_HIGH || dev->speed == USB_SPEED_SUPER)
1399 urb->interval = 1 << (interval - 1);
1401 urb->interval = interval;
1402 urb->start_frame = -1;
1405 extern void usb_init_urb(struct urb *urb);
1406 extern struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags);
1407 extern void usb_free_urb(struct urb *urb);
1408 #define usb_put_urb usb_free_urb
1409 extern struct urb *usb_get_urb(struct urb *urb);
1410 extern int usb_submit_urb(struct urb *urb, gfp_t mem_flags);
1411 extern int usb_unlink_urb(struct urb *urb);
1412 extern void usb_kill_urb(struct urb *urb);
1413 extern void usb_poison_urb(struct urb *urb);
1414 extern void usb_unpoison_urb(struct urb *urb);
1415 extern void usb_block_urb(struct urb *urb);
1416 extern void usb_kill_anchored_urbs(struct usb_anchor *anchor);
1417 extern void usb_poison_anchored_urbs(struct usb_anchor *anchor);
1418 extern void usb_unpoison_anchored_urbs(struct usb_anchor *anchor);
1419 extern void usb_unlink_anchored_urbs(struct usb_anchor *anchor);
1420 extern void usb_anchor_urb(struct urb *urb, struct usb_anchor *anchor);
1421 extern void usb_unanchor_urb(struct urb *urb);
1422 extern int usb_wait_anchor_empty_timeout(struct usb_anchor *anchor,
1423 unsigned int timeout);
1424 extern struct urb *usb_get_from_anchor(struct usb_anchor *anchor);
1425 extern void usb_scuttle_anchored_urbs(struct usb_anchor *anchor);
1426 extern int usb_anchor_empty(struct usb_anchor *anchor);
1428 #define usb_unblock_urb usb_unpoison_urb
1431 * usb_urb_dir_in - check if an URB describes an IN transfer
1432 * @urb: URB to be checked
1434 * Returns 1 if @urb describes an IN transfer (device-to-host),
1437 static inline int usb_urb_dir_in(struct urb *urb)
1439 return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_IN;
1443 * usb_urb_dir_out - check if an URB describes an OUT transfer
1444 * @urb: URB to be checked
1446 * Returns 1 if @urb describes an OUT transfer (host-to-device),
1449 static inline int usb_urb_dir_out(struct urb *urb)
1451 return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_OUT;
1454 void *usb_alloc_coherent(struct usb_device *dev, size_t size,
1455 gfp_t mem_flags, dma_addr_t *dma);
1456 void usb_free_coherent(struct usb_device *dev, size_t size,
1457 void *addr, dma_addr_t dma);
1460 struct urb *usb_buffer_map(struct urb *urb);
1461 void usb_buffer_dmasync(struct urb *urb);
1462 void usb_buffer_unmap(struct urb *urb);
1466 int usb_buffer_map_sg(const struct usb_device *dev, int is_in,
1467 struct scatterlist *sg, int nents);
1469 void usb_buffer_dmasync_sg(const struct usb_device *dev, int is_in,
1470 struct scatterlist *sg, int n_hw_ents);
1472 void usb_buffer_unmap_sg(const struct usb_device *dev, int is_in,
1473 struct scatterlist *sg, int n_hw_ents);
1475 /*-------------------------------------------------------------------*
1476 * SYNCHRONOUS CALL SUPPORT *
1477 *-------------------------------------------------------------------*/
1479 extern int usb_control_msg(struct usb_device *dev, unsigned int pipe,
1480 __u8 request, __u8 requesttype, __u16 value, __u16 index,
1481 void *data, __u16 size, int timeout);
1482 extern int usb_interrupt_msg(struct usb_device *usb_dev, unsigned int pipe,
1483 void *data, int len, int *actual_length, int timeout);
1484 extern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,
1485 void *data, int len, int *actual_length,
1488 /* wrappers around usb_control_msg() for the most common standard requests */
1489 extern int usb_get_descriptor(struct usb_device *dev, unsigned char desctype,
1490 unsigned char descindex, void *buf, int size);
1491 extern int usb_get_status(struct usb_device *dev,
1492 int type, int target, void *data);
1493 extern int usb_string(struct usb_device *dev, int index,
1494 char *buf, size_t size);
1496 /* wrappers that also update important state inside usbcore */
1497 extern int usb_clear_halt(struct usb_device *dev, int pipe);
1498 extern int usb_reset_configuration(struct usb_device *dev);
1499 extern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate);
1500 extern void usb_reset_endpoint(struct usb_device *dev, unsigned int epaddr);
1502 /* this request isn't really synchronous, but it belongs with the others */
1503 extern int usb_driver_set_configuration(struct usb_device *udev, int config);
1506 * timeouts, in milliseconds, used for sending/receiving control messages
1507 * they typically complete within a few frames (msec) after they're issued
1508 * USB identifies 5 second timeouts, maybe more in a few cases, and a few
1509 * slow devices (like some MGE Ellipse UPSes) actually push that limit.
1511 #define USB_CTRL_GET_TIMEOUT 5000
1512 #define USB_CTRL_SET_TIMEOUT 5000
1516 * struct usb_sg_request - support for scatter/gather I/O
1517 * @status: zero indicates success, else negative errno
1518 * @bytes: counts bytes transferred.
1520 * These requests are initialized using usb_sg_init(), and then are used
1521 * as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most
1522 * members of the request object aren't for driver access.
1524 * The status and bytecount values are valid only after usb_sg_wait()
1525 * returns. If the status is zero, then the bytecount matches the total
1528 * After an error completion, drivers may need to clear a halt condition
1531 struct usb_sg_request {
1536 * members below are private to usbcore,
1537 * and are not provided for driver access!
1541 struct usb_device *dev;
1548 struct completion complete;
1552 struct usb_sg_request *io,
1553 struct usb_device *dev,
1556 struct scatterlist *sg,
1561 void usb_sg_cancel(struct usb_sg_request *io);
1562 void usb_sg_wait(struct usb_sg_request *io);
1565 /* ----------------------------------------------------------------------- */
1568 * For various legacy reasons, Linux has a small cookie that's paired with
1569 * a struct usb_device to identify an endpoint queue. Queue characteristics
1570 * are defined by the endpoint's descriptor. This cookie is called a "pipe",
1571 * an unsigned int encoded as:
1573 * - direction: bit 7 (0 = Host-to-Device [Out],
1574 * 1 = Device-to-Host [In] ...
1575 * like endpoint bEndpointAddress)
1576 * - device address: bits 8-14 ... bit positions known to uhci-hcd
1577 * - endpoint: bits 15-18 ... bit positions known to uhci-hcd
1578 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
1579 * 10 = control, 11 = bulk)
1581 * Given the device address and endpoint descriptor, pipes are redundant.
1584 /* NOTE: these are not the standard USB_ENDPOINT_XFER_* values!! */
1585 /* (yet ... they're the values used by usbfs) */
1586 #define PIPE_ISOCHRONOUS 0
1587 #define PIPE_INTERRUPT 1
1588 #define PIPE_CONTROL 2
1591 #define usb_pipein(pipe) ((pipe) & USB_DIR_IN)
1592 #define usb_pipeout(pipe) (!usb_pipein(pipe))
1594 #define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
1595 #define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
1597 #define usb_pipetype(pipe) (((pipe) >> 30) & 3)
1598 #define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
1599 #define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
1600 #define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
1601 #define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
1603 static inline unsigned int __create_pipe(struct usb_device *dev,
1604 unsigned int endpoint)
1606 return (dev->devnum << 8) | (endpoint << 15);
1609 /* Create various pipes... */
1610 #define usb_sndctrlpipe(dev, endpoint) \
1611 ((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint))
1612 #define usb_rcvctrlpipe(dev, endpoint) \
1613 ((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
1614 #define usb_sndisocpipe(dev, endpoint) \
1615 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint))
1616 #define usb_rcvisocpipe(dev, endpoint) \
1617 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
1618 #define usb_sndbulkpipe(dev, endpoint) \
1619 ((PIPE_BULK << 30) | __create_pipe(dev, endpoint))
1620 #define usb_rcvbulkpipe(dev, endpoint) \
1621 ((PIPE_BULK << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
1622 #define usb_sndintpipe(dev, endpoint) \
1623 ((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint))
1624 #define usb_rcvintpipe(dev, endpoint) \
1625 ((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
1627 static inline struct usb_host_endpoint *
1628 usb_pipe_endpoint(struct usb_device *dev, unsigned int pipe)
1630 struct usb_host_endpoint **eps;
1631 eps = usb_pipein(pipe) ? dev->ep_in : dev->ep_out;
1632 return eps[usb_pipeendpoint(pipe)];
1635 /*-------------------------------------------------------------------------*/
1638 usb_maxpacket(struct usb_device *udev, int pipe, int is_out)
1640 struct usb_host_endpoint *ep;
1641 unsigned epnum = usb_pipeendpoint(pipe);
1644 WARN_ON(usb_pipein(pipe));
1645 ep = udev->ep_out[epnum];
1647 WARN_ON(usb_pipeout(pipe));
1648 ep = udev->ep_in[epnum];
1653 /* NOTE: only 0x07ff bits are for packet size... */
1654 return usb_endpoint_maxp(&ep->desc);
1657 /* ----------------------------------------------------------------------- */
1659 /* translate USB error codes to codes user space understands */
1660 static inline int usb_translate_errors(int error_code)
1662 switch (error_code) {
1673 /* Events from the usb core */
1674 #define USB_DEVICE_ADD 0x0001
1675 #define USB_DEVICE_REMOVE 0x0002
1676 #define USB_BUS_ADD 0x0003
1677 #define USB_BUS_REMOVE 0x0004
1678 extern void usb_register_notify(struct notifier_block *nb);
1679 extern void usb_unregister_notify(struct notifier_block *nb);
1682 #define dbg(format, arg...) \
1683 printk(KERN_DEBUG "%s: " format "\n", __FILE__, ##arg)
1685 #define dbg(format, arg...) \
1688 printk(KERN_DEBUG "%s: " format "\n", __FILE__, ##arg); \
1693 extern struct dentry *usb_debug_root;
1695 #endif /* __KERNEL__ */