driver.c 47 KB

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