usb.c 46 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573
  1. /*
  2. * drivers/usb/usb.c
  3. *
  4. * (C) Copyright Linus Torvalds 1999
  5. * (C) Copyright Johannes Erdfelt 1999-2001
  6. * (C) Copyright Andreas Gal 1999
  7. * (C) Copyright Gregory P. Smith 1999
  8. * (C) Copyright Deti Fliegl 1999 (new USB architecture)
  9. * (C) Copyright Randy Dunlap 2000
  10. * (C) Copyright David Brownell 2000-2004
  11. * (C) Copyright Yggdrasil Computing, Inc. 2000
  12. * (usb_device_id matching changes by Adam J. Richter)
  13. * (C) Copyright Greg Kroah-Hartman 2002-2003
  14. *
  15. * NOTE! This is not actually a driver at all, rather this is
  16. * just a collection of helper routines that implement the
  17. * generic USB things that the real drivers can use..
  18. *
  19. * Think of this as a "USB library" rather than anything else.
  20. * It should be considered a slave, with no callbacks. Callbacks
  21. * are evil.
  22. */
  23. #include <linux/config.h>
  24. #ifdef CONFIG_USB_DEBUG
  25. #define DEBUG
  26. #else
  27. #undef DEBUG
  28. #endif
  29. #include <linux/module.h>
  30. #include <linux/string.h>
  31. #include <linux/bitops.h>
  32. #include <linux/slab.h>
  33. #include <linux/interrupt.h> /* for in_interrupt() */
  34. #include <linux/kmod.h>
  35. #include <linux/init.h>
  36. #include <linux/spinlock.h>
  37. #include <linux/errno.h>
  38. #include <linux/smp_lock.h>
  39. #include <linux/rwsem.h>
  40. #include <linux/usb.h>
  41. #include <asm/io.h>
  42. #include <asm/scatterlist.h>
  43. #include <linux/mm.h>
  44. #include <linux/dma-mapping.h>
  45. #include "hcd.h"
  46. #include "usb.h"
  47. extern int usb_hub_init(void);
  48. extern void usb_hub_cleanup(void);
  49. extern int usb_major_init(void);
  50. extern void usb_major_cleanup(void);
  51. extern int usb_host_init(void);
  52. extern void usb_host_cleanup(void);
  53. const char *usbcore_name = "usbcore";
  54. static int nousb; /* Disable USB when built into kernel image */
  55. /* Not honored on modular build */
  56. static DECLARE_RWSEM(usb_all_devices_rwsem);
  57. static int generic_probe (struct device *dev)
  58. {
  59. return 0;
  60. }
  61. static int generic_remove (struct device *dev)
  62. {
  63. return 0;
  64. }
  65. static struct device_driver usb_generic_driver = {
  66. .owner = THIS_MODULE,
  67. .name = "usb",
  68. .bus = &usb_bus_type,
  69. .probe = generic_probe,
  70. .remove = generic_remove,
  71. };
  72. static int usb_generic_driver_data;
  73. /* called from driver core with usb_bus_type.subsys writelock */
  74. static int usb_probe_interface(struct device *dev)
  75. {
  76. struct usb_interface * intf = to_usb_interface(dev);
  77. struct usb_driver * driver = to_usb_driver(dev->driver);
  78. const struct usb_device_id *id;
  79. int error = -ENODEV;
  80. dev_dbg(dev, "%s\n", __FUNCTION__);
  81. if (!driver->probe)
  82. return error;
  83. /* FIXME we'd much prefer to just resume it ... */
  84. if (interface_to_usbdev(intf)->state == USB_STATE_SUSPENDED)
  85. return -EHOSTUNREACH;
  86. id = usb_match_id (intf, driver->id_table);
  87. if (id) {
  88. dev_dbg (dev, "%s - got id\n", __FUNCTION__);
  89. intf->condition = USB_INTERFACE_BINDING;
  90. error = driver->probe (intf, id);
  91. intf->condition = error ? USB_INTERFACE_UNBOUND :
  92. USB_INTERFACE_BOUND;
  93. }
  94. return error;
  95. }
  96. /* called from driver core with usb_bus_type.subsys writelock */
  97. static int usb_unbind_interface(struct device *dev)
  98. {
  99. struct usb_interface *intf = to_usb_interface(dev);
  100. struct usb_driver *driver = to_usb_driver(intf->dev.driver);
  101. intf->condition = USB_INTERFACE_UNBINDING;
  102. /* release all urbs for this interface */
  103. usb_disable_interface(interface_to_usbdev(intf), intf);
  104. if (driver && driver->disconnect)
  105. driver->disconnect(intf);
  106. /* reset other interface state */
  107. usb_set_interface(interface_to_usbdev(intf),
  108. intf->altsetting[0].desc.bInterfaceNumber,
  109. 0);
  110. usb_set_intfdata(intf, NULL);
  111. intf->condition = USB_INTERFACE_UNBOUND;
  112. return 0;
  113. }
  114. /**
  115. * usb_register - register a USB driver
  116. * @new_driver: USB operations for the driver
  117. *
  118. * Registers a USB driver with the USB core. The list of unattached
  119. * interfaces will be rescanned whenever a new driver is added, allowing
  120. * the new driver to attach to any recognized devices.
  121. * Returns a negative error code on failure and 0 on success.
  122. *
  123. * NOTE: if you want your driver to use the USB major number, you must call
  124. * usb_register_dev() to enable that functionality. This function no longer
  125. * takes care of that.
  126. */
  127. int usb_register(struct usb_driver *new_driver)
  128. {
  129. int retval = 0;
  130. if (nousb)
  131. return -ENODEV;
  132. new_driver->driver.name = (char *)new_driver->name;
  133. new_driver->driver.bus = &usb_bus_type;
  134. new_driver->driver.probe = usb_probe_interface;
  135. new_driver->driver.remove = usb_unbind_interface;
  136. new_driver->driver.owner = new_driver->owner;
  137. usb_lock_all_devices();
  138. retval = driver_register(&new_driver->driver);
  139. usb_unlock_all_devices();
  140. if (!retval) {
  141. pr_info("%s: registered new driver %s\n",
  142. usbcore_name, new_driver->name);
  143. usbfs_update_special();
  144. } else {
  145. printk(KERN_ERR "%s: error %d registering driver %s\n",
  146. usbcore_name, retval, new_driver->name);
  147. }
  148. return retval;
  149. }
  150. /**
  151. * usb_deregister - unregister a USB driver
  152. * @driver: USB operations of the driver to unregister
  153. * Context: must be able to sleep
  154. *
  155. * Unlinks the specified driver from the internal USB driver list.
  156. *
  157. * NOTE: If you called usb_register_dev(), you still need to call
  158. * usb_deregister_dev() to clean up your driver's allocated minor numbers,
  159. * this * call will no longer do it for you.
  160. */
  161. void usb_deregister(struct usb_driver *driver)
  162. {
  163. pr_info("%s: deregistering driver %s\n", usbcore_name, driver->name);
  164. usb_lock_all_devices();
  165. driver_unregister (&driver->driver);
  166. usb_unlock_all_devices();
  167. usbfs_update_special();
  168. }
  169. /**
  170. * usb_ifnum_to_if - get the interface object with a given interface number
  171. * @dev: the device whose current configuration is considered
  172. * @ifnum: the desired interface
  173. *
  174. * This walks the device descriptor for the currently active configuration
  175. * and returns a pointer to the interface with that particular interface
  176. * number, or null.
  177. *
  178. * Note that configuration descriptors are not required to assign interface
  179. * numbers sequentially, so that it would be incorrect to assume that
  180. * the first interface in that descriptor corresponds to interface zero.
  181. * This routine helps device drivers avoid such mistakes.
  182. * However, you should make sure that you do the right thing with any
  183. * alternate settings available for this interfaces.
  184. *
  185. * Don't call this function unless you are bound to one of the interfaces
  186. * on this device or you have locked the device!
  187. */
  188. struct usb_interface *usb_ifnum_to_if(struct usb_device *dev, unsigned ifnum)
  189. {
  190. struct usb_host_config *config = dev->actconfig;
  191. int i;
  192. if (!config)
  193. return NULL;
  194. for (i = 0; i < config->desc.bNumInterfaces; i++)
  195. if (config->interface[i]->altsetting[0]
  196. .desc.bInterfaceNumber == ifnum)
  197. return config->interface[i];
  198. return NULL;
  199. }
  200. /**
  201. * usb_altnum_to_altsetting - get the altsetting structure with a given
  202. * alternate setting number.
  203. * @intf: the interface containing the altsetting in question
  204. * @altnum: the desired alternate setting number
  205. *
  206. * This searches the altsetting array of the specified interface for
  207. * an entry with the correct bAlternateSetting value and returns a pointer
  208. * to that entry, or null.
  209. *
  210. * Note that altsettings need not be stored sequentially by number, so
  211. * it would be incorrect to assume that the first altsetting entry in
  212. * the array corresponds to altsetting zero. This routine helps device
  213. * drivers avoid such mistakes.
  214. *
  215. * Don't call this function unless you are bound to the intf interface
  216. * or you have locked the device!
  217. */
  218. struct usb_host_interface *usb_altnum_to_altsetting(struct usb_interface *intf,
  219. unsigned int altnum)
  220. {
  221. int i;
  222. for (i = 0; i < intf->num_altsetting; i++) {
  223. if (intf->altsetting[i].desc.bAlternateSetting == altnum)
  224. return &intf->altsetting[i];
  225. }
  226. return NULL;
  227. }
  228. /**
  229. * usb_driver_claim_interface - bind a driver to an interface
  230. * @driver: the driver to be bound
  231. * @iface: the interface to which it will be bound; must be in the
  232. * usb device's active configuration
  233. * @priv: driver data associated with that interface
  234. *
  235. * This is used by usb device drivers that need to claim more than one
  236. * interface on a device when probing (audio and acm are current examples).
  237. * No device driver should directly modify internal usb_interface or
  238. * usb_device structure members.
  239. *
  240. * Few drivers should need to use this routine, since the most natural
  241. * way to bind to an interface is to return the private data from
  242. * the driver's probe() method.
  243. *
  244. * Callers must own the device lock and the driver model's usb_bus_type.subsys
  245. * writelock. So driver probe() entries don't need extra locking,
  246. * but other call contexts may need to explicitly claim those locks.
  247. */
  248. int usb_driver_claim_interface(struct usb_driver *driver,
  249. struct usb_interface *iface, void* priv)
  250. {
  251. struct device *dev = &iface->dev;
  252. if (dev->driver)
  253. return -EBUSY;
  254. dev->driver = &driver->driver;
  255. usb_set_intfdata(iface, priv);
  256. iface->condition = USB_INTERFACE_BOUND;
  257. /* if interface was already added, bind now; else let
  258. * the future device_add() bind it, bypassing probe()
  259. */
  260. if (!list_empty (&dev->bus_list))
  261. device_bind_driver(dev);
  262. return 0;
  263. }
  264. /**
  265. * usb_driver_release_interface - unbind a driver from an interface
  266. * @driver: the driver to be unbound
  267. * @iface: the interface from which it will be unbound
  268. *
  269. * This can be used by drivers to release an interface without waiting
  270. * for their disconnect() methods to be called. In typical cases this
  271. * also causes the driver disconnect() method to be called.
  272. *
  273. * This call is synchronous, and may not be used in an interrupt context.
  274. * Callers must own the device lock and the driver model's usb_bus_type.subsys
  275. * writelock. So driver disconnect() entries don't need extra locking,
  276. * but other call contexts may need to explicitly claim those locks.
  277. */
  278. void usb_driver_release_interface(struct usb_driver *driver,
  279. struct usb_interface *iface)
  280. {
  281. struct device *dev = &iface->dev;
  282. /* this should never happen, don't release something that's not ours */
  283. if (!dev->driver || dev->driver != &driver->driver)
  284. return;
  285. /* don't disconnect from disconnect(), or before dev_add() */
  286. if (!list_empty (&dev->driver_list) && !list_empty (&dev->bus_list))
  287. device_release_driver(dev);
  288. dev->driver = NULL;
  289. usb_set_intfdata(iface, NULL);
  290. iface->condition = USB_INTERFACE_UNBOUND;
  291. }
  292. /**
  293. * usb_match_id - find first usb_device_id matching device or interface
  294. * @interface: the interface of interest
  295. * @id: array of usb_device_id structures, terminated by zero entry
  296. *
  297. * usb_match_id searches an array of usb_device_id's and returns
  298. * the first one matching the device or interface, or null.
  299. * This is used when binding (or rebinding) a driver to an interface.
  300. * Most USB device drivers will use this indirectly, through the usb core,
  301. * but some layered driver frameworks use it directly.
  302. * These device tables are exported with MODULE_DEVICE_TABLE, through
  303. * modutils and "modules.usbmap", to support the driver loading
  304. * functionality of USB hotplugging.
  305. *
  306. * What Matches:
  307. *
  308. * The "match_flags" element in a usb_device_id controls which
  309. * members are used. If the corresponding bit is set, the
  310. * value in the device_id must match its corresponding member
  311. * in the device or interface descriptor, or else the device_id
  312. * does not match.
  313. *
  314. * "driver_info" is normally used only by device drivers,
  315. * but you can create a wildcard "matches anything" usb_device_id
  316. * as a driver's "modules.usbmap" entry if you provide an id with
  317. * only a nonzero "driver_info" field. If you do this, the USB device
  318. * driver's probe() routine should use additional intelligence to
  319. * decide whether to bind to the specified interface.
  320. *
  321. * What Makes Good usb_device_id Tables:
  322. *
  323. * The match algorithm is very simple, so that intelligence in
  324. * driver selection must come from smart driver id records.
  325. * Unless you have good reasons to use another selection policy,
  326. * provide match elements only in related groups, and order match
  327. * specifiers from specific to general. Use the macros provided
  328. * for that purpose if you can.
  329. *
  330. * The most specific match specifiers use device descriptor
  331. * data. These are commonly used with product-specific matches;
  332. * the USB_DEVICE macro lets you provide vendor and product IDs,
  333. * and you can also match against ranges of product revisions.
  334. * These are widely used for devices with application or vendor
  335. * specific bDeviceClass values.
  336. *
  337. * Matches based on device class/subclass/protocol specifications
  338. * are slightly more general; use the USB_DEVICE_INFO macro, or
  339. * its siblings. These are used with single-function devices
  340. * where bDeviceClass doesn't specify that each interface has
  341. * its own class.
  342. *
  343. * Matches based on interface class/subclass/protocol are the
  344. * most general; they let drivers bind to any interface on a
  345. * multiple-function device. Use the USB_INTERFACE_INFO
  346. * macro, or its siblings, to match class-per-interface style
  347. * devices (as recorded in bDeviceClass).
  348. *
  349. * Within those groups, remember that not all combinations are
  350. * meaningful. For example, don't give a product version range
  351. * without vendor and product IDs; or specify a protocol without
  352. * its associated class and subclass.
  353. */
  354. const struct usb_device_id *
  355. usb_match_id(struct usb_interface *interface, const struct usb_device_id *id)
  356. {
  357. struct usb_host_interface *intf;
  358. struct usb_device *dev;
  359. /* proc_connectinfo in devio.c may call us with id == NULL. */
  360. if (id == NULL)
  361. return NULL;
  362. intf = interface->cur_altsetting;
  363. dev = interface_to_usbdev(interface);
  364. /* It is important to check that id->driver_info is nonzero,
  365. since an entry that is all zeroes except for a nonzero
  366. id->driver_info is the way to create an entry that
  367. indicates that the driver want to examine every
  368. device and interface. */
  369. for (; id->idVendor || id->bDeviceClass || id->bInterfaceClass ||
  370. id->driver_info; id++) {
  371. if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
  372. id->idVendor != le16_to_cpu(dev->descriptor.idVendor))
  373. continue;
  374. if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) &&
  375. id->idProduct != le16_to_cpu(dev->descriptor.idProduct))
  376. continue;
  377. /* No need to test id->bcdDevice_lo != 0, since 0 is never
  378. greater than any unsigned number. */
  379. if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO) &&
  380. (id->bcdDevice_lo > le16_to_cpu(dev->descriptor.bcdDevice)))
  381. continue;
  382. if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) &&
  383. (id->bcdDevice_hi < le16_to_cpu(dev->descriptor.bcdDevice)))
  384. continue;
  385. if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) &&
  386. (id->bDeviceClass != dev->descriptor.bDeviceClass))
  387. continue;
  388. if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) &&
  389. (id->bDeviceSubClass!= dev->descriptor.bDeviceSubClass))
  390. continue;
  391. if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) &&
  392. (id->bDeviceProtocol != dev->descriptor.bDeviceProtocol))
  393. continue;
  394. if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) &&
  395. (id->bInterfaceClass != intf->desc.bInterfaceClass))
  396. continue;
  397. if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) &&
  398. (id->bInterfaceSubClass != intf->desc.bInterfaceSubClass))
  399. continue;
  400. if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) &&
  401. (id->bInterfaceProtocol != intf->desc.bInterfaceProtocol))
  402. continue;
  403. return id;
  404. }
  405. return NULL;
  406. }
  407. /**
  408. * usb_find_interface - find usb_interface pointer for driver and device
  409. * @drv: the driver whose current configuration is considered
  410. * @minor: the minor number of the desired device
  411. *
  412. * This walks the driver device list and returns a pointer to the interface
  413. * with the matching minor. Note, this only works for devices that share the
  414. * USB major number.
  415. */
  416. struct usb_interface *usb_find_interface(struct usb_driver *drv, int minor)
  417. {
  418. struct list_head *entry;
  419. struct device *dev;
  420. struct usb_interface *intf;
  421. list_for_each(entry, &drv->driver.devices) {
  422. dev = container_of(entry, struct device, driver_list);
  423. /* can't look at usb devices, only interfaces */
  424. if (dev->driver == &usb_generic_driver)
  425. continue;
  426. intf = to_usb_interface(dev);
  427. if (intf->minor == -1)
  428. continue;
  429. if (intf->minor == minor)
  430. return intf;
  431. }
  432. /* no device found that matches */
  433. return NULL;
  434. }
  435. static int usb_device_match (struct device *dev, struct device_driver *drv)
  436. {
  437. struct usb_interface *intf;
  438. struct usb_driver *usb_drv;
  439. const struct usb_device_id *id;
  440. /* check for generic driver, which we don't match any device with */
  441. if (drv == &usb_generic_driver)
  442. return 0;
  443. intf = to_usb_interface(dev);
  444. usb_drv = to_usb_driver(drv);
  445. id = usb_match_id (intf, usb_drv->id_table);
  446. if (id)
  447. return 1;
  448. return 0;
  449. }
  450. #ifdef CONFIG_HOTPLUG
  451. /*
  452. * USB hotplugging invokes what /proc/sys/kernel/hotplug says
  453. * (normally /sbin/hotplug) when USB devices get added or removed.
  454. *
  455. * This invokes a user mode policy agent, typically helping to load driver
  456. * or other modules, configure the device, and more. Drivers can provide
  457. * a MODULE_DEVICE_TABLE to help with module loading subtasks.
  458. *
  459. * We're called either from khubd (the typical case) or from root hub
  460. * (init, kapmd, modprobe, rmmod, etc), but the agents need to handle
  461. * delays in event delivery. Use sysfs (and DEVPATH) to make sure the
  462. * device (and this configuration!) are still present.
  463. */
  464. static int usb_hotplug (struct device *dev, char **envp, int num_envp,
  465. char *buffer, int buffer_size)
  466. {
  467. struct usb_interface *intf;
  468. struct usb_device *usb_dev;
  469. int i = 0;
  470. int length = 0;
  471. if (!dev)
  472. return -ENODEV;
  473. /* driver is often null here; dev_dbg() would oops */
  474. pr_debug ("usb %s: hotplug\n", dev->bus_id);
  475. /* Must check driver_data here, as on remove driver is always NULL */
  476. if ((dev->driver == &usb_generic_driver) ||
  477. (dev->driver_data == &usb_generic_driver_data))
  478. return 0;
  479. intf = to_usb_interface(dev);
  480. usb_dev = interface_to_usbdev (intf);
  481. if (usb_dev->devnum < 0) {
  482. pr_debug ("usb %s: already deleted?\n", dev->bus_id);
  483. return -ENODEV;
  484. }
  485. if (!usb_dev->bus) {
  486. pr_debug ("usb %s: bus removed?\n", dev->bus_id);
  487. return -ENODEV;
  488. }
  489. #ifdef CONFIG_USB_DEVICEFS
  490. /* If this is available, userspace programs can directly read
  491. * all the device descriptors we don't tell them about. Or
  492. * even act as usermode drivers.
  493. *
  494. * FIXME reduce hardwired intelligence here
  495. */
  496. if (add_hotplug_env_var(envp, num_envp, &i,
  497. buffer, buffer_size, &length,
  498. "DEVICE=/proc/bus/usb/%03d/%03d",
  499. usb_dev->bus->busnum, usb_dev->devnum))
  500. return -ENOMEM;
  501. #endif
  502. /* per-device configurations are common */
  503. if (add_hotplug_env_var(envp, num_envp, &i,
  504. buffer, buffer_size, &length,
  505. "PRODUCT=%x/%x/%x",
  506. le16_to_cpu(usb_dev->descriptor.idVendor),
  507. le16_to_cpu(usb_dev->descriptor.idProduct),
  508. le16_to_cpu(usb_dev->descriptor.bcdDevice)))
  509. return -ENOMEM;
  510. /* class-based driver binding models */
  511. if (add_hotplug_env_var(envp, num_envp, &i,
  512. buffer, buffer_size, &length,
  513. "TYPE=%d/%d/%d",
  514. usb_dev->descriptor.bDeviceClass,
  515. usb_dev->descriptor.bDeviceSubClass,
  516. usb_dev->descriptor.bDeviceProtocol))
  517. return -ENOMEM;
  518. if (usb_dev->descriptor.bDeviceClass == 0) {
  519. struct usb_host_interface *alt = intf->cur_altsetting;
  520. /* 2.4 only exposed interface zero. in 2.5, hotplug
  521. * agents are called for all interfaces, and can use
  522. * $DEVPATH/bInterfaceNumber if necessary.
  523. */
  524. if (add_hotplug_env_var(envp, num_envp, &i,
  525. buffer, buffer_size, &length,
  526. "INTERFACE=%d/%d/%d",
  527. alt->desc.bInterfaceClass,
  528. alt->desc.bInterfaceSubClass,
  529. alt->desc.bInterfaceProtocol))
  530. return -ENOMEM;
  531. if (add_hotplug_env_var(envp, num_envp, &i,
  532. buffer, buffer_size, &length,
  533. "MODALIAS=usb:v%04Xp%04Xdl%04Xdh%04Xdc%02Xdsc%02Xdp%02Xic%02Xisc%02Xip%02X",
  534. le16_to_cpu(usb_dev->descriptor.idVendor),
  535. le16_to_cpu(usb_dev->descriptor.idProduct),
  536. le16_to_cpu(usb_dev->descriptor.bcdDevice),
  537. le16_to_cpu(usb_dev->descriptor.bcdDevice),
  538. usb_dev->descriptor.bDeviceClass,
  539. usb_dev->descriptor.bDeviceSubClass,
  540. usb_dev->descriptor.bDeviceProtocol,
  541. alt->desc.bInterfaceClass,
  542. alt->desc.bInterfaceSubClass,
  543. alt->desc.bInterfaceProtocol))
  544. return -ENOMEM;
  545. } else {
  546. if (add_hotplug_env_var(envp, num_envp, &i,
  547. buffer, buffer_size, &length,
  548. "MODALIAS=usb:v%04Xp%04Xdl%04Xdh%04Xdc%02Xdsc%02Xdp%02Xic*isc*ip*",
  549. le16_to_cpu(usb_dev->descriptor.idVendor),
  550. le16_to_cpu(usb_dev->descriptor.idProduct),
  551. le16_to_cpu(usb_dev->descriptor.bcdDevice),
  552. le16_to_cpu(usb_dev->descriptor.bcdDevice),
  553. usb_dev->descriptor.bDeviceClass,
  554. usb_dev->descriptor.bDeviceSubClass,
  555. usb_dev->descriptor.bDeviceProtocol))
  556. return -ENOMEM;
  557. }
  558. envp[i] = NULL;
  559. return 0;
  560. }
  561. #else
  562. static int usb_hotplug (struct device *dev, char **envp,
  563. int num_envp, char *buffer, int buffer_size)
  564. {
  565. return -ENODEV;
  566. }
  567. #endif /* CONFIG_HOTPLUG */
  568. /**
  569. * usb_release_dev - free a usb device structure when all users of it are finished.
  570. * @dev: device that's been disconnected
  571. *
  572. * Will be called only by the device core when all users of this usb device are
  573. * done.
  574. */
  575. static void usb_release_dev(struct device *dev)
  576. {
  577. struct usb_device *udev;
  578. udev = to_usb_device(dev);
  579. usb_destroy_configuration(udev);
  580. usb_bus_put(udev->bus);
  581. kfree(udev->product);
  582. kfree(udev->manufacturer);
  583. kfree(udev->serial);
  584. kfree(udev);
  585. }
  586. /**
  587. * usb_alloc_dev - usb device constructor (usbcore-internal)
  588. * @parent: hub to which device is connected; null to allocate a root hub
  589. * @bus: bus used to access the device
  590. * @port1: one-based index of port; ignored for root hubs
  591. * Context: !in_interrupt ()
  592. *
  593. * Only hub drivers (including virtual root hub drivers for host
  594. * controllers) should ever call this.
  595. *
  596. * This call may not be used in a non-sleeping context.
  597. */
  598. struct usb_device *
  599. usb_alloc_dev(struct usb_device *parent, struct usb_bus *bus, unsigned port1)
  600. {
  601. struct usb_device *dev;
  602. dev = kmalloc(sizeof(*dev), GFP_KERNEL);
  603. if (!dev)
  604. return NULL;
  605. memset(dev, 0, sizeof(*dev));
  606. bus = usb_bus_get(bus);
  607. if (!bus) {
  608. kfree(dev);
  609. return NULL;
  610. }
  611. device_initialize(&dev->dev);
  612. dev->dev.bus = &usb_bus_type;
  613. dev->dev.dma_mask = bus->controller->dma_mask;
  614. dev->dev.driver_data = &usb_generic_driver_data;
  615. dev->dev.driver = &usb_generic_driver;
  616. dev->dev.release = usb_release_dev;
  617. dev->state = USB_STATE_ATTACHED;
  618. INIT_LIST_HEAD(&dev->ep0.urb_list);
  619. dev->ep0.desc.bLength = USB_DT_ENDPOINT_SIZE;
  620. dev->ep0.desc.bDescriptorType = USB_DT_ENDPOINT;
  621. /* ep0 maxpacket comes later, from device descriptor */
  622. dev->ep_in[0] = dev->ep_out[0] = &dev->ep0;
  623. /* Save readable and stable topology id, distinguishing devices
  624. * by location for diagnostics, tools, driver model, etc. The
  625. * string is a path along hub ports, from the root. Each device's
  626. * dev->devpath will be stable until USB is re-cabled, and hubs
  627. * are often labeled with these port numbers. The bus_id isn't
  628. * as stable: bus->busnum changes easily from modprobe order,
  629. * cardbus or pci hotplugging, and so on.
  630. */
  631. if (unlikely (!parent)) {
  632. dev->devpath [0] = '0';
  633. dev->dev.parent = bus->controller;
  634. sprintf (&dev->dev.bus_id[0], "usb%d", bus->busnum);
  635. } else {
  636. /* match any labeling on the hubs; it's one-based */
  637. if (parent->devpath [0] == '0')
  638. snprintf (dev->devpath, sizeof dev->devpath,
  639. "%d", port1);
  640. else
  641. snprintf (dev->devpath, sizeof dev->devpath,
  642. "%s.%d", parent->devpath, port1);
  643. dev->dev.parent = &parent->dev;
  644. sprintf (&dev->dev.bus_id[0], "%d-%s",
  645. bus->busnum, dev->devpath);
  646. /* hub driver sets up TT records */
  647. }
  648. dev->bus = bus;
  649. dev->parent = parent;
  650. INIT_LIST_HEAD(&dev->filelist);
  651. init_MUTEX(&dev->serialize);
  652. return dev;
  653. }
  654. /**
  655. * usb_get_dev - increments the reference count of the usb device structure
  656. * @dev: the device being referenced
  657. *
  658. * Each live reference to a device should be refcounted.
  659. *
  660. * Drivers for USB interfaces should normally record such references in
  661. * their probe() methods, when they bind to an interface, and release
  662. * them by calling usb_put_dev(), in their disconnect() methods.
  663. *
  664. * A pointer to the device with the incremented reference counter is returned.
  665. */
  666. struct usb_device *usb_get_dev(struct usb_device *dev)
  667. {
  668. if (dev)
  669. get_device(&dev->dev);
  670. return dev;
  671. }
  672. /**
  673. * usb_put_dev - release a use of the usb device structure
  674. * @dev: device that's been disconnected
  675. *
  676. * Must be called when a user of a device is finished with it. When the last
  677. * user of the device calls this function, the memory of the device is freed.
  678. */
  679. void usb_put_dev(struct usb_device *dev)
  680. {
  681. if (dev)
  682. put_device(&dev->dev);
  683. }
  684. /**
  685. * usb_get_intf - increments the reference count of the usb interface structure
  686. * @intf: the interface being referenced
  687. *
  688. * Each live reference to a interface must be refcounted.
  689. *
  690. * Drivers for USB interfaces should normally record such references in
  691. * their probe() methods, when they bind to an interface, and release
  692. * them by calling usb_put_intf(), in their disconnect() methods.
  693. *
  694. * A pointer to the interface with the incremented reference counter is
  695. * returned.
  696. */
  697. struct usb_interface *usb_get_intf(struct usb_interface *intf)
  698. {
  699. if (intf)
  700. get_device(&intf->dev);
  701. return intf;
  702. }
  703. /**
  704. * usb_put_intf - release a use of the usb interface structure
  705. * @intf: interface that's been decremented
  706. *
  707. * Must be called when a user of an interface is finished with it. When the
  708. * last user of the interface calls this function, the memory of the interface
  709. * is freed.
  710. */
  711. void usb_put_intf(struct usb_interface *intf)
  712. {
  713. if (intf)
  714. put_device(&intf->dev);
  715. }
  716. /* USB device locking
  717. *
  718. * Although locking USB devices should be straightforward, it is
  719. * complicated by the way the driver-model core works. When a new USB
  720. * driver is registered or unregistered, the core will automatically
  721. * probe or disconnect all matching interfaces on all USB devices while
  722. * holding the USB subsystem writelock. There's no good way for us to
  723. * tell which devices will be used or to lock them beforehand; our only
  724. * option is to effectively lock all the USB devices.
  725. *
  726. * We do that by using a private rw-semaphore, usb_all_devices_rwsem.
  727. * When locking an individual device you must first acquire the rwsem's
  728. * readlock. When a driver is registered or unregistered the writelock
  729. * must be held. These actions are encapsulated in the subroutines
  730. * below, so all a driver needs to do is call usb_lock_device() and
  731. * usb_unlock_device().
  732. *
  733. * Complications arise when several devices are to be locked at the same
  734. * time. Only hub-aware drivers that are part of usbcore ever have to
  735. * do this; nobody else needs to worry about it. The problem is that
  736. * usb_lock_device() must not be called to lock a second device since it
  737. * would acquire the rwsem's readlock reentrantly, leading to deadlock if
  738. * another thread was waiting for the writelock. The solution is simple:
  739. *
  740. * When locking more than one device, call usb_lock_device()
  741. * to lock the first one. Lock the others by calling
  742. * down(&udev->serialize) directly.
  743. *
  744. * When unlocking multiple devices, use up(&udev->serialize)
  745. * to unlock all but the last one. Unlock the last one by
  746. * calling usb_unlock_device().
  747. *
  748. * When locking both a device and its parent, always lock the
  749. * the parent first.
  750. */
  751. /**
  752. * usb_lock_device - acquire the lock for a usb device structure
  753. * @udev: device that's being locked
  754. *
  755. * Use this routine when you don't hold any other device locks;
  756. * to acquire nested inner locks call down(&udev->serialize) directly.
  757. * This is necessary for proper interaction with usb_lock_all_devices().
  758. */
  759. void usb_lock_device(struct usb_device *udev)
  760. {
  761. down_read(&usb_all_devices_rwsem);
  762. down(&udev->serialize);
  763. }
  764. /**
  765. * usb_trylock_device - attempt to acquire the lock for a usb device structure
  766. * @udev: device that's being locked
  767. *
  768. * Don't use this routine if you already hold a device lock;
  769. * use down_trylock(&udev->serialize) instead.
  770. * This is necessary for proper interaction with usb_lock_all_devices().
  771. *
  772. * Returns 1 if successful, 0 if contention.
  773. */
  774. int usb_trylock_device(struct usb_device *udev)
  775. {
  776. if (!down_read_trylock(&usb_all_devices_rwsem))
  777. return 0;
  778. if (down_trylock(&udev->serialize)) {
  779. up_read(&usb_all_devices_rwsem);
  780. return 0;
  781. }
  782. return 1;
  783. }
  784. /**
  785. * usb_lock_device_for_reset - cautiously acquire the lock for a
  786. * usb device structure
  787. * @udev: device that's being locked
  788. * @iface: interface bound to the driver making the request (optional)
  789. *
  790. * Attempts to acquire the device lock, but fails if the device is
  791. * NOTATTACHED or SUSPENDED, or if iface is specified and the interface
  792. * is neither BINDING nor BOUND. Rather than sleeping to wait for the
  793. * lock, the routine polls repeatedly. This is to prevent deadlock with
  794. * disconnect; in some drivers (such as usb-storage) the disconnect()
  795. * callback will block waiting for a device reset to complete.
  796. *
  797. * Returns a negative error code for failure, otherwise 1 or 0 to indicate
  798. * that the device will or will not have to be unlocked. (0 can be
  799. * returned when an interface is given and is BINDING, because in that
  800. * case the driver already owns the device lock.)
  801. */
  802. int usb_lock_device_for_reset(struct usb_device *udev,
  803. struct usb_interface *iface)
  804. {
  805. if (udev->state == USB_STATE_NOTATTACHED)
  806. return -ENODEV;
  807. if (udev->state == USB_STATE_SUSPENDED)
  808. return -EHOSTUNREACH;
  809. if (iface) {
  810. switch (iface->condition) {
  811. case USB_INTERFACE_BINDING:
  812. return 0;
  813. case USB_INTERFACE_BOUND:
  814. break;
  815. default:
  816. return -EINTR;
  817. }
  818. }
  819. while (!usb_trylock_device(udev)) {
  820. msleep(15);
  821. if (udev->state == USB_STATE_NOTATTACHED)
  822. return -ENODEV;
  823. if (udev->state == USB_STATE_SUSPENDED)
  824. return -EHOSTUNREACH;
  825. if (iface && iface->condition != USB_INTERFACE_BOUND)
  826. return -EINTR;
  827. }
  828. return 1;
  829. }
  830. /**
  831. * usb_unlock_device - release the lock for a usb device structure
  832. * @udev: device that's being unlocked
  833. *
  834. * Use this routine when releasing the only device lock you hold;
  835. * to release inner nested locks call up(&udev->serialize) directly.
  836. * This is necessary for proper interaction with usb_lock_all_devices().
  837. */
  838. void usb_unlock_device(struct usb_device *udev)
  839. {
  840. up(&udev->serialize);
  841. up_read(&usb_all_devices_rwsem);
  842. }
  843. /**
  844. * usb_lock_all_devices - acquire the lock for all usb device structures
  845. *
  846. * This is necessary when registering a new driver or probing a bus,
  847. * since the driver-model core may try to use any usb_device.
  848. */
  849. void usb_lock_all_devices(void)
  850. {
  851. down_write(&usb_all_devices_rwsem);
  852. }
  853. /**
  854. * usb_unlock_all_devices - release the lock for all usb device structures
  855. */
  856. void usb_unlock_all_devices(void)
  857. {
  858. up_write(&usb_all_devices_rwsem);
  859. }
  860. static struct usb_device *match_device(struct usb_device *dev,
  861. u16 vendor_id, u16 product_id)
  862. {
  863. struct usb_device *ret_dev = NULL;
  864. int child;
  865. dev_dbg(&dev->dev, "check for vendor %04x, product %04x ...\n",
  866. le16_to_cpu(dev->descriptor.idVendor),
  867. le16_to_cpu(dev->descriptor.idProduct));
  868. /* see if this device matches */
  869. if ((vendor_id == le16_to_cpu(dev->descriptor.idVendor)) &&
  870. (product_id == le16_to_cpu(dev->descriptor.idProduct))) {
  871. dev_dbg (&dev->dev, "matched this device!\n");
  872. ret_dev = usb_get_dev(dev);
  873. goto exit;
  874. }
  875. /* look through all of the children of this device */
  876. for (child = 0; child < dev->maxchild; ++child) {
  877. if (dev->children[child]) {
  878. down(&dev->children[child]->serialize);
  879. ret_dev = match_device(dev->children[child],
  880. vendor_id, product_id);
  881. up(&dev->children[child]->serialize);
  882. if (ret_dev)
  883. goto exit;
  884. }
  885. }
  886. exit:
  887. return ret_dev;
  888. }
  889. /**
  890. * usb_find_device - find a specific usb device in the system
  891. * @vendor_id: the vendor id of the device to find
  892. * @product_id: the product id of the device to find
  893. *
  894. * Returns a pointer to a struct usb_device if such a specified usb
  895. * device is present in the system currently. The usage count of the
  896. * device will be incremented if a device is found. Make sure to call
  897. * usb_put_dev() when the caller is finished with the device.
  898. *
  899. * If a device with the specified vendor and product id is not found,
  900. * NULL is returned.
  901. */
  902. struct usb_device *usb_find_device(u16 vendor_id, u16 product_id)
  903. {
  904. struct list_head *buslist;
  905. struct usb_bus *bus;
  906. struct usb_device *dev = NULL;
  907. down(&usb_bus_list_lock);
  908. for (buslist = usb_bus_list.next;
  909. buslist != &usb_bus_list;
  910. buslist = buslist->next) {
  911. bus = container_of(buslist, struct usb_bus, bus_list);
  912. if (!bus->root_hub)
  913. continue;
  914. usb_lock_device(bus->root_hub);
  915. dev = match_device(bus->root_hub, vendor_id, product_id);
  916. usb_unlock_device(bus->root_hub);
  917. if (dev)
  918. goto exit;
  919. }
  920. exit:
  921. up(&usb_bus_list_lock);
  922. return dev;
  923. }
  924. /**
  925. * usb_get_current_frame_number - return current bus frame number
  926. * @dev: the device whose bus is being queried
  927. *
  928. * Returns the current frame number for the USB host controller
  929. * used with the given USB device. This can be used when scheduling
  930. * isochronous requests.
  931. *
  932. * Note that different kinds of host controller have different
  933. * "scheduling horizons". While one type might support scheduling only
  934. * 32 frames into the future, others could support scheduling up to
  935. * 1024 frames into the future.
  936. */
  937. int usb_get_current_frame_number(struct usb_device *dev)
  938. {
  939. return dev->bus->op->get_frame_number (dev);
  940. }
  941. /*-------------------------------------------------------------------*/
  942. /*
  943. * __usb_get_extra_descriptor() finds a descriptor of specific type in the
  944. * extra field of the interface and endpoint descriptor structs.
  945. */
  946. int __usb_get_extra_descriptor(char *buffer, unsigned size,
  947. unsigned char type, void **ptr)
  948. {
  949. struct usb_descriptor_header *header;
  950. while (size >= sizeof(struct usb_descriptor_header)) {
  951. header = (struct usb_descriptor_header *)buffer;
  952. if (header->bLength < 2) {
  953. printk(KERN_ERR
  954. "%s: bogus descriptor, type %d length %d\n",
  955. usbcore_name,
  956. header->bDescriptorType,
  957. header->bLength);
  958. return -1;
  959. }
  960. if (header->bDescriptorType == type) {
  961. *ptr = header;
  962. return 0;
  963. }
  964. buffer += header->bLength;
  965. size -= header->bLength;
  966. }
  967. return -1;
  968. }
  969. /**
  970. * usb_buffer_alloc - allocate dma-consistent buffer for URB_NO_xxx_DMA_MAP
  971. * @dev: device the buffer will be used with
  972. * @size: requested buffer size
  973. * @mem_flags: affect whether allocation may block
  974. * @dma: used to return DMA address of buffer
  975. *
  976. * Return value is either null (indicating no buffer could be allocated), or
  977. * the cpu-space pointer to a buffer that may be used to perform DMA to the
  978. * specified device. Such cpu-space buffers are returned along with the DMA
  979. * address (through the pointer provided).
  980. *
  981. * These buffers are used with URB_NO_xxx_DMA_MAP set in urb->transfer_flags
  982. * to avoid behaviors like using "DMA bounce buffers", or tying down I/O
  983. * mapping hardware for long idle periods. The implementation varies between
  984. * platforms, depending on details of how DMA will work to this device.
  985. * Using these buffers also helps prevent cacheline sharing problems on
  986. * architectures where CPU caches are not DMA-coherent.
  987. *
  988. * When the buffer is no longer used, free it with usb_buffer_free().
  989. */
  990. void *usb_buffer_alloc (
  991. struct usb_device *dev,
  992. size_t size,
  993. int mem_flags,
  994. dma_addr_t *dma
  995. )
  996. {
  997. if (!dev || !dev->bus || !dev->bus->op || !dev->bus->op->buffer_alloc)
  998. return NULL;
  999. return dev->bus->op->buffer_alloc (dev->bus, size, mem_flags, dma);
  1000. }
  1001. /**
  1002. * usb_buffer_free - free memory allocated with usb_buffer_alloc()
  1003. * @dev: device the buffer was used with
  1004. * @size: requested buffer size
  1005. * @addr: CPU address of buffer
  1006. * @dma: DMA address of buffer
  1007. *
  1008. * This reclaims an I/O buffer, letting it be reused. The memory must have
  1009. * been allocated using usb_buffer_alloc(), and the parameters must match
  1010. * those provided in that allocation request.
  1011. */
  1012. void usb_buffer_free (
  1013. struct usb_device *dev,
  1014. size_t size,
  1015. void *addr,
  1016. dma_addr_t dma
  1017. )
  1018. {
  1019. if (!dev || !dev->bus || !dev->bus->op || !dev->bus->op->buffer_free)
  1020. return;
  1021. dev->bus->op->buffer_free (dev->bus, size, addr, dma);
  1022. }
  1023. /**
  1024. * usb_buffer_map - create DMA mapping(s) for an urb
  1025. * @urb: urb whose transfer_buffer/setup_packet will be mapped
  1026. *
  1027. * Return value is either null (indicating no buffer could be mapped), or
  1028. * the parameter. URB_NO_TRANSFER_DMA_MAP and URB_NO_SETUP_DMA_MAP are
  1029. * added to urb->transfer_flags if the operation succeeds. If the device
  1030. * is connected to this system through a non-DMA controller, this operation
  1031. * always succeeds.
  1032. *
  1033. * This call would normally be used for an urb which is reused, perhaps
  1034. * as the target of a large periodic transfer, with usb_buffer_dmasync()
  1035. * calls to synchronize memory and dma state.
  1036. *
  1037. * Reverse the effect of this call with usb_buffer_unmap().
  1038. */
  1039. #if 0
  1040. struct urb *usb_buffer_map (struct urb *urb)
  1041. {
  1042. struct usb_bus *bus;
  1043. struct device *controller;
  1044. if (!urb
  1045. || !urb->dev
  1046. || !(bus = urb->dev->bus)
  1047. || !(controller = bus->controller))
  1048. return NULL;
  1049. if (controller->dma_mask) {
  1050. urb->transfer_dma = dma_map_single (controller,
  1051. urb->transfer_buffer, urb->transfer_buffer_length,
  1052. usb_pipein (urb->pipe)
  1053. ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
  1054. if (usb_pipecontrol (urb->pipe))
  1055. urb->setup_dma = dma_map_single (controller,
  1056. urb->setup_packet,
  1057. sizeof (struct usb_ctrlrequest),
  1058. DMA_TO_DEVICE);
  1059. // FIXME generic api broken like pci, can't report errors
  1060. // if (urb->transfer_dma == DMA_ADDR_INVALID) return 0;
  1061. } else
  1062. urb->transfer_dma = ~0;
  1063. urb->transfer_flags |= (URB_NO_TRANSFER_DMA_MAP
  1064. | URB_NO_SETUP_DMA_MAP);
  1065. return urb;
  1066. }
  1067. #endif /* 0 */
  1068. /* XXX DISABLED, no users currently. If you wish to re-enable this
  1069. * XXX please determine whether the sync is to transfer ownership of
  1070. * XXX the buffer from device to cpu or vice verse, and thusly use the
  1071. * XXX appropriate _for_{cpu,device}() method. -DaveM
  1072. */
  1073. #if 0
  1074. /**
  1075. * usb_buffer_dmasync - synchronize DMA and CPU view of buffer(s)
  1076. * @urb: urb whose transfer_buffer/setup_packet will be synchronized
  1077. */
  1078. void usb_buffer_dmasync (struct urb *urb)
  1079. {
  1080. struct usb_bus *bus;
  1081. struct device *controller;
  1082. if (!urb
  1083. || !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)
  1084. || !urb->dev
  1085. || !(bus = urb->dev->bus)
  1086. || !(controller = bus->controller))
  1087. return;
  1088. if (controller->dma_mask) {
  1089. dma_sync_single (controller,
  1090. urb->transfer_dma, urb->transfer_buffer_length,
  1091. usb_pipein (urb->pipe)
  1092. ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
  1093. if (usb_pipecontrol (urb->pipe))
  1094. dma_sync_single (controller,
  1095. urb->setup_dma,
  1096. sizeof (struct usb_ctrlrequest),
  1097. DMA_TO_DEVICE);
  1098. }
  1099. }
  1100. #endif
  1101. /**
  1102. * usb_buffer_unmap - free DMA mapping(s) for an urb
  1103. * @urb: urb whose transfer_buffer will be unmapped
  1104. *
  1105. * Reverses the effect of usb_buffer_map().
  1106. */
  1107. #if 0
  1108. void usb_buffer_unmap (struct urb *urb)
  1109. {
  1110. struct usb_bus *bus;
  1111. struct device *controller;
  1112. if (!urb
  1113. || !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)
  1114. || !urb->dev
  1115. || !(bus = urb->dev->bus)
  1116. || !(controller = bus->controller))
  1117. return;
  1118. if (controller->dma_mask) {
  1119. dma_unmap_single (controller,
  1120. urb->transfer_dma, urb->transfer_buffer_length,
  1121. usb_pipein (urb->pipe)
  1122. ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
  1123. if (usb_pipecontrol (urb->pipe))
  1124. dma_unmap_single (controller,
  1125. urb->setup_dma,
  1126. sizeof (struct usb_ctrlrequest),
  1127. DMA_TO_DEVICE);
  1128. }
  1129. urb->transfer_flags &= ~(URB_NO_TRANSFER_DMA_MAP
  1130. | URB_NO_SETUP_DMA_MAP);
  1131. }
  1132. #endif /* 0 */
  1133. /**
  1134. * usb_buffer_map_sg - create scatterlist DMA mapping(s) for an endpoint
  1135. * @dev: device to which the scatterlist will be mapped
  1136. * @pipe: endpoint defining the mapping direction
  1137. * @sg: the scatterlist to map
  1138. * @nents: the number of entries in the scatterlist
  1139. *
  1140. * Return value is either < 0 (indicating no buffers could be mapped), or
  1141. * the number of DMA mapping array entries in the scatterlist.
  1142. *
  1143. * The caller is responsible for placing the resulting DMA addresses from
  1144. * the scatterlist into URB transfer buffer pointers, and for setting the
  1145. * URB_NO_TRANSFER_DMA_MAP transfer flag in each of those URBs.
  1146. *
  1147. * Top I/O rates come from queuing URBs, instead of waiting for each one
  1148. * to complete before starting the next I/O. This is particularly easy
  1149. * to do with scatterlists. Just allocate and submit one URB for each DMA
  1150. * mapping entry returned, stopping on the first error or when all succeed.
  1151. * Better yet, use the usb_sg_*() calls, which do that (and more) for you.
  1152. *
  1153. * This call would normally be used when translating scatterlist requests,
  1154. * rather than usb_buffer_map(), since on some hardware (with IOMMUs) it
  1155. * may be able to coalesce mappings for improved I/O efficiency.
  1156. *
  1157. * Reverse the effect of this call with usb_buffer_unmap_sg().
  1158. */
  1159. int usb_buffer_map_sg (struct usb_device *dev, unsigned pipe,
  1160. struct scatterlist *sg, int nents)
  1161. {
  1162. struct usb_bus *bus;
  1163. struct device *controller;
  1164. if (!dev
  1165. || usb_pipecontrol (pipe)
  1166. || !(bus = dev->bus)
  1167. || !(controller = bus->controller)
  1168. || !controller->dma_mask)
  1169. return -1;
  1170. // FIXME generic api broken like pci, can't report errors
  1171. return dma_map_sg (controller, sg, nents,
  1172. usb_pipein (pipe) ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
  1173. }
  1174. /* XXX DISABLED, no users currently. If you wish to re-enable this
  1175. * XXX please determine whether the sync is to transfer ownership of
  1176. * XXX the buffer from device to cpu or vice verse, and thusly use the
  1177. * XXX appropriate _for_{cpu,device}() method. -DaveM
  1178. */
  1179. #if 0
  1180. /**
  1181. * usb_buffer_dmasync_sg - synchronize DMA and CPU view of scatterlist buffer(s)
  1182. * @dev: device to which the scatterlist will be mapped
  1183. * @pipe: endpoint defining the mapping direction
  1184. * @sg: the scatterlist to synchronize
  1185. * @n_hw_ents: the positive return value from usb_buffer_map_sg
  1186. *
  1187. * Use this when you are re-using a scatterlist's data buffers for
  1188. * another USB request.
  1189. */
  1190. void usb_buffer_dmasync_sg (struct usb_device *dev, unsigned pipe,
  1191. struct scatterlist *sg, int n_hw_ents)
  1192. {
  1193. struct usb_bus *bus;
  1194. struct device *controller;
  1195. if (!dev
  1196. || !(bus = dev->bus)
  1197. || !(controller = bus->controller)
  1198. || !controller->dma_mask)
  1199. return;
  1200. dma_sync_sg (controller, sg, n_hw_ents,
  1201. usb_pipein (pipe) ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
  1202. }
  1203. #endif
  1204. /**
  1205. * usb_buffer_unmap_sg - free DMA mapping(s) for a scatterlist
  1206. * @dev: device to which the scatterlist will be mapped
  1207. * @pipe: endpoint defining the mapping direction
  1208. * @sg: the scatterlist to unmap
  1209. * @n_hw_ents: the positive return value from usb_buffer_map_sg
  1210. *
  1211. * Reverses the effect of usb_buffer_map_sg().
  1212. */
  1213. void usb_buffer_unmap_sg (struct usb_device *dev, unsigned pipe,
  1214. struct scatterlist *sg, int n_hw_ents)
  1215. {
  1216. struct usb_bus *bus;
  1217. struct device *controller;
  1218. if (!dev
  1219. || !(bus = dev->bus)
  1220. || !(controller = bus->controller)
  1221. || !controller->dma_mask)
  1222. return;
  1223. dma_unmap_sg (controller, sg, n_hw_ents,
  1224. usb_pipein (pipe) ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
  1225. }
  1226. static int usb_generic_suspend(struct device *dev, pm_message_t message)
  1227. {
  1228. struct usb_interface *intf;
  1229. struct usb_driver *driver;
  1230. if (dev->driver == &usb_generic_driver)
  1231. return usb_suspend_device (to_usb_device(dev), message);
  1232. if ((dev->driver == NULL) ||
  1233. (dev->driver_data == &usb_generic_driver_data))
  1234. return 0;
  1235. intf = to_usb_interface(dev);
  1236. driver = to_usb_driver(dev->driver);
  1237. /* there's only one USB suspend state */
  1238. if (intf->dev.power.power_state)
  1239. return 0;
  1240. if (driver->suspend)
  1241. return driver->suspend(intf, message);
  1242. return 0;
  1243. }
  1244. static int usb_generic_resume(struct device *dev)
  1245. {
  1246. struct usb_interface *intf;
  1247. struct usb_driver *driver;
  1248. /* devices resume through their hub */
  1249. if (dev->driver == &usb_generic_driver)
  1250. return usb_resume_device (to_usb_device(dev));
  1251. if ((dev->driver == NULL) ||
  1252. (dev->driver_data == &usb_generic_driver_data))
  1253. return 0;
  1254. intf = to_usb_interface(dev);
  1255. driver = to_usb_driver(dev->driver);
  1256. if (driver->resume)
  1257. return driver->resume(intf);
  1258. return 0;
  1259. }
  1260. struct bus_type usb_bus_type = {
  1261. .name = "usb",
  1262. .match = usb_device_match,
  1263. .hotplug = usb_hotplug,
  1264. .suspend = usb_generic_suspend,
  1265. .resume = usb_generic_resume,
  1266. };
  1267. #ifndef MODULE
  1268. static int __init usb_setup_disable(char *str)
  1269. {
  1270. nousb = 1;
  1271. return 1;
  1272. }
  1273. /* format to disable USB on kernel command line is: nousb */
  1274. __setup("nousb", usb_setup_disable);
  1275. #endif
  1276. /*
  1277. * for external read access to <nousb>
  1278. */
  1279. int usb_disabled(void)
  1280. {
  1281. return nousb;
  1282. }
  1283. /*
  1284. * Init
  1285. */
  1286. static int __init usb_init(void)
  1287. {
  1288. int retval;
  1289. if (nousb) {
  1290. pr_info ("%s: USB support disabled\n", usbcore_name);
  1291. return 0;
  1292. }
  1293. retval = bus_register(&usb_bus_type);
  1294. if (retval)
  1295. goto out;
  1296. retval = usb_host_init();
  1297. if (retval)
  1298. goto host_init_failed;
  1299. retval = usb_major_init();
  1300. if (retval)
  1301. goto major_init_failed;
  1302. retval = usbfs_init();
  1303. if (retval)
  1304. goto fs_init_failed;
  1305. retval = usb_hub_init();
  1306. if (retval)
  1307. goto hub_init_failed;
  1308. retval = driver_register(&usb_generic_driver);
  1309. if (!retval)
  1310. goto out;
  1311. usb_hub_cleanup();
  1312. hub_init_failed:
  1313. usbfs_cleanup();
  1314. fs_init_failed:
  1315. usb_major_cleanup();
  1316. major_init_failed:
  1317. usb_host_cleanup();
  1318. host_init_failed:
  1319. bus_unregister(&usb_bus_type);
  1320. out:
  1321. return retval;
  1322. }
  1323. /*
  1324. * Cleanup
  1325. */
  1326. static void __exit usb_exit(void)
  1327. {
  1328. /* This will matter if shutdown/reboot does exitcalls. */
  1329. if (nousb)
  1330. return;
  1331. driver_unregister(&usb_generic_driver);
  1332. usb_major_cleanup();
  1333. usbfs_cleanup();
  1334. usb_hub_cleanup();
  1335. usb_host_cleanup();
  1336. bus_unregister(&usb_bus_type);
  1337. }
  1338. subsys_initcall(usb_init);
  1339. module_exit(usb_exit);
  1340. /*
  1341. * USB may be built into the kernel or be built as modules.
  1342. * These symbols are exported for device (or host controller)
  1343. * driver modules to use.
  1344. */
  1345. EXPORT_SYMBOL(usb_register);
  1346. EXPORT_SYMBOL(usb_deregister);
  1347. EXPORT_SYMBOL(usb_disabled);
  1348. EXPORT_SYMBOL(usb_alloc_dev);
  1349. EXPORT_SYMBOL(usb_put_dev);
  1350. EXPORT_SYMBOL(usb_get_dev);
  1351. EXPORT_SYMBOL(usb_hub_tt_clear_buffer);
  1352. EXPORT_SYMBOL(usb_lock_device);
  1353. EXPORT_SYMBOL(usb_trylock_device);
  1354. EXPORT_SYMBOL(usb_lock_device_for_reset);
  1355. EXPORT_SYMBOL(usb_unlock_device);
  1356. EXPORT_SYMBOL(usb_driver_claim_interface);
  1357. EXPORT_SYMBOL(usb_driver_release_interface);
  1358. EXPORT_SYMBOL(usb_match_id);
  1359. EXPORT_SYMBOL(usb_find_interface);
  1360. EXPORT_SYMBOL(usb_ifnum_to_if);
  1361. EXPORT_SYMBOL(usb_altnum_to_altsetting);
  1362. EXPORT_SYMBOL(usb_reset_device);
  1363. EXPORT_SYMBOL(usb_disconnect);
  1364. EXPORT_SYMBOL(__usb_get_extra_descriptor);
  1365. EXPORT_SYMBOL(usb_find_device);
  1366. EXPORT_SYMBOL(usb_get_current_frame_number);
  1367. EXPORT_SYMBOL (usb_buffer_alloc);
  1368. EXPORT_SYMBOL (usb_buffer_free);
  1369. #if 0
  1370. EXPORT_SYMBOL (usb_buffer_map);
  1371. EXPORT_SYMBOL (usb_buffer_dmasync);
  1372. EXPORT_SYMBOL (usb_buffer_unmap);
  1373. #endif
  1374. EXPORT_SYMBOL (usb_buffer_map_sg);
  1375. #if 0
  1376. EXPORT_SYMBOL (usb_buffer_dmasync_sg);
  1377. #endif
  1378. EXPORT_SYMBOL (usb_buffer_unmap_sg);
  1379. MODULE_LICENSE("GPL");