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
60 * @streams: number of USB-3 streams allocated on the endpoint
62 * USB requests are always queued to a given endpoint, identified by a
63 * descriptor within an active interface in a given USB configuration.
65 struct usb_host_endpoint {
66 struct usb_endpoint_descriptor desc;
67 struct usb_ss_ep_comp_descriptor ss_ep_comp;
68 struct list_head urb_list;
70 struct ep_device *ep_dev; /* For sysfs info */
72 unsigned char *extra; /* Extra descriptors */
78 /* host-side wrapper for one interface setting's parsed descriptors */
79 struct usb_host_interface {
80 struct usb_interface_descriptor desc;
83 unsigned char *extra; /* Extra descriptors */
85 /* array of desc.bNumEndpoint endpoints associated with this
86 * interface setting. these will be in no particular order.
88 struct usb_host_endpoint *endpoint;
90 char *string; /* iInterface string, if present */
93 enum usb_interface_condition {
94 USB_INTERFACE_UNBOUND = 0,
95 USB_INTERFACE_BINDING,
97 USB_INTERFACE_UNBINDING,
101 * struct usb_interface - what usb device drivers talk to
102 * @altsetting: array of interface structures, one for each alternate
103 * setting that may be selected. Each one includes a set of
104 * endpoint configurations. They will be in no particular order.
105 * @cur_altsetting: the current altsetting.
106 * @num_altsetting: number of altsettings defined.
107 * @intf_assoc: interface association descriptor
108 * @minor: the minor number assigned to this interface, if this
109 * interface is bound to a driver that uses the USB major number.
110 * If this interface does not use the USB major, this field should
111 * be unused. The driver should set this value in the probe()
112 * function of the driver, after it has been assigned a minor
113 * number from the USB core by calling usb_register_dev().
114 * @condition: binding state of the interface: not bound, binding
115 * (in probe()), bound to a driver, or unbinding (in disconnect())
116 * @sysfs_files_created: sysfs attributes exist
117 * @ep_devs_created: endpoint child pseudo-devices exist
118 * @unregistering: flag set when the interface is being unregistered
119 * @needs_remote_wakeup: flag set when the driver requires remote-wakeup
120 * capability during autosuspend.
121 * @needs_altsetting0: flag set when a set-interface request for altsetting 0
123 * @needs_binding: flag set when the driver should be re-probed or unbound
124 * following a reset or suspend operation it doesn't support.
125 * @dev: driver model's view of this device
126 * @usb_dev: if an interface is bound to the USB major, this will point
127 * to the sysfs representation for that device.
128 * @pm_usage_cnt: PM usage counter for this interface
129 * @reset_ws: Used for scheduling resets from atomic context.
130 * @reset_running: set to 1 if the interface is currently running a
131 * queued reset so that usb_cancel_queued_reset() doesn't try to
132 * remove from the workqueue when running inside the worker
133 * thread. See __usb_queue_reset_device().
134 * @resetting_device: USB core reset the device, so use alt setting 0 as
135 * current; needs bandwidth alloc after reset.
137 * USB device drivers attach to interfaces on a physical device. Each
138 * interface encapsulates a single high level function, such as feeding
139 * an audio stream to a speaker or reporting a change in a volume control.
140 * Many USB devices only have one interface. The protocol used to talk to
141 * an interface's endpoints can be defined in a usb "class" specification,
142 * or by a product's vendor. The (default) control endpoint is part of
143 * every interface, but is never listed among the interface's descriptors.
145 * The driver that is bound to the interface can use standard driver model
146 * calls such as dev_get_drvdata() on the dev member of this structure.
148 * Each interface may have alternate settings. The initial configuration
149 * of a device sets altsetting 0, but the device driver can change
150 * that setting using usb_set_interface(). Alternate settings are often
151 * used to control the use of periodic endpoints, such as by having
152 * different endpoints use different amounts of reserved USB bandwidth.
153 * All standards-conformant USB devices that use isochronous endpoints
154 * will use them in non-default settings.
156 * The USB specification says that alternate setting numbers must run from
157 * 0 to one less than the total number of alternate settings. But some
158 * devices manage to mess this up, and the structures aren't necessarily
159 * stored in numerical order anyhow. Use usb_altnum_to_altsetting() to
160 * look up an alternate setting in the altsetting array based on its number.
162 struct usb_interface {
163 /* array of alternate settings for this interface,
164 * stored in no particular order */
165 struct usb_host_interface *altsetting;
167 struct usb_host_interface *cur_altsetting; /* the currently
168 * active alternate setting */
169 unsigned num_altsetting; /* number of alternate settings */
171 /* If there is an interface association descriptor then it will list
172 * the associated interfaces */
173 struct usb_interface_assoc_descriptor *intf_assoc;
175 int minor; /* minor number this interface is
177 enum usb_interface_condition condition; /* state of binding */
178 unsigned sysfs_files_created:1; /* the sysfs attributes exist */
179 unsigned ep_devs_created:1; /* endpoint "devices" exist */
180 unsigned unregistering:1; /* unregistration is in progress */
181 unsigned needs_remote_wakeup:1; /* driver requires remote wakeup */
182 unsigned needs_altsetting0:1; /* switch to altsetting 0 is pending */
183 unsigned needs_binding:1; /* needs delayed unbind/rebind */
184 unsigned reset_running:1;
185 unsigned resetting_device:1; /* true: bandwidth alloc after reset */
187 struct device dev; /* interface specific device info */
188 struct device *usb_dev;
189 atomic_t pm_usage_cnt; /* usage counter for autosuspend */
190 struct work_struct reset_ws; /* for resets in atomic context */
192 #define to_usb_interface(d) container_of(d, struct usb_interface, dev)
194 static inline void *usb_get_intfdata(struct usb_interface *intf)
196 return dev_get_drvdata(&intf->dev);
199 static inline void usb_set_intfdata(struct usb_interface *intf, void *data)
201 dev_set_drvdata(&intf->dev, data);
204 struct usb_interface *usb_get_intf(struct usb_interface *intf);
205 void usb_put_intf(struct usb_interface *intf);
208 #define USB_MAXENDPOINTS 30
209 /* this maximum is arbitrary */
210 #define USB_MAXINTERFACES 32
211 #define USB_MAXIADS (USB_MAXINTERFACES/2)
214 * struct usb_interface_cache - long-term representation of a device interface
215 * @num_altsetting: number of altsettings defined.
216 * @ref: reference counter.
217 * @altsetting: variable-length array of interface structures, one for
218 * each alternate setting that may be selected. Each one includes a
219 * set of endpoint configurations. They will be in no particular order.
221 * These structures persist for the lifetime of a usb_device, unlike
222 * struct usb_interface (which persists only as long as its configuration
223 * is installed). The altsetting arrays can be accessed through these
224 * structures at any time, permitting comparison of configurations and
225 * providing support for the /proc/bus/usb/devices pseudo-file.
227 struct usb_interface_cache {
228 unsigned num_altsetting; /* number of alternate settings */
229 struct kref ref; /* reference counter */
231 /* variable-length array of alternate settings for this interface,
232 * stored in no particular order */
233 struct usb_host_interface altsetting[0];
235 #define ref_to_usb_interface_cache(r) \
236 container_of(r, struct usb_interface_cache, ref)
237 #define altsetting_to_usb_interface_cache(a) \
238 container_of(a, struct usb_interface_cache, altsetting[0])
241 * struct usb_host_config - representation of a device's configuration
242 * @desc: the device's configuration descriptor.
243 * @string: pointer to the cached version of the iConfiguration string, if
244 * present for this configuration.
245 * @intf_assoc: list of any interface association descriptors in this config
246 * @interface: array of pointers to usb_interface structures, one for each
247 * interface in the configuration. The number of interfaces is stored
248 * in desc.bNumInterfaces. These pointers are valid only while the
249 * the configuration is active.
250 * @intf_cache: array of pointers to usb_interface_cache structures, one
251 * for each interface in the configuration. These structures exist
252 * for the entire life of the device.
253 * @extra: pointer to buffer containing all extra descriptors associated
254 * with this configuration (those preceding the first interface
256 * @extralen: length of the extra descriptors buffer.
258 * USB devices may have multiple configurations, but only one can be active
259 * at any time. Each encapsulates a different operational environment;
260 * for example, a dual-speed device would have separate configurations for
261 * full-speed and high-speed operation. The number of configurations
262 * available is stored in the device descriptor as bNumConfigurations.
264 * A configuration can contain multiple interfaces. Each corresponds to
265 * a different function of the USB device, and all are available whenever
266 * the configuration is active. The USB standard says that interfaces
267 * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot
268 * of devices get this wrong. In addition, the interface array is not
269 * guaranteed to be sorted in numerical order. Use usb_ifnum_to_if() to
270 * look up an interface entry based on its number.
272 * Device drivers should not attempt to activate configurations. The choice
273 * of which configuration to install is a policy decision based on such
274 * considerations as available power, functionality provided, and the user's
275 * desires (expressed through userspace tools). However, drivers can call
276 * usb_reset_configuration() to reinitialize the current configuration and
277 * all its interfaces.
279 struct usb_host_config {
280 struct usb_config_descriptor desc;
282 char *string; /* iConfiguration string, if present */
284 /* List of any Interface Association Descriptors in this
286 struct usb_interface_assoc_descriptor *intf_assoc[USB_MAXIADS];
288 /* the interfaces associated with this configuration,
289 * stored in no particular order */
290 struct usb_interface *interface[USB_MAXINTERFACES];
292 /* Interface information available even when this is not the
293 * active configuration */
294 struct usb_interface_cache *intf_cache[USB_MAXINTERFACES];
296 unsigned char *extra; /* Extra descriptors */
300 /* USB2.0 and USB3.0 device BOS descriptor set */
301 struct usb_host_bos {
302 struct usb_bos_descriptor *desc;
304 /* wireless cap descriptor is handled by wusb */
305 struct usb_ext_cap_descriptor *ext_cap;
306 struct usb_ss_cap_descriptor *ss_cap;
307 struct usb_ss_container_id_descriptor *ss_id;
310 int __usb_get_extra_descriptor(char *buffer, unsigned size,
311 unsigned char type, void **ptr);
312 #define usb_get_extra_descriptor(ifpoint, type, ptr) \
313 __usb_get_extra_descriptor((ifpoint)->extra, \
314 (ifpoint)->extralen, \
317 /* ----------------------------------------------------------------------- */
319 /* USB device number allocation bitmap */
321 unsigned long devicemap[128 / (8*sizeof(unsigned long))];
325 * Allocated per bus (tree of devices) we have:
328 struct device *controller; /* host/master side hardware */
329 int busnum; /* Bus number (in order of reg) */
330 const char *bus_name; /* stable id (PCI slot_name etc) */
331 u8 uses_dma; /* Does the host controller use DMA? */
332 u8 uses_pio_for_control; /*
333 * Does the host controller use PIO
334 * for control transfers?
336 u8 otg_port; /* 0, or number of OTG/HNP port */
337 unsigned is_b_host:1; /* true during some HNP roleswitches */
338 unsigned b_hnp_enable:1; /* OTG: did A-Host enable HNP? */
339 unsigned no_stop_on_short:1; /*
340 * Quirk: some controllers don't stop
341 * the ep queue on a short transfer
342 * with the URB_SHORT_NOT_OK flag set.
344 unsigned no_sg_constraint:1; /* no sg constraint */
345 unsigned sg_tablesize; /* 0 or largest number of sg list entries */
347 int devnum_next; /* Next open device number in
348 * round-robin allocation */
350 struct usb_devmap devmap; /* device address allocation map */
351 struct usb_device *root_hub; /* Root hub */
352 struct usb_bus *hs_companion; /* Companion EHCI bus, if any */
353 struct list_head bus_list; /* list of busses */
355 int bandwidth_allocated; /* on this bus: how much of the time
356 * reserved for periodic (intr/iso)
357 * requests is used, on average?
358 * Units: microseconds/frame.
359 * Limits: Full/low speed reserve 90%,
360 * while high speed reserves 80%.
362 int bandwidth_int_reqs; /* number of Interrupt requests */
363 int bandwidth_isoc_reqs; /* number of Isoc. requests */
365 unsigned resuming_ports; /* bit array: resuming root-hub ports */
367 #if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
368 struct mon_bus *mon_bus; /* non-null when associated */
369 int monitored; /* non-zero when monitored */
373 /* ----------------------------------------------------------------------- */
377 enum usb_device_removable {
378 USB_DEVICE_REMOVABLE_UNKNOWN = 0,
379 USB_DEVICE_REMOVABLE,
383 enum usb_port_connect_type {
384 USB_PORT_CONNECT_TYPE_UNKNOWN = 0,
385 USB_PORT_CONNECT_TYPE_HOT_PLUG,
386 USB_PORT_CONNECT_TYPE_HARD_WIRED,
391 * USB 2.0 Link Power Management (LPM) parameters.
393 struct usb2_lpm_parameters {
394 /* Best effort service latency indicate how long the host will drive
395 * resume on an exit from L1.
399 /* Timeout value in microseconds for the L1 inactivity (LPM) timer.
400 * When the timer counts to zero, the parent hub will initiate a LPM
407 * USB 3.0 Link Power Management (LPM) parameters.
409 * PEL and SEL are USB 3.0 Link PM latencies for device-initiated LPM exit.
410 * MEL is the USB 3.0 Link PM latency for host-initiated LPM exit.
411 * All three are stored in nanoseconds.
413 struct usb3_lpm_parameters {
415 * Maximum exit latency (MEL) for the host to send a packet to the
416 * device (either a Ping for isoc endpoints, or a data packet for
417 * interrupt endpoints), the hubs to decode the packet, and for all hubs
418 * in the path to transition the links to U0.
422 * Maximum exit latency for a device-initiated LPM transition to bring
423 * all links into U0. Abbreviated as "PEL" in section 9.4.12 of the USB
424 * 3.0 spec, with no explanation of what "P" stands for. "Path"?
429 * The System Exit Latency (SEL) includes PEL, and three other
430 * latencies. After a device initiates a U0 transition, it will take
431 * some time from when the device sends the ERDY to when it will finally
432 * receive the data packet. Basically, SEL should be the worse-case
433 * latency from when a device starts initiating a U0 transition to when
438 * The idle timeout value that is currently programmed into the parent
439 * hub for this device. When the timer counts to zero, the parent hub
440 * will initiate an LPM transition to either U1 or U2.
446 * struct usb_device - kernel's representation of a USB device
447 * @devnum: device number; address on a USB bus
448 * @devpath: device ID string for use in messages (e.g., /port/...)
449 * @route: tree topology hex string for use with xHCI
450 * @state: device state: configured, not attached, etc.
451 * @speed: device speed: high/full/low (or error)
452 * @tt: Transaction Translator info; used with low/full speed dev, highspeed hub
453 * @ttport: device port on that tt hub
454 * @toggle: one bit for each endpoint, with ([0] = IN, [1] = OUT) endpoints
455 * @parent: our hub, unless we're the root
456 * @bus: bus we're part of
457 * @ep0: endpoint 0 data (default control pipe)
458 * @dev: generic device interface
459 * @descriptor: USB device descriptor
460 * @bos: USB device BOS descriptor set
461 * @config: all of the device's configs
462 * @actconfig: the active configuration
463 * @ep_in: array of IN endpoints
464 * @ep_out: array of OUT endpoints
465 * @rawdescriptors: raw descriptors for each config
466 * @bus_mA: Current available from the bus
467 * @portnum: parent port number (origin 1)
468 * @level: number of USB hub ancestors
469 * @can_submit: URBs may be submitted
470 * @persist_enabled: USB_PERSIST enabled for this device
471 * @have_langid: whether string_langid is valid
472 * @authorized: policy has said we can use it;
473 * (user space) policy determines if we authorize this device to be
474 * used or not. By default, wired USB devices are authorized.
475 * WUSB devices are not, until we authorize them from user space.
476 * FIXME -- complete doc
477 * @authenticated: Crypto authentication passed
478 * @wusb: device is Wireless USB
479 * @lpm_capable: device supports LPM
480 * @usb2_hw_lpm_capable: device can perform USB2 hardware LPM
481 * @usb2_hw_lpm_besl_capable: device can perform USB2 hardware BESL LPM
482 * @usb2_hw_lpm_enabled: USB2 hardware LPM is enabled
483 * @usb2_hw_lpm_allowed: Userspace allows USB 2.0 LPM to be enabled
484 * @usb3_lpm_enabled: USB3 hardware LPM enabled
485 * @string_langid: language ID for strings
486 * @product: iProduct string, if present (static)
487 * @manufacturer: iManufacturer string, if present (static)
488 * @serial: iSerialNumber string, if present (static)
489 * @filelist: usbfs files that are open to this device
490 * @maxchild: number of ports if hub
491 * @quirks: quirks of the whole device
492 * @urbnum: number of URBs submitted for the whole device
493 * @active_duration: total time device is not suspended
494 * @connect_time: time device was first connected
495 * @do_remote_wakeup: remote wakeup should be enabled
496 * @reset_resume: needs reset instead of resume
497 * @port_is_suspended: the upstream port is suspended (L2 or U3)
498 * @wusb_dev: if this is a Wireless USB device, link to the WUSB
499 * specific data for the device.
500 * @slot_id: Slot ID assigned by xHCI
501 * @removable: Device can be physically removed from this port
502 * @l1_params: best effor service latency for USB2 L1 LPM state, and L1 timeout.
503 * @u1_params: exit latencies for USB3 U1 LPM state, and hub-initiated timeout.
504 * @u2_params: exit latencies for USB3 U2 LPM state, and hub-initiated timeout.
505 * @lpm_disable_count: Ref count used by usb_disable_lpm() and usb_enable_lpm()
506 * to keep track of the number of functions that require USB 3.0 Link Power
507 * Management to be disabled for this usb_device. This count should only
508 * be manipulated by those functions, with the bandwidth_mutex is held.
511 * Usbcore drivers should not set usbdev->state directly. Instead use
512 * usb_set_device_state().
518 enum usb_device_state state;
519 enum usb_device_speed speed;
524 unsigned int toggle[2];
526 struct usb_device *parent;
528 struct usb_host_endpoint ep0;
532 struct usb_device_descriptor descriptor;
533 struct usb_host_bos *bos;
534 struct usb_host_config *config;
536 struct usb_host_config *actconfig;
537 struct usb_host_endpoint *ep_in[16];
538 struct usb_host_endpoint *ep_out[16];
540 char **rawdescriptors;
542 unsigned short bus_mA;
546 unsigned can_submit:1;
547 unsigned persist_enabled:1;
548 unsigned have_langid:1;
549 unsigned authorized:1;
550 unsigned authenticated:1;
552 unsigned lpm_capable:1;
553 unsigned usb2_hw_lpm_capable:1;
554 unsigned usb2_hw_lpm_besl_capable:1;
555 unsigned usb2_hw_lpm_enabled:1;
556 unsigned usb2_hw_lpm_allowed:1;
557 unsigned usb3_lpm_enabled:1;
560 /* static strings from the device */
565 struct list_head filelist;
572 unsigned long active_duration;
575 unsigned long connect_time;
577 unsigned do_remote_wakeup:1;
578 unsigned reset_resume:1;
579 unsigned port_is_suspended:1;
581 struct wusb_dev *wusb_dev;
583 enum usb_device_removable removable;
584 struct usb2_lpm_parameters l1_params;
585 struct usb3_lpm_parameters u1_params;
586 struct usb3_lpm_parameters u2_params;
587 unsigned lpm_disable_count;
589 #define to_usb_device(d) container_of(d, struct usb_device, dev)
591 static inline struct usb_device *interface_to_usbdev(struct usb_interface *intf)
593 return to_usb_device(intf->dev.parent);
596 extern struct usb_device *usb_get_dev(struct usb_device *dev);
597 extern void usb_put_dev(struct usb_device *dev);
598 extern struct usb_device *usb_hub_find_child(struct usb_device *hdev,
602 * usb_hub_for_each_child - iterate over all child devices on the hub
603 * @hdev: USB device belonging to the usb hub
604 * @port1: portnum associated with child device
605 * @child: child device pointer
607 #define usb_hub_for_each_child(hdev, port1, child) \
608 for (port1 = 1, child = usb_hub_find_child(hdev, port1); \
609 port1 <= hdev->maxchild; \
610 child = usb_hub_find_child(hdev, ++port1)) \
611 if (!child) continue; else
613 /* USB device locking */
614 #define usb_lock_device(udev) device_lock(&(udev)->dev)
615 #define usb_unlock_device(udev) device_unlock(&(udev)->dev)
616 #define usb_trylock_device(udev) device_trylock(&(udev)->dev)
617 extern int usb_lock_device_for_reset(struct usb_device *udev,
618 const struct usb_interface *iface);
620 /* USB port reset for device reinitialization */
621 extern int usb_reset_device(struct usb_device *dev);
622 extern void usb_queue_reset_device(struct usb_interface *dev);
625 extern int usb_acpi_set_power_state(struct usb_device *hdev, int index,
627 extern bool usb_acpi_power_manageable(struct usb_device *hdev, int index);
629 static inline int usb_acpi_set_power_state(struct usb_device *hdev, int index,
630 bool enable) { return 0; }
631 static inline bool usb_acpi_power_manageable(struct usb_device *hdev, int index)
635 /* USB autosuspend and autoresume */
636 #ifdef CONFIG_PM_RUNTIME
637 extern void usb_enable_autosuspend(struct usb_device *udev);
638 extern void usb_disable_autosuspend(struct usb_device *udev);
640 extern int usb_autopm_get_interface(struct usb_interface *intf);
641 extern void usb_autopm_put_interface(struct usb_interface *intf);
642 extern int usb_autopm_get_interface_async(struct usb_interface *intf);
643 extern void usb_autopm_put_interface_async(struct usb_interface *intf);
644 extern void usb_autopm_get_interface_no_resume(struct usb_interface *intf);
645 extern void usb_autopm_put_interface_no_suspend(struct usb_interface *intf);
647 static inline void usb_mark_last_busy(struct usb_device *udev)
649 pm_runtime_mark_last_busy(&udev->dev);
654 static inline int usb_enable_autosuspend(struct usb_device *udev)
656 static inline int usb_disable_autosuspend(struct usb_device *udev)
659 static inline int usb_autopm_get_interface(struct usb_interface *intf)
661 static inline int usb_autopm_get_interface_async(struct usb_interface *intf)
664 static inline void usb_autopm_put_interface(struct usb_interface *intf)
666 static inline void usb_autopm_put_interface_async(struct usb_interface *intf)
668 static inline void usb_autopm_get_interface_no_resume(
669 struct usb_interface *intf)
671 static inline void usb_autopm_put_interface_no_suspend(
672 struct usb_interface *intf)
674 static inline void usb_mark_last_busy(struct usb_device *udev)
678 extern int usb_disable_lpm(struct usb_device *udev);
679 extern void usb_enable_lpm(struct usb_device *udev);
680 /* Same as above, but these functions lock/unlock the bandwidth_mutex. */
681 extern int usb_unlocked_disable_lpm(struct usb_device *udev);
682 extern void usb_unlocked_enable_lpm(struct usb_device *udev);
684 extern int usb_disable_ltm(struct usb_device *udev);
685 extern void usb_enable_ltm(struct usb_device *udev);
687 static inline bool usb_device_supports_ltm(struct usb_device *udev)
689 if (udev->speed != USB_SPEED_SUPER || !udev->bos || !udev->bos->ss_cap)
691 return udev->bos->ss_cap->bmAttributes & USB_LTM_SUPPORT;
694 static inline bool usb_device_no_sg_constraint(struct usb_device *udev)
696 return udev && udev->bus && udev->bus->no_sg_constraint;
700 /*-------------------------------------------------------------------------*/
702 /* for drivers using iso endpoints */
703 extern int usb_get_current_frame_number(struct usb_device *usb_dev);
705 /* Sets up a group of bulk endpoints to support multiple stream IDs. */
706 extern int usb_alloc_streams(struct usb_interface *interface,
707 struct usb_host_endpoint **eps, unsigned int num_eps,
708 unsigned int num_streams, gfp_t mem_flags);
710 /* Reverts a group of bulk endpoints back to not using stream IDs. */
711 extern int usb_free_streams(struct usb_interface *interface,
712 struct usb_host_endpoint **eps, unsigned int num_eps,
715 /* used these for multi-interface device registration */
716 extern int usb_driver_claim_interface(struct usb_driver *driver,
717 struct usb_interface *iface, void *priv);
720 * usb_interface_claimed - returns true iff an interface is claimed
721 * @iface: the interface being checked
723 * Return: %true (nonzero) iff the interface is claimed, else %false
727 * Callers must own the driver model's usb bus readlock. So driver
728 * probe() entries don't need extra locking, but other call contexts
729 * may need to explicitly claim that lock.
732 static inline int usb_interface_claimed(struct usb_interface *iface)
734 return (iface->dev.driver != NULL);
737 extern void usb_driver_release_interface(struct usb_driver *driver,
738 struct usb_interface *iface);
739 const struct usb_device_id *usb_match_id(struct usb_interface *interface,
740 const struct usb_device_id *id);
741 extern int usb_match_one_id(struct usb_interface *interface,
742 const struct usb_device_id *id);
744 extern int usb_for_each_dev(void *data, int (*fn)(struct usb_device *, void *));
745 extern struct usb_interface *usb_find_interface(struct usb_driver *drv,
747 extern struct usb_interface *usb_ifnum_to_if(const struct usb_device *dev,
749 extern struct usb_host_interface *usb_altnum_to_altsetting(
750 const struct usb_interface *intf, unsigned int altnum);
751 extern struct usb_host_interface *usb_find_alt_setting(
752 struct usb_host_config *config,
753 unsigned int iface_num,
754 unsigned int alt_num);
758 * usb_make_path - returns stable device path in the usb tree
759 * @dev: the device whose path is being constructed
760 * @buf: where to put the string
761 * @size: how big is "buf"?
763 * Return: Length of the string (> 0) or negative if size was too small.
766 * This identifier is intended to be "stable", reflecting physical paths in
767 * hardware such as physical bus addresses for host controllers or ports on
768 * USB hubs. That makes it stay the same until systems are physically
769 * reconfigured, by re-cabling a tree of USB devices or by moving USB host
770 * controllers. Adding and removing devices, including virtual root hubs
771 * in host controller driver modules, does not change these path identifiers;
772 * neither does rebooting or re-enumerating. These are more useful identifiers
773 * than changeable ("unstable") ones like bus numbers or device addresses.
775 * With a partial exception for devices connected to USB 2.0 root hubs, these
776 * identifiers are also predictable. So long as the device tree isn't changed,
777 * plugging any USB device into a given hub port always gives it the same path.
778 * Because of the use of "companion" controllers, devices connected to ports on
779 * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are
780 * high speed, and a different one if they are full or low speed.
782 static inline int usb_make_path(struct usb_device *dev, char *buf, size_t size)
785 actual = snprintf(buf, size, "usb-%s-%s", dev->bus->bus_name,
787 return (actual >= (int)size) ? -1 : actual;
790 /*-------------------------------------------------------------------------*/
792 #define USB_DEVICE_ID_MATCH_DEVICE \
793 (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
794 #define USB_DEVICE_ID_MATCH_DEV_RANGE \
795 (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI)
796 #define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
797 (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE)
798 #define USB_DEVICE_ID_MATCH_DEV_INFO \
799 (USB_DEVICE_ID_MATCH_DEV_CLASS | \
800 USB_DEVICE_ID_MATCH_DEV_SUBCLASS | \
801 USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
802 #define USB_DEVICE_ID_MATCH_INT_INFO \
803 (USB_DEVICE_ID_MATCH_INT_CLASS | \
804 USB_DEVICE_ID_MATCH_INT_SUBCLASS | \
805 USB_DEVICE_ID_MATCH_INT_PROTOCOL)
808 * USB_DEVICE - macro used to describe a specific usb device
809 * @vend: the 16 bit USB Vendor ID
810 * @prod: the 16 bit USB Product ID
812 * This macro is used to create a struct usb_device_id that matches a
815 #define USB_DEVICE(vend, prod) \
816 .match_flags = USB_DEVICE_ID_MATCH_DEVICE, \
817 .idVendor = (vend), \
820 * USB_DEVICE_VER - describe a specific usb device with a version range
821 * @vend: the 16 bit USB Vendor ID
822 * @prod: the 16 bit USB Product ID
823 * @lo: the bcdDevice_lo value
824 * @hi: the bcdDevice_hi value
826 * This macro is used to create a struct usb_device_id that matches a
827 * specific device, with a version range.
829 #define USB_DEVICE_VER(vend, prod, lo, hi) \
830 .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, \
831 .idVendor = (vend), \
832 .idProduct = (prod), \
833 .bcdDevice_lo = (lo), \
837 * USB_DEVICE_INTERFACE_CLASS - describe a usb device with a specific interface class
838 * @vend: the 16 bit USB Vendor ID
839 * @prod: the 16 bit USB Product ID
840 * @cl: bInterfaceClass value
842 * This macro is used to create a struct usb_device_id that matches a
843 * specific interface class of devices.
845 #define USB_DEVICE_INTERFACE_CLASS(vend, prod, cl) \
846 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
847 USB_DEVICE_ID_MATCH_INT_CLASS, \
848 .idVendor = (vend), \
849 .idProduct = (prod), \
850 .bInterfaceClass = (cl)
853 * USB_DEVICE_INTERFACE_PROTOCOL - describe a usb device with a specific interface protocol
854 * @vend: the 16 bit USB Vendor ID
855 * @prod: the 16 bit USB Product ID
856 * @pr: bInterfaceProtocol value
858 * This macro is used to create a struct usb_device_id that matches a
859 * specific interface protocol of devices.
861 #define USB_DEVICE_INTERFACE_PROTOCOL(vend, prod, pr) \
862 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
863 USB_DEVICE_ID_MATCH_INT_PROTOCOL, \
864 .idVendor = (vend), \
865 .idProduct = (prod), \
866 .bInterfaceProtocol = (pr)
869 * USB_DEVICE_INTERFACE_NUMBER - describe a usb device with a specific interface number
870 * @vend: the 16 bit USB Vendor ID
871 * @prod: the 16 bit USB Product ID
872 * @num: bInterfaceNumber value
874 * This macro is used to create a struct usb_device_id that matches a
875 * specific interface number of devices.
877 #define USB_DEVICE_INTERFACE_NUMBER(vend, prod, num) \
878 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
879 USB_DEVICE_ID_MATCH_INT_NUMBER, \
880 .idVendor = (vend), \
881 .idProduct = (prod), \
882 .bInterfaceNumber = (num)
885 * USB_DEVICE_INFO - macro used to describe a class of usb devices
886 * @cl: bDeviceClass value
887 * @sc: bDeviceSubClass value
888 * @pr: bDeviceProtocol value
890 * This macro is used to create a struct usb_device_id that matches a
891 * specific class of devices.
893 #define USB_DEVICE_INFO(cl, sc, pr) \
894 .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, \
895 .bDeviceClass = (cl), \
896 .bDeviceSubClass = (sc), \
897 .bDeviceProtocol = (pr)
900 * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces
901 * @cl: bInterfaceClass value
902 * @sc: bInterfaceSubClass value
903 * @pr: bInterfaceProtocol value
905 * This macro is used to create a struct usb_device_id that matches a
906 * specific class of interfaces.
908 #define USB_INTERFACE_INFO(cl, sc, pr) \
909 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, \
910 .bInterfaceClass = (cl), \
911 .bInterfaceSubClass = (sc), \
912 .bInterfaceProtocol = (pr)
915 * USB_DEVICE_AND_INTERFACE_INFO - describe a specific usb device with a class of usb interfaces
916 * @vend: the 16 bit USB Vendor ID
917 * @prod: the 16 bit USB Product ID
918 * @cl: bInterfaceClass value
919 * @sc: bInterfaceSubClass value
920 * @pr: bInterfaceProtocol value
922 * This macro is used to create a struct usb_device_id that matches a
923 * specific device with a specific class of interfaces.
925 * This is especially useful when explicitly matching devices that have
926 * vendor specific bDeviceClass values, but standards-compliant interfaces.
928 #define USB_DEVICE_AND_INTERFACE_INFO(vend, prod, cl, sc, pr) \
929 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO \
930 | USB_DEVICE_ID_MATCH_DEVICE, \
931 .idVendor = (vend), \
932 .idProduct = (prod), \
933 .bInterfaceClass = (cl), \
934 .bInterfaceSubClass = (sc), \
935 .bInterfaceProtocol = (pr)
938 * USB_VENDOR_AND_INTERFACE_INFO - describe a specific usb vendor with a class of usb interfaces
939 * @vend: the 16 bit USB Vendor ID
940 * @cl: bInterfaceClass value
941 * @sc: bInterfaceSubClass value
942 * @pr: bInterfaceProtocol value
944 * This macro is used to create a struct usb_device_id that matches a
945 * specific vendor with a specific class of interfaces.
947 * This is especially useful when explicitly matching devices that have
948 * vendor specific bDeviceClass values, but standards-compliant interfaces.
950 #define USB_VENDOR_AND_INTERFACE_INFO(vend, cl, sc, pr) \
951 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO \
952 | USB_DEVICE_ID_MATCH_VENDOR, \
953 .idVendor = (vend), \
954 .bInterfaceClass = (cl), \
955 .bInterfaceSubClass = (sc), \
956 .bInterfaceProtocol = (pr)
958 /* ----------------------------------------------------------------------- */
960 /* Stuff for dynamic usb ids */
963 struct list_head list;
967 struct list_head node;
968 struct usb_device_id id;
971 extern ssize_t usb_store_new_id(struct usb_dynids *dynids,
972 const struct usb_device_id *id_table,
973 struct device_driver *driver,
974 const char *buf, size_t count);
976 extern ssize_t usb_show_dynids(struct usb_dynids *dynids, char *buf);
979 * struct usbdrv_wrap - wrapper for driver-model structure
980 * @driver: The driver-model core driver structure.
981 * @for_devices: Non-zero for device drivers, 0 for interface drivers.
984 struct device_driver driver;
989 * struct usb_driver - identifies USB interface driver to usbcore
990 * @name: The driver name should be unique among USB drivers,
991 * and should normally be the same as the module name.
992 * @probe: Called to see if the driver is willing to manage a particular
993 * interface on a device. If it is, probe returns zero and uses
994 * usb_set_intfdata() to associate driver-specific data with the
995 * interface. It may also use usb_set_interface() to specify the
996 * appropriate altsetting. If unwilling to manage the interface,
997 * return -ENODEV, if genuine IO errors occurred, an appropriate
998 * negative errno value.
999 * @disconnect: Called when the interface is no longer accessible, usually
1000 * because its device has been (or is being) disconnected or the
1001 * driver module is being unloaded.
1002 * @unlocked_ioctl: Used for drivers that want to talk to userspace through
1003 * the "usbfs" filesystem. This lets devices provide ways to
1004 * expose information to user space regardless of where they
1005 * do (or don't) show up otherwise in the filesystem.
1006 * @suspend: Called when the device is going to be suspended by the
1007 * system either from system sleep or runtime suspend context. The
1008 * return value will be ignored in system sleep context, so do NOT
1009 * try to continue using the device if suspend fails in this case.
1010 * Instead, let the resume or reset-resume routine recover from
1012 * @resume: Called when the device is being resumed by the system.
1013 * @reset_resume: Called when the suspended device has been reset instead
1015 * @pre_reset: Called by usb_reset_device() when the device is about to be
1016 * reset. This routine must not return until the driver has no active
1017 * URBs for the device, and no more URBs may be submitted until the
1018 * post_reset method is called.
1019 * @post_reset: Called by usb_reset_device() after the device
1021 * @id_table: USB drivers use ID table to support hotplugging.
1022 * Export this with MODULE_DEVICE_TABLE(usb,...). This must be set
1023 * or your driver's probe function will never get called.
1024 * @dynids: used internally to hold the list of dynamically added device
1025 * ids for this driver.
1026 * @drvwrap: Driver-model core structure wrapper.
1027 * @no_dynamic_id: if set to 1, the USB core will not allow dynamic ids to be
1028 * added to this driver by preventing the sysfs file from being created.
1029 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
1030 * for interfaces bound to this driver.
1031 * @soft_unbind: if set to 1, the USB core will not kill URBs and disable
1032 * endpoints before calling the driver's disconnect method.
1033 * @disable_hub_initiated_lpm: if set to 0, the USB core will not allow hubs
1034 * to initiate lower power link state transitions when an idle timeout
1035 * occurs. Device-initiated USB 3.0 link PM will still be allowed.
1037 * USB interface drivers must provide a name, probe() and disconnect()
1038 * methods, and an id_table. Other driver fields are optional.
1040 * The id_table is used in hotplugging. It holds a set of descriptors,
1041 * and specialized data may be associated with each entry. That table
1042 * is used by both user and kernel mode hotplugging support.
1044 * The probe() and disconnect() methods are called in a context where
1045 * they can sleep, but they should avoid abusing the privilege. Most
1046 * work to connect to a device should be done when the device is opened,
1047 * and undone at the last close. The disconnect code needs to address
1048 * concurrency issues with respect to open() and close() methods, as
1049 * well as forcing all pending I/O requests to complete (by unlinking
1050 * them as necessary, and blocking until the unlinks complete).
1055 int (*probe) (struct usb_interface *intf,
1056 const struct usb_device_id *id);
1058 void (*disconnect) (struct usb_interface *intf);
1060 int (*unlocked_ioctl) (struct usb_interface *intf, unsigned int code,
1063 int (*suspend) (struct usb_interface *intf, pm_message_t message);
1064 int (*resume) (struct usb_interface *intf);
1065 int (*reset_resume)(struct usb_interface *intf);
1067 int (*pre_reset)(struct usb_interface *intf);
1068 int (*post_reset)(struct usb_interface *intf);
1070 const struct usb_device_id *id_table;
1072 struct usb_dynids dynids;
1073 struct usbdrv_wrap drvwrap;
1074 unsigned int no_dynamic_id:1;
1075 unsigned int supports_autosuspend:1;
1076 unsigned int disable_hub_initiated_lpm:1;
1077 unsigned int soft_unbind:1;
1079 #define to_usb_driver(d) container_of(d, struct usb_driver, drvwrap.driver)
1082 * struct usb_device_driver - identifies USB device driver to usbcore
1083 * @name: The driver name should be unique among USB drivers,
1084 * and should normally be the same as the module name.
1085 * @probe: Called to see if the driver is willing to manage a particular
1086 * device. If it is, probe returns zero and uses dev_set_drvdata()
1087 * to associate driver-specific data with the device. If unwilling
1088 * to manage the device, return a negative errno value.
1089 * @disconnect: Called when the device is no longer accessible, usually
1090 * because it has been (or is being) disconnected or the driver's
1091 * module is being unloaded.
1092 * @suspend: Called when the device is going to be suspended by the system.
1093 * @resume: Called when the device is being resumed by the system.
1094 * @drvwrap: Driver-model core structure wrapper.
1095 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
1096 * for devices bound to this driver.
1098 * USB drivers must provide all the fields listed above except drvwrap.
1100 struct usb_device_driver {
1103 int (*probe) (struct usb_device *udev);
1104 void (*disconnect) (struct usb_device *udev);
1106 int (*suspend) (struct usb_device *udev, pm_message_t message);
1107 int (*resume) (struct usb_device *udev, pm_message_t message);
1108 struct usbdrv_wrap drvwrap;
1109 unsigned int supports_autosuspend:1;
1111 #define to_usb_device_driver(d) container_of(d, struct usb_device_driver, \
1114 extern struct bus_type usb_bus_type;
1117 * struct usb_class_driver - identifies a USB driver that wants to use the USB major number
1118 * @name: the usb class device name for this driver. Will show up in sysfs.
1119 * @devnode: Callback to provide a naming hint for a possible
1120 * device node to create.
1121 * @fops: pointer to the struct file_operations of this driver.
1122 * @minor_base: the start of the minor range for this driver.
1124 * This structure is used for the usb_register_dev() and
1125 * usb_unregister_dev() functions, to consolidate a number of the
1126 * parameters used for them.
1128 struct usb_class_driver {
1130 char *(*devnode)(struct device *dev, umode_t *mode);
1131 const struct file_operations *fops;
1136 * use these in module_init()/module_exit()
1137 * and don't forget MODULE_DEVICE_TABLE(usb, ...)
1139 extern int usb_register_driver(struct usb_driver *, struct module *,
1142 /* use a define to avoid include chaining to get THIS_MODULE & friends */
1143 #define usb_register(driver) \
1144 usb_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
1146 extern void usb_deregister(struct usb_driver *);
1149 * module_usb_driver() - Helper macro for registering a USB driver
1150 * @__usb_driver: usb_driver struct
1152 * Helper macro for USB drivers which do not do anything special in module
1153 * init/exit. This eliminates a lot of boilerplate. Each module may only
1154 * use this macro once, and calling it replaces module_init() and module_exit()
1156 #define module_usb_driver(__usb_driver) \
1157 module_driver(__usb_driver, usb_register, \
1160 extern int usb_register_device_driver(struct usb_device_driver *,
1162 extern void usb_deregister_device_driver(struct usb_device_driver *);
1164 extern int usb_register_dev(struct usb_interface *intf,
1165 struct usb_class_driver *class_driver);
1166 extern void usb_deregister_dev(struct usb_interface *intf,
1167 struct usb_class_driver *class_driver);
1169 extern int usb_disabled(void);
1171 /* ----------------------------------------------------------------------- */
1174 * URB support, for asynchronous request completions
1178 * urb->transfer_flags:
1180 * Note: URB_DIR_IN/OUT is automatically set in usb_submit_urb().
1182 #define URB_SHORT_NOT_OK 0x0001 /* report short reads as errors */
1183 #define URB_ISO_ASAP 0x0002 /* iso-only; use the first unexpired
1184 * slot in the schedule */
1185 #define URB_NO_TRANSFER_DMA_MAP 0x0004 /* urb->transfer_dma valid on submit */
1186 #define URB_NO_FSBR 0x0020 /* UHCI-specific */
1187 #define URB_ZERO_PACKET 0x0040 /* Finish bulk OUT with short packet */
1188 #define URB_NO_INTERRUPT 0x0080 /* HINT: no non-error interrupt
1190 #define URB_FREE_BUFFER 0x0100 /* Free transfer buffer with the URB */
1192 /* The following flags are used internally by usbcore and HCDs */
1193 #define URB_DIR_IN 0x0200 /* Transfer from device to host */
1194 #define URB_DIR_OUT 0
1195 #define URB_DIR_MASK URB_DIR_IN
1197 #define URB_DMA_MAP_SINGLE 0x00010000 /* Non-scatter-gather mapping */
1198 #define URB_DMA_MAP_PAGE 0x00020000 /* HCD-unsupported S-G */
1199 #define URB_DMA_MAP_SG 0x00040000 /* HCD-supported S-G */
1200 #define URB_MAP_LOCAL 0x00080000 /* HCD-local-memory mapping */
1201 #define URB_SETUP_MAP_SINGLE 0x00100000 /* Setup packet DMA mapped */
1202 #define URB_SETUP_MAP_LOCAL 0x00200000 /* HCD-local setup packet */
1203 #define URB_DMA_SG_COMBINED 0x00400000 /* S-G entries were combined */
1204 #define URB_ALIGNED_TEMP_BUFFER 0x00800000 /* Temp buffer was alloc'd */
1206 struct usb_iso_packet_descriptor {
1207 unsigned int offset;
1208 unsigned int length; /* expected length */
1209 unsigned int actual_length;
1216 struct list_head urb_list;
1217 wait_queue_head_t wait;
1219 atomic_t suspend_wakeups;
1220 unsigned int poisoned:1;
1223 static inline void init_usb_anchor(struct usb_anchor *anchor)
1225 memset(anchor, 0, sizeof(*anchor));
1226 INIT_LIST_HEAD(&anchor->urb_list);
1227 init_waitqueue_head(&anchor->wait);
1228 spin_lock_init(&anchor->lock);
1231 typedef void (*usb_complete_t)(struct urb *);
1234 * struct urb - USB Request Block
1235 * @urb_list: For use by current owner of the URB.
1236 * @anchor_list: membership in the list of an anchor
1237 * @anchor: to anchor URBs to a common mooring
1238 * @ep: Points to the endpoint's data structure. Will eventually
1240 * @pipe: Holds endpoint number, direction, type, and more.
1241 * Create these values with the eight macros available;
1242 * usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl"
1243 * (control), "bulk", "int" (interrupt), or "iso" (isochronous).
1244 * For example usb_sndbulkpipe() or usb_rcvintpipe(). Endpoint
1245 * numbers range from zero to fifteen. Note that "in" endpoint two
1246 * is a different endpoint (and pipe) from "out" endpoint two.
1247 * The current configuration controls the existence, type, and
1248 * maximum packet size of any given endpoint.
1249 * @stream_id: the endpoint's stream ID for bulk streams
1250 * @dev: Identifies the USB device to perform the request.
1251 * @status: This is read in non-iso completion functions to get the
1252 * status of the particular request. ISO requests only use it
1253 * to tell whether the URB was unlinked; detailed status for
1254 * each frame is in the fields of the iso_frame-desc.
1255 * @transfer_flags: A variety of flags may be used to affect how URB
1256 * submission, unlinking, or operation are handled. Different
1257 * kinds of URB can use different flags.
1258 * @transfer_buffer: This identifies the buffer to (or from) which the I/O
1259 * request will be performed unless URB_NO_TRANSFER_DMA_MAP is set
1260 * (however, do not leave garbage in transfer_buffer even then).
1261 * This buffer must be suitable for DMA; allocate it with
1262 * kmalloc() or equivalent. For transfers to "in" endpoints, contents
1263 * of this buffer will be modified. This buffer is used for the data
1264 * stage of control transfers.
1265 * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP,
1266 * the device driver is saying that it provided this DMA address,
1267 * which the host controller driver should use in preference to the
1269 * @sg: scatter gather buffer list, the buffer size of each element in
1270 * the list (except the last) must be divisible by the endpoint's
1271 * max packet size if no_sg_constraint isn't set in 'struct usb_bus'
1272 * @num_mapped_sgs: (internal) number of mapped sg entries
1273 * @num_sgs: number of entries in the sg list
1274 * @transfer_buffer_length: How big is transfer_buffer. The transfer may
1275 * be broken up into chunks according to the current maximum packet
1276 * size for the endpoint, which is a function of the configuration
1277 * and is encoded in the pipe. When the length is zero, neither
1278 * transfer_buffer nor transfer_dma is used.
1279 * @actual_length: This is read in non-iso completion functions, and
1280 * it tells how many bytes (out of transfer_buffer_length) were
1281 * transferred. It will normally be the same as requested, unless
1282 * either an error was reported or a short read was performed.
1283 * The URB_SHORT_NOT_OK transfer flag may be used to make such
1284 * short reads be reported as errors.
1285 * @setup_packet: Only used for control transfers, this points to eight bytes
1286 * of setup data. Control transfers always start by sending this data
1287 * to the device. Then transfer_buffer is read or written, if needed.
1288 * @setup_dma: DMA pointer for the setup packet. The caller must not use
1289 * this field; setup_packet must point to a valid buffer.
1290 * @start_frame: Returns the initial frame for isochronous transfers.
1291 * @number_of_packets: Lists the number of ISO transfer buffers.
1292 * @interval: Specifies the polling interval for interrupt or isochronous
1293 * transfers. The units are frames (milliseconds) for full and low
1294 * speed devices, and microframes (1/8 millisecond) for highspeed
1295 * and SuperSpeed devices.
1296 * @error_count: Returns the number of ISO transfers that reported errors.
1297 * @context: For use in completion functions. This normally points to
1298 * request-specific driver context.
1299 * @complete: Completion handler. This URB is passed as the parameter to the
1300 * completion function. The completion function may then do what
1301 * it likes with the URB, including resubmitting or freeing it.
1302 * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to
1303 * collect the transfer status for each buffer.
1305 * This structure identifies USB transfer requests. URBs must be allocated by
1306 * calling usb_alloc_urb() and freed with a call to usb_free_urb().
1307 * Initialization may be done using various usb_fill_*_urb() functions. URBs
1308 * are submitted using usb_submit_urb(), and pending requests may be canceled
1309 * using usb_unlink_urb() or usb_kill_urb().
1311 * Data Transfer Buffers:
1313 * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise
1314 * taken from the general page pool. That is provided by transfer_buffer
1315 * (control requests also use setup_packet), and host controller drivers
1316 * perform a dma mapping (and unmapping) for each buffer transferred. Those
1317 * mapping operations can be expensive on some platforms (perhaps using a dma
1318 * bounce buffer or talking to an IOMMU),
1319 * although they're cheap on commodity x86 and ppc hardware.
1321 * Alternatively, drivers may pass the URB_NO_TRANSFER_DMA_MAP transfer flag,
1322 * which tells the host controller driver that no such mapping is needed for
1323 * the transfer_buffer since
1324 * the device driver is DMA-aware. For example, a device driver might
1325 * allocate a DMA buffer with usb_alloc_coherent() or call usb_buffer_map().
1326 * When this transfer flag is provided, host controller drivers will
1327 * attempt to use the dma address found in the transfer_dma
1328 * field rather than determining a dma address themselves.
1330 * Note that transfer_buffer must still be set if the controller
1331 * does not support DMA (as indicated by bus.uses_dma) and when talking
1332 * to root hub. If you have to trasfer between highmem zone and the device
1333 * on such controller, create a bounce buffer or bail out with an error.
1334 * If transfer_buffer cannot be set (is in highmem) and the controller is DMA
1335 * capable, assign NULL to it, so that usbmon knows not to use the value.
1336 * The setup_packet must always be set, so it cannot be located in highmem.
1340 * All URBs submitted must initialize the dev, pipe, transfer_flags (may be
1341 * zero), and complete fields. All URBs must also initialize
1342 * transfer_buffer and transfer_buffer_length. They may provide the
1343 * URB_SHORT_NOT_OK transfer flag, indicating that short reads are
1344 * to be treated as errors; that flag is invalid for write requests.
1347 * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers
1348 * should always terminate with a short packet, even if it means adding an
1349 * extra zero length packet.
1351 * Control URBs must provide a valid pointer in the setup_packet field.
1352 * Unlike the transfer_buffer, the setup_packet may not be mapped for DMA
1355 * Interrupt URBs must provide an interval, saying how often (in milliseconds
1356 * or, for highspeed devices, 125 microsecond units)
1357 * to poll for transfers. After the URB has been submitted, the interval
1358 * field reflects how the transfer was actually scheduled.
1359 * The polling interval may be more frequent than requested.
1360 * For example, some controllers have a maximum interval of 32 milliseconds,
1361 * while others support intervals of up to 1024 milliseconds.
1362 * Isochronous URBs also have transfer intervals. (Note that for isochronous
1363 * endpoints, as well as high speed interrupt endpoints, the encoding of
1364 * the transfer interval in the endpoint descriptor is logarithmic.
1365 * Device drivers must convert that value to linear units themselves.)
1367 * If an isochronous endpoint queue isn't already running, the host
1368 * controller will schedule a new URB to start as soon as bandwidth
1369 * utilization allows. If the queue is running then a new URB will be
1370 * scheduled to start in the first transfer slot following the end of the
1371 * preceding URB, if that slot has not already expired. If the slot has
1372 * expired (which can happen when IRQ delivery is delayed for a long time),
1373 * the scheduling behavior depends on the URB_ISO_ASAP flag. If the flag
1374 * is clear then the URB will be scheduled to start in the expired slot,
1375 * implying that some of its packets will not be transferred; if the flag
1376 * is set then the URB will be scheduled in the first unexpired slot,
1377 * breaking the queue's synchronization. Upon URB completion, the
1378 * start_frame field will be set to the (micro)frame number in which the
1379 * transfer was scheduled. Ranges for frame counter values are HC-specific
1380 * and can go from as low as 256 to as high as 65536 frames.
1382 * Isochronous URBs have a different data transfer model, in part because
1383 * the quality of service is only "best effort". Callers provide specially
1384 * allocated URBs, with number_of_packets worth of iso_frame_desc structures
1385 * at the end. Each such packet is an individual ISO transfer. Isochronous
1386 * URBs are normally queued, submitted by drivers to arrange that
1387 * transfers are at least double buffered, and then explicitly resubmitted
1388 * in completion handlers, so
1389 * that data (such as audio or video) streams at as constant a rate as the
1390 * host controller scheduler can support.
1392 * Completion Callbacks:
1394 * The completion callback is made in_interrupt(), and one of the first
1395 * things that a completion handler should do is check the status field.
1396 * The status field is provided for all URBs. It is used to report
1397 * unlinked URBs, and status for all non-ISO transfers. It should not
1398 * be examined before the URB is returned to the completion handler.
1400 * The context field is normally used to link URBs back to the relevant
1401 * driver or request state.
1403 * When the completion callback is invoked for non-isochronous URBs, the
1404 * actual_length field tells how many bytes were transferred. This field
1405 * is updated even when the URB terminated with an error or was unlinked.
1407 * ISO transfer status is reported in the status and actual_length fields
1408 * of the iso_frame_desc array, and the number of errors is reported in
1409 * error_count. Completion callbacks for ISO transfers will normally
1410 * (re)submit URBs to ensure a constant transfer rate.
1412 * Note that even fields marked "public" should not be touched by the driver
1413 * when the urb is owned by the hcd, that is, since the call to
1414 * usb_submit_urb() till the entry into the completion routine.
1417 /* private: usb core and host controller only fields in the urb */
1418 struct kref kref; /* reference count of the URB */
1419 void *hcpriv; /* private data for host controller */
1420 atomic_t use_count; /* concurrent submissions counter */
1421 atomic_t reject; /* submissions will fail */
1422 int unlinked; /* unlink error code */
1424 /* public: documented fields in the urb that can be used by drivers */
1425 struct list_head urb_list; /* list head for use by the urb's
1427 struct list_head anchor_list; /* the URB may be anchored */
1428 struct usb_anchor *anchor;
1429 struct usb_device *dev; /* (in) pointer to associated device */
1430 struct usb_host_endpoint *ep; /* (internal) pointer to endpoint */
1431 unsigned int pipe; /* (in) pipe information */
1432 unsigned int stream_id; /* (in) stream ID */
1433 int status; /* (return) non-ISO status */
1434 unsigned int transfer_flags; /* (in) URB_SHORT_NOT_OK | ...*/
1435 void *transfer_buffer; /* (in) associated data buffer */
1436 dma_addr_t transfer_dma; /* (in) dma addr for transfer_buffer */
1437 struct scatterlist *sg; /* (in) scatter gather buffer list */
1438 int num_mapped_sgs; /* (internal) mapped sg entries */
1439 int num_sgs; /* (in) number of entries in the sg list */
1440 u32 transfer_buffer_length; /* (in) data buffer length */
1441 u32 actual_length; /* (return) actual transfer length */
1442 unsigned char *setup_packet; /* (in) setup packet (control only) */
1443 dma_addr_t setup_dma; /* (in) dma addr for setup_packet */
1444 int start_frame; /* (modify) start frame (ISO) */
1445 int number_of_packets; /* (in) number of ISO packets */
1446 int interval; /* (modify) transfer interval
1448 int error_count; /* (return) number of ISO errors */
1449 void *context; /* (in) context for completion */
1450 usb_complete_t complete; /* (in) completion routine */
1451 struct usb_iso_packet_descriptor iso_frame_desc[0];
1455 /* ----------------------------------------------------------------------- */
1458 * usb_fill_control_urb - initializes a control urb
1459 * @urb: pointer to the urb to initialize.
1460 * @dev: pointer to the struct usb_device for this urb.
1461 * @pipe: the endpoint pipe
1462 * @setup_packet: pointer to the setup_packet buffer
1463 * @transfer_buffer: pointer to the transfer buffer
1464 * @buffer_length: length of the transfer buffer
1465 * @complete_fn: pointer to the usb_complete_t function
1466 * @context: what to set the urb context to.
1468 * Initializes a control urb with the proper information needed to submit
1471 static inline void usb_fill_control_urb(struct urb *urb,
1472 struct usb_device *dev,
1474 unsigned char *setup_packet,
1475 void *transfer_buffer,
1477 usb_complete_t complete_fn,
1482 urb->setup_packet = setup_packet;
1483 urb->transfer_buffer = transfer_buffer;
1484 urb->transfer_buffer_length = buffer_length;
1485 urb->complete = complete_fn;
1486 urb->context = context;
1490 * usb_fill_bulk_urb - macro to help initialize a bulk urb
1491 * @urb: pointer to the urb to initialize.
1492 * @dev: pointer to the struct usb_device for this urb.
1493 * @pipe: the endpoint pipe
1494 * @transfer_buffer: pointer to the transfer buffer
1495 * @buffer_length: length of the transfer buffer
1496 * @complete_fn: pointer to the usb_complete_t function
1497 * @context: what to set the urb context to.
1499 * Initializes a bulk urb with the proper information needed to submit it
1502 static inline void usb_fill_bulk_urb(struct urb *urb,
1503 struct usb_device *dev,
1505 void *transfer_buffer,
1507 usb_complete_t complete_fn,
1512 urb->transfer_buffer = transfer_buffer;
1513 urb->transfer_buffer_length = buffer_length;
1514 urb->complete = complete_fn;
1515 urb->context = context;
1519 * usb_fill_int_urb - macro to help initialize a interrupt urb
1520 * @urb: pointer to the urb to initialize.
1521 * @dev: pointer to the struct usb_device for this urb.
1522 * @pipe: the endpoint pipe
1523 * @transfer_buffer: pointer to the transfer buffer
1524 * @buffer_length: length of the transfer buffer
1525 * @complete_fn: pointer to the usb_complete_t function
1526 * @context: what to set the urb context to.
1527 * @interval: what to set the urb interval to, encoded like
1528 * the endpoint descriptor's bInterval value.
1530 * Initializes a interrupt urb with the proper information needed to submit
1533 * Note that High Speed and SuperSpeed interrupt endpoints use a logarithmic
1534 * encoding of the endpoint interval, and express polling intervals in
1535 * microframes (eight per millisecond) rather than in frames (one per
1538 * Wireless USB also uses the logarithmic encoding, but specifies it in units of
1539 * 128us instead of 125us. For Wireless USB devices, the interval is passed
1540 * through to the host controller, rather than being translated into microframe
1543 static inline void usb_fill_int_urb(struct urb *urb,
1544 struct usb_device *dev,
1546 void *transfer_buffer,
1548 usb_complete_t complete_fn,
1554 urb->transfer_buffer = transfer_buffer;
1555 urb->transfer_buffer_length = buffer_length;
1556 urb->complete = complete_fn;
1557 urb->context = context;
1559 if (dev->speed == USB_SPEED_HIGH || dev->speed == USB_SPEED_SUPER) {
1560 /* make sure interval is within allowed range */
1561 interval = clamp(interval, 1, 16);
1563 urb->interval = 1 << (interval - 1);
1565 urb->interval = interval;
1568 urb->start_frame = -1;
1571 extern void usb_init_urb(struct urb *urb);
1572 extern struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags);
1573 extern void usb_free_urb(struct urb *urb);
1574 #define usb_put_urb usb_free_urb
1575 extern struct urb *usb_get_urb(struct urb *urb);
1576 extern int usb_submit_urb(struct urb *urb, gfp_t mem_flags);
1577 extern int usb_unlink_urb(struct urb *urb);
1578 extern void usb_kill_urb(struct urb *urb);
1579 extern void usb_poison_urb(struct urb *urb);
1580 extern void usb_unpoison_urb(struct urb *urb);
1581 extern void usb_block_urb(struct urb *urb);
1582 extern void usb_kill_anchored_urbs(struct usb_anchor *anchor);
1583 extern void usb_poison_anchored_urbs(struct usb_anchor *anchor);
1584 extern void usb_unpoison_anchored_urbs(struct usb_anchor *anchor);
1585 extern void usb_unlink_anchored_urbs(struct usb_anchor *anchor);
1586 extern void usb_anchor_suspend_wakeups(struct usb_anchor *anchor);
1587 extern void usb_anchor_resume_wakeups(struct usb_anchor *anchor);
1588 extern void usb_anchor_urb(struct urb *urb, struct usb_anchor *anchor);
1589 extern void usb_unanchor_urb(struct urb *urb);
1590 extern int usb_wait_anchor_empty_timeout(struct usb_anchor *anchor,
1591 unsigned int timeout);
1592 extern struct urb *usb_get_from_anchor(struct usb_anchor *anchor);
1593 extern void usb_scuttle_anchored_urbs(struct usb_anchor *anchor);
1594 extern int usb_anchor_empty(struct usb_anchor *anchor);
1596 #define usb_unblock_urb usb_unpoison_urb
1599 * usb_urb_dir_in - check if an URB describes an IN transfer
1600 * @urb: URB to be checked
1602 * Return: 1 if @urb describes an IN transfer (device-to-host),
1605 static inline int usb_urb_dir_in(struct urb *urb)
1607 return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_IN;
1611 * usb_urb_dir_out - check if an URB describes an OUT transfer
1612 * @urb: URB to be checked
1614 * Return: 1 if @urb describes an OUT transfer (host-to-device),
1617 static inline int usb_urb_dir_out(struct urb *urb)
1619 return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_OUT;
1622 void *usb_alloc_coherent(struct usb_device *dev, size_t size,
1623 gfp_t mem_flags, dma_addr_t *dma);
1624 void usb_free_coherent(struct usb_device *dev, size_t size,
1625 void *addr, dma_addr_t dma);
1628 struct urb *usb_buffer_map(struct urb *urb);
1629 void usb_buffer_dmasync(struct urb *urb);
1630 void usb_buffer_unmap(struct urb *urb);
1634 int usb_buffer_map_sg(const struct usb_device *dev, int is_in,
1635 struct scatterlist *sg, int nents);
1637 void usb_buffer_dmasync_sg(const struct usb_device *dev, int is_in,
1638 struct scatterlist *sg, int n_hw_ents);
1640 void usb_buffer_unmap_sg(const struct usb_device *dev, int is_in,
1641 struct scatterlist *sg, int n_hw_ents);
1643 /*-------------------------------------------------------------------*
1644 * SYNCHRONOUS CALL SUPPORT *
1645 *-------------------------------------------------------------------*/
1647 extern int usb_control_msg(struct usb_device *dev, unsigned int pipe,
1648 __u8 request, __u8 requesttype, __u16 value, __u16 index,
1649 void *data, __u16 size, int timeout);
1650 extern int usb_interrupt_msg(struct usb_device *usb_dev, unsigned int pipe,
1651 void *data, int len, int *actual_length, int timeout);
1652 extern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,
1653 void *data, int len, int *actual_length,
1656 /* wrappers around usb_control_msg() for the most common standard requests */
1657 extern int usb_get_descriptor(struct usb_device *dev, unsigned char desctype,
1658 unsigned char descindex, void *buf, int size);
1659 extern int usb_get_status(struct usb_device *dev,
1660 int type, int target, void *data);
1661 extern int usb_string(struct usb_device *dev, int index,
1662 char *buf, size_t size);
1664 /* wrappers that also update important state inside usbcore */
1665 extern int usb_clear_halt(struct usb_device *dev, int pipe);
1666 extern int usb_reset_configuration(struct usb_device *dev);
1667 extern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate);
1668 extern void usb_reset_endpoint(struct usb_device *dev, unsigned int epaddr);
1670 /* this request isn't really synchronous, but it belongs with the others */
1671 extern int usb_driver_set_configuration(struct usb_device *udev, int config);
1674 * timeouts, in milliseconds, used for sending/receiving control messages
1675 * they typically complete within a few frames (msec) after they're issued
1676 * USB identifies 5 second timeouts, maybe more in a few cases, and a few
1677 * slow devices (like some MGE Ellipse UPSes) actually push that limit.
1679 #define USB_CTRL_GET_TIMEOUT 5000
1680 #define USB_CTRL_SET_TIMEOUT 5000
1684 * struct usb_sg_request - support for scatter/gather I/O
1685 * @status: zero indicates success, else negative errno
1686 * @bytes: counts bytes transferred.
1688 * These requests are initialized using usb_sg_init(), and then are used
1689 * as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most
1690 * members of the request object aren't for driver access.
1692 * The status and bytecount values are valid only after usb_sg_wait()
1693 * returns. If the status is zero, then the bytecount matches the total
1696 * After an error completion, drivers may need to clear a halt condition
1699 struct usb_sg_request {
1704 * members below are private to usbcore,
1705 * and are not provided for driver access!
1709 struct usb_device *dev;
1716 struct completion complete;
1720 struct usb_sg_request *io,
1721 struct usb_device *dev,
1724 struct scatterlist *sg,
1729 void usb_sg_cancel(struct usb_sg_request *io);
1730 void usb_sg_wait(struct usb_sg_request *io);
1733 /* ----------------------------------------------------------------------- */
1736 * For various legacy reasons, Linux has a small cookie that's paired with
1737 * a struct usb_device to identify an endpoint queue. Queue characteristics
1738 * are defined by the endpoint's descriptor. This cookie is called a "pipe",
1739 * an unsigned int encoded as:
1741 * - direction: bit 7 (0 = Host-to-Device [Out],
1742 * 1 = Device-to-Host [In] ...
1743 * like endpoint bEndpointAddress)
1744 * - device address: bits 8-14 ... bit positions known to uhci-hcd
1745 * - endpoint: bits 15-18 ... bit positions known to uhci-hcd
1746 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
1747 * 10 = control, 11 = bulk)
1749 * Given the device address and endpoint descriptor, pipes are redundant.
1752 /* NOTE: these are not the standard USB_ENDPOINT_XFER_* values!! */
1753 /* (yet ... they're the values used by usbfs) */
1754 #define PIPE_ISOCHRONOUS 0
1755 #define PIPE_INTERRUPT 1
1756 #define PIPE_CONTROL 2
1759 #define usb_pipein(pipe) ((pipe) & USB_DIR_IN)
1760 #define usb_pipeout(pipe) (!usb_pipein(pipe))
1762 #define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
1763 #define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
1765 #define usb_pipetype(pipe) (((pipe) >> 30) & 3)
1766 #define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
1767 #define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
1768 #define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
1769 #define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
1771 static inline unsigned int __create_pipe(struct usb_device *dev,
1772 unsigned int endpoint)
1774 return (dev->devnum << 8) | (endpoint << 15);
1777 /* Create various pipes... */
1778 #define usb_sndctrlpipe(dev, endpoint) \
1779 ((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint))
1780 #define usb_rcvctrlpipe(dev, endpoint) \
1781 ((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
1782 #define usb_sndisocpipe(dev, endpoint) \
1783 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint))
1784 #define usb_rcvisocpipe(dev, endpoint) \
1785 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
1786 #define usb_sndbulkpipe(dev, endpoint) \
1787 ((PIPE_BULK << 30) | __create_pipe(dev, endpoint))
1788 #define usb_rcvbulkpipe(dev, endpoint) \
1789 ((PIPE_BULK << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
1790 #define usb_sndintpipe(dev, endpoint) \
1791 ((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint))
1792 #define usb_rcvintpipe(dev, endpoint) \
1793 ((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
1795 static inline struct usb_host_endpoint *
1796 usb_pipe_endpoint(struct usb_device *dev, unsigned int pipe)
1798 struct usb_host_endpoint **eps;
1799 eps = usb_pipein(pipe) ? dev->ep_in : dev->ep_out;
1800 return eps[usb_pipeendpoint(pipe)];
1803 /*-------------------------------------------------------------------------*/
1806 usb_maxpacket(struct usb_device *udev, int pipe, int is_out)
1808 struct usb_host_endpoint *ep;
1809 unsigned epnum = usb_pipeendpoint(pipe);
1812 WARN_ON(usb_pipein(pipe));
1813 ep = udev->ep_out[epnum];
1815 WARN_ON(usb_pipeout(pipe));
1816 ep = udev->ep_in[epnum];
1821 /* NOTE: only 0x07ff bits are for packet size... */
1822 return usb_endpoint_maxp(&ep->desc);
1825 /* ----------------------------------------------------------------------- */
1827 /* translate USB error codes to codes user space understands */
1828 static inline int usb_translate_errors(int error_code)
1830 switch (error_code) {
1841 /* Events from the usb core */
1842 #define USB_DEVICE_ADD 0x0001
1843 #define USB_DEVICE_REMOVE 0x0002
1844 #define USB_BUS_ADD 0x0003
1845 #define USB_BUS_REMOVE 0x0004
1846 extern void usb_register_notify(struct notifier_block *nb);
1847 extern void usb_unregister_notify(struct notifier_block *nb);
1850 extern struct dentry *usb_debug_root;
1852 #endif /* __KERNEL__ */