blob: 043fa833eeca949c6f7613bec94f1433cfe42afc [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Uwe Zeisbergerf30c2262006-10-03 23:01:26 +02002 * drivers/usb/core/usb.c
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/module.h>
Alan Sternb5e795f2007-02-20 15:00:53 -050025#include <linux/moduleparam.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#include <linux/usb.h>
Arjan van de Ven4186ecf2006-01-11 15:55:29 +010035#include <linux/mutex.h>
Alan Sternbd859282006-09-19 10:14:07 -040036#include <linux/workqueue.h>
Greg Kroah-Hartman00048b82009-04-24 14:56:26 -070037#include <linux/debugfs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
39#include <asm/io.h>
Adrian Bunk87ae9af2007-10-30 10:35:04 +010040#include <linux/scatterlist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070041#include <linux/mm.h>
42#include <linux/dma-mapping.h>
43
44#include "hcd.h"
45#include "usb.h"
46
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
48const char *usbcore_name = "usbcore";
49
50static int nousb; /* Disable USB when built into kernel image */
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
Alan Stern6b157c92007-03-13 16:37:30 -040052/* Workqueue for autosuspend and for remote wakeup of root hubs */
53struct workqueue_struct *ksuspend_usb_wq;
Alan Sternbd859282006-09-19 10:14:07 -040054
Alan Sternb5e795f2007-02-20 15:00:53 -050055#ifdef CONFIG_USB_SUSPEND
56static int usb_autosuspend_delay = 2; /* Default delay value,
57 * in seconds */
Alan Sterneaafbc32007-03-13 16:39:15 -040058module_param_named(autosuspend, usb_autosuspend_delay, int, 0644);
Alan Sternb5e795f2007-02-20 15:00:53 -050059MODULE_PARM_DESC(autosuspend, "default autosuspend delay");
60
61#else
62#define usb_autosuspend_delay 0
63#endif
64
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
Linus Torvalds1da177e2005-04-16 15:20:36 -070066/**
Sarah Sharp91017f92009-12-03 09:44:34 -080067 * usb_find_alt_setting() - Given a configuration, find the alternate setting
68 * for the given interface.
69 * @config - the configuration to search (not necessarily the current config).
70 * @iface_num - interface number to search in
71 * @alt_num - alternate interface setting number to search for.
72 *
73 * Search the configuration's interface cache for the given alt setting.
74 */
75struct usb_host_interface *usb_find_alt_setting(
76 struct usb_host_config *config,
77 unsigned int iface_num,
78 unsigned int alt_num)
79{
80 struct usb_interface_cache *intf_cache = NULL;
81 int i;
82
83 for (i = 0; i < config->desc.bNumInterfaces; i++) {
84 if (config->intf_cache[i]->altsetting[0].desc.bInterfaceNumber
85 == iface_num) {
86 intf_cache = config->intf_cache[i];
87 break;
88 }
89 }
90 if (!intf_cache)
91 return NULL;
92 for (i = 0; i < intf_cache->num_altsetting; i++)
93 if (intf_cache->altsetting[i].desc.bAlternateSetting == alt_num)
94 return &intf_cache->altsetting[i];
95
96 printk(KERN_DEBUG "Did not find alt setting %u for intf %u, "
97 "config %u\n", alt_num, iface_num,
98 config->desc.bConfigurationValue);
99 return NULL;
100}
101EXPORT_SYMBOL_GPL(usb_find_alt_setting);
102
103/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 * usb_ifnum_to_if - get the interface object with a given interface number
105 * @dev: the device whose current configuration is considered
106 * @ifnum: the desired interface
107 *
108 * This walks the device descriptor for the currently active configuration
109 * and returns a pointer to the interface with that particular interface
110 * number, or null.
111 *
112 * Note that configuration descriptors are not required to assign interface
113 * numbers sequentially, so that it would be incorrect to assume that
114 * the first interface in that descriptor corresponds to interface zero.
115 * This routine helps device drivers avoid such mistakes.
116 * However, you should make sure that you do the right thing with any
117 * alternate settings available for this interfaces.
118 *
119 * Don't call this function unless you are bound to one of the interfaces
120 * on this device or you have locked the device!
121 */
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300122struct usb_interface *usb_ifnum_to_if(const struct usb_device *dev,
123 unsigned ifnum)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124{
125 struct usb_host_config *config = dev->actconfig;
126 int i;
127
128 if (!config)
129 return NULL;
130 for (i = 0; i < config->desc.bNumInterfaces; i++)
131 if (config->interface[i]->altsetting[0]
132 .desc.bInterfaceNumber == ifnum)
133 return config->interface[i];
134
135 return NULL;
136}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600137EXPORT_SYMBOL_GPL(usb_ifnum_to_if);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
139/**
Randy Dunlapd0bcabc2008-02-29 22:03:07 -0800140 * usb_altnum_to_altsetting - get the altsetting structure with a given alternate setting number.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 * @intf: the interface containing the altsetting in question
142 * @altnum: the desired alternate setting number
143 *
144 * This searches the altsetting array of the specified interface for
145 * an entry with the correct bAlternateSetting value and returns a pointer
146 * to that entry, or null.
147 *
148 * Note that altsettings need not be stored sequentially by number, so
149 * it would be incorrect to assume that the first altsetting entry in
150 * the array corresponds to altsetting zero. This routine helps device
151 * drivers avoid such mistakes.
152 *
153 * Don't call this function unless you are bound to the intf interface
154 * or you have locked the device!
155 */
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800156struct usb_host_interface *usb_altnum_to_altsetting(
157 const struct usb_interface *intf,
158 unsigned int altnum)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159{
160 int i;
161
162 for (i = 0; i < intf->num_altsetting; i++) {
163 if (intf->altsetting[i].desc.bAlternateSetting == altnum)
164 return &intf->altsetting[i];
165 }
166 return NULL;
167}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600168EXPORT_SYMBOL_GPL(usb_altnum_to_altsetting);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800170static int __find_interface(struct device *dev, void *data)
mochel@digitalimplant.org6034a082005-03-21 11:09:40 -0800171{
Russ Dilla2582bd2009-11-18 11:02:13 -0700172 int *minor = data;
Pete Zaitcevf5691d72005-12-21 17:24:54 -0800173 struct usb_interface *intf;
mochel@digitalimplant.org6034a082005-03-21 11:09:40 -0800174
Kay Sievers55129662009-05-04 19:48:32 +0200175 if (!is_usb_interface(dev))
mochel@digitalimplant.org6034a082005-03-21 11:09:40 -0800176 return 0;
177
178 intf = to_usb_interface(dev);
Russ Dilla2582bd2009-11-18 11:02:13 -0700179 if (intf->minor != -1 && intf->minor == *minor)
mochel@digitalimplant.org6034a082005-03-21 11:09:40 -0800180 return 1;
mochel@digitalimplant.org6034a082005-03-21 11:09:40 -0800181 return 0;
182}
183
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184/**
185 * usb_find_interface - find usb_interface pointer for driver and device
186 * @drv: the driver whose current configuration is considered
187 * @minor: the minor number of the desired device
188 *
Russ Dilla2582bd2009-11-18 11:02:13 -0700189 * This walks the bus device list and returns a pointer to the interface
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 * with the matching minor. Note, this only works for devices that share the
191 * USB major number.
192 */
193struct usb_interface *usb_find_interface(struct usb_driver *drv, int minor)
194{
Russ Dilla2582bd2009-11-18 11:02:13 -0700195 struct device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196
Russ Dilla2582bd2009-11-18 11:02:13 -0700197 dev = bus_find_device(&usb_bus_type, NULL, &minor, __find_interface);
198
199 /* Drop reference count from bus_find_device */
200 put_device(dev);
201
202 return dev ? to_usb_interface(dev) : NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600204EXPORT_SYMBOL_GPL(usb_find_interface);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206/**
207 * usb_release_dev - free a usb device structure when all users of it are finished.
208 * @dev: device that's been disconnected
209 *
210 * Will be called only by the device core when all users of this usb device are
211 * done.
212 */
213static void usb_release_dev(struct device *dev)
214{
215 struct usb_device *udev;
Sarah Sharpc6515272009-04-27 19:57:26 -0700216 struct usb_hcd *hcd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217
218 udev = to_usb_device(dev);
Sarah Sharpc6515272009-04-27 19:57:26 -0700219 hcd = bus_to_hcd(udev->bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220
221 usb_destroy_configuration(udev);
Sarah Sharpc6515272009-04-27 19:57:26 -0700222 /* Root hubs aren't real devices, so don't free HCD resources */
223 if (hcd->driver->free_dev && udev->parent)
224 hcd->driver->free_dev(hcd, udev);
225 usb_put_hcd(hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 kfree(udev->product);
227 kfree(udev->manufacturer);
228 kfree(udev->serial);
229 kfree(udev);
230}
231
Alan Stern4a9bee82007-11-06 15:01:52 -0500232#ifdef CONFIG_HOTPLUG
233static int usb_dev_uevent(struct device *dev, struct kobj_uevent_env *env)
234{
235 struct usb_device *usb_dev;
236
237 usb_dev = to_usb_device(dev);
238
239 if (add_uevent_var(env, "BUSNUM=%03d", usb_dev->bus->busnum))
240 return -ENOMEM;
241
242 if (add_uevent_var(env, "DEVNUM=%03d", usb_dev->devnum))
243 return -ENOMEM;
244
245 return 0;
246}
247
248#else
249
250static int usb_dev_uevent(struct device *dev, struct kobj_uevent_env *env)
251{
252 return -ENODEV;
253}
254#endif /* CONFIG_HOTPLUG */
255
Alan Stern645daaa2006-08-30 15:47:02 -0400256#ifdef CONFIG_PM
257
Alan Sternbd859282006-09-19 10:14:07 -0400258static int ksuspend_usb_init(void)
259{
Alan Stern7ed92f12007-05-22 09:38:39 -0400260 /* This workqueue is supposed to be both freezable and
261 * singlethreaded. Its job doesn't justify running on more
262 * than one CPU.
263 */
Rafael J. Wysocki7a8d37a2008-02-25 00:35:04 +0100264 ksuspend_usb_wq = create_freezeable_workqueue("ksuspend_usbd");
Alan Sternbd859282006-09-19 10:14:07 -0400265 if (!ksuspend_usb_wq)
266 return -ENOMEM;
267 return 0;
268}
269
270static void ksuspend_usb_cleanup(void)
271{
272 destroy_workqueue(ksuspend_usb_wq);
273}
274
Alan Sternf2189c42008-08-12 14:34:10 -0400275/* USB device Power-Management thunks.
276 * There's no need to distinguish here between quiescing a USB device
277 * and powering it down; the generic_suspend() routine takes care of
278 * it by skipping the usb_port_suspend() call for a quiesce. And for
279 * USB interfaces there's no difference at all.
280 */
281
282static int usb_dev_prepare(struct device *dev)
283{
284 return 0; /* Implement eventually? */
285}
286
287static void usb_dev_complete(struct device *dev)
288{
289 /* Currently used only for rebinding interfaces */
Alan Stern65bfd292008-11-25 16:39:18 -0500290 usb_resume(dev, PMSG_RESUME); /* Message event is meaningless */
Alan Sternf2189c42008-08-12 14:34:10 -0400291}
292
293static int usb_dev_suspend(struct device *dev)
294{
295 return usb_suspend(dev, PMSG_SUSPEND);
296}
297
298static int usb_dev_resume(struct device *dev)
299{
Alan Stern65bfd292008-11-25 16:39:18 -0500300 return usb_resume(dev, PMSG_RESUME);
Alan Sternf2189c42008-08-12 14:34:10 -0400301}
302
303static int usb_dev_freeze(struct device *dev)
304{
305 return usb_suspend(dev, PMSG_FREEZE);
306}
307
308static int usb_dev_thaw(struct device *dev)
309{
Alan Stern65bfd292008-11-25 16:39:18 -0500310 return usb_resume(dev, PMSG_THAW);
Alan Sternf2189c42008-08-12 14:34:10 -0400311}
312
313static int usb_dev_poweroff(struct device *dev)
314{
315 return usb_suspend(dev, PMSG_HIBERNATE);
316}
317
318static int usb_dev_restore(struct device *dev)
319{
Alan Stern65bfd292008-11-25 16:39:18 -0500320 return usb_resume(dev, PMSG_RESTORE);
Alan Sternf2189c42008-08-12 14:34:10 -0400321}
322
Alexey Dobriyan47145212009-12-14 18:00:08 -0800323static const struct dev_pm_ops usb_device_pm_ops = {
Alan Sternf2189c42008-08-12 14:34:10 -0400324 .prepare = usb_dev_prepare,
325 .complete = usb_dev_complete,
326 .suspend = usb_dev_suspend,
327 .resume = usb_dev_resume,
328 .freeze = usb_dev_freeze,
329 .thaw = usb_dev_thaw,
330 .poweroff = usb_dev_poweroff,
331 .restore = usb_dev_restore,
332};
333
Alan Sterndb063502006-11-13 15:02:04 -0500334#else
335
336#define ksuspend_usb_init() 0
337#define ksuspend_usb_cleanup() do {} while (0)
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200338#define usb_device_pm_ops (*(struct dev_pm_ops *)0)
Alan Sterndb063502006-11-13 15:02:04 -0500339
340#endif /* CONFIG_PM */
Alan Stern645daaa2006-08-30 15:47:02 -0400341
Kay Sieversf7a386c2009-04-30 15:23:42 +0200342
Kay Sieverse454cea2009-09-18 23:01:12 +0200343static char *usb_devnode(struct device *dev, mode_t *mode)
Kay Sieversf7a386c2009-04-30 15:23:42 +0200344{
345 struct usb_device *usb_dev;
346
347 usb_dev = to_usb_device(dev);
348 return kasprintf(GFP_KERNEL, "bus/usb/%03d/%03d",
349 usb_dev->bus->busnum, usb_dev->devnum);
350}
351
Alan Sternf2189c42008-08-12 14:34:10 -0400352struct device_type usb_device_type = {
353 .name = "usb_device",
354 .release = usb_release_dev,
355 .uevent = usb_dev_uevent,
Kay Sieverse454cea2009-09-18 23:01:12 +0200356 .devnode = usb_devnode,
Alan Sternf2189c42008-08-12 14:34:10 -0400357 .pm = &usb_device_pm_ops,
358};
359
Inaky Perez-Gonzalezd7d07252007-07-31 20:34:00 -0700360
361/* Returns 1 if @usb_bus is WUSB, 0 otherwise */
362static unsigned usb_bus_is_wusb(struct usb_bus *bus)
363{
364 struct usb_hcd *hcd = container_of(bus, struct usb_hcd, self);
365 return hcd->wireless;
366}
367
368
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369/**
370 * usb_alloc_dev - usb device constructor (usbcore-internal)
371 * @parent: hub to which device is connected; null to allocate a root hub
372 * @bus: bus used to access the device
373 * @port1: one-based index of port; ignored for root hubs
Oliver Neukum92516442007-01-23 15:55:28 -0500374 * Context: !in_interrupt()
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375 *
376 * Only hub drivers (including virtual root hub drivers for host
377 * controllers) should ever call this.
378 *
379 * This call may not be used in a non-sleeping context.
380 */
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800381struct usb_device *usb_alloc_dev(struct usb_device *parent,
382 struct usb_bus *bus, unsigned port1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383{
384 struct usb_device *dev;
Inaky Perez-Gonzalezd7d07252007-07-31 20:34:00 -0700385 struct usb_hcd *usb_hcd = container_of(bus, struct usb_hcd, self);
386 unsigned root_hub = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387
Alan Stern0a1ef3b2005-10-24 15:38:24 -0400388 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389 if (!dev)
390 return NULL;
391
Alan Stern17200582006-08-30 11:32:52 -0400392 if (!usb_get_hcd(bus_to_hcd(bus))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 kfree(dev);
394 return NULL;
395 }
Sarah Sharpc6515272009-04-27 19:57:26 -0700396 /* Root hubs aren't true devices, so don't allocate HCD resources */
397 if (usb_hcd->driver->alloc_dev && parent &&
398 !usb_hcd->driver->alloc_dev(usb_hcd, dev)) {
399 usb_put_hcd(bus_to_hcd(bus));
400 kfree(dev);
401 return NULL;
402 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403
404 device_initialize(&dev->dev);
405 dev->dev.bus = &usb_bus_type;
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100406 dev->dev.type = &usb_device_type;
Alan Stern2e5f10e2008-04-30 15:37:19 -0400407 dev->dev.groups = usb_device_groups;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 dev->dev.dma_mask = bus->controller->dma_mask;
Yinghai Lu70f458f2007-07-09 12:03:09 -0700409 set_dev_node(&dev->dev, dev_to_node(bus->controller));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 dev->state = USB_STATE_ATTACHED;
Sarah Sharp4d59d8a2007-10-03 14:56:03 -0700411 atomic_set(&dev->urbnum, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412
413 INIT_LIST_HEAD(&dev->ep0.urb_list);
414 dev->ep0.desc.bLength = USB_DT_ENDPOINT_SIZE;
415 dev->ep0.desc.bDescriptorType = USB_DT_ENDPOINT;
416 /* ep0 maxpacket comes later, from device descriptor */
David Vrabel3444b262009-04-08 17:36:28 +0000417 usb_enable_endpoint(dev, &dev->ep0, false);
Alan Stern6840d252007-09-10 11:34:26 -0400418 dev->can_submit = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419
420 /* Save readable and stable topology id, distinguishing devices
421 * by location for diagnostics, tools, driver model, etc. The
422 * string is a path along hub ports, from the root. Each device's
423 * dev->devpath will be stable until USB is re-cabled, and hubs
Kay Sievers7071a3c2008-05-02 06:02:41 +0200424 * are often labeled with these port numbers. The name isn't
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 * as stable: bus->busnum changes easily from modprobe order,
426 * cardbus or pci hotplugging, and so on.
427 */
Oliver Neukum92516442007-01-23 15:55:28 -0500428 if (unlikely(!parent)) {
429 dev->devpath[0] = '0';
Sarah Sharp7206b002009-04-27 19:54:49 -0700430 dev->route = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431
432 dev->dev.parent = bus->controller;
Kay Sievers0031a062008-05-02 06:02:41 +0200433 dev_set_name(&dev->dev, "usb%d", bus->busnum);
Inaky Perez-Gonzalezd7d07252007-07-31 20:34:00 -0700434 root_hub = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 } else {
436 /* match any labeling on the hubs; it's one-based */
Sarah Sharp7206b002009-04-27 19:54:49 -0700437 if (parent->devpath[0] == '0') {
Oliver Neukum92516442007-01-23 15:55:28 -0500438 snprintf(dev->devpath, sizeof dev->devpath,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 "%d", port1);
Sarah Sharp7206b002009-04-27 19:54:49 -0700440 /* Root ports are not counted in route string */
441 dev->route = 0;
442 } else {
Oliver Neukum92516442007-01-23 15:55:28 -0500443 snprintf(dev->devpath, sizeof dev->devpath,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 "%s.%d", parent->devpath, port1);
Sarah Sharp4a0cd962009-09-04 10:53:17 -0700445 /* Route string assumes hubs have less than 16 ports */
446 if (port1 < 15)
447 dev->route = parent->route +
448 (port1 << ((parent->level - 1)*4));
449 else
450 dev->route = parent->route +
451 (15 << ((parent->level - 1)*4));
Sarah Sharp7206b002009-04-27 19:54:49 -0700452 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453
454 dev->dev.parent = &parent->dev;
Kay Sievers0031a062008-05-02 06:02:41 +0200455 dev_set_name(&dev->dev, "%d-%s", bus->busnum, dev->devpath);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456
457 /* hub driver sets up TT records */
458 }
459
Alan Stern12c3da32005-11-23 12:09:52 -0500460 dev->portnum = port1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 dev->bus = bus;
462 dev->parent = parent;
463 INIT_LIST_HEAD(&dev->filelist);
464
Alan Stern645daaa2006-08-30 15:47:02 -0400465#ifdef CONFIG_PM
466 mutex_init(&dev->pm_mutex);
David Howellsc4028952006-11-22 14:57:56 +0000467 INIT_DELAYED_WORK(&dev->autosuspend, usb_autosuspend_work);
Alan Stern9ac39f22008-11-12 16:19:49 -0500468 INIT_WORK(&dev->autoresume, usb_autoresume_work);
Alan Sternb5e795f2007-02-20 15:00:53 -0500469 dev->autosuspend_delay = usb_autosuspend_delay * HZ;
Sarah Sharp15123002007-12-21 16:54:15 -0800470 dev->connect_time = jiffies;
471 dev->active_duration = -jiffies;
Alan Stern645daaa2006-08-30 15:47:02 -0400472#endif
Inaky Perez-Gonzalezd7d07252007-07-31 20:34:00 -0700473 if (root_hub) /* Root hub always ok [and always wired] */
474 dev->authorized = 1;
475 else {
476 dev->authorized = usb_hcd->authorized_default;
477 dev->wusb = usb_bus_is_wusb(bus)? 1 : 0;
478 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 return dev;
480}
481
482/**
483 * usb_get_dev - increments the reference count of the usb device structure
484 * @dev: the device being referenced
485 *
486 * Each live reference to a device should be refcounted.
487 *
488 * Drivers for USB interfaces should normally record such references in
489 * their probe() methods, when they bind to an interface, and release
490 * them by calling usb_put_dev(), in their disconnect() methods.
491 *
492 * A pointer to the device with the incremented reference counter is returned.
493 */
494struct usb_device *usb_get_dev(struct usb_device *dev)
495{
496 if (dev)
497 get_device(&dev->dev);
498 return dev;
499}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600500EXPORT_SYMBOL_GPL(usb_get_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501
502/**
503 * usb_put_dev - release a use of the usb device structure
504 * @dev: device that's been disconnected
505 *
506 * Must be called when a user of a device is finished with it. When the last
507 * user of the device calls this function, the memory of the device is freed.
508 */
509void usb_put_dev(struct usb_device *dev)
510{
511 if (dev)
512 put_device(&dev->dev);
513}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600514EXPORT_SYMBOL_GPL(usb_put_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515
516/**
517 * usb_get_intf - increments the reference count of the usb interface structure
518 * @intf: the interface being referenced
519 *
520 * Each live reference to a interface must be refcounted.
521 *
522 * Drivers for USB interfaces should normally record such references in
523 * their probe() methods, when they bind to an interface, and release
524 * them by calling usb_put_intf(), in their disconnect() methods.
525 *
526 * A pointer to the interface with the incremented reference counter is
527 * returned.
528 */
529struct usb_interface *usb_get_intf(struct usb_interface *intf)
530{
531 if (intf)
532 get_device(&intf->dev);
533 return intf;
534}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600535EXPORT_SYMBOL_GPL(usb_get_intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536
537/**
538 * usb_put_intf - release a use of the usb interface structure
539 * @intf: interface that's been decremented
540 *
541 * Must be called when a user of an interface is finished with it. When the
542 * last user of the interface calls this function, the memory of the interface
543 * is freed.
544 */
545void usb_put_intf(struct usb_interface *intf)
546{
547 if (intf)
548 put_device(&intf->dev);
549}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600550EXPORT_SYMBOL_GPL(usb_put_intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551
552/* USB device locking
553 *
Alan Stern9ad3d6c2005-11-17 17:10:32 -0500554 * USB devices and interfaces are locked using the semaphore in their
555 * embedded struct device. The hub driver guarantees that whenever a
556 * device is connected or disconnected, drivers are called with the
557 * USB device locked as well as their particular interface.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 *
559 * Complications arise when several devices are to be locked at the same
560 * time. Only hub-aware drivers that are part of usbcore ever have to
Alan Stern9ad3d6c2005-11-17 17:10:32 -0500561 * do this; nobody else needs to worry about it. The rule for locking
562 * is simple:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 *
564 * When locking both a device and its parent, always lock the
565 * the parent first.
566 */
567
568/**
Randy Dunlapd0bcabc2008-02-29 22:03:07 -0800569 * usb_lock_device_for_reset - cautiously acquire the lock for a usb device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 * @udev: device that's being locked
571 * @iface: interface bound to the driver making the request (optional)
572 *
573 * Attempts to acquire the device lock, but fails if the device is
574 * NOTATTACHED or SUSPENDED, or if iface is specified and the interface
575 * is neither BINDING nor BOUND. Rather than sleeping to wait for the
576 * lock, the routine polls repeatedly. This is to prevent deadlock with
577 * disconnect; in some drivers (such as usb-storage) the disconnect()
Alan Stern3ea159662005-08-11 10:15:39 -0400578 * or suspend() method will block waiting for a device reset to complete.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 *
Alan Stern011b15d2008-11-04 11:29:27 -0500580 * Returns a negative error code for failure, otherwise 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 */
582int usb_lock_device_for_reset(struct usb_device *udev,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300583 const struct usb_interface *iface)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584{
Alan Stern3ea159662005-08-11 10:15:39 -0400585 unsigned long jiffies_expire = jiffies + HZ;
586
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 if (udev->state == USB_STATE_NOTATTACHED)
588 return -ENODEV;
589 if (udev->state == USB_STATE_SUSPENDED)
590 return -EHOSTUNREACH;
Alan Stern011b15d2008-11-04 11:29:27 -0500591 if (iface && (iface->condition == USB_INTERFACE_UNBINDING ||
592 iface->condition == USB_INTERFACE_UNBOUND))
593 return -EINTR;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594
Alan Stern9ad3d6c2005-11-17 17:10:32 -0500595 while (usb_trylock_device(udev) != 0) {
Alan Stern3ea159662005-08-11 10:15:39 -0400596
597 /* If we can't acquire the lock after waiting one second,
598 * we're probably deadlocked */
599 if (time_after(jiffies, jiffies_expire))
600 return -EBUSY;
601
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 msleep(15);
603 if (udev->state == USB_STATE_NOTATTACHED)
604 return -ENODEV;
605 if (udev->state == USB_STATE_SUSPENDED)
606 return -EHOSTUNREACH;
Alan Stern011b15d2008-11-04 11:29:27 -0500607 if (iface && (iface->condition == USB_INTERFACE_UNBINDING ||
608 iface->condition == USB_INTERFACE_UNBOUND))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 return -EINTR;
610 }
Alan Stern011b15d2008-11-04 11:29:27 -0500611 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600613EXPORT_SYMBOL_GPL(usb_lock_device_for_reset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614
615static struct usb_device *match_device(struct usb_device *dev,
616 u16 vendor_id, u16 product_id)
617{
618 struct usb_device *ret_dev = NULL;
619 int child;
620
621 dev_dbg(&dev->dev, "check for vendor %04x, product %04x ...\n",
622 le16_to_cpu(dev->descriptor.idVendor),
623 le16_to_cpu(dev->descriptor.idProduct));
624
625 /* see if this device matches */
626 if ((vendor_id == le16_to_cpu(dev->descriptor.idVendor)) &&
627 (product_id == le16_to_cpu(dev->descriptor.idProduct))) {
Oliver Neukum92516442007-01-23 15:55:28 -0500628 dev_dbg(&dev->dev, "matched this device!\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 ret_dev = usb_get_dev(dev);
630 goto exit;
631 }
632
633 /* look through all of the children of this device */
634 for (child = 0; child < dev->maxchild; ++child) {
635 if (dev->children[child]) {
Alan Stern9ad3d6c2005-11-17 17:10:32 -0500636 usb_lock_device(dev->children[child]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637 ret_dev = match_device(dev->children[child],
638 vendor_id, product_id);
Alan Stern9ad3d6c2005-11-17 17:10:32 -0500639 usb_unlock_device(dev->children[child]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 if (ret_dev)
641 goto exit;
642 }
643 }
644exit:
645 return ret_dev;
646}
647
648/**
649 * usb_find_device - find a specific usb device in the system
650 * @vendor_id: the vendor id of the device to find
651 * @product_id: the product id of the device to find
652 *
653 * Returns a pointer to a struct usb_device if such a specified usb
654 * device is present in the system currently. The usage count of the
655 * device will be incremented if a device is found. Make sure to call
656 * usb_put_dev() when the caller is finished with the device.
657 *
658 * If a device with the specified vendor and product id is not found,
659 * NULL is returned.
660 */
661struct usb_device *usb_find_device(u16 vendor_id, u16 product_id)
662{
663 struct list_head *buslist;
664 struct usb_bus *bus;
665 struct usb_device *dev = NULL;
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800666
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100667 mutex_lock(&usb_bus_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 for (buslist = usb_bus_list.next;
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800669 buslist != &usb_bus_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 buslist = buslist->next) {
671 bus = container_of(buslist, struct usb_bus, bus_list);
672 if (!bus->root_hub)
673 continue;
674 usb_lock_device(bus->root_hub);
675 dev = match_device(bus->root_hub, vendor_id, product_id);
676 usb_unlock_device(bus->root_hub);
677 if (dev)
678 goto exit;
679 }
680exit:
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100681 mutex_unlock(&usb_bus_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 return dev;
683}
684
685/**
686 * usb_get_current_frame_number - return current bus frame number
687 * @dev: the device whose bus is being queried
688 *
689 * Returns the current frame number for the USB host controller
690 * used with the given USB device. This can be used when scheduling
691 * isochronous requests.
692 *
693 * Note that different kinds of host controller have different
694 * "scheduling horizons". While one type might support scheduling only
695 * 32 frames into the future, others could support scheduling up to
696 * 1024 frames into the future.
697 */
698int usb_get_current_frame_number(struct usb_device *dev)
699{
Oliver Neukum92516442007-01-23 15:55:28 -0500700 return usb_hcd_get_frame_number(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600702EXPORT_SYMBOL_GPL(usb_get_current_frame_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703
704/*-------------------------------------------------------------------*/
705/*
706 * __usb_get_extra_descriptor() finds a descriptor of specific type in the
707 * extra field of the interface and endpoint descriptor structs.
708 */
709
710int __usb_get_extra_descriptor(char *buffer, unsigned size,
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800711 unsigned char type, void **ptr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712{
713 struct usb_descriptor_header *header;
714
715 while (size >= sizeof(struct usb_descriptor_header)) {
716 header = (struct usb_descriptor_header *)buffer;
717
718 if (header->bLength < 2) {
719 printk(KERN_ERR
720 "%s: bogus descriptor, type %d length %d\n",
721 usbcore_name,
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800722 header->bDescriptorType,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 header->bLength);
724 return -1;
725 }
726
727 if (header->bDescriptorType == type) {
728 *ptr = header;
729 return 0;
730 }
731
732 buffer += header->bLength;
733 size -= header->bLength;
734 }
735 return -1;
736}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600737EXPORT_SYMBOL_GPL(__usb_get_extra_descriptor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738
739/**
740 * usb_buffer_alloc - allocate dma-consistent buffer for URB_NO_xxx_DMA_MAP
741 * @dev: device the buffer will be used with
742 * @size: requested buffer size
743 * @mem_flags: affect whether allocation may block
744 * @dma: used to return DMA address of buffer
745 *
746 * Return value is either null (indicating no buffer could be allocated), or
747 * the cpu-space pointer to a buffer that may be used to perform DMA to the
748 * specified device. Such cpu-space buffers are returned along with the DMA
749 * address (through the pointer provided).
750 *
751 * These buffers are used with URB_NO_xxx_DMA_MAP set in urb->transfer_flags
David Brownellfbf54dd2007-07-01 23:33:12 -0700752 * to avoid behaviors like using "DMA bounce buffers", or thrashing IOMMU
753 * hardware during URB completion/resubmit. The implementation varies between
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754 * platforms, depending on details of how DMA will work to this device.
David Brownellfbf54dd2007-07-01 23:33:12 -0700755 * Using these buffers also eliminates cacheline sharing problems on
756 * architectures where CPU caches are not DMA-coherent. On systems without
757 * bus-snooping caches, these buffers are uncached.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 *
759 * When the buffer is no longer used, free it with usb_buffer_free().
760 */
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800761void *usb_buffer_alloc(struct usb_device *dev, size_t size, gfp_t mem_flags,
762 dma_addr_t *dma)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763{
Alan Sterna6d2bb92006-08-30 11:27:36 -0400764 if (!dev || !dev->bus)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 return NULL;
Oliver Neukum92516442007-01-23 15:55:28 -0500766 return hcd_buffer_alloc(dev->bus, size, mem_flags, dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600768EXPORT_SYMBOL_GPL(usb_buffer_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769
770/**
771 * usb_buffer_free - free memory allocated with usb_buffer_alloc()
772 * @dev: device the buffer was used with
773 * @size: requested buffer size
774 * @addr: CPU address of buffer
775 * @dma: DMA address of buffer
776 *
777 * This reclaims an I/O buffer, letting it be reused. The memory must have
778 * been allocated using usb_buffer_alloc(), and the parameters must match
David Brownellfbf54dd2007-07-01 23:33:12 -0700779 * those provided in that allocation request.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 */
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800781void usb_buffer_free(struct usb_device *dev, size_t size, void *addr,
782 dma_addr_t dma)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783{
Alan Sterna6d2bb92006-08-30 11:27:36 -0400784 if (!dev || !dev->bus)
Dmitry Torokhovb94badb2006-08-01 22:33:34 -0400785 return;
786 if (!addr)
787 return;
Oliver Neukum92516442007-01-23 15:55:28 -0500788 hcd_buffer_free(dev->bus, size, addr, dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600790EXPORT_SYMBOL_GPL(usb_buffer_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791
792/**
793 * usb_buffer_map - create DMA mapping(s) for an urb
794 * @urb: urb whose transfer_buffer/setup_packet will be mapped
795 *
796 * Return value is either null (indicating no buffer could be mapped), or
797 * the parameter. URB_NO_TRANSFER_DMA_MAP and URB_NO_SETUP_DMA_MAP are
798 * added to urb->transfer_flags if the operation succeeds. If the device
799 * is connected to this system through a non-DMA controller, this operation
800 * always succeeds.
801 *
802 * This call would normally be used for an urb which is reused, perhaps
803 * as the target of a large periodic transfer, with usb_buffer_dmasync()
804 * calls to synchronize memory and dma state.
805 *
806 * Reverse the effect of this call with usb_buffer_unmap().
807 */
808#if 0
Oliver Neukum92516442007-01-23 15:55:28 -0500809struct urb *usb_buffer_map(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810{
811 struct usb_bus *bus;
812 struct device *controller;
813
814 if (!urb
815 || !urb->dev
816 || !(bus = urb->dev->bus)
817 || !(controller = bus->controller))
818 return NULL;
819
820 if (controller->dma_mask) {
Oliver Neukum92516442007-01-23 15:55:28 -0500821 urb->transfer_dma = dma_map_single(controller,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 urb->transfer_buffer, urb->transfer_buffer_length,
Oliver Neukum92516442007-01-23 15:55:28 -0500823 usb_pipein(urb->pipe)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
Oliver Neukum92516442007-01-23 15:55:28 -0500825 if (usb_pipecontrol(urb->pipe))
826 urb->setup_dma = dma_map_single(controller,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 urb->setup_packet,
Oliver Neukum92516442007-01-23 15:55:28 -0500828 sizeof(struct usb_ctrlrequest),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 DMA_TO_DEVICE);
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800830 /* FIXME generic api broken like pci, can't report errors */
831 /* if (urb->transfer_dma == DMA_ADDR_INVALID) return 0; */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 } else
833 urb->transfer_dma = ~0;
834 urb->transfer_flags |= (URB_NO_TRANSFER_DMA_MAP
835 | URB_NO_SETUP_DMA_MAP);
836 return urb;
837}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600838EXPORT_SYMBOL_GPL(usb_buffer_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839#endif /* 0 */
840
841/* XXX DISABLED, no users currently. If you wish to re-enable this
842 * XXX please determine whether the sync is to transfer ownership of
843 * XXX the buffer from device to cpu or vice verse, and thusly use the
844 * XXX appropriate _for_{cpu,device}() method. -DaveM
845 */
846#if 0
847
848/**
849 * usb_buffer_dmasync - synchronize DMA and CPU view of buffer(s)
850 * @urb: urb whose transfer_buffer/setup_packet will be synchronized
851 */
Oliver Neukum92516442007-01-23 15:55:28 -0500852void usb_buffer_dmasync(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853{
854 struct usb_bus *bus;
855 struct device *controller;
856
857 if (!urb
858 || !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)
859 || !urb->dev
860 || !(bus = urb->dev->bus)
861 || !(controller = bus->controller))
862 return;
863
864 if (controller->dma_mask) {
FUJITA Tomonori9b8e7ba2009-05-28 10:10:44 +0900865 dma_sync_single_for_cpu(controller,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866 urb->transfer_dma, urb->transfer_buffer_length,
Oliver Neukum92516442007-01-23 15:55:28 -0500867 usb_pipein(urb->pipe)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868 ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
Oliver Neukum92516442007-01-23 15:55:28 -0500869 if (usb_pipecontrol(urb->pipe))
FUJITA Tomonori9b8e7ba2009-05-28 10:10:44 +0900870 dma_sync_single_for_cpu(controller,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871 urb->setup_dma,
Oliver Neukum92516442007-01-23 15:55:28 -0500872 sizeof(struct usb_ctrlrequest),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 DMA_TO_DEVICE);
874 }
875}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600876EXPORT_SYMBOL_GPL(usb_buffer_dmasync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877#endif
878
879/**
880 * usb_buffer_unmap - free DMA mapping(s) for an urb
881 * @urb: urb whose transfer_buffer will be unmapped
882 *
883 * Reverses the effect of usb_buffer_map().
884 */
885#if 0
Oliver Neukum92516442007-01-23 15:55:28 -0500886void usb_buffer_unmap(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887{
888 struct usb_bus *bus;
889 struct device *controller;
890
891 if (!urb
892 || !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)
893 || !urb->dev
894 || !(bus = urb->dev->bus)
895 || !(controller = bus->controller))
896 return;
897
898 if (controller->dma_mask) {
Oliver Neukum92516442007-01-23 15:55:28 -0500899 dma_unmap_single(controller,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 urb->transfer_dma, urb->transfer_buffer_length,
Oliver Neukum92516442007-01-23 15:55:28 -0500901 usb_pipein(urb->pipe)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902 ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
Oliver Neukum92516442007-01-23 15:55:28 -0500903 if (usb_pipecontrol(urb->pipe))
904 dma_unmap_single(controller,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905 urb->setup_dma,
Oliver Neukum92516442007-01-23 15:55:28 -0500906 sizeof(struct usb_ctrlrequest),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 DMA_TO_DEVICE);
908 }
909 urb->transfer_flags &= ~(URB_NO_TRANSFER_DMA_MAP
910 | URB_NO_SETUP_DMA_MAP);
911}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600912EXPORT_SYMBOL_GPL(usb_buffer_unmap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913#endif /* 0 */
914
915/**
916 * usb_buffer_map_sg - create scatterlist DMA mapping(s) for an endpoint
917 * @dev: device to which the scatterlist will be mapped
Alan Stern5e60a162007-07-30 17:07:21 -0400918 * @is_in: mapping transfer direction
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 * @sg: the scatterlist to map
920 * @nents: the number of entries in the scatterlist
921 *
922 * Return value is either < 0 (indicating no buffers could be mapped), or
923 * the number of DMA mapping array entries in the scatterlist.
924 *
925 * The caller is responsible for placing the resulting DMA addresses from
926 * the scatterlist into URB transfer buffer pointers, and for setting the
927 * URB_NO_TRANSFER_DMA_MAP transfer flag in each of those URBs.
928 *
929 * Top I/O rates come from queuing URBs, instead of waiting for each one
930 * to complete before starting the next I/O. This is particularly easy
931 * to do with scatterlists. Just allocate and submit one URB for each DMA
932 * mapping entry returned, stopping on the first error or when all succeed.
933 * Better yet, use the usb_sg_*() calls, which do that (and more) for you.
934 *
935 * This call would normally be used when translating scatterlist requests,
936 * rather than usb_buffer_map(), since on some hardware (with IOMMUs) it
937 * may be able to coalesce mappings for improved I/O efficiency.
938 *
939 * Reverse the effect of this call with usb_buffer_unmap_sg().
940 */
Alan Stern5e60a162007-07-30 17:07:21 -0400941int usb_buffer_map_sg(const struct usb_device *dev, int is_in,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300942 struct scatterlist *sg, int nents)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943{
944 struct usb_bus *bus;
945 struct device *controller;
946
947 if (!dev
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948 || !(bus = dev->bus)
949 || !(controller = bus->controller)
950 || !controller->dma_mask)
Jiri Slaby29122822009-08-22 20:24:49 +0200951 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800953 /* FIXME generic api broken like pci, can't report errors */
Oliver Neukum92516442007-01-23 15:55:28 -0500954 return dma_map_sg(controller, sg, nents,
Jiri Slaby29122822009-08-22 20:24:49 +0200955 is_in ? DMA_FROM_DEVICE : DMA_TO_DEVICE) ? : -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600957EXPORT_SYMBOL_GPL(usb_buffer_map_sg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958
959/* XXX DISABLED, no users currently. If you wish to re-enable this
960 * XXX please determine whether the sync is to transfer ownership of
961 * XXX the buffer from device to cpu or vice verse, and thusly use the
962 * XXX appropriate _for_{cpu,device}() method. -DaveM
963 */
964#if 0
965
966/**
967 * usb_buffer_dmasync_sg - synchronize DMA and CPU view of scatterlist buffer(s)
968 * @dev: device to which the scatterlist will be mapped
Alan Stern5e60a162007-07-30 17:07:21 -0400969 * @is_in: mapping transfer direction
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970 * @sg: the scatterlist to synchronize
971 * @n_hw_ents: the positive return value from usb_buffer_map_sg
972 *
973 * Use this when you are re-using a scatterlist's data buffers for
974 * another USB request.
975 */
Alan Stern5e60a162007-07-30 17:07:21 -0400976void usb_buffer_dmasync_sg(const struct usb_device *dev, int is_in,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300977 struct scatterlist *sg, int n_hw_ents)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978{
979 struct usb_bus *bus;
980 struct device *controller;
981
982 if (!dev
983 || !(bus = dev->bus)
984 || !(controller = bus->controller)
985 || !controller->dma_mask)
986 return;
987
FUJITA Tomonori9b8e7ba2009-05-28 10:10:44 +0900988 dma_sync_sg_for_cpu(controller, sg, n_hw_ents,
989 is_in ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600991EXPORT_SYMBOL_GPL(usb_buffer_dmasync_sg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992#endif
993
994/**
995 * usb_buffer_unmap_sg - free DMA mapping(s) for a scatterlist
996 * @dev: device to which the scatterlist will be mapped
Alan Stern5e60a162007-07-30 17:07:21 -0400997 * @is_in: mapping transfer direction
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998 * @sg: the scatterlist to unmap
999 * @n_hw_ents: the positive return value from usb_buffer_map_sg
1000 *
1001 * Reverses the effect of usb_buffer_map_sg().
1002 */
Alan Stern5e60a162007-07-30 17:07:21 -04001003void usb_buffer_unmap_sg(const struct usb_device *dev, int is_in,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -03001004 struct scatterlist *sg, int n_hw_ents)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005{
1006 struct usb_bus *bus;
1007 struct device *controller;
1008
1009 if (!dev
1010 || !(bus = dev->bus)
1011 || !(controller = bus->controller)
1012 || !controller->dma_mask)
1013 return;
1014
Oliver Neukum92516442007-01-23 15:55:28 -05001015 dma_unmap_sg(controller, sg, n_hw_ents,
Alan Stern5e60a162007-07-30 17:07:21 -04001016 is_in ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -06001018EXPORT_SYMBOL_GPL(usb_buffer_unmap_sg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019
Rusty Russell785895f2008-11-22 13:01:06 +10301020/* To disable USB, kernel command line is 'nousb' not 'usbcore.nousb' */
1021#ifdef MODULE
1022module_param(nousb, bool, 0444);
1023#else
1024core_param(nousb, nousb, bool, 0444);
1025#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026
1027/*
1028 * for external read access to <nousb>
1029 */
1030int usb_disabled(void)
1031{
1032 return nousb;
1033}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -06001034EXPORT_SYMBOL_GPL(usb_disabled);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035
1036/*
Alan Stern3b23dd62008-12-05 14:10:34 -05001037 * Notifications of device and interface registration
1038 */
1039static int usb_bus_notify(struct notifier_block *nb, unsigned long action,
1040 void *data)
1041{
1042 struct device *dev = data;
1043
1044 switch (action) {
1045 case BUS_NOTIFY_ADD_DEVICE:
1046 if (dev->type == &usb_device_type)
1047 (void) usb_create_sysfs_dev_files(to_usb_device(dev));
1048 else if (dev->type == &usb_if_device_type)
1049 (void) usb_create_sysfs_intf_files(
1050 to_usb_interface(dev));
1051 break;
1052
1053 case BUS_NOTIFY_DEL_DEVICE:
1054 if (dev->type == &usb_device_type)
1055 usb_remove_sysfs_dev_files(to_usb_device(dev));
1056 else if (dev->type == &usb_if_device_type)
1057 usb_remove_sysfs_intf_files(to_usb_interface(dev));
1058 break;
1059 }
1060 return 0;
1061}
1062
1063static struct notifier_block usb_bus_nb = {
1064 .notifier_call = usb_bus_notify,
1065};
1066
Greg Kroah-Hartman00048b82009-04-24 14:56:26 -07001067struct dentry *usb_debug_root;
1068EXPORT_SYMBOL_GPL(usb_debug_root);
1069
Felipe Balbi719a6e82009-12-04 15:47:42 +02001070static struct dentry *usb_debug_devices;
Greg Kroah-Hartman97d7b7a2009-04-24 15:16:04 -07001071
Greg Kroah-Hartman00048b82009-04-24 14:56:26 -07001072static int usb_debugfs_init(void)
1073{
1074 usb_debug_root = debugfs_create_dir("usb", NULL);
1075 if (!usb_debug_root)
1076 return -ENOENT;
Greg Kroah-Hartman97d7b7a2009-04-24 15:16:04 -07001077
1078 usb_debug_devices = debugfs_create_file("devices", 0444,
1079 usb_debug_root, NULL,
1080 &usbfs_devices_fops);
1081 if (!usb_debug_devices) {
1082 debugfs_remove(usb_debug_root);
1083 usb_debug_root = NULL;
1084 return -ENOENT;
1085 }
1086
Greg Kroah-Hartman00048b82009-04-24 14:56:26 -07001087 return 0;
1088}
1089
1090static void usb_debugfs_cleanup(void)
1091{
Greg Kroah-Hartman97d7b7a2009-04-24 15:16:04 -07001092 debugfs_remove(usb_debug_devices);
Greg Kroah-Hartman00048b82009-04-24 14:56:26 -07001093 debugfs_remove(usb_debug_root);
1094}
1095
Alan Stern3b23dd62008-12-05 14:10:34 -05001096/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 * Init
1098 */
1099static int __init usb_init(void)
1100{
1101 int retval;
1102 if (nousb) {
Oliver Neukum92516442007-01-23 15:55:28 -05001103 pr_info("%s: USB support disabled\n", usbcore_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104 return 0;
1105 }
1106
Greg Kroah-Hartman00048b82009-04-24 14:56:26 -07001107 retval = usb_debugfs_init();
1108 if (retval)
1109 goto out;
1110
Alan Sternbd859282006-09-19 10:14:07 -04001111 retval = ksuspend_usb_init();
1112 if (retval)
1113 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114 retval = bus_register(&usb_bus_type);
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -08001115 if (retval)
Alan Sternbd859282006-09-19 10:14:07 -04001116 goto bus_register_failed;
Alan Stern3b23dd62008-12-05 14:10:34 -05001117 retval = bus_register_notifier(&usb_bus_type, &usb_bus_nb);
1118 if (retval)
1119 goto bus_notifier_failed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120 retval = usb_major_init();
1121 if (retval)
1122 goto major_init_failed;
Kay Sieversfbf82fd2005-07-31 01:05:53 +02001123 retval = usb_register(&usbfs_driver);
1124 if (retval)
1125 goto driver_register_failed;
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001126 retval = usb_devio_init();
Kay Sieversfbf82fd2005-07-31 01:05:53 +02001127 if (retval)
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001128 goto usb_devio_init_failed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129 retval = usbfs_init();
1130 if (retval)
1131 goto fs_init_failed;
1132 retval = usb_hub_init();
1133 if (retval)
1134 goto hub_init_failed;
Alan Stern8bb54ab2006-07-01 22:08:49 -04001135 retval = usb_register_device_driver(&usb_generic_driver, THIS_MODULE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136 if (!retval)
1137 goto out;
1138
1139 usb_hub_cleanup();
1140hub_init_failed:
1141 usbfs_cleanup();
1142fs_init_failed:
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001143 usb_devio_cleanup();
1144usb_devio_init_failed:
Kay Sieversfbf82fd2005-07-31 01:05:53 +02001145 usb_deregister(&usbfs_driver);
1146driver_register_failed:
1147 usb_major_cleanup();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148major_init_failed:
Alan Stern3b23dd62008-12-05 14:10:34 -05001149 bus_unregister_notifier(&usb_bus_type, &usb_bus_nb);
1150bus_notifier_failed:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151 bus_unregister(&usb_bus_type);
Alan Sternbd859282006-09-19 10:14:07 -04001152bus_register_failed:
1153 ksuspend_usb_cleanup();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154out:
1155 return retval;
1156}
1157
1158/*
1159 * Cleanup
1160 */
1161static void __exit usb_exit(void)
1162{
1163 /* This will matter if shutdown/reboot does exitcalls. */
1164 if (nousb)
1165 return;
1166
Alan Stern8bb54ab2006-07-01 22:08:49 -04001167 usb_deregister_device_driver(&usb_generic_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168 usb_major_cleanup();
1169 usbfs_cleanup();
Kay Sieversfbf82fd2005-07-31 01:05:53 +02001170 usb_deregister(&usbfs_driver);
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001171 usb_devio_cleanup();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172 usb_hub_cleanup();
Alan Stern3b23dd62008-12-05 14:10:34 -05001173 bus_unregister_notifier(&usb_bus_type, &usb_bus_nb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174 bus_unregister(&usb_bus_type);
Alan Sternbd859282006-09-19 10:14:07 -04001175 ksuspend_usb_cleanup();
Greg Kroah-Hartman00048b82009-04-24 14:56:26 -07001176 usb_debugfs_cleanup();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001177}
1178
1179subsys_initcall(usb_init);
1180module_exit(usb_exit);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181MODULE_LICENSE("GPL");