4 #include <linux/mod_devicetable.h>
5 #include <linux/usb/ch9.h>
8 #define USB_DEVICE_MAJOR 189
13 #include <linux/errno.h> /* for -ENODEV */
14 #include <linux/delay.h> /* for mdelay() */
15 #include <linux/interrupt.h> /* for in_interrupt() */
16 #include <linux/list.h> /* for struct list_head */
17 #include <linux/kref.h> /* for struct kref */
18 #include <linux/device.h> /* for struct device */
19 #include <linux/fs.h> /* for struct file_operations */
20 #include <linux/completion.h> /* for struct completion */
21 #include <linux/sched.h> /* for current && schedule_timeout */
22 #include <linux/mutex.h> /* for struct mutex */
23 #include <linux/pm_runtime.h> /* for runtime PM */
29 /*-------------------------------------------------------------------------*/
32 * Host-side wrappers for standard USB descriptors ... these are parsed
33 * from the data provided by devices. Parsing turns them from a flat
34 * sequence of descriptors into a hierarchy:
36 * - devices have one (usually) or more configs;
37 * - configs have one (often) or more interfaces;
38 * - interfaces have one (usually) or more settings;
39 * - each interface setting has zero or (usually) more endpoints.
40 * - a SuperSpeed endpoint has a companion descriptor
42 * And there might be other descriptors mixed in with those.
44 * Devices may also have class-specific or vendor-specific descriptors.
50 * struct usb_host_endpoint - host-side endpoint descriptor and queue
51 * @desc: descriptor for this endpoint, wMaxPacketSize in native byteorder
52 * @ss_ep_comp: SuperSpeed companion descriptor for this endpoint
53 * @urb_list: urbs queued to this endpoint; maintained by usbcore
54 * @hcpriv: for use by HCD; typically holds hardware dma queue head (QH)
55 * with one or more transfer descriptors (TDs) per urb
56 * @ep_dev: ep_device for sysfs info
57 * @extra: descriptors following this endpoint in the configuration
58 * @extralen: how many bytes of "extra" are valid
59 * @enabled: URBs may be submitted to this endpoint
61 * USB requests are always queued to a given endpoint, identified by a
62 * descriptor within an active interface in a given USB configuration.
64 struct usb_host_endpoint {
65 struct usb_endpoint_descriptor desc;
66 struct usb_ss_ep_comp_descriptor ss_ep_comp;
67 struct list_head urb_list;
69 struct ep_device *ep_dev; /* For sysfs info */
71 unsigned char *extra; /* Extra descriptors */
76 /* host-side wrapper for one interface setting's parsed descriptors */
77 struct usb_host_interface {
78 struct usb_interface_descriptor desc;
81 unsigned char *extra; /* Extra descriptors */
83 /* array of desc.bNumEndpoint endpoints associated with this
84 * interface setting. these will be in no particular order.
86 struct usb_host_endpoint *endpoint;
88 char *string; /* iInterface string, if present */
91 enum usb_interface_condition {
92 USB_INTERFACE_UNBOUND = 0,
93 USB_INTERFACE_BINDING,
95 USB_INTERFACE_UNBINDING,
99 * struct usb_interface - what usb device drivers talk to
100 * @altsetting: array of interface structures, one for each alternate
101 * setting that may be selected. Each one includes a set of
102 * endpoint configurations. They will be in no particular order.
103 * @cur_altsetting: the current altsetting.
104 * @num_altsetting: number of altsettings defined.
105 * @intf_assoc: interface association descriptor
106 * @minor: the minor number assigned to this interface, if this
107 * interface is bound to a driver that uses the USB major number.
108 * If this interface does not use the USB major, this field should
109 * be unused. The driver should set this value in the probe()
110 * function of the driver, after it has been assigned a minor
111 * number from the USB core by calling usb_register_dev().
112 * @condition: binding state of the interface: not bound, binding
113 * (in probe()), bound to a driver, or unbinding (in disconnect())
114 * @sysfs_files_created: sysfs attributes exist
115 * @ep_devs_created: endpoint child pseudo-devices exist
116 * @unregistering: flag set when the interface is being unregistered
117 * @needs_remote_wakeup: flag set when the driver requires remote-wakeup
118 * capability during autosuspend.
119 * @needs_altsetting0: flag set when a set-interface request for altsetting 0
121 * @needs_binding: flag set when the driver should be re-probed or unbound
122 * following a reset or suspend operation it doesn't support.
123 * @dev: driver model's view of this device
124 * @usb_dev: if an interface is bound to the USB major, this will point
125 * to the sysfs representation for that device.
126 * @pm_usage_cnt: PM usage counter for this interface
127 * @reset_ws: Used for scheduling resets from atomic context.
128 * @reset_running: set to 1 if the interface is currently running a
129 * queued reset so that usb_cancel_queued_reset() doesn't try to
130 * remove from the workqueue when running inside the worker
131 * thread. See __usb_queue_reset_device().
132 * @resetting_device: USB core reset the device, so use alt setting 0 as
133 * current; needs bandwidth alloc after reset.
135 * USB device drivers attach to interfaces on a physical device. Each
136 * interface encapsulates a single high level function, such as feeding
137 * an audio stream to a speaker or reporting a change in a volume control.
138 * Many USB devices only have one interface. The protocol used to talk to
139 * an interface's endpoints can be defined in a usb "class" specification,
140 * or by a product's vendor. The (default) control endpoint is part of
141 * every interface, but is never listed among the interface's descriptors.
143 * The driver that is bound to the interface can use standard driver model
144 * calls such as dev_get_drvdata() on the dev member of this structure.
146 * Each interface may have alternate settings. The initial configuration
147 * of a device sets altsetting 0, but the device driver can change
148 * that setting using usb_set_interface(). Alternate settings are often
149 * used to control the use of periodic endpoints, such as by having
150 * different endpoints use different amounts of reserved USB bandwidth.
151 * All standards-conformant USB devices that use isochronous endpoints
152 * will use them in non-default settings.
154 * The USB specification says that alternate setting numbers must run from
155 * 0 to one less than the total number of alternate settings. But some
156 * devices manage to mess this up, and the structures aren't necessarily
157 * stored in numerical order anyhow. Use usb_altnum_to_altsetting() to
158 * look up an alternate setting in the altsetting array based on its number.
160 struct usb_interface {
161 /* array of alternate settings for this interface,
162 * stored in no particular order */
163 struct usb_host_interface *altsetting;
165 struct usb_host_interface *cur_altsetting; /* the currently
166 * active alternate setting */
167 unsigned num_altsetting; /* number of alternate settings */
169 /* If there is an interface association descriptor then it will list
170 * the associated interfaces */
171 struct usb_interface_assoc_descriptor *intf_assoc;
173 int minor; /* minor number this interface is
175 enum usb_interface_condition condition; /* state of binding */
176 unsigned sysfs_files_created:1; /* the sysfs attributes exist */
177 unsigned ep_devs_created:1; /* endpoint "devices" exist */
178 unsigned unregistering:1; /* unregistration is in progress */
179 unsigned needs_remote_wakeup:1; /* driver requires remote wakeup */
180 unsigned needs_altsetting0:1; /* switch to altsetting 0 is pending */
181 unsigned needs_binding:1; /* needs delayed unbind/rebind */
182 unsigned reset_running:1;
183 unsigned resetting_device:1; /* true: bandwidth alloc after reset */
185 struct device dev; /* interface specific device info */
186 struct device *usb_dev;
187 atomic_t pm_usage_cnt; /* usage counter for autosuspend */
188 struct work_struct reset_ws; /* for resets in atomic context */
190 #define to_usb_interface(d) container_of(d, struct usb_interface, dev)
192 static inline void *usb_get_intfdata(struct usb_interface *intf)
194 return dev_get_drvdata(&intf->dev);
197 static inline void usb_set_intfdata(struct usb_interface *intf, void *data)
199 dev_set_drvdata(&intf->dev, data);
202 struct usb_interface *usb_get_intf(struct usb_interface *intf);
203 void usb_put_intf(struct usb_interface *intf);
205 /* this maximum is arbitrary */
206 #define USB_MAXINTERFACES 32
207 #define USB_MAXIADS (USB_MAXINTERFACES/2)
210 * struct usb_interface_cache - long-term representation of a device interface
211 * @num_altsetting: number of altsettings defined.
212 * @ref: reference counter.
213 * @altsetting: variable-length array of interface structures, one for
214 * each alternate setting that may be selected. Each one includes a
215 * set of endpoint configurations. They will be in no particular order.
217 * These structures persist for the lifetime of a usb_device, unlike
218 * struct usb_interface (which persists only as long as its configuration
219 * is installed). The altsetting arrays can be accessed through these
220 * structures at any time, permitting comparison of configurations and
221 * providing support for the /proc/bus/usb/devices pseudo-file.
223 struct usb_interface_cache {
224 unsigned num_altsetting; /* number of alternate settings */
225 struct kref ref; /* reference counter */
227 /* variable-length array of alternate settings for this interface,
228 * stored in no particular order */
229 struct usb_host_interface altsetting[0];
231 #define ref_to_usb_interface_cache(r) \
232 container_of(r, struct usb_interface_cache, ref)
233 #define altsetting_to_usb_interface_cache(a) \
234 container_of(a, struct usb_interface_cache, altsetting[0])
237 * struct usb_host_config - representation of a device's configuration
238 * @desc: the device's configuration descriptor.
239 * @string: pointer to the cached version of the iConfiguration string, if
240 * present for this configuration.
241 * @intf_assoc: list of any interface association descriptors in this config
242 * @interface: array of pointers to usb_interface structures, one for each
243 * interface in the configuration. The number of interfaces is stored
244 * in desc.bNumInterfaces. These pointers are valid only while the
245 * the configuration is active.
246 * @intf_cache: array of pointers to usb_interface_cache structures, one
247 * for each interface in the configuration. These structures exist
248 * for the entire life of the device.
249 * @extra: pointer to buffer containing all extra descriptors associated
250 * with this configuration (those preceding the first interface
252 * @extralen: length of the extra descriptors buffer.
254 * USB devices may have multiple configurations, but only one can be active
255 * at any time. Each encapsulates a different operational environment;
256 * for example, a dual-speed device would have separate configurations for
257 * full-speed and high-speed operation. The number of configurations
258 * available is stored in the device descriptor as bNumConfigurations.
260 * A configuration can contain multiple interfaces. Each corresponds to
261 * a different function of the USB device, and all are available whenever
262 * the configuration is active. The USB standard says that interfaces
263 * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot
264 * of devices get this wrong. In addition, the interface array is not
265 * guaranteed to be sorted in numerical order. Use usb_ifnum_to_if() to
266 * look up an interface entry based on its number.
268 * Device drivers should not attempt to activate configurations. The choice
269 * of which configuration to install is a policy decision based on such
270 * considerations as available power, functionality provided, and the user's
271 * desires (expressed through userspace tools). However, drivers can call
272 * usb_reset_configuration() to reinitialize the current configuration and
273 * all its interfaces.
275 struct usb_host_config {
276 struct usb_config_descriptor desc;
278 char *string; /* iConfiguration string, if present */
280 /* List of any Interface Association Descriptors in this
282 struct usb_interface_assoc_descriptor *intf_assoc[USB_MAXIADS];
284 /* the interfaces associated with this configuration,
285 * stored in no particular order */
286 struct usb_interface *interface[USB_MAXINTERFACES];
288 /* Interface information available even when this is not the
289 * active configuration */
290 struct usb_interface_cache *intf_cache[USB_MAXINTERFACES];
292 unsigned char *extra; /* Extra descriptors */
296 /* USB2.0 and USB3.0 device BOS descriptor set */
297 struct usb_host_bos {
298 struct usb_bos_descriptor *desc;
300 /* wireless cap descriptor is handled by wusb */
301 struct usb_ext_cap_descriptor *ext_cap;
302 struct usb_ss_cap_descriptor *ss_cap;
303 struct usb_ss_container_id_descriptor *ss_id;
306 int __usb_get_extra_descriptor(char *buffer, unsigned size,
307 unsigned char type, void **ptr);
308 #define usb_get_extra_descriptor(ifpoint, type, ptr) \
309 __usb_get_extra_descriptor((ifpoint)->extra, \
310 (ifpoint)->extralen, \
313 /* ----------------------------------------------------------------------- */
315 /* USB device number allocation bitmap */
317 unsigned long devicemap[128 / (8*sizeof(unsigned long))];
321 * Allocated per bus (tree of devices) we have:
324 struct device *controller; /* host/master side hardware */
325 int busnum; /* Bus number (in order of reg) */
326 const char *bus_name; /* stable id (PCI slot_name etc) */
327 u8 uses_dma; /* Does the host controller use DMA? */
328 u8 uses_pio_for_control; /*
329 * Does the host controller use PIO
330 * for control transfers?
332 u8 otg_port; /* 0, or number of OTG/HNP port */
333 unsigned is_b_host:1; /* true during some HNP roleswitches */
334 unsigned b_hnp_enable:1; /* OTG: did A-Host enable HNP? */
335 unsigned no_stop_on_short:1; /*
336 * Quirk: some controllers don't stop
337 * the ep queue on a short transfer
338 * with the URB_SHORT_NOT_OK flag set.
340 unsigned no_sg_constraint:1; /* no sg constraint */
341 unsigned sg_tablesize; /* 0 or largest number of sg list entries */
343 int devnum_next; /* Next open device number in
344 * round-robin allocation */
346 struct usb_devmap devmap; /* device address allocation map */
347 struct usb_device *root_hub; /* Root hub */
348 struct usb_bus *hs_companion; /* Companion EHCI bus, if any */
349 struct list_head bus_list; /* list of busses */
351 int bandwidth_allocated; /* on this bus: how much of the time
352 * reserved for periodic (intr/iso)
353 * requests is used, on average?
354 * Units: microseconds/frame.
355 * Limits: Full/low speed reserve 90%,
356 * while high speed reserves 80%.
358 int bandwidth_int_reqs; /* number of Interrupt requests */
359 int bandwidth_isoc_reqs; /* number of Isoc. requests */
361 unsigned resuming_ports; /* bit array: resuming root-hub ports */
363 #if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
364 struct mon_bus *mon_bus; /* non-null when associated */
365 int monitored; /* non-zero when monitored */
369 struct usb_dev_state;
371 /* ----------------------------------------------------------------------- */
375 enum usb_device_removable {
376 USB_DEVICE_REMOVABLE_UNKNOWN = 0,
377 USB_DEVICE_REMOVABLE,
381 enum usb_port_connect_type {
382 USB_PORT_CONNECT_TYPE_UNKNOWN = 0,
383 USB_PORT_CONNECT_TYPE_HOT_PLUG,
384 USB_PORT_CONNECT_TYPE_HARD_WIRED,
389 * USB 2.0 Link Power Management (LPM) parameters.
391 struct usb2_lpm_parameters {
392 /* Best effort service latency indicate how long the host will drive
393 * resume on an exit from L1.
397 /* Timeout value in microseconds for the L1 inactivity (LPM) timer.
398 * When the timer counts to zero, the parent hub will initiate a LPM
405 * USB 3.0 Link Power Management (LPM) parameters.
407 * PEL and SEL are USB 3.0 Link PM latencies for device-initiated LPM exit.
408 * MEL is the USB 3.0 Link PM latency for host-initiated LPM exit.
409 * All three are stored in nanoseconds.
411 struct usb3_lpm_parameters {
413 * Maximum exit latency (MEL) for the host to send a packet to the
414 * device (either a Ping for isoc endpoints, or a data packet for
415 * interrupt endpoints), the hubs to decode the packet, and for all hubs
416 * in the path to transition the links to U0.
420 * Maximum exit latency for a device-initiated LPM transition to bring
421 * all links into U0. Abbreviated as "PEL" in section 9.4.12 of the USB
422 * 3.0 spec, with no explanation of what "P" stands for. "Path"?
427 * The System Exit Latency (SEL) includes PEL, and three other
428 * latencies. After a device initiates a U0 transition, it will take
429 * some time from when the device sends the ERDY to when it will finally
430 * receive the data packet. Basically, SEL should be the worse-case
431 * latency from when a device starts initiating a U0 transition to when
436 * The idle timeout value that is currently programmed into the parent
437 * hub for this device. When the timer counts to zero, the parent hub
438 * will initiate an LPM transition to either U1 or U2.
444 * struct usb_device - kernel's representation of a USB device
445 * @devnum: device number; address on a USB bus
446 * @devpath: device ID string for use in messages (e.g., /port/...)
447 * @route: tree topology hex string for use with xHCI
448 * @state: device state: configured, not attached, etc.
449 * @speed: device speed: high/full/low (or error)
450 * @tt: Transaction Translator info; used with low/full speed dev, highspeed hub
451 * @ttport: device port on that tt hub
452 * @toggle: one bit for each endpoint, with ([0] = IN, [1] = OUT) endpoints
453 * @parent: our hub, unless we're the root
454 * @bus: bus we're part of
455 * @ep0: endpoint 0 data (default control pipe)
456 * @dev: generic device interface
457 * @descriptor: USB device descriptor
458 * @bos: USB device BOS descriptor set
459 * @config: all of the device's configs
460 * @actconfig: the active configuration
461 * @ep_in: array of IN endpoints
462 * @ep_out: array of OUT endpoints
463 * @rawdescriptors: raw descriptors for each config
464 * @bus_mA: Current available from the bus
465 * @portnum: parent port number (origin 1)
466 * @level: number of USB hub ancestors
467 * @can_submit: URBs may be submitted
468 * @persist_enabled: USB_PERSIST enabled for this device
469 * @have_langid: whether string_langid is valid
470 * @authorized: policy has said we can use it;
471 * (user space) policy determines if we authorize this device to be
472 * used or not. By default, wired USB devices are authorized.
473 * WUSB devices are not, until we authorize them from user space.
474 * FIXME -- complete doc
475 * @authenticated: Crypto authentication passed
476 * @wusb: device is Wireless USB
477 * @lpm_capable: device supports LPM
478 * @usb2_hw_lpm_capable: device can perform USB2 hardware LPM
479 * @usb2_hw_lpm_besl_capable: device can perform USB2 hardware BESL LPM
480 * @usb2_hw_lpm_enabled: USB2 hardware LPM is enabled
481 * @usb2_hw_lpm_allowed: Userspace allows USB 2.0 LPM to be enabled
482 * @usb3_lpm_enabled: USB3 hardware LPM enabled
483 * @string_langid: language ID for strings
484 * @product: iProduct string, if present (static)
485 * @manufacturer: iManufacturer string, if present (static)
486 * @serial: iSerialNumber string, if present (static)
487 * @filelist: usbfs files that are open to this device
488 * @maxchild: number of ports if hub
489 * @quirks: quirks of the whole device
490 * @urbnum: number of URBs submitted for the whole device
491 * @active_duration: total time device is not suspended
492 * @connect_time: time device was first connected
493 * @do_remote_wakeup: remote wakeup should be enabled
494 * @reset_resume: needs reset instead of resume
495 * @port_is_suspended: the upstream port is suspended (L2 or U3)
496 * @wusb_dev: if this is a Wireless USB device, link to the WUSB
497 * specific data for the device.
498 * @slot_id: Slot ID assigned by xHCI
499 * @removable: Device can be physically removed from this port
500 * @l1_params: best effor service latency for USB2 L1 LPM state, and L1 timeout.
501 * @u1_params: exit latencies for USB3 U1 LPM state, and hub-initiated timeout.
502 * @u2_params: exit latencies for USB3 U2 LPM state, and hub-initiated timeout.
503 * @lpm_disable_count: Ref count used by usb_disable_lpm() and usb_enable_lpm()
504 * to keep track of the number of functions that require USB 3.0 Link Power
505 * Management to be disabled for this usb_device. This count should only
506 * be manipulated by those functions, with the bandwidth_mutex is held.
509 * Usbcore drivers should not set usbdev->state directly. Instead use
510 * usb_set_device_state().
516 enum usb_device_state state;
517 enum usb_device_speed speed;
522 unsigned int toggle[2];
524 struct usb_device *parent;
526 struct usb_host_endpoint ep0;
530 struct usb_device_descriptor descriptor;
531 struct usb_host_bos *bos;
532 struct usb_host_config *config;
534 struct usb_host_config *actconfig;
535 struct usb_host_endpoint *ep_in[16];
536 struct usb_host_endpoint *ep_out[16];
538 char **rawdescriptors;
540 unsigned short bus_mA;
544 unsigned can_submit:1;
545 unsigned persist_enabled:1;
546 unsigned have_langid:1;
547 unsigned authorized:1;
548 unsigned authenticated:1;
550 unsigned lpm_capable:1;
551 unsigned usb2_hw_lpm_capable:1;
552 unsigned usb2_hw_lpm_besl_capable:1;
553 unsigned usb2_hw_lpm_enabled:1;
554 unsigned usb2_hw_lpm_allowed:1;
555 unsigned usb3_lpm_enabled:1;
558 /* static strings from the device */
563 struct list_head filelist;
570 unsigned long active_duration;
573 unsigned long connect_time;
575 unsigned do_remote_wakeup:1;
576 unsigned reset_resume:1;
577 unsigned port_is_suspended:1;
579 struct wusb_dev *wusb_dev;
581 enum usb_device_removable removable;
582 struct usb2_lpm_parameters l1_params;
583 struct usb3_lpm_parameters u1_params;
584 struct usb3_lpm_parameters u2_params;
585 unsigned lpm_disable_count;
587 #define to_usb_device(d) container_of(d, struct usb_device, dev)
589 static inline struct usb_device *interface_to_usbdev(struct usb_interface *intf)
591 return to_usb_device(intf->dev.parent);
594 extern struct usb_device *usb_get_dev(struct usb_device *dev);
595 extern void usb_put_dev(struct usb_device *dev);
596 extern struct usb_device *usb_hub_find_child(struct usb_device *hdev,
600 * usb_hub_for_each_child - iterate over all child devices on the hub
601 * @hdev: USB device belonging to the usb hub
602 * @port1: portnum associated with child device
603 * @child: child device pointer
605 #define usb_hub_for_each_child(hdev, port1, child) \
606 for (port1 = 1, child = usb_hub_find_child(hdev, port1); \
607 port1 <= hdev->maxchild; \
608 child = usb_hub_find_child(hdev, ++port1)) \
609 if (!child) continue; else
611 /* USB device locking */
612 #define usb_lock_device(udev) device_lock(&(udev)->dev)
613 #define usb_unlock_device(udev) device_unlock(&(udev)->dev)
614 #define usb_trylock_device(udev) device_trylock(&(udev)->dev)
615 extern int usb_lock_device_for_reset(struct usb_device *udev,
616 const struct usb_interface *iface);
618 /* USB port reset for device reinitialization */
619 extern int usb_reset_device(struct usb_device *dev);
620 extern void usb_queue_reset_device(struct usb_interface *dev);
623 extern int usb_acpi_set_power_state(struct usb_device *hdev, int index,
625 extern bool usb_acpi_power_manageable(struct usb_device *hdev, int index);
627 static inline int usb_acpi_set_power_state(struct usb_device *hdev, int index,
628 bool enable) { return 0; }
629 static inline bool usb_acpi_power_manageable(struct usb_device *hdev, int index)
633 /* USB autosuspend and autoresume */
634 #ifdef CONFIG_PM_RUNTIME
635 extern void usb_enable_autosuspend(struct usb_device *udev);
636 extern void usb_disable_autosuspend(struct usb_device *udev);
638 extern int usb_autopm_get_interface(struct usb_interface *intf);
639 extern void usb_autopm_put_interface(struct usb_interface *intf);
640 extern int usb_autopm_get_interface_async(struct usb_interface *intf);
641 extern void usb_autopm_put_interface_async(struct usb_interface *intf);
642 extern void usb_autopm_get_interface_no_resume(struct usb_interface *intf);
643 extern void usb_autopm_put_interface_no_suspend(struct usb_interface *intf);
645 static inline void usb_mark_last_busy(struct usb_device *udev)
647 pm_runtime_mark_last_busy(&udev->dev);
652 static inline int usb_enable_autosuspend(struct usb_device *udev)
654 static inline int usb_disable_autosuspend(struct usb_device *udev)
657 static inline int usb_autopm_get_interface(struct usb_interface *intf)
659 static inline int usb_autopm_get_interface_async(struct usb_interface *intf)
662 static inline void usb_autopm_put_interface(struct usb_interface *intf)
664 static inline void usb_autopm_put_interface_async(struct usb_interface *intf)
666 static inline void usb_autopm_get_interface_no_resume(
667 struct usb_interface *intf)
669 static inline void usb_autopm_put_interface_no_suspend(
670 struct usb_interface *intf)
672 static inline void usb_mark_last_busy(struct usb_device *udev)
676 extern int usb_disable_lpm(struct usb_device *udev);
677 extern void usb_enable_lpm(struct usb_device *udev);
678 /* Same as above, but these functions lock/unlock the bandwidth_mutex. */
679 extern int usb_unlocked_disable_lpm(struct usb_device *udev);
680 extern void usb_unlocked_enable_lpm(struct usb_device *udev);
682 extern int usb_disable_ltm(struct usb_device *udev);
683 extern void usb_enable_ltm(struct usb_device *udev);
685 static inline bool usb_device_supports_ltm(struct usb_device *udev)
687 if (udev->speed != USB_SPEED_SUPER || !udev->bos || !udev->bos->ss_cap)
689 return udev->bos->ss_cap->bmAttributes & USB_LTM_SUPPORT;
692 static inline bool usb_device_no_sg_constraint(struct usb_device *udev)
694 return udev && udev->bus && udev->bus->no_sg_constraint;
698 /*-------------------------------------------------------------------------*/
700 /* for drivers using iso endpoints */
701 extern int usb_get_current_frame_number(struct usb_device *usb_dev);
703 /* Sets up a group of bulk endpoints to support multiple stream IDs. */
704 extern int usb_alloc_streams(struct usb_interface *interface,
705 struct usb_host_endpoint **eps, unsigned int num_eps,
706 unsigned int num_streams, gfp_t mem_flags);
708 /* Reverts a group of bulk endpoints back to not using stream IDs. */
709 extern int usb_free_streams(struct usb_interface *interface,
710 struct usb_host_endpoint **eps, unsigned int num_eps,
713 /* used these for multi-interface device registration */
714 extern int usb_driver_claim_interface(struct usb_driver *driver,
715 struct usb_interface *iface, void *priv);
718 * usb_interface_claimed - returns true iff an interface is claimed
719 * @iface: the interface being checked
721 * Return: %true (nonzero) iff the interface is claimed, else %false
725 * Callers must own the driver model's usb bus readlock. So driver
726 * probe() entries don't need extra locking, but other call contexts
727 * may need to explicitly claim that lock.
730 static inline int usb_interface_claimed(struct usb_interface *iface)
732 return (iface->dev.driver != NULL);
735 extern void usb_driver_release_interface(struct usb_driver *driver,
736 struct usb_interface *iface);
737 const struct usb_device_id *usb_match_id(struct usb_interface *interface,
738 const struct usb_device_id *id);
739 extern int usb_match_one_id(struct usb_interface *interface,
740 const struct usb_device_id *id);
742 extern int usb_for_each_dev(void *data, int (*fn)(struct usb_device *, void *));
743 extern struct usb_interface *usb_find_interface(struct usb_driver *drv,
745 extern struct usb_interface *usb_ifnum_to_if(const struct usb_device *dev,
747 extern struct usb_host_interface *usb_altnum_to_altsetting(
748 const struct usb_interface *intf, unsigned int altnum);
749 extern struct usb_host_interface *usb_find_alt_setting(
750 struct usb_host_config *config,
751 unsigned int iface_num,
752 unsigned int alt_num);
754 /* port claiming functions */
755 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
756 struct usb_dev_state *owner);
757 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
758 struct usb_dev_state *owner);
761 * usb_make_path - returns stable device path in the usb tree
762 * @dev: the device whose path is being constructed
763 * @buf: where to put the string
764 * @size: how big is "buf"?
766 * Return: Length of the string (> 0) or negative if size was too small.
769 * This identifier is intended to be "stable", reflecting physical paths in
770 * hardware such as physical bus addresses for host controllers or ports on
771 * USB hubs. That makes it stay the same until systems are physically
772 * reconfigured, by re-cabling a tree of USB devices or by moving USB host
773 * controllers. Adding and removing devices, including virtual root hubs
774 * in host controller driver modules, does not change these path identifiers;
775 * neither does rebooting or re-enumerating. These are more useful identifiers
776 * than changeable ("unstable") ones like bus numbers or device addresses.
778 * With a partial exception for devices connected to USB 2.0 root hubs, these
779 * identifiers are also predictable. So long as the device tree isn't changed,
780 * plugging any USB device into a given hub port always gives it the same path.
781 * Because of the use of "companion" controllers, devices connected to ports on
782 * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are
783 * high speed, and a different one if they are full or low speed.
785 static inline int usb_make_path(struct usb_device *dev, char *buf, size_t size)
788 actual = snprintf(buf, size, "usb-%s-%s", dev->bus->bus_name,
790 return (actual >= (int)size) ? -1 : actual;
793 /*-------------------------------------------------------------------------*/
795 #define USB_DEVICE_ID_MATCH_DEVICE \
796 (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
797 #define USB_DEVICE_ID_MATCH_DEV_RANGE \
798 (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI)
799 #define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
800 (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE)
801 #define USB_DEVICE_ID_MATCH_DEV_INFO \
802 (USB_DEVICE_ID_MATCH_DEV_CLASS | \
803 USB_DEVICE_ID_MATCH_DEV_SUBCLASS | \
804 USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
805 #define USB_DEVICE_ID_MATCH_INT_INFO \
806 (USB_DEVICE_ID_MATCH_INT_CLASS | \
807 USB_DEVICE_ID_MATCH_INT_SUBCLASS | \
808 USB_DEVICE_ID_MATCH_INT_PROTOCOL)
811 * USB_DEVICE - macro used to describe a specific usb device
812 * @vend: the 16 bit USB Vendor ID
813 * @prod: the 16 bit USB Product ID
815 * This macro is used to create a struct usb_device_id that matches a
818 #define USB_DEVICE(vend, prod) \
819 .match_flags = USB_DEVICE_ID_MATCH_DEVICE, \
820 .idVendor = (vend), \
823 * USB_DEVICE_VER - describe a specific usb device with a version range
824 * @vend: the 16 bit USB Vendor ID
825 * @prod: the 16 bit USB Product ID
826 * @lo: the bcdDevice_lo value
827 * @hi: the bcdDevice_hi value
829 * This macro is used to create a struct usb_device_id that matches a
830 * specific device, with a version range.
832 #define USB_DEVICE_VER(vend, prod, lo, hi) \
833 .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, \
834 .idVendor = (vend), \
835 .idProduct = (prod), \
836 .bcdDevice_lo = (lo), \
840 * USB_DEVICE_INTERFACE_CLASS - describe a usb device with a specific interface class
841 * @vend: the 16 bit USB Vendor ID
842 * @prod: the 16 bit USB Product ID
843 * @cl: bInterfaceClass value
845 * This macro is used to create a struct usb_device_id that matches a
846 * specific interface class of devices.
848 #define USB_DEVICE_INTERFACE_CLASS(vend, prod, cl) \
849 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
850 USB_DEVICE_ID_MATCH_INT_CLASS, \
851 .idVendor = (vend), \
852 .idProduct = (prod), \
853 .bInterfaceClass = (cl)
856 * USB_DEVICE_INTERFACE_PROTOCOL - describe a usb device with a specific interface protocol
857 * @vend: the 16 bit USB Vendor ID
858 * @prod: the 16 bit USB Product ID
859 * @pr: bInterfaceProtocol value
861 * This macro is used to create a struct usb_device_id that matches a
862 * specific interface protocol of devices.
864 #define USB_DEVICE_INTERFACE_PROTOCOL(vend, prod, pr) \
865 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
866 USB_DEVICE_ID_MATCH_INT_PROTOCOL, \
867 .idVendor = (vend), \
868 .idProduct = (prod), \
869 .bInterfaceProtocol = (pr)
872 * USB_DEVICE_INTERFACE_NUMBER - describe a usb device with a specific interface number
873 * @vend: the 16 bit USB Vendor ID
874 * @prod: the 16 bit USB Product ID
875 * @num: bInterfaceNumber value
877 * This macro is used to create a struct usb_device_id that matches a
878 * specific interface number of devices.
880 #define USB_DEVICE_INTERFACE_NUMBER(vend, prod, num) \
881 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
882 USB_DEVICE_ID_MATCH_INT_NUMBER, \
883 .idVendor = (vend), \
884 .idProduct = (prod), \
885 .bInterfaceNumber = (num)
888 * USB_DEVICE_INFO - macro used to describe a class of usb devices
889 * @cl: bDeviceClass value
890 * @sc: bDeviceSubClass value
891 * @pr: bDeviceProtocol value
893 * This macro is used to create a struct usb_device_id that matches a
894 * specific class of devices.
896 #define USB_DEVICE_INFO(cl, sc, pr) \
897 .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, \
898 .bDeviceClass = (cl), \
899 .bDeviceSubClass = (sc), \
900 .bDeviceProtocol = (pr)
903 * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces
904 * @cl: bInterfaceClass value
905 * @sc: bInterfaceSubClass value
906 * @pr: bInterfaceProtocol value
908 * This macro is used to create a struct usb_device_id that matches a
909 * specific class of interfaces.
911 #define USB_INTERFACE_INFO(cl, sc, pr) \
912 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, \
913 .bInterfaceClass = (cl), \
914 .bInterfaceSubClass = (sc), \
915 .bInterfaceProtocol = (pr)
918 * USB_DEVICE_AND_INTERFACE_INFO - describe a specific usb device with a class of usb interfaces
919 * @vend: the 16 bit USB Vendor ID
920 * @prod: the 16 bit USB Product ID
921 * @cl: bInterfaceClass value
922 * @sc: bInterfaceSubClass value
923 * @pr: bInterfaceProtocol value
925 * This macro is used to create a struct usb_device_id that matches a
926 * specific device with a specific class of interfaces.
928 * This is especially useful when explicitly matching devices that have
929 * vendor specific bDeviceClass values, but standards-compliant interfaces.
931 #define USB_DEVICE_AND_INTERFACE_INFO(vend, prod, cl, sc, pr) \
932 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO \
933 | USB_DEVICE_ID_MATCH_DEVICE, \
934 .idVendor = (vend), \
935 .idProduct = (prod), \
936 .bInterfaceClass = (cl), \
937 .bInterfaceSubClass = (sc), \
938 .bInterfaceProtocol = (pr)
941 * USB_VENDOR_AND_INTERFACE_INFO - describe a specific usb vendor with a class of usb interfaces
942 * @vend: the 16 bit USB Vendor ID
943 * @cl: bInterfaceClass value
944 * @sc: bInterfaceSubClass value
945 * @pr: bInterfaceProtocol value
947 * This macro is used to create a struct usb_device_id that matches a
948 * specific vendor with a specific class of interfaces.
950 * This is especially useful when explicitly matching devices that have
951 * vendor specific bDeviceClass values, but standards-compliant interfaces.
953 #define USB_VENDOR_AND_INTERFACE_INFO(vend, cl, sc, pr) \
954 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO \
955 | USB_DEVICE_ID_MATCH_VENDOR, \
956 .idVendor = (vend), \
957 .bInterfaceClass = (cl), \
958 .bInterfaceSubClass = (sc), \
959 .bInterfaceProtocol = (pr)
961 /* ----------------------------------------------------------------------- */
963 /* Stuff for dynamic usb ids */
966 struct list_head list;
970 struct list_head node;
971 struct usb_device_id id;
974 extern ssize_t usb_store_new_id(struct usb_dynids *dynids,
975 const struct usb_device_id *id_table,
976 struct device_driver *driver,
977 const char *buf, size_t count);
979 extern ssize_t usb_show_dynids(struct usb_dynids *dynids, char *buf);
982 * struct usbdrv_wrap - wrapper for driver-model structure
983 * @driver: The driver-model core driver structure.
984 * @for_devices: Non-zero for device drivers, 0 for interface drivers.
987 struct device_driver driver;
992 * struct usb_driver - identifies USB interface driver to usbcore
993 * @name: The driver name should be unique among USB drivers,
994 * and should normally be the same as the module name.
995 * @probe: Called to see if the driver is willing to manage a particular
996 * interface on a device. If it is, probe returns zero and uses
997 * usb_set_intfdata() to associate driver-specific data with the
998 * interface. It may also use usb_set_interface() to specify the
999 * appropriate altsetting. If unwilling to manage the interface,
1000 * return -ENODEV, if genuine IO errors occurred, an appropriate
1001 * negative errno value.
1002 * @disconnect: Called when the interface is no longer accessible, usually
1003 * because its device has been (or is being) disconnected or the
1004 * driver module is being unloaded.
1005 * @unlocked_ioctl: Used for drivers that want to talk to userspace through
1006 * the "usbfs" filesystem. This lets devices provide ways to
1007 * expose information to user space regardless of where they
1008 * do (or don't) show up otherwise in the filesystem.
1009 * @suspend: Called when the device is going to be suspended by the
1010 * system either from system sleep or runtime suspend context. The
1011 * return value will be ignored in system sleep context, so do NOT
1012 * try to continue using the device if suspend fails in this case.
1013 * Instead, let the resume or reset-resume routine recover from
1015 * @resume: Called when the device is being resumed by the system.
1016 * @reset_resume: Called when the suspended device has been reset instead
1018 * @pre_reset: Called by usb_reset_device() when the device is about to be
1019 * reset. This routine must not return until the driver has no active
1020 * URBs for the device, and no more URBs may be submitted until the
1021 * post_reset method is called.
1022 * @post_reset: Called by usb_reset_device() after the device
1024 * @id_table: USB drivers use ID table to support hotplugging.
1025 * Export this with MODULE_DEVICE_TABLE(usb,...). This must be set
1026 * or your driver's probe function will never get called.
1027 * @dynids: used internally to hold the list of dynamically added device
1028 * ids for this driver.
1029 * @drvwrap: Driver-model core structure wrapper.
1030 * @no_dynamic_id: if set to 1, the USB core will not allow dynamic ids to be
1031 * added to this driver by preventing the sysfs file from being created.
1032 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
1033 * for interfaces bound to this driver.
1034 * @soft_unbind: if set to 1, the USB core will not kill URBs and disable
1035 * endpoints before calling the driver's disconnect method.
1036 * @disable_hub_initiated_lpm: if set to 0, the USB core will not allow hubs
1037 * to initiate lower power link state transitions when an idle timeout
1038 * occurs. Device-initiated USB 3.0 link PM will still be allowed.
1040 * USB interface drivers must provide a name, probe() and disconnect()
1041 * methods, and an id_table. Other driver fields are optional.
1043 * The id_table is used in hotplugging. It holds a set of descriptors,
1044 * and specialized data may be associated with each entry. That table
1045 * is used by both user and kernel mode hotplugging support.
1047 * The probe() and disconnect() methods are called in a context where
1048 * they can sleep, but they should avoid abusing the privilege. Most
1049 * work to connect to a device should be done when the device is opened,
1050 * and undone at the last close. The disconnect code needs to address
1051 * concurrency issues with respect to open() and close() methods, as
1052 * well as forcing all pending I/O requests to complete (by unlinking
1053 * them as necessary, and blocking until the unlinks complete).
1058 int (*probe) (struct usb_interface *intf,
1059 const struct usb_device_id *id);
1061 void (*disconnect) (struct usb_interface *intf);
1063 int (*unlocked_ioctl) (struct usb_interface *intf, unsigned int code,
1066 int (*suspend) (struct usb_interface *intf, pm_message_t message);
1067 int (*resume) (struct usb_interface *intf);
1068 int (*reset_resume)(struct usb_interface *intf);
1070 int (*pre_reset)(struct usb_interface *intf);
1071 int (*post_reset)(struct usb_interface *intf);
1073 const struct usb_device_id *id_table;
1075 struct usb_dynids dynids;
1076 struct usbdrv_wrap drvwrap;
1077 unsigned int no_dynamic_id:1;
1078 unsigned int supports_autosuspend:1;
1079 unsigned int disable_hub_initiated_lpm:1;
1080 unsigned int soft_unbind:1;
1082 #define to_usb_driver(d) container_of(d, struct usb_driver, drvwrap.driver)
1085 * struct usb_device_driver - identifies USB device driver to usbcore
1086 * @name: The driver name should be unique among USB drivers,
1087 * and should normally be the same as the module name.
1088 * @probe: Called to see if the driver is willing to manage a particular
1089 * device. If it is, probe returns zero and uses dev_set_drvdata()
1090 * to associate driver-specific data with the device. If unwilling
1091 * to manage the device, return a negative errno value.
1092 * @disconnect: Called when the device is no longer accessible, usually
1093 * because it has been (or is being) disconnected or the driver's
1094 * module is being unloaded.
1095 * @suspend: Called when the device is going to be suspended by the system.
1096 * @resume: Called when the device is being resumed by the system.
1097 * @drvwrap: Driver-model core structure wrapper.
1098 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
1099 * for devices bound to this driver.
1101 * USB drivers must provide all the fields listed above except drvwrap.
1103 struct usb_device_driver {
1106 int (*probe) (struct usb_device *udev);
1107 void (*disconnect) (struct usb_device *udev);
1109 int (*suspend) (struct usb_device *udev, pm_message_t message);
1110 int (*resume) (struct usb_device *udev, pm_message_t message);
1111 struct usbdrv_wrap drvwrap;
1112 unsigned int supports_autosuspend:1;
1114 #define to_usb_device_driver(d) container_of(d, struct usb_device_driver, \
1117 extern struct bus_type usb_bus_type;
1120 * struct usb_class_driver - identifies a USB driver that wants to use the USB major number
1121 * @name: the usb class device name for this driver. Will show up in sysfs.
1122 * @devnode: Callback to provide a naming hint for a possible
1123 * device node to create.
1124 * @fops: pointer to the struct file_operations of this driver.
1125 * @minor_base: the start of the minor range for this driver.
1127 * This structure is used for the usb_register_dev() and
1128 * usb_unregister_dev() functions, to consolidate a number of the
1129 * parameters used for them.
1131 struct usb_class_driver {
1133 char *(*devnode)(struct device *dev, umode_t *mode);
1134 const struct file_operations *fops;
1139 * use these in module_init()/module_exit()
1140 * and don't forget MODULE_DEVICE_TABLE(usb, ...)
1142 extern int usb_register_driver(struct usb_driver *, struct module *,
1145 /* use a define to avoid include chaining to get THIS_MODULE & friends */
1146 #define usb_register(driver) \
1147 usb_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
1149 extern void usb_deregister(struct usb_driver *);
1152 * module_usb_driver() - Helper macro for registering a USB driver
1153 * @__usb_driver: usb_driver struct
1155 * Helper macro for USB drivers which do not do anything special in module
1156 * init/exit. This eliminates a lot of boilerplate. Each module may only
1157 * use this macro once, and calling it replaces module_init() and module_exit()
1159 #define module_usb_driver(__usb_driver) \
1160 module_driver(__usb_driver, usb_register, \
1163 extern int usb_register_device_driver(struct usb_device_driver *,
1165 extern void usb_deregister_device_driver(struct usb_device_driver *);
1167 extern int usb_register_dev(struct usb_interface *intf,
1168 struct usb_class_driver *class_driver);
1169 extern void usb_deregister_dev(struct usb_interface *intf,
1170 struct usb_class_driver *class_driver);
1172 extern int usb_disabled(void);
1174 /* ----------------------------------------------------------------------- */
1177 * URB support, for asynchronous request completions
1181 * urb->transfer_flags:
1183 * Note: URB_DIR_IN/OUT is automatically set in usb_submit_urb().
1185 #define URB_SHORT_NOT_OK 0x0001 /* report short reads as errors */
1186 #define URB_ISO_ASAP 0x0002 /* iso-only; use the first unexpired
1187 * slot in the schedule */
1188 #define URB_NO_TRANSFER_DMA_MAP 0x0004 /* urb->transfer_dma valid on submit */
1189 #define URB_NO_FSBR 0x0020 /* UHCI-specific */
1190 #define URB_ZERO_PACKET 0x0040 /* Finish bulk OUT with short packet */
1191 #define URB_NO_INTERRUPT 0x0080 /* HINT: no non-error interrupt
1193 #define URB_FREE_BUFFER 0x0100 /* Free transfer buffer with the URB */
1195 /* The following flags are used internally by usbcore and HCDs */
1196 #define URB_DIR_IN 0x0200 /* Transfer from device to host */
1197 #define URB_DIR_OUT 0
1198 #define URB_DIR_MASK URB_DIR_IN
1200 #define URB_DMA_MAP_SINGLE 0x00010000 /* Non-scatter-gather mapping */
1201 #define URB_DMA_MAP_PAGE 0x00020000 /* HCD-unsupported S-G */
1202 #define URB_DMA_MAP_SG 0x00040000 /* HCD-supported S-G */
1203 #define URB_MAP_LOCAL 0x00080000 /* HCD-local-memory mapping */
1204 #define URB_SETUP_MAP_SINGLE 0x00100000 /* Setup packet DMA mapped */
1205 #define URB_SETUP_MAP_LOCAL 0x00200000 /* HCD-local setup packet */
1206 #define URB_DMA_SG_COMBINED 0x00400000 /* S-G entries were combined */
1207 #define URB_ALIGNED_TEMP_BUFFER 0x00800000 /* Temp buffer was alloc'd */
1209 struct usb_iso_packet_descriptor {
1210 unsigned int offset;
1211 unsigned int length; /* expected length */
1212 unsigned int actual_length;
1219 struct list_head urb_list;
1220 wait_queue_head_t wait;
1222 atomic_t suspend_wakeups;
1223 unsigned int poisoned:1;
1226 static inline void init_usb_anchor(struct usb_anchor *anchor)
1228 memset(anchor, 0, sizeof(*anchor));
1229 INIT_LIST_HEAD(&anchor->urb_list);
1230 init_waitqueue_head(&anchor->wait);
1231 spin_lock_init(&anchor->lock);
1234 typedef void (*usb_complete_t)(struct urb *);
1237 * struct urb - USB Request Block
1238 * @urb_list: For use by current owner of the URB.
1239 * @anchor_list: membership in the list of an anchor
1240 * @anchor: to anchor URBs to a common mooring
1241 * @ep: Points to the endpoint's data structure. Will eventually
1243 * @pipe: Holds endpoint number, direction, type, and more.
1244 * Create these values with the eight macros available;
1245 * usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl"
1246 * (control), "bulk", "int" (interrupt), or "iso" (isochronous).
1247 * For example usb_sndbulkpipe() or usb_rcvintpipe(). Endpoint
1248 * numbers range from zero to fifteen. Note that "in" endpoint two
1249 * is a different endpoint (and pipe) from "out" endpoint two.
1250 * The current configuration controls the existence, type, and
1251 * maximum packet size of any given endpoint.
1252 * @stream_id: the endpoint's stream ID for bulk streams
1253 * @dev: Identifies the USB device to perform the request.
1254 * @status: This is read in non-iso completion functions to get the
1255 * status of the particular request. ISO requests only use it
1256 * to tell whether the URB was unlinked; detailed status for
1257 * each frame is in the fields of the iso_frame-desc.
1258 * @transfer_flags: A variety of flags may be used to affect how URB
1259 * submission, unlinking, or operation are handled. Different
1260 * kinds of URB can use different flags.
1261 * @transfer_buffer: This identifies the buffer to (or from) which the I/O
1262 * request will be performed unless URB_NO_TRANSFER_DMA_MAP is set
1263 * (however, do not leave garbage in transfer_buffer even then).
1264 * This buffer must be suitable for DMA; allocate it with
1265 * kmalloc() or equivalent. For transfers to "in" endpoints, contents
1266 * of this buffer will be modified. This buffer is used for the data
1267 * stage of control transfers.
1268 * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP,
1269 * the device driver is saying that it provided this DMA address,
1270 * which the host controller driver should use in preference to the
1272 * @sg: scatter gather buffer list, the buffer size of each element in
1273 * the list (except the last) must be divisible by the endpoint's
1274 * max packet size if no_sg_constraint isn't set in 'struct usb_bus'
1275 * @num_mapped_sgs: (internal) number of mapped sg entries
1276 * @num_sgs: number of entries in the sg list
1277 * @transfer_buffer_length: How big is transfer_buffer. The transfer may
1278 * be broken up into chunks according to the current maximum packet
1279 * size for the endpoint, which is a function of the configuration
1280 * and is encoded in the pipe. When the length is zero, neither
1281 * transfer_buffer nor transfer_dma is used.
1282 * @actual_length: This is read in non-iso completion functions, and
1283 * it tells how many bytes (out of transfer_buffer_length) were
1284 * transferred. It will normally be the same as requested, unless
1285 * either an error was reported or a short read was performed.
1286 * The URB_SHORT_NOT_OK transfer flag may be used to make such
1287 * short reads be reported as errors.
1288 * @setup_packet: Only used for control transfers, this points to eight bytes
1289 * of setup data. Control transfers always start by sending this data
1290 * to the device. Then transfer_buffer is read or written, if needed.
1291 * @setup_dma: DMA pointer for the setup packet. The caller must not use
1292 * this field; setup_packet must point to a valid buffer.
1293 * @start_frame: Returns the initial frame for isochronous transfers.
1294 * @number_of_packets: Lists the number of ISO transfer buffers.
1295 * @interval: Specifies the polling interval for interrupt or isochronous
1296 * transfers. The units are frames (milliseconds) for full and low
1297 * speed devices, and microframes (1/8 millisecond) for highspeed
1298 * and SuperSpeed devices.
1299 * @error_count: Returns the number of ISO transfers that reported errors.
1300 * @context: For use in completion functions. This normally points to
1301 * request-specific driver context.
1302 * @complete: Completion handler. This URB is passed as the parameter to the
1303 * completion function. The completion function may then do what
1304 * it likes with the URB, including resubmitting or freeing it.
1305 * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to
1306 * collect the transfer status for each buffer.
1308 * This structure identifies USB transfer requests. URBs must be allocated by
1309 * calling usb_alloc_urb() and freed with a call to usb_free_urb().
1310 * Initialization may be done using various usb_fill_*_urb() functions. URBs
1311 * are submitted using usb_submit_urb(), and pending requests may be canceled
1312 * using usb_unlink_urb() or usb_kill_urb().
1314 * Data Transfer Buffers:
1316 * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise
1317 * taken from the general page pool. That is provided by transfer_buffer
1318 * (control requests also use setup_packet), and host controller drivers
1319 * perform a dma mapping (and unmapping) for each buffer transferred. Those
1320 * mapping operations can be expensive on some platforms (perhaps using a dma
1321 * bounce buffer or talking to an IOMMU),
1322 * although they're cheap on commodity x86 and ppc hardware.
1324 * Alternatively, drivers may pass the URB_NO_TRANSFER_DMA_MAP transfer flag,
1325 * which tells the host controller driver that no such mapping is needed for
1326 * the transfer_buffer since
1327 * the device driver is DMA-aware. For example, a device driver might
1328 * allocate a DMA buffer with usb_alloc_coherent() or call usb_buffer_map().
1329 * When this transfer flag is provided, host controller drivers will
1330 * attempt to use the dma address found in the transfer_dma
1331 * field rather than determining a dma address themselves.
1333 * Note that transfer_buffer must still be set if the controller
1334 * does not support DMA (as indicated by bus.uses_dma) and when talking
1335 * to root hub. If you have to trasfer between highmem zone and the device
1336 * on such controller, create a bounce buffer or bail out with an error.
1337 * If transfer_buffer cannot be set (is in highmem) and the controller is DMA
1338 * capable, assign NULL to it, so that usbmon knows not to use the value.
1339 * The setup_packet must always be set, so it cannot be located in highmem.
1343 * All URBs submitted must initialize the dev, pipe, transfer_flags (may be
1344 * zero), and complete fields. All URBs must also initialize
1345 * transfer_buffer and transfer_buffer_length. They may provide the
1346 * URB_SHORT_NOT_OK transfer flag, indicating that short reads are
1347 * to be treated as errors; that flag is invalid for write requests.
1350 * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers
1351 * should always terminate with a short packet, even if it means adding an
1352 * extra zero length packet.
1354 * Control URBs must provide a valid pointer in the setup_packet field.
1355 * Unlike the transfer_buffer, the setup_packet may not be mapped for DMA
1358 * Interrupt URBs must provide an interval, saying how often (in milliseconds
1359 * or, for highspeed devices, 125 microsecond units)
1360 * to poll for transfers. After the URB has been submitted, the interval
1361 * field reflects how the transfer was actually scheduled.
1362 * The polling interval may be more frequent than requested.
1363 * For example, some controllers have a maximum interval of 32 milliseconds,
1364 * while others support intervals of up to 1024 milliseconds.
1365 * Isochronous URBs also have transfer intervals. (Note that for isochronous
1366 * endpoints, as well as high speed interrupt endpoints, the encoding of
1367 * the transfer interval in the endpoint descriptor is logarithmic.
1368 * Device drivers must convert that value to linear units themselves.)
1370 * If an isochronous endpoint queue isn't already running, the host
1371 * controller will schedule a new URB to start as soon as bandwidth
1372 * utilization allows. If the queue is running then a new URB will be
1373 * scheduled to start in the first transfer slot following the end of the
1374 * preceding URB, if that slot has not already expired. If the slot has
1375 * expired (which can happen when IRQ delivery is delayed for a long time),
1376 * the scheduling behavior depends on the URB_ISO_ASAP flag. If the flag
1377 * is clear then the URB will be scheduled to start in the expired slot,
1378 * implying that some of its packets will not be transferred; if the flag
1379 * is set then the URB will be scheduled in the first unexpired slot,
1380 * breaking the queue's synchronization. Upon URB completion, the
1381 * start_frame field will be set to the (micro)frame number in which the
1382 * transfer was scheduled. Ranges for frame counter values are HC-specific
1383 * and can go from as low as 256 to as high as 65536 frames.
1385 * Isochronous URBs have a different data transfer model, in part because
1386 * the quality of service is only "best effort". Callers provide specially
1387 * allocated URBs, with number_of_packets worth of iso_frame_desc structures
1388 * at the end. Each such packet is an individual ISO transfer. Isochronous
1389 * URBs are normally queued, submitted by drivers to arrange that
1390 * transfers are at least double buffered, and then explicitly resubmitted
1391 * in completion handlers, so
1392 * that data (such as audio or video) streams at as constant a rate as the
1393 * host controller scheduler can support.
1395 * Completion Callbacks:
1397 * The completion callback is made in_interrupt(), and one of the first
1398 * things that a completion handler should do is check the status field.
1399 * The status field is provided for all URBs. It is used to report
1400 * unlinked URBs, and status for all non-ISO transfers. It should not
1401 * be examined before the URB is returned to the completion handler.
1403 * The context field is normally used to link URBs back to the relevant
1404 * driver or request state.
1406 * When the completion callback is invoked for non-isochronous URBs, the
1407 * actual_length field tells how many bytes were transferred. This field
1408 * is updated even when the URB terminated with an error or was unlinked.
1410 * ISO transfer status is reported in the status and actual_length fields
1411 * of the iso_frame_desc array, and the number of errors is reported in
1412 * error_count. Completion callbacks for ISO transfers will normally
1413 * (re)submit URBs to ensure a constant transfer rate.
1415 * Note that even fields marked "public" should not be touched by the driver
1416 * when the urb is owned by the hcd, that is, since the call to
1417 * usb_submit_urb() till the entry into the completion routine.
1420 /* private: usb core and host controller only fields in the urb */
1421 struct kref kref; /* reference count of the URB */
1422 void *hcpriv; /* private data for host controller */
1423 atomic_t use_count; /* concurrent submissions counter */
1424 atomic_t reject; /* submissions will fail */
1425 int unlinked; /* unlink error code */
1427 /* public: documented fields in the urb that can be used by drivers */
1428 struct list_head urb_list; /* list head for use by the urb's
1430 struct list_head anchor_list; /* the URB may be anchored */
1431 struct usb_anchor *anchor;
1432 struct usb_device *dev; /* (in) pointer to associated device */
1433 struct usb_host_endpoint *ep; /* (internal) pointer to endpoint */
1434 unsigned int pipe; /* (in) pipe information */
1435 unsigned int stream_id; /* (in) stream ID */
1436 int status; /* (return) non-ISO status */
1437 unsigned int transfer_flags; /* (in) URB_SHORT_NOT_OK | ...*/
1438 void *transfer_buffer; /* (in) associated data buffer */
1439 dma_addr_t transfer_dma; /* (in) dma addr for transfer_buffer */
1440 struct scatterlist *sg; /* (in) scatter gather buffer list */
1441 int num_mapped_sgs; /* (internal) mapped sg entries */
1442 int num_sgs; /* (in) number of entries in the sg list */
1443 u32 transfer_buffer_length; /* (in) data buffer length */
1444 u32 actual_length; /* (return) actual transfer length */
1445 unsigned char *setup_packet; /* (in) setup packet (control only) */
1446 dma_addr_t setup_dma; /* (in) dma addr for setup_packet */
1447 int start_frame; /* (modify) start frame (ISO) */
1448 int number_of_packets; /* (in) number of ISO packets */
1449 int interval; /* (modify) transfer interval
1451 int error_count; /* (return) number of ISO errors */
1452 void *context; /* (in) context for completion */
1453 usb_complete_t complete; /* (in) completion routine */
1454 struct usb_iso_packet_descriptor iso_frame_desc[0];
1458 /* ----------------------------------------------------------------------- */
1461 * usb_fill_control_urb - initializes a control urb
1462 * @urb: pointer to the urb to initialize.
1463 * @dev: pointer to the struct usb_device for this urb.
1464 * @pipe: the endpoint pipe
1465 * @setup_packet: pointer to the setup_packet buffer
1466 * @transfer_buffer: pointer to the transfer buffer
1467 * @buffer_length: length of the transfer buffer
1468 * @complete_fn: pointer to the usb_complete_t function
1469 * @context: what to set the urb context to.
1471 * Initializes a control urb with the proper information needed to submit
1474 static inline void usb_fill_control_urb(struct urb *urb,
1475 struct usb_device *dev,
1477 unsigned char *setup_packet,
1478 void *transfer_buffer,
1480 usb_complete_t complete_fn,
1485 urb->setup_packet = setup_packet;
1486 urb->transfer_buffer = transfer_buffer;
1487 urb->transfer_buffer_length = buffer_length;
1488 urb->complete = complete_fn;
1489 urb->context = context;
1493 * usb_fill_bulk_urb - macro to help initialize a bulk urb
1494 * @urb: pointer to the urb to initialize.
1495 * @dev: pointer to the struct usb_device for this urb.
1496 * @pipe: the endpoint pipe
1497 * @transfer_buffer: pointer to the transfer buffer
1498 * @buffer_length: length of the transfer buffer
1499 * @complete_fn: pointer to the usb_complete_t function
1500 * @context: what to set the urb context to.
1502 * Initializes a bulk urb with the proper information needed to submit it
1505 static inline void usb_fill_bulk_urb(struct urb *urb,
1506 struct usb_device *dev,
1508 void *transfer_buffer,
1510 usb_complete_t complete_fn,
1515 urb->transfer_buffer = transfer_buffer;
1516 urb->transfer_buffer_length = buffer_length;
1517 urb->complete = complete_fn;
1518 urb->context = context;
1522 * usb_fill_int_urb - macro to help initialize a interrupt urb
1523 * @urb: pointer to the urb to initialize.
1524 * @dev: pointer to the struct usb_device for this urb.
1525 * @pipe: the endpoint pipe
1526 * @transfer_buffer: pointer to the transfer buffer
1527 * @buffer_length: length of the transfer buffer
1528 * @complete_fn: pointer to the usb_complete_t function
1529 * @context: what to set the urb context to.
1530 * @interval: what to set the urb interval to, encoded like
1531 * the endpoint descriptor's bInterval value.
1533 * Initializes a interrupt urb with the proper information needed to submit
1536 * Note that High Speed and SuperSpeed interrupt endpoints use a logarithmic
1537 * encoding of the endpoint interval, and express polling intervals in
1538 * microframes (eight per millisecond) rather than in frames (one per
1541 * Wireless USB also uses the logarithmic encoding, but specifies it in units of
1542 * 128us instead of 125us. For Wireless USB devices, the interval is passed
1543 * through to the host controller, rather than being translated into microframe
1546 static inline void usb_fill_int_urb(struct urb *urb,
1547 struct usb_device *dev,
1549 void *transfer_buffer,
1551 usb_complete_t complete_fn,
1557 urb->transfer_buffer = transfer_buffer;
1558 urb->transfer_buffer_length = buffer_length;
1559 urb->complete = complete_fn;
1560 urb->context = context;
1562 if (dev->speed == USB_SPEED_HIGH || dev->speed == USB_SPEED_SUPER) {
1563 /* make sure interval is within allowed range */
1564 interval = clamp(interval, 1, 16);
1566 urb->interval = 1 << (interval - 1);
1568 urb->interval = interval;
1571 urb->start_frame = -1;
1574 extern void usb_init_urb(struct urb *urb);
1575 extern struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags);
1576 extern void usb_free_urb(struct urb *urb);
1577 #define usb_put_urb usb_free_urb
1578 extern struct urb *usb_get_urb(struct urb *urb);
1579 extern int usb_submit_urb(struct urb *urb, gfp_t mem_flags);
1580 extern int usb_unlink_urb(struct urb *urb);
1581 extern void usb_kill_urb(struct urb *urb);
1582 extern void usb_poison_urb(struct urb *urb);
1583 extern void usb_unpoison_urb(struct urb *urb);
1584 extern void usb_block_urb(struct urb *urb);
1585 extern void usb_kill_anchored_urbs(struct usb_anchor *anchor);
1586 extern void usb_poison_anchored_urbs(struct usb_anchor *anchor);
1587 extern void usb_unpoison_anchored_urbs(struct usb_anchor *anchor);
1588 extern void usb_unlink_anchored_urbs(struct usb_anchor *anchor);
1589 extern void usb_anchor_suspend_wakeups(struct usb_anchor *anchor);
1590 extern void usb_anchor_resume_wakeups(struct usb_anchor *anchor);
1591 extern void usb_anchor_urb(struct urb *urb, struct usb_anchor *anchor);
1592 extern void usb_unanchor_urb(struct urb *urb);
1593 extern int usb_wait_anchor_empty_timeout(struct usb_anchor *anchor,
1594 unsigned int timeout);
1595 extern struct urb *usb_get_from_anchor(struct usb_anchor *anchor);
1596 extern void usb_scuttle_anchored_urbs(struct usb_anchor *anchor);
1597 extern int usb_anchor_empty(struct usb_anchor *anchor);
1599 #define usb_unblock_urb usb_unpoison_urb
1602 * usb_urb_dir_in - check if an URB describes an IN transfer
1603 * @urb: URB to be checked
1605 * Return: 1 if @urb describes an IN transfer (device-to-host),
1608 static inline int usb_urb_dir_in(struct urb *urb)
1610 return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_IN;
1614 * usb_urb_dir_out - check if an URB describes an OUT transfer
1615 * @urb: URB to be checked
1617 * Return: 1 if @urb describes an OUT transfer (host-to-device),
1620 static inline int usb_urb_dir_out(struct urb *urb)
1622 return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_OUT;
1625 void *usb_alloc_coherent(struct usb_device *dev, size_t size,
1626 gfp_t mem_flags, dma_addr_t *dma);
1627 void usb_free_coherent(struct usb_device *dev, size_t size,
1628 void *addr, dma_addr_t dma);
1631 struct urb *usb_buffer_map(struct urb *urb);
1632 void usb_buffer_dmasync(struct urb *urb);
1633 void usb_buffer_unmap(struct urb *urb);
1637 int usb_buffer_map_sg(const struct usb_device *dev, int is_in,
1638 struct scatterlist *sg, int nents);
1640 void usb_buffer_dmasync_sg(const struct usb_device *dev, int is_in,
1641 struct scatterlist *sg, int n_hw_ents);
1643 void usb_buffer_unmap_sg(const struct usb_device *dev, int is_in,
1644 struct scatterlist *sg, int n_hw_ents);
1646 /*-------------------------------------------------------------------*
1647 * SYNCHRONOUS CALL SUPPORT *
1648 *-------------------------------------------------------------------*/
1650 extern int usb_control_msg(struct usb_device *dev, unsigned int pipe,
1651 __u8 request, __u8 requesttype, __u16 value, __u16 index,
1652 void *data, __u16 size, int timeout);
1653 extern int usb_interrupt_msg(struct usb_device *usb_dev, unsigned int pipe,
1654 void *data, int len, int *actual_length, int timeout);
1655 extern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,
1656 void *data, int len, int *actual_length,
1659 /* wrappers around usb_control_msg() for the most common standard requests */
1660 extern int usb_get_descriptor(struct usb_device *dev, unsigned char desctype,
1661 unsigned char descindex, void *buf, int size);
1662 extern int usb_get_status(struct usb_device *dev,
1663 int type, int target, void *data);
1664 extern int usb_string(struct usb_device *dev, int index,
1665 char *buf, size_t size);
1667 /* wrappers that also update important state inside usbcore */
1668 extern int usb_clear_halt(struct usb_device *dev, int pipe);
1669 extern int usb_reset_configuration(struct usb_device *dev);
1670 extern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate);
1671 extern void usb_reset_endpoint(struct usb_device *dev, unsigned int epaddr);
1673 /* this request isn't really synchronous, but it belongs with the others */
1674 extern int usb_driver_set_configuration(struct usb_device *udev, int config);
1676 /* choose and set configuration for device */
1677 extern int usb_choose_configuration(struct usb_device *udev);
1678 extern int usb_set_configuration(struct usb_device *dev, int configuration);
1681 * timeouts, in milliseconds, used for sending/receiving control messages
1682 * they typically complete within a few frames (msec) after they're issued
1683 * USB identifies 5 second timeouts, maybe more in a few cases, and a few
1684 * slow devices (like some MGE Ellipse UPSes) actually push that limit.
1686 #define USB_CTRL_GET_TIMEOUT 5000
1687 #define USB_CTRL_SET_TIMEOUT 5000
1691 * struct usb_sg_request - support for scatter/gather I/O
1692 * @status: zero indicates success, else negative errno
1693 * @bytes: counts bytes transferred.
1695 * These requests are initialized using usb_sg_init(), and then are used
1696 * as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most
1697 * members of the request object aren't for driver access.
1699 * The status and bytecount values are valid only after usb_sg_wait()
1700 * returns. If the status is zero, then the bytecount matches the total
1703 * After an error completion, drivers may need to clear a halt condition
1706 struct usb_sg_request {
1711 * members below are private to usbcore,
1712 * and are not provided for driver access!
1716 struct usb_device *dev;
1723 struct completion complete;
1727 struct usb_sg_request *io,
1728 struct usb_device *dev,
1731 struct scatterlist *sg,
1736 void usb_sg_cancel(struct usb_sg_request *io);
1737 void usb_sg_wait(struct usb_sg_request *io);
1740 /* ----------------------------------------------------------------------- */
1743 * For various legacy reasons, Linux has a small cookie that's paired with
1744 * a struct usb_device to identify an endpoint queue. Queue characteristics
1745 * are defined by the endpoint's descriptor. This cookie is called a "pipe",
1746 * an unsigned int encoded as:
1748 * - direction: bit 7 (0 = Host-to-Device [Out],
1749 * 1 = Device-to-Host [In] ...
1750 * like endpoint bEndpointAddress)
1751 * - device address: bits 8-14 ... bit positions known to uhci-hcd
1752 * - endpoint: bits 15-18 ... bit positions known to uhci-hcd
1753 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
1754 * 10 = control, 11 = bulk)
1756 * Given the device address and endpoint descriptor, pipes are redundant.
1759 /* NOTE: these are not the standard USB_ENDPOINT_XFER_* values!! */
1760 /* (yet ... they're the values used by usbfs) */
1761 #define PIPE_ISOCHRONOUS 0
1762 #define PIPE_INTERRUPT 1
1763 #define PIPE_CONTROL 2
1766 #define usb_pipein(pipe) ((pipe) & USB_DIR_IN)
1767 #define usb_pipeout(pipe) (!usb_pipein(pipe))
1769 #define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
1770 #define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
1772 #define usb_pipetype(pipe) (((pipe) >> 30) & 3)
1773 #define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
1774 #define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
1775 #define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
1776 #define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
1778 static inline unsigned int __create_pipe(struct usb_device *dev,
1779 unsigned int endpoint)
1781 return (dev->devnum << 8) | (endpoint << 15);
1784 /* Create various pipes... */
1785 #define usb_sndctrlpipe(dev, endpoint) \
1786 ((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint))
1787 #define usb_rcvctrlpipe(dev, endpoint) \
1788 ((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
1789 #define usb_sndisocpipe(dev, endpoint) \
1790 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint))
1791 #define usb_rcvisocpipe(dev, endpoint) \
1792 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
1793 #define usb_sndbulkpipe(dev, endpoint) \
1794 ((PIPE_BULK << 30) | __create_pipe(dev, endpoint))
1795 #define usb_rcvbulkpipe(dev, endpoint) \
1796 ((PIPE_BULK << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
1797 #define usb_sndintpipe(dev, endpoint) \
1798 ((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint))
1799 #define usb_rcvintpipe(dev, endpoint) \
1800 ((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
1802 static inline struct usb_host_endpoint *
1803 usb_pipe_endpoint(struct usb_device *dev, unsigned int pipe)
1805 struct usb_host_endpoint **eps;
1806 eps = usb_pipein(pipe) ? dev->ep_in : dev->ep_out;
1807 return eps[usb_pipeendpoint(pipe)];
1810 /*-------------------------------------------------------------------------*/
1813 usb_maxpacket(struct usb_device *udev, int pipe, int is_out)
1815 struct usb_host_endpoint *ep;
1816 unsigned epnum = usb_pipeendpoint(pipe);
1819 WARN_ON(usb_pipein(pipe));
1820 ep = udev->ep_out[epnum];
1822 WARN_ON(usb_pipeout(pipe));
1823 ep = udev->ep_in[epnum];
1828 /* NOTE: only 0x07ff bits are for packet size... */
1829 return usb_endpoint_maxp(&ep->desc);
1832 /* ----------------------------------------------------------------------- */
1834 /* translate USB error codes to codes user space understands */
1835 static inline int usb_translate_errors(int error_code)
1837 switch (error_code) {
1848 /* Events from the usb core */
1849 #define USB_DEVICE_ADD 0x0001
1850 #define USB_DEVICE_REMOVE 0x0002
1851 #define USB_BUS_ADD 0x0003
1852 #define USB_BUS_REMOVE 0x0004
1853 extern void usb_register_notify(struct notifier_block *nb);
1854 extern void usb_unregister_notify(struct notifier_block *nb);
1857 extern struct dentry *usb_debug_root;
1859 #endif /* __KERNEL__ */