4 * (C) Copyright Linus Torvalds 1999
5 * (C) Copyright Johannes Erdfelt 1999-2001
6 * (C) Copyright Andreas Gal 1999
7 * (C) Copyright Gregory P. Smith 1999
8 * (C) Copyright Deti Fliegl 1999 (new USB architecture)
9 * (C) Copyright Randy Dunlap 2000
10 * (C) Copyright David Brownell 2000-2004
11 * (C) Copyright Yggdrasil Computing, Inc. 2000
12 * (usb_device_id matching changes by Adam J. Richter)
13 * (C) Copyright Greg Kroah-Hartman 2002-2003
15 * NOTE! This is not actually a driver at all, rather this is
16 * just a collection of helper routines that implement the
17 * generic USB things that the real drivers can use..
19 * Think of this as a "USB library" rather than anything else.
20 * It should be considered a slave, with no callbacks. Callbacks
24 #include <linux/config.h>
25 #include <linux/module.h>
26 #include <linux/string.h>
27 #include <linux/bitops.h>
28 #include <linux/slab.h>
29 #include <linux/interrupt.h> /* for in_interrupt() */
30 #include <linux/kmod.h>
31 #include <linux/init.h>
32 #include <linux/spinlock.h>
33 #include <linux/errno.h>
34 #include <linux/smp_lock.h>
35 #include <linux/rwsem.h>
36 #include <linux/usb.h>
39 #include <asm/scatterlist.h>
41 #include <linux/dma-mapping.h>
47 const char *usbcore_name = "usbcore";
49 static int nousb; /* Disable USB when built into kernel image */
50 /* Not honored on modular build */
52 static DECLARE_RWSEM(usb_all_devices_rwsem);
55 static int generic_probe (struct device *dev)
59 static int generic_remove (struct device *dev)
61 struct usb_device *udev = to_usb_device(dev);
63 /* if this is only an unbind, not a physical disconnect, then
64 * unconfigure the device */
65 if (udev->state == USB_STATE_CONFIGURED)
66 usb_set_configuration(udev, 0);
68 /* in case the call failed or the device was suspended */
69 if (udev->state >= USB_STATE_CONFIGURED)
70 usb_disable_device(udev, 0);
74 static struct device_driver usb_generic_driver = {
78 .probe = generic_probe,
79 .remove = generic_remove,
82 static int usb_generic_driver_data;
84 /* called from driver core with usb_bus_type.subsys writelock */
85 static int usb_probe_interface(struct device *dev)
87 struct usb_interface * intf = to_usb_interface(dev);
88 struct usb_driver * driver = to_usb_driver(dev->driver);
89 const struct usb_device_id *id;
92 dev_dbg(dev, "%s\n", __FUNCTION__);
96 /* FIXME we'd much prefer to just resume it ... */
97 if (interface_to_usbdev(intf)->state == USB_STATE_SUSPENDED)
100 id = usb_match_id (intf, driver->id_table);
102 dev_dbg (dev, "%s - got id\n", __FUNCTION__);
104 /* Interface "power state" doesn't correspond to any hardware
105 * state whatsoever. We use it to record when it's bound to
106 * a driver that may start I/0: it's not frozen/quiesced.
109 intf->condition = USB_INTERFACE_BINDING;
110 error = driver->probe (intf, id);
113 intf->condition = USB_INTERFACE_UNBOUND;
115 intf->condition = USB_INTERFACE_BOUND;
121 /* called from driver core with usb_bus_type.subsys writelock */
122 static int usb_unbind_interface(struct device *dev)
124 struct usb_interface *intf = to_usb_interface(dev);
125 struct usb_driver *driver = to_usb_driver(intf->dev.driver);
127 intf->condition = USB_INTERFACE_UNBINDING;
129 /* release all urbs for this interface */
130 usb_disable_interface(interface_to_usbdev(intf), intf);
132 if (driver && driver->disconnect)
133 driver->disconnect(intf);
135 /* reset other interface state */
136 usb_set_interface(interface_to_usbdev(intf),
137 intf->altsetting[0].desc.bInterfaceNumber,
139 usb_set_intfdata(intf, NULL);
140 intf->condition = USB_INTERFACE_UNBOUND;
147 * usb_register - register a USB driver
148 * @new_driver: USB operations for the driver
150 * Registers a USB driver with the USB core. The list of unattached
151 * interfaces will be rescanned whenever a new driver is added, allowing
152 * the new driver to attach to any recognized devices.
153 * Returns a negative error code on failure and 0 on success.
155 * NOTE: if you want your driver to use the USB major number, you must call
156 * usb_register_dev() to enable that functionality. This function no longer
157 * takes care of that.
159 int usb_register(struct usb_driver *new_driver)
166 new_driver->driver.name = (char *)new_driver->name;
167 new_driver->driver.bus = &usb_bus_type;
168 new_driver->driver.probe = usb_probe_interface;
169 new_driver->driver.remove = usb_unbind_interface;
170 new_driver->driver.owner = new_driver->owner;
172 usb_lock_all_devices();
173 retval = driver_register(&new_driver->driver);
174 usb_unlock_all_devices();
177 pr_info("%s: registered new driver %s\n",
178 usbcore_name, new_driver->name);
179 usbfs_update_special();
181 printk(KERN_ERR "%s: error %d registering driver %s\n",
182 usbcore_name, retval, new_driver->name);
189 * usb_deregister - unregister a USB driver
190 * @driver: USB operations of the driver to unregister
191 * Context: must be able to sleep
193 * Unlinks the specified driver from the internal USB driver list.
195 * NOTE: If you called usb_register_dev(), you still need to call
196 * usb_deregister_dev() to clean up your driver's allocated minor numbers,
197 * this * call will no longer do it for you.
199 void usb_deregister(struct usb_driver *driver)
201 pr_info("%s: deregistering driver %s\n", usbcore_name, driver->name);
203 usb_lock_all_devices();
204 driver_unregister (&driver->driver);
205 usb_unlock_all_devices();
207 usbfs_update_special();
211 * usb_ifnum_to_if - get the interface object with a given interface number
212 * @dev: the device whose current configuration is considered
213 * @ifnum: the desired interface
215 * This walks the device descriptor for the currently active configuration
216 * and returns a pointer to the interface with that particular interface
219 * Note that configuration descriptors are not required to assign interface
220 * numbers sequentially, so that it would be incorrect to assume that
221 * the first interface in that descriptor corresponds to interface zero.
222 * This routine helps device drivers avoid such mistakes.
223 * However, you should make sure that you do the right thing with any
224 * alternate settings available for this interfaces.
226 * Don't call this function unless you are bound to one of the interfaces
227 * on this device or you have locked the device!
229 struct usb_interface *usb_ifnum_to_if(struct usb_device *dev, unsigned ifnum)
231 struct usb_host_config *config = dev->actconfig;
236 for (i = 0; i < config->desc.bNumInterfaces; i++)
237 if (config->interface[i]->altsetting[0]
238 .desc.bInterfaceNumber == ifnum)
239 return config->interface[i];
245 * usb_altnum_to_altsetting - get the altsetting structure with a given
246 * alternate setting number.
247 * @intf: the interface containing the altsetting in question
248 * @altnum: the desired alternate setting number
250 * This searches the altsetting array of the specified interface for
251 * an entry with the correct bAlternateSetting value and returns a pointer
252 * to that entry, or null.
254 * Note that altsettings need not be stored sequentially by number, so
255 * it would be incorrect to assume that the first altsetting entry in
256 * the array corresponds to altsetting zero. This routine helps device
257 * drivers avoid such mistakes.
259 * Don't call this function unless you are bound to the intf interface
260 * or you have locked the device!
262 struct usb_host_interface *usb_altnum_to_altsetting(struct usb_interface *intf,
267 for (i = 0; i < intf->num_altsetting; i++) {
268 if (intf->altsetting[i].desc.bAlternateSetting == altnum)
269 return &intf->altsetting[i];
275 * usb_driver_claim_interface - bind a driver to an interface
276 * @driver: the driver to be bound
277 * @iface: the interface to which it will be bound; must be in the
278 * usb device's active configuration
279 * @priv: driver data associated with that interface
281 * This is used by usb device drivers that need to claim more than one
282 * interface on a device when probing (audio and acm are current examples).
283 * No device driver should directly modify internal usb_interface or
284 * usb_device structure members.
286 * Few drivers should need to use this routine, since the most natural
287 * way to bind to an interface is to return the private data from
288 * the driver's probe() method.
290 * Callers must own the device lock and the driver model's usb_bus_type.subsys
291 * writelock. So driver probe() entries don't need extra locking,
292 * but other call contexts may need to explicitly claim those locks.
294 int usb_driver_claim_interface(struct usb_driver *driver,
295 struct usb_interface *iface, void* priv)
297 struct device *dev = &iface->dev;
302 dev->driver = &driver->driver;
303 usb_set_intfdata(iface, priv);
304 iface->condition = USB_INTERFACE_BOUND;
307 /* if interface was already added, bind now; else let
308 * the future device_add() bind it, bypassing probe()
310 if (device_is_registered(dev))
311 device_bind_driver(dev);
317 * usb_driver_release_interface - unbind a driver from an interface
318 * @driver: the driver to be unbound
319 * @iface: the interface from which it will be unbound
321 * This can be used by drivers to release an interface without waiting
322 * for their disconnect() methods to be called. In typical cases this
323 * also causes the driver disconnect() method to be called.
325 * This call is synchronous, and may not be used in an interrupt context.
326 * Callers must own the device lock and the driver model's usb_bus_type.subsys
327 * writelock. So driver disconnect() entries don't need extra locking,
328 * but other call contexts may need to explicitly claim those locks.
330 void usb_driver_release_interface(struct usb_driver *driver,
331 struct usb_interface *iface)
333 struct device *dev = &iface->dev;
335 /* this should never happen, don't release something that's not ours */
336 if (!dev->driver || dev->driver != &driver->driver)
339 /* don't release from within disconnect() */
340 if (iface->condition != USB_INTERFACE_BOUND)
343 /* don't release if the interface hasn't been added yet */
344 if (device_is_registered(dev)) {
345 iface->condition = USB_INTERFACE_UNBINDING;
346 device_release_driver(dev);
350 usb_set_intfdata(iface, NULL);
351 iface->condition = USB_INTERFACE_UNBOUND;
352 mark_quiesced(iface);
356 * usb_match_id - find first usb_device_id matching device or interface
357 * @interface: the interface of interest
358 * @id: array of usb_device_id structures, terminated by zero entry
360 * usb_match_id searches an array of usb_device_id's and returns
361 * the first one matching the device or interface, or null.
362 * This is used when binding (or rebinding) a driver to an interface.
363 * Most USB device drivers will use this indirectly, through the usb core,
364 * but some layered driver frameworks use it directly.
365 * These device tables are exported with MODULE_DEVICE_TABLE, through
366 * modutils, to support the driver loading functionality of USB hotplugging.
370 * The "match_flags" element in a usb_device_id controls which
371 * members are used. If the corresponding bit is set, the
372 * value in the device_id must match its corresponding member
373 * in the device or interface descriptor, or else the device_id
376 * "driver_info" is normally used only by device drivers,
377 * but you can create a wildcard "matches anything" usb_device_id
378 * as a driver's "modules.usbmap" entry if you provide an id with
379 * only a nonzero "driver_info" field. If you do this, the USB device
380 * driver's probe() routine should use additional intelligence to
381 * decide whether to bind to the specified interface.
383 * What Makes Good usb_device_id Tables:
385 * The match algorithm is very simple, so that intelligence in
386 * driver selection must come from smart driver id records.
387 * Unless you have good reasons to use another selection policy,
388 * provide match elements only in related groups, and order match
389 * specifiers from specific to general. Use the macros provided
390 * for that purpose if you can.
392 * The most specific match specifiers use device descriptor
393 * data. These are commonly used with product-specific matches;
394 * the USB_DEVICE macro lets you provide vendor and product IDs,
395 * and you can also match against ranges of product revisions.
396 * These are widely used for devices with application or vendor
397 * specific bDeviceClass values.
399 * Matches based on device class/subclass/protocol specifications
400 * are slightly more general; use the USB_DEVICE_INFO macro, or
401 * its siblings. These are used with single-function devices
402 * where bDeviceClass doesn't specify that each interface has
405 * Matches based on interface class/subclass/protocol are the
406 * most general; they let drivers bind to any interface on a
407 * multiple-function device. Use the USB_INTERFACE_INFO
408 * macro, or its siblings, to match class-per-interface style
409 * devices (as recorded in bDeviceClass).
411 * Within those groups, remember that not all combinations are
412 * meaningful. For example, don't give a product version range
413 * without vendor and product IDs; or specify a protocol without
414 * its associated class and subclass.
416 const struct usb_device_id *
417 usb_match_id(struct usb_interface *interface, const struct usb_device_id *id)
419 struct usb_host_interface *intf;
420 struct usb_device *dev;
422 /* proc_connectinfo in devio.c may call us with id == NULL. */
426 intf = interface->cur_altsetting;
427 dev = interface_to_usbdev(interface);
429 /* It is important to check that id->driver_info is nonzero,
430 since an entry that is all zeroes except for a nonzero
431 id->driver_info is the way to create an entry that
432 indicates that the driver want to examine every
433 device and interface. */
434 for (; id->idVendor || id->bDeviceClass || id->bInterfaceClass ||
435 id->driver_info; id++) {
437 if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
438 id->idVendor != le16_to_cpu(dev->descriptor.idVendor))
441 if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) &&
442 id->idProduct != le16_to_cpu(dev->descriptor.idProduct))
445 /* No need to test id->bcdDevice_lo != 0, since 0 is never
446 greater than any unsigned number. */
447 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO) &&
448 (id->bcdDevice_lo > le16_to_cpu(dev->descriptor.bcdDevice)))
451 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) &&
452 (id->bcdDevice_hi < le16_to_cpu(dev->descriptor.bcdDevice)))
455 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) &&
456 (id->bDeviceClass != dev->descriptor.bDeviceClass))
459 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) &&
460 (id->bDeviceSubClass!= dev->descriptor.bDeviceSubClass))
463 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) &&
464 (id->bDeviceProtocol != dev->descriptor.bDeviceProtocol))
467 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) &&
468 (id->bInterfaceClass != intf->desc.bInterfaceClass))
471 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) &&
472 (id->bInterfaceSubClass != intf->desc.bInterfaceSubClass))
475 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) &&
476 (id->bInterfaceProtocol != intf->desc.bInterfaceProtocol))
486 static int __find_interface(struct device * dev, void * data)
488 struct usb_interface ** ret = (struct usb_interface **)data;
489 struct usb_interface * intf = *ret;
490 int *minor = (int *)data;
492 /* can't look at usb devices, only interfaces */
493 if (dev->driver == &usb_generic_driver)
496 intf = to_usb_interface(dev);
497 if (intf->minor != -1 && intf->minor == *minor) {
505 * usb_find_interface - find usb_interface pointer for driver and device
506 * @drv: the driver whose current configuration is considered
507 * @minor: the minor number of the desired device
509 * This walks the driver device list and returns a pointer to the interface
510 * with the matching minor. Note, this only works for devices that share the
513 struct usb_interface *usb_find_interface(struct usb_driver *drv, int minor)
515 struct usb_interface *intf = (struct usb_interface *)(long)minor;
518 ret = driver_for_each_device(&drv->driver, NULL, &intf, __find_interface);
520 return ret ? intf : NULL;
523 static int usb_device_match (struct device *dev, struct device_driver *drv)
525 struct usb_interface *intf;
526 struct usb_driver *usb_drv;
527 const struct usb_device_id *id;
529 /* check for generic driver, which we don't match any device with */
530 if (drv == &usb_generic_driver)
533 intf = to_usb_interface(dev);
534 usb_drv = to_usb_driver(drv);
536 id = usb_match_id (intf, usb_drv->id_table);
544 #ifdef CONFIG_HOTPLUG
547 * This sends an uevent to userspace, typically helping to load driver
548 * or other modules, configure the device, and more. Drivers can provide
549 * a MODULE_DEVICE_TABLE to help with module loading subtasks.
551 * We're called either from khubd (the typical case) or from root hub
552 * (init, kapmd, modprobe, rmmod, etc), but the agents need to handle
553 * delays in event delivery. Use sysfs (and DEVPATH) to make sure the
554 * device (and this configuration!) are still present.
556 static int usb_uevent(struct device *dev, char **envp, int num_envp,
557 char *buffer, int buffer_size)
559 struct usb_interface *intf;
560 struct usb_device *usb_dev;
561 struct usb_host_interface *alt;
568 /* driver is often null here; dev_dbg() would oops */
569 pr_debug ("usb %s: uevent\n", dev->bus_id);
571 /* Must check driver_data here, as on remove driver is always NULL */
572 if ((dev->driver == &usb_generic_driver) ||
573 (dev->driver_data == &usb_generic_driver_data))
576 intf = to_usb_interface(dev);
577 usb_dev = interface_to_usbdev (intf);
578 alt = intf->cur_altsetting;
580 if (usb_dev->devnum < 0) {
581 pr_debug ("usb %s: already deleted?\n", dev->bus_id);
585 pr_debug ("usb %s: bus removed?\n", dev->bus_id);
589 #ifdef CONFIG_USB_DEVICEFS
590 /* If this is available, userspace programs can directly read
591 * all the device descriptors we don't tell them about. Or
592 * even act as usermode drivers.
594 * FIXME reduce hardwired intelligence here
596 if (add_uevent_var(envp, num_envp, &i,
597 buffer, buffer_size, &length,
598 "DEVICE=/proc/bus/usb/%03d/%03d",
599 usb_dev->bus->busnum, usb_dev->devnum))
603 /* per-device configurations are common */
604 if (add_uevent_var(envp, num_envp, &i,
605 buffer, buffer_size, &length,
607 le16_to_cpu(usb_dev->descriptor.idVendor),
608 le16_to_cpu(usb_dev->descriptor.idProduct),
609 le16_to_cpu(usb_dev->descriptor.bcdDevice)))
612 /* class-based driver binding models */
613 if (add_uevent_var(envp, num_envp, &i,
614 buffer, buffer_size, &length,
616 usb_dev->descriptor.bDeviceClass,
617 usb_dev->descriptor.bDeviceSubClass,
618 usb_dev->descriptor.bDeviceProtocol))
621 if (add_uevent_var(envp, num_envp, &i,
622 buffer, buffer_size, &length,
623 "INTERFACE=%d/%d/%d",
624 alt->desc.bInterfaceClass,
625 alt->desc.bInterfaceSubClass,
626 alt->desc.bInterfaceProtocol))
629 if (add_uevent_var(envp, num_envp, &i,
630 buffer, buffer_size, &length,
631 "MODALIAS=usb:v%04Xp%04Xd%04Xdc%02Xdsc%02Xdp%02Xic%02Xisc%02Xip%02X",
632 le16_to_cpu(usb_dev->descriptor.idVendor),
633 le16_to_cpu(usb_dev->descriptor.idProduct),
634 le16_to_cpu(usb_dev->descriptor.bcdDevice),
635 usb_dev->descriptor.bDeviceClass,
636 usb_dev->descriptor.bDeviceSubClass,
637 usb_dev->descriptor.bDeviceProtocol,
638 alt->desc.bInterfaceClass,
639 alt->desc.bInterfaceSubClass,
640 alt->desc.bInterfaceProtocol))
650 static int usb_uevent(struct device *dev, char **envp,
651 int num_envp, char *buffer, int buffer_size)
656 #endif /* CONFIG_HOTPLUG */
659 * usb_release_dev - free a usb device structure when all users of it are finished.
660 * @dev: device that's been disconnected
662 * Will be called only by the device core when all users of this usb device are
665 static void usb_release_dev(struct device *dev)
667 struct usb_device *udev;
669 udev = to_usb_device(dev);
671 usb_destroy_configuration(udev);
672 usb_bus_put(udev->bus);
673 kfree(udev->product);
674 kfree(udev->manufacturer);
680 * usb_alloc_dev - usb device constructor (usbcore-internal)
681 * @parent: hub to which device is connected; null to allocate a root hub
682 * @bus: bus used to access the device
683 * @port1: one-based index of port; ignored for root hubs
684 * Context: !in_interrupt ()
686 * Only hub drivers (including virtual root hub drivers for host
687 * controllers) should ever call this.
689 * This call may not be used in a non-sleeping context.
692 usb_alloc_dev(struct usb_device *parent, struct usb_bus *bus, unsigned port1)
694 struct usb_device *dev;
696 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
700 bus = usb_bus_get(bus);
706 device_initialize(&dev->dev);
707 dev->dev.bus = &usb_bus_type;
708 dev->dev.dma_mask = bus->controller->dma_mask;
709 dev->dev.driver_data = &usb_generic_driver_data;
710 dev->dev.driver = &usb_generic_driver;
711 dev->dev.release = usb_release_dev;
712 dev->state = USB_STATE_ATTACHED;
714 INIT_LIST_HEAD(&dev->ep0.urb_list);
715 dev->ep0.desc.bLength = USB_DT_ENDPOINT_SIZE;
716 dev->ep0.desc.bDescriptorType = USB_DT_ENDPOINT;
717 /* ep0 maxpacket comes later, from device descriptor */
718 dev->ep_in[0] = dev->ep_out[0] = &dev->ep0;
720 /* Save readable and stable topology id, distinguishing devices
721 * by location for diagnostics, tools, driver model, etc. The
722 * string is a path along hub ports, from the root. Each device's
723 * dev->devpath will be stable until USB is re-cabled, and hubs
724 * are often labeled with these port numbers. The bus_id isn't
725 * as stable: bus->busnum changes easily from modprobe order,
726 * cardbus or pci hotplugging, and so on.
728 if (unlikely (!parent)) {
729 dev->devpath [0] = '0';
731 dev->dev.parent = bus->controller;
732 sprintf (&dev->dev.bus_id[0], "usb%d", bus->busnum);
734 /* match any labeling on the hubs; it's one-based */
735 if (parent->devpath [0] == '0')
736 snprintf (dev->devpath, sizeof dev->devpath,
739 snprintf (dev->devpath, sizeof dev->devpath,
740 "%s.%d", parent->devpath, port1);
742 dev->dev.parent = &parent->dev;
743 sprintf (&dev->dev.bus_id[0], "%d-%s",
744 bus->busnum, dev->devpath);
746 /* hub driver sets up TT records */
750 dev->parent = parent;
751 INIT_LIST_HEAD(&dev->filelist);
753 init_MUTEX(&dev->serialize);
759 * usb_get_dev - increments the reference count of the usb device structure
760 * @dev: the device being referenced
762 * Each live reference to a device should be refcounted.
764 * Drivers for USB interfaces should normally record such references in
765 * their probe() methods, when they bind to an interface, and release
766 * them by calling usb_put_dev(), in their disconnect() methods.
768 * A pointer to the device with the incremented reference counter is returned.
770 struct usb_device *usb_get_dev(struct usb_device *dev)
773 get_device(&dev->dev);
778 * usb_put_dev - release a use of the usb device structure
779 * @dev: device that's been disconnected
781 * Must be called when a user of a device is finished with it. When the last
782 * user of the device calls this function, the memory of the device is freed.
784 void usb_put_dev(struct usb_device *dev)
787 put_device(&dev->dev);
791 * usb_get_intf - increments the reference count of the usb interface structure
792 * @intf: the interface being referenced
794 * Each live reference to a interface must be refcounted.
796 * Drivers for USB interfaces should normally record such references in
797 * their probe() methods, when they bind to an interface, and release
798 * them by calling usb_put_intf(), in their disconnect() methods.
800 * A pointer to the interface with the incremented reference counter is
803 struct usb_interface *usb_get_intf(struct usb_interface *intf)
806 get_device(&intf->dev);
811 * usb_put_intf - release a use of the usb interface structure
812 * @intf: interface that's been decremented
814 * Must be called when a user of an interface is finished with it. When the
815 * last user of the interface calls this function, the memory of the interface
818 void usb_put_intf(struct usb_interface *intf)
821 put_device(&intf->dev);
825 /* USB device locking
827 * Although locking USB devices should be straightforward, it is
828 * complicated by the way the driver-model core works. When a new USB
829 * driver is registered or unregistered, the core will automatically
830 * probe or disconnect all matching interfaces on all USB devices while
831 * holding the USB subsystem writelock. There's no good way for us to
832 * tell which devices will be used or to lock them beforehand; our only
833 * option is to effectively lock all the USB devices.
835 * We do that by using a private rw-semaphore, usb_all_devices_rwsem.
836 * When locking an individual device you must first acquire the rwsem's
837 * readlock. When a driver is registered or unregistered the writelock
838 * must be held. These actions are encapsulated in the subroutines
839 * below, so all a driver needs to do is call usb_lock_device() and
840 * usb_unlock_device().
842 * Complications arise when several devices are to be locked at the same
843 * time. Only hub-aware drivers that are part of usbcore ever have to
844 * do this; nobody else needs to worry about it. The problem is that
845 * usb_lock_device() must not be called to lock a second device since it
846 * would acquire the rwsem's readlock reentrantly, leading to deadlock if
847 * another thread was waiting for the writelock. The solution is simple:
849 * When locking more than one device, call usb_lock_device()
850 * to lock the first one. Lock the others by calling
851 * down(&udev->serialize) directly.
853 * When unlocking multiple devices, use up(&udev->serialize)
854 * to unlock all but the last one. Unlock the last one by
855 * calling usb_unlock_device().
857 * When locking both a device and its parent, always lock the
862 * usb_lock_device - acquire the lock for a usb device structure
863 * @udev: device that's being locked
865 * Use this routine when you don't hold any other device locks;
866 * to acquire nested inner locks call down(&udev->serialize) directly.
867 * This is necessary for proper interaction with usb_lock_all_devices().
869 void usb_lock_device(struct usb_device *udev)
871 down_read(&usb_all_devices_rwsem);
872 down(&udev->serialize);
876 * usb_trylock_device - attempt to acquire the lock for a usb device structure
877 * @udev: device that's being locked
879 * Don't use this routine if you already hold a device lock;
880 * use down_trylock(&udev->serialize) instead.
881 * This is necessary for proper interaction with usb_lock_all_devices().
883 * Returns 1 if successful, 0 if contention.
885 int usb_trylock_device(struct usb_device *udev)
887 if (!down_read_trylock(&usb_all_devices_rwsem))
889 if (down_trylock(&udev->serialize)) {
890 up_read(&usb_all_devices_rwsem);
897 * usb_lock_device_for_reset - cautiously acquire the lock for a
898 * usb device structure
899 * @udev: device that's being locked
900 * @iface: interface bound to the driver making the request (optional)
902 * Attempts to acquire the device lock, but fails if the device is
903 * NOTATTACHED or SUSPENDED, or if iface is specified and the interface
904 * is neither BINDING nor BOUND. Rather than sleeping to wait for the
905 * lock, the routine polls repeatedly. This is to prevent deadlock with
906 * disconnect; in some drivers (such as usb-storage) the disconnect()
907 * or suspend() method will block waiting for a device reset to complete.
909 * Returns a negative error code for failure, otherwise 1 or 0 to indicate
910 * that the device will or will not have to be unlocked. (0 can be
911 * returned when an interface is given and is BINDING, because in that
912 * case the driver already owns the device lock.)
914 int usb_lock_device_for_reset(struct usb_device *udev,
915 struct usb_interface *iface)
917 unsigned long jiffies_expire = jiffies + HZ;
919 if (udev->state == USB_STATE_NOTATTACHED)
921 if (udev->state == USB_STATE_SUSPENDED)
922 return -EHOSTUNREACH;
924 switch (iface->condition) {
925 case USB_INTERFACE_BINDING:
927 case USB_INTERFACE_BOUND:
934 while (!usb_trylock_device(udev)) {
936 /* If we can't acquire the lock after waiting one second,
937 * we're probably deadlocked */
938 if (time_after(jiffies, jiffies_expire))
942 if (udev->state == USB_STATE_NOTATTACHED)
944 if (udev->state == USB_STATE_SUSPENDED)
945 return -EHOSTUNREACH;
946 if (iface && iface->condition != USB_INTERFACE_BOUND)
953 * usb_unlock_device - release the lock for a usb device structure
954 * @udev: device that's being unlocked
956 * Use this routine when releasing the only device lock you hold;
957 * to release inner nested locks call up(&udev->serialize) directly.
958 * This is necessary for proper interaction with usb_lock_all_devices().
960 void usb_unlock_device(struct usb_device *udev)
962 up(&udev->serialize);
963 up_read(&usb_all_devices_rwsem);
967 * usb_lock_all_devices - acquire the lock for all usb device structures
969 * This is necessary when registering a new driver or probing a bus,
970 * since the driver-model core may try to use any usb_device.
972 void usb_lock_all_devices(void)
974 down_write(&usb_all_devices_rwsem);
978 * usb_unlock_all_devices - release the lock for all usb device structures
980 void usb_unlock_all_devices(void)
982 up_write(&usb_all_devices_rwsem);
986 static struct usb_device *match_device(struct usb_device *dev,
987 u16 vendor_id, u16 product_id)
989 struct usb_device *ret_dev = NULL;
992 dev_dbg(&dev->dev, "check for vendor %04x, product %04x ...\n",
993 le16_to_cpu(dev->descriptor.idVendor),
994 le16_to_cpu(dev->descriptor.idProduct));
996 /* see if this device matches */
997 if ((vendor_id == le16_to_cpu(dev->descriptor.idVendor)) &&
998 (product_id == le16_to_cpu(dev->descriptor.idProduct))) {
999 dev_dbg (&dev->dev, "matched this device!\n");
1000 ret_dev = usb_get_dev(dev);
1004 /* look through all of the children of this device */
1005 for (child = 0; child < dev->maxchild; ++child) {
1006 if (dev->children[child]) {
1007 down(&dev->children[child]->serialize);
1008 ret_dev = match_device(dev->children[child],
1009 vendor_id, product_id);
1010 up(&dev->children[child]->serialize);
1020 * usb_find_device - find a specific usb device in the system
1021 * @vendor_id: the vendor id of the device to find
1022 * @product_id: the product id of the device to find
1024 * Returns a pointer to a struct usb_device if such a specified usb
1025 * device is present in the system currently. The usage count of the
1026 * device will be incremented if a device is found. Make sure to call
1027 * usb_put_dev() when the caller is finished with the device.
1029 * If a device with the specified vendor and product id is not found,
1032 struct usb_device *usb_find_device(u16 vendor_id, u16 product_id)
1034 struct list_head *buslist;
1035 struct usb_bus *bus;
1036 struct usb_device *dev = NULL;
1038 down(&usb_bus_list_lock);
1039 for (buslist = usb_bus_list.next;
1040 buslist != &usb_bus_list;
1041 buslist = buslist->next) {
1042 bus = container_of(buslist, struct usb_bus, bus_list);
1045 usb_lock_device(bus->root_hub);
1046 dev = match_device(bus->root_hub, vendor_id, product_id);
1047 usb_unlock_device(bus->root_hub);
1052 up(&usb_bus_list_lock);
1057 * usb_get_current_frame_number - return current bus frame number
1058 * @dev: the device whose bus is being queried
1060 * Returns the current frame number for the USB host controller
1061 * used with the given USB device. This can be used when scheduling
1062 * isochronous requests.
1064 * Note that different kinds of host controller have different
1065 * "scheduling horizons". While one type might support scheduling only
1066 * 32 frames into the future, others could support scheduling up to
1067 * 1024 frames into the future.
1069 int usb_get_current_frame_number(struct usb_device *dev)
1071 return dev->bus->op->get_frame_number (dev);
1074 /*-------------------------------------------------------------------*/
1076 * __usb_get_extra_descriptor() finds a descriptor of specific type in the
1077 * extra field of the interface and endpoint descriptor structs.
1080 int __usb_get_extra_descriptor(char *buffer, unsigned size,
1081 unsigned char type, void **ptr)
1083 struct usb_descriptor_header *header;
1085 while (size >= sizeof(struct usb_descriptor_header)) {
1086 header = (struct usb_descriptor_header *)buffer;
1088 if (header->bLength < 2) {
1090 "%s: bogus descriptor, type %d length %d\n",
1092 header->bDescriptorType,
1097 if (header->bDescriptorType == type) {
1102 buffer += header->bLength;
1103 size -= header->bLength;
1109 * usb_buffer_alloc - allocate dma-consistent buffer for URB_NO_xxx_DMA_MAP
1110 * @dev: device the buffer will be used with
1111 * @size: requested buffer size
1112 * @mem_flags: affect whether allocation may block
1113 * @dma: used to return DMA address of buffer
1115 * Return value is either null (indicating no buffer could be allocated), or
1116 * the cpu-space pointer to a buffer that may be used to perform DMA to the
1117 * specified device. Such cpu-space buffers are returned along with the DMA
1118 * address (through the pointer provided).
1120 * These buffers are used with URB_NO_xxx_DMA_MAP set in urb->transfer_flags
1121 * to avoid behaviors like using "DMA bounce buffers", or tying down I/O
1122 * mapping hardware for long idle periods. The implementation varies between
1123 * platforms, depending on details of how DMA will work to this device.
1124 * Using these buffers also helps prevent cacheline sharing problems on
1125 * architectures where CPU caches are not DMA-coherent.
1127 * When the buffer is no longer used, free it with usb_buffer_free().
1129 void *usb_buffer_alloc (
1130 struct usb_device *dev,
1136 if (!dev || !dev->bus || !dev->bus->op || !dev->bus->op->buffer_alloc)
1138 return dev->bus->op->buffer_alloc (dev->bus, size, mem_flags, dma);
1142 * usb_buffer_free - free memory allocated with usb_buffer_alloc()
1143 * @dev: device the buffer was used with
1144 * @size: requested buffer size
1145 * @addr: CPU address of buffer
1146 * @dma: DMA address of buffer
1148 * This reclaims an I/O buffer, letting it be reused. The memory must have
1149 * been allocated using usb_buffer_alloc(), and the parameters must match
1150 * those provided in that allocation request.
1152 void usb_buffer_free (
1153 struct usb_device *dev,
1159 if (!dev || !dev->bus || !dev->bus->op || !dev->bus->op->buffer_free)
1161 dev->bus->op->buffer_free (dev->bus, size, addr, dma);
1165 * usb_buffer_map - create DMA mapping(s) for an urb
1166 * @urb: urb whose transfer_buffer/setup_packet will be mapped
1168 * Return value is either null (indicating no buffer could be mapped), or
1169 * the parameter. URB_NO_TRANSFER_DMA_MAP and URB_NO_SETUP_DMA_MAP are
1170 * added to urb->transfer_flags if the operation succeeds. If the device
1171 * is connected to this system through a non-DMA controller, this operation
1174 * This call would normally be used for an urb which is reused, perhaps
1175 * as the target of a large periodic transfer, with usb_buffer_dmasync()
1176 * calls to synchronize memory and dma state.
1178 * Reverse the effect of this call with usb_buffer_unmap().
1181 struct urb *usb_buffer_map (struct urb *urb)
1183 struct usb_bus *bus;
1184 struct device *controller;
1188 || !(bus = urb->dev->bus)
1189 || !(controller = bus->controller))
1192 if (controller->dma_mask) {
1193 urb->transfer_dma = dma_map_single (controller,
1194 urb->transfer_buffer, urb->transfer_buffer_length,
1195 usb_pipein (urb->pipe)
1196 ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
1197 if (usb_pipecontrol (urb->pipe))
1198 urb->setup_dma = dma_map_single (controller,
1200 sizeof (struct usb_ctrlrequest),
1202 // FIXME generic api broken like pci, can't report errors
1203 // if (urb->transfer_dma == DMA_ADDR_INVALID) return 0;
1205 urb->transfer_dma = ~0;
1206 urb->transfer_flags |= (URB_NO_TRANSFER_DMA_MAP
1207 | URB_NO_SETUP_DMA_MAP);
1212 /* XXX DISABLED, no users currently. If you wish to re-enable this
1213 * XXX please determine whether the sync is to transfer ownership of
1214 * XXX the buffer from device to cpu or vice verse, and thusly use the
1215 * XXX appropriate _for_{cpu,device}() method. -DaveM
1220 * usb_buffer_dmasync - synchronize DMA and CPU view of buffer(s)
1221 * @urb: urb whose transfer_buffer/setup_packet will be synchronized
1223 void usb_buffer_dmasync (struct urb *urb)
1225 struct usb_bus *bus;
1226 struct device *controller;
1229 || !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)
1231 || !(bus = urb->dev->bus)
1232 || !(controller = bus->controller))
1235 if (controller->dma_mask) {
1236 dma_sync_single (controller,
1237 urb->transfer_dma, urb->transfer_buffer_length,
1238 usb_pipein (urb->pipe)
1239 ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
1240 if (usb_pipecontrol (urb->pipe))
1241 dma_sync_single (controller,
1243 sizeof (struct usb_ctrlrequest),
1250 * usb_buffer_unmap - free DMA mapping(s) for an urb
1251 * @urb: urb whose transfer_buffer will be unmapped
1253 * Reverses the effect of usb_buffer_map().
1256 void usb_buffer_unmap (struct urb *urb)
1258 struct usb_bus *bus;
1259 struct device *controller;
1262 || !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)
1264 || !(bus = urb->dev->bus)
1265 || !(controller = bus->controller))
1268 if (controller->dma_mask) {
1269 dma_unmap_single (controller,
1270 urb->transfer_dma, urb->transfer_buffer_length,
1271 usb_pipein (urb->pipe)
1272 ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
1273 if (usb_pipecontrol (urb->pipe))
1274 dma_unmap_single (controller,
1276 sizeof (struct usb_ctrlrequest),
1279 urb->transfer_flags &= ~(URB_NO_TRANSFER_DMA_MAP
1280 | URB_NO_SETUP_DMA_MAP);
1285 * usb_buffer_map_sg - create scatterlist DMA mapping(s) for an endpoint
1286 * @dev: device to which the scatterlist will be mapped
1287 * @pipe: endpoint defining the mapping direction
1288 * @sg: the scatterlist to map
1289 * @nents: the number of entries in the scatterlist
1291 * Return value is either < 0 (indicating no buffers could be mapped), or
1292 * the number of DMA mapping array entries in the scatterlist.
1294 * The caller is responsible for placing the resulting DMA addresses from
1295 * the scatterlist into URB transfer buffer pointers, and for setting the
1296 * URB_NO_TRANSFER_DMA_MAP transfer flag in each of those URBs.
1298 * Top I/O rates come from queuing URBs, instead of waiting for each one
1299 * to complete before starting the next I/O. This is particularly easy
1300 * to do with scatterlists. Just allocate and submit one URB for each DMA
1301 * mapping entry returned, stopping on the first error or when all succeed.
1302 * Better yet, use the usb_sg_*() calls, which do that (and more) for you.
1304 * This call would normally be used when translating scatterlist requests,
1305 * rather than usb_buffer_map(), since on some hardware (with IOMMUs) it
1306 * may be able to coalesce mappings for improved I/O efficiency.
1308 * Reverse the effect of this call with usb_buffer_unmap_sg().
1310 int usb_buffer_map_sg (struct usb_device *dev, unsigned pipe,
1311 struct scatterlist *sg, int nents)
1313 struct usb_bus *bus;
1314 struct device *controller;
1317 || usb_pipecontrol (pipe)
1318 || !(bus = dev->bus)
1319 || !(controller = bus->controller)
1320 || !controller->dma_mask)
1323 // FIXME generic api broken like pci, can't report errors
1324 return dma_map_sg (controller, sg, nents,
1325 usb_pipein (pipe) ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
1328 /* XXX DISABLED, no users currently. If you wish to re-enable this
1329 * XXX please determine whether the sync is to transfer ownership of
1330 * XXX the buffer from device to cpu or vice verse, and thusly use the
1331 * XXX appropriate _for_{cpu,device}() method. -DaveM
1336 * usb_buffer_dmasync_sg - synchronize DMA and CPU view of scatterlist buffer(s)
1337 * @dev: device to which the scatterlist will be mapped
1338 * @pipe: endpoint defining the mapping direction
1339 * @sg: the scatterlist to synchronize
1340 * @n_hw_ents: the positive return value from usb_buffer_map_sg
1342 * Use this when you are re-using a scatterlist's data buffers for
1343 * another USB request.
1345 void usb_buffer_dmasync_sg (struct usb_device *dev, unsigned pipe,
1346 struct scatterlist *sg, int n_hw_ents)
1348 struct usb_bus *bus;
1349 struct device *controller;
1352 || !(bus = dev->bus)
1353 || !(controller = bus->controller)
1354 || !controller->dma_mask)
1357 dma_sync_sg (controller, sg, n_hw_ents,
1358 usb_pipein (pipe) ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
1363 * usb_buffer_unmap_sg - free DMA mapping(s) for a scatterlist
1364 * @dev: device to which the scatterlist will be mapped
1365 * @pipe: endpoint defining the mapping direction
1366 * @sg: the scatterlist to unmap
1367 * @n_hw_ents: the positive return value from usb_buffer_map_sg
1369 * Reverses the effect of usb_buffer_map_sg().
1371 void usb_buffer_unmap_sg (struct usb_device *dev, unsigned pipe,
1372 struct scatterlist *sg, int n_hw_ents)
1374 struct usb_bus *bus;
1375 struct device *controller;
1378 || !(bus = dev->bus)
1379 || !(controller = bus->controller)
1380 || !controller->dma_mask)
1383 dma_unmap_sg (controller, sg, n_hw_ents,
1384 usb_pipein (pipe) ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
1387 static int verify_suspended(struct device *dev, void *unused)
1389 return (dev->power.power_state.event == PM_EVENT_ON) ? -EBUSY : 0;
1392 static int usb_generic_suspend(struct device *dev, pm_message_t message)
1394 struct usb_interface *intf;
1395 struct usb_driver *driver;
1398 /* USB devices enter SUSPEND state through their hubs, but can be
1399 * marked for FREEZE as soon as their children are already idled.
1400 * But those semantics are useless, so we equate the two (sigh).
1402 if (dev->driver == &usb_generic_driver) {
1403 if (dev->power.power_state.event == message.event)
1405 /* we need to rule out bogus requests through sysfs */
1406 status = device_for_each_child(dev, NULL, verify_suspended);
1409 return usb_suspend_device (to_usb_device(dev));
1412 if ((dev->driver == NULL) ||
1413 (dev->driver_data == &usb_generic_driver_data))
1416 intf = to_usb_interface(dev);
1417 driver = to_usb_driver(dev->driver);
1419 /* with no hardware, USB interfaces only use FREEZE and ON states */
1420 if (!is_active(intf))
1423 if (driver->suspend && driver->resume) {
1424 status = driver->suspend(intf, message);
1426 dev_err(dev, "%s error %d\n", "suspend", status);
1428 mark_quiesced(intf);
1430 // FIXME else if there's no suspend method, disconnect...
1431 dev_warn(dev, "no suspend for driver %s?\n", driver->name);
1432 mark_quiesced(intf);
1438 static int usb_generic_resume(struct device *dev)
1440 struct usb_interface *intf;
1441 struct usb_driver *driver;
1442 struct usb_device *udev;
1445 if (dev->power.power_state.event == PM_EVENT_ON)
1448 /* mark things as "on" immediately, no matter what errors crop up */
1449 dev->power.power_state.event = PM_EVENT_ON;
1451 /* devices resume through their hubs */
1452 if (dev->driver == &usb_generic_driver) {
1453 udev = to_usb_device(dev);
1454 if (udev->state == USB_STATE_NOTATTACHED)
1456 return usb_resume_device (to_usb_device(dev));
1459 if ((dev->driver == NULL) ||
1460 (dev->driver_data == &usb_generic_driver_data)) {
1461 dev->power.power_state.event = PM_EVENT_FREEZE;
1465 intf = to_usb_interface(dev);
1466 driver = to_usb_driver(dev->driver);
1468 udev = interface_to_usbdev(intf);
1469 if (udev->state == USB_STATE_NOTATTACHED)
1472 /* if driver was suspended, it has a resume method;
1473 * however, sysfs can wrongly mark things as suspended
1474 * (on the "no suspend method" FIXME path above)
1476 if (driver->resume) {
1477 status = driver->resume(intf);
1479 dev_err(dev, "%s error %d\n", "resume", status);
1480 mark_quiesced(intf);
1483 dev_warn(dev, "no resume for driver %s?\n", driver->name);
1487 struct bus_type usb_bus_type = {
1489 .match = usb_device_match,
1490 .uevent = usb_uevent,
1491 .suspend = usb_generic_suspend,
1492 .resume = usb_generic_resume,
1497 static int __init usb_setup_disable(char *str)
1503 /* format to disable USB on kernel command line is: nousb */
1504 __setup("nousb", usb_setup_disable);
1509 * for external read access to <nousb>
1511 int usb_disabled(void)
1519 static int __init usb_init(void)
1523 pr_info ("%s: USB support disabled\n", usbcore_name);
1527 retval = bus_register(&usb_bus_type);
1530 retval = usb_host_init();
1532 goto host_init_failed;
1533 retval = usb_major_init();
1535 goto major_init_failed;
1536 retval = usb_register(&usbfs_driver);
1538 goto driver_register_failed;
1539 retval = usbdev_init();
1541 goto usbdevice_init_failed;
1542 retval = usbfs_init();
1544 goto fs_init_failed;
1545 retval = usb_hub_init();
1547 goto hub_init_failed;
1548 retval = driver_register(&usb_generic_driver);
1557 usbdevice_init_failed:
1558 usb_deregister(&usbfs_driver);
1559 driver_register_failed:
1560 usb_major_cleanup();
1564 bus_unregister(&usb_bus_type);
1572 static void __exit usb_exit(void)
1574 /* This will matter if shutdown/reboot does exitcalls. */
1578 driver_unregister(&usb_generic_driver);
1579 usb_major_cleanup();
1581 usb_deregister(&usbfs_driver);
1585 bus_unregister(&usb_bus_type);
1588 subsys_initcall(usb_init);
1589 module_exit(usb_exit);
1592 * USB may be built into the kernel or be built as modules.
1593 * These symbols are exported for device (or host controller)
1594 * driver modules to use.
1597 EXPORT_SYMBOL(usb_register);
1598 EXPORT_SYMBOL(usb_deregister);
1599 EXPORT_SYMBOL(usb_disabled);
1601 EXPORT_SYMBOL_GPL(usb_get_intf);
1602 EXPORT_SYMBOL_GPL(usb_put_intf);
1604 EXPORT_SYMBOL(usb_alloc_dev);
1605 EXPORT_SYMBOL(usb_put_dev);
1606 EXPORT_SYMBOL(usb_get_dev);
1607 EXPORT_SYMBOL(usb_hub_tt_clear_buffer);
1609 EXPORT_SYMBOL(usb_lock_device);
1610 EXPORT_SYMBOL(usb_trylock_device);
1611 EXPORT_SYMBOL(usb_lock_device_for_reset);
1612 EXPORT_SYMBOL(usb_unlock_device);
1614 EXPORT_SYMBOL(usb_driver_claim_interface);
1615 EXPORT_SYMBOL(usb_driver_release_interface);
1616 EXPORT_SYMBOL(usb_match_id);
1617 EXPORT_SYMBOL(usb_find_interface);
1618 EXPORT_SYMBOL(usb_ifnum_to_if);
1619 EXPORT_SYMBOL(usb_altnum_to_altsetting);
1621 EXPORT_SYMBOL(usb_reset_device);
1622 EXPORT_SYMBOL(usb_disconnect);
1624 EXPORT_SYMBOL(__usb_get_extra_descriptor);
1626 EXPORT_SYMBOL(usb_find_device);
1627 EXPORT_SYMBOL(usb_get_current_frame_number);
1629 EXPORT_SYMBOL (usb_buffer_alloc);
1630 EXPORT_SYMBOL (usb_buffer_free);
1633 EXPORT_SYMBOL (usb_buffer_map);
1634 EXPORT_SYMBOL (usb_buffer_dmasync);
1635 EXPORT_SYMBOL (usb_buffer_unmap);
1638 EXPORT_SYMBOL (usb_buffer_map_sg);
1640 EXPORT_SYMBOL (usb_buffer_dmasync_sg);
1642 EXPORT_SYMBOL (usb_buffer_unmap_sg);
1644 MODULE_LICENSE("GPL");