blob: 25d0c61c3f8a3045e19fddc35016b35e9c44bd6d [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>
Eric Lescouet27729aa2010-04-24 23:21:52 +020035#include <linux/usb/hcd.h>
Arjan van de Ven4186ecf2006-01-11 15:55:29 +010036#include <linux/mutex.h>
Alan Sternbd859282006-09-19 10:14:07 -040037#include <linux/workqueue.h>
Greg Kroah-Hartman00048b82009-04-24 14:56:26 -070038#include <linux/debugfs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
40#include <asm/io.h>
Adrian Bunk87ae9af2007-10-30 10:35:04 +010041#include <linux/scatterlist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070042#include <linux/mm.h>
43#include <linux/dma-mapping.h>
44
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#include "usb.h"
46
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
48const char *usbcore_name = "usbcore";
49
Rusty Russell90ab5ee2012-01-13 09:32:20 +103050static bool nousb; /* Disable USB when built into kernel image */
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
Alan Sternb5e795f2007-02-20 15:00:53 -050052#ifdef CONFIG_USB_SUSPEND
53static int usb_autosuspend_delay = 2; /* Default delay value,
54 * in seconds */
Alan Sterneaafbc32007-03-13 16:39:15 -040055module_param_named(autosuspend, usb_autosuspend_delay, int, 0644);
Alan Sternb5e795f2007-02-20 15:00:53 -050056MODULE_PARM_DESC(autosuspend, "default autosuspend delay");
57
58#else
59#define usb_autosuspend_delay 0
60#endif
61
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
Linus Torvalds1da177e2005-04-16 15:20:36 -070063/**
Sarah Sharp91017f92009-12-03 09:44:34 -080064 * usb_find_alt_setting() - Given a configuration, find the alternate setting
65 * for the given interface.
Randy Dunlap70445ae2009-12-13 10:17:16 -080066 * @config: the configuration to search (not necessarily the current config).
67 * @iface_num: interface number to search in
68 * @alt_num: alternate interface setting number to search for.
Sarah Sharp91017f92009-12-03 09:44:34 -080069 *
70 * Search the configuration's interface cache for the given alt setting.
71 */
72struct usb_host_interface *usb_find_alt_setting(
73 struct usb_host_config *config,
74 unsigned int iface_num,
75 unsigned int alt_num)
76{
77 struct usb_interface_cache *intf_cache = NULL;
78 int i;
79
80 for (i = 0; i < config->desc.bNumInterfaces; i++) {
81 if (config->intf_cache[i]->altsetting[0].desc.bInterfaceNumber
82 == iface_num) {
83 intf_cache = config->intf_cache[i];
84 break;
85 }
86 }
87 if (!intf_cache)
88 return NULL;
89 for (i = 0; i < intf_cache->num_altsetting; i++)
90 if (intf_cache->altsetting[i].desc.bAlternateSetting == alt_num)
91 return &intf_cache->altsetting[i];
92
93 printk(KERN_DEBUG "Did not find alt setting %u for intf %u, "
94 "config %u\n", alt_num, iface_num,
95 config->desc.bConfigurationValue);
96 return NULL;
97}
98EXPORT_SYMBOL_GPL(usb_find_alt_setting);
99
100/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101 * usb_ifnum_to_if - get the interface object with a given interface number
102 * @dev: the device whose current configuration is considered
103 * @ifnum: the desired interface
104 *
105 * This walks the device descriptor for the currently active configuration
106 * and returns a pointer to the interface with that particular interface
107 * number, or null.
108 *
109 * Note that configuration descriptors are not required to assign interface
110 * numbers sequentially, so that it would be incorrect to assume that
111 * the first interface in that descriptor corresponds to interface zero.
112 * This routine helps device drivers avoid such mistakes.
113 * However, you should make sure that you do the right thing with any
114 * alternate settings available for this interfaces.
115 *
116 * Don't call this function unless you are bound to one of the interfaces
117 * on this device or you have locked the device!
118 */
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300119struct usb_interface *usb_ifnum_to_if(const struct usb_device *dev,
120 unsigned ifnum)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121{
122 struct usb_host_config *config = dev->actconfig;
123 int i;
124
125 if (!config)
126 return NULL;
127 for (i = 0; i < config->desc.bNumInterfaces; i++)
128 if (config->interface[i]->altsetting[0]
129 .desc.bInterfaceNumber == ifnum)
130 return config->interface[i];
131
132 return NULL;
133}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600134EXPORT_SYMBOL_GPL(usb_ifnum_to_if);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135
136/**
Randy Dunlapd0bcabc2008-02-29 22:03:07 -0800137 * usb_altnum_to_altsetting - get the altsetting structure with a given alternate setting number.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 * @intf: the interface containing the altsetting in question
139 * @altnum: the desired alternate setting number
140 *
141 * This searches the altsetting array of the specified interface for
142 * an entry with the correct bAlternateSetting value and returns a pointer
143 * to that entry, or null.
144 *
145 * Note that altsettings need not be stored sequentially by number, so
146 * it would be incorrect to assume that the first altsetting entry in
147 * the array corresponds to altsetting zero. This routine helps device
148 * drivers avoid such mistakes.
149 *
150 * Don't call this function unless you are bound to the intf interface
151 * or you have locked the device!
152 */
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800153struct usb_host_interface *usb_altnum_to_altsetting(
154 const struct usb_interface *intf,
155 unsigned int altnum)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156{
157 int i;
158
159 for (i = 0; i < intf->num_altsetting; i++) {
160 if (intf->altsetting[i].desc.bAlternateSetting == altnum)
161 return &intf->altsetting[i];
162 }
163 return NULL;
164}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600165EXPORT_SYMBOL_GPL(usb_altnum_to_altsetting);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166
Greg Kroah-Hartmanab7cd8c2009-12-15 07:47:28 -0800167struct find_interface_arg {
168 int minor;
Russ Dillc2d284e2009-12-14 21:45:35 -0700169 struct device_driver *drv;
Greg Kroah-Hartmanab7cd8c2009-12-15 07:47:28 -0800170};
171
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800172static int __find_interface(struct device *dev, void *data)
mochel@digitalimplant.org6034a082005-03-21 11:09:40 -0800173{
Greg Kroah-Hartmanab7cd8c2009-12-15 07:47:28 -0800174 struct find_interface_arg *arg = data;
Pete Zaitcevf5691d72005-12-21 17:24:54 -0800175 struct usb_interface *intf;
mochel@digitalimplant.org6034a082005-03-21 11:09:40 -0800176
Kay Sievers55129662009-05-04 19:48:32 +0200177 if (!is_usb_interface(dev))
mochel@digitalimplant.org6034a082005-03-21 11:09:40 -0800178 return 0;
179
Russ Dillc2d284e2009-12-14 21:45:35 -0700180 if (dev->driver != arg->drv)
181 return 0;
mochel@digitalimplant.org6034a082005-03-21 11:09:40 -0800182 intf = to_usb_interface(dev);
Russ Dillc2d284e2009-12-14 21:45:35 -0700183 return intf->minor == arg->minor;
mochel@digitalimplant.org6034a082005-03-21 11:09:40 -0800184}
185
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186/**
187 * usb_find_interface - find usb_interface pointer for driver and device
188 * @drv: the driver whose current configuration is considered
189 * @minor: the minor number of the desired device
190 *
Russ Dilla2582bd2009-11-18 11:02:13 -0700191 * This walks the bus device list and returns a pointer to the interface
Russ Dillc2d284e2009-12-14 21:45:35 -0700192 * with the matching minor and driver. Note, this only works for devices
193 * that share the USB major number.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 */
195struct usb_interface *usb_find_interface(struct usb_driver *drv, int minor)
196{
Greg Kroah-Hartmanab7cd8c2009-12-15 07:47:28 -0800197 struct find_interface_arg argb;
Russ Dilla2582bd2009-11-18 11:02:13 -0700198 struct device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
Greg Kroah-Hartmanab7cd8c2009-12-15 07:47:28 -0800200 argb.minor = minor;
Russ Dillc2d284e2009-12-14 21:45:35 -0700201 argb.drv = &drv->drvwrap.driver;
202
203 dev = bus_find_device(&usb_bus_type, NULL, &argb, __find_interface);
Russ Dilla2582bd2009-11-18 11:02:13 -0700204
205 /* Drop reference count from bus_find_device */
206 put_device(dev);
207
208 return dev ? to_usb_interface(dev) : NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600210EXPORT_SYMBOL_GPL(usb_find_interface);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212/**
213 * usb_release_dev - free a usb device structure when all users of it are finished.
214 * @dev: device that's been disconnected
215 *
216 * Will be called only by the device core when all users of this usb device are
217 * done.
218 */
219static void usb_release_dev(struct device *dev)
220{
221 struct usb_device *udev;
Sarah Sharpc6515272009-04-27 19:57:26 -0700222 struct usb_hcd *hcd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223
224 udev = to_usb_device(dev);
Sarah Sharpc6515272009-04-27 19:57:26 -0700225 hcd = bus_to_hcd(udev->bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226
227 usb_destroy_configuration(udev);
Andiry Xu3148bf02011-09-23 14:19:47 -0700228 usb_release_bos_descriptor(udev);
Sarah Sharpc6515272009-04-27 19:57:26 -0700229 usb_put_hcd(hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 kfree(udev->product);
231 kfree(udev->manufacturer);
232 kfree(udev->serial);
233 kfree(udev);
234}
235
Alan Stern4a9bee82007-11-06 15:01:52 -0500236#ifdef CONFIG_HOTPLUG
237static int usb_dev_uevent(struct device *dev, struct kobj_uevent_env *env)
238{
239 struct usb_device *usb_dev;
240
241 usb_dev = to_usb_device(dev);
242
243 if (add_uevent_var(env, "BUSNUM=%03d", usb_dev->bus->busnum))
244 return -ENOMEM;
245
246 if (add_uevent_var(env, "DEVNUM=%03d", usb_dev->devnum))
247 return -ENOMEM;
248
249 return 0;
250}
251
252#else
253
254static int usb_dev_uevent(struct device *dev, struct kobj_uevent_env *env)
255{
256 return -ENODEV;
257}
258#endif /* CONFIG_HOTPLUG */
259
Alan Stern645daaa2006-08-30 15:47:02 -0400260#ifdef CONFIG_PM
261
Alan Sternf2189c42008-08-12 14:34:10 -0400262/* USB device Power-Management thunks.
263 * There's no need to distinguish here between quiescing a USB device
264 * and powering it down; the generic_suspend() routine takes care of
265 * it by skipping the usb_port_suspend() call for a quiesce. And for
266 * USB interfaces there's no difference at all.
267 */
268
269static int usb_dev_prepare(struct device *dev)
270{
271 return 0; /* Implement eventually? */
272}
273
274static void usb_dev_complete(struct device *dev)
275{
276 /* Currently used only for rebinding interfaces */
Oliver Neukum98d9a822012-01-11 08:38:35 +0100277 usb_resume_complete(dev);
Alan Sternf2189c42008-08-12 14:34:10 -0400278}
279
280static int usb_dev_suspend(struct device *dev)
281{
282 return usb_suspend(dev, PMSG_SUSPEND);
283}
284
285static int usb_dev_resume(struct device *dev)
286{
Alan Stern65bfd292008-11-25 16:39:18 -0500287 return usb_resume(dev, PMSG_RESUME);
Alan Sternf2189c42008-08-12 14:34:10 -0400288}
289
290static int usb_dev_freeze(struct device *dev)
291{
292 return usb_suspend(dev, PMSG_FREEZE);
293}
294
295static int usb_dev_thaw(struct device *dev)
296{
Alan Stern65bfd292008-11-25 16:39:18 -0500297 return usb_resume(dev, PMSG_THAW);
Alan Sternf2189c42008-08-12 14:34:10 -0400298}
299
300static int usb_dev_poweroff(struct device *dev)
301{
302 return usb_suspend(dev, PMSG_HIBERNATE);
303}
304
305static int usb_dev_restore(struct device *dev)
306{
Alan Stern65bfd292008-11-25 16:39:18 -0500307 return usb_resume(dev, PMSG_RESTORE);
Alan Sternf2189c42008-08-12 14:34:10 -0400308}
309
Alexey Dobriyan47145212009-12-14 18:00:08 -0800310static const struct dev_pm_ops usb_device_pm_ops = {
Alan Sternf2189c42008-08-12 14:34:10 -0400311 .prepare = usb_dev_prepare,
312 .complete = usb_dev_complete,
313 .suspend = usb_dev_suspend,
314 .resume = usb_dev_resume,
315 .freeze = usb_dev_freeze,
316 .thaw = usb_dev_thaw,
317 .poweroff = usb_dev_poweroff,
318 .restore = usb_dev_restore,
Rafael J. Wysockie1620d52011-03-18 19:55:36 +0100319#ifdef CONFIG_USB_SUSPEND
320 .runtime_suspend = usb_runtime_suspend,
321 .runtime_resume = usb_runtime_resume,
322 .runtime_idle = usb_runtime_idle,
323#endif
Alan Sternf2189c42008-08-12 14:34:10 -0400324};
325
Alan Sterndb063502006-11-13 15:02:04 -0500326#endif /* CONFIG_PM */
Alan Stern645daaa2006-08-30 15:47:02 -0400327
Kay Sieversf7a386c2009-04-30 15:23:42 +0200328
Al Viro2c9ede52011-07-23 20:24:48 -0400329static char *usb_devnode(struct device *dev, umode_t *mode)
Kay Sieversf7a386c2009-04-30 15:23:42 +0200330{
331 struct usb_device *usb_dev;
332
333 usb_dev = to_usb_device(dev);
334 return kasprintf(GFP_KERNEL, "bus/usb/%03d/%03d",
335 usb_dev->bus->busnum, usb_dev->devnum);
336}
337
Alan Sternf2189c42008-08-12 14:34:10 -0400338struct device_type usb_device_type = {
339 .name = "usb_device",
340 .release = usb_release_dev,
341 .uevent = usb_dev_uevent,
Kay Sieverse454cea2009-09-18 23:01:12 +0200342 .devnode = usb_devnode,
Alan Sternb4092142010-08-05 13:12:14 -0400343#ifdef CONFIG_PM
Alan Sternf2189c42008-08-12 14:34:10 -0400344 .pm = &usb_device_pm_ops,
Alan Sternb4092142010-08-05 13:12:14 -0400345#endif
Alan Sternf2189c42008-08-12 14:34:10 -0400346};
347
Inaky Perez-Gonzalezd7d07252007-07-31 20:34:00 -0700348
349/* Returns 1 if @usb_bus is WUSB, 0 otherwise */
350static unsigned usb_bus_is_wusb(struct usb_bus *bus)
351{
352 struct usb_hcd *hcd = container_of(bus, struct usb_hcd, self);
353 return hcd->wireless;
354}
355
356
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357/**
358 * usb_alloc_dev - usb device constructor (usbcore-internal)
359 * @parent: hub to which device is connected; null to allocate a root hub
360 * @bus: bus used to access the device
361 * @port1: one-based index of port; ignored for root hubs
Oliver Neukum92516442007-01-23 15:55:28 -0500362 * Context: !in_interrupt()
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 *
364 * Only hub drivers (including virtual root hub drivers for host
365 * controllers) should ever call this.
366 *
367 * This call may not be used in a non-sleeping context.
368 */
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800369struct usb_device *usb_alloc_dev(struct usb_device *parent,
370 struct usb_bus *bus, unsigned port1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371{
372 struct usb_device *dev;
Inaky Perez-Gonzalezd7d07252007-07-31 20:34:00 -0700373 struct usb_hcd *usb_hcd = container_of(bus, struct usb_hcd, self);
374 unsigned root_hub = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375
Alan Stern0a1ef3b2005-10-24 15:38:24 -0400376 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 if (!dev)
378 return NULL;
379
Alan Stern17200582006-08-30 11:32:52 -0400380 if (!usb_get_hcd(bus_to_hcd(bus))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 kfree(dev);
382 return NULL;
383 }
Sarah Sharpc6515272009-04-27 19:57:26 -0700384 /* Root hubs aren't true devices, so don't allocate HCD resources */
385 if (usb_hcd->driver->alloc_dev && parent &&
386 !usb_hcd->driver->alloc_dev(usb_hcd, dev)) {
387 usb_put_hcd(bus_to_hcd(bus));
388 kfree(dev);
389 return NULL;
390 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391
392 device_initialize(&dev->dev);
393 dev->dev.bus = &usb_bus_type;
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100394 dev->dev.type = &usb_device_type;
Alan Stern2e5f10e2008-04-30 15:37:19 -0400395 dev->dev.groups = usb_device_groups;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 dev->dev.dma_mask = bus->controller->dma_mask;
Yinghai Lu70f458f2007-07-09 12:03:09 -0700397 set_dev_node(&dev->dev, dev_to_node(bus->controller));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 dev->state = USB_STATE_ATTACHED;
Sarah Sharp4d59d8a2007-10-03 14:56:03 -0700399 atomic_set(&dev->urbnum, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400
401 INIT_LIST_HEAD(&dev->ep0.urb_list);
402 dev->ep0.desc.bLength = USB_DT_ENDPOINT_SIZE;
403 dev->ep0.desc.bDescriptorType = USB_DT_ENDPOINT;
404 /* ep0 maxpacket comes later, from device descriptor */
David Vrabel3444b262009-04-08 17:36:28 +0000405 usb_enable_endpoint(dev, &dev->ep0, false);
Alan Stern6840d252007-09-10 11:34:26 -0400406 dev->can_submit = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407
408 /* Save readable and stable topology id, distinguishing devices
409 * by location for diagnostics, tools, driver model, etc. The
410 * string is a path along hub ports, from the root. Each device's
411 * dev->devpath will be stable until USB is re-cabled, and hubs
Kay Sievers7071a3c2008-05-02 06:02:41 +0200412 * are often labeled with these port numbers. The name isn't
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 * as stable: bus->busnum changes easily from modprobe order,
414 * cardbus or pci hotplugging, and so on.
415 */
Oliver Neukum92516442007-01-23 15:55:28 -0500416 if (unlikely(!parent)) {
417 dev->devpath[0] = '0';
Sarah Sharp7206b002009-04-27 19:54:49 -0700418 dev->route = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419
420 dev->dev.parent = bus->controller;
Kay Sievers0031a062008-05-02 06:02:41 +0200421 dev_set_name(&dev->dev, "usb%d", bus->busnum);
Inaky Perez-Gonzalezd7d07252007-07-31 20:34:00 -0700422 root_hub = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 } else {
424 /* match any labeling on the hubs; it's one-based */
Sarah Sharp7206b002009-04-27 19:54:49 -0700425 if (parent->devpath[0] == '0') {
Oliver Neukum92516442007-01-23 15:55:28 -0500426 snprintf(dev->devpath, sizeof dev->devpath,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 "%d", port1);
Sarah Sharp7206b002009-04-27 19:54:49 -0700428 /* Root ports are not counted in route string */
429 dev->route = 0;
430 } else {
Oliver Neukum92516442007-01-23 15:55:28 -0500431 snprintf(dev->devpath, sizeof dev->devpath,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 "%s.%d", parent->devpath, port1);
Sarah Sharp4a0cd962009-09-04 10:53:17 -0700433 /* Route string assumes hubs have less than 16 ports */
434 if (port1 < 15)
435 dev->route = parent->route +
436 (port1 << ((parent->level - 1)*4));
437 else
438 dev->route = parent->route +
439 (15 << ((parent->level - 1)*4));
Sarah Sharp7206b002009-04-27 19:54:49 -0700440 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441
442 dev->dev.parent = &parent->dev;
Kay Sievers0031a062008-05-02 06:02:41 +0200443 dev_set_name(&dev->dev, "%d-%s", bus->busnum, dev->devpath);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444
445 /* hub driver sets up TT records */
446 }
447
Alan Stern12c3da32005-11-23 12:09:52 -0500448 dev->portnum = port1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 dev->bus = bus;
450 dev->parent = parent;
451 INIT_LIST_HEAD(&dev->filelist);
452
Alan Stern645daaa2006-08-30 15:47:02 -0400453#ifdef CONFIG_PM
Alan Sternfcc4a012010-11-15 15:57:51 -0500454 pm_runtime_set_autosuspend_delay(&dev->dev,
455 usb_autosuspend_delay * 1000);
Sarah Sharp15123002007-12-21 16:54:15 -0800456 dev->connect_time = jiffies;
457 dev->active_duration = -jiffies;
Alan Stern645daaa2006-08-30 15:47:02 -0400458#endif
Inaky Perez-Gonzalezd7d07252007-07-31 20:34:00 -0700459 if (root_hub) /* Root hub always ok [and always wired] */
460 dev->authorized = 1;
461 else {
462 dev->authorized = usb_hcd->authorized_default;
463 dev->wusb = usb_bus_is_wusb(bus)? 1 : 0;
464 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 return dev;
466}
467
468/**
469 * usb_get_dev - increments the reference count of the usb device structure
470 * @dev: the device being referenced
471 *
472 * Each live reference to a device should be refcounted.
473 *
474 * Drivers for USB interfaces should normally record such references in
475 * their probe() methods, when they bind to an interface, and release
476 * them by calling usb_put_dev(), in their disconnect() methods.
477 *
478 * A pointer to the device with the incremented reference counter is returned.
479 */
480struct usb_device *usb_get_dev(struct usb_device *dev)
481{
482 if (dev)
483 get_device(&dev->dev);
484 return dev;
485}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600486EXPORT_SYMBOL_GPL(usb_get_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487
488/**
489 * usb_put_dev - release a use of the usb device structure
490 * @dev: device that's been disconnected
491 *
492 * Must be called when a user of a device is finished with it. When the last
493 * user of the device calls this function, the memory of the device is freed.
494 */
495void usb_put_dev(struct usb_device *dev)
496{
497 if (dev)
498 put_device(&dev->dev);
499}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600500EXPORT_SYMBOL_GPL(usb_put_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501
502/**
503 * usb_get_intf - increments the reference count of the usb interface structure
504 * @intf: the interface being referenced
505 *
506 * Each live reference to a interface must be refcounted.
507 *
508 * Drivers for USB interfaces should normally record such references in
509 * their probe() methods, when they bind to an interface, and release
510 * them by calling usb_put_intf(), in their disconnect() methods.
511 *
512 * A pointer to the interface with the incremented reference counter is
513 * returned.
514 */
515struct usb_interface *usb_get_intf(struct usb_interface *intf)
516{
517 if (intf)
518 get_device(&intf->dev);
519 return intf;
520}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600521EXPORT_SYMBOL_GPL(usb_get_intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522
523/**
524 * usb_put_intf - release a use of the usb interface structure
525 * @intf: interface that's been decremented
526 *
527 * Must be called when a user of an interface is finished with it. When the
528 * last user of the interface calls this function, the memory of the interface
529 * is freed.
530 */
531void usb_put_intf(struct usb_interface *intf)
532{
533 if (intf)
534 put_device(&intf->dev);
535}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600536EXPORT_SYMBOL_GPL(usb_put_intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537
538/* USB device locking
539 *
Alan Stern9ad3d6c2005-11-17 17:10:32 -0500540 * USB devices and interfaces are locked using the semaphore in their
541 * embedded struct device. The hub driver guarantees that whenever a
542 * device is connected or disconnected, drivers are called with the
543 * USB device locked as well as their particular interface.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544 *
545 * Complications arise when several devices are to be locked at the same
546 * time. Only hub-aware drivers that are part of usbcore ever have to
Alan Stern9ad3d6c2005-11-17 17:10:32 -0500547 * do this; nobody else needs to worry about it. The rule for locking
548 * is simple:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549 *
550 * When locking both a device and its parent, always lock the
551 * the parent first.
552 */
553
554/**
Randy Dunlapd0bcabc2008-02-29 22:03:07 -0800555 * usb_lock_device_for_reset - cautiously acquire the lock for a usb device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 * @udev: device that's being locked
557 * @iface: interface bound to the driver making the request (optional)
558 *
559 * Attempts to acquire the device lock, but fails if the device is
560 * NOTATTACHED or SUSPENDED, or if iface is specified and the interface
561 * is neither BINDING nor BOUND. Rather than sleeping to wait for the
562 * lock, the routine polls repeatedly. This is to prevent deadlock with
563 * disconnect; in some drivers (such as usb-storage) the disconnect()
Alan Stern3ea15962005-08-11 10:15:39 -0400564 * or suspend() method will block waiting for a device reset to complete.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 *
Alan Stern011b15d2008-11-04 11:29:27 -0500566 * Returns a negative error code for failure, otherwise 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 */
568int usb_lock_device_for_reset(struct usb_device *udev,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300569 const struct usb_interface *iface)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570{
Alan Stern3ea15962005-08-11 10:15:39 -0400571 unsigned long jiffies_expire = jiffies + HZ;
572
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 if (udev->state == USB_STATE_NOTATTACHED)
574 return -ENODEV;
575 if (udev->state == USB_STATE_SUSPENDED)
576 return -EHOSTUNREACH;
Alan Stern011b15d2008-11-04 11:29:27 -0500577 if (iface && (iface->condition == USB_INTERFACE_UNBINDING ||
578 iface->condition == USB_INTERFACE_UNBOUND))
579 return -EINTR;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580
Thomas Gleixner31427882010-01-29 20:39:02 +0000581 while (!usb_trylock_device(udev)) {
Alan Stern3ea15962005-08-11 10:15:39 -0400582
583 /* If we can't acquire the lock after waiting one second,
584 * we're probably deadlocked */
585 if (time_after(jiffies, jiffies_expire))
586 return -EBUSY;
587
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 msleep(15);
589 if (udev->state == USB_STATE_NOTATTACHED)
590 return -ENODEV;
591 if (udev->state == USB_STATE_SUSPENDED)
592 return -EHOSTUNREACH;
Alan Stern011b15d2008-11-04 11:29:27 -0500593 if (iface && (iface->condition == USB_INTERFACE_UNBINDING ||
594 iface->condition == USB_INTERFACE_UNBOUND))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 return -EINTR;
596 }
Alan Stern011b15d2008-11-04 11:29:27 -0500597 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600599EXPORT_SYMBOL_GPL(usb_lock_device_for_reset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 * usb_get_current_frame_number - return current bus frame number
603 * @dev: the device whose bus is being queried
604 *
605 * Returns the current frame number for the USB host controller
606 * used with the given USB device. This can be used when scheduling
607 * isochronous requests.
608 *
609 * Note that different kinds of host controller have different
610 * "scheduling horizons". While one type might support scheduling only
611 * 32 frames into the future, others could support scheduling up to
612 * 1024 frames into the future.
613 */
614int usb_get_current_frame_number(struct usb_device *dev)
615{
Oliver Neukum92516442007-01-23 15:55:28 -0500616 return usb_hcd_get_frame_number(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600618EXPORT_SYMBOL_GPL(usb_get_current_frame_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619
620/*-------------------------------------------------------------------*/
621/*
622 * __usb_get_extra_descriptor() finds a descriptor of specific type in the
623 * extra field of the interface and endpoint descriptor structs.
624 */
625
626int __usb_get_extra_descriptor(char *buffer, unsigned size,
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800627 unsigned char type, void **ptr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628{
629 struct usb_descriptor_header *header;
630
631 while (size >= sizeof(struct usb_descriptor_header)) {
632 header = (struct usb_descriptor_header *)buffer;
633
634 if (header->bLength < 2) {
635 printk(KERN_ERR
636 "%s: bogus descriptor, type %d length %d\n",
637 usbcore_name,
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800638 header->bDescriptorType,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 header->bLength);
640 return -1;
641 }
642
643 if (header->bDescriptorType == type) {
644 *ptr = header;
645 return 0;
646 }
647
648 buffer += header->bLength;
649 size -= header->bLength;
650 }
651 return -1;
652}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600653EXPORT_SYMBOL_GPL(__usb_get_extra_descriptor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654
655/**
Daniel Mack073900a2010-04-12 13:17:25 +0200656 * usb_alloc_coherent - allocate dma-consistent buffer for URB_NO_xxx_DMA_MAP
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 * @dev: device the buffer will be used with
658 * @size: requested buffer size
659 * @mem_flags: affect whether allocation may block
660 * @dma: used to return DMA address of buffer
661 *
662 * Return value is either null (indicating no buffer could be allocated), or
663 * the cpu-space pointer to a buffer that may be used to perform DMA to the
664 * specified device. Such cpu-space buffers are returned along with the DMA
665 * address (through the pointer provided).
666 *
667 * These buffers are used with URB_NO_xxx_DMA_MAP set in urb->transfer_flags
David Brownellfbf54dd2007-07-01 23:33:12 -0700668 * to avoid behaviors like using "DMA bounce buffers", or thrashing IOMMU
669 * hardware during URB completion/resubmit. The implementation varies between
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 * platforms, depending on details of how DMA will work to this device.
David Brownellfbf54dd2007-07-01 23:33:12 -0700671 * Using these buffers also eliminates cacheline sharing problems on
672 * architectures where CPU caches are not DMA-coherent. On systems without
673 * bus-snooping caches, these buffers are uncached.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 *
Daniel Mack073900a2010-04-12 13:17:25 +0200675 * When the buffer is no longer used, free it with usb_free_coherent().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 */
Daniel Mack073900a2010-04-12 13:17:25 +0200677void *usb_alloc_coherent(struct usb_device *dev, size_t size, gfp_t mem_flags,
678 dma_addr_t *dma)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679{
Alan Sterna6d2bb92006-08-30 11:27:36 -0400680 if (!dev || !dev->bus)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 return NULL;
Oliver Neukum92516442007-01-23 15:55:28 -0500682 return hcd_buffer_alloc(dev->bus, size, mem_flags, dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683}
Daniel Mack073900a2010-04-12 13:17:25 +0200684EXPORT_SYMBOL_GPL(usb_alloc_coherent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685
686/**
Daniel Mack073900a2010-04-12 13:17:25 +0200687 * usb_free_coherent - free memory allocated with usb_alloc_coherent()
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688 * @dev: device the buffer was used with
689 * @size: requested buffer size
690 * @addr: CPU address of buffer
691 * @dma: DMA address of buffer
692 *
693 * This reclaims an I/O buffer, letting it be reused. The memory must have
Daniel Mack073900a2010-04-12 13:17:25 +0200694 * been allocated using usb_alloc_coherent(), and the parameters must match
David Brownellfbf54dd2007-07-01 23:33:12 -0700695 * those provided in that allocation request.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 */
Daniel Mack073900a2010-04-12 13:17:25 +0200697void usb_free_coherent(struct usb_device *dev, size_t size, void *addr,
698 dma_addr_t dma)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699{
Alan Sterna6d2bb92006-08-30 11:27:36 -0400700 if (!dev || !dev->bus)
Dmitry Torokhovb94badb2006-08-01 22:33:34 -0400701 return;
702 if (!addr)
703 return;
Oliver Neukum92516442007-01-23 15:55:28 -0500704 hcd_buffer_free(dev->bus, size, addr, dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705}
Daniel Mack073900a2010-04-12 13:17:25 +0200706EXPORT_SYMBOL_GPL(usb_free_coherent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707
708/**
709 * usb_buffer_map - create DMA mapping(s) for an urb
710 * @urb: urb whose transfer_buffer/setup_packet will be mapped
711 *
712 * Return value is either null (indicating no buffer could be mapped), or
Alan Stern0ede76f2010-03-05 15:10:17 -0500713 * the parameter. URB_NO_TRANSFER_DMA_MAP is
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714 * added to urb->transfer_flags if the operation succeeds. If the device
715 * is connected to this system through a non-DMA controller, this operation
716 * always succeeds.
717 *
718 * This call would normally be used for an urb which is reused, perhaps
719 * as the target of a large periodic transfer, with usb_buffer_dmasync()
720 * calls to synchronize memory and dma state.
721 *
722 * Reverse the effect of this call with usb_buffer_unmap().
723 */
724#if 0
Oliver Neukum92516442007-01-23 15:55:28 -0500725struct urb *usb_buffer_map(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726{
727 struct usb_bus *bus;
728 struct device *controller;
729
730 if (!urb
731 || !urb->dev
732 || !(bus = urb->dev->bus)
733 || !(controller = bus->controller))
734 return NULL;
735
736 if (controller->dma_mask) {
Oliver Neukum92516442007-01-23 15:55:28 -0500737 urb->transfer_dma = dma_map_single(controller,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 urb->transfer_buffer, urb->transfer_buffer_length,
Oliver Neukum92516442007-01-23 15:55:28 -0500739 usb_pipein(urb->pipe)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800741 /* FIXME generic api broken like pci, can't report errors */
742 /* if (urb->transfer_dma == DMA_ADDR_INVALID) return 0; */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 } else
744 urb->transfer_dma = ~0;
Alan Stern0ede76f2010-03-05 15:10:17 -0500745 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 return urb;
747}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600748EXPORT_SYMBOL_GPL(usb_buffer_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749#endif /* 0 */
750
751/* XXX DISABLED, no users currently. If you wish to re-enable this
752 * XXX please determine whether the sync is to transfer ownership of
753 * XXX the buffer from device to cpu or vice verse, and thusly use the
754 * XXX appropriate _for_{cpu,device}() method. -DaveM
755 */
756#if 0
757
758/**
759 * usb_buffer_dmasync - synchronize DMA and CPU view of buffer(s)
760 * @urb: urb whose transfer_buffer/setup_packet will be synchronized
761 */
Oliver Neukum92516442007-01-23 15:55:28 -0500762void usb_buffer_dmasync(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763{
764 struct usb_bus *bus;
765 struct device *controller;
766
767 if (!urb
768 || !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)
769 || !urb->dev
770 || !(bus = urb->dev->bus)
771 || !(controller = bus->controller))
772 return;
773
774 if (controller->dma_mask) {
FUJITA Tomonori9b8e7ba2009-05-28 10:10:44 +0900775 dma_sync_single_for_cpu(controller,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776 urb->transfer_dma, urb->transfer_buffer_length,
Oliver Neukum92516442007-01-23 15:55:28 -0500777 usb_pipein(urb->pipe)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
Oliver Neukum92516442007-01-23 15:55:28 -0500779 if (usb_pipecontrol(urb->pipe))
FUJITA Tomonori9b8e7ba2009-05-28 10:10:44 +0900780 dma_sync_single_for_cpu(controller,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 urb->setup_dma,
Oliver Neukum92516442007-01-23 15:55:28 -0500782 sizeof(struct usb_ctrlrequest),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 DMA_TO_DEVICE);
784 }
785}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600786EXPORT_SYMBOL_GPL(usb_buffer_dmasync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787#endif
788
789/**
790 * usb_buffer_unmap - free DMA mapping(s) for an urb
791 * @urb: urb whose transfer_buffer will be unmapped
792 *
793 * Reverses the effect of usb_buffer_map().
794 */
795#if 0
Oliver Neukum92516442007-01-23 15:55:28 -0500796void usb_buffer_unmap(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797{
798 struct usb_bus *bus;
799 struct device *controller;
800
801 if (!urb
802 || !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)
803 || !urb->dev
804 || !(bus = urb->dev->bus)
805 || !(controller = bus->controller))
806 return;
807
808 if (controller->dma_mask) {
Oliver Neukum92516442007-01-23 15:55:28 -0500809 dma_unmap_single(controller,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 urb->transfer_dma, urb->transfer_buffer_length,
Oliver Neukum92516442007-01-23 15:55:28 -0500811 usb_pipein(urb->pipe)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 }
Alan Stern0ede76f2010-03-05 15:10:17 -0500814 urb->transfer_flags &= ~URB_NO_TRANSFER_DMA_MAP;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600816EXPORT_SYMBOL_GPL(usb_buffer_unmap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817#endif /* 0 */
818
Alan Sternff9c8952010-04-02 13:27:28 -0400819#if 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820/**
821 * usb_buffer_map_sg - create scatterlist DMA mapping(s) for an endpoint
822 * @dev: device to which the scatterlist will be mapped
Alan Stern5e60a162007-07-30 17:07:21 -0400823 * @is_in: mapping transfer direction
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 * @sg: the scatterlist to map
825 * @nents: the number of entries in the scatterlist
826 *
827 * Return value is either < 0 (indicating no buffers could be mapped), or
828 * the number of DMA mapping array entries in the scatterlist.
829 *
830 * The caller is responsible for placing the resulting DMA addresses from
831 * the scatterlist into URB transfer buffer pointers, and for setting the
832 * URB_NO_TRANSFER_DMA_MAP transfer flag in each of those URBs.
833 *
834 * Top I/O rates come from queuing URBs, instead of waiting for each one
835 * to complete before starting the next I/O. This is particularly easy
836 * to do with scatterlists. Just allocate and submit one URB for each DMA
837 * mapping entry returned, stopping on the first error or when all succeed.
838 * Better yet, use the usb_sg_*() calls, which do that (and more) for you.
839 *
840 * This call would normally be used when translating scatterlist requests,
841 * rather than usb_buffer_map(), since on some hardware (with IOMMUs) it
842 * may be able to coalesce mappings for improved I/O efficiency.
843 *
844 * Reverse the effect of this call with usb_buffer_unmap_sg().
845 */
Alan Stern5e60a162007-07-30 17:07:21 -0400846int usb_buffer_map_sg(const struct usb_device *dev, int is_in,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300847 struct scatterlist *sg, int nents)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848{
849 struct usb_bus *bus;
850 struct device *controller;
851
852 if (!dev
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 || !(bus = dev->bus)
854 || !(controller = bus->controller)
855 || !controller->dma_mask)
Jiri Slaby29122822009-08-22 20:24:49 +0200856 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800858 /* FIXME generic api broken like pci, can't report errors */
Oliver Neukum92516442007-01-23 15:55:28 -0500859 return dma_map_sg(controller, sg, nents,
Jiri Slaby29122822009-08-22 20:24:49 +0200860 is_in ? DMA_FROM_DEVICE : DMA_TO_DEVICE) ? : -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600862EXPORT_SYMBOL_GPL(usb_buffer_map_sg);
Alan Sternff9c8952010-04-02 13:27:28 -0400863#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864
865/* XXX DISABLED, no users currently. If you wish to re-enable this
866 * XXX please determine whether the sync is to transfer ownership of
867 * XXX the buffer from device to cpu or vice verse, and thusly use the
868 * XXX appropriate _for_{cpu,device}() method. -DaveM
869 */
870#if 0
871
872/**
873 * usb_buffer_dmasync_sg - synchronize DMA and CPU view of scatterlist buffer(s)
874 * @dev: device to which the scatterlist will be mapped
Alan Stern5e60a162007-07-30 17:07:21 -0400875 * @is_in: mapping transfer direction
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 * @sg: the scatterlist to synchronize
877 * @n_hw_ents: the positive return value from usb_buffer_map_sg
878 *
879 * Use this when you are re-using a scatterlist's data buffers for
880 * another USB request.
881 */
Alan Stern5e60a162007-07-30 17:07:21 -0400882void usb_buffer_dmasync_sg(const struct usb_device *dev, int is_in,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300883 struct scatterlist *sg, int n_hw_ents)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884{
885 struct usb_bus *bus;
886 struct device *controller;
887
888 if (!dev
889 || !(bus = dev->bus)
890 || !(controller = bus->controller)
891 || !controller->dma_mask)
892 return;
893
FUJITA Tomonori9b8e7ba2009-05-28 10:10:44 +0900894 dma_sync_sg_for_cpu(controller, sg, n_hw_ents,
895 is_in ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600897EXPORT_SYMBOL_GPL(usb_buffer_dmasync_sg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898#endif
899
Alan Sternff9c8952010-04-02 13:27:28 -0400900#if 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901/**
902 * usb_buffer_unmap_sg - free DMA mapping(s) for a scatterlist
903 * @dev: device to which the scatterlist will be mapped
Alan Stern5e60a162007-07-30 17:07:21 -0400904 * @is_in: mapping transfer direction
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905 * @sg: the scatterlist to unmap
906 * @n_hw_ents: the positive return value from usb_buffer_map_sg
907 *
908 * Reverses the effect of usb_buffer_map_sg().
909 */
Alan Stern5e60a162007-07-30 17:07:21 -0400910void usb_buffer_unmap_sg(const struct usb_device *dev, int is_in,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300911 struct scatterlist *sg, int n_hw_ents)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912{
913 struct usb_bus *bus;
914 struct device *controller;
915
916 if (!dev
917 || !(bus = dev->bus)
918 || !(controller = bus->controller)
919 || !controller->dma_mask)
920 return;
921
Oliver Neukum92516442007-01-23 15:55:28 -0500922 dma_unmap_sg(controller, sg, n_hw_ents,
Alan Stern5e60a162007-07-30 17:07:21 -0400923 is_in ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600925EXPORT_SYMBOL_GPL(usb_buffer_unmap_sg);
Alan Sternff9c8952010-04-02 13:27:28 -0400926#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927
Rusty Russell785895f2008-11-22 13:01:06 +1030928/* To disable USB, kernel command line is 'nousb' not 'usbcore.nousb' */
929#ifdef MODULE
930module_param(nousb, bool, 0444);
931#else
932core_param(nousb, nousb, bool, 0444);
933#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934
935/*
936 * for external read access to <nousb>
937 */
938int usb_disabled(void)
939{
940 return nousb;
941}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600942EXPORT_SYMBOL_GPL(usb_disabled);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943
944/*
Alan Stern3b23dd62008-12-05 14:10:34 -0500945 * Notifications of device and interface registration
946 */
947static int usb_bus_notify(struct notifier_block *nb, unsigned long action,
948 void *data)
949{
950 struct device *dev = data;
951
952 switch (action) {
953 case BUS_NOTIFY_ADD_DEVICE:
954 if (dev->type == &usb_device_type)
955 (void) usb_create_sysfs_dev_files(to_usb_device(dev));
956 else if (dev->type == &usb_if_device_type)
Michal Nazarewicz643de622011-04-14 17:47:09 +0200957 usb_create_sysfs_intf_files(to_usb_interface(dev));
Alan Stern3b23dd62008-12-05 14:10:34 -0500958 break;
959
960 case BUS_NOTIFY_DEL_DEVICE:
961 if (dev->type == &usb_device_type)
962 usb_remove_sysfs_dev_files(to_usb_device(dev));
963 else if (dev->type == &usb_if_device_type)
964 usb_remove_sysfs_intf_files(to_usb_interface(dev));
965 break;
966 }
967 return 0;
968}
969
970static struct notifier_block usb_bus_nb = {
971 .notifier_call = usb_bus_notify,
972};
973
Greg Kroah-Hartman00048b82009-04-24 14:56:26 -0700974struct dentry *usb_debug_root;
975EXPORT_SYMBOL_GPL(usb_debug_root);
976
Felipe Balbi719a6e82009-12-04 15:47:42 +0200977static struct dentry *usb_debug_devices;
Greg Kroah-Hartman97d7b7a2009-04-24 15:16:04 -0700978
Greg Kroah-Hartman00048b82009-04-24 14:56:26 -0700979static int usb_debugfs_init(void)
980{
981 usb_debug_root = debugfs_create_dir("usb", NULL);
982 if (!usb_debug_root)
983 return -ENOENT;
Greg Kroah-Hartman97d7b7a2009-04-24 15:16:04 -0700984
985 usb_debug_devices = debugfs_create_file("devices", 0444,
986 usb_debug_root, NULL,
987 &usbfs_devices_fops);
988 if (!usb_debug_devices) {
989 debugfs_remove(usb_debug_root);
990 usb_debug_root = NULL;
991 return -ENOENT;
992 }
993
Greg Kroah-Hartman00048b82009-04-24 14:56:26 -0700994 return 0;
995}
996
997static void usb_debugfs_cleanup(void)
998{
Greg Kroah-Hartman97d7b7a2009-04-24 15:16:04 -0700999 debugfs_remove(usb_debug_devices);
Greg Kroah-Hartman00048b82009-04-24 14:56:26 -07001000 debugfs_remove(usb_debug_root);
1001}
1002
Alan Stern3b23dd62008-12-05 14:10:34 -05001003/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004 * Init
1005 */
1006static int __init usb_init(void)
1007{
1008 int retval;
1009 if (nousb) {
Oliver Neukum92516442007-01-23 15:55:28 -05001010 pr_info("%s: USB support disabled\n", usbcore_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011 return 0;
1012 }
1013
Greg Kroah-Hartman00048b82009-04-24 14:56:26 -07001014 retval = usb_debugfs_init();
1015 if (retval)
1016 goto out;
1017
Sasha Levinea79c2e2012-05-16 14:11:15 +02001018 usb_acpi_register();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019 retval = bus_register(&usb_bus_type);
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -08001020 if (retval)
Alan Sternbd859282006-09-19 10:14:07 -04001021 goto bus_register_failed;
Alan Stern3b23dd62008-12-05 14:10:34 -05001022 retval = bus_register_notifier(&usb_bus_type, &usb_bus_nb);
1023 if (retval)
1024 goto bus_notifier_failed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025 retval = usb_major_init();
1026 if (retval)
1027 goto major_init_failed;
Kay Sieversfbf82fd2005-07-31 01:05:53 +02001028 retval = usb_register(&usbfs_driver);
1029 if (retval)
1030 goto driver_register_failed;
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001031 retval = usb_devio_init();
Kay Sieversfbf82fd2005-07-31 01:05:53 +02001032 if (retval)
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001033 goto usb_devio_init_failed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034 retval = usb_hub_init();
1035 if (retval)
1036 goto hub_init_failed;
Alan Stern8bb54ab2006-07-01 22:08:49 -04001037 retval = usb_register_device_driver(&usb_generic_driver, THIS_MODULE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038 if (!retval)
1039 goto out;
1040
1041 usb_hub_cleanup();
1042hub_init_failed:
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001043 usb_devio_cleanup();
1044usb_devio_init_failed:
Kay Sieversfbf82fd2005-07-31 01:05:53 +02001045 usb_deregister(&usbfs_driver);
1046driver_register_failed:
1047 usb_major_cleanup();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048major_init_failed:
Alan Stern3b23dd62008-12-05 14:10:34 -05001049 bus_unregister_notifier(&usb_bus_type, &usb_bus_nb);
1050bus_notifier_failed:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051 bus_unregister(&usb_bus_type);
Alan Sternbd859282006-09-19 10:14:07 -04001052bus_register_failed:
Matthew Garrettda0af6e2012-05-11 16:08:27 +08001053 usb_acpi_unregister();
Alan Stern9bbdf1e2010-01-08 12:57:28 -05001054 usb_debugfs_cleanup();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055out:
1056 return retval;
1057}
1058
1059/*
1060 * Cleanup
1061 */
1062static void __exit usb_exit(void)
1063{
1064 /* This will matter if shutdown/reboot does exitcalls. */
1065 if (nousb)
1066 return;
1067
Alan Stern8bb54ab2006-07-01 22:08:49 -04001068 usb_deregister_device_driver(&usb_generic_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 usb_major_cleanup();
Kay Sieversfbf82fd2005-07-31 01:05:53 +02001070 usb_deregister(&usbfs_driver);
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001071 usb_devio_cleanup();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 usb_hub_cleanup();
Alan Stern3b23dd62008-12-05 14:10:34 -05001073 bus_unregister_notifier(&usb_bus_type, &usb_bus_nb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074 bus_unregister(&usb_bus_type);
Matthew Garrettda0af6e2012-05-11 16:08:27 +08001075 usb_acpi_unregister();
Greg Kroah-Hartman00048b82009-04-24 14:56:26 -07001076 usb_debugfs_cleanup();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077}
1078
1079subsys_initcall(usb_init);
1080module_exit(usb_exit);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081MODULE_LICENSE("GPL");