blob: 60a45f1e3a67e13b41fd41770d51cbe83b39f730 [file] [log] [blame]
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -08001/*
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
Alan Stern36e56a32006-07-01 22:08:06 -040020 * matching, probing, releasing, suspending and resuming for
21 * real drivers.
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -080022 *
23 */
24
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -080025#include <linux/device.h>
26#include <linux/usb.h>
Alan Stern6bc6cff2007-05-04 11:53:03 -040027#include <linux/usb/quirks.h>
Alan Sternbd859282006-09-19 10:14:07 -040028#include <linux/workqueue.h>
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -080029#include "hcd.h"
30#include "usb.h"
31
Alan Stern20dfdad2007-05-22 11:50:17 -040032
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -080033#ifdef CONFIG_HOTPLUG
34
35/*
36 * Adds a new dynamic USBdevice ID to this driver,
37 * and cause the driver to probe for all devices again.
38 */
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +010039ssize_t usb_store_new_id(struct usb_dynids *dynids,
40 struct device_driver *driver,
41 const char *buf, size_t count)
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -080042{
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -080043 struct usb_dynid *dynid;
44 u32 idVendor = 0;
45 u32 idProduct = 0;
46 int fields = 0;
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -070047 int retval = 0;
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -080048
49 fields = sscanf(buf, "%x %x", &idVendor, &idProduct);
50 if (fields < 2)
51 return -EINVAL;
52
53 dynid = kzalloc(sizeof(*dynid), GFP_KERNEL);
54 if (!dynid)
55 return -ENOMEM;
56
57 INIT_LIST_HEAD(&dynid->node);
58 dynid->id.idVendor = idVendor;
59 dynid->id.idProduct = idProduct;
60 dynid->id.match_flags = USB_DEVICE_ID_MATCH_DEVICE;
61
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +010062 spin_lock(&dynids->lock);
Nathael Pajanie5dd0112007-09-04 11:46:23 +020063 list_add_tail(&dynid->node, &dynids->list);
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +010064 spin_unlock(&dynids->lock);
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -080065
66 if (get_driver(driver)) {
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -070067 retval = driver_attach(driver);
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -080068 put_driver(driver);
69 }
70
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -070071 if (retval)
72 return retval;
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -080073 return count;
74}
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +010075EXPORT_SYMBOL_GPL(usb_store_new_id);
76
77static ssize_t store_new_id(struct device_driver *driver,
78 const char *buf, size_t count)
79{
80 struct usb_driver *usb_drv = to_usb_driver(driver);
81
82 return usb_store_new_id(&usb_drv->dynids, driver, buf, count);
83}
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -080084static DRIVER_ATTR(new_id, S_IWUSR, NULL, store_new_id);
85
CHENG Renquan0c7a2b72009-11-22 01:28:52 +080086/**
87 * store_remove_id - remove a USB device ID from this driver
88 * @driver: target device driver
89 * @buf: buffer for scanning device ID data
90 * @count: input size
91 *
92 * Removes a dynamic usb device ID from this driver.
93 */
94static ssize_t
95store_remove_id(struct device_driver *driver, const char *buf, size_t count)
96{
97 struct usb_dynid *dynid, *n;
98 struct usb_driver *usb_driver = to_usb_driver(driver);
99 u32 idVendor = 0;
100 u32 idProduct = 0;
101 int fields = 0;
102 int retval = 0;
103
104 fields = sscanf(buf, "%x %x", &idVendor, &idProduct);
105 if (fields < 2)
106 return -EINVAL;
107
108 spin_lock(&usb_driver->dynids.lock);
109 list_for_each_entry_safe(dynid, n, &usb_driver->dynids.list, node) {
110 struct usb_device_id *id = &dynid->id;
111 if ((id->idVendor == idVendor) &&
112 (id->idProduct == idProduct)) {
113 list_del(&dynid->node);
114 kfree(dynid);
115 retval = 0;
116 break;
117 }
118 }
119 spin_unlock(&usb_driver->dynids.lock);
120
121 if (retval)
122 return retval;
123 return count;
124}
125static DRIVER_ATTR(remove_id, S_IWUSR, NULL, store_remove_id);
126
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800127static int usb_create_newid_file(struct usb_driver *usb_drv)
128{
129 int error = 0;
130
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -0800131 if (usb_drv->no_dynamic_id)
132 goto exit;
133
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800134 if (usb_drv->probe != NULL)
Greg Kroah-Hartman15147ff2007-11-28 12:23:18 -0800135 error = driver_create_file(&usb_drv->drvwrap.driver,
136 &driver_attr_new_id);
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -0800137exit:
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800138 return error;
139}
140
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -0800141static void usb_remove_newid_file(struct usb_driver *usb_drv)
142{
143 if (usb_drv->no_dynamic_id)
144 return;
145
146 if (usb_drv->probe != NULL)
Greg Kroah-Hartman15147ff2007-11-28 12:23:18 -0800147 driver_remove_file(&usb_drv->drvwrap.driver,
148 &driver_attr_new_id);
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -0800149}
150
CHENG Renquan0c7a2b72009-11-22 01:28:52 +0800151static int
152usb_create_removeid_file(struct usb_driver *drv)
153{
154 int error = 0;
155 if (drv->probe != NULL)
156 error = driver_create_file(&drv->drvwrap.driver,
157 &driver_attr_remove_id);
158 return error;
159}
160
161static void usb_remove_removeid_file(struct usb_driver *drv)
162{
163 driver_remove_file(&drv->drvwrap.driver, &driver_attr_remove_id);
164}
165
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800166static void usb_free_dynids(struct usb_driver *usb_drv)
167{
168 struct usb_dynid *dynid, *n;
169
170 spin_lock(&usb_drv->dynids.lock);
171 list_for_each_entry_safe(dynid, n, &usb_drv->dynids.list, node) {
172 list_del(&dynid->node);
173 kfree(dynid);
174 }
175 spin_unlock(&usb_drv->dynids.lock);
176}
177#else
178static inline int usb_create_newid_file(struct usb_driver *usb_drv)
179{
180 return 0;
181}
182
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -0800183static void usb_remove_newid_file(struct usb_driver *usb_drv)
184{
185}
186
CHENG Renquan0c7a2b72009-11-22 01:28:52 +0800187static int
188usb_create_removeid_file(struct usb_driver *drv)
189{
190 return 0;
191}
192
193static void usb_remove_removeid_file(struct usb_driver *drv)
194{
195}
196
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800197static inline void usb_free_dynids(struct usb_driver *usb_drv)
198{
199}
200#endif
201
202static const struct usb_device_id *usb_match_dynamic_id(struct usb_interface *intf,
203 struct usb_driver *drv)
204{
205 struct usb_dynid *dynid;
206
207 spin_lock(&drv->dynids.lock);
208 list_for_each_entry(dynid, &drv->dynids.list, node) {
209 if (usb_match_one_id(intf, &dynid->id)) {
210 spin_unlock(&drv->dynids.lock);
211 return &dynid->id;
212 }
213 }
214 spin_unlock(&drv->dynids.lock);
215 return NULL;
216}
217
218
Alan Stern8bb54ab2006-07-01 22:08:49 -0400219/* called from driver core with dev locked */
220static int usb_probe_device(struct device *dev)
221{
222 struct usb_device_driver *udriver = to_usb_device_driver(dev->driver);
Kay Sievers55129662009-05-04 19:48:32 +0200223 struct usb_device *udev = to_usb_device(dev);
Alan Stern8bb54ab2006-07-01 22:08:49 -0400224 int error = -ENODEV;
225
Harvey Harrison441b62c2008-03-03 16:08:34 -0800226 dev_dbg(dev, "%s\n", __func__);
Alan Stern8bb54ab2006-07-01 22:08:49 -0400227
Alan Stern8bb54ab2006-07-01 22:08:49 -0400228 /* TODO: Add real matching code */
229
Alan Stern645daaa2006-08-30 15:47:02 -0400230 /* The device should always appear to be in use
231 * unless the driver suports autosuspend.
232 */
233 udev->pm_usage_cnt = !(udriver->supports_autosuspend);
234
Alan Stern8bb54ab2006-07-01 22:08:49 -0400235 error = udriver->probe(udev);
236 return error;
237}
238
239/* called from driver core with dev locked */
240static int usb_unbind_device(struct device *dev)
241{
242 struct usb_device_driver *udriver = to_usb_device_driver(dev->driver);
243
244 udriver->disconnect(to_usb_device(dev));
245 return 0;
246}
247
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -0800248/*
249 * Cancel any pending scheduled resets
250 *
251 * [see usb_queue_reset_device()]
252 *
253 * Called after unconfiguring / when releasing interfaces. See
254 * comments in __usb_queue_reset_device() regarding
255 * udev->reset_running.
256 */
257static void usb_cancel_queued_reset(struct usb_interface *iface)
258{
259 if (iface->reset_running == 0)
260 cancel_work_sync(&iface->reset_ws);
261}
Alan Stern8bb54ab2006-07-01 22:08:49 -0400262
263/* called from driver core with dev locked */
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800264static int usb_probe_interface(struct device *dev)
265{
Alan Stern8bb54ab2006-07-01 22:08:49 -0400266 struct usb_driver *driver = to_usb_driver(dev->driver);
Kay Sievers55129662009-05-04 19:48:32 +0200267 struct usb_interface *intf = to_usb_interface(dev);
268 struct usb_device *udev = interface_to_usbdev(intf);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800269 const struct usb_device_id *id;
270 int error = -ENODEV;
271
Harvey Harrison441b62c2008-03-03 16:08:34 -0800272 dev_dbg(dev, "%s\n", __func__);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800273
Alan Stern78d9a482008-06-23 16:00:40 -0400274 intf->needs_binding = 0;
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800275
Alan Stern7cbe5dc2009-06-29 10:56:54 -0400276 if (usb_device_is_owned(udev))
277 return -ENODEV;
278
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800279 if (udev->authorized == 0) {
280 dev_err(&intf->dev, "Device is not authorized for usage\n");
281 return -ENODEV;
282 }
Inaky Perez-Gonzalez72230ab2007-07-31 20:34:03 -0700283
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800284 id = usb_match_id(intf, driver->id_table);
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800285 if (!id)
286 id = usb_match_dynamic_id(intf, driver);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800287 if (id) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800288 dev_dbg(dev, "%s - got id\n", __func__);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800289
Alan Stern94fcda12006-11-20 11:38:46 -0500290 error = usb_autoresume_device(udev);
Alan Stern645daaa2006-08-30 15:47:02 -0400291 if (error)
292 return error;
293
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800294 /* Interface "power state" doesn't correspond to any hardware
295 * state whatsoever. We use it to record when it's bound to
296 * a driver that may start I/0: it's not frozen/quiesced.
297 */
298 mark_active(intf);
299 intf->condition = USB_INTERFACE_BINDING;
Alan Stern645daaa2006-08-30 15:47:02 -0400300
301 /* The interface should always appear to be in use
302 * unless the driver suports autosuspend.
303 */
Alan Sternccf5b802009-06-29 11:00:01 -0400304 atomic_set(&intf->pm_usage_cnt, !driver->supports_autosuspend);
Alan Stern645daaa2006-08-30 15:47:02 -0400305
Alan Stern55151d72008-08-12 14:33:59 -0400306 /* Carry out a deferred switch to altsetting 0 */
307 if (intf->needs_altsetting0) {
Oliver Neukum1e5ea5e2009-08-27 16:46:56 +0200308 error = usb_set_interface(udev, intf->altsetting[0].
Alan Stern55151d72008-08-12 14:33:59 -0400309 desc.bInterfaceNumber, 0);
Oliver Neukum1e5ea5e2009-08-27 16:46:56 +0200310 if (error < 0)
311 goto err;
312
Alan Stern55151d72008-08-12 14:33:59 -0400313 intf->needs_altsetting0 = 0;
314 }
315
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800316 error = driver->probe(intf, id);
Oliver Neukum1e5ea5e2009-08-27 16:46:56 +0200317 if (error)
318 goto err;
Alan Stern645daaa2006-08-30 15:47:02 -0400319
Oliver Neukum1e5ea5e2009-08-27 16:46:56 +0200320 intf->condition = USB_INTERFACE_BOUND;
Alan Stern94fcda12006-11-20 11:38:46 -0500321 usb_autosuspend_device(udev);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800322 }
323
324 return error;
Oliver Neukum1e5ea5e2009-08-27 16:46:56 +0200325
326err:
327 mark_quiesced(intf);
328 intf->needs_remote_wakeup = 0;
329 intf->condition = USB_INTERFACE_UNBOUND;
330 usb_cancel_queued_reset(intf);
331 usb_autosuspend_device(udev);
332 return error;
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800333}
334
Alan Stern8bb54ab2006-07-01 22:08:49 -0400335/* called from driver core with dev locked */
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800336static int usb_unbind_interface(struct device *dev)
337{
Alan Stern8bb54ab2006-07-01 22:08:49 -0400338 struct usb_driver *driver = to_usb_driver(dev->driver);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800339 struct usb_interface *intf = to_usb_interface(dev);
Alan Stern645daaa2006-08-30 15:47:02 -0400340 struct usb_device *udev;
Oliver Neukum1e5ea5e2009-08-27 16:46:56 +0200341 int error, r;
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800342
343 intf->condition = USB_INTERFACE_UNBINDING;
344
Alan Stern645daaa2006-08-30 15:47:02 -0400345 /* Autoresume for set_interface call below */
346 udev = interface_to_usbdev(intf);
Alan Stern94fcda12006-11-20 11:38:46 -0500347 error = usb_autoresume_device(udev);
Alan Stern645daaa2006-08-30 15:47:02 -0400348
Alan Stern9da82bd2008-05-08 11:54:37 -0400349 /* Terminate all URBs for this interface unless the driver
350 * supports "soft" unbinding.
351 */
352 if (!driver->soft_unbind)
Alan Sternddeac4e2009-01-15 17:03:33 -0500353 usb_disable_interface(udev, intf, false);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800354
Alan Stern8bb54ab2006-07-01 22:08:49 -0400355 driver->disconnect(intf);
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -0800356 usb_cancel_queued_reset(intf);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800357
Alan Stern55151d72008-08-12 14:33:59 -0400358 /* Reset other interface state.
359 * We cannot do a Set-Interface if the device is suspended or
360 * if it is prepared for a system sleep (since installing a new
361 * altsetting means creating new endpoint device entries).
362 * When either of these happens, defer the Set-Interface.
363 */
Alan Stern2caf7fc2008-12-31 11:31:33 -0500364 if (intf->cur_altsetting->desc.bAlternateSetting == 0) {
365 /* Already in altsetting 0 so skip Set-Interface.
366 * Just re-enable it without affecting the endpoint toggles.
367 */
368 usb_enable_interface(udev, intf, false);
Oliver Neukum1e5ea5e2009-08-27 16:46:56 +0200369 } else if (!error && intf->dev.power.status == DPM_ON) {
370 r = usb_set_interface(udev, intf->altsetting[0].
Alan Stern55151d72008-08-12 14:33:59 -0400371 desc.bInterfaceNumber, 0);
Oliver Neukum1e5ea5e2009-08-27 16:46:56 +0200372 if (r < 0)
373 intf->needs_altsetting0 = 1;
374 } else {
Alan Stern55151d72008-08-12 14:33:59 -0400375 intf->needs_altsetting0 = 1;
Oliver Neukum1e5ea5e2009-08-27 16:46:56 +0200376 }
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800377 usb_set_intfdata(intf, NULL);
Alan Stern645daaa2006-08-30 15:47:02 -0400378
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800379 intf->condition = USB_INTERFACE_UNBOUND;
380 mark_quiesced(intf);
Alan Stern645daaa2006-08-30 15:47:02 -0400381 intf->needs_remote_wakeup = 0;
382
383 if (!error)
Alan Stern94fcda12006-11-20 11:38:46 -0500384 usb_autosuspend_device(udev);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800385
386 return 0;
387}
388
Alan Stern36e56a32006-07-01 22:08:06 -0400389/**
390 * usb_driver_claim_interface - bind a driver to an interface
391 * @driver: the driver to be bound
392 * @iface: the interface to which it will be bound; must be in the
393 * usb device's active configuration
394 * @priv: driver data associated with that interface
395 *
396 * This is used by usb device drivers that need to claim more than one
397 * interface on a device when probing (audio and acm are current examples).
398 * No device driver should directly modify internal usb_interface or
399 * usb_device structure members.
400 *
401 * Few drivers should need to use this routine, since the most natural
402 * way to bind to an interface is to return the private data from
403 * the driver's probe() method.
404 *
Greg Kroah-Hartman341487a2007-04-09 11:52:31 -0400405 * Callers must own the device lock, so driver probe() entries don't need
406 * extra locking, but other call contexts may need to explicitly claim that
407 * lock.
Alan Stern36e56a32006-07-01 22:08:06 -0400408 */
409int usb_driver_claim_interface(struct usb_driver *driver,
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800410 struct usb_interface *iface, void *priv)
Alan Stern36e56a32006-07-01 22:08:06 -0400411{
412 struct device *dev = &iface->dev;
Alan Stern645daaa2006-08-30 15:47:02 -0400413 struct usb_device *udev = interface_to_usbdev(iface);
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700414 int retval = 0;
Alan Stern36e56a32006-07-01 22:08:06 -0400415
416 if (dev->driver)
417 return -EBUSY;
418
Alan Stern8bb54ab2006-07-01 22:08:49 -0400419 dev->driver = &driver->drvwrap.driver;
Alan Stern36e56a32006-07-01 22:08:06 -0400420 usb_set_intfdata(iface, priv);
Alan Stern78d9a482008-06-23 16:00:40 -0400421 iface->needs_binding = 0;
Alan Stern645daaa2006-08-30 15:47:02 -0400422
Alan Sterne0318eb2006-09-26 14:50:20 -0400423 usb_pm_lock(udev);
Alan Stern36e56a32006-07-01 22:08:06 -0400424 iface->condition = USB_INTERFACE_BOUND;
425 mark_active(iface);
Alan Sternccf5b802009-06-29 11:00:01 -0400426 atomic_set(&iface->pm_usage_cnt, !driver->supports_autosuspend);
Alan Sterne0318eb2006-09-26 14:50:20 -0400427 usb_pm_unlock(udev);
Alan Stern36e56a32006-07-01 22:08:06 -0400428
429 /* if interface was already added, bind now; else let
430 * the future device_add() bind it, bypassing probe()
431 */
432 if (device_is_registered(dev))
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700433 retval = device_bind_driver(dev);
Alan Stern36e56a32006-07-01 22:08:06 -0400434
Greg Kroah-Hartman1b21d5e2006-08-28 11:43:25 -0700435 return retval;
Alan Stern36e56a32006-07-01 22:08:06 -0400436}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600437EXPORT_SYMBOL_GPL(usb_driver_claim_interface);
Alan Stern36e56a32006-07-01 22:08:06 -0400438
439/**
440 * usb_driver_release_interface - unbind a driver from an interface
441 * @driver: the driver to be unbound
442 * @iface: the interface from which it will be unbound
443 *
444 * This can be used by drivers to release an interface without waiting
445 * for their disconnect() methods to be called. In typical cases this
446 * also causes the driver disconnect() method to be called.
447 *
448 * This call is synchronous, and may not be used in an interrupt context.
Greg Kroah-Hartman341487a2007-04-09 11:52:31 -0400449 * Callers must own the device lock, so driver disconnect() entries don't
450 * need extra locking, but other call contexts may need to explicitly claim
451 * that lock.
Alan Stern36e56a32006-07-01 22:08:06 -0400452 */
453void usb_driver_release_interface(struct usb_driver *driver,
454 struct usb_interface *iface)
455{
456 struct device *dev = &iface->dev;
457
458 /* this should never happen, don't release something that's not ours */
Alan Stern8bb54ab2006-07-01 22:08:49 -0400459 if (!dev->driver || dev->driver != &driver->drvwrap.driver)
Alan Stern36e56a32006-07-01 22:08:06 -0400460 return;
461
462 /* don't release from within disconnect() */
463 if (iface->condition != USB_INTERFACE_BOUND)
464 return;
Alan Stern91f8d062009-04-16 15:35:09 -0400465 iface->condition = USB_INTERFACE_UNBINDING;
Alan Stern36e56a32006-07-01 22:08:06 -0400466
Alan Stern91f8d062009-04-16 15:35:09 -0400467 /* Release via the driver core only if the interface
468 * has already been registered
469 */
Alan Stern36e56a32006-07-01 22:08:06 -0400470 if (device_is_registered(dev)) {
Alan Stern36e56a32006-07-01 22:08:06 -0400471 device_release_driver(dev);
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -0800472 } else {
Alan Stern91f8d062009-04-16 15:35:09 -0400473 down(&dev->sem);
474 usb_unbind_interface(dev);
475 dev->driver = NULL;
476 up(&dev->sem);
Alan Stern36e56a32006-07-01 22:08:06 -0400477 }
Alan Stern36e56a32006-07-01 22:08:06 -0400478}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600479EXPORT_SYMBOL_GPL(usb_driver_release_interface);
Alan Stern36e56a32006-07-01 22:08:06 -0400480
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800481/* returns 0 if no match, 1 if match */
Greg Kroah-Hartmanbb417022007-01-26 14:26:21 +0100482int usb_match_device(struct usb_device *dev, const struct usb_device_id *id)
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800483{
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800484 if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
485 id->idVendor != le16_to_cpu(dev->descriptor.idVendor))
486 return 0;
487
488 if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) &&
489 id->idProduct != le16_to_cpu(dev->descriptor.idProduct))
490 return 0;
491
492 /* No need to test id->bcdDevice_lo != 0, since 0 is never
493 greater than any unsigned number. */
494 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO) &&
495 (id->bcdDevice_lo > le16_to_cpu(dev->descriptor.bcdDevice)))
496 return 0;
497
498 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) &&
499 (id->bcdDevice_hi < le16_to_cpu(dev->descriptor.bcdDevice)))
500 return 0;
501
502 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) &&
503 (id->bDeviceClass != dev->descriptor.bDeviceClass))
504 return 0;
505
506 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) &&
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800507 (id->bDeviceSubClass != dev->descriptor.bDeviceSubClass))
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800508 return 0;
509
510 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) &&
511 (id->bDeviceProtocol != dev->descriptor.bDeviceProtocol))
512 return 0;
513
Greg Kroah-Hartmanbb417022007-01-26 14:26:21 +0100514 return 1;
515}
516
517/* returns 0 if no match, 1 if match */
518int usb_match_one_id(struct usb_interface *interface,
519 const struct usb_device_id *id)
520{
521 struct usb_host_interface *intf;
522 struct usb_device *dev;
523
524 /* proc_connectinfo in devio.c may call us with id == NULL. */
525 if (id == NULL)
526 return 0;
527
528 intf = interface->cur_altsetting;
529 dev = interface_to_usbdev(interface);
530
531 if (!usb_match_device(dev, id))
532 return 0;
533
Alan Stern93c8bf42006-10-18 16:41:51 -0400534 /* The interface class, subclass, and protocol should never be
535 * checked for a match if the device class is Vendor Specific,
536 * unless the match record specifies the Vendor ID. */
537 if (dev->descriptor.bDeviceClass == USB_CLASS_VENDOR_SPEC &&
538 !(id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
539 (id->match_flags & (USB_DEVICE_ID_MATCH_INT_CLASS |
540 USB_DEVICE_ID_MATCH_INT_SUBCLASS |
541 USB_DEVICE_ID_MATCH_INT_PROTOCOL)))
542 return 0;
543
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800544 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) &&
545 (id->bInterfaceClass != intf->desc.bInterfaceClass))
546 return 0;
547
548 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) &&
549 (id->bInterfaceSubClass != intf->desc.bInterfaceSubClass))
550 return 0;
551
552 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) &&
553 (id->bInterfaceProtocol != intf->desc.bInterfaceProtocol))
554 return 0;
555
556 return 1;
557}
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +0100558EXPORT_SYMBOL_GPL(usb_match_one_id);
559
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800560/**
561 * usb_match_id - find first usb_device_id matching device or interface
562 * @interface: the interface of interest
563 * @id: array of usb_device_id structures, terminated by zero entry
564 *
565 * usb_match_id searches an array of usb_device_id's and returns
566 * the first one matching the device or interface, or null.
567 * This is used when binding (or rebinding) a driver to an interface.
568 * Most USB device drivers will use this indirectly, through the usb core,
569 * but some layered driver frameworks use it directly.
570 * These device tables are exported with MODULE_DEVICE_TABLE, through
571 * modutils, to support the driver loading functionality of USB hotplugging.
572 *
573 * What Matches:
574 *
575 * The "match_flags" element in a usb_device_id controls which
576 * members are used. If the corresponding bit is set, the
577 * value in the device_id must match its corresponding member
578 * in the device or interface descriptor, or else the device_id
579 * does not match.
580 *
581 * "driver_info" is normally used only by device drivers,
582 * but you can create a wildcard "matches anything" usb_device_id
583 * as a driver's "modules.usbmap" entry if you provide an id with
584 * only a nonzero "driver_info" field. If you do this, the USB device
585 * driver's probe() routine should use additional intelligence to
586 * decide whether to bind to the specified interface.
587 *
588 * What Makes Good usb_device_id Tables:
589 *
590 * The match algorithm is very simple, so that intelligence in
591 * driver selection must come from smart driver id records.
592 * Unless you have good reasons to use another selection policy,
593 * provide match elements only in related groups, and order match
594 * specifiers from specific to general. Use the macros provided
595 * for that purpose if you can.
596 *
597 * The most specific match specifiers use device descriptor
598 * data. These are commonly used with product-specific matches;
599 * the USB_DEVICE macro lets you provide vendor and product IDs,
600 * and you can also match against ranges of product revisions.
601 * These are widely used for devices with application or vendor
602 * specific bDeviceClass values.
603 *
604 * Matches based on device class/subclass/protocol specifications
605 * are slightly more general; use the USB_DEVICE_INFO macro, or
606 * its siblings. These are used with single-function devices
607 * where bDeviceClass doesn't specify that each interface has
608 * its own class.
609 *
610 * Matches based on interface class/subclass/protocol are the
611 * most general; they let drivers bind to any interface on a
612 * multiple-function device. Use the USB_INTERFACE_INFO
613 * macro, or its siblings, to match class-per-interface style
Alan Stern93c8bf42006-10-18 16:41:51 -0400614 * devices (as recorded in bInterfaceClass).
615 *
616 * Note that an entry created by USB_INTERFACE_INFO won't match
617 * any interface if the device class is set to Vendor-Specific.
618 * This is deliberate; according to the USB spec the meanings of
619 * the interface class/subclass/protocol for these devices are also
620 * vendor-specific, and hence matching against a standard product
621 * class wouldn't work anyway. If you really want to use an
622 * interface-based match for such a device, create a match record
623 * that also specifies the vendor ID. (Unforunately there isn't a
624 * standard macro for creating records like this.)
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800625 *
626 * Within those groups, remember that not all combinations are
627 * meaningful. For example, don't give a product version range
628 * without vendor and product IDs; or specify a protocol without
629 * its associated class and subclass.
630 */
631const struct usb_device_id *usb_match_id(struct usb_interface *interface,
632 const struct usb_device_id *id)
633{
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800634 /* proc_connectinfo in devio.c may call us with id == NULL. */
635 if (id == NULL)
636 return NULL;
637
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800638 /* It is important to check that id->driver_info is nonzero,
639 since an entry that is all zeroes except for a nonzero
640 id->driver_info is the way to create an entry that
641 indicates that the driver want to examine every
642 device and interface. */
Greg Kroah-Hartmande6f92b2008-01-28 09:50:12 -0800643 for (; id->idVendor || id->idProduct || id->bDeviceClass ||
644 id->bInterfaceClass || id->driver_info; id++) {
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800645 if (usb_match_one_id(interface, id))
646 return id;
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800647 }
648
649 return NULL;
650}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600651EXPORT_SYMBOL_GPL(usb_match_id);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800652
Adrian Bunk8bb22d22006-11-21 22:02:54 +0100653static int usb_device_match(struct device *dev, struct device_driver *drv)
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800654{
Alan Stern8bb54ab2006-07-01 22:08:49 -0400655 /* devices and interfaces are handled separately */
656 if (is_usb_device(dev)) {
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800657
Alan Stern8bb54ab2006-07-01 22:08:49 -0400658 /* interface drivers never match devices */
659 if (!is_usb_device_driver(drv))
660 return 0;
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800661
Alan Stern8bb54ab2006-07-01 22:08:49 -0400662 /* TODO: Add real matching code */
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800663 return 1;
664
Kay Sievers55129662009-05-04 19:48:32 +0200665 } else if (is_usb_interface(dev)) {
Alan Stern8bb54ab2006-07-01 22:08:49 -0400666 struct usb_interface *intf;
667 struct usb_driver *usb_drv;
668 const struct usb_device_id *id;
669
670 /* device drivers never match interfaces */
671 if (is_usb_device_driver(drv))
672 return 0;
673
674 intf = to_usb_interface(dev);
675 usb_drv = to_usb_driver(drv);
676
677 id = usb_match_id(intf, usb_drv->id_table);
678 if (id)
679 return 1;
680
681 id = usb_match_dynamic_id(intf, usb_drv);
682 if (id)
683 return 1;
684 }
685
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800686 return 0;
687}
688
Alan Stern36e56a32006-07-01 22:08:06 -0400689#ifdef CONFIG_HOTPLUG
Kay Sievers7eff2e72007-08-14 15:15:12 +0200690static int usb_uevent(struct device *dev, struct kobj_uevent_env *env)
Alan Stern36e56a32006-07-01 22:08:06 -0400691{
Alan Stern36e56a32006-07-01 22:08:06 -0400692 struct usb_device *usb_dev;
Alan Stern36e56a32006-07-01 22:08:06 -0400693
Alan Stern36e56a32006-07-01 22:08:06 -0400694 /* driver is often null here; dev_dbg() would oops */
Kay Sievers7071a3c2008-05-02 06:02:41 +0200695 pr_debug("usb %s: uevent\n", dev_name(dev));
Alan Stern36e56a32006-07-01 22:08:06 -0400696
Kay Sievers55129662009-05-04 19:48:32 +0200697 if (is_usb_device(dev)) {
Alan Stern782da722006-07-01 22:09:35 -0400698 usb_dev = to_usb_device(dev);
Kay Sievers55129662009-05-04 19:48:32 +0200699 } else if (is_usb_interface(dev)) {
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100700 struct usb_interface *intf = to_usb_interface(dev);
Kay Sievers55129662009-05-04 19:48:32 +0200701
Alan Stern8bb54ab2006-07-01 22:08:49 -0400702 usb_dev = interface_to_usbdev(intf);
Kay Sievers55129662009-05-04 19:48:32 +0200703 } else {
704 return 0;
Alan Stern8bb54ab2006-07-01 22:08:49 -0400705 }
Alan Stern36e56a32006-07-01 22:08:06 -0400706
707 if (usb_dev->devnum < 0) {
Kay Sievers7071a3c2008-05-02 06:02:41 +0200708 pr_debug("usb %s: already deleted?\n", dev_name(dev));
Alan Stern36e56a32006-07-01 22:08:06 -0400709 return -ENODEV;
710 }
711 if (!usb_dev->bus) {
Kay Sievers7071a3c2008-05-02 06:02:41 +0200712 pr_debug("usb %s: bus removed?\n", dev_name(dev));
Alan Stern36e56a32006-07-01 22:08:06 -0400713 return -ENODEV;
714 }
715
716#ifdef CONFIG_USB_DEVICEFS
717 /* If this is available, userspace programs can directly read
718 * all the device descriptors we don't tell them about. Or
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100719 * act as usermode drivers.
Alan Stern36e56a32006-07-01 22:08:06 -0400720 */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200721 if (add_uevent_var(env, "DEVICE=/proc/bus/usb/%03d/%03d",
Alan Stern36e56a32006-07-01 22:08:06 -0400722 usb_dev->bus->busnum, usb_dev->devnum))
723 return -ENOMEM;
724#endif
725
726 /* per-device configurations are common */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200727 if (add_uevent_var(env, "PRODUCT=%x/%x/%x",
Alan Stern36e56a32006-07-01 22:08:06 -0400728 le16_to_cpu(usb_dev->descriptor.idVendor),
729 le16_to_cpu(usb_dev->descriptor.idProduct),
730 le16_to_cpu(usb_dev->descriptor.bcdDevice)))
731 return -ENOMEM;
732
733 /* class-based driver binding models */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200734 if (add_uevent_var(env, "TYPE=%d/%d/%d",
Alan Stern36e56a32006-07-01 22:08:06 -0400735 usb_dev->descriptor.bDeviceClass,
736 usb_dev->descriptor.bDeviceSubClass,
737 usb_dev->descriptor.bDeviceProtocol))
738 return -ENOMEM;
739
Alan Stern36e56a32006-07-01 22:08:06 -0400740 return 0;
741}
742
743#else
744
Kay Sievers7eff2e72007-08-14 15:15:12 +0200745static int usb_uevent(struct device *dev, struct kobj_uevent_env *env)
Alan Stern36e56a32006-07-01 22:08:06 -0400746{
747 return -ENODEV;
748}
Alan Stern36e56a32006-07-01 22:08:06 -0400749#endif /* CONFIG_HOTPLUG */
750
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800751/**
Alan Stern8bb54ab2006-07-01 22:08:49 -0400752 * usb_register_device_driver - register a USB device (not interface) driver
753 * @new_udriver: USB operations for the device driver
Greg Kroah-Hartman2143acc2005-11-21 14:53:03 -0800754 * @owner: module owner of this driver.
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800755 *
Alan Stern8bb54ab2006-07-01 22:08:49 -0400756 * Registers a USB device driver with the USB core. The list of
757 * unattached devices will be rescanned whenever a new driver is
758 * added, allowing the new driver to attach to any recognized devices.
759 * Returns a negative error code on failure and 0 on success.
760 */
761int usb_register_device_driver(struct usb_device_driver *new_udriver,
762 struct module *owner)
763{
764 int retval = 0;
765
766 if (usb_disabled())
767 return -ENODEV;
768
769 new_udriver->drvwrap.for_devices = 1;
770 new_udriver->drvwrap.driver.name = (char *) new_udriver->name;
771 new_udriver->drvwrap.driver.bus = &usb_bus_type;
772 new_udriver->drvwrap.driver.probe = usb_probe_device;
773 new_udriver->drvwrap.driver.remove = usb_unbind_device;
774 new_udriver->drvwrap.driver.owner = owner;
775
776 retval = driver_register(&new_udriver->drvwrap.driver);
777
778 if (!retval) {
779 pr_info("%s: registered new device driver %s\n",
780 usbcore_name, new_udriver->name);
781 usbfs_update_special();
782 } else {
783 printk(KERN_ERR "%s: error %d registering device "
784 " driver %s\n",
785 usbcore_name, retval, new_udriver->name);
786 }
787
788 return retval;
789}
790EXPORT_SYMBOL_GPL(usb_register_device_driver);
791
792/**
793 * usb_deregister_device_driver - unregister a USB device (not interface) driver
794 * @udriver: USB operations of the device driver to unregister
795 * Context: must be able to sleep
796 *
797 * Unlinks the specified driver from the internal USB driver list.
798 */
799void usb_deregister_device_driver(struct usb_device_driver *udriver)
800{
801 pr_info("%s: deregistering device driver %s\n",
802 usbcore_name, udriver->name);
803
804 driver_unregister(&udriver->drvwrap.driver);
805 usbfs_update_special();
806}
807EXPORT_SYMBOL_GPL(usb_deregister_device_driver);
808
809/**
810 * usb_register_driver - register a USB interface driver
811 * @new_driver: USB operations for the interface driver
812 * @owner: module owner of this driver.
Randy Dunlap892705a2007-02-10 14:41:41 -0800813 * @mod_name: module name string
Alan Stern8bb54ab2006-07-01 22:08:49 -0400814 *
815 * Registers a USB interface driver with the USB core. The list of
816 * unattached interfaces will be rescanned whenever a new driver is
817 * added, allowing the new driver to attach to any recognized interfaces.
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800818 * Returns a negative error code on failure and 0 on success.
819 *
820 * NOTE: if you want your driver to use the USB major number, you must call
821 * usb_register_dev() to enable that functionality. This function no longer
822 * takes care of that.
823 */
Greg Kroah-Hartman80f745f2007-01-15 11:50:02 -0800824int usb_register_driver(struct usb_driver *new_driver, struct module *owner,
825 const char *mod_name)
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800826{
827 int retval = 0;
828
829 if (usb_disabled())
830 return -ENODEV;
831
Alan Stern8bb54ab2006-07-01 22:08:49 -0400832 new_driver->drvwrap.for_devices = 0;
833 new_driver->drvwrap.driver.name = (char *) new_driver->name;
834 new_driver->drvwrap.driver.bus = &usb_bus_type;
835 new_driver->drvwrap.driver.probe = usb_probe_interface;
836 new_driver->drvwrap.driver.remove = usb_unbind_interface;
837 new_driver->drvwrap.driver.owner = owner;
Greg Kroah-Hartman80f745f2007-01-15 11:50:02 -0800838 new_driver->drvwrap.driver.mod_name = mod_name;
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800839 spin_lock_init(&new_driver->dynids.lock);
840 INIT_LIST_HEAD(&new_driver->dynids.list);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800841
Alan Stern8bb54ab2006-07-01 22:08:49 -0400842 retval = driver_register(&new_driver->drvwrap.driver);
CHENG Renquan0c7a2b72009-11-22 01:28:52 +0800843 if (retval)
844 goto out;
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800845
CHENG Renquan0c7a2b72009-11-22 01:28:52 +0800846 usbfs_update_special();
847
848 retval = usb_create_newid_file(new_driver);
849 if (retval)
850 goto out_newid;
851
852 retval = usb_create_removeid_file(new_driver);
853 if (retval)
854 goto out_removeid;
855
856 pr_info("%s: registered new interface driver %s\n",
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800857 usbcore_name, new_driver->name);
CHENG Renquan0c7a2b72009-11-22 01:28:52 +0800858
859out:
860 return retval;
861
862out_removeid:
863 usb_remove_newid_file(new_driver);
864out_newid:
865 driver_unregister(&new_driver->drvwrap.driver);
866
867 printk(KERN_ERR "%s: error %d registering interface "
Alan Stern8bb54ab2006-07-01 22:08:49 -0400868 " driver %s\n",
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800869 usbcore_name, retval, new_driver->name);
CHENG Renquan0c7a2b72009-11-22 01:28:52 +0800870 goto out;
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800871}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600872EXPORT_SYMBOL_GPL(usb_register_driver);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800873
874/**
Alan Stern8bb54ab2006-07-01 22:08:49 -0400875 * usb_deregister - unregister a USB interface driver
876 * @driver: USB operations of the interface driver to unregister
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800877 * Context: must be able to sleep
878 *
879 * Unlinks the specified driver from the internal USB driver list.
880 *
881 * NOTE: If you called usb_register_dev(), you still need to call
882 * usb_deregister_dev() to clean up your driver's allocated minor numbers,
883 * this * call will no longer do it for you.
884 */
885void usb_deregister(struct usb_driver *driver)
886{
Alan Stern8bb54ab2006-07-01 22:08:49 -0400887 pr_info("%s: deregistering interface driver %s\n",
888 usbcore_name, driver->name);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800889
CHENG Renquan0c7a2b72009-11-22 01:28:52 +0800890 usb_remove_removeid_file(driver);
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -0800891 usb_remove_newid_file(driver);
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800892 usb_free_dynids(driver);
Alan Stern8bb54ab2006-07-01 22:08:49 -0400893 driver_unregister(&driver->drvwrap.driver);
Greg Kroah-Hartmanddae41b2005-11-16 13:41:28 -0800894
895 usbfs_update_special();
896}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600897EXPORT_SYMBOL_GPL(usb_deregister);
Alan Stern36e56a32006-07-01 22:08:06 -0400898
Alan Stern78d9a482008-06-23 16:00:40 -0400899/* Forced unbinding of a USB interface driver, either because
900 * it doesn't support pre_reset/post_reset/reset_resume or
901 * because it doesn't support suspend/resume.
902 *
903 * The caller must hold @intf's device's lock, but not its pm_mutex
904 * and not @intf->dev.sem.
905 */
906void usb_forced_unbind_intf(struct usb_interface *intf)
907{
908 struct usb_driver *driver = to_usb_driver(intf->dev.driver);
909
910 dev_dbg(&intf->dev, "forced unbind\n");
911 usb_driver_release_interface(driver, intf);
912
913 /* Mark the interface for later rebinding */
914 intf->needs_binding = 1;
915}
916
917/* Delayed forced unbinding of a USB interface driver and scan
918 * for rebinding.
919 *
920 * The caller must hold @intf's device's lock, but not its pm_mutex
921 * and not @intf->dev.sem.
922 *
Alan Stern5096aed2008-08-12 14:34:14 -0400923 * Note: Rebinds will be skipped if a system sleep transition is in
924 * progress and the PM "complete" callback hasn't occurred yet.
Alan Stern78d9a482008-06-23 16:00:40 -0400925 */
926void usb_rebind_intf(struct usb_interface *intf)
927{
928 int rc;
929
930 /* Delayed unbind of an existing driver */
931 if (intf->dev.driver) {
932 struct usb_driver *driver =
933 to_usb_driver(intf->dev.driver);
934
935 dev_dbg(&intf->dev, "forced unbind\n");
936 usb_driver_release_interface(driver, intf);
937 }
938
939 /* Try to rebind the interface */
Alan Stern5096aed2008-08-12 14:34:14 -0400940 if (intf->dev.power.status == DPM_ON) {
941 intf->needs_binding = 0;
942 rc = device_attach(&intf->dev);
943 if (rc < 0)
944 dev_warn(&intf->dev, "rebind failed: %d\n", rc);
945 }
Alan Stern78d9a482008-06-23 16:00:40 -0400946}
947
Alan Stern9ff78432008-08-07 13:04:51 -0400948#ifdef CONFIG_PM
949
Alan Stern78d9a482008-06-23 16:00:40 -0400950#define DO_UNBIND 0
951#define DO_REBIND 1
952
953/* Unbind drivers for @udev's interfaces that don't support suspend/resume,
954 * or rebind interfaces that have been unbound, according to @action.
955 *
956 * The caller must hold @udev's device lock.
Alan Stern78d9a482008-06-23 16:00:40 -0400957 */
958static void do_unbind_rebind(struct usb_device *udev, int action)
959{
960 struct usb_host_config *config;
961 int i;
962 struct usb_interface *intf;
963 struct usb_driver *drv;
964
965 config = udev->actconfig;
966 if (config) {
967 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
968 intf = config->interface[i];
969 switch (action) {
970 case DO_UNBIND:
971 if (intf->dev.driver) {
972 drv = to_usb_driver(intf->dev.driver);
973 if (!drv->suspend || !drv->resume)
974 usb_forced_unbind_intf(intf);
975 }
976 break;
977 case DO_REBIND:
Alan Stern5096aed2008-08-12 14:34:14 -0400978 if (intf->needs_binding)
Alan Stern78d9a482008-06-23 16:00:40 -0400979 usb_rebind_intf(intf);
Alan Stern78d9a482008-06-23 16:00:40 -0400980 break;
981 }
982 }
983 }
984}
985
Alan Sterne0318eb2006-09-26 14:50:20 -0400986/* Caller has locked udev's pm_mutex */
Stephen Hemmingerd5ec1682006-11-14 10:06:17 -0800987static int usb_suspend_device(struct usb_device *udev, pm_message_t msg)
Alan Stern36e56a32006-07-01 22:08:06 -0400988{
Alan Stern782da722006-07-01 22:09:35 -0400989 struct usb_device_driver *udriver;
Alan Stern2bf40862006-07-01 22:12:19 -0400990 int status = 0;
Alan Stern36e56a32006-07-01 22:08:06 -0400991
Alan Stern114b3682006-07-01 22:13:04 -0400992 if (udev->state == USB_STATE_NOTATTACHED ||
993 udev->state == USB_STATE_SUSPENDED)
994 goto done;
995
Alan Sternb6f6436d2007-05-04 11:51:54 -0400996 /* For devices that don't have a driver, we do a generic suspend. */
997 if (udev->dev.driver)
998 udriver = to_usb_device_driver(udev->dev.driver);
999 else {
Alan Stern645daaa2006-08-30 15:47:02 -04001000 udev->do_remote_wakeup = 0;
Alan Sternb6f6436d2007-05-04 11:51:54 -04001001 udriver = &usb_generic_driver;
Alan Stern1c5df7e2006-07-01 22:13:50 -04001002 }
Alan Stern2bf40862006-07-01 22:12:19 -04001003 status = udriver->suspend(udev, msg);
1004
Alan Stern20dfdad2007-05-22 11:50:17 -04001005 done:
Harvey Harrison441b62c2008-03-03 16:08:34 -08001006 dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
Alan Stern2bf40862006-07-01 22:12:19 -04001007 return status;
Alan Stern1cc8a252006-07-01 22:10:15 -04001008}
Alan Stern36e56a32006-07-01 22:08:06 -04001009
Alan Sterne0318eb2006-09-26 14:50:20 -04001010/* Caller has locked udev's pm_mutex */
Alan Stern65bfd292008-11-25 16:39:18 -05001011static int usb_resume_device(struct usb_device *udev, pm_message_t msg)
Alan Stern1cc8a252006-07-01 22:10:15 -04001012{
1013 struct usb_device_driver *udriver;
Alan Stern2bf40862006-07-01 22:12:19 -04001014 int status = 0;
Alan Stern1cc8a252006-07-01 22:10:15 -04001015
Alan Stern0458d5b2007-05-04 11:52:20 -04001016 if (udev->state == USB_STATE_NOTATTACHED)
1017 goto done;
Alan Stern1cc8a252006-07-01 22:10:15 -04001018
Alan Stern1c5df7e2006-07-01 22:13:50 -04001019 /* Can't resume it if it doesn't have a driver. */
1020 if (udev->dev.driver == NULL) {
1021 status = -ENOTCONN;
Alan Stern2bf40862006-07-01 22:12:19 -04001022 goto done;
Alan Stern1c5df7e2006-07-01 22:13:50 -04001023 }
1024
Alan Stern6bc6cff2007-05-04 11:53:03 -04001025 if (udev->quirks & USB_QUIRK_RESET_RESUME)
1026 udev->reset_resume = 1;
1027
Alan Stern1cc8a252006-07-01 22:10:15 -04001028 udriver = to_usb_device_driver(udev->dev.driver);
Alan Stern65bfd292008-11-25 16:39:18 -05001029 status = udriver->resume(udev, msg);
Alan Stern2bf40862006-07-01 22:12:19 -04001030
Alan Stern20dfdad2007-05-22 11:50:17 -04001031 done:
Harvey Harrison441b62c2008-03-03 16:08:34 -08001032 dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
Alan Stern2bf40862006-07-01 22:12:19 -04001033 return status;
Alan Stern1cc8a252006-07-01 22:10:15 -04001034}
1035
Alan Sterne0318eb2006-09-26 14:50:20 -04001036/* Caller has locked intf's usb_device's pm mutex */
Alan Stern65605ae2008-08-12 14:33:27 -04001037static int usb_suspend_interface(struct usb_device *udev,
1038 struct usb_interface *intf, pm_message_t msg)
Alan Stern1cc8a252006-07-01 22:10:15 -04001039{
1040 struct usb_driver *driver;
Alan Stern2bf40862006-07-01 22:12:19 -04001041 int status = 0;
Alan Stern1cc8a252006-07-01 22:10:15 -04001042
Alan Stern114b3682006-07-01 22:13:04 -04001043 /* with no hardware, USB interfaces only use FREEZE and ON states */
Alan Stern65605ae2008-08-12 14:33:27 -04001044 if (udev->state == USB_STATE_NOTATTACHED || !is_active(intf))
Alan Stern114b3682006-07-01 22:13:04 -04001045 goto done;
1046
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -08001047 /* This can happen; see usb_driver_release_interface() */
1048 if (intf->condition == USB_INTERFACE_UNBOUND)
Alan Stern2bf40862006-07-01 22:12:19 -04001049 goto done;
Alan Stern1cc8a252006-07-01 22:10:15 -04001050 driver = to_usb_driver(intf->dev.driver);
Alan Stern36e56a32006-07-01 22:08:06 -04001051
Alan Stern78d9a482008-06-23 16:00:40 -04001052 if (driver->suspend) {
Alan Stern1cc8a252006-07-01 22:10:15 -04001053 status = driver->suspend(intf, msg);
Alan Stern645daaa2006-08-30 15:47:02 -04001054 if (status == 0)
1055 mark_quiesced(intf);
Alan Stern65bfd292008-11-25 16:39:18 -05001056 else if (!(msg.event & PM_EVENT_AUTO))
Alan Stern1cc8a252006-07-01 22:10:15 -04001057 dev_err(&intf->dev, "%s error %d\n",
1058 "suspend", status);
Alan Stern36e56a32006-07-01 22:08:06 -04001059 } else {
Alan Stern78d9a482008-06-23 16:00:40 -04001060 /* Later we will unbind the driver and reprobe */
1061 intf->needs_binding = 1;
1062 dev_warn(&intf->dev, "no %s for driver %s?\n",
1063 "suspend", driver->name);
Alan Stern36e56a32006-07-01 22:08:06 -04001064 mark_quiesced(intf);
Alan Stern36e56a32006-07-01 22:08:06 -04001065 }
Alan Stern2bf40862006-07-01 22:12:19 -04001066
Alan Stern20dfdad2007-05-22 11:50:17 -04001067 done:
Harvey Harrison441b62c2008-03-03 16:08:34 -08001068 dev_vdbg(&intf->dev, "%s: status %d\n", __func__, status);
Alan Stern36e56a32006-07-01 22:08:06 -04001069 return status;
1070}
1071
Alan Stern645daaa2006-08-30 15:47:02 -04001072/* Caller has locked intf's usb_device's pm_mutex */
Alan Stern65605ae2008-08-12 14:33:27 -04001073static int usb_resume_interface(struct usb_device *udev,
Alan Stern65bfd292008-11-25 16:39:18 -05001074 struct usb_interface *intf, pm_message_t msg, int reset_resume)
Alan Stern36e56a32006-07-01 22:08:06 -04001075{
Alan Stern1cc8a252006-07-01 22:10:15 -04001076 struct usb_driver *driver;
Alan Stern2bf40862006-07-01 22:12:19 -04001077 int status = 0;
Alan Stern36e56a32006-07-01 22:08:06 -04001078
Alan Stern65605ae2008-08-12 14:33:27 -04001079 if (udev->state == USB_STATE_NOTATTACHED || is_active(intf))
Alan Stern2bf40862006-07-01 22:12:19 -04001080 goto done;
Alan Stern36e56a32006-07-01 22:08:06 -04001081
Alan Stern645daaa2006-08-30 15:47:02 -04001082 /* Don't let autoresume interfere with unbinding */
1083 if (intf->condition == USB_INTERFACE_UNBINDING)
1084 goto done;
1085
Alan Stern1c5df7e2006-07-01 22:13:50 -04001086 /* Can't resume it if it doesn't have a driver. */
Alan Stern55151d72008-08-12 14:33:59 -04001087 if (intf->condition == USB_INTERFACE_UNBOUND) {
1088
1089 /* Carry out a deferred switch to altsetting 0 */
1090 if (intf->needs_altsetting0 &&
1091 intf->dev.power.status == DPM_ON) {
1092 usb_set_interface(udev, intf->altsetting[0].
1093 desc.bInterfaceNumber, 0);
1094 intf->needs_altsetting0 = 0;
1095 }
Alan Stern2bf40862006-07-01 22:12:19 -04001096 goto done;
Alan Stern55151d72008-08-12 14:33:59 -04001097 }
Alan Stern78d9a482008-06-23 16:00:40 -04001098
1099 /* Don't resume if the interface is marked for rebinding */
1100 if (intf->needs_binding)
1101 goto done;
Alan Stern1cc8a252006-07-01 22:10:15 -04001102 driver = to_usb_driver(intf->dev.driver);
Alan Stern36e56a32006-07-01 22:08:06 -04001103
Alan Sternf07600c2007-05-30 15:38:16 -04001104 if (reset_resume) {
1105 if (driver->reset_resume) {
1106 status = driver->reset_resume(intf);
1107 if (status)
1108 dev_err(&intf->dev, "%s error %d\n",
1109 "reset_resume", status);
1110 } else {
Alan Stern78d9a482008-06-23 16:00:40 -04001111 intf->needs_binding = 1;
Alan Sternf07600c2007-05-30 15:38:16 -04001112 dev_warn(&intf->dev, "no %s for driver %s?\n",
1113 "reset_resume", driver->name);
1114 }
1115 } else {
1116 if (driver->resume) {
1117 status = driver->resume(intf);
1118 if (status)
1119 dev_err(&intf->dev, "%s error %d\n",
1120 "resume", status);
1121 } else {
Alan Stern78d9a482008-06-23 16:00:40 -04001122 intf->needs_binding = 1;
Alan Sternf07600c2007-05-30 15:38:16 -04001123 dev_warn(&intf->dev, "no %s for driver %s?\n",
1124 "resume", driver->name);
1125 }
1126 }
Alan Stern2bf40862006-07-01 22:12:19 -04001127
1128done:
Harvey Harrison441b62c2008-03-03 16:08:34 -08001129 dev_vdbg(&intf->dev, "%s: status %d\n", __func__, status);
Alan Stern78d9a482008-06-23 16:00:40 -04001130 if (status == 0 && intf->condition == USB_INTERFACE_BOUND)
Alan Stern0458d5b2007-05-04 11:52:20 -04001131 mark_active(intf);
Alan Sternf07600c2007-05-30 15:38:16 -04001132
Alan Stern78d9a482008-06-23 16:00:40 -04001133 /* Later we will unbind the driver and/or reprobe, if necessary */
Alan Stern2bf40862006-07-01 22:12:19 -04001134 return status;
Alan Stern36e56a32006-07-01 22:08:06 -04001135}
1136
Alan Stern94fcda12006-11-20 11:38:46 -05001137#ifdef CONFIG_USB_SUSPEND
1138
Alan Sternaf4f7602006-10-30 17:06:45 -05001139/* Internal routine to check whether we may autosuspend a device. */
Alan Sternd1aa3e62007-10-11 16:47:36 -04001140static int autosuspend_check(struct usb_device *udev, int reschedule)
Alan Sternaf4f7602006-10-30 17:06:45 -05001141{
1142 int i;
1143 struct usb_interface *intf;
Alan Sternd1aa3e62007-10-11 16:47:36 -04001144 unsigned long suspend_time, j;
Alan Sternaf4f7602006-10-30 17:06:45 -05001145
Alan Sternb5e795f2007-02-20 15:00:53 -05001146 /* For autosuspend, fail fast if anything is in use or autosuspend
1147 * is disabled. Also fail if any interfaces require remote wakeup
1148 * but it isn't available.
1149 */
Alan Sternaf4f7602006-10-30 17:06:45 -05001150 if (udev->pm_usage_cnt > 0)
1151 return -EBUSY;
Alan Stern2add5222007-03-20 14:59:39 -04001152 if (udev->autosuspend_delay < 0 || udev->autosuspend_disabled)
Alan Sternb5e795f2007-02-20 15:00:53 -05001153 return -EPERM;
1154
Alan Stern19410442007-03-27 13:33:59 -04001155 suspend_time = udev->last_busy + udev->autosuspend_delay;
Alan Sternaf4f7602006-10-30 17:06:45 -05001156 if (udev->actconfig) {
1157 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1158 intf = udev->actconfig->interface[i];
1159 if (!is_active(intf))
1160 continue;
Alan Sternccf5b802009-06-29 11:00:01 -04001161 if (atomic_read(&intf->pm_usage_cnt) > 0)
Alan Sternaf4f7602006-10-30 17:06:45 -05001162 return -EBUSY;
1163 if (intf->needs_remote_wakeup &&
1164 !udev->do_remote_wakeup) {
1165 dev_dbg(&udev->dev, "remote wakeup needed "
1166 "for autosuspend\n");
1167 return -EOPNOTSUPP;
1168 }
Alan Sternf07600c2007-05-30 15:38:16 -04001169
1170 /* Don't allow autosuspend if the device will need
1171 * a reset-resume and any of its interface drivers
1172 * doesn't include support.
1173 */
1174 if (udev->quirks & USB_QUIRK_RESET_RESUME) {
1175 struct usb_driver *driver;
1176
1177 driver = to_usb_driver(intf->dev.driver);
Oliver Neukum399d31d2008-09-15 17:29:28 +02001178 if (!driver->reset_resume ||
1179 intf->needs_remote_wakeup)
Alan Sternf07600c2007-05-30 15:38:16 -04001180 return -EOPNOTSUPP;
1181 }
Alan Sternaf4f7602006-10-30 17:06:45 -05001182 }
1183 }
Alan Stern19410442007-03-27 13:33:59 -04001184
1185 /* If everything is okay but the device hasn't been idle for long
Alan Sternd1aa3e62007-10-11 16:47:36 -04001186 * enough, queue a delayed autosuspend request. If the device
1187 * _has_ been idle for long enough and the reschedule flag is set,
1188 * likewise queue a delayed (1 second) autosuspend request.
Alan Stern19410442007-03-27 13:33:59 -04001189 */
Alan Sternd1aa3e62007-10-11 16:47:36 -04001190 j = jiffies;
1191 if (time_before(j, suspend_time))
1192 reschedule = 1;
1193 else
1194 suspend_time = j + HZ;
1195 if (reschedule) {
Alan Stern8c9862e2007-04-11 12:06:16 -04001196 if (!timer_pending(&udev->autosuspend.timer)) {
Alan Stern19410442007-03-27 13:33:59 -04001197 queue_delayed_work(ksuspend_usb_wq, &udev->autosuspend,
Alan Stern4ec06d62008-11-25 16:40:02 -05001198 round_jiffies_up_relative(suspend_time - j));
Alan Sternd1aa3e62007-10-11 16:47:36 -04001199 }
Alan Stern19410442007-03-27 13:33:59 -04001200 return -EAGAIN;
1201 }
Alan Sternaf4f7602006-10-30 17:06:45 -05001202 return 0;
1203}
1204
Alan Stern94fcda12006-11-20 11:38:46 -05001205#else
1206
Alan Sternd1aa3e62007-10-11 16:47:36 -04001207static inline int autosuspend_check(struct usb_device *udev, int reschedule)
Alan Sternef7f6c72007-04-05 16:03:49 -04001208{
1209 return 0;
1210}
Alan Stern94fcda12006-11-20 11:38:46 -05001211
Alan Sternb5e795f2007-02-20 15:00:53 -05001212#endif /* CONFIG_USB_SUSPEND */
Alan Stern94fcda12006-11-20 11:38:46 -05001213
Alan Stern645daaa2006-08-30 15:47:02 -04001214/**
1215 * usb_suspend_both - suspend a USB device and its interfaces
1216 * @udev: the usb_device to suspend
1217 * @msg: Power Management message describing this state transition
1218 *
1219 * This is the central routine for suspending USB devices. It calls the
1220 * suspend methods for all the interface drivers in @udev and then calls
1221 * the suspend method for @udev itself. If an error occurs at any stage,
1222 * all the interfaces which were suspended are resumed so that they remain
1223 * in the same state as the device.
1224 *
Alan Stern65bfd292008-11-25 16:39:18 -05001225 * If an autosuspend is in progress the routine checks first to make sure
1226 * that neither the device itself or any of its active interfaces is in use
1227 * (pm_usage_cnt is greater than 0). If they are, the autosuspend fails.
Alan Stern645daaa2006-08-30 15:47:02 -04001228 *
1229 * If the suspend succeeds, the routine recursively queues an autosuspend
1230 * request for @udev's parent device, thereby propagating the change up
1231 * the device tree. If all of the parent's children are now suspended,
1232 * the parent will autosuspend in turn.
1233 *
1234 * The suspend method calls are subject to mutual exclusion under control
1235 * of @udev's pm_mutex. Many of these calls are also under the protection
1236 * of @udev's device lock (including all requests originating outside the
1237 * USB subsystem), but autosuspend requests generated by a child device or
1238 * interface driver may not be. Usbcore will insure that the method calls
1239 * do not arrive during bind, unbind, or reset operations. However, drivers
1240 * must be prepared to handle suspend calls arriving at unpredictable times.
1241 * The only way to block such calls is to do an autoresume (preventing
1242 * autosuspends) while holding @udev's device lock (preventing outside
1243 * suspends).
1244 *
1245 * The caller must hold @udev->pm_mutex.
1246 *
1247 * This routine can run only in process context.
1248 */
Alan Stern718efa62007-03-09 15:41:13 -05001249static int usb_suspend_both(struct usb_device *udev, pm_message_t msg)
Alan Sterna8e7c562006-07-01 22:11:02 -04001250{
1251 int status = 0;
1252 int i = 0;
1253 struct usb_interface *intf;
Alan Stern645daaa2006-08-30 15:47:02 -04001254 struct usb_device *parent = udev->parent;
Alan Sterna8e7c562006-07-01 22:11:02 -04001255
Alan Stern19410442007-03-27 13:33:59 -04001256 if (udev->state == USB_STATE_NOTATTACHED ||
1257 udev->state == USB_STATE_SUSPENDED)
1258 goto done;
Alan Stern645daaa2006-08-30 15:47:02 -04001259
1260 udev->do_remote_wakeup = device_may_wakeup(&udev->dev);
1261
Alan Stern65bfd292008-11-25 16:39:18 -05001262 if (msg.event & PM_EVENT_AUTO) {
Alan Sternd1aa3e62007-10-11 16:47:36 -04001263 status = autosuspend_check(udev, 0);
Alan Sternaf4f7602006-10-30 17:06:45 -05001264 if (status < 0)
Alan Stern19410442007-03-27 13:33:59 -04001265 goto done;
Alan Stern645daaa2006-08-30 15:47:02 -04001266 }
1267
1268 /* Suspend all the interfaces and then udev itself */
Alan Sterna8e7c562006-07-01 22:11:02 -04001269 if (udev->actconfig) {
1270 for (; i < udev->actconfig->desc.bNumInterfaces; i++) {
1271 intf = udev->actconfig->interface[i];
Alan Stern65605ae2008-08-12 14:33:27 -04001272 status = usb_suspend_interface(udev, intf, msg);
Alan Sterna8e7c562006-07-01 22:11:02 -04001273 if (status != 0)
1274 break;
1275 }
1276 }
Alan Stern5ad4f712007-09-10 11:31:43 -04001277 if (status == 0)
Stephen Hemmingerd5ec1682006-11-14 10:06:17 -08001278 status = usb_suspend_device(udev, msg);
Alan Sterna8e7c562006-07-01 22:11:02 -04001279
1280 /* If the suspend failed, resume interfaces that did get suspended */
1281 if (status != 0) {
Alan Stern65bfd292008-11-25 16:39:18 -05001282 pm_message_t msg2;
1283
1284 msg2.event = msg.event ^ (PM_EVENT_SUSPEND | PM_EVENT_RESUME);
Alan Sterna8e7c562006-07-01 22:11:02 -04001285 while (--i >= 0) {
1286 intf = udev->actconfig->interface[i];
Alan Stern65bfd292008-11-25 16:39:18 -05001287 usb_resume_interface(udev, intf, msg2, 0);
Alan Sterna8e7c562006-07-01 22:11:02 -04001288 }
Alan Stern645daaa2006-08-30 15:47:02 -04001289
Alan Sternef7f6c72007-04-05 16:03:49 -04001290 /* Try another autosuspend when the interfaces aren't busy */
Alan Stern65bfd292008-11-25 16:39:18 -05001291 if (msg.event & PM_EVENT_AUTO)
Alan Sternd1aa3e62007-10-11 16:47:36 -04001292 autosuspend_check(udev, status == -EBUSY);
Alan Sternef7f6c72007-04-05 16:03:49 -04001293
Alan Stern6840d252007-09-10 11:34:26 -04001294 /* If the suspend succeeded then prevent any more URB submissions,
1295 * flush any outstanding URBs, and propagate the suspend up the tree.
1296 */
Alan Sternef7f6c72007-04-05 16:03:49 -04001297 } else {
1298 cancel_delayed_work(&udev->autosuspend);
Alan Stern6840d252007-09-10 11:34:26 -04001299 udev->can_submit = 0;
1300 for (i = 0; i < 16; ++i) {
1301 usb_hcd_flush_endpoint(udev, udev->ep_out[i]);
1302 usb_hcd_flush_endpoint(udev, udev->ep_in[i]);
1303 }
Alan Stern7108f282007-09-20 12:37:50 -04001304
1305 /* If this is just a FREEZE or a PRETHAW, udev might
1306 * not really be suspended. Only true suspends get
1307 * propagated up the device tree.
1308 */
1309 if (parent && udev->state == USB_STATE_SUSPENDED)
Alan Sternef7f6c72007-04-05 16:03:49 -04001310 usb_autosuspend_device(parent);
1311 }
Alan Stern645daaa2006-08-30 15:47:02 -04001312
Alan Stern19410442007-03-27 13:33:59 -04001313 done:
Harvey Harrison441b62c2008-03-03 16:08:34 -08001314 dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
Alan Sterna8e7c562006-07-01 22:11:02 -04001315 return status;
1316}
1317
Alan Stern645daaa2006-08-30 15:47:02 -04001318/**
1319 * usb_resume_both - resume a USB device and its interfaces
1320 * @udev: the usb_device to resume
Alan Stern65bfd292008-11-25 16:39:18 -05001321 * @msg: Power Management message describing this state transition
Alan Stern645daaa2006-08-30 15:47:02 -04001322 *
1323 * This is the central routine for resuming USB devices. It calls the
1324 * the resume method for @udev and then calls the resume methods for all
1325 * the interface drivers in @udev.
1326 *
1327 * Before starting the resume, the routine calls itself recursively for
1328 * the parent device of @udev, thereby propagating the change up the device
1329 * tree and assuring that @udev will be able to resume. If the parent is
1330 * unable to resume successfully, the routine fails.
1331 *
1332 * The resume method calls are subject to mutual exclusion under control
1333 * of @udev's pm_mutex. Many of these calls are also under the protection
1334 * of @udev's device lock (including all requests originating outside the
1335 * USB subsystem), but autoresume requests generated by a child device or
1336 * interface driver may not be. Usbcore will insure that the method calls
1337 * do not arrive during bind, unbind, or reset operations. However, drivers
1338 * must be prepared to handle resume calls arriving at unpredictable times.
1339 * The only way to block such calls is to do an autoresume (preventing
1340 * other autoresumes) while holding @udev's device lock (preventing outside
1341 * resumes).
1342 *
1343 * The caller must hold @udev->pm_mutex.
1344 *
1345 * This routine can run only in process context.
1346 */
Alan Stern65bfd292008-11-25 16:39:18 -05001347static int usb_resume_both(struct usb_device *udev, pm_message_t msg)
Alan Sterna8e7c562006-07-01 22:11:02 -04001348{
Alan Stern645daaa2006-08-30 15:47:02 -04001349 int status = 0;
Alan Sterna8e7c562006-07-01 22:11:02 -04001350 int i;
1351 struct usb_interface *intf;
Alan Stern645daaa2006-08-30 15:47:02 -04001352 struct usb_device *parent = udev->parent;
Alan Sterna8e7c562006-07-01 22:11:02 -04001353
Alan Stern645daaa2006-08-30 15:47:02 -04001354 cancel_delayed_work(&udev->autosuspend);
Alan Stern19410442007-03-27 13:33:59 -04001355 if (udev->state == USB_STATE_NOTATTACHED) {
1356 status = -ENODEV;
1357 goto done;
1358 }
Alan Stern6840d252007-09-10 11:34:26 -04001359 udev->can_submit = 1;
Alan Stern645daaa2006-08-30 15:47:02 -04001360
1361 /* Propagate the resume up the tree, if necessary */
1362 if (udev->state == USB_STATE_SUSPENDED) {
1363 if (parent) {
Alan Stern94fcda12006-11-20 11:38:46 -05001364 status = usb_autoresume_device(parent);
Alan Sternee49fb52006-11-22 16:55:54 -05001365 if (status == 0) {
Alan Stern65bfd292008-11-25 16:39:18 -05001366 status = usb_resume_device(udev, msg);
Alan Sternf07600c2007-05-30 15:38:16 -04001367 if (status || udev->state ==
1368 USB_STATE_NOTATTACHED) {
Alan Stern94fcda12006-11-20 11:38:46 -05001369 usb_autosuspend_device(parent);
Alan Sternee49fb52006-11-22 16:55:54 -05001370
1371 /* It's possible usb_resume_device()
1372 * failed after the port was
1373 * unsuspended, causing udev to be
1374 * logically disconnected. We don't
1375 * want usb_disconnect() to autosuspend
1376 * the parent again, so tell it that
1377 * udev disconnected while still
1378 * suspended. */
1379 if (udev->state ==
1380 USB_STATE_NOTATTACHED)
1381 udev->discon_suspended = 1;
1382 }
1383 }
Alan Stern645daaa2006-08-30 15:47:02 -04001384 } else {
1385
1386 /* We can't progagate beyond the USB subsystem,
1387 * so if a root hub's controller is suspended
1388 * then we're stuck. */
Alan Stern65bfd292008-11-25 16:39:18 -05001389 status = usb_resume_device(udev, msg);
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -08001390 }
Alan Stern6ee0b272008-04-28 11:06:42 -04001391 } else if (udev->reset_resume)
Alan Stern65bfd292008-11-25 16:39:18 -05001392 status = usb_resume_device(udev, msg);
Alan Stern114b3682006-07-01 22:13:04 -04001393
Alan Sterna8e7c562006-07-01 22:11:02 -04001394 if (status == 0 && udev->actconfig) {
1395 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1396 intf = udev->actconfig->interface[i];
Alan Stern65bfd292008-11-25 16:39:18 -05001397 usb_resume_interface(udev, intf, msg,
1398 udev->reset_resume);
Alan Sterna8e7c562006-07-01 22:11:02 -04001399 }
1400 }
Alan Stern645daaa2006-08-30 15:47:02 -04001401
Alan Stern19410442007-03-27 13:33:59 -04001402 done:
Harvey Harrison441b62c2008-03-03 16:08:34 -08001403 dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
Alan Stern70a1c9e2008-03-06 17:00:58 -05001404 if (!status)
1405 udev->reset_resume = 0;
Alan Sterna8e7c562006-07-01 22:11:02 -04001406 return status;
1407}
1408
Alan Stern645daaa2006-08-30 15:47:02 -04001409#ifdef CONFIG_USB_SUSPEND
1410
Alan Stern94fcda12006-11-20 11:38:46 -05001411/* Internal routine to adjust a device's usage counter and change
1412 * its autosuspend state.
1413 */
1414static int usb_autopm_do_device(struct usb_device *udev, int inc_usage_cnt)
1415{
1416 int status = 0;
1417
1418 usb_pm_lock(udev);
1419 udev->pm_usage_cnt += inc_usage_cnt;
1420 WARN_ON(udev->pm_usage_cnt < 0);
Alan Stern013d27f2007-08-20 12:18:39 -04001421 if (inc_usage_cnt)
1422 udev->last_busy = jiffies;
Alan Stern94fcda12006-11-20 11:38:46 -05001423 if (inc_usage_cnt >= 0 && udev->pm_usage_cnt > 0) {
Alan Stern19410442007-03-27 13:33:59 -04001424 if (udev->state == USB_STATE_SUSPENDED)
Alan Stern65bfd292008-11-25 16:39:18 -05001425 status = usb_resume_both(udev, PMSG_AUTO_RESUME);
Alan Stern94fcda12006-11-20 11:38:46 -05001426 if (status != 0)
1427 udev->pm_usage_cnt -= inc_usage_cnt;
Alan Stern19410442007-03-27 13:33:59 -04001428 else if (inc_usage_cnt)
1429 udev->last_busy = jiffies;
1430 } else if (inc_usage_cnt <= 0 && udev->pm_usage_cnt <= 0) {
Alan Stern65bfd292008-11-25 16:39:18 -05001431 status = usb_suspend_both(udev, PMSG_AUTO_SUSPEND);
Alan Stern19410442007-03-27 13:33:59 -04001432 }
Alan Stern94fcda12006-11-20 11:38:46 -05001433 usb_pm_unlock(udev);
1434 return status;
1435}
1436
Alan Stern19410442007-03-27 13:33:59 -04001437/* usb_autosuspend_work - callback routine to autosuspend a USB device */
1438void usb_autosuspend_work(struct work_struct *work)
1439{
1440 struct usb_device *udev =
1441 container_of(work, struct usb_device, autosuspend.work);
1442
1443 usb_autopm_do_device(udev, 0);
1444}
1445
Alan Stern9ac39f22008-11-12 16:19:49 -05001446/* usb_autoresume_work - callback routine to autoresume a USB device */
1447void usb_autoresume_work(struct work_struct *work)
1448{
1449 struct usb_device *udev =
1450 container_of(work, struct usb_device, autoresume);
1451
1452 /* Wake it up, let the drivers do their thing, and then put it
1453 * back to sleep.
1454 */
1455 if (usb_autopm_do_device(udev, 1) == 0)
1456 usb_autopm_do_device(udev, -1);
1457}
1458
Alan Stern645daaa2006-08-30 15:47:02 -04001459/**
1460 * usb_autosuspend_device - delayed autosuspend of a USB device and its interfaces
Henrik Kretzschmar701f35a2006-09-25 17:00:56 -07001461 * @udev: the usb_device to autosuspend
Alan Stern645daaa2006-08-30 15:47:02 -04001462 *
1463 * This routine should be called when a core subsystem is finished using
1464 * @udev and wants to allow it to autosuspend. Examples would be when
1465 * @udev's device file in usbfs is closed or after a configuration change.
1466 *
Alan Stern94fcda12006-11-20 11:38:46 -05001467 * @udev's usage counter is decremented. If it or any of the usage counters
1468 * for an active interface is greater than 0, no autosuspend request will be
1469 * queued. (If an interface driver does not support autosuspend then its
1470 * usage counter is permanently positive.) Furthermore, if an interface
1471 * driver requires remote-wakeup capability during autosuspend but remote
1472 * wakeup is disabled, the autosuspend will fail.
Alan Stern645daaa2006-08-30 15:47:02 -04001473 *
1474 * Often the caller will hold @udev's device lock, but this is not
1475 * necessary.
1476 *
1477 * This routine can run only in process context.
1478 */
Alan Stern94fcda12006-11-20 11:38:46 -05001479void usb_autosuspend_device(struct usb_device *udev)
Alan Stern645daaa2006-08-30 15:47:02 -04001480{
Alan Stern94fcda12006-11-20 11:38:46 -05001481 int status;
1482
1483 status = usb_autopm_do_device(udev, -1);
Alan Stern20dfdad2007-05-22 11:50:17 -04001484 dev_vdbg(&udev->dev, "%s: cnt %d\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -08001485 __func__, udev->pm_usage_cnt);
Alan Stern645daaa2006-08-30 15:47:02 -04001486}
1487
1488/**
Alan Stern19c26232007-02-20 15:03:32 -05001489 * usb_try_autosuspend_device - attempt an autosuspend of a USB device and its interfaces
1490 * @udev: the usb_device to autosuspend
1491 *
1492 * This routine should be called when a core subsystem thinks @udev may
1493 * be ready to autosuspend.
1494 *
1495 * @udev's usage counter left unchanged. If it or any of the usage counters
1496 * for an active interface is greater than 0, or autosuspend is not allowed
1497 * for any other reason, no autosuspend request will be queued.
1498 *
1499 * This routine can run only in process context.
1500 */
1501void usb_try_autosuspend_device(struct usb_device *udev)
1502{
1503 usb_autopm_do_device(udev, 0);
Alan Stern20dfdad2007-05-22 11:50:17 -04001504 dev_vdbg(&udev->dev, "%s: cnt %d\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -08001505 __func__, udev->pm_usage_cnt);
Alan Stern19c26232007-02-20 15:03:32 -05001506}
1507
1508/**
Alan Stern645daaa2006-08-30 15:47:02 -04001509 * usb_autoresume_device - immediately autoresume a USB device and its interfaces
Henrik Kretzschmar701f35a2006-09-25 17:00:56 -07001510 * @udev: the usb_device to autoresume
Alan Stern645daaa2006-08-30 15:47:02 -04001511 *
1512 * This routine should be called when a core subsystem wants to use @udev
Alan Stern94fcda12006-11-20 11:38:46 -05001513 * and needs to guarantee that it is not suspended. No autosuspend will
1514 * occur until usb_autosuspend_device is called. (Note that this will not
1515 * prevent suspend events originating in the PM core.) Examples would be
1516 * when @udev's device file in usbfs is opened or when a remote-wakeup
1517 * request is received.
Alan Stern645daaa2006-08-30 15:47:02 -04001518 *
Alan Stern94fcda12006-11-20 11:38:46 -05001519 * @udev's usage counter is incremented to prevent subsequent autosuspends.
1520 * However if the autoresume fails then the usage counter is re-decremented.
Alan Stern645daaa2006-08-30 15:47:02 -04001521 *
1522 * Often the caller will hold @udev's device lock, but this is not
1523 * necessary (and attempting it might cause deadlock).
1524 *
1525 * This routine can run only in process context.
1526 */
Alan Stern94fcda12006-11-20 11:38:46 -05001527int usb_autoresume_device(struct usb_device *udev)
Alan Stern645daaa2006-08-30 15:47:02 -04001528{
1529 int status;
1530
Alan Stern94fcda12006-11-20 11:38:46 -05001531 status = usb_autopm_do_device(udev, 1);
Alan Stern20dfdad2007-05-22 11:50:17 -04001532 dev_vdbg(&udev->dev, "%s: status %d cnt %d\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -08001533 __func__, status, udev->pm_usage_cnt);
Alan Stern645daaa2006-08-30 15:47:02 -04001534 return status;
1535}
1536
Alan Sternaf4f7602006-10-30 17:06:45 -05001537/* Internal routine to adjust an interface's usage counter and change
1538 * its device's autosuspend state.
1539 */
1540static int usb_autopm_do_interface(struct usb_interface *intf,
1541 int inc_usage_cnt)
1542{
1543 struct usb_device *udev = interface_to_usbdev(intf);
1544 int status = 0;
1545
1546 usb_pm_lock(udev);
1547 if (intf->condition == USB_INTERFACE_UNBOUND)
1548 status = -ENODEV;
1549 else {
Alan Sternccf5b802009-06-29 11:00:01 -04001550 atomic_add(inc_usage_cnt, &intf->pm_usage_cnt);
Alan Stern013d27f2007-08-20 12:18:39 -04001551 udev->last_busy = jiffies;
Alan Sternccf5b802009-06-29 11:00:01 -04001552 if (inc_usage_cnt >= 0 &&
1553 atomic_read(&intf->pm_usage_cnt) > 0) {
Alan Stern19410442007-03-27 13:33:59 -04001554 if (udev->state == USB_STATE_SUSPENDED)
Alan Stern65bfd292008-11-25 16:39:18 -05001555 status = usb_resume_both(udev,
1556 PMSG_AUTO_RESUME);
Alan Sternaf4f7602006-10-30 17:06:45 -05001557 if (status != 0)
Alan Sternccf5b802009-06-29 11:00:01 -04001558 atomic_sub(inc_usage_cnt, &intf->pm_usage_cnt);
Alan Stern013d27f2007-08-20 12:18:39 -04001559 else
Alan Stern19410442007-03-27 13:33:59 -04001560 udev->last_busy = jiffies;
Alan Sternccf5b802009-06-29 11:00:01 -04001561 } else if (inc_usage_cnt <= 0 &&
1562 atomic_read(&intf->pm_usage_cnt) <= 0) {
Alan Stern65bfd292008-11-25 16:39:18 -05001563 status = usb_suspend_both(udev, PMSG_AUTO_SUSPEND);
Alan Stern19410442007-03-27 13:33:59 -04001564 }
Alan Sternaf4f7602006-10-30 17:06:45 -05001565 }
1566 usb_pm_unlock(udev);
1567 return status;
1568}
1569
Alan Stern645daaa2006-08-30 15:47:02 -04001570/**
1571 * usb_autopm_put_interface - decrement a USB interface's PM-usage counter
Henrik Kretzschmar701f35a2006-09-25 17:00:56 -07001572 * @intf: the usb_interface whose counter should be decremented
Alan Stern645daaa2006-08-30 15:47:02 -04001573 *
1574 * This routine should be called by an interface driver when it is
1575 * finished using @intf and wants to allow it to autosuspend. A typical
1576 * example would be a character-device driver when its device file is
1577 * closed.
1578 *
1579 * The routine decrements @intf's usage counter. When the counter reaches
1580 * 0, a delayed autosuspend request for @intf's device is queued. When
1581 * the delay expires, if @intf->pm_usage_cnt is still <= 0 along with all
1582 * the other usage counters for the sibling interfaces and @intf's
1583 * usb_device, the device and all its interfaces will be autosuspended.
1584 *
1585 * Note that @intf->pm_usage_cnt is owned by the interface driver. The
1586 * core will not change its value other than the increment and decrement
1587 * in usb_autopm_get_interface and usb_autopm_put_interface. The driver
1588 * may use this simple counter-oriented discipline or may set the value
1589 * any way it likes.
1590 *
1591 * If the driver has set @intf->needs_remote_wakeup then autosuspend will
1592 * take place only if the device's remote-wakeup facility is enabled.
1593 *
1594 * Suspend method calls queued by this routine can arrive at any time
1595 * while @intf is resumed and its usage counter is equal to 0. They are
1596 * not protected by the usb_device's lock but only by its pm_mutex.
1597 * Drivers must provide their own synchronization.
1598 *
1599 * This routine can run only in process context.
1600 */
1601void usb_autopm_put_interface(struct usb_interface *intf)
1602{
Alan Sternaf4f7602006-10-30 17:06:45 -05001603 int status;
Alan Stern645daaa2006-08-30 15:47:02 -04001604
Alan Sternaf4f7602006-10-30 17:06:45 -05001605 status = usb_autopm_do_interface(intf, -1);
Alan Stern20dfdad2007-05-22 11:50:17 -04001606 dev_vdbg(&intf->dev, "%s: status %d cnt %d\n",
Alan Sternccf5b802009-06-29 11:00:01 -04001607 __func__, status, atomic_read(&intf->pm_usage_cnt));
Alan Stern645daaa2006-08-30 15:47:02 -04001608}
1609EXPORT_SYMBOL_GPL(usb_autopm_put_interface);
1610
1611/**
Alan Stern9ac39f22008-11-12 16:19:49 -05001612 * usb_autopm_put_interface_async - decrement a USB interface's PM-usage counter
1613 * @intf: the usb_interface whose counter should be decremented
1614 *
1615 * This routine does essentially the same thing as
1616 * usb_autopm_put_interface(): it decrements @intf's usage counter and
1617 * queues a delayed autosuspend request if the counter is <= 0. The
1618 * difference is that it does not acquire the device's pm_mutex;
1619 * callers must handle all synchronization issues themselves.
1620 *
1621 * Typically a driver would call this routine during an URB's completion
1622 * handler, if no more URBs were pending.
1623 *
1624 * This routine can run in atomic context.
1625 */
1626void usb_autopm_put_interface_async(struct usb_interface *intf)
1627{
1628 struct usb_device *udev = interface_to_usbdev(intf);
1629 int status = 0;
1630
1631 if (intf->condition == USB_INTERFACE_UNBOUND) {
1632 status = -ENODEV;
1633 } else {
1634 udev->last_busy = jiffies;
Alan Sternccf5b802009-06-29 11:00:01 -04001635 atomic_dec(&intf->pm_usage_cnt);
Alan Stern9ac39f22008-11-12 16:19:49 -05001636 if (udev->autosuspend_disabled || udev->autosuspend_delay < 0)
1637 status = -EPERM;
Alan Sternccf5b802009-06-29 11:00:01 -04001638 else if (atomic_read(&intf->pm_usage_cnt) <= 0 &&
Alan Stern9ac39f22008-11-12 16:19:49 -05001639 !timer_pending(&udev->autosuspend.timer)) {
1640 queue_delayed_work(ksuspend_usb_wq, &udev->autosuspend,
Alan Stern4ec06d62008-11-25 16:40:02 -05001641 round_jiffies_up_relative(
Alan Stern9ac39f22008-11-12 16:19:49 -05001642 udev->autosuspend_delay));
1643 }
1644 }
1645 dev_vdbg(&intf->dev, "%s: status %d cnt %d\n",
Alan Sternccf5b802009-06-29 11:00:01 -04001646 __func__, status, atomic_read(&intf->pm_usage_cnt));
Alan Stern9ac39f22008-11-12 16:19:49 -05001647}
1648EXPORT_SYMBOL_GPL(usb_autopm_put_interface_async);
1649
1650/**
Alan Stern645daaa2006-08-30 15:47:02 -04001651 * usb_autopm_get_interface - increment a USB interface's PM-usage counter
Henrik Kretzschmar701f35a2006-09-25 17:00:56 -07001652 * @intf: the usb_interface whose counter should be incremented
Alan Stern645daaa2006-08-30 15:47:02 -04001653 *
1654 * This routine should be called by an interface driver when it wants to
1655 * use @intf and needs to guarantee that it is not suspended. In addition,
1656 * the routine prevents @intf from being autosuspended subsequently. (Note
1657 * that this will not prevent suspend events originating in the PM core.)
1658 * This prevention will persist until usb_autopm_put_interface() is called
1659 * or @intf is unbound. A typical example would be a character-device
1660 * driver when its device file is opened.
1661 *
Alan Stern19410442007-03-27 13:33:59 -04001662 *
1663 * The routine increments @intf's usage counter. (However if the
1664 * autoresume fails then the counter is re-decremented.) So long as the
1665 * counter is greater than 0, autosuspend will not be allowed for @intf
1666 * or its usb_device. When the driver is finished using @intf it should
1667 * call usb_autopm_put_interface() to decrement the usage counter and
1668 * queue a delayed autosuspend request (if the counter is <= 0).
1669 *
Alan Stern645daaa2006-08-30 15:47:02 -04001670 *
1671 * Note that @intf->pm_usage_cnt is owned by the interface driver. The
1672 * core will not change its value other than the increment and decrement
1673 * in usb_autopm_get_interface and usb_autopm_put_interface. The driver
1674 * may use this simple counter-oriented discipline or may set the value
1675 * any way it likes.
1676 *
1677 * Resume method calls generated by this routine can arrive at any time
1678 * while @intf is suspended. They are not protected by the usb_device's
1679 * lock but only by its pm_mutex. Drivers must provide their own
1680 * synchronization.
1681 *
1682 * This routine can run only in process context.
1683 */
1684int usb_autopm_get_interface(struct usb_interface *intf)
1685{
Alan Sternaf4f7602006-10-30 17:06:45 -05001686 int status;
Alan Stern645daaa2006-08-30 15:47:02 -04001687
Alan Sternaf4f7602006-10-30 17:06:45 -05001688 status = usb_autopm_do_interface(intf, 1);
Alan Stern20dfdad2007-05-22 11:50:17 -04001689 dev_vdbg(&intf->dev, "%s: status %d cnt %d\n",
Alan Sternccf5b802009-06-29 11:00:01 -04001690 __func__, status, atomic_read(&intf->pm_usage_cnt));
Alan Stern645daaa2006-08-30 15:47:02 -04001691 return status;
1692}
1693EXPORT_SYMBOL_GPL(usb_autopm_get_interface);
1694
Alan Stern692a1862006-10-30 17:07:51 -05001695/**
Alan Stern9ac39f22008-11-12 16:19:49 -05001696 * usb_autopm_get_interface_async - increment a USB interface's PM-usage counter
1697 * @intf: the usb_interface whose counter should be incremented
1698 *
1699 * This routine does much the same thing as
1700 * usb_autopm_get_interface(): it increments @intf's usage counter and
1701 * queues an autoresume request if the result is > 0. The differences
1702 * are that it does not acquire the device's pm_mutex (callers must
1703 * handle all synchronization issues themselves), and it does not
1704 * autoresume the device directly (it only queues a request). After a
1705 * successful call, the device will generally not yet be resumed.
1706 *
1707 * This routine can run in atomic context.
1708 */
1709int usb_autopm_get_interface_async(struct usb_interface *intf)
1710{
1711 struct usb_device *udev = interface_to_usbdev(intf);
1712 int status = 0;
1713
1714 if (intf->condition == USB_INTERFACE_UNBOUND)
1715 status = -ENODEV;
Alan Sternccf5b802009-06-29 11:00:01 -04001716 else {
1717 atomic_inc(&intf->pm_usage_cnt);
1718 if (atomic_read(&intf->pm_usage_cnt) > 0 &&
1719 udev->state == USB_STATE_SUSPENDED)
1720 queue_work(ksuspend_usb_wq, &udev->autoresume);
1721 }
Alan Stern9ac39f22008-11-12 16:19:49 -05001722 dev_vdbg(&intf->dev, "%s: status %d cnt %d\n",
Alan Sternccf5b802009-06-29 11:00:01 -04001723 __func__, status, atomic_read(&intf->pm_usage_cnt));
Alan Stern9ac39f22008-11-12 16:19:49 -05001724 return status;
1725}
1726EXPORT_SYMBOL_GPL(usb_autopm_get_interface_async);
1727
Alan Stern718efa62007-03-09 15:41:13 -05001728#else
1729
1730void usb_autosuspend_work(struct work_struct *work)
1731{}
1732
Alan Stern9ac39f22008-11-12 16:19:49 -05001733void usb_autoresume_work(struct work_struct *work)
1734{}
1735
Alan Stern645daaa2006-08-30 15:47:02 -04001736#endif /* CONFIG_USB_SUSPEND */
1737
Alan Stern6b157c92007-03-13 16:37:30 -04001738/**
1739 * usb_external_suspend_device - external suspend of a USB device and its interfaces
1740 * @udev: the usb_device to suspend
1741 * @msg: Power Management message describing this state transition
1742 *
1743 * This routine handles external suspend requests: ones not generated
1744 * internally by a USB driver (autosuspend) but rather coming from the user
1745 * (via sysfs) or the PM core (system sleep). The suspend will be carried
1746 * out regardless of @udev's usage counter or those of its interfaces,
1747 * and regardless of whether or not remote wakeup is enabled. Of course,
1748 * interface drivers still have the option of failing the suspend (if
1749 * there are unsuspended children, for example).
1750 *
1751 * The caller must hold @udev's device lock.
1752 */
1753int usb_external_suspend_device(struct usb_device *udev, pm_message_t msg)
Alan Stern1cc8a252006-07-01 22:10:15 -04001754{
1755 int status;
1756
Alan Stern78d9a482008-06-23 16:00:40 -04001757 do_unbind_rebind(udev, DO_UNBIND);
Alan Stern6b157c92007-03-13 16:37:30 -04001758 usb_pm_lock(udev);
Alan Stern6b157c92007-03-13 16:37:30 -04001759 status = usb_suspend_both(udev, msg);
1760 usb_pm_unlock(udev);
Alan Stern1cc8a252006-07-01 22:10:15 -04001761 return status;
1762}
1763
Alan Stern6b157c92007-03-13 16:37:30 -04001764/**
1765 * usb_external_resume_device - external resume of a USB device and its interfaces
1766 * @udev: the usb_device to resume
Alan Stern65bfd292008-11-25 16:39:18 -05001767 * @msg: Power Management message describing this state transition
Alan Stern6b157c92007-03-13 16:37:30 -04001768 *
1769 * This routine handles external resume requests: ones not generated
1770 * internally by a USB driver (autoresume) but rather coming from the user
1771 * (via sysfs), the PM core (system resume), or the device itself (remote
1772 * wakeup). @udev's usage counter is unaffected.
1773 *
1774 * The caller must hold @udev's device lock.
1775 */
Alan Stern65bfd292008-11-25 16:39:18 -05001776int usb_external_resume_device(struct usb_device *udev, pm_message_t msg)
Alan Stern6b157c92007-03-13 16:37:30 -04001777{
1778 int status;
1779
1780 usb_pm_lock(udev);
Alan Stern65bfd292008-11-25 16:39:18 -05001781 status = usb_resume_both(udev, msg);
Alan Sternef7f6c72007-04-05 16:03:49 -04001782 udev->last_busy = jiffies;
Alan Stern6b157c92007-03-13 16:37:30 -04001783 usb_pm_unlock(udev);
Alan Stern6c640942008-10-21 15:40:03 -04001784 if (status == 0)
1785 do_unbind_rebind(udev, DO_REBIND);
Alan Stern6b157c92007-03-13 16:37:30 -04001786
1787 /* Now that the device is awake, we can start trying to autosuspend
1788 * it again. */
1789 if (status == 0)
1790 usb_try_autosuspend_device(udev);
1791 return status;
1792}
1793
Alan Stern65bfd292008-11-25 16:39:18 -05001794int usb_suspend(struct device *dev, pm_message_t msg)
Alan Stern6b157c92007-03-13 16:37:30 -04001795{
Alan Stern271f9e62007-10-10 16:30:12 -04001796 struct usb_device *udev;
1797
Alan Stern271f9e62007-10-10 16:30:12 -04001798 udev = to_usb_device(dev);
1799
1800 /* If udev is already suspended, we can skip this suspend and
Alan Stern3bb1af52008-03-03 15:15:36 -05001801 * we should also skip the upcoming system resume. High-speed
1802 * root hubs are an exception; they need to resume whenever the
1803 * system wakes up in order for USB-PERSIST port handover to work
1804 * properly.
1805 */
Alan Stern271f9e62007-10-10 16:30:12 -04001806 if (udev->state == USB_STATE_SUSPENDED) {
Alan Stern3bb1af52008-03-03 15:15:36 -05001807 if (udev->parent || udev->speed != USB_SPEED_HIGH)
1808 udev->skip_sys_resume = 1;
Alan Stern271f9e62007-10-10 16:30:12 -04001809 return 0;
1810 }
1811
1812 udev->skip_sys_resume = 0;
Alan Stern65bfd292008-11-25 16:39:18 -05001813 return usb_external_suspend_device(udev, msg);
Alan Stern6b157c92007-03-13 16:37:30 -04001814}
1815
Alan Stern65bfd292008-11-25 16:39:18 -05001816int usb_resume(struct device *dev, pm_message_t msg)
Alan Stern1cc8a252006-07-01 22:10:15 -04001817{
Alan Stern2add5222007-03-20 14:59:39 -04001818 struct usb_device *udev;
Frans Pop23a54e52009-06-04 22:30:48 +02001819 int status;
Alan Stern2add5222007-03-20 14:59:39 -04001820
Alan Stern2add5222007-03-20 14:59:39 -04001821 udev = to_usb_device(dev);
Alan Stern0458d5b2007-05-04 11:52:20 -04001822
Alan Stern271f9e62007-10-10 16:30:12 -04001823 /* If udev->skip_sys_resume is set then udev was already suspended
Alan Stern8808f002008-04-28 11:06:55 -04001824 * when the system sleep started, so we don't want to resume it
1825 * during this system wakeup.
1826 */
1827 if (udev->skip_sys_resume)
1828 return 0;
Frans Pop23a54e52009-06-04 22:30:48 +02001829 status = usb_external_resume_device(udev, msg);
1830
1831 /* Avoid PM error messages for devices disconnected while suspended
1832 * as we'll display regular disconnect messages just a bit later.
1833 */
1834 if (status == -ENODEV)
1835 return 0;
1836 return status;
Alan Stern1cc8a252006-07-01 22:10:15 -04001837}
1838
Alan Stern36e56a32006-07-01 22:08:06 -04001839#endif /* CONFIG_PM */
1840
1841struct bus_type usb_bus_type = {
1842 .name = "usb",
1843 .match = usb_device_match,
1844 .uevent = usb_uevent,
Alan Stern36e56a32006-07-01 22:08:06 -04001845};