]>
Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /* |
f30c2269 | 2 | * drivers/usb/core/usb.c |
1da177e4 LT |
3 | * |
4 | * (C) Copyright Linus Torvalds 1999 | |
5 | * (C) Copyright Johannes Erdfelt 1999-2001 | |
6 | * (C) Copyright Andreas Gal 1999 | |
7 | * (C) Copyright Gregory P. Smith 1999 | |
8 | * (C) Copyright Deti Fliegl 1999 (new USB architecture) | |
9 | * (C) Copyright Randy Dunlap 2000 | |
10 | * (C) Copyright David Brownell 2000-2004 | |
11 | * (C) Copyright Yggdrasil Computing, Inc. 2000 | |
12 | * (usb_device_id matching changes by Adam J. Richter) | |
13 | * (C) Copyright Greg Kroah-Hartman 2002-2003 | |
14 | * | |
15 | * NOTE! This is not actually a driver at all, rather this is | |
16 | * just a collection of helper routines that implement the | |
17 | * generic USB things that the real drivers can use.. | |
18 | * | |
19 | * Think of this as a "USB library" rather than anything else. | |
20 | * It should be considered a slave, with no callbacks. Callbacks | |
21 | * are evil. | |
22 | */ | |
23 | ||
1da177e4 | 24 | #include <linux/module.h> |
b5e795f8 | 25 | #include <linux/moduleparam.h> |
1da177e4 LT |
26 | #include <linux/string.h> |
27 | #include <linux/bitops.h> | |
28 | #include <linux/slab.h> | |
29 | #include <linux/interrupt.h> /* for in_interrupt() */ | |
30 | #include <linux/kmod.h> | |
31 | #include <linux/init.h> | |
32 | #include <linux/spinlock.h> | |
33 | #include <linux/errno.h> | |
1da177e4 | 34 | #include <linux/usb.h> |
4186ecf8 | 35 | #include <linux/mutex.h> |
bd859281 | 36 | #include <linux/workqueue.h> |
00048b8b | 37 | #include <linux/debugfs.h> |
1da177e4 LT |
38 | |
39 | #include <asm/io.h> | |
87ae9afd | 40 | #include <linux/scatterlist.h> |
1da177e4 LT |
41 | #include <linux/mm.h> |
42 | #include <linux/dma-mapping.h> | |
43 | ||
44 | #include "hcd.h" | |
45 | #include "usb.h" | |
46 | ||
1da177e4 LT |
47 | |
48 | const char *usbcore_name = "usbcore"; | |
49 | ||
50 | static int nousb; /* Disable USB when built into kernel image */ | |
1da177e4 | 51 | |
6b157c9b AS |
52 | /* Workqueue for autosuspend and for remote wakeup of root hubs */ |
53 | struct workqueue_struct *ksuspend_usb_wq; | |
bd859281 | 54 | |
b5e795f8 AS |
55 | #ifdef CONFIG_USB_SUSPEND |
56 | static int usb_autosuspend_delay = 2; /* Default delay value, | |
57 | * in seconds */ | |
eaafbc3a | 58 | module_param_named(autosuspend, usb_autosuspend_delay, int, 0644); |
b5e795f8 AS |
59 | MODULE_PARM_DESC(autosuspend, "default autosuspend delay"); |
60 | ||
61 | #else | |
62 | #define usb_autosuspend_delay 0 | |
63 | #endif | |
64 | ||
1da177e4 | 65 | |
91017f9c SS |
66 | /** |
67 | * 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 | */ | |
75 | struct 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 | } | |
101 | EXPORT_SYMBOL_GPL(usb_find_alt_setting); | |
102 | ||
1da177e4 LT |
103 | /** |
104 | * 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 | */ | |
095bc335 LFC |
122 | struct usb_interface *usb_ifnum_to_if(const struct usb_device *dev, |
123 | unsigned ifnum) | |
1da177e4 LT |
124 | { |
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 | } | |
782e70c6 | 137 | EXPORT_SYMBOL_GPL(usb_ifnum_to_if); |
1da177e4 LT |
138 | |
139 | /** | |
d0bcabcd | 140 | * usb_altnum_to_altsetting - get the altsetting structure with a given alternate setting number. |
1da177e4 LT |
141 | * @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 | */ | |
2c044a48 GKH |
156 | struct usb_host_interface *usb_altnum_to_altsetting( |
157 | const struct usb_interface *intf, | |
158 | unsigned int altnum) | |
1da177e4 LT |
159 | { |
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 | } | |
782e70c6 | 168 | EXPORT_SYMBOL_GPL(usb_altnum_to_altsetting); |
1da177e4 | 169 | |
ab7cd8c7 GKH |
170 | struct find_interface_arg { |
171 | int minor; | |
172 | struct usb_interface *interface; | |
173 | }; | |
174 | ||
2c044a48 | 175 | static int __find_interface(struct device *dev, void *data) |
6034a080 | 176 | { |
ab7cd8c7 | 177 | struct find_interface_arg *arg = data; |
f5691d70 | 178 | struct usb_interface *intf; |
6034a080 | 179 | |
55129666 | 180 | if (!is_usb_interface(dev)) |
6034a080 PM |
181 | return 0; |
182 | ||
183 | intf = to_usb_interface(dev); | |
ab7cd8c7 GKH |
184 | if (intf->minor != -1 && intf->minor == arg->minor) { |
185 | arg->interface = intf; | |
6034a080 | 186 | return 1; |
ab7cd8c7 | 187 | } |
6034a080 PM |
188 | return 0; |
189 | } | |
190 | ||
1da177e4 LT |
191 | /** |
192 | * usb_find_interface - find usb_interface pointer for driver and device | |
193 | * @drv: the driver whose current configuration is considered | |
194 | * @minor: the minor number of the desired device | |
195 | * | |
ab7cd8c7 | 196 | * This walks the driver device list and returns a pointer to the interface |
1da177e4 LT |
197 | * with the matching minor. Note, this only works for devices that share the |
198 | * USB major number. | |
199 | */ | |
200 | struct usb_interface *usb_find_interface(struct usb_driver *drv, int minor) | |
201 | { | |
ab7cd8c7 GKH |
202 | struct find_interface_arg argb; |
203 | int retval; | |
204 | ||
205 | argb.minor = minor; | |
206 | argb.interface = NULL; | |
207 | /* eat the error, it will be in argb.interface */ | |
208 | retval = driver_for_each_device(&drv->drvwrap.driver, NULL, &argb, | |
209 | __find_interface); | |
210 | return argb.interface; | |
1da177e4 | 211 | } |
782e70c6 | 212 | EXPORT_SYMBOL_GPL(usb_find_interface); |
1da177e4 | 213 | |
1da177e4 LT |
214 | /** |
215 | * usb_release_dev - free a usb device structure when all users of it are finished. | |
216 | * @dev: device that's been disconnected | |
217 | * | |
218 | * Will be called only by the device core when all users of this usb device are | |
219 | * done. | |
220 | */ | |
221 | static void usb_release_dev(struct device *dev) | |
222 | { | |
223 | struct usb_device *udev; | |
c6515272 | 224 | struct usb_hcd *hcd; |
1da177e4 LT |
225 | |
226 | udev = to_usb_device(dev); | |
c6515272 | 227 | hcd = bus_to_hcd(udev->bus); |
1da177e4 LT |
228 | |
229 | usb_destroy_configuration(udev); | |
c6515272 SS |
230 | /* Root hubs aren't real devices, so don't free HCD resources */ |
231 | if (hcd->driver->free_dev && udev->parent) | |
232 | hcd->driver->free_dev(hcd, udev); | |
233 | usb_put_hcd(hcd); | |
1da177e4 LT |
234 | kfree(udev->product); |
235 | kfree(udev->manufacturer); | |
236 | kfree(udev->serial); | |
237 | kfree(udev); | |
238 | } | |
239 | ||
4a9bee82 AS |
240 | #ifdef CONFIG_HOTPLUG |
241 | static int usb_dev_uevent(struct device *dev, struct kobj_uevent_env *env) | |
242 | { | |
243 | struct usb_device *usb_dev; | |
244 | ||
245 | usb_dev = to_usb_device(dev); | |
246 | ||
247 | if (add_uevent_var(env, "BUSNUM=%03d", usb_dev->bus->busnum)) | |
248 | return -ENOMEM; | |
249 | ||
250 | if (add_uevent_var(env, "DEVNUM=%03d", usb_dev->devnum)) | |
251 | return -ENOMEM; | |
252 | ||
253 | return 0; | |
254 | } | |
255 | ||
256 | #else | |
257 | ||
258 | static int usb_dev_uevent(struct device *dev, struct kobj_uevent_env *env) | |
259 | { | |
260 | return -ENODEV; | |
261 | } | |
262 | #endif /* CONFIG_HOTPLUG */ | |
263 | ||
645daaab AS |
264 | #ifdef CONFIG_PM |
265 | ||
bd859281 AS |
266 | static int ksuspend_usb_init(void) |
267 | { | |
7ed92f1a AS |
268 | /* This workqueue is supposed to be both freezable and |
269 | * singlethreaded. Its job doesn't justify running on more | |
270 | * than one CPU. | |
271 | */ | |
7a8d37a3 | 272 | ksuspend_usb_wq = create_freezeable_workqueue("ksuspend_usbd"); |
bd859281 AS |
273 | if (!ksuspend_usb_wq) |
274 | return -ENOMEM; | |
275 | return 0; | |
276 | } | |
277 | ||
278 | static void ksuspend_usb_cleanup(void) | |
279 | { | |
280 | destroy_workqueue(ksuspend_usb_wq); | |
281 | } | |
282 | ||
f2189c47 AS |
283 | /* USB device Power-Management thunks. |
284 | * There's no need to distinguish here between quiescing a USB device | |
285 | * and powering it down; the generic_suspend() routine takes care of | |
286 | * it by skipping the usb_port_suspend() call for a quiesce. And for | |
287 | * USB interfaces there's no difference at all. | |
288 | */ | |
289 | ||
290 | static int usb_dev_prepare(struct device *dev) | |
291 | { | |
292 | return 0; /* Implement eventually? */ | |
293 | } | |
294 | ||
295 | static void usb_dev_complete(struct device *dev) | |
296 | { | |
297 | /* Currently used only for rebinding interfaces */ | |
65bfd296 | 298 | usb_resume(dev, PMSG_RESUME); /* Message event is meaningless */ |
f2189c47 AS |
299 | } |
300 | ||
301 | static int usb_dev_suspend(struct device *dev) | |
302 | { | |
303 | return usb_suspend(dev, PMSG_SUSPEND); | |
304 | } | |
305 | ||
306 | static int usb_dev_resume(struct device *dev) | |
307 | { | |
65bfd296 | 308 | return usb_resume(dev, PMSG_RESUME); |
f2189c47 AS |
309 | } |
310 | ||
311 | static int usb_dev_freeze(struct device *dev) | |
312 | { | |
313 | return usb_suspend(dev, PMSG_FREEZE); | |
314 | } | |
315 | ||
316 | static int usb_dev_thaw(struct device *dev) | |
317 | { | |
65bfd296 | 318 | return usb_resume(dev, PMSG_THAW); |
f2189c47 AS |
319 | } |
320 | ||
321 | static int usb_dev_poweroff(struct device *dev) | |
322 | { | |
323 | return usb_suspend(dev, PMSG_HIBERNATE); | |
324 | } | |
325 | ||
326 | static int usb_dev_restore(struct device *dev) | |
327 | { | |
65bfd296 | 328 | return usb_resume(dev, PMSG_RESTORE); |
f2189c47 AS |
329 | } |
330 | ||
adf09493 | 331 | static struct dev_pm_ops usb_device_pm_ops = { |
f2189c47 AS |
332 | .prepare = usb_dev_prepare, |
333 | .complete = usb_dev_complete, | |
334 | .suspend = usb_dev_suspend, | |
335 | .resume = usb_dev_resume, | |
336 | .freeze = usb_dev_freeze, | |
337 | .thaw = usb_dev_thaw, | |
338 | .poweroff = usb_dev_poweroff, | |
339 | .restore = usb_dev_restore, | |
340 | }; | |
341 | ||
db063507 AS |
342 | #else |
343 | ||
344 | #define ksuspend_usb_init() 0 | |
345 | #define ksuspend_usb_cleanup() do {} while (0) | |
adf09493 | 346 | #define usb_device_pm_ops (*(struct dev_pm_ops *)0) |
db063507 AS |
347 | |
348 | #endif /* CONFIG_PM */ | |
645daaab | 349 | |
f7a386c5 | 350 | |
e454cea2 | 351 | static char *usb_devnode(struct device *dev, mode_t *mode) |
f7a386c5 KS |
352 | { |
353 | struct usb_device *usb_dev; | |
354 | ||
355 | usb_dev = to_usb_device(dev); | |
356 | return kasprintf(GFP_KERNEL, "bus/usb/%03d/%03d", | |
357 | usb_dev->bus->busnum, usb_dev->devnum); | |
358 | } | |
359 | ||
f2189c47 AS |
360 | struct device_type usb_device_type = { |
361 | .name = "usb_device", | |
362 | .release = usb_release_dev, | |
363 | .uevent = usb_dev_uevent, | |
e454cea2 | 364 | .devnode = usb_devnode, |
f2189c47 AS |
365 | .pm = &usb_device_pm_ops, |
366 | }; | |
367 | ||
d7d07255 IPG |
368 | |
369 | /* Returns 1 if @usb_bus is WUSB, 0 otherwise */ | |
370 | static unsigned usb_bus_is_wusb(struct usb_bus *bus) | |
371 | { | |
372 | struct usb_hcd *hcd = container_of(bus, struct usb_hcd, self); | |
373 | return hcd->wireless; | |
374 | } | |
375 | ||
376 | ||
1da177e4 LT |
377 | /** |
378 | * usb_alloc_dev - usb device constructor (usbcore-internal) | |
379 | * @parent: hub to which device is connected; null to allocate a root hub | |
380 | * @bus: bus used to access the device | |
381 | * @port1: one-based index of port; ignored for root hubs | |
9251644a | 382 | * Context: !in_interrupt() |
1da177e4 LT |
383 | * |
384 | * Only hub drivers (including virtual root hub drivers for host | |
385 | * controllers) should ever call this. | |
386 | * | |
387 | * This call may not be used in a non-sleeping context. | |
388 | */ | |
2c044a48 GKH |
389 | struct usb_device *usb_alloc_dev(struct usb_device *parent, |
390 | struct usb_bus *bus, unsigned port1) | |
1da177e4 LT |
391 | { |
392 | struct usb_device *dev; | |
d7d07255 IPG |
393 | struct usb_hcd *usb_hcd = container_of(bus, struct usb_hcd, self); |
394 | unsigned root_hub = 0; | |
1da177e4 | 395 | |
0a1ef3b5 | 396 | dev = kzalloc(sizeof(*dev), GFP_KERNEL); |
1da177e4 LT |
397 | if (!dev) |
398 | return NULL; | |
399 | ||
17200583 | 400 | if (!usb_get_hcd(bus_to_hcd(bus))) { |
1da177e4 LT |
401 | kfree(dev); |
402 | return NULL; | |
403 | } | |
c6515272 SS |
404 | /* Root hubs aren't true devices, so don't allocate HCD resources */ |
405 | if (usb_hcd->driver->alloc_dev && parent && | |
406 | !usb_hcd->driver->alloc_dev(usb_hcd, dev)) { | |
407 | usb_put_hcd(bus_to_hcd(bus)); | |
408 | kfree(dev); | |
409 | return NULL; | |
410 | } | |
1da177e4 LT |
411 | |
412 | device_initialize(&dev->dev); | |
413 | dev->dev.bus = &usb_bus_type; | |
9f8b17e6 | 414 | dev->dev.type = &usb_device_type; |
2e5f10e4 | 415 | dev->dev.groups = usb_device_groups; |
1da177e4 | 416 | dev->dev.dma_mask = bus->controller->dma_mask; |
70f458f6 | 417 | set_dev_node(&dev->dev, dev_to_node(bus->controller)); |
1da177e4 | 418 | dev->state = USB_STATE_ATTACHED; |
4d59d8a1 | 419 | atomic_set(&dev->urbnum, 0); |
1da177e4 LT |
420 | |
421 | INIT_LIST_HEAD(&dev->ep0.urb_list); | |
422 | dev->ep0.desc.bLength = USB_DT_ENDPOINT_SIZE; | |
423 | dev->ep0.desc.bDescriptorType = USB_DT_ENDPOINT; | |
424 | /* ep0 maxpacket comes later, from device descriptor */ | |
3444b26a | 425 | usb_enable_endpoint(dev, &dev->ep0, false); |
6840d255 | 426 | dev->can_submit = 1; |
1da177e4 LT |
427 | |
428 | /* Save readable and stable topology id, distinguishing devices | |
429 | * by location for diagnostics, tools, driver model, etc. The | |
430 | * string is a path along hub ports, from the root. Each device's | |
431 | * dev->devpath will be stable until USB is re-cabled, and hubs | |
7071a3ce | 432 | * are often labeled with these port numbers. The name isn't |
1da177e4 LT |
433 | * as stable: bus->busnum changes easily from modprobe order, |
434 | * cardbus or pci hotplugging, and so on. | |
435 | */ | |
9251644a ON |
436 | if (unlikely(!parent)) { |
437 | dev->devpath[0] = '0'; | |
7206b001 | 438 | dev->route = 0; |
1da177e4 LT |
439 | |
440 | dev->dev.parent = bus->controller; | |
0031a06e | 441 | dev_set_name(&dev->dev, "usb%d", bus->busnum); |
d7d07255 | 442 | root_hub = 1; |
1da177e4 LT |
443 | } else { |
444 | /* match any labeling on the hubs; it's one-based */ | |
7206b001 | 445 | if (parent->devpath[0] == '0') { |
9251644a | 446 | snprintf(dev->devpath, sizeof dev->devpath, |
1da177e4 | 447 | "%d", port1); |
7206b001 SS |
448 | /* Root ports are not counted in route string */ |
449 | dev->route = 0; | |
450 | } else { | |
9251644a | 451 | snprintf(dev->devpath, sizeof dev->devpath, |
1da177e4 | 452 | "%s.%d", parent->devpath, port1); |
4a0cd967 SS |
453 | /* Route string assumes hubs have less than 16 ports */ |
454 | if (port1 < 15) | |
455 | dev->route = parent->route + | |
456 | (port1 << ((parent->level - 1)*4)); | |
457 | else | |
458 | dev->route = parent->route + | |
459 | (15 << ((parent->level - 1)*4)); | |
7206b001 | 460 | } |
1da177e4 LT |
461 | |
462 | dev->dev.parent = &parent->dev; | |
0031a06e | 463 | dev_set_name(&dev->dev, "%d-%s", bus->busnum, dev->devpath); |
1da177e4 LT |
464 | |
465 | /* hub driver sets up TT records */ | |
466 | } | |
467 | ||
12c3da34 | 468 | dev->portnum = port1; |
1da177e4 LT |
469 | dev->bus = bus; |
470 | dev->parent = parent; | |
471 | INIT_LIST_HEAD(&dev->filelist); | |
472 | ||
645daaab AS |
473 | #ifdef CONFIG_PM |
474 | mutex_init(&dev->pm_mutex); | |
c4028958 | 475 | INIT_DELAYED_WORK(&dev->autosuspend, usb_autosuspend_work); |
9ac39f28 | 476 | INIT_WORK(&dev->autoresume, usb_autoresume_work); |
b5e795f8 | 477 | dev->autosuspend_delay = usb_autosuspend_delay * HZ; |
15123006 SS |
478 | dev->connect_time = jiffies; |
479 | dev->active_duration = -jiffies; | |
645daaab | 480 | #endif |
d7d07255 IPG |
481 | if (root_hub) /* Root hub always ok [and always wired] */ |
482 | dev->authorized = 1; | |
483 | else { | |
484 | dev->authorized = usb_hcd->authorized_default; | |
485 | dev->wusb = usb_bus_is_wusb(bus)? 1 : 0; | |
486 | } | |
1da177e4 LT |
487 | return dev; |
488 | } | |
489 | ||
490 | /** | |
491 | * usb_get_dev - increments the reference count of the usb device structure | |
492 | * @dev: the device being referenced | |
493 | * | |
494 | * Each live reference to a device should be refcounted. | |
495 | * | |
496 | * Drivers for USB interfaces should normally record such references in | |
497 | * their probe() methods, when they bind to an interface, and release | |
498 | * them by calling usb_put_dev(), in their disconnect() methods. | |
499 | * | |
500 | * A pointer to the device with the incremented reference counter is returned. | |
501 | */ | |
502 | struct usb_device *usb_get_dev(struct usb_device *dev) | |
503 | { | |
504 | if (dev) | |
505 | get_device(&dev->dev); | |
506 | return dev; | |
507 | } | |
782e70c6 | 508 | EXPORT_SYMBOL_GPL(usb_get_dev); |
1da177e4 LT |
509 | |
510 | /** | |
511 | * usb_put_dev - release a use of the usb device structure | |
512 | * @dev: device that's been disconnected | |
513 | * | |
514 | * Must be called when a user of a device is finished with it. When the last | |
515 | * user of the device calls this function, the memory of the device is freed. | |
516 | */ | |
517 | void usb_put_dev(struct usb_device *dev) | |
518 | { | |
519 | if (dev) | |
520 | put_device(&dev->dev); | |
521 | } | |
782e70c6 | 522 | EXPORT_SYMBOL_GPL(usb_put_dev); |
1da177e4 LT |
523 | |
524 | /** | |
525 | * usb_get_intf - increments the reference count of the usb interface structure | |
526 | * @intf: the interface being referenced | |
527 | * | |
528 | * Each live reference to a interface must be refcounted. | |
529 | * | |
530 | * Drivers for USB interfaces should normally record such references in | |
531 | * their probe() methods, when they bind to an interface, and release | |
532 | * them by calling usb_put_intf(), in their disconnect() methods. | |
533 | * | |
534 | * A pointer to the interface with the incremented reference counter is | |
535 | * returned. | |
536 | */ | |
537 | struct usb_interface *usb_get_intf(struct usb_interface *intf) | |
538 | { | |
539 | if (intf) | |
540 | get_device(&intf->dev); | |
541 | return intf; | |
542 | } | |
782e70c6 | 543 | EXPORT_SYMBOL_GPL(usb_get_intf); |
1da177e4 LT |
544 | |
545 | /** | |
546 | * usb_put_intf - release a use of the usb interface structure | |
547 | * @intf: interface that's been decremented | |
548 | * | |
549 | * Must be called when a user of an interface is finished with it. When the | |
550 | * last user of the interface calls this function, the memory of the interface | |
551 | * is freed. | |
552 | */ | |
553 | void usb_put_intf(struct usb_interface *intf) | |
554 | { | |
555 | if (intf) | |
556 | put_device(&intf->dev); | |
557 | } | |
782e70c6 | 558 | EXPORT_SYMBOL_GPL(usb_put_intf); |
1da177e4 LT |
559 | |
560 | /* USB device locking | |
561 | * | |
9ad3d6cc AS |
562 | * USB devices and interfaces are locked using the semaphore in their |
563 | * embedded struct device. The hub driver guarantees that whenever a | |
564 | * device is connected or disconnected, drivers are called with the | |
565 | * USB device locked as well as their particular interface. | |
1da177e4 LT |
566 | * |
567 | * Complications arise when several devices are to be locked at the same | |
568 | * time. Only hub-aware drivers that are part of usbcore ever have to | |
9ad3d6cc AS |
569 | * do this; nobody else needs to worry about it. The rule for locking |
570 | * is simple: | |
1da177e4 LT |
571 | * |
572 | * When locking both a device and its parent, always lock the | |
573 | * the parent first. | |
574 | */ | |
575 | ||
1da177e4 | 576 | /** |
d0bcabcd | 577 | * usb_lock_device_for_reset - cautiously acquire the lock for a usb device structure |
1da177e4 LT |
578 | * @udev: device that's being locked |
579 | * @iface: interface bound to the driver making the request (optional) | |
580 | * | |
581 | * Attempts to acquire the device lock, but fails if the device is | |
582 | * NOTATTACHED or SUSPENDED, or if iface is specified and the interface | |
583 | * is neither BINDING nor BOUND. Rather than sleeping to wait for the | |
584 | * lock, the routine polls repeatedly. This is to prevent deadlock with | |
585 | * disconnect; in some drivers (such as usb-storage) the disconnect() | |
3ea15966 | 586 | * or suspend() method will block waiting for a device reset to complete. |
1da177e4 | 587 | * |
011b15df | 588 | * Returns a negative error code for failure, otherwise 0. |
1da177e4 LT |
589 | */ |
590 | int usb_lock_device_for_reset(struct usb_device *udev, | |
095bc335 | 591 | const struct usb_interface *iface) |
1da177e4 | 592 | { |
3ea15966 AS |
593 | unsigned long jiffies_expire = jiffies + HZ; |
594 | ||
1da177e4 LT |
595 | if (udev->state == USB_STATE_NOTATTACHED) |
596 | return -ENODEV; | |
597 | if (udev->state == USB_STATE_SUSPENDED) | |
598 | return -EHOSTUNREACH; | |
011b15df AS |
599 | if (iface && (iface->condition == USB_INTERFACE_UNBINDING || |
600 | iface->condition == USB_INTERFACE_UNBOUND)) | |
601 | return -EINTR; | |
1da177e4 | 602 | |
9ad3d6cc | 603 | while (usb_trylock_device(udev) != 0) { |
3ea15966 AS |
604 | |
605 | /* If we can't acquire the lock after waiting one second, | |
606 | * we're probably deadlocked */ | |
607 | if (time_after(jiffies, jiffies_expire)) | |
608 | return -EBUSY; | |
609 | ||
1da177e4 LT |
610 | msleep(15); |
611 | if (udev->state == USB_STATE_NOTATTACHED) | |
612 | return -ENODEV; | |
613 | if (udev->state == USB_STATE_SUSPENDED) | |
614 | return -EHOSTUNREACH; | |
011b15df AS |
615 | if (iface && (iface->condition == USB_INTERFACE_UNBINDING || |
616 | iface->condition == USB_INTERFACE_UNBOUND)) | |
1da177e4 LT |
617 | return -EINTR; |
618 | } | |
011b15df | 619 | return 0; |
1da177e4 | 620 | } |
782e70c6 | 621 | EXPORT_SYMBOL_GPL(usb_lock_device_for_reset); |
1da177e4 LT |
622 | |
623 | static struct usb_device *match_device(struct usb_device *dev, | |
624 | u16 vendor_id, u16 product_id) | |
625 | { | |
626 | struct usb_device *ret_dev = NULL; | |
627 | int child; | |
628 | ||
629 | dev_dbg(&dev->dev, "check for vendor %04x, product %04x ...\n", | |
630 | le16_to_cpu(dev->descriptor.idVendor), | |
631 | le16_to_cpu(dev->descriptor.idProduct)); | |
632 | ||
633 | /* see if this device matches */ | |
634 | if ((vendor_id == le16_to_cpu(dev->descriptor.idVendor)) && | |
635 | (product_id == le16_to_cpu(dev->descriptor.idProduct))) { | |
9251644a | 636 | dev_dbg(&dev->dev, "matched this device!\n"); |
1da177e4 LT |
637 | ret_dev = usb_get_dev(dev); |
638 | goto exit; | |
639 | } | |
640 | ||
641 | /* look through all of the children of this device */ | |
642 | for (child = 0; child < dev->maxchild; ++child) { | |
643 | if (dev->children[child]) { | |
9ad3d6cc | 644 | usb_lock_device(dev->children[child]); |
1da177e4 LT |
645 | ret_dev = match_device(dev->children[child], |
646 | vendor_id, product_id); | |
9ad3d6cc | 647 | usb_unlock_device(dev->children[child]); |
1da177e4 LT |
648 | if (ret_dev) |
649 | goto exit; | |
650 | } | |
651 | } | |
652 | exit: | |
653 | return ret_dev; | |
654 | } | |
655 | ||
656 | /** | |
657 | * usb_find_device - find a specific usb device in the system | |
658 | * @vendor_id: the vendor id of the device to find | |
659 | * @product_id: the product id of the device to find | |
660 | * | |
661 | * Returns a pointer to a struct usb_device if such a specified usb | |
662 | * device is present in the system currently. The usage count of the | |
663 | * device will be incremented if a device is found. Make sure to call | |
664 | * usb_put_dev() when the caller is finished with the device. | |
665 | * | |
666 | * If a device with the specified vendor and product id is not found, | |
667 | * NULL is returned. | |
668 | */ | |
669 | struct usb_device *usb_find_device(u16 vendor_id, u16 product_id) | |
670 | { | |
671 | struct list_head *buslist; | |
672 | struct usb_bus *bus; | |
673 | struct usb_device *dev = NULL; | |
2c044a48 | 674 | |
4186ecf8 | 675 | mutex_lock(&usb_bus_list_lock); |
1da177e4 | 676 | for (buslist = usb_bus_list.next; |
2c044a48 | 677 | buslist != &usb_bus_list; |
1da177e4 LT |
678 | buslist = buslist->next) { |
679 | bus = container_of(buslist, struct usb_bus, bus_list); | |
680 | if (!bus->root_hub) | |
681 | continue; | |
682 | usb_lock_device(bus->root_hub); | |
683 | dev = match_device(bus->root_hub, vendor_id, product_id); | |
684 | usb_unlock_device(bus->root_hub); | |
685 | if (dev) | |
686 | goto exit; | |
687 | } | |
688 | exit: | |
4186ecf8 | 689 | mutex_unlock(&usb_bus_list_lock); |
1da177e4 LT |
690 | return dev; |
691 | } | |
692 | ||
693 | /** | |
694 | * usb_get_current_frame_number - return current bus frame number | |
695 | * @dev: the device whose bus is being queried | |
696 | * | |
697 | * Returns the current frame number for the USB host controller | |
698 | * used with the given USB device. This can be used when scheduling | |
699 | * isochronous requests. | |
700 | * | |
701 | * Note that different kinds of host controller have different | |
702 | * "scheduling horizons". While one type might support scheduling only | |
703 | * 32 frames into the future, others could support scheduling up to | |
704 | * 1024 frames into the future. | |
705 | */ | |
706 | int usb_get_current_frame_number(struct usb_device *dev) | |
707 | { | |
9251644a | 708 | return usb_hcd_get_frame_number(dev); |
1da177e4 | 709 | } |
782e70c6 | 710 | EXPORT_SYMBOL_GPL(usb_get_current_frame_number); |
1da177e4 LT |
711 | |
712 | /*-------------------------------------------------------------------*/ | |
713 | /* | |
714 | * __usb_get_extra_descriptor() finds a descriptor of specific type in the | |
715 | * extra field of the interface and endpoint descriptor structs. | |
716 | */ | |
717 | ||
718 | int __usb_get_extra_descriptor(char *buffer, unsigned size, | |
2c044a48 | 719 | unsigned char type, void **ptr) |
1da177e4 LT |
720 | { |
721 | struct usb_descriptor_header *header; | |
722 | ||
723 | while (size >= sizeof(struct usb_descriptor_header)) { | |
724 | header = (struct usb_descriptor_header *)buffer; | |
725 | ||
726 | if (header->bLength < 2) { | |
727 | printk(KERN_ERR | |
728 | "%s: bogus descriptor, type %d length %d\n", | |
729 | usbcore_name, | |
2c044a48 | 730 | header->bDescriptorType, |
1da177e4 LT |
731 | header->bLength); |
732 | return -1; | |
733 | } | |
734 | ||
735 | if (header->bDescriptorType == type) { | |
736 | *ptr = header; | |
737 | return 0; | |
738 | } | |
739 | ||
740 | buffer += header->bLength; | |
741 | size -= header->bLength; | |
742 | } | |
743 | return -1; | |
744 | } | |
782e70c6 | 745 | EXPORT_SYMBOL_GPL(__usb_get_extra_descriptor); |
1da177e4 LT |
746 | |
747 | /** | |
748 | * usb_buffer_alloc - allocate dma-consistent buffer for URB_NO_xxx_DMA_MAP | |
749 | * @dev: device the buffer will be used with | |
750 | * @size: requested buffer size | |
751 | * @mem_flags: affect whether allocation may block | |
752 | * @dma: used to return DMA address of buffer | |
753 | * | |
754 | * Return value is either null (indicating no buffer could be allocated), or | |
755 | * the cpu-space pointer to a buffer that may be used to perform DMA to the | |
756 | * specified device. Such cpu-space buffers are returned along with the DMA | |
757 | * address (through the pointer provided). | |
758 | * | |
759 | * These buffers are used with URB_NO_xxx_DMA_MAP set in urb->transfer_flags | |
fbf54dd3 DB |
760 | * to avoid behaviors like using "DMA bounce buffers", or thrashing IOMMU |
761 | * hardware during URB completion/resubmit. The implementation varies between | |
1da177e4 | 762 | * platforms, depending on details of how DMA will work to this device. |
fbf54dd3 DB |
763 | * Using these buffers also eliminates cacheline sharing problems on |
764 | * architectures where CPU caches are not DMA-coherent. On systems without | |
765 | * bus-snooping caches, these buffers are uncached. | |
1da177e4 LT |
766 | * |
767 | * When the buffer is no longer used, free it with usb_buffer_free(). | |
768 | */ | |
2c044a48 GKH |
769 | void *usb_buffer_alloc(struct usb_device *dev, size_t size, gfp_t mem_flags, |
770 | dma_addr_t *dma) | |
1da177e4 | 771 | { |
a6d2bb9f | 772 | if (!dev || !dev->bus) |
1da177e4 | 773 | return NULL; |
9251644a | 774 | return hcd_buffer_alloc(dev->bus, size, mem_flags, dma); |
1da177e4 | 775 | } |
782e70c6 | 776 | EXPORT_SYMBOL_GPL(usb_buffer_alloc); |
1da177e4 LT |
777 | |
778 | /** | |
779 | * usb_buffer_free - free memory allocated with usb_buffer_alloc() | |
780 | * @dev: device the buffer was used with | |
781 | * @size: requested buffer size | |
782 | * @addr: CPU address of buffer | |
783 | * @dma: DMA address of buffer | |
784 | * | |
785 | * This reclaims an I/O buffer, letting it be reused. The memory must have | |
786 | * been allocated using usb_buffer_alloc(), and the parameters must match | |
fbf54dd3 | 787 | * those provided in that allocation request. |
1da177e4 | 788 | */ |
2c044a48 GKH |
789 | void usb_buffer_free(struct usb_device *dev, size_t size, void *addr, |
790 | dma_addr_t dma) | |
1da177e4 | 791 | { |
a6d2bb9f | 792 | if (!dev || !dev->bus) |
b94badbb DT |
793 | return; |
794 | if (!addr) | |
795 | return; | |
9251644a | 796 | hcd_buffer_free(dev->bus, size, addr, dma); |
1da177e4 | 797 | } |
782e70c6 | 798 | EXPORT_SYMBOL_GPL(usb_buffer_free); |
1da177e4 LT |
799 | |
800 | /** | |
801 | * usb_buffer_map - create DMA mapping(s) for an urb | |
802 | * @urb: urb whose transfer_buffer/setup_packet will be mapped | |
803 | * | |
804 | * Return value is either null (indicating no buffer could be mapped), or | |
805 | * the parameter. URB_NO_TRANSFER_DMA_MAP and URB_NO_SETUP_DMA_MAP are | |
806 | * added to urb->transfer_flags if the operation succeeds. If the device | |
807 | * is connected to this system through a non-DMA controller, this operation | |
808 | * always succeeds. | |
809 | * | |
810 | * This call would normally be used for an urb which is reused, perhaps | |
811 | * as the target of a large periodic transfer, with usb_buffer_dmasync() | |
812 | * calls to synchronize memory and dma state. | |
813 | * | |
814 | * Reverse the effect of this call with usb_buffer_unmap(). | |
815 | */ | |
816 | #if 0 | |
9251644a | 817 | struct urb *usb_buffer_map(struct urb *urb) |
1da177e4 LT |
818 | { |
819 | struct usb_bus *bus; | |
820 | struct device *controller; | |
821 | ||
822 | if (!urb | |
823 | || !urb->dev | |
824 | || !(bus = urb->dev->bus) | |
825 | || !(controller = bus->controller)) | |
826 | return NULL; | |
827 | ||
828 | if (controller->dma_mask) { | |
9251644a | 829 | urb->transfer_dma = dma_map_single(controller, |
1da177e4 | 830 | urb->transfer_buffer, urb->transfer_buffer_length, |
9251644a | 831 | usb_pipein(urb->pipe) |
1da177e4 | 832 | ? DMA_FROM_DEVICE : DMA_TO_DEVICE); |
9251644a ON |
833 | if (usb_pipecontrol(urb->pipe)) |
834 | urb->setup_dma = dma_map_single(controller, | |
1da177e4 | 835 | urb->setup_packet, |
9251644a | 836 | sizeof(struct usb_ctrlrequest), |
1da177e4 | 837 | DMA_TO_DEVICE); |
2c044a48 GKH |
838 | /* FIXME generic api broken like pci, can't report errors */ |
839 | /* if (urb->transfer_dma == DMA_ADDR_INVALID) return 0; */ | |
1da177e4 LT |
840 | } else |
841 | urb->transfer_dma = ~0; | |
842 | urb->transfer_flags |= (URB_NO_TRANSFER_DMA_MAP | |
843 | | URB_NO_SETUP_DMA_MAP); | |
844 | return urb; | |
845 | } | |
782e70c6 | 846 | EXPORT_SYMBOL_GPL(usb_buffer_map); |
1da177e4 LT |
847 | #endif /* 0 */ |
848 | ||
849 | /* XXX DISABLED, no users currently. If you wish to re-enable this | |
850 | * XXX please determine whether the sync is to transfer ownership of | |
851 | * XXX the buffer from device to cpu or vice verse, and thusly use the | |
852 | * XXX appropriate _for_{cpu,device}() method. -DaveM | |
853 | */ | |
854 | #if 0 | |
855 | ||
856 | /** | |
857 | * usb_buffer_dmasync - synchronize DMA and CPU view of buffer(s) | |
858 | * @urb: urb whose transfer_buffer/setup_packet will be synchronized | |
859 | */ | |
9251644a | 860 | void usb_buffer_dmasync(struct urb *urb) |
1da177e4 LT |
861 | { |
862 | struct usb_bus *bus; | |
863 | struct device *controller; | |
864 | ||
865 | if (!urb | |
866 | || !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP) | |
867 | || !urb->dev | |
868 | || !(bus = urb->dev->bus) | |
869 | || !(controller = bus->controller)) | |
870 | return; | |
871 | ||
872 | if (controller->dma_mask) { | |
9b8e7ba6 | 873 | dma_sync_single_for_cpu(controller, |
1da177e4 | 874 | urb->transfer_dma, urb->transfer_buffer_length, |
9251644a | 875 | usb_pipein(urb->pipe) |
1da177e4 | 876 | ? DMA_FROM_DEVICE : DMA_TO_DEVICE); |
9251644a | 877 | if (usb_pipecontrol(urb->pipe)) |
9b8e7ba6 | 878 | dma_sync_single_for_cpu(controller, |
1da177e4 | 879 | urb->setup_dma, |
9251644a | 880 | sizeof(struct usb_ctrlrequest), |
1da177e4 LT |
881 | DMA_TO_DEVICE); |
882 | } | |
883 | } | |
782e70c6 | 884 | EXPORT_SYMBOL_GPL(usb_buffer_dmasync); |
1da177e4 LT |
885 | #endif |
886 | ||
887 | /** | |
888 | * usb_buffer_unmap - free DMA mapping(s) for an urb | |
889 | * @urb: urb whose transfer_buffer will be unmapped | |
890 | * | |
891 | * Reverses the effect of usb_buffer_map(). | |
892 | */ | |
893 | #if 0 | |
9251644a | 894 | void usb_buffer_unmap(struct urb *urb) |
1da177e4 LT |
895 | { |
896 | struct usb_bus *bus; | |
897 | struct device *controller; | |
898 | ||
899 | if (!urb | |
900 | || !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP) | |
901 | || !urb->dev | |
902 | || !(bus = urb->dev->bus) | |
903 | || !(controller = bus->controller)) | |
904 | return; | |
905 | ||
906 | if (controller->dma_mask) { | |
9251644a | 907 | dma_unmap_single(controller, |
1da177e4 | 908 | urb->transfer_dma, urb->transfer_buffer_length, |
9251644a | 909 | usb_pipein(urb->pipe) |
1da177e4 | 910 | ? DMA_FROM_DEVICE : DMA_TO_DEVICE); |
9251644a ON |
911 | if (usb_pipecontrol(urb->pipe)) |
912 | dma_unmap_single(controller, | |
1da177e4 | 913 | urb->setup_dma, |
9251644a | 914 | sizeof(struct usb_ctrlrequest), |
1da177e4 LT |
915 | DMA_TO_DEVICE); |
916 | } | |
917 | urb->transfer_flags &= ~(URB_NO_TRANSFER_DMA_MAP | |
918 | | URB_NO_SETUP_DMA_MAP); | |
919 | } | |
782e70c6 | 920 | EXPORT_SYMBOL_GPL(usb_buffer_unmap); |
1da177e4 LT |
921 | #endif /* 0 */ |
922 | ||
923 | /** | |
924 | * usb_buffer_map_sg - create scatterlist DMA mapping(s) for an endpoint | |
925 | * @dev: device to which the scatterlist will be mapped | |
5e60a161 | 926 | * @is_in: mapping transfer direction |
1da177e4 LT |
927 | * @sg: the scatterlist to map |
928 | * @nents: the number of entries in the scatterlist | |
929 | * | |
930 | * Return value is either < 0 (indicating no buffers could be mapped), or | |
931 | * the number of DMA mapping array entries in the scatterlist. | |
932 | * | |
933 | * The caller is responsible for placing the resulting DMA addresses from | |
934 | * the scatterlist into URB transfer buffer pointers, and for setting the | |
935 | * URB_NO_TRANSFER_DMA_MAP transfer flag in each of those URBs. | |
936 | * | |
937 | * Top I/O rates come from queuing URBs, instead of waiting for each one | |
938 | * to complete before starting the next I/O. This is particularly easy | |
939 | * to do with scatterlists. Just allocate and submit one URB for each DMA | |
940 | * mapping entry returned, stopping on the first error or when all succeed. | |
941 | * Better yet, use the usb_sg_*() calls, which do that (and more) for you. | |
942 | * | |
943 | * This call would normally be used when translating scatterlist requests, | |
944 | * rather than usb_buffer_map(), since on some hardware (with IOMMUs) it | |
945 | * may be able to coalesce mappings for improved I/O efficiency. | |
946 | * | |
947 | * Reverse the effect of this call with usb_buffer_unmap_sg(). | |
948 | */ | |
5e60a161 | 949 | int usb_buffer_map_sg(const struct usb_device *dev, int is_in, |
095bc335 | 950 | struct scatterlist *sg, int nents) |
1da177e4 LT |
951 | { |
952 | struct usb_bus *bus; | |
953 | struct device *controller; | |
954 | ||
955 | if (!dev | |
1da177e4 LT |
956 | || !(bus = dev->bus) |
957 | || !(controller = bus->controller) | |
958 | || !controller->dma_mask) | |
2912282c | 959 | return -EINVAL; |
1da177e4 | 960 | |
2c044a48 | 961 | /* FIXME generic api broken like pci, can't report errors */ |
9251644a | 962 | return dma_map_sg(controller, sg, nents, |
2912282c | 963 | is_in ? DMA_FROM_DEVICE : DMA_TO_DEVICE) ? : -ENOMEM; |
1da177e4 | 964 | } |
782e70c6 | 965 | EXPORT_SYMBOL_GPL(usb_buffer_map_sg); |
1da177e4 LT |
966 | |
967 | /* XXX DISABLED, no users currently. If you wish to re-enable this | |
968 | * XXX please determine whether the sync is to transfer ownership of | |
969 | * XXX the buffer from device to cpu or vice verse, and thusly use the | |
970 | * XXX appropriate _for_{cpu,device}() method. -DaveM | |
971 | */ | |
972 | #if 0 | |
973 | ||
974 | /** | |
975 | * usb_buffer_dmasync_sg - synchronize DMA and CPU view of scatterlist buffer(s) | |
976 | * @dev: device to which the scatterlist will be mapped | |
5e60a161 | 977 | * @is_in: mapping transfer direction |
1da177e4 LT |
978 | * @sg: the scatterlist to synchronize |
979 | * @n_hw_ents: the positive return value from usb_buffer_map_sg | |
980 | * | |
981 | * Use this when you are re-using a scatterlist's data buffers for | |
982 | * another USB request. | |
983 | */ | |
5e60a161 | 984 | void usb_buffer_dmasync_sg(const struct usb_device *dev, int is_in, |
095bc335 | 985 | struct scatterlist *sg, int n_hw_ents) |
1da177e4 LT |
986 | { |
987 | struct usb_bus *bus; | |
988 | struct device *controller; | |
989 | ||
990 | if (!dev | |
991 | || !(bus = dev->bus) | |
992 | || !(controller = bus->controller) | |
993 | || !controller->dma_mask) | |
994 | return; | |
995 | ||
9b8e7ba6 FT |
996 | dma_sync_sg_for_cpu(controller, sg, n_hw_ents, |
997 | is_in ? DMA_FROM_DEVICE : DMA_TO_DEVICE); | |
1da177e4 | 998 | } |
782e70c6 | 999 | EXPORT_SYMBOL_GPL(usb_buffer_dmasync_sg); |
1da177e4 LT |
1000 | #endif |
1001 | ||
1002 | /** | |
1003 | * usb_buffer_unmap_sg - free DMA mapping(s) for a scatterlist | |
1004 | * @dev: device to which the scatterlist will be mapped | |
5e60a161 | 1005 | * @is_in: mapping transfer direction |
1da177e4 LT |
1006 | * @sg: the scatterlist to unmap |
1007 | * @n_hw_ents: the positive return value from usb_buffer_map_sg | |
1008 | * | |
1009 | * Reverses the effect of usb_buffer_map_sg(). | |
1010 | */ | |
5e60a161 | 1011 | void usb_buffer_unmap_sg(const struct usb_device *dev, int is_in, |
095bc335 | 1012 | struct scatterlist *sg, int n_hw_ents) |
1da177e4 LT |
1013 | { |
1014 | struct usb_bus *bus; | |
1015 | struct device *controller; | |
1016 | ||
1017 | if (!dev | |
1018 | || !(bus = dev->bus) | |
1019 | || !(controller = bus->controller) | |
1020 | || !controller->dma_mask) | |
1021 | return; | |
1022 | ||
9251644a | 1023 | dma_unmap_sg(controller, sg, n_hw_ents, |
5e60a161 | 1024 | is_in ? DMA_FROM_DEVICE : DMA_TO_DEVICE); |
1da177e4 | 1025 | } |
782e70c6 | 1026 | EXPORT_SYMBOL_GPL(usb_buffer_unmap_sg); |
1da177e4 | 1027 | |
785895ff RR |
1028 | /* To disable USB, kernel command line is 'nousb' not 'usbcore.nousb' */ |
1029 | #ifdef MODULE | |
1030 | module_param(nousb, bool, 0444); | |
1031 | #else | |
1032 | core_param(nousb, nousb, bool, 0444); | |
1033 | #endif | |
1da177e4 LT |
1034 | |
1035 | /* | |
1036 | * for external read access to <nousb> | |
1037 | */ | |
1038 | int usb_disabled(void) | |
1039 | { | |
1040 | return nousb; | |
1041 | } | |
782e70c6 | 1042 | EXPORT_SYMBOL_GPL(usb_disabled); |
1da177e4 | 1043 | |
3b23dd6f AS |
1044 | /* |
1045 | * Notifications of device and interface registration | |
1046 | */ | |
1047 | static int usb_bus_notify(struct notifier_block *nb, unsigned long action, | |
1048 | void *data) | |
1049 | { | |
1050 | struct device *dev = data; | |
1051 | ||
1052 | switch (action) { | |
1053 | case BUS_NOTIFY_ADD_DEVICE: | |
1054 | if (dev->type == &usb_device_type) | |
1055 | (void) usb_create_sysfs_dev_files(to_usb_device(dev)); | |
1056 | else if (dev->type == &usb_if_device_type) | |
1057 | (void) usb_create_sysfs_intf_files( | |
1058 | to_usb_interface(dev)); | |
1059 | break; | |
1060 | ||
1061 | case BUS_NOTIFY_DEL_DEVICE: | |
1062 | if (dev->type == &usb_device_type) | |
1063 | usb_remove_sysfs_dev_files(to_usb_device(dev)); | |
1064 | else if (dev->type == &usb_if_device_type) | |
1065 | usb_remove_sysfs_intf_files(to_usb_interface(dev)); | |
1066 | break; | |
1067 | } | |
1068 | return 0; | |
1069 | } | |
1070 | ||
1071 | static struct notifier_block usb_bus_nb = { | |
1072 | .notifier_call = usb_bus_notify, | |
1073 | }; | |
1074 | ||
00048b8b GKH |
1075 | struct dentry *usb_debug_root; |
1076 | EXPORT_SYMBOL_GPL(usb_debug_root); | |
1077 | ||
719a6e88 | 1078 | static struct dentry *usb_debug_devices; |
97d7b7a4 | 1079 | |
00048b8b GKH |
1080 | static int usb_debugfs_init(void) |
1081 | { | |
1082 | usb_debug_root = debugfs_create_dir("usb", NULL); | |
1083 | if (!usb_debug_root) | |
1084 | return -ENOENT; | |
97d7b7a4 GKH |
1085 | |
1086 | usb_debug_devices = debugfs_create_file("devices", 0444, | |
1087 | usb_debug_root, NULL, | |
1088 | &usbfs_devices_fops); | |
1089 | if (!usb_debug_devices) { | |
1090 | debugfs_remove(usb_debug_root); | |
1091 | usb_debug_root = NULL; | |
1092 | return -ENOENT; | |
1093 | } | |
1094 | ||
00048b8b GKH |
1095 | return 0; |
1096 | } | |
1097 | ||
1098 | static void usb_debugfs_cleanup(void) | |
1099 | { | |
97d7b7a4 | 1100 | debugfs_remove(usb_debug_devices); |
00048b8b GKH |
1101 | debugfs_remove(usb_debug_root); |
1102 | } | |
1103 | ||
1da177e4 LT |
1104 | /* |
1105 | * Init | |
1106 | */ | |
1107 | static int __init usb_init(void) | |
1108 | { | |
1109 | int retval; | |
1110 | if (nousb) { | |
9251644a | 1111 | pr_info("%s: USB support disabled\n", usbcore_name); |
1da177e4 LT |
1112 | return 0; |
1113 | } | |
1114 | ||
00048b8b GKH |
1115 | retval = usb_debugfs_init(); |
1116 | if (retval) | |
1117 | goto out; | |
1118 | ||
bd859281 AS |
1119 | retval = ksuspend_usb_init(); |
1120 | if (retval) | |
1121 | goto out; | |
1da177e4 | 1122 | retval = bus_register(&usb_bus_type); |
2c044a48 | 1123 | if (retval) |
bd859281 | 1124 | goto bus_register_failed; |
3b23dd6f AS |
1125 | retval = bus_register_notifier(&usb_bus_type, &usb_bus_nb); |
1126 | if (retval) | |
1127 | goto bus_notifier_failed; | |
1da177e4 LT |
1128 | retval = usb_major_init(); |
1129 | if (retval) | |
1130 | goto major_init_failed; | |
fbf82fd2 KS |
1131 | retval = usb_register(&usbfs_driver); |
1132 | if (retval) | |
1133 | goto driver_register_failed; | |
9f8b17e6 | 1134 | retval = usb_devio_init(); |
fbf82fd2 | 1135 | if (retval) |
9f8b17e6 | 1136 | goto usb_devio_init_failed; |
1da177e4 LT |
1137 | retval = usbfs_init(); |
1138 | if (retval) | |
1139 | goto fs_init_failed; | |
1140 | retval = usb_hub_init(); | |
1141 | if (retval) | |
1142 | goto hub_init_failed; | |
8bb54ab5 | 1143 | retval = usb_register_device_driver(&usb_generic_driver, THIS_MODULE); |
1da177e4 LT |
1144 | if (!retval) |
1145 | goto out; | |
1146 | ||
1147 | usb_hub_cleanup(); | |
1148 | hub_init_failed: | |
1149 | usbfs_cleanup(); | |
1150 | fs_init_failed: | |
9f8b17e6 KS |
1151 | usb_devio_cleanup(); |
1152 | usb_devio_init_failed: | |
fbf82fd2 KS |
1153 | usb_deregister(&usbfs_driver); |
1154 | driver_register_failed: | |
1155 | usb_major_cleanup(); | |
1da177e4 | 1156 | major_init_failed: |
3b23dd6f AS |
1157 | bus_unregister_notifier(&usb_bus_type, &usb_bus_nb); |
1158 | bus_notifier_failed: | |
1da177e4 | 1159 | bus_unregister(&usb_bus_type); |
bd859281 AS |
1160 | bus_register_failed: |
1161 | ksuspend_usb_cleanup(); | |
1da177e4 LT |
1162 | out: |
1163 | return retval; | |
1164 | } | |
1165 | ||
1166 | /* | |
1167 | * Cleanup | |
1168 | */ | |
1169 | static void __exit usb_exit(void) | |
1170 | { | |
1171 | /* This will matter if shutdown/reboot does exitcalls. */ | |
1172 | if (nousb) | |
1173 | return; | |
1174 | ||
8bb54ab5 | 1175 | usb_deregister_device_driver(&usb_generic_driver); |
1da177e4 LT |
1176 | usb_major_cleanup(); |
1177 | usbfs_cleanup(); | |
fbf82fd2 | 1178 | usb_deregister(&usbfs_driver); |
9f8b17e6 | 1179 | usb_devio_cleanup(); |
1da177e4 | 1180 | usb_hub_cleanup(); |
3b23dd6f | 1181 | bus_unregister_notifier(&usb_bus_type, &usb_bus_nb); |
1da177e4 | 1182 | bus_unregister(&usb_bus_type); |
bd859281 | 1183 | ksuspend_usb_cleanup(); |
00048b8b | 1184 | usb_debugfs_cleanup(); |
1da177e4 LT |
1185 | } |
1186 | ||
1187 | subsys_initcall(usb_init); | |
1188 | module_exit(usb_exit); | |
1da177e4 | 1189 | MODULE_LICENSE("GPL"); |