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