driver.c 50 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744
  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/slab.h>
  26. #include <linux/export.h>
  27. #include <linux/usb.h>
  28. #include <linux/usb/quirks.h>
  29. #include <linux/usb/hcd.h>
  30. #include "usb.h"
  31. #ifdef CONFIG_HOTPLUG
  32. /*
  33. * Adds a new dynamic USBdevice ID to this driver,
  34. * and cause the driver to probe for all devices again.
  35. */
  36. ssize_t usb_store_new_id(struct usb_dynids *dynids,
  37. struct device_driver *driver,
  38. const char *buf, size_t count)
  39. {
  40. struct usb_dynid *dynid;
  41. u32 idVendor = 0;
  42. u32 idProduct = 0;
  43. unsigned int bInterfaceClass = 0;
  44. int fields = 0;
  45. int retval = 0;
  46. fields = sscanf(buf, "%x %x %x", &idVendor, &idProduct,
  47. &bInterfaceClass);
  48. if (fields < 2)
  49. return -EINVAL;
  50. dynid = kzalloc(sizeof(*dynid), GFP_KERNEL);
  51. if (!dynid)
  52. return -ENOMEM;
  53. INIT_LIST_HEAD(&dynid->node);
  54. dynid->id.idVendor = idVendor;
  55. dynid->id.idProduct = idProduct;
  56. dynid->id.match_flags = USB_DEVICE_ID_MATCH_DEVICE;
  57. if (fields == 3) {
  58. dynid->id.bInterfaceClass = (u8)bInterfaceClass;
  59. dynid->id.match_flags |= USB_DEVICE_ID_MATCH_INT_CLASS;
  60. }
  61. spin_lock(&dynids->lock);
  62. list_add_tail(&dynid->node, &dynids->list);
  63. spin_unlock(&dynids->lock);
  64. retval = driver_attach(driver);
  65. if (retval)
  66. return retval;
  67. return count;
  68. }
  69. EXPORT_SYMBOL_GPL(usb_store_new_id);
  70. ssize_t usb_show_dynids(struct usb_dynids *dynids, char *buf)
  71. {
  72. struct usb_dynid *dynid;
  73. size_t count = 0;
  74. list_for_each_entry(dynid, &dynids->list, node)
  75. if (dynid->id.bInterfaceClass != 0)
  76. count += scnprintf(&buf[count], PAGE_SIZE - count, "%04x %04x %02x\n",
  77. dynid->id.idVendor, dynid->id.idProduct,
  78. dynid->id.bInterfaceClass);
  79. else
  80. count += scnprintf(&buf[count], PAGE_SIZE - count, "%04x %04x\n",
  81. dynid->id.idVendor, dynid->id.idProduct);
  82. return count;
  83. }
  84. EXPORT_SYMBOL_GPL(usb_show_dynids);
  85. static ssize_t show_dynids(struct device_driver *driver, char *buf)
  86. {
  87. struct usb_driver *usb_drv = to_usb_driver(driver);
  88. return usb_show_dynids(&usb_drv->dynids, buf);
  89. }
  90. static ssize_t store_new_id(struct device_driver *driver,
  91. const char *buf, size_t count)
  92. {
  93. struct usb_driver *usb_drv = to_usb_driver(driver);
  94. return usb_store_new_id(&usb_drv->dynids, driver, buf, count);
  95. }
  96. static DRIVER_ATTR(new_id, S_IRUGO | S_IWUSR, show_dynids, store_new_id);
  97. /**
  98. * store_remove_id - remove a USB device ID from this driver
  99. * @driver: target device driver
  100. * @buf: buffer for scanning device ID data
  101. * @count: input size
  102. *
  103. * Removes a dynamic usb device ID from this driver.
  104. */
  105. static ssize_t
  106. store_remove_id(struct device_driver *driver, const char *buf, size_t count)
  107. {
  108. struct usb_dynid *dynid, *n;
  109. struct usb_driver *usb_driver = to_usb_driver(driver);
  110. u32 idVendor = 0;
  111. u32 idProduct = 0;
  112. int fields = 0;
  113. int retval = 0;
  114. fields = sscanf(buf, "%x %x", &idVendor, &idProduct);
  115. if (fields < 2)
  116. return -EINVAL;
  117. spin_lock(&usb_driver->dynids.lock);
  118. list_for_each_entry_safe(dynid, n, &usb_driver->dynids.list, node) {
  119. struct usb_device_id *id = &dynid->id;
  120. if ((id->idVendor == idVendor) &&
  121. (id->idProduct == idProduct)) {
  122. list_del(&dynid->node);
  123. kfree(dynid);
  124. retval = 0;
  125. break;
  126. }
  127. }
  128. spin_unlock(&usb_driver->dynids.lock);
  129. if (retval)
  130. return retval;
  131. return count;
  132. }
  133. static DRIVER_ATTR(remove_id, S_IRUGO | S_IWUSR, show_dynids, store_remove_id);
  134. static int usb_create_newid_files(struct usb_driver *usb_drv)
  135. {
  136. int error = 0;
  137. if (usb_drv->no_dynamic_id)
  138. goto exit;
  139. if (usb_drv->probe != NULL) {
  140. error = driver_create_file(&usb_drv->drvwrap.driver,
  141. &driver_attr_new_id);
  142. if (error == 0) {
  143. error = driver_create_file(&usb_drv->drvwrap.driver,
  144. &driver_attr_remove_id);
  145. if (error)
  146. driver_remove_file(&usb_drv->drvwrap.driver,
  147. &driver_attr_new_id);
  148. }
  149. }
  150. exit:
  151. return error;
  152. }
  153. static void usb_remove_newid_files(struct usb_driver *usb_drv)
  154. {
  155. if (usb_drv->no_dynamic_id)
  156. return;
  157. if (usb_drv->probe != NULL) {
  158. driver_remove_file(&usb_drv->drvwrap.driver,
  159. &driver_attr_remove_id);
  160. driver_remove_file(&usb_drv->drvwrap.driver,
  161. &driver_attr_new_id);
  162. }
  163. }
  164. static void usb_free_dynids(struct usb_driver *usb_drv)
  165. {
  166. struct usb_dynid *dynid, *n;
  167. spin_lock(&usb_drv->dynids.lock);
  168. list_for_each_entry_safe(dynid, n, &usb_drv->dynids.list, node) {
  169. list_del(&dynid->node);
  170. kfree(dynid);
  171. }
  172. spin_unlock(&usb_drv->dynids.lock);
  173. }
  174. #else
  175. static inline int usb_create_newid_files(struct usb_driver *usb_drv)
  176. {
  177. return 0;
  178. }
  179. static void usb_remove_newid_files(struct usb_driver *usb_drv)
  180. {
  181. }
  182. static inline void usb_free_dynids(struct usb_driver *usb_drv)
  183. {
  184. }
  185. #endif
  186. static const struct usb_device_id *usb_match_dynamic_id(struct usb_interface *intf,
  187. struct usb_driver *drv)
  188. {
  189. struct usb_dynid *dynid;
  190. spin_lock(&drv->dynids.lock);
  191. list_for_each_entry(dynid, &drv->dynids.list, node) {
  192. if (usb_match_one_id(intf, &dynid->id)) {
  193. spin_unlock(&drv->dynids.lock);
  194. return &dynid->id;
  195. }
  196. }
  197. spin_unlock(&drv->dynids.lock);
  198. return NULL;
  199. }
  200. /* called from driver core with dev locked */
  201. static int usb_probe_device(struct device *dev)
  202. {
  203. struct usb_device_driver *udriver = to_usb_device_driver(dev->driver);
  204. struct usb_device *udev = to_usb_device(dev);
  205. int error = 0;
  206. dev_dbg(dev, "%s\n", __func__);
  207. /* TODO: Add real matching code */
  208. /* The device should always appear to be in use
  209. * unless the driver suports autosuspend.
  210. */
  211. if (!udriver->supports_autosuspend)
  212. error = usb_autoresume_device(udev);
  213. if (!error)
  214. error = udriver->probe(udev);
  215. return error;
  216. }
  217. /* called from driver core with dev locked */
  218. static int usb_unbind_device(struct device *dev)
  219. {
  220. struct usb_device *udev = to_usb_device(dev);
  221. struct usb_device_driver *udriver = to_usb_device_driver(dev->driver);
  222. udriver->disconnect(udev);
  223. if (!udriver->supports_autosuspend)
  224. usb_autosuspend_device(udev);
  225. return 0;
  226. }
  227. /*
  228. * Cancel any pending scheduled resets
  229. *
  230. * [see usb_queue_reset_device()]
  231. *
  232. * Called after unconfiguring / when releasing interfaces. See
  233. * comments in __usb_queue_reset_device() regarding
  234. * udev->reset_running.
  235. */
  236. static void usb_cancel_queued_reset(struct usb_interface *iface)
  237. {
  238. if (iface->reset_running == 0)
  239. cancel_work_sync(&iface->reset_ws);
  240. }
  241. /* called from driver core with dev locked */
  242. static int usb_probe_interface(struct device *dev)
  243. {
  244. struct usb_driver *driver = to_usb_driver(dev->driver);
  245. struct usb_interface *intf = to_usb_interface(dev);
  246. struct usb_device *udev = interface_to_usbdev(intf);
  247. const struct usb_device_id *id;
  248. int error = -ENODEV;
  249. dev_dbg(dev, "%s\n", __func__);
  250. intf->needs_binding = 0;
  251. if (usb_device_is_owned(udev))
  252. return error;
  253. if (udev->authorized == 0) {
  254. dev_err(&intf->dev, "Device is not authorized for usage\n");
  255. return error;
  256. }
  257. id = usb_match_id(intf, driver->id_table);
  258. if (!id)
  259. id = usb_match_dynamic_id(intf, driver);
  260. if (!id)
  261. return error;
  262. dev_dbg(dev, "%s - got id\n", __func__);
  263. error = usb_autoresume_device(udev);
  264. if (error)
  265. return error;
  266. intf->condition = USB_INTERFACE_BINDING;
  267. /* Probed interfaces are initially active. They are
  268. * runtime-PM-enabled only if the driver has autosuspend support.
  269. * They are sensitive to their children's power states.
  270. */
  271. pm_runtime_set_active(dev);
  272. pm_suspend_ignore_children(dev, false);
  273. if (driver->supports_autosuspend)
  274. pm_runtime_enable(dev);
  275. /* Carry out a deferred switch to altsetting 0 */
  276. if (intf->needs_altsetting0) {
  277. error = usb_set_interface(udev, intf->altsetting[0].
  278. desc.bInterfaceNumber, 0);
  279. if (error < 0)
  280. goto err;
  281. intf->needs_altsetting0 = 0;
  282. }
  283. error = driver->probe(intf, id);
  284. if (error)
  285. goto err;
  286. intf->condition = USB_INTERFACE_BOUND;
  287. usb_autosuspend_device(udev);
  288. return error;
  289. err:
  290. intf->needs_remote_wakeup = 0;
  291. intf->condition = USB_INTERFACE_UNBOUND;
  292. usb_cancel_queued_reset(intf);
  293. /* Unbound interfaces are always runtime-PM-disabled and -suspended */
  294. if (driver->supports_autosuspend)
  295. pm_runtime_disable(dev);
  296. pm_runtime_set_suspended(dev);
  297. usb_autosuspend_device(udev);
  298. return error;
  299. }
  300. /* called from driver core with dev locked */
  301. static int usb_unbind_interface(struct device *dev)
  302. {
  303. struct usb_driver *driver = to_usb_driver(dev->driver);
  304. struct usb_interface *intf = to_usb_interface(dev);
  305. struct usb_device *udev;
  306. int error, r;
  307. intf->condition = USB_INTERFACE_UNBINDING;
  308. /* Autoresume for set_interface call below */
  309. udev = interface_to_usbdev(intf);
  310. error = usb_autoresume_device(udev);
  311. /* Terminate all URBs for this interface unless the driver
  312. * supports "soft" unbinding.
  313. */
  314. if (!driver->soft_unbind)
  315. usb_disable_interface(udev, intf, false);
  316. driver->disconnect(intf);
  317. usb_cancel_queued_reset(intf);
  318. /* Reset other interface state.
  319. * We cannot do a Set-Interface if the device is suspended or
  320. * if it is prepared for a system sleep (since installing a new
  321. * altsetting means creating new endpoint device entries).
  322. * When either of these happens, defer the Set-Interface.
  323. */
  324. if (intf->cur_altsetting->desc.bAlternateSetting == 0) {
  325. /* Already in altsetting 0 so skip Set-Interface.
  326. * Just re-enable it without affecting the endpoint toggles.
  327. */
  328. usb_enable_interface(udev, intf, false);
  329. } else if (!error && !intf->dev.power.is_prepared) {
  330. r = usb_set_interface(udev, intf->altsetting[0].
  331. desc.bInterfaceNumber, 0);
  332. if (r < 0)
  333. intf->needs_altsetting0 = 1;
  334. } else {
  335. intf->needs_altsetting0 = 1;
  336. }
  337. usb_set_intfdata(intf, NULL);
  338. intf->condition = USB_INTERFACE_UNBOUND;
  339. intf->needs_remote_wakeup = 0;
  340. /* Unbound interfaces are always runtime-PM-disabled and -suspended */
  341. if (driver->supports_autosuspend)
  342. pm_runtime_disable(dev);
  343. pm_runtime_set_suspended(dev);
  344. /* Undo any residual pm_autopm_get_interface_* calls */
  345. for (r = atomic_read(&intf->pm_usage_cnt); r > 0; --r)
  346. usb_autopm_put_interface_no_suspend(intf);
  347. atomic_set(&intf->pm_usage_cnt, 0);
  348. if (!error)
  349. usb_autosuspend_device(udev);
  350. return 0;
  351. }
  352. /**
  353. * usb_driver_claim_interface - bind a driver to an interface
  354. * @driver: the driver to be bound
  355. * @iface: the interface to which it will be bound; must be in the
  356. * usb device's active configuration
  357. * @priv: driver data associated with that interface
  358. *
  359. * This is used by usb device drivers that need to claim more than one
  360. * interface on a device when probing (audio and acm are current examples).
  361. * No device driver should directly modify internal usb_interface or
  362. * usb_device structure members.
  363. *
  364. * Few drivers should need to use this routine, since the most natural
  365. * way to bind to an interface is to return the private data from
  366. * the driver's probe() method.
  367. *
  368. * Callers must own the device lock, so driver probe() entries don't need
  369. * extra locking, but other call contexts may need to explicitly claim that
  370. * lock.
  371. */
  372. int usb_driver_claim_interface(struct usb_driver *driver,
  373. struct usb_interface *iface, void *priv)
  374. {
  375. struct device *dev = &iface->dev;
  376. int retval = 0;
  377. if (dev->driver)
  378. return -EBUSY;
  379. dev->driver = &driver->drvwrap.driver;
  380. usb_set_intfdata(iface, priv);
  381. iface->needs_binding = 0;
  382. iface->condition = USB_INTERFACE_BOUND;
  383. /* Claimed interfaces are initially inactive (suspended) and
  384. * runtime-PM-enabled, but only if the driver has autosuspend
  385. * support. Otherwise they are marked active, to prevent the
  386. * device from being autosuspended, but left disabled. In either
  387. * case they are sensitive to their children's power states.
  388. */
  389. pm_suspend_ignore_children(dev, false);
  390. if (driver->supports_autosuspend)
  391. pm_runtime_enable(dev);
  392. else
  393. pm_runtime_set_active(dev);
  394. /* if interface was already added, bind now; else let
  395. * the future device_add() bind it, bypassing probe()
  396. */
  397. if (device_is_registered(dev))
  398. retval = device_bind_driver(dev);
  399. return retval;
  400. }
  401. EXPORT_SYMBOL_GPL(usb_driver_claim_interface);
  402. /**
  403. * usb_driver_release_interface - unbind a driver from an interface
  404. * @driver: the driver to be unbound
  405. * @iface: the interface from which it will be unbound
  406. *
  407. * This can be used by drivers to release an interface without waiting
  408. * for their disconnect() methods to be called. In typical cases this
  409. * also causes the driver disconnect() method to be called.
  410. *
  411. * This call is synchronous, and may not be used in an interrupt context.
  412. * Callers must own the device lock, so driver disconnect() entries don't
  413. * need extra locking, but other call contexts may need to explicitly claim
  414. * that lock.
  415. */
  416. void usb_driver_release_interface(struct usb_driver *driver,
  417. struct usb_interface *iface)
  418. {
  419. struct device *dev = &iface->dev;
  420. /* this should never happen, don't release something that's not ours */
  421. if (!dev->driver || dev->driver != &driver->drvwrap.driver)
  422. return;
  423. /* don't release from within disconnect() */
  424. if (iface->condition != USB_INTERFACE_BOUND)
  425. return;
  426. iface->condition = USB_INTERFACE_UNBINDING;
  427. /* Release via the driver core only if the interface
  428. * has already been registered
  429. */
  430. if (device_is_registered(dev)) {
  431. device_release_driver(dev);
  432. } else {
  433. device_lock(dev);
  434. usb_unbind_interface(dev);
  435. dev->driver = NULL;
  436. device_unlock(dev);
  437. }
  438. }
  439. EXPORT_SYMBOL_GPL(usb_driver_release_interface);
  440. /* returns 0 if no match, 1 if match */
  441. int usb_match_device(struct usb_device *dev, const struct usb_device_id *id)
  442. {
  443. if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
  444. id->idVendor != le16_to_cpu(dev->descriptor.idVendor))
  445. return 0;
  446. if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) &&
  447. id->idProduct != le16_to_cpu(dev->descriptor.idProduct))
  448. return 0;
  449. /* No need to test id->bcdDevice_lo != 0, since 0 is never
  450. greater than any unsigned number. */
  451. if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO) &&
  452. (id->bcdDevice_lo > le16_to_cpu(dev->descriptor.bcdDevice)))
  453. return 0;
  454. if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) &&
  455. (id->bcdDevice_hi < le16_to_cpu(dev->descriptor.bcdDevice)))
  456. return 0;
  457. if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) &&
  458. (id->bDeviceClass != dev->descriptor.bDeviceClass))
  459. return 0;
  460. if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) &&
  461. (id->bDeviceSubClass != dev->descriptor.bDeviceSubClass))
  462. return 0;
  463. if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) &&
  464. (id->bDeviceProtocol != dev->descriptor.bDeviceProtocol))
  465. return 0;
  466. return 1;
  467. }
  468. /* returns 0 if no match, 1 if match */
  469. int usb_match_one_id(struct usb_interface *interface,
  470. const struct usb_device_id *id)
  471. {
  472. struct usb_host_interface *intf;
  473. struct usb_device *dev;
  474. /* proc_connectinfo in devio.c may call us with id == NULL. */
  475. if (id == NULL)
  476. return 0;
  477. intf = interface->cur_altsetting;
  478. dev = interface_to_usbdev(interface);
  479. if (!usb_match_device(dev, id))
  480. return 0;
  481. /* The interface class, subclass, and protocol should never be
  482. * checked for a match if the device class is Vendor Specific,
  483. * unless the match record specifies the Vendor ID. */
  484. if (dev->descriptor.bDeviceClass == USB_CLASS_VENDOR_SPEC &&
  485. !(id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
  486. (id->match_flags & (USB_DEVICE_ID_MATCH_INT_CLASS |
  487. USB_DEVICE_ID_MATCH_INT_SUBCLASS |
  488. USB_DEVICE_ID_MATCH_INT_PROTOCOL)))
  489. return 0;
  490. if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) &&
  491. (id->bInterfaceClass != intf->desc.bInterfaceClass))
  492. return 0;
  493. if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) &&
  494. (id->bInterfaceSubClass != intf->desc.bInterfaceSubClass))
  495. return 0;
  496. if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) &&
  497. (id->bInterfaceProtocol != intf->desc.bInterfaceProtocol))
  498. return 0;
  499. return 1;
  500. }
  501. EXPORT_SYMBOL_GPL(usb_match_one_id);
  502. /**
  503. * usb_match_id - find first usb_device_id matching device or interface
  504. * @interface: the interface of interest
  505. * @id: array of usb_device_id structures, terminated by zero entry
  506. *
  507. * usb_match_id searches an array of usb_device_id's and returns
  508. * the first one matching the device or interface, or null.
  509. * This is used when binding (or rebinding) a driver to an interface.
  510. * Most USB device drivers will use this indirectly, through the usb core,
  511. * but some layered driver frameworks use it directly.
  512. * These device tables are exported with MODULE_DEVICE_TABLE, through
  513. * modutils, to support the driver loading functionality of USB hotplugging.
  514. *
  515. * What Matches:
  516. *
  517. * The "match_flags" element in a usb_device_id controls which
  518. * members are used. If the corresponding bit is set, the
  519. * value in the device_id must match its corresponding member
  520. * in the device or interface descriptor, or else the device_id
  521. * does not match.
  522. *
  523. * "driver_info" is normally used only by device drivers,
  524. * but you can create a wildcard "matches anything" usb_device_id
  525. * as a driver's "modules.usbmap" entry if you provide an id with
  526. * only a nonzero "driver_info" field. If you do this, the USB device
  527. * driver's probe() routine should use additional intelligence to
  528. * decide whether to bind to the specified interface.
  529. *
  530. * What Makes Good usb_device_id Tables:
  531. *
  532. * The match algorithm is very simple, so that intelligence in
  533. * driver selection must come from smart driver id records.
  534. * Unless you have good reasons to use another selection policy,
  535. * provide match elements only in related groups, and order match
  536. * specifiers from specific to general. Use the macros provided
  537. * for that purpose if you can.
  538. *
  539. * The most specific match specifiers use device descriptor
  540. * data. These are commonly used with product-specific matches;
  541. * the USB_DEVICE macro lets you provide vendor and product IDs,
  542. * and you can also match against ranges of product revisions.
  543. * These are widely used for devices with application or vendor
  544. * specific bDeviceClass values.
  545. *
  546. * Matches based on device class/subclass/protocol specifications
  547. * are slightly more general; use the USB_DEVICE_INFO macro, or
  548. * its siblings. These are used with single-function devices
  549. * where bDeviceClass doesn't specify that each interface has
  550. * its own class.
  551. *
  552. * Matches based on interface class/subclass/protocol are the
  553. * most general; they let drivers bind to any interface on a
  554. * multiple-function device. Use the USB_INTERFACE_INFO
  555. * macro, or its siblings, to match class-per-interface style
  556. * devices (as recorded in bInterfaceClass).
  557. *
  558. * Note that an entry created by USB_INTERFACE_INFO won't match
  559. * any interface if the device class is set to Vendor-Specific.
  560. * This is deliberate; according to the USB spec the meanings of
  561. * the interface class/subclass/protocol for these devices are also
  562. * vendor-specific, and hence matching against a standard product
  563. * class wouldn't work anyway. If you really want to use an
  564. * interface-based match for such a device, create a match record
  565. * that also specifies the vendor ID. (Unforunately there isn't a
  566. * standard macro for creating records like this.)
  567. *
  568. * Within those groups, remember that not all combinations are
  569. * meaningful. For example, don't give a product version range
  570. * without vendor and product IDs; or specify a protocol without
  571. * its associated class and subclass.
  572. */
  573. const struct usb_device_id *usb_match_id(struct usb_interface *interface,
  574. const struct usb_device_id *id)
  575. {
  576. /* proc_connectinfo in devio.c may call us with id == NULL. */
  577. if (id == NULL)
  578. return NULL;
  579. /* It is important to check that id->driver_info is nonzero,
  580. since an entry that is all zeroes except for a nonzero
  581. id->driver_info is the way to create an entry that
  582. indicates that the driver want to examine every
  583. device and interface. */
  584. for (; id->idVendor || id->idProduct || id->bDeviceClass ||
  585. id->bInterfaceClass || id->driver_info; id++) {
  586. if (usb_match_one_id(interface, id))
  587. return id;
  588. }
  589. return NULL;
  590. }
  591. EXPORT_SYMBOL_GPL(usb_match_id);
  592. static int usb_device_match(struct device *dev, struct device_driver *drv)
  593. {
  594. /* devices and interfaces are handled separately */
  595. if (is_usb_device(dev)) {
  596. /* interface drivers never match devices */
  597. if (!is_usb_device_driver(drv))
  598. return 0;
  599. /* TODO: Add real matching code */
  600. return 1;
  601. } else if (is_usb_interface(dev)) {
  602. struct usb_interface *intf;
  603. struct usb_driver *usb_drv;
  604. const struct usb_device_id *id;
  605. /* device drivers never match interfaces */
  606. if (is_usb_device_driver(drv))
  607. return 0;
  608. intf = to_usb_interface(dev);
  609. usb_drv = to_usb_driver(drv);
  610. id = usb_match_id(intf, usb_drv->id_table);
  611. if (id)
  612. return 1;
  613. id = usb_match_dynamic_id(intf, usb_drv);
  614. if (id)
  615. return 1;
  616. }
  617. return 0;
  618. }
  619. #ifdef CONFIG_HOTPLUG
  620. static int usb_uevent(struct device *dev, struct kobj_uevent_env *env)
  621. {
  622. struct usb_device *usb_dev;
  623. if (is_usb_device(dev)) {
  624. usb_dev = to_usb_device(dev);
  625. } else if (is_usb_interface(dev)) {
  626. struct usb_interface *intf = to_usb_interface(dev);
  627. usb_dev = interface_to_usbdev(intf);
  628. } else {
  629. return 0;
  630. }
  631. if (usb_dev->devnum < 0) {
  632. /* driver is often null here; dev_dbg() would oops */
  633. pr_debug("usb %s: already deleted?\n", dev_name(dev));
  634. return -ENODEV;
  635. }
  636. if (!usb_dev->bus) {
  637. pr_debug("usb %s: bus removed?\n", dev_name(dev));
  638. return -ENODEV;
  639. }
  640. /* per-device configurations are common */
  641. if (add_uevent_var(env, "PRODUCT=%x/%x/%x",
  642. le16_to_cpu(usb_dev->descriptor.idVendor),
  643. le16_to_cpu(usb_dev->descriptor.idProduct),
  644. le16_to_cpu(usb_dev->descriptor.bcdDevice)))
  645. return -ENOMEM;
  646. /* class-based driver binding models */
  647. if (add_uevent_var(env, "TYPE=%d/%d/%d",
  648. usb_dev->descriptor.bDeviceClass,
  649. usb_dev->descriptor.bDeviceSubClass,
  650. usb_dev->descriptor.bDeviceProtocol))
  651. return -ENOMEM;
  652. return 0;
  653. }
  654. #else
  655. static int usb_uevent(struct device *dev, struct kobj_uevent_env *env)
  656. {
  657. return -ENODEV;
  658. }
  659. #endif /* CONFIG_HOTPLUG */
  660. /**
  661. * usb_register_device_driver - register a USB device (not interface) driver
  662. * @new_udriver: USB operations for the device driver
  663. * @owner: module owner of this driver.
  664. *
  665. * Registers a USB device driver with the USB core. The list of
  666. * unattached devices will be rescanned whenever a new driver is
  667. * added, allowing the new driver to attach to any recognized devices.
  668. * Returns a negative error code on failure and 0 on success.
  669. */
  670. int usb_register_device_driver(struct usb_device_driver *new_udriver,
  671. struct module *owner)
  672. {
  673. int retval = 0;
  674. if (usb_disabled())
  675. return -ENODEV;
  676. new_udriver->drvwrap.for_devices = 1;
  677. new_udriver->drvwrap.driver.name = (char *) new_udriver->name;
  678. new_udriver->drvwrap.driver.bus = &usb_bus_type;
  679. new_udriver->drvwrap.driver.probe = usb_probe_device;
  680. new_udriver->drvwrap.driver.remove = usb_unbind_device;
  681. new_udriver->drvwrap.driver.owner = owner;
  682. retval = driver_register(&new_udriver->drvwrap.driver);
  683. if (!retval)
  684. pr_info("%s: registered new device driver %s\n",
  685. usbcore_name, new_udriver->name);
  686. else
  687. printk(KERN_ERR "%s: error %d registering device "
  688. " driver %s\n",
  689. usbcore_name, retval, new_udriver->name);
  690. return retval;
  691. }
  692. EXPORT_SYMBOL_GPL(usb_register_device_driver);
  693. /**
  694. * usb_deregister_device_driver - unregister a USB device (not interface) driver
  695. * @udriver: USB operations of the device driver to unregister
  696. * Context: must be able to sleep
  697. *
  698. * Unlinks the specified driver from the internal USB driver list.
  699. */
  700. void usb_deregister_device_driver(struct usb_device_driver *udriver)
  701. {
  702. pr_info("%s: deregistering device driver %s\n",
  703. usbcore_name, udriver->name);
  704. driver_unregister(&udriver->drvwrap.driver);
  705. }
  706. EXPORT_SYMBOL_GPL(usb_deregister_device_driver);
  707. /**
  708. * usb_register_driver - register a USB interface driver
  709. * @new_driver: USB operations for the interface driver
  710. * @owner: module owner of this driver.
  711. * @mod_name: module name string
  712. *
  713. * Registers a USB interface driver with the USB core. The list of
  714. * unattached interfaces will be rescanned whenever a new driver is
  715. * added, allowing the new driver to attach to any recognized interfaces.
  716. * Returns a negative error code on failure and 0 on success.
  717. *
  718. * NOTE: if you want your driver to use the USB major number, you must call
  719. * usb_register_dev() to enable that functionality. This function no longer
  720. * takes care of that.
  721. */
  722. int usb_register_driver(struct usb_driver *new_driver, struct module *owner,
  723. const char *mod_name)
  724. {
  725. int retval = 0;
  726. if (usb_disabled())
  727. return -ENODEV;
  728. new_driver->drvwrap.for_devices = 0;
  729. new_driver->drvwrap.driver.name = (char *) new_driver->name;
  730. new_driver->drvwrap.driver.bus = &usb_bus_type;
  731. new_driver->drvwrap.driver.probe = usb_probe_interface;
  732. new_driver->drvwrap.driver.remove = usb_unbind_interface;
  733. new_driver->drvwrap.driver.owner = owner;
  734. new_driver->drvwrap.driver.mod_name = mod_name;
  735. spin_lock_init(&new_driver->dynids.lock);
  736. INIT_LIST_HEAD(&new_driver->dynids.list);
  737. retval = driver_register(&new_driver->drvwrap.driver);
  738. if (retval)
  739. goto out;
  740. retval = usb_create_newid_files(new_driver);
  741. if (retval)
  742. goto out_newid;
  743. pr_info("%s: registered new interface driver %s\n",
  744. usbcore_name, new_driver->name);
  745. out:
  746. return retval;
  747. out_newid:
  748. driver_unregister(&new_driver->drvwrap.driver);
  749. printk(KERN_ERR "%s: error %d registering interface "
  750. " driver %s\n",
  751. usbcore_name, retval, new_driver->name);
  752. goto out;
  753. }
  754. EXPORT_SYMBOL_GPL(usb_register_driver);
  755. /**
  756. * usb_deregister - unregister a USB interface driver
  757. * @driver: USB operations of the interface driver to unregister
  758. * Context: must be able to sleep
  759. *
  760. * Unlinks the specified driver from the internal USB driver list.
  761. *
  762. * NOTE: If you called usb_register_dev(), you still need to call
  763. * usb_deregister_dev() to clean up your driver's allocated minor numbers,
  764. * this * call will no longer do it for you.
  765. */
  766. void usb_deregister(struct usb_driver *driver)
  767. {
  768. pr_info("%s: deregistering interface driver %s\n",
  769. usbcore_name, driver->name);
  770. usb_remove_newid_files(driver);
  771. driver_unregister(&driver->drvwrap.driver);
  772. usb_free_dynids(driver);
  773. }
  774. EXPORT_SYMBOL_GPL(usb_deregister);
  775. /* Forced unbinding of a USB interface driver, either because
  776. * it doesn't support pre_reset/post_reset/reset_resume or
  777. * because it doesn't support suspend/resume.
  778. *
  779. * The caller must hold @intf's device's lock, but not its pm_mutex
  780. * and not @intf->dev.sem.
  781. */
  782. void usb_forced_unbind_intf(struct usb_interface *intf)
  783. {
  784. struct usb_driver *driver = to_usb_driver(intf->dev.driver);
  785. dev_dbg(&intf->dev, "forced unbind\n");
  786. usb_driver_release_interface(driver, intf);
  787. /* Mark the interface for later rebinding */
  788. intf->needs_binding = 1;
  789. }
  790. /* Delayed forced unbinding of a USB interface driver and scan
  791. * for rebinding.
  792. *
  793. * The caller must hold @intf's device's lock, but not its pm_mutex
  794. * and not @intf->dev.sem.
  795. *
  796. * Note: Rebinds will be skipped if a system sleep transition is in
  797. * progress and the PM "complete" callback hasn't occurred yet.
  798. */
  799. void usb_rebind_intf(struct usb_interface *intf)
  800. {
  801. int rc;
  802. /* Delayed unbind of an existing driver */
  803. if (intf->dev.driver)
  804. usb_forced_unbind_intf(intf);
  805. /* Try to rebind the interface */
  806. if (!intf->dev.power.is_prepared) {
  807. intf->needs_binding = 0;
  808. rc = device_attach(&intf->dev);
  809. if (rc < 0)
  810. dev_warn(&intf->dev, "rebind failed: %d\n", rc);
  811. }
  812. }
  813. #ifdef CONFIG_PM
  814. /* Unbind drivers for @udev's interfaces that don't support suspend/resume
  815. * There is no check for reset_resume here because it can be determined
  816. * only during resume whether reset_resume is needed.
  817. *
  818. * The caller must hold @udev's device lock.
  819. */
  820. static void unbind_no_pm_drivers_interfaces(struct usb_device *udev)
  821. {
  822. struct usb_host_config *config;
  823. int i;
  824. struct usb_interface *intf;
  825. struct usb_driver *drv;
  826. config = udev->actconfig;
  827. if (config) {
  828. for (i = 0; i < config->desc.bNumInterfaces; ++i) {
  829. intf = config->interface[i];
  830. if (intf->dev.driver) {
  831. drv = to_usb_driver(intf->dev.driver);
  832. if (!drv->suspend || !drv->resume)
  833. usb_forced_unbind_intf(intf);
  834. }
  835. }
  836. }
  837. }
  838. /* Unbind drivers for @udev's interfaces that failed to support reset-resume.
  839. * These interfaces have the needs_binding flag set by usb_resume_interface().
  840. *
  841. * The caller must hold @udev's device lock.
  842. */
  843. static void unbind_no_reset_resume_drivers_interfaces(struct usb_device *udev)
  844. {
  845. struct usb_host_config *config;
  846. int i;
  847. struct usb_interface *intf;
  848. config = udev->actconfig;
  849. if (config) {
  850. for (i = 0; i < config->desc.bNumInterfaces; ++i) {
  851. intf = config->interface[i];
  852. if (intf->dev.driver && intf->needs_binding)
  853. usb_forced_unbind_intf(intf);
  854. }
  855. }
  856. }
  857. static void do_rebind_interfaces(struct usb_device *udev)
  858. {
  859. struct usb_host_config *config;
  860. int i;
  861. struct usb_interface *intf;
  862. config = udev->actconfig;
  863. if (config) {
  864. for (i = 0; i < config->desc.bNumInterfaces; ++i) {
  865. intf = config->interface[i];
  866. if (intf->needs_binding)
  867. usb_rebind_intf(intf);
  868. }
  869. }
  870. }
  871. static int usb_suspend_device(struct usb_device *udev, pm_message_t msg)
  872. {
  873. struct usb_device_driver *udriver;
  874. int status = 0;
  875. if (udev->state == USB_STATE_NOTATTACHED ||
  876. udev->state == USB_STATE_SUSPENDED)
  877. goto done;
  878. /* For devices that don't have a driver, we do a generic suspend. */
  879. if (udev->dev.driver)
  880. udriver = to_usb_device_driver(udev->dev.driver);
  881. else {
  882. udev->do_remote_wakeup = 0;
  883. udriver = &usb_generic_driver;
  884. }
  885. status = udriver->suspend(udev, msg);
  886. done:
  887. dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
  888. return status;
  889. }
  890. static int usb_resume_device(struct usb_device *udev, pm_message_t msg)
  891. {
  892. struct usb_device_driver *udriver;
  893. int status = 0;
  894. if (udev->state == USB_STATE_NOTATTACHED)
  895. goto done;
  896. /* Can't resume it if it doesn't have a driver. */
  897. if (udev->dev.driver == NULL) {
  898. status = -ENOTCONN;
  899. goto done;
  900. }
  901. /* Non-root devices on a full/low-speed bus must wait for their
  902. * companion high-speed root hub, in case a handoff is needed.
  903. */
  904. if (!PMSG_IS_AUTO(msg) && udev->parent && udev->bus->hs_companion)
  905. device_pm_wait_for_dev(&udev->dev,
  906. &udev->bus->hs_companion->root_hub->dev);
  907. if (udev->quirks & USB_QUIRK_RESET_RESUME)
  908. udev->reset_resume = 1;
  909. udriver = to_usb_device_driver(udev->dev.driver);
  910. status = udriver->resume(udev, msg);
  911. done:
  912. dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
  913. return status;
  914. }
  915. static int usb_suspend_interface(struct usb_device *udev,
  916. struct usb_interface *intf, pm_message_t msg)
  917. {
  918. struct usb_driver *driver;
  919. int status = 0;
  920. if (udev->state == USB_STATE_NOTATTACHED ||
  921. intf->condition == USB_INTERFACE_UNBOUND)
  922. goto done;
  923. driver = to_usb_driver(intf->dev.driver);
  924. /* at this time we know the driver supports suspend */
  925. status = driver->suspend(intf, msg);
  926. if (status && !PMSG_IS_AUTO(msg))
  927. dev_err(&intf->dev, "suspend error %d\n", status);
  928. done:
  929. dev_vdbg(&intf->dev, "%s: status %d\n", __func__, status);
  930. return status;
  931. }
  932. static int usb_resume_interface(struct usb_device *udev,
  933. struct usb_interface *intf, pm_message_t msg, int reset_resume)
  934. {
  935. struct usb_driver *driver;
  936. int status = 0;
  937. if (udev->state == USB_STATE_NOTATTACHED)
  938. goto done;
  939. /* Don't let autoresume interfere with unbinding */
  940. if (intf->condition == USB_INTERFACE_UNBINDING)
  941. goto done;
  942. /* Can't resume it if it doesn't have a driver. */
  943. if (intf->condition == USB_INTERFACE_UNBOUND) {
  944. /* Carry out a deferred switch to altsetting 0 */
  945. if (intf->needs_altsetting0 && !intf->dev.power.is_prepared) {
  946. usb_set_interface(udev, intf->altsetting[0].
  947. desc.bInterfaceNumber, 0);
  948. intf->needs_altsetting0 = 0;
  949. }
  950. goto done;
  951. }
  952. /* Don't resume if the interface is marked for rebinding */
  953. if (intf->needs_binding)
  954. goto done;
  955. driver = to_usb_driver(intf->dev.driver);
  956. if (reset_resume) {
  957. if (driver->reset_resume) {
  958. status = driver->reset_resume(intf);
  959. if (status)
  960. dev_err(&intf->dev, "%s error %d\n",
  961. "reset_resume", status);
  962. } else {
  963. intf->needs_binding = 1;
  964. dev_warn(&intf->dev, "no %s for driver %s?\n",
  965. "reset_resume", driver->name);
  966. }
  967. } else {
  968. status = driver->resume(intf);
  969. if (status)
  970. dev_err(&intf->dev, "resume error %d\n", status);
  971. }
  972. done:
  973. dev_vdbg(&intf->dev, "%s: status %d\n", __func__, status);
  974. /* Later we will unbind the driver and/or reprobe, if necessary */
  975. return status;
  976. }
  977. /**
  978. * usb_suspend_both - suspend a USB device and its interfaces
  979. * @udev: the usb_device to suspend
  980. * @msg: Power Management message describing this state transition
  981. *
  982. * This is the central routine for suspending USB devices. It calls the
  983. * suspend methods for all the interface drivers in @udev and then calls
  984. * the suspend method for @udev itself. If an error occurs at any stage,
  985. * all the interfaces which were suspended are resumed so that they remain
  986. * in the same state as the device.
  987. *
  988. * Autosuspend requests originating from a child device or an interface
  989. * driver may be made without the protection of @udev's device lock, but
  990. * all other suspend calls will hold the lock. Usbcore will insure that
  991. * method calls do not arrive during bind, unbind, or reset operations.
  992. * However drivers must be prepared to handle suspend calls arriving at
  993. * unpredictable times.
  994. *
  995. * This routine can run only in process context.
  996. */
  997. static int usb_suspend_both(struct usb_device *udev, pm_message_t msg)
  998. {
  999. int status = 0;
  1000. int i = 0, n = 0;
  1001. struct usb_interface *intf;
  1002. if (udev->state == USB_STATE_NOTATTACHED ||
  1003. udev->state == USB_STATE_SUSPENDED)
  1004. goto done;
  1005. /* Suspend all the interfaces and then udev itself */
  1006. if (udev->actconfig) {
  1007. n = udev->actconfig->desc.bNumInterfaces;
  1008. for (i = n - 1; i >= 0; --i) {
  1009. intf = udev->actconfig->interface[i];
  1010. status = usb_suspend_interface(udev, intf, msg);
  1011. /* Ignore errors during system sleep transitions */
  1012. if (!PMSG_IS_AUTO(msg))
  1013. status = 0;
  1014. if (status != 0)
  1015. break;
  1016. }
  1017. }
  1018. if (status == 0) {
  1019. status = usb_suspend_device(udev, msg);
  1020. /*
  1021. * Ignore errors from non-root-hub devices during
  1022. * system sleep transitions. For the most part,
  1023. * these devices should go to low power anyway when
  1024. * the entire bus is suspended.
  1025. */
  1026. if (udev->parent && !PMSG_IS_AUTO(msg))
  1027. status = 0;
  1028. }
  1029. /* If the suspend failed, resume interfaces that did get suspended */
  1030. if (status != 0) {
  1031. msg.event ^= (PM_EVENT_SUSPEND | PM_EVENT_RESUME);
  1032. while (++i < n) {
  1033. intf = udev->actconfig->interface[i];
  1034. usb_resume_interface(udev, intf, msg, 0);
  1035. }
  1036. /* If the suspend succeeded then prevent any more URB submissions
  1037. * and flush any outstanding URBs.
  1038. */
  1039. } else {
  1040. udev->can_submit = 0;
  1041. for (i = 0; i < 16; ++i) {
  1042. usb_hcd_flush_endpoint(udev, udev->ep_out[i]);
  1043. usb_hcd_flush_endpoint(udev, udev->ep_in[i]);
  1044. }
  1045. }
  1046. done:
  1047. dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
  1048. return status;
  1049. }
  1050. /**
  1051. * usb_resume_both - resume a USB device and its interfaces
  1052. * @udev: the usb_device to resume
  1053. * @msg: Power Management message describing this state transition
  1054. *
  1055. * This is the central routine for resuming USB devices. It calls the
  1056. * the resume method for @udev and then calls the resume methods for all
  1057. * the interface drivers in @udev.
  1058. *
  1059. * Autoresume requests originating from a child device or an interface
  1060. * driver may be made without the protection of @udev's device lock, but
  1061. * all other resume calls will hold the lock. Usbcore will insure that
  1062. * method calls do not arrive during bind, unbind, or reset operations.
  1063. * However drivers must be prepared to handle resume calls arriving at
  1064. * unpredictable times.
  1065. *
  1066. * This routine can run only in process context.
  1067. */
  1068. static int usb_resume_both(struct usb_device *udev, pm_message_t msg)
  1069. {
  1070. int status = 0;
  1071. int i;
  1072. struct usb_interface *intf;
  1073. if (udev->state == USB_STATE_NOTATTACHED) {
  1074. status = -ENODEV;
  1075. goto done;
  1076. }
  1077. udev->can_submit = 1;
  1078. /* Resume the device */
  1079. if (udev->state == USB_STATE_SUSPENDED || udev->reset_resume)
  1080. status = usb_resume_device(udev, msg);
  1081. /* Resume the interfaces */
  1082. if (status == 0 && udev->actconfig) {
  1083. for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
  1084. intf = udev->actconfig->interface[i];
  1085. usb_resume_interface(udev, intf, msg,
  1086. udev->reset_resume);
  1087. }
  1088. }
  1089. usb_mark_last_busy(udev);
  1090. done:
  1091. dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
  1092. if (!status)
  1093. udev->reset_resume = 0;
  1094. return status;
  1095. }
  1096. static void choose_wakeup(struct usb_device *udev, pm_message_t msg)
  1097. {
  1098. int w;
  1099. /* Remote wakeup is needed only when we actually go to sleep.
  1100. * For things like FREEZE and QUIESCE, if the device is already
  1101. * autosuspended then its current wakeup setting is okay.
  1102. */
  1103. if (msg.event == PM_EVENT_FREEZE || msg.event == PM_EVENT_QUIESCE) {
  1104. if (udev->state != USB_STATE_SUSPENDED)
  1105. udev->do_remote_wakeup = 0;
  1106. return;
  1107. }
  1108. /* Enable remote wakeup if it is allowed, even if no interface drivers
  1109. * actually want it.
  1110. */
  1111. w = device_may_wakeup(&udev->dev);
  1112. /* If the device is autosuspended with the wrong wakeup setting,
  1113. * autoresume now so the setting can be changed.
  1114. */
  1115. if (udev->state == USB_STATE_SUSPENDED && w != udev->do_remote_wakeup)
  1116. pm_runtime_resume(&udev->dev);
  1117. udev->do_remote_wakeup = w;
  1118. }
  1119. /* The device lock is held by the PM core */
  1120. int usb_suspend(struct device *dev, pm_message_t msg)
  1121. {
  1122. struct usb_device *udev = to_usb_device(dev);
  1123. unbind_no_pm_drivers_interfaces(udev);
  1124. /* From now on we are sure all drivers support suspend/resume
  1125. * but not necessarily reset_resume()
  1126. * so we may still need to unbind and rebind upon resume
  1127. */
  1128. choose_wakeup(udev, msg);
  1129. return usb_suspend_both(udev, msg);
  1130. }
  1131. /* The device lock is held by the PM core */
  1132. int usb_resume_complete(struct device *dev)
  1133. {
  1134. struct usb_device *udev = to_usb_device(dev);
  1135. /* For PM complete calls, all we do is rebind interfaces
  1136. * whose needs_binding flag is set
  1137. */
  1138. if (udev->state != USB_STATE_NOTATTACHED)
  1139. do_rebind_interfaces(udev);
  1140. return 0;
  1141. }
  1142. /* The device lock is held by the PM core */
  1143. int usb_resume(struct device *dev, pm_message_t msg)
  1144. {
  1145. struct usb_device *udev = to_usb_device(dev);
  1146. int status;
  1147. /* For all calls, take the device back to full power and
  1148. * tell the PM core in case it was autosuspended previously.
  1149. * Unbind the interfaces that will need rebinding later,
  1150. * because they fail to support reset_resume.
  1151. * (This can't be done in usb_resume_interface()
  1152. * above because it doesn't own the right set of locks.)
  1153. */
  1154. status = usb_resume_both(udev, msg);
  1155. if (status == 0) {
  1156. pm_runtime_disable(dev);
  1157. pm_runtime_set_active(dev);
  1158. pm_runtime_enable(dev);
  1159. unbind_no_reset_resume_drivers_interfaces(udev);
  1160. }
  1161. /* Avoid PM error messages for devices disconnected while suspended
  1162. * as we'll display regular disconnect messages just a bit later.
  1163. */
  1164. if (status == -ENODEV || status == -ESHUTDOWN)
  1165. status = 0;
  1166. return status;
  1167. }
  1168. #endif /* CONFIG_PM */
  1169. #ifdef CONFIG_USB_SUSPEND
  1170. /**
  1171. * usb_enable_autosuspend - allow a USB device to be autosuspended
  1172. * @udev: the USB device which may be autosuspended
  1173. *
  1174. * This routine allows @udev to be autosuspended. An autosuspend won't
  1175. * take place until the autosuspend_delay has elapsed and all the other
  1176. * necessary conditions are satisfied.
  1177. *
  1178. * The caller must hold @udev's device lock.
  1179. */
  1180. void usb_enable_autosuspend(struct usb_device *udev)
  1181. {
  1182. pm_runtime_allow(&udev->dev);
  1183. }
  1184. EXPORT_SYMBOL_GPL(usb_enable_autosuspend);
  1185. /**
  1186. * usb_disable_autosuspend - prevent a USB device from being autosuspended
  1187. * @udev: the USB device which may not be autosuspended
  1188. *
  1189. * This routine prevents @udev from being autosuspended and wakes it up
  1190. * if it is already autosuspended.
  1191. *
  1192. * The caller must hold @udev's device lock.
  1193. */
  1194. void usb_disable_autosuspend(struct usb_device *udev)
  1195. {
  1196. pm_runtime_forbid(&udev->dev);
  1197. }
  1198. EXPORT_SYMBOL_GPL(usb_disable_autosuspend);
  1199. /**
  1200. * usb_autosuspend_device - delayed autosuspend of a USB device and its interfaces
  1201. * @udev: the usb_device to autosuspend
  1202. *
  1203. * This routine should be called when a core subsystem is finished using
  1204. * @udev and wants to allow it to autosuspend. Examples would be when
  1205. * @udev's device file in usbfs is closed or after a configuration change.
  1206. *
  1207. * @udev's usage counter is decremented; if it drops to 0 and all the
  1208. * interfaces are inactive then a delayed autosuspend will be attempted.
  1209. * The attempt may fail (see autosuspend_check()).
  1210. *
  1211. * The caller must hold @udev's device lock.
  1212. *
  1213. * This routine can run only in process context.
  1214. */
  1215. void usb_autosuspend_device(struct usb_device *udev)
  1216. {
  1217. int status;
  1218. usb_mark_last_busy(udev);
  1219. status = pm_runtime_put_sync_autosuspend(&udev->dev);
  1220. dev_vdbg(&udev->dev, "%s: cnt %d -> %d\n",
  1221. __func__, atomic_read(&udev->dev.power.usage_count),
  1222. status);
  1223. }
  1224. /**
  1225. * usb_autoresume_device - immediately autoresume a USB device and its interfaces
  1226. * @udev: the usb_device to autoresume
  1227. *
  1228. * This routine should be called when a core subsystem wants to use @udev
  1229. * and needs to guarantee that it is not suspended. No autosuspend will
  1230. * occur until usb_autosuspend_device() is called. (Note that this will
  1231. * not prevent suspend events originating in the PM core.) Examples would
  1232. * be when @udev's device file in usbfs is opened or when a remote-wakeup
  1233. * request is received.
  1234. *
  1235. * @udev's usage counter is incremented to prevent subsequent autosuspends.
  1236. * However if the autoresume fails then the usage counter is re-decremented.
  1237. *
  1238. * The caller must hold @udev's device lock.
  1239. *
  1240. * This routine can run only in process context.
  1241. */
  1242. int usb_autoresume_device(struct usb_device *udev)
  1243. {
  1244. int status;
  1245. status = pm_runtime_get_sync(&udev->dev);
  1246. if (status < 0)
  1247. pm_runtime_put_sync(&udev->dev);
  1248. dev_vdbg(&udev->dev, "%s: cnt %d -> %d\n",
  1249. __func__, atomic_read(&udev->dev.power.usage_count),
  1250. status);
  1251. if (status > 0)
  1252. status = 0;
  1253. return status;
  1254. }
  1255. /**
  1256. * usb_autopm_put_interface - decrement a USB interface's PM-usage counter
  1257. * @intf: the usb_interface whose counter should be decremented
  1258. *
  1259. * This routine should be called by an interface driver when it is
  1260. * finished using @intf and wants to allow it to autosuspend. A typical
  1261. * example would be a character-device driver when its device file is
  1262. * closed.
  1263. *
  1264. * The routine decrements @intf's usage counter. When the counter reaches
  1265. * 0, a delayed autosuspend request for @intf's device is attempted. The
  1266. * attempt may fail (see autosuspend_check()).
  1267. *
  1268. * This routine can run only in process context.
  1269. */
  1270. void usb_autopm_put_interface(struct usb_interface *intf)
  1271. {
  1272. struct usb_device *udev = interface_to_usbdev(intf);
  1273. int status;
  1274. usb_mark_last_busy(udev);
  1275. atomic_dec(&intf->pm_usage_cnt);
  1276. status = pm_runtime_put_sync(&intf->dev);
  1277. dev_vdbg(&intf->dev, "%s: cnt %d -> %d\n",
  1278. __func__, atomic_read(&intf->dev.power.usage_count),
  1279. status);
  1280. }
  1281. EXPORT_SYMBOL_GPL(usb_autopm_put_interface);
  1282. /**
  1283. * usb_autopm_put_interface_async - decrement a USB interface's PM-usage counter
  1284. * @intf: the usb_interface whose counter should be decremented
  1285. *
  1286. * This routine does much the same thing as usb_autopm_put_interface():
  1287. * It decrements @intf's usage counter and schedules a delayed
  1288. * autosuspend request if the counter is <= 0. The difference is that it
  1289. * does not perform any synchronization; callers should hold a private
  1290. * lock and handle all synchronization issues themselves.
  1291. *
  1292. * Typically a driver would call this routine during an URB's completion
  1293. * handler, if no more URBs were pending.
  1294. *
  1295. * This routine can run in atomic context.
  1296. */
  1297. void usb_autopm_put_interface_async(struct usb_interface *intf)
  1298. {
  1299. struct usb_device *udev = interface_to_usbdev(intf);
  1300. int status;
  1301. usb_mark_last_busy(udev);
  1302. atomic_dec(&intf->pm_usage_cnt);
  1303. status = pm_runtime_put(&intf->dev);
  1304. dev_vdbg(&intf->dev, "%s: cnt %d -> %d\n",
  1305. __func__, atomic_read(&intf->dev.power.usage_count),
  1306. status);
  1307. }
  1308. EXPORT_SYMBOL_GPL(usb_autopm_put_interface_async);
  1309. /**
  1310. * usb_autopm_put_interface_no_suspend - decrement a USB interface's PM-usage counter
  1311. * @intf: the usb_interface whose counter should be decremented
  1312. *
  1313. * This routine decrements @intf's usage counter but does not carry out an
  1314. * autosuspend.
  1315. *
  1316. * This routine can run in atomic context.
  1317. */
  1318. void usb_autopm_put_interface_no_suspend(struct usb_interface *intf)
  1319. {
  1320. struct usb_device *udev = interface_to_usbdev(intf);
  1321. usb_mark_last_busy(udev);
  1322. atomic_dec(&intf->pm_usage_cnt);
  1323. pm_runtime_put_noidle(&intf->dev);
  1324. }
  1325. EXPORT_SYMBOL_GPL(usb_autopm_put_interface_no_suspend);
  1326. /**
  1327. * usb_autopm_get_interface - increment a USB interface's PM-usage counter
  1328. * @intf: the usb_interface whose counter should be incremented
  1329. *
  1330. * This routine should be called by an interface driver when it wants to
  1331. * use @intf and needs to guarantee that it is not suspended. In addition,
  1332. * the routine prevents @intf from being autosuspended subsequently. (Note
  1333. * that this will not prevent suspend events originating in the PM core.)
  1334. * This prevention will persist until usb_autopm_put_interface() is called
  1335. * or @intf is unbound. A typical example would be a character-device
  1336. * driver when its device file is opened.
  1337. *
  1338. * @intf's usage counter is incremented to prevent subsequent autosuspends.
  1339. * However if the autoresume fails then the counter is re-decremented.
  1340. *
  1341. * This routine can run only in process context.
  1342. */
  1343. int usb_autopm_get_interface(struct usb_interface *intf)
  1344. {
  1345. int status;
  1346. status = pm_runtime_get_sync(&intf->dev);
  1347. if (status < 0)
  1348. pm_runtime_put_sync(&intf->dev);
  1349. else
  1350. atomic_inc(&intf->pm_usage_cnt);
  1351. dev_vdbg(&intf->dev, "%s: cnt %d -> %d\n",
  1352. __func__, atomic_read(&intf->dev.power.usage_count),
  1353. status);
  1354. if (status > 0)
  1355. status = 0;
  1356. return status;
  1357. }
  1358. EXPORT_SYMBOL_GPL(usb_autopm_get_interface);
  1359. /**
  1360. * usb_autopm_get_interface_async - increment a USB interface's PM-usage counter
  1361. * @intf: the usb_interface whose counter should be incremented
  1362. *
  1363. * This routine does much the same thing as
  1364. * usb_autopm_get_interface(): It increments @intf's usage counter and
  1365. * queues an autoresume request if the device is suspended. The
  1366. * differences are that it does not perform any synchronization (callers
  1367. * should hold a private lock and handle all synchronization issues
  1368. * themselves), and it does not autoresume the device directly (it only
  1369. * queues a request). After a successful call, the device may not yet be
  1370. * resumed.
  1371. *
  1372. * This routine can run in atomic context.
  1373. */
  1374. int usb_autopm_get_interface_async(struct usb_interface *intf)
  1375. {
  1376. int status;
  1377. status = pm_runtime_get(&intf->dev);
  1378. if (status < 0 && status != -EINPROGRESS)
  1379. pm_runtime_put_noidle(&intf->dev);
  1380. else
  1381. atomic_inc(&intf->pm_usage_cnt);
  1382. dev_vdbg(&intf->dev, "%s: cnt %d -> %d\n",
  1383. __func__, atomic_read(&intf->dev.power.usage_count),
  1384. status);
  1385. if (status > 0 || status == -EINPROGRESS)
  1386. status = 0;
  1387. return status;
  1388. }
  1389. EXPORT_SYMBOL_GPL(usb_autopm_get_interface_async);
  1390. /**
  1391. * usb_autopm_get_interface_no_resume - increment a USB interface's PM-usage counter
  1392. * @intf: the usb_interface whose counter should be incremented
  1393. *
  1394. * This routine increments @intf's usage counter but does not carry out an
  1395. * autoresume.
  1396. *
  1397. * This routine can run in atomic context.
  1398. */
  1399. void usb_autopm_get_interface_no_resume(struct usb_interface *intf)
  1400. {
  1401. struct usb_device *udev = interface_to_usbdev(intf);
  1402. usb_mark_last_busy(udev);
  1403. atomic_inc(&intf->pm_usage_cnt);
  1404. pm_runtime_get_noresume(&intf->dev);
  1405. }
  1406. EXPORT_SYMBOL_GPL(usb_autopm_get_interface_no_resume);
  1407. /* Internal routine to check whether we may autosuspend a device. */
  1408. static int autosuspend_check(struct usb_device *udev)
  1409. {
  1410. int w, i;
  1411. struct usb_interface *intf;
  1412. /* Fail if autosuspend is disabled, or any interfaces are in use, or
  1413. * any interface drivers require remote wakeup but it isn't available.
  1414. */
  1415. w = 0;
  1416. if (udev->actconfig) {
  1417. for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
  1418. intf = udev->actconfig->interface[i];
  1419. /* We don't need to check interfaces that are
  1420. * disabled for runtime PM. Either they are unbound
  1421. * or else their drivers don't support autosuspend
  1422. * and so they are permanently active.
  1423. */
  1424. if (intf->dev.power.disable_depth)
  1425. continue;
  1426. if (atomic_read(&intf->dev.power.usage_count) > 0)
  1427. return -EBUSY;
  1428. w |= intf->needs_remote_wakeup;
  1429. /* Don't allow autosuspend if the device will need
  1430. * a reset-resume and any of its interface drivers
  1431. * doesn't include support or needs remote wakeup.
  1432. */
  1433. if (udev->quirks & USB_QUIRK_RESET_RESUME) {
  1434. struct usb_driver *driver;
  1435. driver = to_usb_driver(intf->dev.driver);
  1436. if (!driver->reset_resume ||
  1437. intf->needs_remote_wakeup)
  1438. return -EOPNOTSUPP;
  1439. }
  1440. }
  1441. }
  1442. if (w && !device_can_wakeup(&udev->dev)) {
  1443. dev_dbg(&udev->dev, "remote wakeup needed for autosuspend\n");
  1444. return -EOPNOTSUPP;
  1445. }
  1446. udev->do_remote_wakeup = w;
  1447. return 0;
  1448. }
  1449. int usb_runtime_suspend(struct device *dev)
  1450. {
  1451. struct usb_device *udev = to_usb_device(dev);
  1452. int status;
  1453. /* A USB device can be suspended if it passes the various autosuspend
  1454. * checks. Runtime suspend for a USB device means suspending all the
  1455. * interfaces and then the device itself.
  1456. */
  1457. if (autosuspend_check(udev) != 0)
  1458. return -EAGAIN;
  1459. status = usb_suspend_both(udev, PMSG_AUTO_SUSPEND);
  1460. /* Allow a retry if autosuspend failed temporarily */
  1461. if (status == -EAGAIN || status == -EBUSY)
  1462. usb_mark_last_busy(udev);
  1463. /* The PM core reacts badly unless the return code is 0,
  1464. * -EAGAIN, or -EBUSY, so always return -EBUSY on an error.
  1465. */
  1466. if (status != 0)
  1467. return -EBUSY;
  1468. return status;
  1469. }
  1470. int usb_runtime_resume(struct device *dev)
  1471. {
  1472. struct usb_device *udev = to_usb_device(dev);
  1473. int status;
  1474. /* Runtime resume for a USB device means resuming both the device
  1475. * and all its interfaces.
  1476. */
  1477. status = usb_resume_both(udev, PMSG_AUTO_RESUME);
  1478. return status;
  1479. }
  1480. int usb_runtime_idle(struct device *dev)
  1481. {
  1482. struct usb_device *udev = to_usb_device(dev);
  1483. /* An idle USB device can be suspended if it passes the various
  1484. * autosuspend checks.
  1485. */
  1486. if (autosuspend_check(udev) == 0)
  1487. pm_runtime_autosuspend(dev);
  1488. return 0;
  1489. }
  1490. int usb_set_usb2_hardware_lpm(struct usb_device *udev, int enable)
  1491. {
  1492. struct usb_hcd *hcd = bus_to_hcd(udev->bus);
  1493. int ret = -EPERM;
  1494. if (hcd->driver->set_usb2_hw_lpm) {
  1495. ret = hcd->driver->set_usb2_hw_lpm(hcd, udev, enable);
  1496. if (!ret)
  1497. udev->usb2_hw_lpm_enabled = enable;
  1498. }
  1499. return ret;
  1500. }
  1501. #endif /* CONFIG_USB_SUSPEND */
  1502. struct bus_type usb_bus_type = {
  1503. .name = "usb",
  1504. .match = usb_device_match,
  1505. .uevent = usb_uevent,
  1506. };