Commit | Line | Data |
---|---|---|
ddae41be GKH |
1 | /* |
2 | * drivers/usb/driver.c - most of the driver model stuff for usb | |
3 | * | |
4 | * (C) Copyright 2005 Greg Kroah-Hartman <gregkh@suse.de> | |
5 | * | |
6 | * based on drivers/usb/usb.c which had the following copyrights: | |
7 | * (C) Copyright Linus Torvalds 1999 | |
8 | * (C) Copyright Johannes Erdfelt 1999-2001 | |
9 | * (C) Copyright Andreas Gal 1999 | |
10 | * (C) Copyright Gregory P. Smith 1999 | |
11 | * (C) Copyright Deti Fliegl 1999 (new USB architecture) | |
12 | * (C) Copyright Randy Dunlap 2000 | |
13 | * (C) Copyright David Brownell 2000-2004 | |
14 | * (C) Copyright Yggdrasil Computing, Inc. 2000 | |
15 | * (usb_device_id matching changes by Adam J. Richter) | |
16 | * (C) Copyright Greg Kroah-Hartman 2002-2003 | |
17 | * | |
18 | * NOTE! This is not actually a driver at all, rather this is | |
19 | * just a collection of helper routines that implement the | |
36e56a34 AS |
20 | * matching, probing, releasing, suspending and resuming for |
21 | * real drivers. | |
ddae41be GKH |
22 | * |
23 | */ | |
24 | ||
ddae41be GKH |
25 | #include <linux/device.h> |
26 | #include <linux/usb.h> | |
bd859281 | 27 | #include <linux/workqueue.h> |
ddae41be GKH |
28 | #include "hcd.h" |
29 | #include "usb.h" | |
30 | ||
733260ff GKH |
31 | #ifdef CONFIG_HOTPLUG |
32 | ||
33 | /* | |
34 | * Adds a new dynamic USBdevice ID to this driver, | |
35 | * and cause the driver to probe for all devices again. | |
36 | */ | |
93bacefc GKH |
37 | ssize_t usb_store_new_id(struct usb_dynids *dynids, |
38 | struct device_driver *driver, | |
39 | const char *buf, size_t count) | |
733260ff | 40 | { |
733260ff GKH |
41 | struct usb_dynid *dynid; |
42 | u32 idVendor = 0; | |
43 | u32 idProduct = 0; | |
44 | int fields = 0; | |
1b21d5e1 | 45 | int retval = 0; |
733260ff GKH |
46 | |
47 | fields = sscanf(buf, "%x %x", &idVendor, &idProduct); | |
48 | if (fields < 2) | |
49 | return -EINVAL; | |
50 | ||
51 | dynid = kzalloc(sizeof(*dynid), GFP_KERNEL); | |
52 | if (!dynid) | |
53 | return -ENOMEM; | |
54 | ||
55 | INIT_LIST_HEAD(&dynid->node); | |
56 | dynid->id.idVendor = idVendor; | |
57 | dynid->id.idProduct = idProduct; | |
58 | dynid->id.match_flags = USB_DEVICE_ID_MATCH_DEVICE; | |
59 | ||
93bacefc GKH |
60 | spin_lock(&dynids->lock); |
61 | list_add_tail(&dynids->list, &dynid->node); | |
62 | spin_unlock(&dynids->lock); | |
733260ff GKH |
63 | |
64 | if (get_driver(driver)) { | |
1b21d5e1 | 65 | retval = driver_attach(driver); |
733260ff GKH |
66 | put_driver(driver); |
67 | } | |
68 | ||
1b21d5e1 GKH |
69 | if (retval) |
70 | return retval; | |
733260ff GKH |
71 | return count; |
72 | } | |
93bacefc GKH |
73 | EXPORT_SYMBOL_GPL(usb_store_new_id); |
74 | ||
75 | static ssize_t store_new_id(struct device_driver *driver, | |
76 | const char *buf, size_t count) | |
77 | { | |
78 | struct usb_driver *usb_drv = to_usb_driver(driver); | |
79 | ||
80 | return usb_store_new_id(&usb_drv->dynids, driver, buf, count); | |
81 | } | |
733260ff GKH |
82 | static DRIVER_ATTR(new_id, S_IWUSR, NULL, store_new_id); |
83 | ||
84 | static int usb_create_newid_file(struct usb_driver *usb_drv) | |
85 | { | |
86 | int error = 0; | |
87 | ||
ba9dc657 GKH |
88 | if (usb_drv->no_dynamic_id) |
89 | goto exit; | |
90 | ||
733260ff | 91 | if (usb_drv->probe != NULL) |
8bb54ab5 | 92 | error = sysfs_create_file(&usb_drv->drvwrap.driver.kobj, |
733260ff | 93 | &driver_attr_new_id.attr); |
ba9dc657 | 94 | exit: |
733260ff GKH |
95 | return error; |
96 | } | |
97 | ||
ba9dc657 GKH |
98 | static void usb_remove_newid_file(struct usb_driver *usb_drv) |
99 | { | |
100 | if (usb_drv->no_dynamic_id) | |
101 | return; | |
102 | ||
103 | if (usb_drv->probe != NULL) | |
8bb54ab5 | 104 | sysfs_remove_file(&usb_drv->drvwrap.driver.kobj, |
ba9dc657 GKH |
105 | &driver_attr_new_id.attr); |
106 | } | |
107 | ||
733260ff GKH |
108 | static void usb_free_dynids(struct usb_driver *usb_drv) |
109 | { | |
110 | struct usb_dynid *dynid, *n; | |
111 | ||
112 | spin_lock(&usb_drv->dynids.lock); | |
113 | list_for_each_entry_safe(dynid, n, &usb_drv->dynids.list, node) { | |
114 | list_del(&dynid->node); | |
115 | kfree(dynid); | |
116 | } | |
117 | spin_unlock(&usb_drv->dynids.lock); | |
118 | } | |
119 | #else | |
120 | static inline int usb_create_newid_file(struct usb_driver *usb_drv) | |
121 | { | |
122 | return 0; | |
123 | } | |
124 | ||
ba9dc657 GKH |
125 | static void usb_remove_newid_file(struct usb_driver *usb_drv) |
126 | { | |
127 | } | |
128 | ||
733260ff GKH |
129 | static inline void usb_free_dynids(struct usb_driver *usb_drv) |
130 | { | |
131 | } | |
132 | #endif | |
133 | ||
134 | static const struct usb_device_id *usb_match_dynamic_id(struct usb_interface *intf, | |
135 | struct usb_driver *drv) | |
136 | { | |
137 | struct usb_dynid *dynid; | |
138 | ||
139 | spin_lock(&drv->dynids.lock); | |
140 | list_for_each_entry(dynid, &drv->dynids.list, node) { | |
141 | if (usb_match_one_id(intf, &dynid->id)) { | |
142 | spin_unlock(&drv->dynids.lock); | |
143 | return &dynid->id; | |
144 | } | |
145 | } | |
146 | spin_unlock(&drv->dynids.lock); | |
147 | return NULL; | |
148 | } | |
149 | ||
150 | ||
8bb54ab5 AS |
151 | /* called from driver core with dev locked */ |
152 | static int usb_probe_device(struct device *dev) | |
153 | { | |
154 | struct usb_device_driver *udriver = to_usb_device_driver(dev->driver); | |
155 | struct usb_device *udev; | |
156 | int error = -ENODEV; | |
157 | ||
158 | dev_dbg(dev, "%s\n", __FUNCTION__); | |
159 | ||
160 | if (!is_usb_device(dev)) /* Sanity check */ | |
161 | return error; | |
162 | ||
163 | udev = to_usb_device(dev); | |
164 | ||
8bb54ab5 AS |
165 | /* TODO: Add real matching code */ |
166 | ||
645daaab AS |
167 | /* The device should always appear to be in use |
168 | * unless the driver suports autosuspend. | |
169 | */ | |
170 | udev->pm_usage_cnt = !(udriver->supports_autosuspend); | |
171 | ||
8bb54ab5 AS |
172 | error = udriver->probe(udev); |
173 | return error; | |
174 | } | |
175 | ||
176 | /* called from driver core with dev locked */ | |
177 | static int usb_unbind_device(struct device *dev) | |
178 | { | |
179 | struct usb_device_driver *udriver = to_usb_device_driver(dev->driver); | |
180 | ||
181 | udriver->disconnect(to_usb_device(dev)); | |
182 | return 0; | |
183 | } | |
184 | ||
185 | ||
186 | /* called from driver core with dev locked */ | |
ddae41be GKH |
187 | static int usb_probe_interface(struct device *dev) |
188 | { | |
8bb54ab5 AS |
189 | struct usb_driver *driver = to_usb_driver(dev->driver); |
190 | struct usb_interface *intf; | |
645daaab | 191 | struct usb_device *udev; |
ddae41be GKH |
192 | const struct usb_device_id *id; |
193 | int error = -ENODEV; | |
194 | ||
195 | dev_dbg(dev, "%s\n", __FUNCTION__); | |
196 | ||
8bb54ab5 | 197 | if (is_usb_device(dev)) /* Sanity check */ |
ddae41be | 198 | return error; |
8bb54ab5 AS |
199 | |
200 | intf = to_usb_interface(dev); | |
645daaab | 201 | udev = interface_to_usbdev(intf); |
ddae41be GKH |
202 | |
203 | id = usb_match_id(intf, driver->id_table); | |
733260ff GKH |
204 | if (!id) |
205 | id = usb_match_dynamic_id(intf, driver); | |
ddae41be GKH |
206 | if (id) { |
207 | dev_dbg(dev, "%s - got id\n", __FUNCTION__); | |
208 | ||
94fcda1f | 209 | error = usb_autoresume_device(udev); |
645daaab AS |
210 | if (error) |
211 | return error; | |
212 | ||
ddae41be GKH |
213 | /* Interface "power state" doesn't correspond to any hardware |
214 | * state whatsoever. We use it to record when it's bound to | |
215 | * a driver that may start I/0: it's not frozen/quiesced. | |
216 | */ | |
217 | mark_active(intf); | |
218 | intf->condition = USB_INTERFACE_BINDING; | |
645daaab AS |
219 | |
220 | /* The interface should always appear to be in use | |
221 | * unless the driver suports autosuspend. | |
222 | */ | |
223 | intf->pm_usage_cnt = !(driver->supports_autosuspend); | |
224 | ||
ddae41be GKH |
225 | error = driver->probe(intf, id); |
226 | if (error) { | |
227 | mark_quiesced(intf); | |
645daaab | 228 | intf->needs_remote_wakeup = 0; |
ddae41be GKH |
229 | intf->condition = USB_INTERFACE_UNBOUND; |
230 | } else | |
231 | intf->condition = USB_INTERFACE_BOUND; | |
645daaab | 232 | |
94fcda1f | 233 | usb_autosuspend_device(udev); |
ddae41be GKH |
234 | } |
235 | ||
236 | return error; | |
237 | } | |
238 | ||
8bb54ab5 | 239 | /* called from driver core with dev locked */ |
ddae41be GKH |
240 | static int usb_unbind_interface(struct device *dev) |
241 | { | |
8bb54ab5 | 242 | struct usb_driver *driver = to_usb_driver(dev->driver); |
ddae41be | 243 | struct usb_interface *intf = to_usb_interface(dev); |
645daaab AS |
244 | struct usb_device *udev; |
245 | int error; | |
ddae41be GKH |
246 | |
247 | intf->condition = USB_INTERFACE_UNBINDING; | |
248 | ||
645daaab AS |
249 | /* Autoresume for set_interface call below */ |
250 | udev = interface_to_usbdev(intf); | |
94fcda1f | 251 | error = usb_autoresume_device(udev); |
645daaab | 252 | |
ddae41be GKH |
253 | /* release all urbs for this interface */ |
254 | usb_disable_interface(interface_to_usbdev(intf), intf); | |
255 | ||
8bb54ab5 | 256 | driver->disconnect(intf); |
ddae41be GKH |
257 | |
258 | /* reset other interface state */ | |
259 | usb_set_interface(interface_to_usbdev(intf), | |
260 | intf->altsetting[0].desc.bInterfaceNumber, | |
261 | 0); | |
262 | usb_set_intfdata(intf, NULL); | |
645daaab | 263 | |
ddae41be GKH |
264 | intf->condition = USB_INTERFACE_UNBOUND; |
265 | mark_quiesced(intf); | |
645daaab AS |
266 | intf->needs_remote_wakeup = 0; |
267 | ||
268 | if (!error) | |
94fcda1f | 269 | usb_autosuspend_device(udev); |
ddae41be GKH |
270 | |
271 | return 0; | |
272 | } | |
273 | ||
36e56a34 AS |
274 | /** |
275 | * usb_driver_claim_interface - bind a driver to an interface | |
276 | * @driver: the driver to be bound | |
277 | * @iface: the interface to which it will be bound; must be in the | |
278 | * usb device's active configuration | |
279 | * @priv: driver data associated with that interface | |
280 | * | |
281 | * This is used by usb device drivers that need to claim more than one | |
282 | * interface on a device when probing (audio and acm are current examples). | |
283 | * No device driver should directly modify internal usb_interface or | |
284 | * usb_device structure members. | |
285 | * | |
286 | * Few drivers should need to use this routine, since the most natural | |
287 | * way to bind to an interface is to return the private data from | |
288 | * the driver's probe() method. | |
289 | * | |
290 | * Callers must own the device lock and the driver model's usb_bus_type.subsys | |
291 | * writelock. So driver probe() entries don't need extra locking, | |
292 | * but other call contexts may need to explicitly claim those locks. | |
293 | */ | |
294 | int usb_driver_claim_interface(struct usb_driver *driver, | |
295 | struct usb_interface *iface, void* priv) | |
296 | { | |
297 | struct device *dev = &iface->dev; | |
645daaab | 298 | struct usb_device *udev = interface_to_usbdev(iface); |
1b21d5e1 | 299 | int retval = 0; |
36e56a34 AS |
300 | |
301 | if (dev->driver) | |
302 | return -EBUSY; | |
303 | ||
8bb54ab5 | 304 | dev->driver = &driver->drvwrap.driver; |
36e56a34 | 305 | usb_set_intfdata(iface, priv); |
645daaab | 306 | |
e0318ebf | 307 | usb_pm_lock(udev); |
36e56a34 AS |
308 | iface->condition = USB_INTERFACE_BOUND; |
309 | mark_active(iface); | |
645daaab | 310 | iface->pm_usage_cnt = !(driver->supports_autosuspend); |
e0318ebf | 311 | usb_pm_unlock(udev); |
36e56a34 AS |
312 | |
313 | /* if interface was already added, bind now; else let | |
314 | * the future device_add() bind it, bypassing probe() | |
315 | */ | |
316 | if (device_is_registered(dev)) | |
1b21d5e1 | 317 | retval = device_bind_driver(dev); |
36e56a34 | 318 | |
1b21d5e1 | 319 | return retval; |
36e56a34 AS |
320 | } |
321 | EXPORT_SYMBOL(usb_driver_claim_interface); | |
322 | ||
323 | /** | |
324 | * usb_driver_release_interface - unbind a driver from an interface | |
325 | * @driver: the driver to be unbound | |
326 | * @iface: the interface from which it will be unbound | |
327 | * | |
328 | * This can be used by drivers to release an interface without waiting | |
329 | * for their disconnect() methods to be called. In typical cases this | |
330 | * also causes the driver disconnect() method to be called. | |
331 | * | |
332 | * This call is synchronous, and may not be used in an interrupt context. | |
333 | * Callers must own the device lock and the driver model's usb_bus_type.subsys | |
334 | * writelock. So driver disconnect() entries don't need extra locking, | |
335 | * but other call contexts may need to explicitly claim those locks. | |
336 | */ | |
337 | void usb_driver_release_interface(struct usb_driver *driver, | |
338 | struct usb_interface *iface) | |
339 | { | |
340 | struct device *dev = &iface->dev; | |
645daaab | 341 | struct usb_device *udev = interface_to_usbdev(iface); |
36e56a34 AS |
342 | |
343 | /* this should never happen, don't release something that's not ours */ | |
8bb54ab5 | 344 | if (!dev->driver || dev->driver != &driver->drvwrap.driver) |
36e56a34 AS |
345 | return; |
346 | ||
347 | /* don't release from within disconnect() */ | |
348 | if (iface->condition != USB_INTERFACE_BOUND) | |
349 | return; | |
350 | ||
351 | /* don't release if the interface hasn't been added yet */ | |
352 | if (device_is_registered(dev)) { | |
353 | iface->condition = USB_INTERFACE_UNBINDING; | |
354 | device_release_driver(dev); | |
355 | } | |
356 | ||
357 | dev->driver = NULL; | |
358 | usb_set_intfdata(iface, NULL); | |
645daaab | 359 | |
e0318ebf | 360 | usb_pm_lock(udev); |
36e56a34 AS |
361 | iface->condition = USB_INTERFACE_UNBOUND; |
362 | mark_quiesced(iface); | |
645daaab | 363 | iface->needs_remote_wakeup = 0; |
e0318ebf | 364 | usb_pm_unlock(udev); |
36e56a34 AS |
365 | } |
366 | EXPORT_SYMBOL(usb_driver_release_interface); | |
367 | ||
733260ff | 368 | /* returns 0 if no match, 1 if match */ |
93bacefc GKH |
369 | int usb_match_one_id(struct usb_interface *interface, |
370 | const struct usb_device_id *id) | |
733260ff GKH |
371 | { |
372 | struct usb_host_interface *intf; | |
373 | struct usb_device *dev; | |
374 | ||
375 | /* proc_connectinfo in devio.c may call us with id == NULL. */ | |
376 | if (id == NULL) | |
377 | return 0; | |
378 | ||
379 | intf = interface->cur_altsetting; | |
380 | dev = interface_to_usbdev(interface); | |
381 | ||
382 | if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) && | |
383 | id->idVendor != le16_to_cpu(dev->descriptor.idVendor)) | |
384 | return 0; | |
385 | ||
386 | if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) && | |
387 | id->idProduct != le16_to_cpu(dev->descriptor.idProduct)) | |
388 | return 0; | |
389 | ||
390 | /* No need to test id->bcdDevice_lo != 0, since 0 is never | |
391 | greater than any unsigned number. */ | |
392 | if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO) && | |
393 | (id->bcdDevice_lo > le16_to_cpu(dev->descriptor.bcdDevice))) | |
394 | return 0; | |
395 | ||
396 | if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) && | |
397 | (id->bcdDevice_hi < le16_to_cpu(dev->descriptor.bcdDevice))) | |
398 | return 0; | |
399 | ||
400 | if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) && | |
401 | (id->bDeviceClass != dev->descriptor.bDeviceClass)) | |
402 | return 0; | |
403 | ||
404 | if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) && | |
405 | (id->bDeviceSubClass!= dev->descriptor.bDeviceSubClass)) | |
406 | return 0; | |
407 | ||
408 | if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) && | |
409 | (id->bDeviceProtocol != dev->descriptor.bDeviceProtocol)) | |
410 | return 0; | |
411 | ||
93c8bf45 AS |
412 | /* The interface class, subclass, and protocol should never be |
413 | * checked for a match if the device class is Vendor Specific, | |
414 | * unless the match record specifies the Vendor ID. */ | |
415 | if (dev->descriptor.bDeviceClass == USB_CLASS_VENDOR_SPEC && | |
416 | !(id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) && | |
417 | (id->match_flags & (USB_DEVICE_ID_MATCH_INT_CLASS | | |
418 | USB_DEVICE_ID_MATCH_INT_SUBCLASS | | |
419 | USB_DEVICE_ID_MATCH_INT_PROTOCOL))) | |
420 | return 0; | |
421 | ||
733260ff GKH |
422 | if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) && |
423 | (id->bInterfaceClass != intf->desc.bInterfaceClass)) | |
424 | return 0; | |
425 | ||
426 | if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) && | |
427 | (id->bInterfaceSubClass != intf->desc.bInterfaceSubClass)) | |
428 | return 0; | |
429 | ||
430 | if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) && | |
431 | (id->bInterfaceProtocol != intf->desc.bInterfaceProtocol)) | |
432 | return 0; | |
433 | ||
434 | return 1; | |
435 | } | |
93bacefc GKH |
436 | EXPORT_SYMBOL_GPL(usb_match_one_id); |
437 | ||
ddae41be GKH |
438 | /** |
439 | * usb_match_id - find first usb_device_id matching device or interface | |
440 | * @interface: the interface of interest | |
441 | * @id: array of usb_device_id structures, terminated by zero entry | |
442 | * | |
443 | * usb_match_id searches an array of usb_device_id's and returns | |
444 | * the first one matching the device or interface, or null. | |
445 | * This is used when binding (or rebinding) a driver to an interface. | |
446 | * Most USB device drivers will use this indirectly, through the usb core, | |
447 | * but some layered driver frameworks use it directly. | |
448 | * These device tables are exported with MODULE_DEVICE_TABLE, through | |
449 | * modutils, to support the driver loading functionality of USB hotplugging. | |
450 | * | |
451 | * What Matches: | |
452 | * | |
453 | * The "match_flags" element in a usb_device_id controls which | |
454 | * members are used. If the corresponding bit is set, the | |
455 | * value in the device_id must match its corresponding member | |
456 | * in the device or interface descriptor, or else the device_id | |
457 | * does not match. | |
458 | * | |
459 | * "driver_info" is normally used only by device drivers, | |
460 | * but you can create a wildcard "matches anything" usb_device_id | |
461 | * as a driver's "modules.usbmap" entry if you provide an id with | |
462 | * only a nonzero "driver_info" field. If you do this, the USB device | |
463 | * driver's probe() routine should use additional intelligence to | |
464 | * decide whether to bind to the specified interface. | |
465 | * | |
466 | * What Makes Good usb_device_id Tables: | |
467 | * | |
468 | * The match algorithm is very simple, so that intelligence in | |
469 | * driver selection must come from smart driver id records. | |
470 | * Unless you have good reasons to use another selection policy, | |
471 | * provide match elements only in related groups, and order match | |
472 | * specifiers from specific to general. Use the macros provided | |
473 | * for that purpose if you can. | |
474 | * | |
475 | * The most specific match specifiers use device descriptor | |
476 | * data. These are commonly used with product-specific matches; | |
477 | * the USB_DEVICE macro lets you provide vendor and product IDs, | |
478 | * and you can also match against ranges of product revisions. | |
479 | * These are widely used for devices with application or vendor | |
480 | * specific bDeviceClass values. | |
481 | * | |
482 | * Matches based on device class/subclass/protocol specifications | |
483 | * are slightly more general; use the USB_DEVICE_INFO macro, or | |
484 | * its siblings. These are used with single-function devices | |
485 | * where bDeviceClass doesn't specify that each interface has | |
486 | * its own class. | |
487 | * | |
488 | * Matches based on interface class/subclass/protocol are the | |
489 | * most general; they let drivers bind to any interface on a | |
490 | * multiple-function device. Use the USB_INTERFACE_INFO | |
491 | * macro, or its siblings, to match class-per-interface style | |
93c8bf45 AS |
492 | * devices (as recorded in bInterfaceClass). |
493 | * | |
494 | * Note that an entry created by USB_INTERFACE_INFO won't match | |
495 | * any interface if the device class is set to Vendor-Specific. | |
496 | * This is deliberate; according to the USB spec the meanings of | |
497 | * the interface class/subclass/protocol for these devices are also | |
498 | * vendor-specific, and hence matching against a standard product | |
499 | * class wouldn't work anyway. If you really want to use an | |
500 | * interface-based match for such a device, create a match record | |
501 | * that also specifies the vendor ID. (Unforunately there isn't a | |
502 | * standard macro for creating records like this.) | |
ddae41be GKH |
503 | * |
504 | * Within those groups, remember that not all combinations are | |
505 | * meaningful. For example, don't give a product version range | |
506 | * without vendor and product IDs; or specify a protocol without | |
507 | * its associated class and subclass. | |
508 | */ | |
509 | const struct usb_device_id *usb_match_id(struct usb_interface *interface, | |
510 | const struct usb_device_id *id) | |
511 | { | |
ddae41be GKH |
512 | /* proc_connectinfo in devio.c may call us with id == NULL. */ |
513 | if (id == NULL) | |
514 | return NULL; | |
515 | ||
ddae41be GKH |
516 | /* It is important to check that id->driver_info is nonzero, |
517 | since an entry that is all zeroes except for a nonzero | |
518 | id->driver_info is the way to create an entry that | |
519 | indicates that the driver want to examine every | |
520 | device and interface. */ | |
521 | for (; id->idVendor || id->bDeviceClass || id->bInterfaceClass || | |
522 | id->driver_info; id++) { | |
733260ff GKH |
523 | if (usb_match_one_id(interface, id)) |
524 | return id; | |
ddae41be GKH |
525 | } |
526 | ||
527 | return NULL; | |
528 | } | |
b87ba0a3 | 529 | EXPORT_SYMBOL_GPL_FUTURE(usb_match_id); |
ddae41be | 530 | |
8bb22d2b | 531 | static int usb_device_match(struct device *dev, struct device_driver *drv) |
ddae41be | 532 | { |
8bb54ab5 AS |
533 | /* devices and interfaces are handled separately */ |
534 | if (is_usb_device(dev)) { | |
ddae41be | 535 | |
8bb54ab5 AS |
536 | /* interface drivers never match devices */ |
537 | if (!is_usb_device_driver(drv)) | |
538 | return 0; | |
ddae41be | 539 | |
8bb54ab5 | 540 | /* TODO: Add real matching code */ |
ddae41be GKH |
541 | return 1; |
542 | ||
8bb54ab5 AS |
543 | } else { |
544 | struct usb_interface *intf; | |
545 | struct usb_driver *usb_drv; | |
546 | const struct usb_device_id *id; | |
547 | ||
548 | /* device drivers never match interfaces */ | |
549 | if (is_usb_device_driver(drv)) | |
550 | return 0; | |
551 | ||
552 | intf = to_usb_interface(dev); | |
553 | usb_drv = to_usb_driver(drv); | |
554 | ||
555 | id = usb_match_id(intf, usb_drv->id_table); | |
556 | if (id) | |
557 | return 1; | |
558 | ||
559 | id = usb_match_dynamic_id(intf, usb_drv); | |
560 | if (id) | |
561 | return 1; | |
562 | } | |
563 | ||
ddae41be GKH |
564 | return 0; |
565 | } | |
566 | ||
36e56a34 AS |
567 | #ifdef CONFIG_HOTPLUG |
568 | ||
569 | /* | |
570 | * This sends an uevent to userspace, typically helping to load driver | |
571 | * or other modules, configure the device, and more. Drivers can provide | |
572 | * a MODULE_DEVICE_TABLE to help with module loading subtasks. | |
573 | * | |
574 | * We're called either from khubd (the typical case) or from root hub | |
575 | * (init, kapmd, modprobe, rmmod, etc), but the agents need to handle | |
576 | * delays in event delivery. Use sysfs (and DEVPATH) to make sure the | |
577 | * device (and this configuration!) are still present. | |
578 | */ | |
579 | static int usb_uevent(struct device *dev, char **envp, int num_envp, | |
580 | char *buffer, int buffer_size) | |
581 | { | |
582 | struct usb_interface *intf; | |
583 | struct usb_device *usb_dev; | |
584 | struct usb_host_interface *alt; | |
585 | int i = 0; | |
586 | int length = 0; | |
587 | ||
588 | if (!dev) | |
589 | return -ENODEV; | |
590 | ||
591 | /* driver is often null here; dev_dbg() would oops */ | |
592 | pr_debug ("usb %s: uevent\n", dev->bus_id); | |
593 | ||
782da727 AS |
594 | if (is_usb_device(dev)) { |
595 | usb_dev = to_usb_device(dev); | |
596 | alt = NULL; | |
597 | } else { | |
8bb54ab5 AS |
598 | intf = to_usb_interface(dev); |
599 | usb_dev = interface_to_usbdev(intf); | |
600 | alt = intf->cur_altsetting; | |
601 | } | |
36e56a34 AS |
602 | |
603 | if (usb_dev->devnum < 0) { | |
604 | pr_debug ("usb %s: already deleted?\n", dev->bus_id); | |
605 | return -ENODEV; | |
606 | } | |
607 | if (!usb_dev->bus) { | |
608 | pr_debug ("usb %s: bus removed?\n", dev->bus_id); | |
609 | return -ENODEV; | |
610 | } | |
611 | ||
612 | #ifdef CONFIG_USB_DEVICEFS | |
613 | /* If this is available, userspace programs can directly read | |
614 | * all the device descriptors we don't tell them about. Or | |
615 | * even act as usermode drivers. | |
616 | * | |
617 | * FIXME reduce hardwired intelligence here | |
618 | */ | |
619 | if (add_uevent_var(envp, num_envp, &i, | |
620 | buffer, buffer_size, &length, | |
621 | "DEVICE=/proc/bus/usb/%03d/%03d", | |
622 | usb_dev->bus->busnum, usb_dev->devnum)) | |
623 | return -ENOMEM; | |
624 | #endif | |
625 | ||
626 | /* per-device configurations are common */ | |
627 | if (add_uevent_var(envp, num_envp, &i, | |
628 | buffer, buffer_size, &length, | |
629 | "PRODUCT=%x/%x/%x", | |
630 | le16_to_cpu(usb_dev->descriptor.idVendor), | |
631 | le16_to_cpu(usb_dev->descriptor.idProduct), | |
632 | le16_to_cpu(usb_dev->descriptor.bcdDevice))) | |
633 | return -ENOMEM; | |
634 | ||
635 | /* class-based driver binding models */ | |
636 | if (add_uevent_var(envp, num_envp, &i, | |
637 | buffer, buffer_size, &length, | |
638 | "TYPE=%d/%d/%d", | |
639 | usb_dev->descriptor.bDeviceClass, | |
640 | usb_dev->descriptor.bDeviceSubClass, | |
641 | usb_dev->descriptor.bDeviceProtocol)) | |
642 | return -ENOMEM; | |
643 | ||
782da727 AS |
644 | if (!is_usb_device(dev)) { |
645 | ||
646 | if (add_uevent_var(envp, num_envp, &i, | |
36e56a34 AS |
647 | buffer, buffer_size, &length, |
648 | "INTERFACE=%d/%d/%d", | |
649 | alt->desc.bInterfaceClass, | |
650 | alt->desc.bInterfaceSubClass, | |
651 | alt->desc.bInterfaceProtocol)) | |
782da727 | 652 | return -ENOMEM; |
36e56a34 | 653 | |
782da727 | 654 | if (add_uevent_var(envp, num_envp, &i, |
36e56a34 AS |
655 | buffer, buffer_size, &length, |
656 | "MODALIAS=usb:v%04Xp%04Xd%04Xdc%02Xdsc%02Xdp%02Xic%02Xisc%02Xip%02X", | |
657 | le16_to_cpu(usb_dev->descriptor.idVendor), | |
658 | le16_to_cpu(usb_dev->descriptor.idProduct), | |
659 | le16_to_cpu(usb_dev->descriptor.bcdDevice), | |
660 | usb_dev->descriptor.bDeviceClass, | |
661 | usb_dev->descriptor.bDeviceSubClass, | |
662 | usb_dev->descriptor.bDeviceProtocol, | |
663 | alt->desc.bInterfaceClass, | |
664 | alt->desc.bInterfaceSubClass, | |
665 | alt->desc.bInterfaceProtocol)) | |
782da727 AS |
666 | return -ENOMEM; |
667 | } | |
36e56a34 AS |
668 | |
669 | envp[i] = NULL; | |
670 | ||
671 | return 0; | |
672 | } | |
673 | ||
674 | #else | |
675 | ||
676 | static int usb_uevent(struct device *dev, char **envp, | |
677 | int num_envp, char *buffer, int buffer_size) | |
678 | { | |
679 | return -ENODEV; | |
680 | } | |
681 | ||
682 | #endif /* CONFIG_HOTPLUG */ | |
683 | ||
ddae41be | 684 | /** |
8bb54ab5 AS |
685 | * usb_register_device_driver - register a USB device (not interface) driver |
686 | * @new_udriver: USB operations for the device driver | |
2143acc6 | 687 | * @owner: module owner of this driver. |
ddae41be | 688 | * |
8bb54ab5 AS |
689 | * Registers a USB device driver with the USB core. The list of |
690 | * unattached devices will be rescanned whenever a new driver is | |
691 | * added, allowing the new driver to attach to any recognized devices. | |
692 | * Returns a negative error code on failure and 0 on success. | |
693 | */ | |
694 | int usb_register_device_driver(struct usb_device_driver *new_udriver, | |
695 | struct module *owner) | |
696 | { | |
697 | int retval = 0; | |
698 | ||
699 | if (usb_disabled()) | |
700 | return -ENODEV; | |
701 | ||
702 | new_udriver->drvwrap.for_devices = 1; | |
703 | new_udriver->drvwrap.driver.name = (char *) new_udriver->name; | |
704 | new_udriver->drvwrap.driver.bus = &usb_bus_type; | |
705 | new_udriver->drvwrap.driver.probe = usb_probe_device; | |
706 | new_udriver->drvwrap.driver.remove = usb_unbind_device; | |
707 | new_udriver->drvwrap.driver.owner = owner; | |
708 | ||
709 | retval = driver_register(&new_udriver->drvwrap.driver); | |
710 | ||
711 | if (!retval) { | |
712 | pr_info("%s: registered new device driver %s\n", | |
713 | usbcore_name, new_udriver->name); | |
714 | usbfs_update_special(); | |
715 | } else { | |
716 | printk(KERN_ERR "%s: error %d registering device " | |
717 | " driver %s\n", | |
718 | usbcore_name, retval, new_udriver->name); | |
719 | } | |
720 | ||
721 | return retval; | |
722 | } | |
723 | EXPORT_SYMBOL_GPL(usb_register_device_driver); | |
724 | ||
725 | /** | |
726 | * usb_deregister_device_driver - unregister a USB device (not interface) driver | |
727 | * @udriver: USB operations of the device driver to unregister | |
728 | * Context: must be able to sleep | |
729 | * | |
730 | * Unlinks the specified driver from the internal USB driver list. | |
731 | */ | |
732 | void usb_deregister_device_driver(struct usb_device_driver *udriver) | |
733 | { | |
734 | pr_info("%s: deregistering device driver %s\n", | |
735 | usbcore_name, udriver->name); | |
736 | ||
737 | driver_unregister(&udriver->drvwrap.driver); | |
738 | usbfs_update_special(); | |
739 | } | |
740 | EXPORT_SYMBOL_GPL(usb_deregister_device_driver); | |
741 | ||
742 | /** | |
743 | * usb_register_driver - register a USB interface driver | |
744 | * @new_driver: USB operations for the interface driver | |
745 | * @owner: module owner of this driver. | |
892705a1 | 746 | * @mod_name: module name string |
8bb54ab5 AS |
747 | * |
748 | * Registers a USB interface driver with the USB core. The list of | |
749 | * unattached interfaces will be rescanned whenever a new driver is | |
750 | * added, allowing the new driver to attach to any recognized interfaces. | |
ddae41be GKH |
751 | * Returns a negative error code on failure and 0 on success. |
752 | * | |
753 | * NOTE: if you want your driver to use the USB major number, you must call | |
754 | * usb_register_dev() to enable that functionality. This function no longer | |
755 | * takes care of that. | |
756 | */ | |
80f745fb GKH |
757 | int usb_register_driver(struct usb_driver *new_driver, struct module *owner, |
758 | const char *mod_name) | |
ddae41be GKH |
759 | { |
760 | int retval = 0; | |
761 | ||
762 | if (usb_disabled()) | |
763 | return -ENODEV; | |
764 | ||
8bb54ab5 AS |
765 | new_driver->drvwrap.for_devices = 0; |
766 | new_driver->drvwrap.driver.name = (char *) new_driver->name; | |
767 | new_driver->drvwrap.driver.bus = &usb_bus_type; | |
768 | new_driver->drvwrap.driver.probe = usb_probe_interface; | |
769 | new_driver->drvwrap.driver.remove = usb_unbind_interface; | |
770 | new_driver->drvwrap.driver.owner = owner; | |
80f745fb | 771 | new_driver->drvwrap.driver.mod_name = mod_name; |
733260ff GKH |
772 | spin_lock_init(&new_driver->dynids.lock); |
773 | INIT_LIST_HEAD(&new_driver->dynids.list); | |
ddae41be | 774 | |
8bb54ab5 | 775 | retval = driver_register(&new_driver->drvwrap.driver); |
ddae41be GKH |
776 | |
777 | if (!retval) { | |
8bb54ab5 | 778 | pr_info("%s: registered new interface driver %s\n", |
ddae41be GKH |
779 | usbcore_name, new_driver->name); |
780 | usbfs_update_special(); | |
733260ff | 781 | usb_create_newid_file(new_driver); |
ddae41be | 782 | } else { |
8bb54ab5 AS |
783 | printk(KERN_ERR "%s: error %d registering interface " |
784 | " driver %s\n", | |
ddae41be GKH |
785 | usbcore_name, retval, new_driver->name); |
786 | } | |
787 | ||
788 | return retval; | |
789 | } | |
b87ba0a3 | 790 | EXPORT_SYMBOL_GPL_FUTURE(usb_register_driver); |
ddae41be GKH |
791 | |
792 | /** | |
8bb54ab5 AS |
793 | * usb_deregister - unregister a USB interface driver |
794 | * @driver: USB operations of the interface driver to unregister | |
ddae41be GKH |
795 | * Context: must be able to sleep |
796 | * | |
797 | * Unlinks the specified driver from the internal USB driver list. | |
798 | * | |
799 | * NOTE: If you called usb_register_dev(), you still need to call | |
800 | * usb_deregister_dev() to clean up your driver's allocated minor numbers, | |
801 | * this * call will no longer do it for you. | |
802 | */ | |
803 | void usb_deregister(struct usb_driver *driver) | |
804 | { | |
8bb54ab5 AS |
805 | pr_info("%s: deregistering interface driver %s\n", |
806 | usbcore_name, driver->name); | |
ddae41be | 807 | |
ba9dc657 | 808 | usb_remove_newid_file(driver); |
733260ff | 809 | usb_free_dynids(driver); |
8bb54ab5 | 810 | driver_unregister(&driver->drvwrap.driver); |
ddae41be GKH |
811 | |
812 | usbfs_update_special(); | |
813 | } | |
b87ba0a3 | 814 | EXPORT_SYMBOL_GPL_FUTURE(usb_deregister); |
36e56a34 AS |
815 | |
816 | #ifdef CONFIG_PM | |
817 | ||
e0318ebf | 818 | /* Caller has locked udev's pm_mutex */ |
d5ec1686 | 819 | static int usb_suspend_device(struct usb_device *udev, pm_message_t msg) |
36e56a34 | 820 | { |
782da727 | 821 | struct usb_device_driver *udriver; |
2bf4086d | 822 | int status = 0; |
36e56a34 | 823 | |
114b368c AS |
824 | if (udev->state == USB_STATE_NOTATTACHED || |
825 | udev->state == USB_STATE_SUSPENDED) | |
826 | goto done; | |
827 | ||
1c5df7e7 AS |
828 | /* For devices that don't have a driver, we do a standard suspend. */ |
829 | if (udev->dev.driver == NULL) { | |
645daaab | 830 | udev->do_remote_wakeup = 0; |
1c5df7e7 | 831 | status = usb_port_suspend(udev); |
2bf4086d | 832 | goto done; |
1c5df7e7 AS |
833 | } |
834 | ||
1cc8a25d | 835 | udriver = to_usb_device_driver(udev->dev.driver); |
2bf4086d AS |
836 | status = udriver->suspend(udev, msg); |
837 | ||
838 | done: | |
645daaab | 839 | // dev_dbg(&udev->dev, "%s: status %d\n", __FUNCTION__, status); |
2bf4086d AS |
840 | if (status == 0) |
841 | udev->dev.power.power_state.event = msg.event; | |
842 | return status; | |
1cc8a25d AS |
843 | } |
844 | ||
e0318ebf | 845 | /* Caller has locked udev's pm_mutex */ |
d5ec1686 | 846 | static int usb_resume_device(struct usb_device *udev) |
1cc8a25d AS |
847 | { |
848 | struct usb_device_driver *udriver; | |
2bf4086d | 849 | int status = 0; |
36e56a34 | 850 | |
114b368c AS |
851 | if (udev->state == USB_STATE_NOTATTACHED || |
852 | udev->state != USB_STATE_SUSPENDED) | |
2bf4086d | 853 | goto done; |
1cc8a25d | 854 | |
1c5df7e7 AS |
855 | /* Can't resume it if it doesn't have a driver. */ |
856 | if (udev->dev.driver == NULL) { | |
857 | status = -ENOTCONN; | |
2bf4086d | 858 | goto done; |
1c5df7e7 AS |
859 | } |
860 | ||
1cc8a25d | 861 | udriver = to_usb_device_driver(udev->dev.driver); |
2bf4086d AS |
862 | status = udriver->resume(udev); |
863 | ||
864 | done: | |
645daaab | 865 | // dev_dbg(&udev->dev, "%s: status %d\n", __FUNCTION__, status); |
2bf4086d AS |
866 | if (status == 0) |
867 | udev->dev.power.power_state.event = PM_EVENT_ON; | |
868 | return status; | |
1cc8a25d AS |
869 | } |
870 | ||
e0318ebf | 871 | /* Caller has locked intf's usb_device's pm mutex */ |
d5ec1686 | 872 | static int usb_suspend_interface(struct usb_interface *intf, pm_message_t msg) |
1cc8a25d AS |
873 | { |
874 | struct usb_driver *driver; | |
2bf4086d | 875 | int status = 0; |
1cc8a25d | 876 | |
114b368c AS |
877 | /* with no hardware, USB interfaces only use FREEZE and ON states */ |
878 | if (interface_to_usbdev(intf)->state == USB_STATE_NOTATTACHED || | |
879 | !is_active(intf)) | |
2bf4086d | 880 | goto done; |
1cc8a25d | 881 | |
645daaab | 882 | if (intf->condition == USB_INTERFACE_UNBOUND) /* This can't happen */ |
2bf4086d | 883 | goto done; |
114b368c | 884 | driver = to_usb_driver(intf->dev.driver); |
36e56a34 AS |
885 | |
886 | if (driver->suspend && driver->resume) { | |
1cc8a25d | 887 | status = driver->suspend(intf, msg); |
645daaab AS |
888 | if (status == 0) |
889 | mark_quiesced(intf); | |
890 | else if (!interface_to_usbdev(intf)->auto_pm) | |
1cc8a25d AS |
891 | dev_err(&intf->dev, "%s error %d\n", |
892 | "suspend", status); | |
36e56a34 AS |
893 | } else { |
894 | // FIXME else if there's no suspend method, disconnect... | |
645daaab | 895 | // Not possible if auto_pm is set... |
1cc8a25d AS |
896 | dev_warn(&intf->dev, "no suspend for driver %s?\n", |
897 | driver->name); | |
36e56a34 | 898 | mark_quiesced(intf); |
36e56a34 | 899 | } |
2bf4086d AS |
900 | |
901 | done: | |
645daaab | 902 | // dev_dbg(&intf->dev, "%s: status %d\n", __FUNCTION__, status); |
2bf4086d AS |
903 | if (status == 0) |
904 | intf->dev.power.power_state.event = msg.event; | |
36e56a34 AS |
905 | return status; |
906 | } | |
907 | ||
645daaab | 908 | /* Caller has locked intf's usb_device's pm_mutex */ |
d5ec1686 | 909 | static int usb_resume_interface(struct usb_interface *intf) |
36e56a34 | 910 | { |
1cc8a25d | 911 | struct usb_driver *driver; |
2bf4086d | 912 | int status = 0; |
36e56a34 | 913 | |
114b368c AS |
914 | if (interface_to_usbdev(intf)->state == USB_STATE_NOTATTACHED || |
915 | is_active(intf)) | |
2bf4086d | 916 | goto done; |
36e56a34 | 917 | |
645daaab AS |
918 | /* Don't let autoresume interfere with unbinding */ |
919 | if (intf->condition == USB_INTERFACE_UNBINDING) | |
920 | goto done; | |
921 | ||
1c5df7e7 | 922 | /* Can't resume it if it doesn't have a driver. */ |
645daaab | 923 | if (intf->condition == USB_INTERFACE_UNBOUND) { |
1c5df7e7 | 924 | status = -ENOTCONN; |
2bf4086d | 925 | goto done; |
1c5df7e7 | 926 | } |
1cc8a25d | 927 | driver = to_usb_driver(intf->dev.driver); |
36e56a34 | 928 | |
36e56a34 AS |
929 | if (driver->resume) { |
930 | status = driver->resume(intf); | |
2bf4086d | 931 | if (status) |
1cc8a25d AS |
932 | dev_err(&intf->dev, "%s error %d\n", |
933 | "resume", status); | |
2bf4086d AS |
934 | else |
935 | mark_active(intf); | |
936 | } else { | |
1cc8a25d AS |
937 | dev_warn(&intf->dev, "no resume for driver %s?\n", |
938 | driver->name); | |
2bf4086d AS |
939 | mark_active(intf); |
940 | } | |
941 | ||
942 | done: | |
645daaab | 943 | // dev_dbg(&intf->dev, "%s: status %d\n", __FUNCTION__, status); |
2bf4086d AS |
944 | if (status == 0) |
945 | intf->dev.power.power_state.event = PM_EVENT_ON; | |
946 | return status; | |
36e56a34 AS |
947 | } |
948 | ||
94fcda1f AS |
949 | #ifdef CONFIG_USB_SUSPEND |
950 | ||
af4f7606 AS |
951 | /* Internal routine to check whether we may autosuspend a device. */ |
952 | static int autosuspend_check(struct usb_device *udev) | |
953 | { | |
954 | int i; | |
955 | struct usb_interface *intf; | |
956 | ||
957 | /* For autosuspend, fail fast if anything is in use. | |
958 | * Also fail if any interfaces require remote wakeup but it | |
959 | * isn't available. */ | |
960 | udev->do_remote_wakeup = device_may_wakeup(&udev->dev); | |
961 | if (udev->pm_usage_cnt > 0) | |
962 | return -EBUSY; | |
963 | if (udev->actconfig) { | |
964 | for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) { | |
965 | intf = udev->actconfig->interface[i]; | |
966 | if (!is_active(intf)) | |
967 | continue; | |
968 | if (intf->pm_usage_cnt > 0) | |
969 | return -EBUSY; | |
970 | if (intf->needs_remote_wakeup && | |
971 | !udev->do_remote_wakeup) { | |
972 | dev_dbg(&udev->dev, "remote wakeup needed " | |
973 | "for autosuspend\n"); | |
974 | return -EOPNOTSUPP; | |
975 | } | |
976 | } | |
977 | } | |
978 | return 0; | |
979 | } | |
980 | ||
94fcda1f AS |
981 | #else |
982 | ||
983 | #define autosuspend_check(udev) 0 | |
984 | ||
985 | #endif | |
986 | ||
645daaab AS |
987 | /** |
988 | * usb_suspend_both - suspend a USB device and its interfaces | |
989 | * @udev: the usb_device to suspend | |
990 | * @msg: Power Management message describing this state transition | |
991 | * | |
992 | * This is the central routine for suspending USB devices. It calls the | |
993 | * suspend methods for all the interface drivers in @udev and then calls | |
994 | * the suspend method for @udev itself. If an error occurs at any stage, | |
995 | * all the interfaces which were suspended are resumed so that they remain | |
996 | * in the same state as the device. | |
997 | * | |
998 | * If an autosuspend is in progress (@udev->auto_pm is set), the routine | |
999 | * checks first to make sure that neither the device itself or any of its | |
1000 | * active interfaces is in use (pm_usage_cnt is greater than 0). If they | |
1001 | * are, the autosuspend fails. | |
1002 | * | |
1003 | * If the suspend succeeds, the routine recursively queues an autosuspend | |
1004 | * request for @udev's parent device, thereby propagating the change up | |
1005 | * the device tree. If all of the parent's children are now suspended, | |
1006 | * the parent will autosuspend in turn. | |
1007 | * | |
1008 | * The suspend method calls are subject to mutual exclusion under control | |
1009 | * of @udev's pm_mutex. Many of these calls are also under the protection | |
1010 | * of @udev's device lock (including all requests originating outside the | |
1011 | * USB subsystem), but autosuspend requests generated by a child device or | |
1012 | * interface driver may not be. Usbcore will insure that the method calls | |
1013 | * do not arrive during bind, unbind, or reset operations. However, drivers | |
1014 | * must be prepared to handle suspend calls arriving at unpredictable times. | |
1015 | * The only way to block such calls is to do an autoresume (preventing | |
1016 | * autosuspends) while holding @udev's device lock (preventing outside | |
1017 | * suspends). | |
1018 | * | |
1019 | * The caller must hold @udev->pm_mutex. | |
1020 | * | |
1021 | * This routine can run only in process context. | |
1022 | */ | |
a8e7c565 AS |
1023 | int usb_suspend_both(struct usb_device *udev, pm_message_t msg) |
1024 | { | |
1025 | int status = 0; | |
1026 | int i = 0; | |
1027 | struct usb_interface *intf; | |
645daaab AS |
1028 | struct usb_device *parent = udev->parent; |
1029 | ||
1030 | cancel_delayed_work(&udev->autosuspend); | |
1031 | if (udev->state == USB_STATE_NOTATTACHED) | |
1032 | return 0; | |
1033 | if (udev->state == USB_STATE_SUSPENDED) | |
1034 | return 0; | |
a8e7c565 | 1035 | |
645daaab AS |
1036 | udev->do_remote_wakeup = device_may_wakeup(&udev->dev); |
1037 | ||
645daaab | 1038 | if (udev->auto_pm) { |
af4f7606 AS |
1039 | status = autosuspend_check(udev); |
1040 | if (status < 0) | |
1041 | return status; | |
645daaab AS |
1042 | } |
1043 | ||
1044 | /* Suspend all the interfaces and then udev itself */ | |
a8e7c565 AS |
1045 | if (udev->actconfig) { |
1046 | for (; i < udev->actconfig->desc.bNumInterfaces; i++) { | |
1047 | intf = udev->actconfig->interface[i]; | |
d5ec1686 | 1048 | status = usb_suspend_interface(intf, msg); |
a8e7c565 AS |
1049 | if (status != 0) |
1050 | break; | |
1051 | } | |
1052 | } | |
1053 | if (status == 0) | |
d5ec1686 | 1054 | status = usb_suspend_device(udev, msg); |
a8e7c565 AS |
1055 | |
1056 | /* If the suspend failed, resume interfaces that did get suspended */ | |
1057 | if (status != 0) { | |
1058 | while (--i >= 0) { | |
1059 | intf = udev->actconfig->interface[i]; | |
d5ec1686 | 1060 | usb_resume_interface(intf); |
a8e7c565 | 1061 | } |
645daaab AS |
1062 | |
1063 | /* If the suspend succeeded, propagate it up the tree */ | |
1064 | } else if (parent) | |
94fcda1f | 1065 | usb_autosuspend_device(parent); |
645daaab AS |
1066 | |
1067 | // dev_dbg(&udev->dev, "%s: status %d\n", __FUNCTION__, status); | |
a8e7c565 AS |
1068 | return status; |
1069 | } | |
1070 | ||
645daaab AS |
1071 | /** |
1072 | * usb_resume_both - resume a USB device and its interfaces | |
1073 | * @udev: the usb_device to resume | |
1074 | * | |
1075 | * This is the central routine for resuming USB devices. It calls the | |
1076 | * the resume method for @udev and then calls the resume methods for all | |
1077 | * the interface drivers in @udev. | |
1078 | * | |
1079 | * Before starting the resume, the routine calls itself recursively for | |
1080 | * the parent device of @udev, thereby propagating the change up the device | |
1081 | * tree and assuring that @udev will be able to resume. If the parent is | |
1082 | * unable to resume successfully, the routine fails. | |
1083 | * | |
1084 | * The resume method calls are subject to mutual exclusion under control | |
1085 | * of @udev's pm_mutex. Many of these calls are also under the protection | |
1086 | * of @udev's device lock (including all requests originating outside the | |
1087 | * USB subsystem), but autoresume requests generated by a child device or | |
1088 | * interface driver may not be. Usbcore will insure that the method calls | |
1089 | * do not arrive during bind, unbind, or reset operations. However, drivers | |
1090 | * must be prepared to handle resume calls arriving at unpredictable times. | |
1091 | * The only way to block such calls is to do an autoresume (preventing | |
1092 | * other autoresumes) while holding @udev's device lock (preventing outside | |
1093 | * resumes). | |
1094 | * | |
1095 | * The caller must hold @udev->pm_mutex. | |
1096 | * | |
1097 | * This routine can run only in process context. | |
1098 | */ | |
a8e7c565 AS |
1099 | int usb_resume_both(struct usb_device *udev) |
1100 | { | |
645daaab | 1101 | int status = 0; |
a8e7c565 AS |
1102 | int i; |
1103 | struct usb_interface *intf; | |
645daaab AS |
1104 | struct usb_device *parent = udev->parent; |
1105 | ||
1106 | cancel_delayed_work(&udev->autosuspend); | |
1107 | if (udev->state == USB_STATE_NOTATTACHED) | |
1108 | return -ENODEV; | |
a8e7c565 | 1109 | |
645daaab AS |
1110 | /* Propagate the resume up the tree, if necessary */ |
1111 | if (udev->state == USB_STATE_SUSPENDED) { | |
1112 | if (parent) { | |
94fcda1f | 1113 | status = usb_autoresume_device(parent); |
ee49fb5d AS |
1114 | if (status == 0) { |
1115 | status = usb_resume_device(udev); | |
1116 | if (status) { | |
94fcda1f | 1117 | usb_autosuspend_device(parent); |
ee49fb5d AS |
1118 | |
1119 | /* It's possible usb_resume_device() | |
1120 | * failed after the port was | |
1121 | * unsuspended, causing udev to be | |
1122 | * logically disconnected. We don't | |
1123 | * want usb_disconnect() to autosuspend | |
1124 | * the parent again, so tell it that | |
1125 | * udev disconnected while still | |
1126 | * suspended. */ | |
1127 | if (udev->state == | |
1128 | USB_STATE_NOTATTACHED) | |
1129 | udev->discon_suspended = 1; | |
1130 | } | |
1131 | } | |
645daaab AS |
1132 | } else { |
1133 | ||
1134 | /* We can't progagate beyond the USB subsystem, | |
1135 | * so if a root hub's controller is suspended | |
1136 | * then we're stuck. */ | |
1137 | if (udev->dev.parent->power.power_state.event != | |
1138 | PM_EVENT_ON) | |
1139 | status = -EHOSTUNREACH; | |
ee49fb5d AS |
1140 | else |
1141 | status = usb_resume_device(udev); | |
1142 | } | |
592fbbe4 AS |
1143 | } else { |
1144 | ||
1145 | /* Needed only for setting udev->dev.power.power_state.event | |
1146 | * and for possible debugging message. */ | |
d5ec1686 | 1147 | status = usb_resume_device(udev); |
114b368c AS |
1148 | } |
1149 | ||
a8e7c565 AS |
1150 | if (status == 0 && udev->actconfig) { |
1151 | for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) { | |
1152 | intf = udev->actconfig->interface[i]; | |
d5ec1686 | 1153 | usb_resume_interface(intf); |
a8e7c565 AS |
1154 | } |
1155 | } | |
645daaab AS |
1156 | |
1157 | // dev_dbg(&udev->dev, "%s: status %d\n", __FUNCTION__, status); | |
1158 | return status; | |
1159 | } | |
1160 | ||
1161 | #ifdef CONFIG_USB_SUSPEND | |
1162 | ||
94fcda1f AS |
1163 | /* Internal routine to adjust a device's usage counter and change |
1164 | * its autosuspend state. | |
1165 | */ | |
1166 | static int usb_autopm_do_device(struct usb_device *udev, int inc_usage_cnt) | |
1167 | { | |
1168 | int status = 0; | |
1169 | ||
1170 | usb_pm_lock(udev); | |
1171 | udev->pm_usage_cnt += inc_usage_cnt; | |
1172 | WARN_ON(udev->pm_usage_cnt < 0); | |
1173 | if (inc_usage_cnt >= 0 && udev->pm_usage_cnt > 0) { | |
1174 | udev->auto_pm = 1; | |
1175 | status = usb_resume_both(udev); | |
1176 | if (status != 0) | |
1177 | udev->pm_usage_cnt -= inc_usage_cnt; | |
1178 | } else if (inc_usage_cnt <= 0 && autosuspend_check(udev) == 0) | |
1179 | queue_delayed_work(ksuspend_usb_wq, &udev->autosuspend, | |
1180 | USB_AUTOSUSPEND_DELAY); | |
1181 | usb_pm_unlock(udev); | |
1182 | return status; | |
1183 | } | |
1184 | ||
645daaab AS |
1185 | /** |
1186 | * usb_autosuspend_device - delayed autosuspend of a USB device and its interfaces | |
701f35af | 1187 | * @udev: the usb_device to autosuspend |
645daaab AS |
1188 | * |
1189 | * This routine should be called when a core subsystem is finished using | |
1190 | * @udev and wants to allow it to autosuspend. Examples would be when | |
1191 | * @udev's device file in usbfs is closed or after a configuration change. | |
1192 | * | |
94fcda1f AS |
1193 | * @udev's usage counter is decremented. If it or any of the usage counters |
1194 | * for an active interface is greater than 0, no autosuspend request will be | |
1195 | * queued. (If an interface driver does not support autosuspend then its | |
1196 | * usage counter is permanently positive.) Furthermore, if an interface | |
1197 | * driver requires remote-wakeup capability during autosuspend but remote | |
1198 | * wakeup is disabled, the autosuspend will fail. | |
645daaab AS |
1199 | * |
1200 | * Often the caller will hold @udev's device lock, but this is not | |
1201 | * necessary. | |
1202 | * | |
1203 | * This routine can run only in process context. | |
1204 | */ | |
94fcda1f | 1205 | void usb_autosuspend_device(struct usb_device *udev) |
645daaab | 1206 | { |
94fcda1f AS |
1207 | int status; |
1208 | ||
1209 | status = usb_autopm_do_device(udev, -1); | |
645daaab AS |
1210 | // dev_dbg(&udev->dev, "%s: cnt %d\n", |
1211 | // __FUNCTION__, udev->pm_usage_cnt); | |
1212 | } | |
1213 | ||
1214 | /** | |
1215 | * usb_autoresume_device - immediately autoresume a USB device and its interfaces | |
701f35af | 1216 | * @udev: the usb_device to autoresume |
645daaab AS |
1217 | * |
1218 | * This routine should be called when a core subsystem wants to use @udev | |
94fcda1f AS |
1219 | * and needs to guarantee that it is not suspended. No autosuspend will |
1220 | * occur until usb_autosuspend_device is called. (Note that this will not | |
1221 | * prevent suspend events originating in the PM core.) Examples would be | |
1222 | * when @udev's device file in usbfs is opened or when a remote-wakeup | |
1223 | * request is received. | |
645daaab | 1224 | * |
94fcda1f AS |
1225 | * @udev's usage counter is incremented to prevent subsequent autosuspends. |
1226 | * However if the autoresume fails then the usage counter is re-decremented. | |
645daaab AS |
1227 | * |
1228 | * Often the caller will hold @udev's device lock, but this is not | |
1229 | * necessary (and attempting it might cause deadlock). | |
1230 | * | |
1231 | * This routine can run only in process context. | |
1232 | */ | |
94fcda1f | 1233 | int usb_autoresume_device(struct usb_device *udev) |
645daaab AS |
1234 | { |
1235 | int status; | |
1236 | ||
94fcda1f | 1237 | status = usb_autopm_do_device(udev, 1); |
645daaab AS |
1238 | // dev_dbg(&udev->dev, "%s: status %d cnt %d\n", |
1239 | // __FUNCTION__, status, udev->pm_usage_cnt); | |
1240 | return status; | |
1241 | } | |
1242 | ||
af4f7606 AS |
1243 | /* Internal routine to adjust an interface's usage counter and change |
1244 | * its device's autosuspend state. | |
1245 | */ | |
1246 | static int usb_autopm_do_interface(struct usb_interface *intf, | |
1247 | int inc_usage_cnt) | |
1248 | { | |
1249 | struct usb_device *udev = interface_to_usbdev(intf); | |
1250 | int status = 0; | |
1251 | ||
1252 | usb_pm_lock(udev); | |
1253 | if (intf->condition == USB_INTERFACE_UNBOUND) | |
1254 | status = -ENODEV; | |
1255 | else { | |
1256 | intf->pm_usage_cnt += inc_usage_cnt; | |
1257 | if (inc_usage_cnt >= 0 && intf->pm_usage_cnt > 0) { | |
1258 | udev->auto_pm = 1; | |
1259 | status = usb_resume_both(udev); | |
1260 | if (status != 0) | |
1261 | intf->pm_usage_cnt -= inc_usage_cnt; | |
1262 | } else if (inc_usage_cnt <= 0 && autosuspend_check(udev) == 0) | |
1263 | queue_delayed_work(ksuspend_usb_wq, &udev->autosuspend, | |
1264 | USB_AUTOSUSPEND_DELAY); | |
1265 | } | |
1266 | usb_pm_unlock(udev); | |
1267 | return status; | |
1268 | } | |
1269 | ||
645daaab AS |
1270 | /** |
1271 | * usb_autopm_put_interface - decrement a USB interface's PM-usage counter | |
701f35af | 1272 | * @intf: the usb_interface whose counter should be decremented |
645daaab AS |
1273 | * |
1274 | * This routine should be called by an interface driver when it is | |
1275 | * finished using @intf and wants to allow it to autosuspend. A typical | |
1276 | * example would be a character-device driver when its device file is | |
1277 | * closed. | |
1278 | * | |
1279 | * The routine decrements @intf's usage counter. When the counter reaches | |
1280 | * 0, a delayed autosuspend request for @intf's device is queued. When | |
1281 | * the delay expires, if @intf->pm_usage_cnt is still <= 0 along with all | |
1282 | * the other usage counters for the sibling interfaces and @intf's | |
1283 | * usb_device, the device and all its interfaces will be autosuspended. | |
1284 | * | |
1285 | * Note that @intf->pm_usage_cnt is owned by the interface driver. The | |
1286 | * core will not change its value other than the increment and decrement | |
1287 | * in usb_autopm_get_interface and usb_autopm_put_interface. The driver | |
1288 | * may use this simple counter-oriented discipline or may set the value | |
1289 | * any way it likes. | |
1290 | * | |
1291 | * If the driver has set @intf->needs_remote_wakeup then autosuspend will | |
1292 | * take place only if the device's remote-wakeup facility is enabled. | |
1293 | * | |
1294 | * Suspend method calls queued by this routine can arrive at any time | |
1295 | * while @intf is resumed and its usage counter is equal to 0. They are | |
1296 | * not protected by the usb_device's lock but only by its pm_mutex. | |
1297 | * Drivers must provide their own synchronization. | |
1298 | * | |
1299 | * This routine can run only in process context. | |
1300 | */ | |
1301 | void usb_autopm_put_interface(struct usb_interface *intf) | |
1302 | { | |
af4f7606 | 1303 | int status; |
645daaab | 1304 | |
af4f7606 AS |
1305 | status = usb_autopm_do_interface(intf, -1); |
1306 | // dev_dbg(&intf->dev, "%s: status %d cnt %d\n", | |
1307 | // __FUNCTION__, status, intf->pm_usage_cnt); | |
645daaab AS |
1308 | } |
1309 | EXPORT_SYMBOL_GPL(usb_autopm_put_interface); | |
1310 | ||
1311 | /** | |
1312 | * usb_autopm_get_interface - increment a USB interface's PM-usage counter | |
701f35af | 1313 | * @intf: the usb_interface whose counter should be incremented |
645daaab AS |
1314 | * |
1315 | * This routine should be called by an interface driver when it wants to | |
1316 | * use @intf and needs to guarantee that it is not suspended. In addition, | |
1317 | * the routine prevents @intf from being autosuspended subsequently. (Note | |
1318 | * that this will not prevent suspend events originating in the PM core.) | |
1319 | * This prevention will persist until usb_autopm_put_interface() is called | |
1320 | * or @intf is unbound. A typical example would be a character-device | |
1321 | * driver when its device file is opened. | |
1322 | * | |
1323 | * The routine increments @intf's usage counter. So long as the counter | |
1324 | * is greater than 0, autosuspend will not be allowed for @intf or its | |
1325 | * usb_device. When the driver is finished using @intf it should call | |
1326 | * usb_autopm_put_interface() to decrement the usage counter and queue | |
1327 | * a delayed autosuspend request (if the counter is <= 0). | |
1328 | * | |
1329 | * Note that @intf->pm_usage_cnt is owned by the interface driver. The | |
1330 | * core will not change its value other than the increment and decrement | |
1331 | * in usb_autopm_get_interface and usb_autopm_put_interface. The driver | |
1332 | * may use this simple counter-oriented discipline or may set the value | |
1333 | * any way it likes. | |
1334 | * | |
1335 | * Resume method calls generated by this routine can arrive at any time | |
1336 | * while @intf is suspended. They are not protected by the usb_device's | |
1337 | * lock but only by its pm_mutex. Drivers must provide their own | |
1338 | * synchronization. | |
1339 | * | |
1340 | * This routine can run only in process context. | |
1341 | */ | |
1342 | int usb_autopm_get_interface(struct usb_interface *intf) | |
1343 | { | |
af4f7606 | 1344 | int status; |
645daaab | 1345 | |
af4f7606 | 1346 | status = usb_autopm_do_interface(intf, 1); |
645daaab AS |
1347 | // dev_dbg(&intf->dev, "%s: status %d cnt %d\n", |
1348 | // __FUNCTION__, status, intf->pm_usage_cnt); | |
a8e7c565 AS |
1349 | return status; |
1350 | } | |
645daaab AS |
1351 | EXPORT_SYMBOL_GPL(usb_autopm_get_interface); |
1352 | ||
692a186c AS |
1353 | /** |
1354 | * usb_autopm_set_interface - set a USB interface's autosuspend state | |
1355 | * @intf: the usb_interface whose state should be set | |
1356 | * | |
1357 | * This routine sets the autosuspend state of @intf's device according | |
1358 | * to @intf's usage counter, which the caller must have set previously. | |
1359 | * If the counter is <= 0, the device is autosuspended (if it isn't | |
1360 | * already suspended and if nothing else prevents the autosuspend). If | |
1361 | * the counter is > 0, the device is autoresumed (if it isn't already | |
1362 | * awake). | |
1363 | */ | |
1364 | int usb_autopm_set_interface(struct usb_interface *intf) | |
1365 | { | |
1366 | int status; | |
1367 | ||
1368 | status = usb_autopm_do_interface(intf, 0); | |
1369 | // dev_dbg(&intf->dev, "%s: status %d cnt %d\n", | |
1370 | // __FUNCTION__, status, intf->pm_usage_cnt); | |
1371 | return status; | |
1372 | } | |
1373 | EXPORT_SYMBOL_GPL(usb_autopm_set_interface); | |
1374 | ||
645daaab | 1375 | #endif /* CONFIG_USB_SUSPEND */ |
a8e7c565 | 1376 | |
1cc8a25d AS |
1377 | static int usb_suspend(struct device *dev, pm_message_t message) |
1378 | { | |
1379 | int status; | |
1380 | ||
645daaab AS |
1381 | if (is_usb_device(dev)) { |
1382 | struct usb_device *udev = to_usb_device(dev); | |
1383 | ||
e0318ebf | 1384 | usb_pm_lock(udev); |
645daaab AS |
1385 | udev->auto_pm = 0; |
1386 | status = usb_suspend_both(udev, message); | |
e0318ebf | 1387 | usb_pm_unlock(udev); |
645daaab | 1388 | } else |
a8e7c565 | 1389 | status = 0; |
1cc8a25d AS |
1390 | return status; |
1391 | } | |
1392 | ||
1393 | static int usb_resume(struct device *dev) | |
1394 | { | |
1395 | int status; | |
1396 | ||
a8e7c565 | 1397 | if (is_usb_device(dev)) { |
645daaab AS |
1398 | struct usb_device *udev = to_usb_device(dev); |
1399 | ||
e0318ebf | 1400 | usb_pm_lock(udev); |
645daaab AS |
1401 | udev->auto_pm = 0; |
1402 | status = usb_resume_both(udev); | |
e0318ebf | 1403 | usb_pm_unlock(udev); |
a8e7c565 AS |
1404 | |
1405 | /* Rebind drivers that had no suspend method? */ | |
1406 | } else | |
1407 | status = 0; | |
1cc8a25d AS |
1408 | return status; |
1409 | } | |
1410 | ||
36e56a34 AS |
1411 | #endif /* CONFIG_PM */ |
1412 | ||
1413 | struct bus_type usb_bus_type = { | |
1414 | .name = "usb", | |
1415 | .match = usb_device_match, | |
1416 | .uevent = usb_uevent, | |
1417 | #ifdef CONFIG_PM | |
782da727 AS |
1418 | .suspend = usb_suspend, |
1419 | .resume = usb_resume, | |
36e56a34 AS |
1420 | #endif |
1421 | }; |