blob: 4eca4904938fcb72bf25eb52a6babe10970c5d09 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * drivers/usb/usb.c
3 *
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
14 *
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..
18 *
19 * Think of this as a "USB library" rather than anything else.
20 * It should be considered a slave, with no callbacks. Callbacks
21 * are evil.
22 */
23
24#include <linux/config.h>
25
26#ifdef CONFIG_USB_DEBUG
27 #define DEBUG
28#else
29 #undef DEBUG
30#endif
31
32#include <linux/module.h>
33#include <linux/string.h>
34#include <linux/bitops.h>
35#include <linux/slab.h>
36#include <linux/interrupt.h> /* for in_interrupt() */
37#include <linux/kmod.h>
38#include <linux/init.h>
39#include <linux/spinlock.h>
40#include <linux/errno.h>
41#include <linux/smp_lock.h>
42#include <linux/rwsem.h>
43#include <linux/usb.h>
44
45#include <asm/io.h>
46#include <asm/scatterlist.h>
47#include <linux/mm.h>
48#include <linux/dma-mapping.h>
49
50#include "hcd.h"
51#include "usb.h"
52
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
54const char *usbcore_name = "usbcore";
55
56static int nousb; /* Disable USB when built into kernel image */
57 /* Not honored on modular build */
58
59static DECLARE_RWSEM(usb_all_devices_rwsem);
60
61
62static int generic_probe (struct device *dev)
63{
64 return 0;
65}
66static int generic_remove (struct device *dev)
67{
Alan Stern3b4d7f72005-08-11 15:50:32 -040068 struct usb_device *udev = to_usb_device(dev);
69
70 /* if this is only an unbind, not a physical disconnect, then
71 * unconfigure the device */
72 if (udev->state == USB_STATE_CONFIGURED)
73 usb_set_configuration(udev, 0);
74
75 /* in case the call failed or the device was suspended */
76 if (udev->state >= USB_STATE_CONFIGURED)
77 usb_disable_device(udev, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 return 0;
79}
80
81static struct device_driver usb_generic_driver = {
82 .owner = THIS_MODULE,
83 .name = "usb",
84 .bus = &usb_bus_type,
85 .probe = generic_probe,
86 .remove = generic_remove,
87};
88
89static int usb_generic_driver_data;
90
91/* called from driver core with usb_bus_type.subsys writelock */
92static int usb_probe_interface(struct device *dev)
93{
94 struct usb_interface * intf = to_usb_interface(dev);
95 struct usb_driver * driver = to_usb_driver(dev->driver);
96 const struct usb_device_id *id;
97 int error = -ENODEV;
98
99 dev_dbg(dev, "%s\n", __FUNCTION__);
100
101 if (!driver->probe)
102 return error;
103 /* FIXME we'd much prefer to just resume it ... */
104 if (interface_to_usbdev(intf)->state == USB_STATE_SUSPENDED)
105 return -EHOSTUNREACH;
106
107 id = usb_match_id (intf, driver->id_table);
108 if (id) {
109 dev_dbg (dev, "%s - got id\n", __FUNCTION__);
David Brownelldb690872005-09-13 19:56:33 -0700110
111 /* Interface "power state" doesn't correspond to any hardware
112 * state whatsoever. We use it to record when it's bound to
113 * a driver that may start I/0: it's not frozen/quiesced.
114 */
115 mark_active(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 intf->condition = USB_INTERFACE_BINDING;
117 error = driver->probe (intf, id);
David Brownelldb690872005-09-13 19:56:33 -0700118 if (error) {
119 mark_quiesced(intf);
120 intf->condition = USB_INTERFACE_UNBOUND;
121 } else
122 intf->condition = USB_INTERFACE_BOUND;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123 }
124
125 return error;
126}
127
128/* called from driver core with usb_bus_type.subsys writelock */
129static int usb_unbind_interface(struct device *dev)
130{
131 struct usb_interface *intf = to_usb_interface(dev);
132 struct usb_driver *driver = to_usb_driver(intf->dev.driver);
133
134 intf->condition = USB_INTERFACE_UNBINDING;
135
136 /* release all urbs for this interface */
137 usb_disable_interface(interface_to_usbdev(intf), intf);
138
139 if (driver && driver->disconnect)
140 driver->disconnect(intf);
141
142 /* reset other interface state */
143 usb_set_interface(interface_to_usbdev(intf),
144 intf->altsetting[0].desc.bInterfaceNumber,
145 0);
146 usb_set_intfdata(intf, NULL);
147 intf->condition = USB_INTERFACE_UNBOUND;
David Brownelldb690872005-09-13 19:56:33 -0700148 mark_quiesced(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149
150 return 0;
151}
152
153/**
154 * usb_register - register a USB driver
155 * @new_driver: USB operations for the driver
156 *
157 * Registers a USB driver with the USB core. The list of unattached
158 * interfaces will be rescanned whenever a new driver is added, allowing
159 * the new driver to attach to any recognized devices.
160 * Returns a negative error code on failure and 0 on success.
161 *
162 * NOTE: if you want your driver to use the USB major number, you must call
163 * usb_register_dev() to enable that functionality. This function no longer
164 * takes care of that.
165 */
166int usb_register(struct usb_driver *new_driver)
167{
168 int retval = 0;
169
170 if (nousb)
171 return -ENODEV;
172
173 new_driver->driver.name = (char *)new_driver->name;
174 new_driver->driver.bus = &usb_bus_type;
175 new_driver->driver.probe = usb_probe_interface;
176 new_driver->driver.remove = usb_unbind_interface;
177 new_driver->driver.owner = new_driver->owner;
178
179 usb_lock_all_devices();
180 retval = driver_register(&new_driver->driver);
181 usb_unlock_all_devices();
182
183 if (!retval) {
184 pr_info("%s: registered new driver %s\n",
185 usbcore_name, new_driver->name);
186 usbfs_update_special();
187 } else {
188 printk(KERN_ERR "%s: error %d registering driver %s\n",
189 usbcore_name, retval, new_driver->name);
190 }
191
192 return retval;
193}
194
195/**
196 * usb_deregister - unregister a USB driver
197 * @driver: USB operations of the driver to unregister
198 * Context: must be able to sleep
199 *
200 * Unlinks the specified driver from the internal USB driver list.
201 *
202 * NOTE: If you called usb_register_dev(), you still need to call
203 * usb_deregister_dev() to clean up your driver's allocated minor numbers,
204 * this * call will no longer do it for you.
205 */
206void usb_deregister(struct usb_driver *driver)
207{
208 pr_info("%s: deregistering driver %s\n", usbcore_name, driver->name);
209
210 usb_lock_all_devices();
211 driver_unregister (&driver->driver);
212 usb_unlock_all_devices();
213
214 usbfs_update_special();
215}
216
217/**
218 * usb_ifnum_to_if - get the interface object with a given interface number
219 * @dev: the device whose current configuration is considered
220 * @ifnum: the desired interface
221 *
222 * This walks the device descriptor for the currently active configuration
223 * and returns a pointer to the interface with that particular interface
224 * number, or null.
225 *
226 * Note that configuration descriptors are not required to assign interface
227 * numbers sequentially, so that it would be incorrect to assume that
228 * the first interface in that descriptor corresponds to interface zero.
229 * This routine helps device drivers avoid such mistakes.
230 * However, you should make sure that you do the right thing with any
231 * alternate settings available for this interfaces.
232 *
233 * Don't call this function unless you are bound to one of the interfaces
234 * on this device or you have locked the device!
235 */
236struct usb_interface *usb_ifnum_to_if(struct usb_device *dev, unsigned ifnum)
237{
238 struct usb_host_config *config = dev->actconfig;
239 int i;
240
241 if (!config)
242 return NULL;
243 for (i = 0; i < config->desc.bNumInterfaces; i++)
244 if (config->interface[i]->altsetting[0]
245 .desc.bInterfaceNumber == ifnum)
246 return config->interface[i];
247
248 return NULL;
249}
250
251/**
252 * usb_altnum_to_altsetting - get the altsetting structure with a given
253 * alternate setting number.
254 * @intf: the interface containing the altsetting in question
255 * @altnum: the desired alternate setting number
256 *
257 * This searches the altsetting array of the specified interface for
258 * an entry with the correct bAlternateSetting value and returns a pointer
259 * to that entry, or null.
260 *
261 * Note that altsettings need not be stored sequentially by number, so
262 * it would be incorrect to assume that the first altsetting entry in
263 * the array corresponds to altsetting zero. This routine helps device
264 * drivers avoid such mistakes.
265 *
266 * Don't call this function unless you are bound to the intf interface
267 * or you have locked the device!
268 */
269struct usb_host_interface *usb_altnum_to_altsetting(struct usb_interface *intf,
270 unsigned int altnum)
271{
272 int i;
273
274 for (i = 0; i < intf->num_altsetting; i++) {
275 if (intf->altsetting[i].desc.bAlternateSetting == altnum)
276 return &intf->altsetting[i];
277 }
278 return NULL;
279}
280
281/**
282 * usb_driver_claim_interface - bind a driver to an interface
283 * @driver: the driver to be bound
284 * @iface: the interface to which it will be bound; must be in the
285 * usb device's active configuration
286 * @priv: driver data associated with that interface
287 *
288 * This is used by usb device drivers that need to claim more than one
289 * interface on a device when probing (audio and acm are current examples).
290 * No device driver should directly modify internal usb_interface or
291 * usb_device structure members.
292 *
293 * Few drivers should need to use this routine, since the most natural
294 * way to bind to an interface is to return the private data from
295 * the driver's probe() method.
296 *
297 * Callers must own the device lock and the driver model's usb_bus_type.subsys
298 * writelock. So driver probe() entries don't need extra locking,
299 * but other call contexts may need to explicitly claim those locks.
300 */
301int usb_driver_claim_interface(struct usb_driver *driver,
302 struct usb_interface *iface, void* priv)
303{
304 struct device *dev = &iface->dev;
305
306 if (dev->driver)
307 return -EBUSY;
308
309 dev->driver = &driver->driver;
310 usb_set_intfdata(iface, priv);
311 iface->condition = USB_INTERFACE_BOUND;
David Brownelldb690872005-09-13 19:56:33 -0700312 mark_active(iface);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
314 /* if interface was already added, bind now; else let
315 * the future device_add() bind it, bypassing probe()
316 */
Daniel Ritzd305ef52005-09-22 00:47:24 -0700317 if (device_is_registered(dev))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318 device_bind_driver(dev);
319
320 return 0;
321}
322
323/**
324 * usb_driver_release_interface - unbind a driver from an interface
325 * @driver: the driver to be unbound
326 * @iface: the interface from which it will be unbound
327 *
328 * This can be used by drivers to release an interface without waiting
329 * for their disconnect() methods to be called. In typical cases this
330 * also causes the driver disconnect() method to be called.
331 *
332 * This call is synchronous, and may not be used in an interrupt context.
333 * Callers must own the device lock and the driver model's usb_bus_type.subsys
334 * writelock. So driver disconnect() entries don't need extra locking,
335 * but other call contexts may need to explicitly claim those locks.
336 */
337void usb_driver_release_interface(struct usb_driver *driver,
338 struct usb_interface *iface)
339{
340 struct device *dev = &iface->dev;
341
342 /* this should never happen, don't release something that's not ours */
343 if (!dev->driver || dev->driver != &driver->driver)
344 return;
345
Alan Sternf4096612005-05-06 15:41:08 -0400346 /* don't release from within disconnect() */
347 if (iface->condition != USB_INTERFACE_BOUND)
348 return;
349
Daniel Ritzd305ef52005-09-22 00:47:24 -0700350 /* don't release if the interface hasn't been added yet */
351 if (device_is_registered(dev)) {
Alan Sternf4096612005-05-06 15:41:08 -0400352 iface->condition = USB_INTERFACE_UNBINDING;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 device_release_driver(dev);
Alan Sternf4096612005-05-06 15:41:08 -0400354 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355
356 dev->driver = NULL;
357 usb_set_intfdata(iface, NULL);
358 iface->condition = USB_INTERFACE_UNBOUND;
David Brownelldb690872005-09-13 19:56:33 -0700359 mark_quiesced(iface);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360}
361
362/**
363 * usb_match_id - find first usb_device_id matching device or interface
364 * @interface: the interface of interest
365 * @id: array of usb_device_id structures, terminated by zero entry
366 *
367 * usb_match_id searches an array of usb_device_id's and returns
368 * the first one matching the device or interface, or null.
369 * This is used when binding (or rebinding) a driver to an interface.
370 * Most USB device drivers will use this indirectly, through the usb core,
371 * but some layered driver frameworks use it directly.
372 * These device tables are exported with MODULE_DEVICE_TABLE, through
373 * modutils and "modules.usbmap", to support the driver loading
374 * functionality of USB hotplugging.
375 *
376 * What Matches:
377 *
378 * The "match_flags" element in a usb_device_id controls which
379 * members are used. If the corresponding bit is set, the
380 * value in the device_id must match its corresponding member
381 * in the device or interface descriptor, or else the device_id
382 * does not match.
383 *
384 * "driver_info" is normally used only by device drivers,
385 * but you can create a wildcard "matches anything" usb_device_id
386 * as a driver's "modules.usbmap" entry if you provide an id with
387 * only a nonzero "driver_info" field. If you do this, the USB device
388 * driver's probe() routine should use additional intelligence to
389 * decide whether to bind to the specified interface.
390 *
391 * What Makes Good usb_device_id Tables:
392 *
393 * The match algorithm is very simple, so that intelligence in
394 * driver selection must come from smart driver id records.
395 * Unless you have good reasons to use another selection policy,
396 * provide match elements only in related groups, and order match
397 * specifiers from specific to general. Use the macros provided
398 * for that purpose if you can.
399 *
400 * The most specific match specifiers use device descriptor
401 * data. These are commonly used with product-specific matches;
402 * the USB_DEVICE macro lets you provide vendor and product IDs,
403 * and you can also match against ranges of product revisions.
404 * These are widely used for devices with application or vendor
405 * specific bDeviceClass values.
406 *
407 * Matches based on device class/subclass/protocol specifications
408 * are slightly more general; use the USB_DEVICE_INFO macro, or
409 * its siblings. These are used with single-function devices
410 * where bDeviceClass doesn't specify that each interface has
411 * its own class.
412 *
413 * Matches based on interface class/subclass/protocol are the
414 * most general; they let drivers bind to any interface on a
415 * multiple-function device. Use the USB_INTERFACE_INFO
416 * macro, or its siblings, to match class-per-interface style
417 * devices (as recorded in bDeviceClass).
418 *
419 * Within those groups, remember that not all combinations are
420 * meaningful. For example, don't give a product version range
421 * without vendor and product IDs; or specify a protocol without
422 * its associated class and subclass.
423 */
424const struct usb_device_id *
425usb_match_id(struct usb_interface *interface, const struct usb_device_id *id)
426{
427 struct usb_host_interface *intf;
428 struct usb_device *dev;
429
430 /* proc_connectinfo in devio.c may call us with id == NULL. */
431 if (id == NULL)
432 return NULL;
433
434 intf = interface->cur_altsetting;
435 dev = interface_to_usbdev(interface);
436
437 /* It is important to check that id->driver_info is nonzero,
438 since an entry that is all zeroes except for a nonzero
439 id->driver_info is the way to create an entry that
440 indicates that the driver want to examine every
441 device and interface. */
442 for (; id->idVendor || id->bDeviceClass || id->bInterfaceClass ||
443 id->driver_info; id++) {
444
445 if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
446 id->idVendor != le16_to_cpu(dev->descriptor.idVendor))
447 continue;
448
449 if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) &&
450 id->idProduct != le16_to_cpu(dev->descriptor.idProduct))
451 continue;
452
453 /* No need to test id->bcdDevice_lo != 0, since 0 is never
454 greater than any unsigned number. */
455 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO) &&
456 (id->bcdDevice_lo > le16_to_cpu(dev->descriptor.bcdDevice)))
457 continue;
458
459 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) &&
460 (id->bcdDevice_hi < le16_to_cpu(dev->descriptor.bcdDevice)))
461 continue;
462
463 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) &&
464 (id->bDeviceClass != dev->descriptor.bDeviceClass))
465 continue;
466
467 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) &&
468 (id->bDeviceSubClass!= dev->descriptor.bDeviceSubClass))
469 continue;
470
471 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) &&
472 (id->bDeviceProtocol != dev->descriptor.bDeviceProtocol))
473 continue;
474
475 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) &&
476 (id->bInterfaceClass != intf->desc.bInterfaceClass))
477 continue;
478
479 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) &&
480 (id->bInterfaceSubClass != intf->desc.bInterfaceSubClass))
481 continue;
482
483 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) &&
484 (id->bInterfaceProtocol != intf->desc.bInterfaceProtocol))
485 continue;
486
487 return id;
488 }
489
490 return NULL;
491}
492
mochel@digitalimplant.org6034a082005-03-21 11:09:40 -0800493
494static int __find_interface(struct device * dev, void * data)
495{
496 struct usb_interface ** ret = (struct usb_interface **)data;
497 struct usb_interface * intf = *ret;
498 int *minor = (int *)data;
499
500 /* can't look at usb devices, only interfaces */
501 if (dev->driver == &usb_generic_driver)
502 return 0;
503
504 intf = to_usb_interface(dev);
505 if (intf->minor != -1 && intf->minor == *minor) {
506 *ret = intf;
507 return 1;
508 }
509 return 0;
510}
511
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512/**
513 * usb_find_interface - find usb_interface pointer for driver and device
514 * @drv: the driver whose current configuration is considered
515 * @minor: the minor number of the desired device
516 *
517 * This walks the driver device list and returns a pointer to the interface
518 * with the matching minor. Note, this only works for devices that share the
519 * USB major number.
520 */
521struct usb_interface *usb_find_interface(struct usb_driver *drv, int minor)
522{
gregkh@suse.deff710712005-03-24 00:44:28 -0800523 struct usb_interface *intf = (struct usb_interface *)(long)minor;
mochel@digitalimplant.org6034a082005-03-21 11:09:40 -0800524 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
mochel@digitalimplant.org6034a082005-03-21 11:09:40 -0800526 ret = driver_for_each_device(&drv->driver, NULL, &intf, __find_interface);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527
mochel@digitalimplant.org6034a082005-03-21 11:09:40 -0800528 return ret ? intf : NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529}
530
531static int usb_device_match (struct device *dev, struct device_driver *drv)
532{
533 struct usb_interface *intf;
534 struct usb_driver *usb_drv;
535 const struct usb_device_id *id;
536
537 /* check for generic driver, which we don't match any device with */
538 if (drv == &usb_generic_driver)
539 return 0;
540
541 intf = to_usb_interface(dev);
542 usb_drv = to_usb_driver(drv);
543
544 id = usb_match_id (intf, usb_drv->id_table);
545 if (id)
546 return 1;
547
548 return 0;
549}
550
551
552#ifdef CONFIG_HOTPLUG
553
554/*
555 * USB hotplugging invokes what /proc/sys/kernel/hotplug says
556 * (normally /sbin/hotplug) when USB devices get added or removed.
557 *
558 * This invokes a user mode policy agent, typically helping to load driver
559 * or other modules, configure the device, and more. Drivers can provide
560 * a MODULE_DEVICE_TABLE to help with module loading subtasks.
561 *
562 * We're called either from khubd (the typical case) or from root hub
563 * (init, kapmd, modprobe, rmmod, etc), but the agents need to handle
564 * delays in event delivery. Use sysfs (and DEVPATH) to make sure the
565 * device (and this configuration!) are still present.
566 */
567static int usb_hotplug (struct device *dev, char **envp, int num_envp,
568 char *buffer, int buffer_size)
569{
570 struct usb_interface *intf;
571 struct usb_device *usb_dev;
Greg Kroah-Hartman75218032005-06-20 21:15:16 -0700572 struct usb_host_interface *alt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 int i = 0;
574 int length = 0;
575
576 if (!dev)
577 return -ENODEV;
578
579 /* driver is often null here; dev_dbg() would oops */
580 pr_debug ("usb %s: hotplug\n", dev->bus_id);
581
582 /* Must check driver_data here, as on remove driver is always NULL */
583 if ((dev->driver == &usb_generic_driver) ||
584 (dev->driver_data == &usb_generic_driver_data))
585 return 0;
586
587 intf = to_usb_interface(dev);
588 usb_dev = interface_to_usbdev (intf);
Greg Kroah-Hartman75218032005-06-20 21:15:16 -0700589 alt = intf->cur_altsetting;
590
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 if (usb_dev->devnum < 0) {
592 pr_debug ("usb %s: already deleted?\n", dev->bus_id);
593 return -ENODEV;
594 }
595 if (!usb_dev->bus) {
596 pr_debug ("usb %s: bus removed?\n", dev->bus_id);
597 return -ENODEV;
598 }
599
600#ifdef CONFIG_USB_DEVICEFS
601 /* If this is available, userspace programs can directly read
602 * all the device descriptors we don't tell them about. Or
603 * even act as usermode drivers.
604 *
605 * FIXME reduce hardwired intelligence here
606 */
607 if (add_hotplug_env_var(envp, num_envp, &i,
608 buffer, buffer_size, &length,
609 "DEVICE=/proc/bus/usb/%03d/%03d",
610 usb_dev->bus->busnum, usb_dev->devnum))
611 return -ENOMEM;
612#endif
613
614 /* per-device configurations are common */
615 if (add_hotplug_env_var(envp, num_envp, &i,
616 buffer, buffer_size, &length,
617 "PRODUCT=%x/%x/%x",
618 le16_to_cpu(usb_dev->descriptor.idVendor),
619 le16_to_cpu(usb_dev->descriptor.idProduct),
620 le16_to_cpu(usb_dev->descriptor.bcdDevice)))
621 return -ENOMEM;
622
623 /* class-based driver binding models */
624 if (add_hotplug_env_var(envp, num_envp, &i,
625 buffer, buffer_size, &length,
626 "TYPE=%d/%d/%d",
627 usb_dev->descriptor.bDeviceClass,
628 usb_dev->descriptor.bDeviceSubClass,
629 usb_dev->descriptor.bDeviceProtocol))
630 return -ENOMEM;
631
Greg Kroah-Hartman75218032005-06-20 21:15:16 -0700632 if (add_hotplug_env_var(envp, num_envp, &i,
633 buffer, buffer_size, &length,
634 "INTERFACE=%d/%d/%d",
635 alt->desc.bInterfaceClass,
636 alt->desc.bInterfaceSubClass,
637 alt->desc.bInterfaceProtocol))
638 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639
Greg Kroah-Hartman75218032005-06-20 21:15:16 -0700640 if (add_hotplug_env_var(envp, num_envp, &i,
641 buffer, buffer_size, &length,
642 "MODALIAS=usb:v%04Xp%04Xd%04Xdc%02Xdsc%02Xdp%02Xic%02Xisc%02Xip%02X",
643 le16_to_cpu(usb_dev->descriptor.idVendor),
644 le16_to_cpu(usb_dev->descriptor.idProduct),
645 le16_to_cpu(usb_dev->descriptor.bcdDevice),
646 usb_dev->descriptor.bDeviceClass,
647 usb_dev->descriptor.bDeviceSubClass,
648 usb_dev->descriptor.bDeviceProtocol,
649 alt->desc.bInterfaceClass,
650 alt->desc.bInterfaceSubClass,
651 alt->desc.bInterfaceProtocol))
652 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653
654 envp[i] = NULL;
655
656 return 0;
657}
658
659#else
660
661static int usb_hotplug (struct device *dev, char **envp,
662 int num_envp, char *buffer, int buffer_size)
663{
664 return -ENODEV;
665}
666
667#endif /* CONFIG_HOTPLUG */
668
669/**
670 * usb_release_dev - free a usb device structure when all users of it are finished.
671 * @dev: device that's been disconnected
672 *
673 * Will be called only by the device core when all users of this usb device are
674 * done.
675 */
676static void usb_release_dev(struct device *dev)
677{
678 struct usb_device *udev;
679
680 udev = to_usb_device(dev);
681
682 usb_destroy_configuration(udev);
683 usb_bus_put(udev->bus);
684 kfree(udev->product);
685 kfree(udev->manufacturer);
686 kfree(udev->serial);
687 kfree(udev);
688}
689
690/**
691 * usb_alloc_dev - usb device constructor (usbcore-internal)
692 * @parent: hub to which device is connected; null to allocate a root hub
693 * @bus: bus used to access the device
694 * @port1: one-based index of port; ignored for root hubs
695 * Context: !in_interrupt ()
696 *
697 * Only hub drivers (including virtual root hub drivers for host
698 * controllers) should ever call this.
699 *
700 * This call may not be used in a non-sleeping context.
701 */
702struct usb_device *
703usb_alloc_dev(struct usb_device *parent, struct usb_bus *bus, unsigned port1)
704{
705 struct usb_device *dev;
706
707 dev = kmalloc(sizeof(*dev), GFP_KERNEL);
708 if (!dev)
709 return NULL;
710
711 memset(dev, 0, sizeof(*dev));
712
713 bus = usb_bus_get(bus);
714 if (!bus) {
715 kfree(dev);
716 return NULL;
717 }
718
719 device_initialize(&dev->dev);
720 dev->dev.bus = &usb_bus_type;
721 dev->dev.dma_mask = bus->controller->dma_mask;
722 dev->dev.driver_data = &usb_generic_driver_data;
723 dev->dev.driver = &usb_generic_driver;
724 dev->dev.release = usb_release_dev;
725 dev->state = USB_STATE_ATTACHED;
726
727 INIT_LIST_HEAD(&dev->ep0.urb_list);
728 dev->ep0.desc.bLength = USB_DT_ENDPOINT_SIZE;
729 dev->ep0.desc.bDescriptorType = USB_DT_ENDPOINT;
730 /* ep0 maxpacket comes later, from device descriptor */
731 dev->ep_in[0] = dev->ep_out[0] = &dev->ep0;
732
733 /* Save readable and stable topology id, distinguishing devices
734 * by location for diagnostics, tools, driver model, etc. The
735 * string is a path along hub ports, from the root. Each device's
736 * dev->devpath will be stable until USB is re-cabled, and hubs
737 * are often labeled with these port numbers. The bus_id isn't
738 * as stable: bus->busnum changes easily from modprobe order,
739 * cardbus or pci hotplugging, and so on.
740 */
741 if (unlikely (!parent)) {
742 dev->devpath [0] = '0';
743
744 dev->dev.parent = bus->controller;
745 sprintf (&dev->dev.bus_id[0], "usb%d", bus->busnum);
746 } else {
747 /* match any labeling on the hubs; it's one-based */
748 if (parent->devpath [0] == '0')
749 snprintf (dev->devpath, sizeof dev->devpath,
750 "%d", port1);
751 else
752 snprintf (dev->devpath, sizeof dev->devpath,
753 "%s.%d", parent->devpath, port1);
754
755 dev->dev.parent = &parent->dev;
756 sprintf (&dev->dev.bus_id[0], "%d-%s",
757 bus->busnum, dev->devpath);
758
759 /* hub driver sets up TT records */
760 }
761
762 dev->bus = bus;
763 dev->parent = parent;
764 INIT_LIST_HEAD(&dev->filelist);
765
766 init_MUTEX(&dev->serialize);
767
768 return dev;
769}
770
771/**
772 * usb_get_dev - increments the reference count of the usb device structure
773 * @dev: the device being referenced
774 *
775 * Each live reference to a device should be refcounted.
776 *
777 * Drivers for USB interfaces should normally record such references in
778 * their probe() methods, when they bind to an interface, and release
779 * them by calling usb_put_dev(), in their disconnect() methods.
780 *
781 * A pointer to the device with the incremented reference counter is returned.
782 */
783struct usb_device *usb_get_dev(struct usb_device *dev)
784{
785 if (dev)
786 get_device(&dev->dev);
787 return dev;
788}
789
790/**
791 * usb_put_dev - release a use of the usb device structure
792 * @dev: device that's been disconnected
793 *
794 * Must be called when a user of a device is finished with it. When the last
795 * user of the device calls this function, the memory of the device is freed.
796 */
797void usb_put_dev(struct usb_device *dev)
798{
799 if (dev)
800 put_device(&dev->dev);
801}
802
803/**
804 * usb_get_intf - increments the reference count of the usb interface structure
805 * @intf: the interface being referenced
806 *
807 * Each live reference to a interface must be refcounted.
808 *
809 * Drivers for USB interfaces should normally record such references in
810 * their probe() methods, when they bind to an interface, and release
811 * them by calling usb_put_intf(), in their disconnect() methods.
812 *
813 * A pointer to the interface with the incremented reference counter is
814 * returned.
815 */
816struct usb_interface *usb_get_intf(struct usb_interface *intf)
817{
818 if (intf)
819 get_device(&intf->dev);
820 return intf;
821}
822
823/**
824 * usb_put_intf - release a use of the usb interface structure
825 * @intf: interface that's been decremented
826 *
827 * Must be called when a user of an interface is finished with it. When the
828 * last user of the interface calls this function, the memory of the interface
829 * is freed.
830 */
831void usb_put_intf(struct usb_interface *intf)
832{
833 if (intf)
834 put_device(&intf->dev);
835}
836
837
838/* USB device locking
839 *
840 * Although locking USB devices should be straightforward, it is
841 * complicated by the way the driver-model core works. When a new USB
842 * driver is registered or unregistered, the core will automatically
843 * probe or disconnect all matching interfaces on all USB devices while
844 * holding the USB subsystem writelock. There's no good way for us to
845 * tell which devices will be used or to lock them beforehand; our only
846 * option is to effectively lock all the USB devices.
847 *
848 * We do that by using a private rw-semaphore, usb_all_devices_rwsem.
849 * When locking an individual device you must first acquire the rwsem's
850 * readlock. When a driver is registered or unregistered the writelock
851 * must be held. These actions are encapsulated in the subroutines
852 * below, so all a driver needs to do is call usb_lock_device() and
853 * usb_unlock_device().
854 *
855 * Complications arise when several devices are to be locked at the same
856 * time. Only hub-aware drivers that are part of usbcore ever have to
857 * do this; nobody else needs to worry about it. The problem is that
858 * usb_lock_device() must not be called to lock a second device since it
859 * would acquire the rwsem's readlock reentrantly, leading to deadlock if
860 * another thread was waiting for the writelock. The solution is simple:
861 *
862 * When locking more than one device, call usb_lock_device()
863 * to lock the first one. Lock the others by calling
864 * down(&udev->serialize) directly.
865 *
866 * When unlocking multiple devices, use up(&udev->serialize)
867 * to unlock all but the last one. Unlock the last one by
868 * calling usb_unlock_device().
869 *
870 * When locking both a device and its parent, always lock the
871 * the parent first.
872 */
873
874/**
875 * usb_lock_device - acquire the lock for a usb device structure
876 * @udev: device that's being locked
877 *
878 * Use this routine when you don't hold any other device locks;
879 * to acquire nested inner locks call down(&udev->serialize) directly.
880 * This is necessary for proper interaction with usb_lock_all_devices().
881 */
882void usb_lock_device(struct usb_device *udev)
883{
884 down_read(&usb_all_devices_rwsem);
885 down(&udev->serialize);
886}
887
888/**
889 * usb_trylock_device - attempt to acquire the lock for a usb device structure
890 * @udev: device that's being locked
891 *
892 * Don't use this routine if you already hold a device lock;
893 * use down_trylock(&udev->serialize) instead.
894 * This is necessary for proper interaction with usb_lock_all_devices().
895 *
896 * Returns 1 if successful, 0 if contention.
897 */
898int usb_trylock_device(struct usb_device *udev)
899{
900 if (!down_read_trylock(&usb_all_devices_rwsem))
901 return 0;
902 if (down_trylock(&udev->serialize)) {
903 up_read(&usb_all_devices_rwsem);
904 return 0;
905 }
906 return 1;
907}
908
909/**
910 * usb_lock_device_for_reset - cautiously acquire the lock for a
911 * usb device structure
912 * @udev: device that's being locked
913 * @iface: interface bound to the driver making the request (optional)
914 *
915 * Attempts to acquire the device lock, but fails if the device is
916 * NOTATTACHED or SUSPENDED, or if iface is specified and the interface
917 * is neither BINDING nor BOUND. Rather than sleeping to wait for the
918 * lock, the routine polls repeatedly. This is to prevent deadlock with
919 * disconnect; in some drivers (such as usb-storage) the disconnect()
Alan Stern3ea15962005-08-11 10:15:39 -0400920 * or suspend() method will block waiting for a device reset to complete.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921 *
922 * Returns a negative error code for failure, otherwise 1 or 0 to indicate
923 * that the device will or will not have to be unlocked. (0 can be
924 * returned when an interface is given and is BINDING, because in that
925 * case the driver already owns the device lock.)
926 */
927int usb_lock_device_for_reset(struct usb_device *udev,
928 struct usb_interface *iface)
929{
Alan Stern3ea15962005-08-11 10:15:39 -0400930 unsigned long jiffies_expire = jiffies + HZ;
931
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932 if (udev->state == USB_STATE_NOTATTACHED)
933 return -ENODEV;
934 if (udev->state == USB_STATE_SUSPENDED)
935 return -EHOSTUNREACH;
936 if (iface) {
937 switch (iface->condition) {
938 case USB_INTERFACE_BINDING:
939 return 0;
940 case USB_INTERFACE_BOUND:
941 break;
942 default:
943 return -EINTR;
944 }
945 }
946
947 while (!usb_trylock_device(udev)) {
Alan Stern3ea15962005-08-11 10:15:39 -0400948
949 /* If we can't acquire the lock after waiting one second,
950 * we're probably deadlocked */
951 if (time_after(jiffies, jiffies_expire))
952 return -EBUSY;
953
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954 msleep(15);
955 if (udev->state == USB_STATE_NOTATTACHED)
956 return -ENODEV;
957 if (udev->state == USB_STATE_SUSPENDED)
958 return -EHOSTUNREACH;
959 if (iface && iface->condition != USB_INTERFACE_BOUND)
960 return -EINTR;
961 }
962 return 1;
963}
964
965/**
966 * usb_unlock_device - release the lock for a usb device structure
967 * @udev: device that's being unlocked
968 *
969 * Use this routine when releasing the only device lock you hold;
970 * to release inner nested locks call up(&udev->serialize) directly.
971 * This is necessary for proper interaction with usb_lock_all_devices().
972 */
973void usb_unlock_device(struct usb_device *udev)
974{
975 up(&udev->serialize);
976 up_read(&usb_all_devices_rwsem);
977}
978
979/**
980 * usb_lock_all_devices - acquire the lock for all usb device structures
981 *
982 * This is necessary when registering a new driver or probing a bus,
983 * since the driver-model core may try to use any usb_device.
984 */
985void usb_lock_all_devices(void)
986{
987 down_write(&usb_all_devices_rwsem);
988}
989
990/**
991 * usb_unlock_all_devices - release the lock for all usb device structures
992 */
993void usb_unlock_all_devices(void)
994{
995 up_write(&usb_all_devices_rwsem);
996}
997
998
999static struct usb_device *match_device(struct usb_device *dev,
1000 u16 vendor_id, u16 product_id)
1001{
1002 struct usb_device *ret_dev = NULL;
1003 int child;
1004
1005 dev_dbg(&dev->dev, "check for vendor %04x, product %04x ...\n",
1006 le16_to_cpu(dev->descriptor.idVendor),
1007 le16_to_cpu(dev->descriptor.idProduct));
1008
1009 /* see if this device matches */
1010 if ((vendor_id == le16_to_cpu(dev->descriptor.idVendor)) &&
1011 (product_id == le16_to_cpu(dev->descriptor.idProduct))) {
1012 dev_dbg (&dev->dev, "matched this device!\n");
1013 ret_dev = usb_get_dev(dev);
1014 goto exit;
1015 }
1016
1017 /* look through all of the children of this device */
1018 for (child = 0; child < dev->maxchild; ++child) {
1019 if (dev->children[child]) {
1020 down(&dev->children[child]->serialize);
1021 ret_dev = match_device(dev->children[child],
1022 vendor_id, product_id);
1023 up(&dev->children[child]->serialize);
1024 if (ret_dev)
1025 goto exit;
1026 }
1027 }
1028exit:
1029 return ret_dev;
1030}
1031
1032/**
1033 * usb_find_device - find a specific usb device in the system
1034 * @vendor_id: the vendor id of the device to find
1035 * @product_id: the product id of the device to find
1036 *
1037 * Returns a pointer to a struct usb_device if such a specified usb
1038 * device is present in the system currently. The usage count of the
1039 * device will be incremented if a device is found. Make sure to call
1040 * usb_put_dev() when the caller is finished with the device.
1041 *
1042 * If a device with the specified vendor and product id is not found,
1043 * NULL is returned.
1044 */
1045struct usb_device *usb_find_device(u16 vendor_id, u16 product_id)
1046{
1047 struct list_head *buslist;
1048 struct usb_bus *bus;
1049 struct usb_device *dev = NULL;
1050
1051 down(&usb_bus_list_lock);
1052 for (buslist = usb_bus_list.next;
1053 buslist != &usb_bus_list;
1054 buslist = buslist->next) {
1055 bus = container_of(buslist, struct usb_bus, bus_list);
1056 if (!bus->root_hub)
1057 continue;
1058 usb_lock_device(bus->root_hub);
1059 dev = match_device(bus->root_hub, vendor_id, product_id);
1060 usb_unlock_device(bus->root_hub);
1061 if (dev)
1062 goto exit;
1063 }
1064exit:
1065 up(&usb_bus_list_lock);
1066 return dev;
1067}
1068
1069/**
1070 * usb_get_current_frame_number - return current bus frame number
1071 * @dev: the device whose bus is being queried
1072 *
1073 * Returns the current frame number for the USB host controller
1074 * used with the given USB device. This can be used when scheduling
1075 * isochronous requests.
1076 *
1077 * Note that different kinds of host controller have different
1078 * "scheduling horizons". While one type might support scheduling only
1079 * 32 frames into the future, others could support scheduling up to
1080 * 1024 frames into the future.
1081 */
1082int usb_get_current_frame_number(struct usb_device *dev)
1083{
1084 return dev->bus->op->get_frame_number (dev);
1085}
1086
1087/*-------------------------------------------------------------------*/
1088/*
1089 * __usb_get_extra_descriptor() finds a descriptor of specific type in the
1090 * extra field of the interface and endpoint descriptor structs.
1091 */
1092
1093int __usb_get_extra_descriptor(char *buffer, unsigned size,
1094 unsigned char type, void **ptr)
1095{
1096 struct usb_descriptor_header *header;
1097
1098 while (size >= sizeof(struct usb_descriptor_header)) {
1099 header = (struct usb_descriptor_header *)buffer;
1100
1101 if (header->bLength < 2) {
1102 printk(KERN_ERR
1103 "%s: bogus descriptor, type %d length %d\n",
1104 usbcore_name,
1105 header->bDescriptorType,
1106 header->bLength);
1107 return -1;
1108 }
1109
1110 if (header->bDescriptorType == type) {
1111 *ptr = header;
1112 return 0;
1113 }
1114
1115 buffer += header->bLength;
1116 size -= header->bLength;
1117 }
1118 return -1;
1119}
1120
1121/**
1122 * usb_buffer_alloc - allocate dma-consistent buffer for URB_NO_xxx_DMA_MAP
1123 * @dev: device the buffer will be used with
1124 * @size: requested buffer size
1125 * @mem_flags: affect whether allocation may block
1126 * @dma: used to return DMA address of buffer
1127 *
1128 * Return value is either null (indicating no buffer could be allocated), or
1129 * the cpu-space pointer to a buffer that may be used to perform DMA to the
1130 * specified device. Such cpu-space buffers are returned along with the DMA
1131 * address (through the pointer provided).
1132 *
1133 * These buffers are used with URB_NO_xxx_DMA_MAP set in urb->transfer_flags
1134 * to avoid behaviors like using "DMA bounce buffers", or tying down I/O
1135 * mapping hardware for long idle periods. The implementation varies between
1136 * platforms, depending on details of how DMA will work to this device.
1137 * Using these buffers also helps prevent cacheline sharing problems on
1138 * architectures where CPU caches are not DMA-coherent.
1139 *
1140 * When the buffer is no longer used, free it with usb_buffer_free().
1141 */
1142void *usb_buffer_alloc (
1143 struct usb_device *dev,
1144 size_t size,
Al Viro55016f12005-10-21 03:21:58 -04001145 gfp_t mem_flags,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146 dma_addr_t *dma
1147)
1148{
1149 if (!dev || !dev->bus || !dev->bus->op || !dev->bus->op->buffer_alloc)
1150 return NULL;
1151 return dev->bus->op->buffer_alloc (dev->bus, size, mem_flags, dma);
1152}
1153
1154/**
1155 * usb_buffer_free - free memory allocated with usb_buffer_alloc()
1156 * @dev: device the buffer was used with
1157 * @size: requested buffer size
1158 * @addr: CPU address of buffer
1159 * @dma: DMA address of buffer
1160 *
1161 * This reclaims an I/O buffer, letting it be reused. The memory must have
1162 * been allocated using usb_buffer_alloc(), and the parameters must match
1163 * those provided in that allocation request.
1164 */
1165void usb_buffer_free (
1166 struct usb_device *dev,
1167 size_t size,
1168 void *addr,
1169 dma_addr_t dma
1170)
1171{
1172 if (!dev || !dev->bus || !dev->bus->op || !dev->bus->op->buffer_free)
1173 return;
1174 dev->bus->op->buffer_free (dev->bus, size, addr, dma);
1175}
1176
1177/**
1178 * usb_buffer_map - create DMA mapping(s) for an urb
1179 * @urb: urb whose transfer_buffer/setup_packet will be mapped
1180 *
1181 * Return value is either null (indicating no buffer could be mapped), or
1182 * the parameter. URB_NO_TRANSFER_DMA_MAP and URB_NO_SETUP_DMA_MAP are
1183 * added to urb->transfer_flags if the operation succeeds. If the device
1184 * is connected to this system through a non-DMA controller, this operation
1185 * always succeeds.
1186 *
1187 * This call would normally be used for an urb which is reused, perhaps
1188 * as the target of a large periodic transfer, with usb_buffer_dmasync()
1189 * calls to synchronize memory and dma state.
1190 *
1191 * Reverse the effect of this call with usb_buffer_unmap().
1192 */
1193#if 0
1194struct urb *usb_buffer_map (struct urb *urb)
1195{
1196 struct usb_bus *bus;
1197 struct device *controller;
1198
1199 if (!urb
1200 || !urb->dev
1201 || !(bus = urb->dev->bus)
1202 || !(controller = bus->controller))
1203 return NULL;
1204
1205 if (controller->dma_mask) {
1206 urb->transfer_dma = dma_map_single (controller,
1207 urb->transfer_buffer, urb->transfer_buffer_length,
1208 usb_pipein (urb->pipe)
1209 ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
1210 if (usb_pipecontrol (urb->pipe))
1211 urb->setup_dma = dma_map_single (controller,
1212 urb->setup_packet,
1213 sizeof (struct usb_ctrlrequest),
1214 DMA_TO_DEVICE);
1215 // FIXME generic api broken like pci, can't report errors
1216 // if (urb->transfer_dma == DMA_ADDR_INVALID) return 0;
1217 } else
1218 urb->transfer_dma = ~0;
1219 urb->transfer_flags |= (URB_NO_TRANSFER_DMA_MAP
1220 | URB_NO_SETUP_DMA_MAP);
1221 return urb;
1222}
1223#endif /* 0 */
1224
1225/* XXX DISABLED, no users currently. If you wish to re-enable this
1226 * XXX please determine whether the sync is to transfer ownership of
1227 * XXX the buffer from device to cpu or vice verse, and thusly use the
1228 * XXX appropriate _for_{cpu,device}() method. -DaveM
1229 */
1230#if 0
1231
1232/**
1233 * usb_buffer_dmasync - synchronize DMA and CPU view of buffer(s)
1234 * @urb: urb whose transfer_buffer/setup_packet will be synchronized
1235 */
1236void usb_buffer_dmasync (struct urb *urb)
1237{
1238 struct usb_bus *bus;
1239 struct device *controller;
1240
1241 if (!urb
1242 || !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)
1243 || !urb->dev
1244 || !(bus = urb->dev->bus)
1245 || !(controller = bus->controller))
1246 return;
1247
1248 if (controller->dma_mask) {
1249 dma_sync_single (controller,
1250 urb->transfer_dma, urb->transfer_buffer_length,
1251 usb_pipein (urb->pipe)
1252 ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
1253 if (usb_pipecontrol (urb->pipe))
1254 dma_sync_single (controller,
1255 urb->setup_dma,
1256 sizeof (struct usb_ctrlrequest),
1257 DMA_TO_DEVICE);
1258 }
1259}
1260#endif
1261
1262/**
1263 * usb_buffer_unmap - free DMA mapping(s) for an urb
1264 * @urb: urb whose transfer_buffer will be unmapped
1265 *
1266 * Reverses the effect of usb_buffer_map().
1267 */
1268#if 0
1269void usb_buffer_unmap (struct urb *urb)
1270{
1271 struct usb_bus *bus;
1272 struct device *controller;
1273
1274 if (!urb
1275 || !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)
1276 || !urb->dev
1277 || !(bus = urb->dev->bus)
1278 || !(controller = bus->controller))
1279 return;
1280
1281 if (controller->dma_mask) {
1282 dma_unmap_single (controller,
1283 urb->transfer_dma, urb->transfer_buffer_length,
1284 usb_pipein (urb->pipe)
1285 ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
1286 if (usb_pipecontrol (urb->pipe))
1287 dma_unmap_single (controller,
1288 urb->setup_dma,
1289 sizeof (struct usb_ctrlrequest),
1290 DMA_TO_DEVICE);
1291 }
1292 urb->transfer_flags &= ~(URB_NO_TRANSFER_DMA_MAP
1293 | URB_NO_SETUP_DMA_MAP);
1294}
1295#endif /* 0 */
1296
1297/**
1298 * usb_buffer_map_sg - create scatterlist DMA mapping(s) for an endpoint
1299 * @dev: device to which the scatterlist will be mapped
1300 * @pipe: endpoint defining the mapping direction
1301 * @sg: the scatterlist to map
1302 * @nents: the number of entries in the scatterlist
1303 *
1304 * Return value is either < 0 (indicating no buffers could be mapped), or
1305 * the number of DMA mapping array entries in the scatterlist.
1306 *
1307 * The caller is responsible for placing the resulting DMA addresses from
1308 * the scatterlist into URB transfer buffer pointers, and for setting the
1309 * URB_NO_TRANSFER_DMA_MAP transfer flag in each of those URBs.
1310 *
1311 * Top I/O rates come from queuing URBs, instead of waiting for each one
1312 * to complete before starting the next I/O. This is particularly easy
1313 * to do with scatterlists. Just allocate and submit one URB for each DMA
1314 * mapping entry returned, stopping on the first error or when all succeed.
1315 * Better yet, use the usb_sg_*() calls, which do that (and more) for you.
1316 *
1317 * This call would normally be used when translating scatterlist requests,
1318 * rather than usb_buffer_map(), since on some hardware (with IOMMUs) it
1319 * may be able to coalesce mappings for improved I/O efficiency.
1320 *
1321 * Reverse the effect of this call with usb_buffer_unmap_sg().
1322 */
1323int usb_buffer_map_sg (struct usb_device *dev, unsigned pipe,
1324 struct scatterlist *sg, int nents)
1325{
1326 struct usb_bus *bus;
1327 struct device *controller;
1328
1329 if (!dev
1330 || usb_pipecontrol (pipe)
1331 || !(bus = dev->bus)
1332 || !(controller = bus->controller)
1333 || !controller->dma_mask)
1334 return -1;
1335
1336 // FIXME generic api broken like pci, can't report errors
1337 return dma_map_sg (controller, sg, nents,
1338 usb_pipein (pipe) ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
1339}
1340
1341/* XXX DISABLED, no users currently. If you wish to re-enable this
1342 * XXX please determine whether the sync is to transfer ownership of
1343 * XXX the buffer from device to cpu or vice verse, and thusly use the
1344 * XXX appropriate _for_{cpu,device}() method. -DaveM
1345 */
1346#if 0
1347
1348/**
1349 * usb_buffer_dmasync_sg - synchronize DMA and CPU view of scatterlist buffer(s)
1350 * @dev: device to which the scatterlist will be mapped
1351 * @pipe: endpoint defining the mapping direction
1352 * @sg: the scatterlist to synchronize
1353 * @n_hw_ents: the positive return value from usb_buffer_map_sg
1354 *
1355 * Use this when you are re-using a scatterlist's data buffers for
1356 * another USB request.
1357 */
1358void usb_buffer_dmasync_sg (struct usb_device *dev, unsigned pipe,
1359 struct scatterlist *sg, int n_hw_ents)
1360{
1361 struct usb_bus *bus;
1362 struct device *controller;
1363
1364 if (!dev
1365 || !(bus = dev->bus)
1366 || !(controller = bus->controller)
1367 || !controller->dma_mask)
1368 return;
1369
1370 dma_sync_sg (controller, sg, n_hw_ents,
1371 usb_pipein (pipe) ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
1372}
1373#endif
1374
1375/**
1376 * usb_buffer_unmap_sg - free DMA mapping(s) for a scatterlist
1377 * @dev: device to which the scatterlist will be mapped
1378 * @pipe: endpoint defining the mapping direction
1379 * @sg: the scatterlist to unmap
1380 * @n_hw_ents: the positive return value from usb_buffer_map_sg
1381 *
1382 * Reverses the effect of usb_buffer_map_sg().
1383 */
1384void usb_buffer_unmap_sg (struct usb_device *dev, unsigned pipe,
1385 struct scatterlist *sg, int n_hw_ents)
1386{
1387 struct usb_bus *bus;
1388 struct device *controller;
1389
1390 if (!dev
1391 || !(bus = dev->bus)
1392 || !(controller = bus->controller)
1393 || !controller->dma_mask)
1394 return;
1395
1396 dma_unmap_sg (controller, sg, n_hw_ents,
1397 usb_pipein (pipe) ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
1398}
1399
David Brownell390a8c32005-09-13 19:57:27 -07001400static int verify_suspended(struct device *dev, void *unused)
1401{
1402 return (dev->power.power_state.event == PM_EVENT_ON) ? -EBUSY : 0;
1403}
1404
David Brownell27d72e82005-04-18 17:39:22 -07001405static int usb_generic_suspend(struct device *dev, pm_message_t message)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406{
David Brownelldb690872005-09-13 19:56:33 -07001407 struct usb_interface *intf;
1408 struct usb_driver *driver;
1409 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410
David Brownell390a8c32005-09-13 19:57:27 -07001411 /* USB devices enter SUSPEND state through their hubs, but can be
1412 * marked for FREEZE as soon as their children are already idled.
David Brownell979d5192005-09-22 22:32:24 -07001413 * But those semantics are useless, so we equate the two (sigh).
David Brownell390a8c32005-09-13 19:57:27 -07001414 */
1415 if (dev->driver == &usb_generic_driver) {
1416 if (dev->power.power_state.event == message.event)
1417 return 0;
1418 /* we need to rule out bogus requests through sysfs */
1419 status = device_for_each_child(dev, NULL, verify_suspended);
1420 if (status)
1421 return status;
David Brownell390a8c32005-09-13 19:57:27 -07001422 return usb_suspend_device (to_usb_device(dev));
1423 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424
1425 if ((dev->driver == NULL) ||
1426 (dev->driver_data == &usb_generic_driver_data))
1427 return 0;
1428
1429 intf = to_usb_interface(dev);
1430 driver = to_usb_driver(dev->driver);
1431
David Brownelldb690872005-09-13 19:56:33 -07001432 /* with no hardware, USB interfaces only use FREEZE and ON states */
1433 if (!is_active(intf))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434 return 0;
1435
David Brownelldb690872005-09-13 19:56:33 -07001436 if (driver->suspend && driver->resume) {
1437 status = driver->suspend(intf, message);
1438 if (status)
1439 dev_err(dev, "%s error %d\n", "suspend", status);
1440 else
1441 mark_quiesced(intf);
1442 } else {
1443 // FIXME else if there's no suspend method, disconnect...
1444 dev_warn(dev, "no %s?\n", "suspend");
1445 status = 0;
1446 }
1447 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448}
1449
1450static int usb_generic_resume(struct device *dev)
1451{
David Brownelldb690872005-09-13 19:56:33 -07001452 struct usb_interface *intf;
1453 struct usb_driver *driver;
David Brownell979d5192005-09-22 22:32:24 -07001454 struct usb_device *udev;
David Brownelldb690872005-09-13 19:56:33 -07001455 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456
David Brownelldb690872005-09-13 19:56:33 -07001457 if (dev->power.power_state.event == PM_EVENT_ON)
1458 return 0;
1459
David Brownell979d5192005-09-22 22:32:24 -07001460 /* mark things as "on" immediately, no matter what errors crop up */
1461 dev->power.power_state.event = PM_EVENT_ON;
1462
David Brownelldb690872005-09-13 19:56:33 -07001463 /* devices resume through their hubs */
David Brownell979d5192005-09-22 22:32:24 -07001464 if (dev->driver == &usb_generic_driver) {
1465 udev = to_usb_device(dev);
1466 if (udev->state == USB_STATE_NOTATTACHED)
1467 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468 return usb_resume_device (to_usb_device(dev));
David Brownell979d5192005-09-22 22:32:24 -07001469 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470
1471 if ((dev->driver == NULL) ||
1472 (dev->driver_data == &usb_generic_driver_data))
1473 return 0;
1474
1475 intf = to_usb_interface(dev);
1476 driver = to_usb_driver(dev->driver);
1477
David Brownell979d5192005-09-22 22:32:24 -07001478 udev = interface_to_usbdev(intf);
1479 if (udev->state == USB_STATE_NOTATTACHED)
1480 return 0;
1481
David Brownelldb690872005-09-13 19:56:33 -07001482 /* if driver was suspended, it has a resume method;
1483 * however, sysfs can wrongly mark things as suspended
1484 * (on the "no suspend method" FIXME path above)
1485 */
David Brownelldb690872005-09-13 19:56:33 -07001486 if (driver->resume) {
1487 status = driver->resume(intf);
1488 if (status) {
1489 dev_err(dev, "%s error %d\n", "resume", status);
1490 mark_quiesced(intf);
1491 }
1492 } else
1493 dev_warn(dev, "no %s?\n", "resume");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494 return 0;
1495}
1496
1497struct bus_type usb_bus_type = {
1498 .name = "usb",
1499 .match = usb_device_match,
1500 .hotplug = usb_hotplug,
1501 .suspend = usb_generic_suspend,
1502 .resume = usb_generic_resume,
1503};
1504
1505#ifndef MODULE
1506
1507static int __init usb_setup_disable(char *str)
1508{
1509 nousb = 1;
1510 return 1;
1511}
1512
1513/* format to disable USB on kernel command line is: nousb */
1514__setup("nousb", usb_setup_disable);
1515
1516#endif
1517
1518/*
1519 * for external read access to <nousb>
1520 */
1521int usb_disabled(void)
1522{
1523 return nousb;
1524}
1525
1526/*
1527 * Init
1528 */
1529static int __init usb_init(void)
1530{
1531 int retval;
1532 if (nousb) {
1533 pr_info ("%s: USB support disabled\n", usbcore_name);
1534 return 0;
1535 }
1536
1537 retval = bus_register(&usb_bus_type);
1538 if (retval)
1539 goto out;
1540 retval = usb_host_init();
1541 if (retval)
1542 goto host_init_failed;
1543 retval = usb_major_init();
1544 if (retval)
1545 goto major_init_failed;
Kay Sieversfbf82fd2005-07-31 01:05:53 +02001546 retval = usb_register(&usbfs_driver);
1547 if (retval)
1548 goto driver_register_failed;
1549 retval = usbdev_init();
1550 if (retval)
1551 goto usbdevice_init_failed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552 retval = usbfs_init();
1553 if (retval)
1554 goto fs_init_failed;
1555 retval = usb_hub_init();
1556 if (retval)
1557 goto hub_init_failed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558 retval = driver_register(&usb_generic_driver);
1559 if (!retval)
1560 goto out;
1561
1562 usb_hub_cleanup();
1563hub_init_failed:
1564 usbfs_cleanup();
1565fs_init_failed:
Kay Sieversfbf82fd2005-07-31 01:05:53 +02001566 usbdev_cleanup();
1567usbdevice_init_failed:
1568 usb_deregister(&usbfs_driver);
1569driver_register_failed:
1570 usb_major_cleanup();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571major_init_failed:
1572 usb_host_cleanup();
1573host_init_failed:
1574 bus_unregister(&usb_bus_type);
1575out:
1576 return retval;
1577}
1578
1579/*
1580 * Cleanup
1581 */
1582static void __exit usb_exit(void)
1583{
1584 /* This will matter if shutdown/reboot does exitcalls. */
1585 if (nousb)
1586 return;
1587
1588 driver_unregister(&usb_generic_driver);
1589 usb_major_cleanup();
1590 usbfs_cleanup();
Kay Sieversfbf82fd2005-07-31 01:05:53 +02001591 usb_deregister(&usbfs_driver);
1592 usbdev_cleanup();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593 usb_hub_cleanup();
1594 usb_host_cleanup();
1595 bus_unregister(&usb_bus_type);
1596}
1597
1598subsys_initcall(usb_init);
1599module_exit(usb_exit);
1600
1601/*
1602 * USB may be built into the kernel or be built as modules.
1603 * These symbols are exported for device (or host controller)
1604 * driver modules to use.
1605 */
1606
1607EXPORT_SYMBOL(usb_register);
1608EXPORT_SYMBOL(usb_deregister);
1609EXPORT_SYMBOL(usb_disabled);
1610
brian@murphy.dka3fdf4e2005-06-29 16:53:29 -07001611EXPORT_SYMBOL_GPL(usb_get_intf);
1612EXPORT_SYMBOL_GPL(usb_put_intf);
1613
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614EXPORT_SYMBOL(usb_alloc_dev);
1615EXPORT_SYMBOL(usb_put_dev);
1616EXPORT_SYMBOL(usb_get_dev);
1617EXPORT_SYMBOL(usb_hub_tt_clear_buffer);
1618
1619EXPORT_SYMBOL(usb_lock_device);
1620EXPORT_SYMBOL(usb_trylock_device);
1621EXPORT_SYMBOL(usb_lock_device_for_reset);
1622EXPORT_SYMBOL(usb_unlock_device);
1623
1624EXPORT_SYMBOL(usb_driver_claim_interface);
1625EXPORT_SYMBOL(usb_driver_release_interface);
1626EXPORT_SYMBOL(usb_match_id);
1627EXPORT_SYMBOL(usb_find_interface);
1628EXPORT_SYMBOL(usb_ifnum_to_if);
1629EXPORT_SYMBOL(usb_altnum_to_altsetting);
1630
1631EXPORT_SYMBOL(usb_reset_device);
1632EXPORT_SYMBOL(usb_disconnect);
1633
1634EXPORT_SYMBOL(__usb_get_extra_descriptor);
1635
1636EXPORT_SYMBOL(usb_find_device);
1637EXPORT_SYMBOL(usb_get_current_frame_number);
1638
1639EXPORT_SYMBOL (usb_buffer_alloc);
1640EXPORT_SYMBOL (usb_buffer_free);
1641
1642#if 0
1643EXPORT_SYMBOL (usb_buffer_map);
1644EXPORT_SYMBOL (usb_buffer_dmasync);
1645EXPORT_SYMBOL (usb_buffer_unmap);
1646#endif
1647
1648EXPORT_SYMBOL (usb_buffer_map_sg);
1649#if 0
1650EXPORT_SYMBOL (usb_buffer_dmasync_sg);
1651#endif
1652EXPORT_SYMBOL (usb_buffer_unmap_sg);
1653
1654MODULE_LICENSE("GPL");