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