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 * @ssp_isoc_ep_comp: SuperSpeedPlus isoc companion descriptor for this endpoint
54 * @urb_list: urbs queued to this endpoint; maintained by usbcore
55 * @hcpriv: for use by HCD; typically holds hardware dma queue head (QH)
56 * with one or more transfer descriptors (TDs) per urb
57 * @ep_dev: ep_device for sysfs info
58 * @extra: descriptors following this endpoint in the configuration
59 * @extralen: how many bytes of "extra" are valid
60 * @enabled: URBs may be submitted to this endpoint
61 * @streams: number of USB-3 streams allocated on the endpoint
63 * USB requests are always queued to a given endpoint, identified by a
64 * descriptor within an active interface in a given USB configuration.
66 struct usb_host_endpoint {
67 struct usb_endpoint_descriptor desc;
68 struct usb_ss_ep_comp_descriptor ss_ep_comp;
69 struct usb_ssp_isoc_ep_comp_descriptor ssp_isoc_ep_comp;
70 struct list_head urb_list;
72 struct ep_device *ep_dev; /* For sysfs info */
74 unsigned char *extra; /* Extra descriptors */
80 /* host-side wrapper for one interface setting's parsed descriptors */
81 struct usb_host_interface {
82 struct usb_interface_descriptor desc;
85 unsigned char *extra; /* Extra descriptors */
87 /* array of desc.bNumEndpoints endpoints associated with this
88 * interface setting. these will be in no particular order.
90 struct usb_host_endpoint *endpoint;
92 char *string; /* iInterface string, if present */
95 enum usb_interface_condition {
96 USB_INTERFACE_UNBOUND = 0,
97 USB_INTERFACE_BINDING,
99 USB_INTERFACE_UNBINDING,
103 usb_find_common_endpoints(struct usb_host_interface *alt,
104 struct usb_endpoint_descriptor **bulk_in,
105 struct usb_endpoint_descriptor **bulk_out,
106 struct usb_endpoint_descriptor **int_in,
107 struct usb_endpoint_descriptor **int_out);
109 static inline int __must_check
110 usb_find_bulk_in_endpoint(struct usb_host_interface *alt,
111 struct usb_endpoint_descriptor **bulk_in)
113 return usb_find_common_endpoints(alt, bulk_in, NULL, NULL, NULL);
116 static inline int __must_check
117 usb_find_bulk_out_endpoint(struct usb_host_interface *alt,
118 struct usb_endpoint_descriptor **bulk_out)
120 return usb_find_common_endpoints(alt, NULL, bulk_out, NULL, NULL);
123 static inline int __must_check
124 usb_find_int_in_endpoint(struct usb_host_interface *alt,
125 struct usb_endpoint_descriptor **int_in)
127 return usb_find_common_endpoints(alt, NULL, NULL, int_in, NULL);
130 static inline int __must_check
131 usb_find_int_out_endpoint(struct usb_host_interface *alt,
132 struct usb_endpoint_descriptor **int_out)
134 return usb_find_common_endpoints(alt, NULL, NULL, NULL, int_out);
138 * struct usb_interface - what usb device drivers talk to
139 * @altsetting: array of interface structures, one for each alternate
140 * setting that may be selected. Each one includes a set of
141 * endpoint configurations. They will be in no particular order.
142 * @cur_altsetting: the current altsetting.
143 * @num_altsetting: number of altsettings defined.
144 * @intf_assoc: interface association descriptor
145 * @minor: the minor number assigned to this interface, if this
146 * interface is bound to a driver that uses the USB major number.
147 * If this interface does not use the USB major, this field should
148 * be unused. The driver should set this value in the probe()
149 * function of the driver, after it has been assigned a minor
150 * number from the USB core by calling usb_register_dev().
151 * @condition: binding state of the interface: not bound, binding
152 * (in probe()), bound to a driver, or unbinding (in disconnect())
153 * @sysfs_files_created: sysfs attributes exist
154 * @ep_devs_created: endpoint child pseudo-devices exist
155 * @unregistering: flag set when the interface is being unregistered
156 * @needs_remote_wakeup: flag set when the driver requires remote-wakeup
157 * capability during autosuspend.
158 * @needs_altsetting0: flag set when a set-interface request for altsetting 0
160 * @needs_binding: flag set when the driver should be re-probed or unbound
161 * following a reset or suspend operation it doesn't support.
162 * @authorized: This allows to (de)authorize individual interfaces instead
163 * a whole device in contrast to the device authorization.
164 * @dev: driver model's view of this device
165 * @usb_dev: if an interface is bound to the USB major, this will point
166 * to the sysfs representation for that device.
167 * @reset_ws: Used for scheduling resets from atomic context.
168 * @resetting_device: USB core reset the device, so use alt setting 0 as
169 * current; needs bandwidth alloc after reset.
171 * USB device drivers attach to interfaces on a physical device. Each
172 * interface encapsulates a single high level function, such as feeding
173 * an audio stream to a speaker or reporting a change in a volume control.
174 * Many USB devices only have one interface. The protocol used to talk to
175 * an interface's endpoints can be defined in a usb "class" specification,
176 * or by a product's vendor. The (default) control endpoint is part of
177 * every interface, but is never listed among the interface's descriptors.
179 * The driver that is bound to the interface can use standard driver model
180 * calls such as dev_get_drvdata() on the dev member of this structure.
182 * Each interface may have alternate settings. The initial configuration
183 * of a device sets altsetting 0, but the device driver can change
184 * that setting using usb_set_interface(). Alternate settings are often
185 * used to control the use of periodic endpoints, such as by having
186 * different endpoints use different amounts of reserved USB bandwidth.
187 * All standards-conformant USB devices that use isochronous endpoints
188 * will use them in non-default settings.
190 * The USB specification says that alternate setting numbers must run from
191 * 0 to one less than the total number of alternate settings. But some
192 * devices manage to mess this up, and the structures aren't necessarily
193 * stored in numerical order anyhow. Use usb_altnum_to_altsetting() to
194 * look up an alternate setting in the altsetting array based on its number.
196 struct usb_interface {
197 /* array of alternate settings for this interface,
198 * stored in no particular order */
199 struct usb_host_interface *altsetting;
201 struct usb_host_interface *cur_altsetting; /* the currently
202 * active alternate setting */
203 unsigned num_altsetting; /* number of alternate settings */
205 /* If there is an interface association descriptor then it will list
206 * the associated interfaces */
207 struct usb_interface_assoc_descriptor *intf_assoc;
209 int minor; /* minor number this interface is
211 enum usb_interface_condition condition; /* state of binding */
212 unsigned sysfs_files_created:1; /* the sysfs attributes exist */
213 unsigned ep_devs_created:1; /* endpoint "devices" exist */
214 unsigned unregistering:1; /* unregistration is in progress */
215 unsigned needs_remote_wakeup:1; /* driver requires remote wakeup */
216 unsigned needs_altsetting0:1; /* switch to altsetting 0 is pending */
217 unsigned needs_binding:1; /* needs delayed unbind/rebind */
218 unsigned resetting_device:1; /* true: bandwidth alloc after reset */
219 unsigned authorized:1; /* used for interface authorization */
221 struct device dev; /* interface specific device info */
222 struct device *usb_dev;
223 struct work_struct reset_ws; /* for resets in atomic context */
225 #define to_usb_interface(d) container_of(d, struct usb_interface, dev)
227 static inline void *usb_get_intfdata(struct usb_interface *intf)
229 return dev_get_drvdata(&intf->dev);
232 static inline void usb_set_intfdata(struct usb_interface *intf, void *data)
234 dev_set_drvdata(&intf->dev, data);
237 struct usb_interface *usb_get_intf(struct usb_interface *intf);
238 void usb_put_intf(struct usb_interface *intf);
241 #define USB_MAXENDPOINTS 30
242 /* this maximum is arbitrary */
243 #define USB_MAXINTERFACES 32
244 #define USB_MAXIADS (USB_MAXINTERFACES/2)
247 * USB Resume Timer: Every Host controller driver should drive the resume
248 * signalling on the bus for the amount of time defined by this macro.
250 * That way we will have a 'stable' behavior among all HCDs supported by Linux.
252 * Note that the USB Specification states we should drive resume for *at least*
253 * 20 ms, but it doesn't give an upper bound. This creates two possible
254 * situations which we want to avoid:
256 * (a) sometimes an msleep(20) might expire slightly before 20 ms, which causes
257 * us to fail USB Electrical Tests, thus failing Certification
259 * (b) Some (many) devices actually need more than 20 ms of resume signalling,
260 * and while we can argue that's against the USB Specification, we don't have
261 * control over which devices a certification laboratory will be using for
262 * certification. If CertLab uses a device which was tested against Windows and
263 * that happens to have relaxed resume signalling rules, we might fall into
264 * situations where we fail interoperability and electrical tests.
266 * In order to avoid both conditions, we're using a 40 ms resume timeout, which
267 * should cope with both LPJ calibration errors and devices not following every
268 * detail of the USB Specification.
270 #define USB_RESUME_TIMEOUT 40 /* ms */
273 * struct usb_interface_cache - long-term representation of a device interface
274 * @num_altsetting: number of altsettings defined.
275 * @ref: reference counter.
276 * @altsetting: variable-length array of interface structures, one for
277 * each alternate setting that may be selected. Each one includes a
278 * set of endpoint configurations. They will be in no particular order.
280 * These structures persist for the lifetime of a usb_device, unlike
281 * struct usb_interface (which persists only as long as its configuration
282 * is installed). The altsetting arrays can be accessed through these
283 * structures at any time, permitting comparison of configurations and
284 * providing support for the /proc/bus/usb/devices pseudo-file.
286 struct usb_interface_cache {
287 unsigned num_altsetting; /* number of alternate settings */
288 struct kref ref; /* reference counter */
290 /* variable-length array of alternate settings for this interface,
291 * stored in no particular order */
292 struct usb_host_interface altsetting[0];
294 #define ref_to_usb_interface_cache(r) \
295 container_of(r, struct usb_interface_cache, ref)
296 #define altsetting_to_usb_interface_cache(a) \
297 container_of(a, struct usb_interface_cache, altsetting[0])
300 * struct usb_host_config - representation of a device's configuration
301 * @desc: the device's configuration descriptor.
302 * @string: pointer to the cached version of the iConfiguration string, if
303 * present for this configuration.
304 * @intf_assoc: list of any interface association descriptors in this config
305 * @interface: array of pointers to usb_interface structures, one for each
306 * interface in the configuration. The number of interfaces is stored
307 * in desc.bNumInterfaces. These pointers are valid only while the
308 * the configuration is active.
309 * @intf_cache: array of pointers to usb_interface_cache structures, one
310 * for each interface in the configuration. These structures exist
311 * for the entire life of the device.
312 * @extra: pointer to buffer containing all extra descriptors associated
313 * with this configuration (those preceding the first interface
315 * @extralen: length of the extra descriptors buffer.
317 * USB devices may have multiple configurations, but only one can be active
318 * at any time. Each encapsulates a different operational environment;
319 * for example, a dual-speed device would have separate configurations for
320 * full-speed and high-speed operation. The number of configurations
321 * available is stored in the device descriptor as bNumConfigurations.
323 * A configuration can contain multiple interfaces. Each corresponds to
324 * a different function of the USB device, and all are available whenever
325 * the configuration is active. The USB standard says that interfaces
326 * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot
327 * of devices get this wrong. In addition, the interface array is not
328 * guaranteed to be sorted in numerical order. Use usb_ifnum_to_if() to
329 * look up an interface entry based on its number.
331 * Device drivers should not attempt to activate configurations. The choice
332 * of which configuration to install is a policy decision based on such
333 * considerations as available power, functionality provided, and the user's
334 * desires (expressed through userspace tools). However, drivers can call
335 * usb_reset_configuration() to reinitialize the current configuration and
336 * all its interfaces.
338 struct usb_host_config {
339 struct usb_config_descriptor desc;
341 char *string; /* iConfiguration string, if present */
343 /* List of any Interface Association Descriptors in this
345 struct usb_interface_assoc_descriptor *intf_assoc[USB_MAXIADS];
347 /* the interfaces associated with this configuration,
348 * stored in no particular order */
349 struct usb_interface *interface[USB_MAXINTERFACES];
351 /* Interface information available even when this is not the
352 * active configuration */
353 struct usb_interface_cache *intf_cache[USB_MAXINTERFACES];
355 unsigned char *extra; /* Extra descriptors */
359 /* USB2.0 and USB3.0 device BOS descriptor set */
360 struct usb_host_bos {
361 struct usb_bos_descriptor *desc;
363 /* wireless cap descriptor is handled by wusb */
364 struct usb_ext_cap_descriptor *ext_cap;
365 struct usb_ss_cap_descriptor *ss_cap;
366 struct usb_ssp_cap_descriptor *ssp_cap;
367 struct usb_ss_container_id_descriptor *ss_id;
368 struct usb_ptm_cap_descriptor *ptm_cap;
371 int __usb_get_extra_descriptor(char *buffer, unsigned size,
372 unsigned char type, void **ptr, size_t min);
373 #define usb_get_extra_descriptor(ifpoint, type, ptr) \
374 __usb_get_extra_descriptor((ifpoint)->extra, \
375 (ifpoint)->extralen, \
376 type, (void **)ptr, sizeof(**(ptr)))
378 /* ----------------------------------------------------------------------- */
380 /* USB device number allocation bitmap */
382 unsigned long devicemap[128 / (8*sizeof(unsigned long))];
386 * Allocated per bus (tree of devices) we have:
389 struct device *controller; /* host/master side hardware */
390 int busnum; /* Bus number (in order of reg) */
391 const char *bus_name; /* stable id (PCI slot_name etc) */
392 u8 uses_dma; /* Does the host controller use DMA? */
393 u8 uses_pio_for_control; /*
394 * Does the host controller use PIO
395 * for control transfers?
397 u8 otg_port; /* 0, or number of OTG/HNP port */
398 unsigned is_b_host:1; /* true during some HNP roleswitches */
399 unsigned b_hnp_enable:1; /* OTG: did A-Host enable HNP? */
400 unsigned no_stop_on_short:1; /*
401 * Quirk: some controllers don't stop
402 * the ep queue on a short transfer
403 * with the URB_SHORT_NOT_OK flag set.
405 unsigned no_sg_constraint:1; /* no sg constraint */
406 unsigned sg_tablesize; /* 0 or largest number of sg list entries */
408 int devnum_next; /* Next open device number in
409 * round-robin allocation */
410 struct mutex devnum_next_mutex; /* devnum_next mutex */
412 struct usb_devmap devmap; /* device address allocation map */
413 struct usb_device *root_hub; /* Root hub */
414 struct usb_bus *hs_companion; /* Companion EHCI bus, if any */
416 int bandwidth_allocated; /* on this bus: how much of the time
417 * reserved for periodic (intr/iso)
418 * requests is used, on average?
419 * Units: microseconds/frame.
420 * Limits: Full/low speed reserve 90%,
421 * while high speed reserves 80%.
423 int bandwidth_int_reqs; /* number of Interrupt requests */
424 int bandwidth_isoc_reqs; /* number of Isoc. requests */
426 unsigned resuming_ports; /* bit array: resuming root-hub ports */
428 #if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
429 struct mon_bus *mon_bus; /* non-null when associated */
430 int monitored; /* non-zero when monitored */
434 struct usb_dev_state;
436 /* ----------------------------------------------------------------------- */
440 enum usb_device_removable {
441 USB_DEVICE_REMOVABLE_UNKNOWN = 0,
442 USB_DEVICE_REMOVABLE,
446 enum usb_port_connect_type {
447 USB_PORT_CONNECT_TYPE_UNKNOWN = 0,
448 USB_PORT_CONNECT_TYPE_HOT_PLUG,
449 USB_PORT_CONNECT_TYPE_HARD_WIRED,
454 * USB 2.0 Link Power Management (LPM) parameters.
456 struct usb2_lpm_parameters {
457 /* Best effort service latency indicate how long the host will drive
458 * resume on an exit from L1.
462 /* Timeout value in microseconds for the L1 inactivity (LPM) timer.
463 * When the timer counts to zero, the parent hub will initiate a LPM
470 * USB 3.0 Link Power Management (LPM) parameters.
472 * PEL and SEL are USB 3.0 Link PM latencies for device-initiated LPM exit.
473 * MEL is the USB 3.0 Link PM latency for host-initiated LPM exit.
474 * All three are stored in nanoseconds.
476 struct usb3_lpm_parameters {
478 * Maximum exit latency (MEL) for the host to send a packet to the
479 * device (either a Ping for isoc endpoints, or a data packet for
480 * interrupt endpoints), the hubs to decode the packet, and for all hubs
481 * in the path to transition the links to U0.
485 * Maximum exit latency for a device-initiated LPM transition to bring
486 * all links into U0. Abbreviated as "PEL" in section 9.4.12 of the USB
487 * 3.0 spec, with no explanation of what "P" stands for. "Path"?
492 * The System Exit Latency (SEL) includes PEL, and three other
493 * latencies. After a device initiates a U0 transition, it will take
494 * some time from when the device sends the ERDY to when it will finally
495 * receive the data packet. Basically, SEL should be the worse-case
496 * latency from when a device starts initiating a U0 transition to when
501 * The idle timeout value that is currently programmed into the parent
502 * hub for this device. When the timer counts to zero, the parent hub
503 * will initiate an LPM transition to either U1 or U2.
509 * struct usb_device - kernel's representation of a USB device
510 * @devnum: device number; address on a USB bus
511 * @devpath: device ID string for use in messages (e.g., /port/...)
512 * @route: tree topology hex string for use with xHCI
513 * @state: device state: configured, not attached, etc.
514 * @speed: device speed: high/full/low (or error)
515 * @tt: Transaction Translator info; used with low/full speed dev, highspeed hub
516 * @ttport: device port on that tt hub
517 * @toggle: one bit for each endpoint, with ([0] = IN, [1] = OUT) endpoints
518 * @parent: our hub, unless we're the root
519 * @bus: bus we're part of
520 * @ep0: endpoint 0 data (default control pipe)
521 * @dev: generic device interface
522 * @descriptor: USB device descriptor
523 * @bos: USB device BOS descriptor set
524 * @config: all of the device's configs
525 * @actconfig: the active configuration
526 * @ep_in: array of IN endpoints
527 * @ep_out: array of OUT endpoints
528 * @rawdescriptors: raw descriptors for each config
529 * @bus_mA: Current available from the bus
530 * @portnum: parent port number (origin 1)
531 * @level: number of USB hub ancestors
532 * @can_submit: URBs may be submitted
533 * @persist_enabled: USB_PERSIST enabled for this device
534 * @reset_in_progress: the device is being reset
535 * @have_langid: whether string_langid is valid
536 * @authorized: policy has said we can use it;
537 * (user space) policy determines if we authorize this device to be
538 * used or not. By default, wired USB devices are authorized.
539 * WUSB devices are not, until we authorize them from user space.
540 * FIXME -- complete doc
541 * @authenticated: Crypto authentication passed
542 * @wusb: device is Wireless USB
543 * @lpm_capable: device supports LPM
544 * @usb2_hw_lpm_capable: device can perform USB2 hardware LPM
545 * @usb2_hw_lpm_besl_capable: device can perform USB2 hardware BESL LPM
546 * @usb2_hw_lpm_enabled: USB2 hardware LPM is enabled
547 * @usb2_hw_lpm_allowed: Userspace allows USB 2.0 LPM to be enabled
548 * @usb3_lpm_u1_enabled: USB3 hardware U1 LPM enabled
549 * @usb3_lpm_u2_enabled: USB3 hardware U2 LPM enabled
550 * @string_langid: language ID for strings
551 * @product: iProduct string, if present (static)
552 * @manufacturer: iManufacturer string, if present (static)
553 * @serial: iSerialNumber string, if present (static)
554 * @filelist: usbfs files that are open to this device
555 * @maxchild: number of ports if hub
556 * @quirks: quirks of the whole device
557 * @urbnum: number of URBs submitted for the whole device
558 * @active_duration: total time device is not suspended
559 * @connect_time: time device was first connected
560 * @do_remote_wakeup: remote wakeup should be enabled
561 * @reset_resume: needs reset instead of resume
562 * @port_is_suspended: the upstream port is suspended (L2 or U3)
563 * @wusb_dev: if this is a Wireless USB device, link to the WUSB
564 * specific data for the device.
565 * @slot_id: Slot ID assigned by xHCI
566 * @removable: Device can be physically removed from this port
567 * @l1_params: best effor service latency for USB2 L1 LPM state, and L1 timeout.
568 * @u1_params: exit latencies for USB3 U1 LPM state, and hub-initiated timeout.
569 * @u2_params: exit latencies for USB3 U2 LPM state, and hub-initiated timeout.
570 * @lpm_disable_count: Ref count used by usb_disable_lpm() and usb_enable_lpm()
571 * to keep track of the number of functions that require USB 3.0 Link Power
572 * Management to be disabled for this usb_device. This count should only
573 * be manipulated by those functions, with the bandwidth_mutex is held.
576 * Usbcore drivers should not set usbdev->state directly. Instead use
577 * usb_set_device_state().
583 enum usb_device_state state;
584 enum usb_device_speed speed;
589 unsigned int toggle[2];
591 struct usb_device *parent;
593 struct usb_host_endpoint ep0;
597 struct usb_device_descriptor descriptor;
598 struct usb_host_bos *bos;
599 struct usb_host_config *config;
601 struct usb_host_config *actconfig;
602 struct usb_host_endpoint *ep_in[16];
603 struct usb_host_endpoint *ep_out[16];
605 char **rawdescriptors;
607 unsigned short bus_mA;
611 unsigned can_submit:1;
612 unsigned persist_enabled:1;
613 unsigned reset_in_progress:1;
614 unsigned have_langid:1;
615 unsigned authorized:1;
616 unsigned authenticated:1;
618 unsigned lpm_capable:1;
619 unsigned usb2_hw_lpm_capable:1;
620 unsigned usb2_hw_lpm_besl_capable:1;
621 unsigned usb2_hw_lpm_enabled:1;
622 unsigned usb2_hw_lpm_allowed:1;
623 unsigned usb3_lpm_u1_enabled:1;
624 unsigned usb3_lpm_u2_enabled:1;
627 /* static strings from the device */
632 struct list_head filelist;
639 unsigned long active_duration;
642 unsigned long connect_time;
644 unsigned do_remote_wakeup:1;
645 unsigned reset_resume:1;
646 unsigned port_is_suspended:1;
648 struct wusb_dev *wusb_dev;
650 enum usb_device_removable removable;
651 struct usb2_lpm_parameters l1_params;
652 struct usb3_lpm_parameters u1_params;
653 struct usb3_lpm_parameters u2_params;
654 unsigned lpm_disable_count;
656 #define to_usb_device(d) container_of(d, struct usb_device, dev)
658 static inline struct usb_device *interface_to_usbdev(struct usb_interface *intf)
660 return to_usb_device(intf->dev.parent);
663 extern struct usb_device *usb_get_dev(struct usb_device *dev);
664 extern void usb_put_dev(struct usb_device *dev);
665 extern struct usb_device *usb_hub_find_child(struct usb_device *hdev,
669 * usb_hub_for_each_child - iterate over all child devices on the hub
670 * @hdev: USB device belonging to the usb hub
671 * @port1: portnum associated with child device
672 * @child: child device pointer
674 #define usb_hub_for_each_child(hdev, port1, child) \
675 for (port1 = 1, child = usb_hub_find_child(hdev, port1); \
676 port1 <= hdev->maxchild; \
677 child = usb_hub_find_child(hdev, ++port1)) \
678 if (!child) continue; else
680 /* USB device locking */
681 #define usb_lock_device(udev) device_lock(&(udev)->dev)
682 #define usb_unlock_device(udev) device_unlock(&(udev)->dev)
683 #define usb_lock_device_interruptible(udev) device_lock_interruptible(&(udev)->dev)
684 #define usb_trylock_device(udev) device_trylock(&(udev)->dev)
685 extern int usb_lock_device_for_reset(struct usb_device *udev,
686 const struct usb_interface *iface);
688 /* USB port reset for device reinitialization */
689 extern int usb_reset_device(struct usb_device *dev);
690 extern void usb_queue_reset_device(struct usb_interface *dev);
693 extern int usb_acpi_set_power_state(struct usb_device *hdev, int index,
695 extern bool usb_acpi_power_manageable(struct usb_device *hdev, int index);
697 static inline int usb_acpi_set_power_state(struct usb_device *hdev, int index,
698 bool enable) { return 0; }
699 static inline bool usb_acpi_power_manageable(struct usb_device *hdev, int index)
703 /* USB autosuspend and autoresume */
705 extern void usb_enable_autosuspend(struct usb_device *udev);
706 extern void usb_disable_autosuspend(struct usb_device *udev);
708 extern int usb_autopm_get_interface(struct usb_interface *intf);
709 extern void usb_autopm_put_interface(struct usb_interface *intf);
710 extern int usb_autopm_get_interface_async(struct usb_interface *intf);
711 extern void usb_autopm_put_interface_async(struct usb_interface *intf);
712 extern void usb_autopm_get_interface_no_resume(struct usb_interface *intf);
713 extern void usb_autopm_put_interface_no_suspend(struct usb_interface *intf);
715 static inline void usb_mark_last_busy(struct usb_device *udev)
717 pm_runtime_mark_last_busy(&udev->dev);
722 static inline int usb_enable_autosuspend(struct usb_device *udev)
724 static inline int usb_disable_autosuspend(struct usb_device *udev)
727 static inline int usb_autopm_get_interface(struct usb_interface *intf)
729 static inline int usb_autopm_get_interface_async(struct usb_interface *intf)
732 static inline void usb_autopm_put_interface(struct usb_interface *intf)
734 static inline void usb_autopm_put_interface_async(struct usb_interface *intf)
736 static inline void usb_autopm_get_interface_no_resume(
737 struct usb_interface *intf)
739 static inline void usb_autopm_put_interface_no_suspend(
740 struct usb_interface *intf)
742 static inline void usb_mark_last_busy(struct usb_device *udev)
746 extern int usb_disable_lpm(struct usb_device *udev);
747 extern void usb_enable_lpm(struct usb_device *udev);
748 /* Same as above, but these functions lock/unlock the bandwidth_mutex. */
749 extern int usb_unlocked_disable_lpm(struct usb_device *udev);
750 extern void usb_unlocked_enable_lpm(struct usb_device *udev);
752 extern int usb_disable_ltm(struct usb_device *udev);
753 extern void usb_enable_ltm(struct usb_device *udev);
755 static inline bool usb_device_supports_ltm(struct usb_device *udev)
757 if (udev->speed < USB_SPEED_SUPER || !udev->bos || !udev->bos->ss_cap)
759 return udev->bos->ss_cap->bmAttributes & USB_LTM_SUPPORT;
762 static inline bool usb_device_no_sg_constraint(struct usb_device *udev)
764 return udev && udev->bus && udev->bus->no_sg_constraint;
768 /*-------------------------------------------------------------------------*/
770 /* for drivers using iso endpoints */
771 extern int usb_get_current_frame_number(struct usb_device *usb_dev);
773 /* Sets up a group of bulk endpoints to support multiple stream IDs. */
774 extern int usb_alloc_streams(struct usb_interface *interface,
775 struct usb_host_endpoint **eps, unsigned int num_eps,
776 unsigned int num_streams, gfp_t mem_flags);
778 /* Reverts a group of bulk endpoints back to not using stream IDs. */
779 extern int usb_free_streams(struct usb_interface *interface,
780 struct usb_host_endpoint **eps, unsigned int num_eps,
783 /* used these for multi-interface device registration */
784 extern int usb_driver_claim_interface(struct usb_driver *driver,
785 struct usb_interface *iface, void *priv);
788 * usb_interface_claimed - returns true iff an interface is claimed
789 * @iface: the interface being checked
791 * Return: %true (nonzero) iff the interface is claimed, else %false
795 * Callers must own the driver model's usb bus readlock. So driver
796 * probe() entries don't need extra locking, but other call contexts
797 * may need to explicitly claim that lock.
800 static inline int usb_interface_claimed(struct usb_interface *iface)
802 return (iface->dev.driver != NULL);
805 extern void usb_driver_release_interface(struct usb_driver *driver,
806 struct usb_interface *iface);
807 const struct usb_device_id *usb_match_id(struct usb_interface *interface,
808 const struct usb_device_id *id);
809 extern int usb_match_one_id(struct usb_interface *interface,
810 const struct usb_device_id *id);
812 extern int usb_for_each_dev(void *data, int (*fn)(struct usb_device *, void *));
813 extern struct usb_interface *usb_find_interface(struct usb_driver *drv,
815 extern struct usb_interface *usb_ifnum_to_if(const struct usb_device *dev,
817 extern struct usb_host_interface *usb_altnum_to_altsetting(
818 const struct usb_interface *intf, unsigned int altnum);
819 extern struct usb_host_interface *usb_find_alt_setting(
820 struct usb_host_config *config,
821 unsigned int iface_num,
822 unsigned int alt_num);
824 /* port claiming functions */
825 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
826 struct usb_dev_state *owner);
827 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
828 struct usb_dev_state *owner);
831 * usb_make_path - returns stable device path in the usb tree
832 * @dev: the device whose path is being constructed
833 * @buf: where to put the string
834 * @size: how big is "buf"?
836 * Return: Length of the string (> 0) or negative if size was too small.
839 * This identifier is intended to be "stable", reflecting physical paths in
840 * hardware such as physical bus addresses for host controllers or ports on
841 * USB hubs. That makes it stay the same until systems are physically
842 * reconfigured, by re-cabling a tree of USB devices or by moving USB host
843 * controllers. Adding and removing devices, including virtual root hubs
844 * in host controller driver modules, does not change these path identifiers;
845 * neither does rebooting or re-enumerating. These are more useful identifiers
846 * than changeable ("unstable") ones like bus numbers or device addresses.
848 * With a partial exception for devices connected to USB 2.0 root hubs, these
849 * identifiers are also predictable. So long as the device tree isn't changed,
850 * plugging any USB device into a given hub port always gives it the same path.
851 * Because of the use of "companion" controllers, devices connected to ports on
852 * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are
853 * high speed, and a different one if they are full or low speed.
855 static inline int usb_make_path(struct usb_device *dev, char *buf, size_t size)
858 actual = snprintf(buf, size, "usb-%s-%s", dev->bus->bus_name,
860 return (actual >= (int)size) ? -1 : actual;
863 /*-------------------------------------------------------------------------*/
865 #define USB_DEVICE_ID_MATCH_DEVICE \
866 (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
867 #define USB_DEVICE_ID_MATCH_DEV_RANGE \
868 (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI)
869 #define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
870 (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE)
871 #define USB_DEVICE_ID_MATCH_DEV_INFO \
872 (USB_DEVICE_ID_MATCH_DEV_CLASS | \
873 USB_DEVICE_ID_MATCH_DEV_SUBCLASS | \
874 USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
875 #define USB_DEVICE_ID_MATCH_INT_INFO \
876 (USB_DEVICE_ID_MATCH_INT_CLASS | \
877 USB_DEVICE_ID_MATCH_INT_SUBCLASS | \
878 USB_DEVICE_ID_MATCH_INT_PROTOCOL)
881 * USB_DEVICE - macro used to describe a specific usb device
882 * @vend: the 16 bit USB Vendor ID
883 * @prod: the 16 bit USB Product ID
885 * This macro is used to create a struct usb_device_id that matches a
888 #define USB_DEVICE(vend, prod) \
889 .match_flags = USB_DEVICE_ID_MATCH_DEVICE, \
890 .idVendor = (vend), \
893 * USB_DEVICE_VER - describe a specific usb device with a version range
894 * @vend: the 16 bit USB Vendor ID
895 * @prod: the 16 bit USB Product ID
896 * @lo: the bcdDevice_lo value
897 * @hi: the bcdDevice_hi value
899 * This macro is used to create a struct usb_device_id that matches a
900 * specific device, with a version range.
902 #define USB_DEVICE_VER(vend, prod, lo, hi) \
903 .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, \
904 .idVendor = (vend), \
905 .idProduct = (prod), \
906 .bcdDevice_lo = (lo), \
910 * USB_DEVICE_INTERFACE_CLASS - describe a usb device with a specific interface class
911 * @vend: the 16 bit USB Vendor ID
912 * @prod: the 16 bit USB Product ID
913 * @cl: bInterfaceClass value
915 * This macro is used to create a struct usb_device_id that matches a
916 * specific interface class of devices.
918 #define USB_DEVICE_INTERFACE_CLASS(vend, prod, cl) \
919 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
920 USB_DEVICE_ID_MATCH_INT_CLASS, \
921 .idVendor = (vend), \
922 .idProduct = (prod), \
923 .bInterfaceClass = (cl)
926 * USB_DEVICE_INTERFACE_PROTOCOL - describe a usb device with a specific interface protocol
927 * @vend: the 16 bit USB Vendor ID
928 * @prod: the 16 bit USB Product ID
929 * @pr: bInterfaceProtocol value
931 * This macro is used to create a struct usb_device_id that matches a
932 * specific interface protocol of devices.
934 #define USB_DEVICE_INTERFACE_PROTOCOL(vend, prod, pr) \
935 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
936 USB_DEVICE_ID_MATCH_INT_PROTOCOL, \
937 .idVendor = (vend), \
938 .idProduct = (prod), \
939 .bInterfaceProtocol = (pr)
942 * USB_DEVICE_INTERFACE_NUMBER - describe a usb device with a specific interface number
943 * @vend: the 16 bit USB Vendor ID
944 * @prod: the 16 bit USB Product ID
945 * @num: bInterfaceNumber value
947 * This macro is used to create a struct usb_device_id that matches a
948 * specific interface number of devices.
950 #define USB_DEVICE_INTERFACE_NUMBER(vend, prod, num) \
951 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
952 USB_DEVICE_ID_MATCH_INT_NUMBER, \
953 .idVendor = (vend), \
954 .idProduct = (prod), \
955 .bInterfaceNumber = (num)
958 * USB_DEVICE_INFO - macro used to describe a class of usb devices
959 * @cl: bDeviceClass value
960 * @sc: bDeviceSubClass value
961 * @pr: bDeviceProtocol value
963 * This macro is used to create a struct usb_device_id that matches a
964 * specific class of devices.
966 #define USB_DEVICE_INFO(cl, sc, pr) \
967 .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, \
968 .bDeviceClass = (cl), \
969 .bDeviceSubClass = (sc), \
970 .bDeviceProtocol = (pr)
973 * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces
974 * @cl: bInterfaceClass value
975 * @sc: bInterfaceSubClass value
976 * @pr: bInterfaceProtocol value
978 * This macro is used to create a struct usb_device_id that matches a
979 * specific class of interfaces.
981 #define USB_INTERFACE_INFO(cl, sc, pr) \
982 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, \
983 .bInterfaceClass = (cl), \
984 .bInterfaceSubClass = (sc), \
985 .bInterfaceProtocol = (pr)
988 * USB_DEVICE_AND_INTERFACE_INFO - describe a specific usb device with a class of usb interfaces
989 * @vend: the 16 bit USB Vendor ID
990 * @prod: the 16 bit USB Product ID
991 * @cl: bInterfaceClass value
992 * @sc: bInterfaceSubClass value
993 * @pr: bInterfaceProtocol value
995 * This macro is used to create a struct usb_device_id that matches a
996 * specific device with a specific class of interfaces.
998 * This is especially useful when explicitly matching devices that have
999 * vendor specific bDeviceClass values, but standards-compliant interfaces.
1001 #define USB_DEVICE_AND_INTERFACE_INFO(vend, prod, cl, sc, pr) \
1002 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO \
1003 | USB_DEVICE_ID_MATCH_DEVICE, \
1004 .idVendor = (vend), \
1005 .idProduct = (prod), \
1006 .bInterfaceClass = (cl), \
1007 .bInterfaceSubClass = (sc), \
1008 .bInterfaceProtocol = (pr)
1011 * USB_VENDOR_AND_INTERFACE_INFO - describe a specific usb vendor with a class of usb interfaces
1012 * @vend: the 16 bit USB Vendor ID
1013 * @cl: bInterfaceClass value
1014 * @sc: bInterfaceSubClass value
1015 * @pr: bInterfaceProtocol value
1017 * This macro is used to create a struct usb_device_id that matches a
1018 * specific vendor with a specific class of interfaces.
1020 * This is especially useful when explicitly matching devices that have
1021 * vendor specific bDeviceClass values, but standards-compliant interfaces.
1023 #define USB_VENDOR_AND_INTERFACE_INFO(vend, cl, sc, pr) \
1024 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO \
1025 | USB_DEVICE_ID_MATCH_VENDOR, \
1026 .idVendor = (vend), \
1027 .bInterfaceClass = (cl), \
1028 .bInterfaceSubClass = (sc), \
1029 .bInterfaceProtocol = (pr)
1031 /* ----------------------------------------------------------------------- */
1033 /* Stuff for dynamic usb ids */
1036 struct list_head list;
1040 struct list_head node;
1041 struct usb_device_id id;
1044 extern ssize_t usb_store_new_id(struct usb_dynids *dynids,
1045 const struct usb_device_id *id_table,
1046 struct device_driver *driver,
1047 const char *buf, size_t count);
1049 extern ssize_t usb_show_dynids(struct usb_dynids *dynids, char *buf);
1052 * struct usbdrv_wrap - wrapper for driver-model structure
1053 * @driver: The driver-model core driver structure.
1054 * @for_devices: Non-zero for device drivers, 0 for interface drivers.
1056 struct usbdrv_wrap {
1057 struct device_driver driver;
1062 * struct usb_driver - identifies USB interface driver to usbcore
1063 * @name: The driver name should be unique among USB drivers,
1064 * and should normally be the same as the module name.
1065 * @probe: Called to see if the driver is willing to manage a particular
1066 * interface on a device. If it is, probe returns zero and uses
1067 * usb_set_intfdata() to associate driver-specific data with the
1068 * interface. It may also use usb_set_interface() to specify the
1069 * appropriate altsetting. If unwilling to manage the interface,
1070 * return -ENODEV, if genuine IO errors occurred, an appropriate
1071 * negative errno value.
1072 * @disconnect: Called when the interface is no longer accessible, usually
1073 * because its device has been (or is being) disconnected or the
1074 * driver module is being unloaded.
1075 * @unlocked_ioctl: Used for drivers that want to talk to userspace through
1076 * the "usbfs" filesystem. This lets devices provide ways to
1077 * expose information to user space regardless of where they
1078 * do (or don't) show up otherwise in the filesystem.
1079 * @suspend: Called when the device is going to be suspended by the
1080 * system either from system sleep or runtime suspend context. The
1081 * return value will be ignored in system sleep context, so do NOT
1082 * try to continue using the device if suspend fails in this case.
1083 * Instead, let the resume or reset-resume routine recover from
1085 * @resume: Called when the device is being resumed by the system.
1086 * @reset_resume: Called when the suspended device has been reset instead
1088 * @pre_reset: Called by usb_reset_device() when the device is about to be
1089 * reset. This routine must not return until the driver has no active
1090 * URBs for the device, and no more URBs may be submitted until the
1091 * post_reset method is called.
1092 * @post_reset: Called by usb_reset_device() after the device
1094 * @id_table: USB drivers use ID table to support hotplugging.
1095 * Export this with MODULE_DEVICE_TABLE(usb,...). This must be set
1096 * or your driver's probe function will never get called.
1097 * @dynids: used internally to hold the list of dynamically added device
1098 * ids for this driver.
1099 * @drvwrap: Driver-model core structure wrapper.
1100 * @no_dynamic_id: if set to 1, the USB core will not allow dynamic ids to be
1101 * added to this driver by preventing the sysfs file from being created.
1102 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
1103 * for interfaces bound to this driver.
1104 * @soft_unbind: if set to 1, the USB core will not kill URBs and disable
1105 * endpoints before calling the driver's disconnect method.
1106 * @disable_hub_initiated_lpm: if set to 1, the USB core will not allow hubs
1107 * to initiate lower power link state transitions when an idle timeout
1108 * occurs. Device-initiated USB 3.0 link PM will still be allowed.
1110 * USB interface drivers must provide a name, probe() and disconnect()
1111 * methods, and an id_table. Other driver fields are optional.
1113 * The id_table is used in hotplugging. It holds a set of descriptors,
1114 * and specialized data may be associated with each entry. That table
1115 * is used by both user and kernel mode hotplugging support.
1117 * The probe() and disconnect() methods are called in a context where
1118 * they can sleep, but they should avoid abusing the privilege. Most
1119 * work to connect to a device should be done when the device is opened,
1120 * and undone at the last close. The disconnect code needs to address
1121 * concurrency issues with respect to open() and close() methods, as
1122 * well as forcing all pending I/O requests to complete (by unlinking
1123 * them as necessary, and blocking until the unlinks complete).
1128 int (*probe) (struct usb_interface *intf,
1129 const struct usb_device_id *id);
1131 void (*disconnect) (struct usb_interface *intf);
1133 int (*unlocked_ioctl) (struct usb_interface *intf, unsigned int code,
1136 int (*suspend) (struct usb_interface *intf, pm_message_t message);
1137 int (*resume) (struct usb_interface *intf);
1138 int (*reset_resume)(struct usb_interface *intf);
1140 int (*pre_reset)(struct usb_interface *intf);
1141 int (*post_reset)(struct usb_interface *intf);
1143 const struct usb_device_id *id_table;
1145 struct usb_dynids dynids;
1146 struct usbdrv_wrap drvwrap;
1147 unsigned int no_dynamic_id:1;
1148 unsigned int supports_autosuspend:1;
1149 unsigned int disable_hub_initiated_lpm:1;
1150 unsigned int soft_unbind:1;
1152 #define to_usb_driver(d) container_of(d, struct usb_driver, drvwrap.driver)
1155 * struct usb_device_driver - identifies USB device driver to usbcore
1156 * @name: The driver name should be unique among USB drivers,
1157 * and should normally be the same as the module name.
1158 * @probe: Called to see if the driver is willing to manage a particular
1159 * device. If it is, probe returns zero and uses dev_set_drvdata()
1160 * to associate driver-specific data with the device. If unwilling
1161 * to manage the device, return a negative errno value.
1162 * @disconnect: Called when the device is no longer accessible, usually
1163 * because it has been (or is being) disconnected or the driver's
1164 * module is being unloaded.
1165 * @suspend: Called when the device is going to be suspended by the system.
1166 * @resume: Called when the device is being resumed by the system.
1167 * @drvwrap: Driver-model core structure wrapper.
1168 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
1169 * for devices bound to this driver.
1171 * USB drivers must provide all the fields listed above except drvwrap.
1173 struct usb_device_driver {
1176 int (*probe) (struct usb_device *udev);
1177 void (*disconnect) (struct usb_device *udev);
1179 int (*suspend) (struct usb_device *udev, pm_message_t message);
1180 int (*resume) (struct usb_device *udev, pm_message_t message);
1181 struct usbdrv_wrap drvwrap;
1182 unsigned int supports_autosuspend:1;
1184 #define to_usb_device_driver(d) container_of(d, struct usb_device_driver, \
1187 extern struct bus_type usb_bus_type;
1190 * struct usb_class_driver - identifies a USB driver that wants to use the USB major number
1191 * @name: the usb class device name for this driver. Will show up in sysfs.
1192 * @devnode: Callback to provide a naming hint for a possible
1193 * device node to create.
1194 * @fops: pointer to the struct file_operations of this driver.
1195 * @minor_base: the start of the minor range for this driver.
1197 * This structure is used for the usb_register_dev() and
1198 * usb_unregister_dev() functions, to consolidate a number of the
1199 * parameters used for them.
1201 struct usb_class_driver {
1203 char *(*devnode)(struct device *dev, umode_t *mode);
1204 const struct file_operations *fops;
1209 * use these in module_init()/module_exit()
1210 * and don't forget MODULE_DEVICE_TABLE(usb, ...)
1212 extern int usb_register_driver(struct usb_driver *, struct module *,
1215 /* use a define to avoid include chaining to get THIS_MODULE & friends */
1216 #define usb_register(driver) \
1217 usb_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
1219 extern void usb_deregister(struct usb_driver *);
1222 * module_usb_driver() - Helper macro for registering a USB driver
1223 * @__usb_driver: usb_driver struct
1225 * Helper macro for USB drivers which do not do anything special in module
1226 * init/exit. This eliminates a lot of boilerplate. Each module may only
1227 * use this macro once, and calling it replaces module_init() and module_exit()
1229 #define module_usb_driver(__usb_driver) \
1230 module_driver(__usb_driver, usb_register, \
1233 extern int usb_register_device_driver(struct usb_device_driver *,
1235 extern void usb_deregister_device_driver(struct usb_device_driver *);
1237 extern int usb_register_dev(struct usb_interface *intf,
1238 struct usb_class_driver *class_driver);
1239 extern void usb_deregister_dev(struct usb_interface *intf,
1240 struct usb_class_driver *class_driver);
1242 extern int usb_disabled(void);
1244 /* ----------------------------------------------------------------------- */
1247 * URB support, for asynchronous request completions
1251 * urb->transfer_flags:
1253 * Note: URB_DIR_IN/OUT is automatically set in usb_submit_urb().
1255 #define URB_SHORT_NOT_OK 0x0001 /* report short reads as errors */
1256 #define URB_ISO_ASAP 0x0002 /* iso-only; use the first unexpired
1257 * slot in the schedule */
1258 #define URB_NO_TRANSFER_DMA_MAP 0x0004 /* urb->transfer_dma valid on submit */
1259 #define URB_NO_FSBR 0x0020 /* UHCI-specific */
1260 #define URB_ZERO_PACKET 0x0040 /* Finish bulk OUT with short packet */
1261 #define URB_NO_INTERRUPT 0x0080 /* HINT: no non-error interrupt
1263 #define URB_FREE_BUFFER 0x0100 /* Free transfer buffer with the URB */
1265 /* The following flags are used internally by usbcore and HCDs */
1266 #define URB_DIR_IN 0x0200 /* Transfer from device to host */
1267 #define URB_DIR_OUT 0
1268 #define URB_DIR_MASK URB_DIR_IN
1270 #define URB_DMA_MAP_SINGLE 0x00010000 /* Non-scatter-gather mapping */
1271 #define URB_DMA_MAP_PAGE 0x00020000 /* HCD-unsupported S-G */
1272 #define URB_DMA_MAP_SG 0x00040000 /* HCD-supported S-G */
1273 #define URB_MAP_LOCAL 0x00080000 /* HCD-local-memory mapping */
1274 #define URB_SETUP_MAP_SINGLE 0x00100000 /* Setup packet DMA mapped */
1275 #define URB_SETUP_MAP_LOCAL 0x00200000 /* HCD-local setup packet */
1276 #define URB_DMA_SG_COMBINED 0x00400000 /* S-G entries were combined */
1277 #define URB_ALIGNED_TEMP_BUFFER 0x00800000 /* Temp buffer was alloc'd */
1279 struct usb_iso_packet_descriptor {
1280 unsigned int offset;
1281 unsigned int length; /* expected length */
1282 unsigned int actual_length;
1289 struct list_head urb_list;
1290 wait_queue_head_t wait;
1292 atomic_t suspend_wakeups;
1293 unsigned int poisoned:1;
1296 static inline void init_usb_anchor(struct usb_anchor *anchor)
1298 memset(anchor, 0, sizeof(*anchor));
1299 INIT_LIST_HEAD(&anchor->urb_list);
1300 init_waitqueue_head(&anchor->wait);
1301 spin_lock_init(&anchor->lock);
1304 typedef void (*usb_complete_t)(struct urb *);
1307 * struct urb - USB Request Block
1308 * @urb_list: For use by current owner of the URB.
1309 * @anchor_list: membership in the list of an anchor
1310 * @anchor: to anchor URBs to a common mooring
1311 * @ep: Points to the endpoint's data structure. Will eventually
1313 * @pipe: Holds endpoint number, direction, type, and more.
1314 * Create these values with the eight macros available;
1315 * usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl"
1316 * (control), "bulk", "int" (interrupt), or "iso" (isochronous).
1317 * For example usb_sndbulkpipe() or usb_rcvintpipe(). Endpoint
1318 * numbers range from zero to fifteen. Note that "in" endpoint two
1319 * is a different endpoint (and pipe) from "out" endpoint two.
1320 * The current configuration controls the existence, type, and
1321 * maximum packet size of any given endpoint.
1322 * @stream_id: the endpoint's stream ID for bulk streams
1323 * @dev: Identifies the USB device to perform the request.
1324 * @status: This is read in non-iso completion functions to get the
1325 * status of the particular request. ISO requests only use it
1326 * to tell whether the URB was unlinked; detailed status for
1327 * each frame is in the fields of the iso_frame-desc.
1328 * @transfer_flags: A variety of flags may be used to affect how URB
1329 * submission, unlinking, or operation are handled. Different
1330 * kinds of URB can use different flags.
1331 * @transfer_buffer: This identifies the buffer to (or from) which the I/O
1332 * request will be performed unless URB_NO_TRANSFER_DMA_MAP is set
1333 * (however, do not leave garbage in transfer_buffer even then).
1334 * This buffer must be suitable for DMA; allocate it with
1335 * kmalloc() or equivalent. For transfers to "in" endpoints, contents
1336 * of this buffer will be modified. This buffer is used for the data
1337 * stage of control transfers.
1338 * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP,
1339 * the device driver is saying that it provided this DMA address,
1340 * which the host controller driver should use in preference to the
1342 * @sg: scatter gather buffer list, the buffer size of each element in
1343 * the list (except the last) must be divisible by the endpoint's
1344 * max packet size if no_sg_constraint isn't set in 'struct usb_bus'
1345 * @num_mapped_sgs: (internal) number of mapped sg entries
1346 * @num_sgs: number of entries in the sg list
1347 * @transfer_buffer_length: How big is transfer_buffer. The transfer may
1348 * be broken up into chunks according to the current maximum packet
1349 * size for the endpoint, which is a function of the configuration
1350 * and is encoded in the pipe. When the length is zero, neither
1351 * transfer_buffer nor transfer_dma is used.
1352 * @actual_length: This is read in non-iso completion functions, and
1353 * it tells how many bytes (out of transfer_buffer_length) were
1354 * transferred. It will normally be the same as requested, unless
1355 * either an error was reported or a short read was performed.
1356 * The URB_SHORT_NOT_OK transfer flag may be used to make such
1357 * short reads be reported as errors.
1358 * @setup_packet: Only used for control transfers, this points to eight bytes
1359 * of setup data. Control transfers always start by sending this data
1360 * to the device. Then transfer_buffer is read or written, if needed.
1361 * @setup_dma: DMA pointer for the setup packet. The caller must not use
1362 * this field; setup_packet must point to a valid buffer.
1363 * @start_frame: Returns the initial frame for isochronous transfers.
1364 * @number_of_packets: Lists the number of ISO transfer buffers.
1365 * @interval: Specifies the polling interval for interrupt or isochronous
1366 * transfers. The units are frames (milliseconds) for full and low
1367 * speed devices, and microframes (1/8 millisecond) for highspeed
1368 * and SuperSpeed devices.
1369 * @error_count: Returns the number of ISO transfers that reported errors.
1370 * @context: For use in completion functions. This normally points to
1371 * request-specific driver context.
1372 * @complete: Completion handler. This URB is passed as the parameter to the
1373 * completion function. The completion function may then do what
1374 * it likes with the URB, including resubmitting or freeing it.
1375 * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to
1376 * collect the transfer status for each buffer.
1378 * This structure identifies USB transfer requests. URBs must be allocated by
1379 * calling usb_alloc_urb() and freed with a call to usb_free_urb().
1380 * Initialization may be done using various usb_fill_*_urb() functions. URBs
1381 * are submitted using usb_submit_urb(), and pending requests may be canceled
1382 * using usb_unlink_urb() or usb_kill_urb().
1384 * Data Transfer Buffers:
1386 * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise
1387 * taken from the general page pool. That is provided by transfer_buffer
1388 * (control requests also use setup_packet), and host controller drivers
1389 * perform a dma mapping (and unmapping) for each buffer transferred. Those
1390 * mapping operations can be expensive on some platforms (perhaps using a dma
1391 * bounce buffer or talking to an IOMMU),
1392 * although they're cheap on commodity x86 and ppc hardware.
1394 * Alternatively, drivers may pass the URB_NO_TRANSFER_DMA_MAP transfer flag,
1395 * which tells the host controller driver that no such mapping is needed for
1396 * the transfer_buffer since
1397 * the device driver is DMA-aware. For example, a device driver might
1398 * allocate a DMA buffer with usb_alloc_coherent() or call usb_buffer_map().
1399 * When this transfer flag is provided, host controller drivers will
1400 * attempt to use the dma address found in the transfer_dma
1401 * field rather than determining a dma address themselves.
1403 * Note that transfer_buffer must still be set if the controller
1404 * does not support DMA (as indicated by bus.uses_dma) and when talking
1405 * to root hub. If you have to trasfer between highmem zone and the device
1406 * on such controller, create a bounce buffer or bail out with an error.
1407 * If transfer_buffer cannot be set (is in highmem) and the controller is DMA
1408 * capable, assign NULL to it, so that usbmon knows not to use the value.
1409 * The setup_packet must always be set, so it cannot be located in highmem.
1413 * All URBs submitted must initialize the dev, pipe, transfer_flags (may be
1414 * zero), and complete fields. All URBs must also initialize
1415 * transfer_buffer and transfer_buffer_length. They may provide the
1416 * URB_SHORT_NOT_OK transfer flag, indicating that short reads are
1417 * to be treated as errors; that flag is invalid for write requests.
1420 * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers
1421 * should always terminate with a short packet, even if it means adding an
1422 * extra zero length packet.
1424 * Control URBs must provide a valid pointer in the setup_packet field.
1425 * Unlike the transfer_buffer, the setup_packet may not be mapped for DMA
1428 * Interrupt URBs must provide an interval, saying how often (in milliseconds
1429 * or, for highspeed devices, 125 microsecond units)
1430 * to poll for transfers. After the URB has been submitted, the interval
1431 * field reflects how the transfer was actually scheduled.
1432 * The polling interval may be more frequent than requested.
1433 * For example, some controllers have a maximum interval of 32 milliseconds,
1434 * while others support intervals of up to 1024 milliseconds.
1435 * Isochronous URBs also have transfer intervals. (Note that for isochronous
1436 * endpoints, as well as high speed interrupt endpoints, the encoding of
1437 * the transfer interval in the endpoint descriptor is logarithmic.
1438 * Device drivers must convert that value to linear units themselves.)
1440 * If an isochronous endpoint queue isn't already running, the host
1441 * controller will schedule a new URB to start as soon as bandwidth
1442 * utilization allows. If the queue is running then a new URB will be
1443 * scheduled to start in the first transfer slot following the end of the
1444 * preceding URB, if that slot has not already expired. If the slot has
1445 * expired (which can happen when IRQ delivery is delayed for a long time),
1446 * the scheduling behavior depends on the URB_ISO_ASAP flag. If the flag
1447 * is clear then the URB will be scheduled to start in the expired slot,
1448 * implying that some of its packets will not be transferred; if the flag
1449 * is set then the URB will be scheduled in the first unexpired slot,
1450 * breaking the queue's synchronization. Upon URB completion, the
1451 * start_frame field will be set to the (micro)frame number in which the
1452 * transfer was scheduled. Ranges for frame counter values are HC-specific
1453 * and can go from as low as 256 to as high as 65536 frames.
1455 * Isochronous URBs have a different data transfer model, in part because
1456 * the quality of service is only "best effort". Callers provide specially
1457 * allocated URBs, with number_of_packets worth of iso_frame_desc structures
1458 * at the end. Each such packet is an individual ISO transfer. Isochronous
1459 * URBs are normally queued, submitted by drivers to arrange that
1460 * transfers are at least double buffered, and then explicitly resubmitted
1461 * in completion handlers, so
1462 * that data (such as audio or video) streams at as constant a rate as the
1463 * host controller scheduler can support.
1465 * Completion Callbacks:
1467 * The completion callback is made in_interrupt(), and one of the first
1468 * things that a completion handler should do is check the status field.
1469 * The status field is provided for all URBs. It is used to report
1470 * unlinked URBs, and status for all non-ISO transfers. It should not
1471 * be examined before the URB is returned to the completion handler.
1473 * The context field is normally used to link URBs back to the relevant
1474 * driver or request state.
1476 * When the completion callback is invoked for non-isochronous URBs, the
1477 * actual_length field tells how many bytes were transferred. This field
1478 * is updated even when the URB terminated with an error or was unlinked.
1480 * ISO transfer status is reported in the status and actual_length fields
1481 * of the iso_frame_desc array, and the number of errors is reported in
1482 * error_count. Completion callbacks for ISO transfers will normally
1483 * (re)submit URBs to ensure a constant transfer rate.
1485 * Note that even fields marked "public" should not be touched by the driver
1486 * when the urb is owned by the hcd, that is, since the call to
1487 * usb_submit_urb() till the entry into the completion routine.
1490 /* private: usb core and host controller only fields in the urb */
1491 struct kref kref; /* reference count of the URB */
1492 void *hcpriv; /* private data for host controller */
1493 atomic_t use_count; /* concurrent submissions counter */
1494 atomic_t reject; /* submissions will fail */
1495 int unlinked; /* unlink error code */
1497 /* public: documented fields in the urb that can be used by drivers */
1498 struct list_head urb_list; /* list head for use by the urb's
1500 struct list_head anchor_list; /* the URB may be anchored */
1501 struct usb_anchor *anchor;
1502 struct usb_device *dev; /* (in) pointer to associated device */
1503 struct usb_host_endpoint *ep; /* (internal) pointer to endpoint */
1504 unsigned int pipe; /* (in) pipe information */
1505 unsigned int stream_id; /* (in) stream ID */
1506 int status; /* (return) non-ISO status */
1507 unsigned int transfer_flags; /* (in) URB_SHORT_NOT_OK | ...*/
1508 void *transfer_buffer; /* (in) associated data buffer */
1509 dma_addr_t transfer_dma; /* (in) dma addr for transfer_buffer */
1510 struct scatterlist *sg; /* (in) scatter gather buffer list */
1511 int num_mapped_sgs; /* (internal) mapped sg entries */
1512 int num_sgs; /* (in) number of entries in the sg list */
1513 u32 transfer_buffer_length; /* (in) data buffer length */
1514 u32 actual_length; /* (return) actual transfer length */
1515 unsigned char *setup_packet; /* (in) setup packet (control only) */
1516 dma_addr_t setup_dma; /* (in) dma addr for setup_packet */
1517 int start_frame; /* (modify) start frame (ISO) */
1518 int number_of_packets; /* (in) number of ISO packets */
1519 int interval; /* (modify) transfer interval
1521 int error_count; /* (return) number of ISO errors */
1522 void *context; /* (in) context for completion */
1523 usb_complete_t complete; /* (in) completion routine */
1524 struct usb_iso_packet_descriptor iso_frame_desc[0];
1528 /* ----------------------------------------------------------------------- */
1531 * usb_fill_control_urb - initializes a control urb
1532 * @urb: pointer to the urb to initialize.
1533 * @dev: pointer to the struct usb_device for this urb.
1534 * @pipe: the endpoint pipe
1535 * @setup_packet: pointer to the setup_packet buffer
1536 * @transfer_buffer: pointer to the transfer buffer
1537 * @buffer_length: length of the transfer buffer
1538 * @complete_fn: pointer to the usb_complete_t function
1539 * @context: what to set the urb context to.
1541 * Initializes a control urb with the proper information needed to submit
1544 static inline void usb_fill_control_urb(struct urb *urb,
1545 struct usb_device *dev,
1547 unsigned char *setup_packet,
1548 void *transfer_buffer,
1550 usb_complete_t complete_fn,
1555 urb->setup_packet = setup_packet;
1556 urb->transfer_buffer = transfer_buffer;
1557 urb->transfer_buffer_length = buffer_length;
1558 urb->complete = complete_fn;
1559 urb->context = context;
1563 * usb_fill_bulk_urb - macro to help initialize a bulk urb
1564 * @urb: pointer to the urb to initialize.
1565 * @dev: pointer to the struct usb_device for this urb.
1566 * @pipe: the endpoint pipe
1567 * @transfer_buffer: pointer to the transfer buffer
1568 * @buffer_length: length of the transfer buffer
1569 * @complete_fn: pointer to the usb_complete_t function
1570 * @context: what to set the urb context to.
1572 * Initializes a bulk urb with the proper information needed to submit it
1575 static inline void usb_fill_bulk_urb(struct urb *urb,
1576 struct usb_device *dev,
1578 void *transfer_buffer,
1580 usb_complete_t complete_fn,
1585 urb->transfer_buffer = transfer_buffer;
1586 urb->transfer_buffer_length = buffer_length;
1587 urb->complete = complete_fn;
1588 urb->context = context;
1592 * usb_fill_int_urb - macro to help initialize a interrupt urb
1593 * @urb: pointer to the urb to initialize.
1594 * @dev: pointer to the struct usb_device for this urb.
1595 * @pipe: the endpoint pipe
1596 * @transfer_buffer: pointer to the transfer buffer
1597 * @buffer_length: length of the transfer buffer
1598 * @complete_fn: pointer to the usb_complete_t function
1599 * @context: what to set the urb context to.
1600 * @interval: what to set the urb interval to, encoded like
1601 * the endpoint descriptor's bInterval value.
1603 * Initializes a interrupt urb with the proper information needed to submit
1606 * Note that High Speed and SuperSpeed(+) interrupt endpoints use a logarithmic
1607 * encoding of the endpoint interval, and express polling intervals in
1608 * microframes (eight per millisecond) rather than in frames (one per
1611 * Wireless USB also uses the logarithmic encoding, but specifies it in units of
1612 * 128us instead of 125us. For Wireless USB devices, the interval is passed
1613 * through to the host controller, rather than being translated into microframe
1616 static inline void usb_fill_int_urb(struct urb *urb,
1617 struct usb_device *dev,
1619 void *transfer_buffer,
1621 usb_complete_t complete_fn,
1627 urb->transfer_buffer = transfer_buffer;
1628 urb->transfer_buffer_length = buffer_length;
1629 urb->complete = complete_fn;
1630 urb->context = context;
1632 if (dev->speed == USB_SPEED_HIGH || dev->speed >= USB_SPEED_SUPER) {
1633 /* make sure interval is within allowed range */
1634 interval = clamp(interval, 1, 16);
1636 urb->interval = 1 << (interval - 1);
1638 urb->interval = interval;
1641 urb->start_frame = -1;
1644 extern void usb_init_urb(struct urb *urb);
1645 extern struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags);
1646 extern void usb_free_urb(struct urb *urb);
1647 #define usb_put_urb usb_free_urb
1648 extern struct urb *usb_get_urb(struct urb *urb);
1649 extern int usb_submit_urb(struct urb *urb, gfp_t mem_flags);
1650 extern int usb_unlink_urb(struct urb *urb);
1651 extern void usb_kill_urb(struct urb *urb);
1652 extern void usb_poison_urb(struct urb *urb);
1653 extern void usb_unpoison_urb(struct urb *urb);
1654 extern void usb_block_urb(struct urb *urb);
1655 extern void usb_kill_anchored_urbs(struct usb_anchor *anchor);
1656 extern void usb_poison_anchored_urbs(struct usb_anchor *anchor);
1657 extern void usb_unpoison_anchored_urbs(struct usb_anchor *anchor);
1658 extern void usb_unlink_anchored_urbs(struct usb_anchor *anchor);
1659 extern void usb_anchor_suspend_wakeups(struct usb_anchor *anchor);
1660 extern void usb_anchor_resume_wakeups(struct usb_anchor *anchor);
1661 extern void usb_anchor_urb(struct urb *urb, struct usb_anchor *anchor);
1662 extern void usb_unanchor_urb(struct urb *urb);
1663 extern int usb_wait_anchor_empty_timeout(struct usb_anchor *anchor,
1664 unsigned int timeout);
1665 extern struct urb *usb_get_from_anchor(struct usb_anchor *anchor);
1666 extern void usb_scuttle_anchored_urbs(struct usb_anchor *anchor);
1667 extern int usb_anchor_empty(struct usb_anchor *anchor);
1669 #define usb_unblock_urb usb_unpoison_urb
1672 * usb_urb_dir_in - check if an URB describes an IN transfer
1673 * @urb: URB to be checked
1675 * Return: 1 if @urb describes an IN transfer (device-to-host),
1678 static inline int usb_urb_dir_in(struct urb *urb)
1680 return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_IN;
1684 * usb_urb_dir_out - check if an URB describes an OUT transfer
1685 * @urb: URB to be checked
1687 * Return: 1 if @urb describes an OUT transfer (host-to-device),
1690 static inline int usb_urb_dir_out(struct urb *urb)
1692 return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_OUT;
1695 int usb_urb_ep_type_check(const struct urb *urb);
1697 void *usb_alloc_coherent(struct usb_device *dev, size_t size,
1698 gfp_t mem_flags, dma_addr_t *dma);
1699 void usb_free_coherent(struct usb_device *dev, size_t size,
1700 void *addr, dma_addr_t dma);
1703 struct urb *usb_buffer_map(struct urb *urb);
1704 void usb_buffer_dmasync(struct urb *urb);
1705 void usb_buffer_unmap(struct urb *urb);
1709 int usb_buffer_map_sg(const struct usb_device *dev, int is_in,
1710 struct scatterlist *sg, int nents);
1712 void usb_buffer_dmasync_sg(const struct usb_device *dev, int is_in,
1713 struct scatterlist *sg, int n_hw_ents);
1715 void usb_buffer_unmap_sg(const struct usb_device *dev, int is_in,
1716 struct scatterlist *sg, int n_hw_ents);
1718 /*-------------------------------------------------------------------*
1719 * SYNCHRONOUS CALL SUPPORT *
1720 *-------------------------------------------------------------------*/
1722 extern int usb_control_msg(struct usb_device *dev, unsigned int pipe,
1723 __u8 request, __u8 requesttype, __u16 value, __u16 index,
1724 void *data, __u16 size, int timeout);
1725 extern int usb_interrupt_msg(struct usb_device *usb_dev, unsigned int pipe,
1726 void *data, int len, int *actual_length, int timeout);
1727 extern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,
1728 void *data, int len, int *actual_length,
1731 /* wrappers around usb_control_msg() for the most common standard requests */
1732 extern int usb_get_descriptor(struct usb_device *dev, unsigned char desctype,
1733 unsigned char descindex, void *buf, int size);
1734 extern int usb_get_status(struct usb_device *dev,
1735 int type, int target, void *data);
1736 extern int usb_string(struct usb_device *dev, int index,
1737 char *buf, size_t size);
1739 /* wrappers that also update important state inside usbcore */
1740 extern int usb_clear_halt(struct usb_device *dev, int pipe);
1741 extern int usb_reset_configuration(struct usb_device *dev);
1742 extern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate);
1743 extern void usb_reset_endpoint(struct usb_device *dev, unsigned int epaddr);
1745 /* this request isn't really synchronous, but it belongs with the others */
1746 extern int usb_driver_set_configuration(struct usb_device *udev, int config);
1748 /* choose and set configuration for device */
1749 extern int usb_choose_configuration(struct usb_device *udev);
1750 extern int usb_set_configuration(struct usb_device *dev, int configuration);
1753 * timeouts, in milliseconds, used for sending/receiving control messages
1754 * they typically complete within a few frames (msec) after they're issued
1755 * USB identifies 5 second timeouts, maybe more in a few cases, and a few
1756 * slow devices (like some MGE Ellipse UPSes) actually push that limit.
1758 #define USB_CTRL_GET_TIMEOUT 5000
1759 #define USB_CTRL_SET_TIMEOUT 5000
1763 * struct usb_sg_request - support for scatter/gather I/O
1764 * @status: zero indicates success, else negative errno
1765 * @bytes: counts bytes transferred.
1767 * These requests are initialized using usb_sg_init(), and then are used
1768 * as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most
1769 * members of the request object aren't for driver access.
1771 * The status and bytecount values are valid only after usb_sg_wait()
1772 * returns. If the status is zero, then the bytecount matches the total
1775 * After an error completion, drivers may need to clear a halt condition
1778 struct usb_sg_request {
1783 * members below are private to usbcore,
1784 * and are not provided for driver access!
1788 struct usb_device *dev;
1795 struct completion complete;
1799 struct usb_sg_request *io,
1800 struct usb_device *dev,
1803 struct scatterlist *sg,
1808 void usb_sg_cancel(struct usb_sg_request *io);
1809 void usb_sg_wait(struct usb_sg_request *io);
1812 /* ----------------------------------------------------------------------- */
1815 * For various legacy reasons, Linux has a small cookie that's paired with
1816 * a struct usb_device to identify an endpoint queue. Queue characteristics
1817 * are defined by the endpoint's descriptor. This cookie is called a "pipe",
1818 * an unsigned int encoded as:
1820 * - direction: bit 7 (0 = Host-to-Device [Out],
1821 * 1 = Device-to-Host [In] ...
1822 * like endpoint bEndpointAddress)
1823 * - device address: bits 8-14 ... bit positions known to uhci-hcd
1824 * - endpoint: bits 15-18 ... bit positions known to uhci-hcd
1825 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
1826 * 10 = control, 11 = bulk)
1828 * Given the device address and endpoint descriptor, pipes are redundant.
1831 /* NOTE: these are not the standard USB_ENDPOINT_XFER_* values!! */
1832 /* (yet ... they're the values used by usbfs) */
1833 #define PIPE_ISOCHRONOUS 0
1834 #define PIPE_INTERRUPT 1
1835 #define PIPE_CONTROL 2
1838 #define usb_pipein(pipe) ((pipe) & USB_DIR_IN)
1839 #define usb_pipeout(pipe) (!usb_pipein(pipe))
1841 #define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
1842 #define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
1844 #define usb_pipetype(pipe) (((pipe) >> 30) & 3)
1845 #define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
1846 #define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
1847 #define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
1848 #define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
1850 static inline unsigned int __create_pipe(struct usb_device *dev,
1851 unsigned int endpoint)
1853 return (dev->devnum << 8) | (endpoint << 15);
1856 /* Create various pipes... */
1857 #define usb_sndctrlpipe(dev, endpoint) \
1858 ((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint))
1859 #define usb_rcvctrlpipe(dev, endpoint) \
1860 ((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
1861 #define usb_sndisocpipe(dev, endpoint) \
1862 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint))
1863 #define usb_rcvisocpipe(dev, endpoint) \
1864 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
1865 #define usb_sndbulkpipe(dev, endpoint) \
1866 ((PIPE_BULK << 30) | __create_pipe(dev, endpoint))
1867 #define usb_rcvbulkpipe(dev, endpoint) \
1868 ((PIPE_BULK << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
1869 #define usb_sndintpipe(dev, endpoint) \
1870 ((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint))
1871 #define usb_rcvintpipe(dev, endpoint) \
1872 ((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
1874 static inline struct usb_host_endpoint *
1875 usb_pipe_endpoint(struct usb_device *dev, unsigned int pipe)
1877 struct usb_host_endpoint **eps;
1878 eps = usb_pipein(pipe) ? dev->ep_in : dev->ep_out;
1879 return eps[usb_pipeendpoint(pipe)];
1882 /*-------------------------------------------------------------------------*/
1885 usb_maxpacket(struct usb_device *udev, int pipe, int is_out)
1887 struct usb_host_endpoint *ep;
1888 unsigned epnum = usb_pipeendpoint(pipe);
1891 WARN_ON(usb_pipein(pipe));
1892 ep = udev->ep_out[epnum];
1894 WARN_ON(usb_pipeout(pipe));
1895 ep = udev->ep_in[epnum];
1900 /* NOTE: only 0x07ff bits are for packet size... */
1901 return usb_endpoint_maxp(&ep->desc);
1904 /* ----------------------------------------------------------------------- */
1906 /* translate USB error codes to codes user space understands */
1907 static inline int usb_translate_errors(int error_code)
1909 switch (error_code) {
1920 /* Events from the usb core */
1921 #define USB_DEVICE_ADD 0x0001
1922 #define USB_DEVICE_REMOVE 0x0002
1923 #define USB_BUS_ADD 0x0003
1924 #define USB_BUS_REMOVE 0x0004
1925 extern void usb_register_notify(struct notifier_block *nb);
1926 extern void usb_unregister_notify(struct notifier_block *nb);
1929 extern struct dentry *usb_debug_root;
1932 enum usb_led_event {
1933 USB_LED_EVENT_HOST = 0,
1934 USB_LED_EVENT_GADGET = 1,
1937 #ifdef CONFIG_USB_LED_TRIG
1938 extern void usb_led_activity(enum usb_led_event ev);
1940 static inline void usb_led_activity(enum usb_led_event ev) {}
1943 #endif /* __KERNEL__ */