usb.h 70 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837
  1. #ifndef __LINUX_USB_H
  2. #define __LINUX_USB_H
  3. #include <linux/mod_devicetable.h>
  4. #include <linux/usb/ch9.h>
  5. #define USB_MAJOR 180
  6. #define USB_DEVICE_MAJOR 189
  7. #ifdef __KERNEL__
  8. #include <linux/errno.h> /* for -ENODEV */
  9. #include <linux/delay.h> /* for mdelay() */
  10. #include <linux/interrupt.h> /* for in_interrupt() */
  11. #include <linux/list.h> /* for struct list_head */
  12. #include <linux/kref.h> /* for struct kref */
  13. #include <linux/device.h> /* for struct device */
  14. #include <linux/fs.h> /* for struct file_operations */
  15. #include <linux/completion.h> /* for struct completion */
  16. #include <linux/sched.h> /* for current && schedule_timeout */
  17. #include <linux/mutex.h> /* for struct mutex */
  18. #include <linux/pm_runtime.h> /* for runtime PM */
  19. struct usb_device;
  20. struct usb_driver;
  21. struct wusb_dev;
  22. /*-------------------------------------------------------------------------*/
  23. /*
  24. * Host-side wrappers for standard USB descriptors ... these are parsed
  25. * from the data provided by devices. Parsing turns them from a flat
  26. * sequence of descriptors into a hierarchy:
  27. *
  28. * - devices have one (usually) or more configs;
  29. * - configs have one (often) or more interfaces;
  30. * - interfaces have one (usually) or more settings;
  31. * - each interface setting has zero or (usually) more endpoints.
  32. * - a SuperSpeed endpoint has a companion descriptor
  33. *
  34. * And there might be other descriptors mixed in with those.
  35. *
  36. * Devices may also have class-specific or vendor-specific descriptors.
  37. */
  38. struct ep_device;
  39. /**
  40. * struct usb_host_endpoint - host-side endpoint descriptor and queue
  41. * @desc: descriptor for this endpoint, wMaxPacketSize in native byteorder
  42. * @ss_ep_comp: SuperSpeed companion descriptor for this endpoint
  43. * @urb_list: urbs queued to this endpoint; maintained by usbcore
  44. * @hcpriv: for use by HCD; typically holds hardware dma queue head (QH)
  45. * with one or more transfer descriptors (TDs) per urb
  46. * @ep_dev: ep_device for sysfs info
  47. * @extra: descriptors following this endpoint in the configuration
  48. * @extralen: how many bytes of "extra" are valid
  49. * @enabled: URBs may be submitted to this endpoint
  50. *
  51. * USB requests are always queued to a given endpoint, identified by a
  52. * descriptor within an active interface in a given USB configuration.
  53. */
  54. struct usb_host_endpoint {
  55. struct usb_endpoint_descriptor desc;
  56. struct usb_ss_ep_comp_descriptor ss_ep_comp;
  57. struct list_head urb_list;
  58. void *hcpriv;
  59. struct ep_device *ep_dev; /* For sysfs info */
  60. unsigned char *extra; /* Extra descriptors */
  61. int extralen;
  62. int enabled;
  63. };
  64. /* host-side wrapper for one interface setting's parsed descriptors */
  65. struct usb_host_interface {
  66. struct usb_interface_descriptor desc;
  67. int extralen;
  68. unsigned char *extra; /* Extra descriptors */
  69. /* array of desc.bNumEndpoint endpoints associated with this
  70. * interface setting. these will be in no particular order.
  71. */
  72. struct usb_host_endpoint *endpoint;
  73. char *string; /* iInterface string, if present */
  74. };
  75. enum usb_interface_condition {
  76. USB_INTERFACE_UNBOUND = 0,
  77. USB_INTERFACE_BINDING,
  78. USB_INTERFACE_BOUND,
  79. USB_INTERFACE_UNBINDING,
  80. };
  81. /**
  82. * struct usb_interface - what usb device drivers talk to
  83. * @altsetting: array of interface structures, one for each alternate
  84. * setting that may be selected. Each one includes a set of
  85. * endpoint configurations. They will be in no particular order.
  86. * @cur_altsetting: the current altsetting.
  87. * @num_altsetting: number of altsettings defined.
  88. * @intf_assoc: interface association descriptor
  89. * @minor: the minor number assigned to this interface, if this
  90. * interface is bound to a driver that uses the USB major number.
  91. * If this interface does not use the USB major, this field should
  92. * be unused. The driver should set this value in the probe()
  93. * function of the driver, after it has been assigned a minor
  94. * number from the USB core by calling usb_register_dev().
  95. * @condition: binding state of the interface: not bound, binding
  96. * (in probe()), bound to a driver, or unbinding (in disconnect())
  97. * @sysfs_files_created: sysfs attributes exist
  98. * @ep_devs_created: endpoint child pseudo-devices exist
  99. * @unregistering: flag set when the interface is being unregistered
  100. * @needs_remote_wakeup: flag set when the driver requires remote-wakeup
  101. * capability during autosuspend.
  102. * @needs_altsetting0: flag set when a set-interface request for altsetting 0
  103. * has been deferred.
  104. * @needs_binding: flag set when the driver should be re-probed or unbound
  105. * following a reset or suspend operation it doesn't support.
  106. * @dev: driver model's view of this device
  107. * @usb_dev: if an interface is bound to the USB major, this will point
  108. * to the sysfs representation for that device.
  109. * @pm_usage_cnt: PM usage counter for this interface
  110. * @reset_ws: Used for scheduling resets from atomic context.
  111. * @reset_running: set to 1 if the interface is currently running a
  112. * queued reset so that usb_cancel_queued_reset() doesn't try to
  113. * remove from the workqueue when running inside the worker
  114. * thread. See __usb_queue_reset_device().
  115. * @resetting_device: USB core reset the device, so use alt setting 0 as
  116. * current; needs bandwidth alloc after reset.
  117. *
  118. * USB device drivers attach to interfaces on a physical device. Each
  119. * interface encapsulates a single high level function, such as feeding
  120. * an audio stream to a speaker or reporting a change in a volume control.
  121. * Many USB devices only have one interface. The protocol used to talk to
  122. * an interface's endpoints can be defined in a usb "class" specification,
  123. * or by a product's vendor. The (default) control endpoint is part of
  124. * every interface, but is never listed among the interface's descriptors.
  125. *
  126. * The driver that is bound to the interface can use standard driver model
  127. * calls such as dev_get_drvdata() on the dev member of this structure.
  128. *
  129. * Each interface may have alternate settings. The initial configuration
  130. * of a device sets altsetting 0, but the device driver can change
  131. * that setting using usb_set_interface(). Alternate settings are often
  132. * used to control the use of periodic endpoints, such as by having
  133. * different endpoints use different amounts of reserved USB bandwidth.
  134. * All standards-conformant USB devices that use isochronous endpoints
  135. * will use them in non-default settings.
  136. *
  137. * The USB specification says that alternate setting numbers must run from
  138. * 0 to one less than the total number of alternate settings. But some
  139. * devices manage to mess this up, and the structures aren't necessarily
  140. * stored in numerical order anyhow. Use usb_altnum_to_altsetting() to
  141. * look up an alternate setting in the altsetting array based on its number.
  142. */
  143. struct usb_interface {
  144. /* array of alternate settings for this interface,
  145. * stored in no particular order */
  146. struct usb_host_interface *altsetting;
  147. struct usb_host_interface *cur_altsetting; /* the currently
  148. * active alternate setting */
  149. unsigned num_altsetting; /* number of alternate settings */
  150. /* If there is an interface association descriptor then it will list
  151. * the associated interfaces */
  152. struct usb_interface_assoc_descriptor *intf_assoc;
  153. int minor; /* minor number this interface is
  154. * bound to */
  155. enum usb_interface_condition condition; /* state of binding */
  156. unsigned sysfs_files_created:1; /* the sysfs attributes exist */
  157. unsigned ep_devs_created:1; /* endpoint "devices" exist */
  158. unsigned unregistering:1; /* unregistration is in progress */
  159. unsigned needs_remote_wakeup:1; /* driver requires remote wakeup */
  160. unsigned needs_altsetting0:1; /* switch to altsetting 0 is pending */
  161. unsigned needs_binding:1; /* needs delayed unbind/rebind */
  162. unsigned reset_running:1;
  163. unsigned resetting_device:1; /* true: bandwidth alloc after reset */
  164. struct device dev; /* interface specific device info */
  165. struct device *usb_dev;
  166. atomic_t pm_usage_cnt; /* usage counter for autosuspend */
  167. struct work_struct reset_ws; /* for resets in atomic context */
  168. };
  169. #define to_usb_interface(d) container_of(d, struct usb_interface, dev)
  170. static inline void *usb_get_intfdata(struct usb_interface *intf)
  171. {
  172. return dev_get_drvdata(&intf->dev);
  173. }
  174. static inline void usb_set_intfdata(struct usb_interface *intf, void *data)
  175. {
  176. dev_set_drvdata(&intf->dev, data);
  177. }
  178. struct usb_interface *usb_get_intf(struct usb_interface *intf);
  179. void usb_put_intf(struct usb_interface *intf);
  180. /* this maximum is arbitrary */
  181. #define USB_MAXINTERFACES 32
  182. #define USB_MAXIADS (USB_MAXINTERFACES/2)
  183. /**
  184. * struct usb_interface_cache - long-term representation of a device interface
  185. * @num_altsetting: number of altsettings defined.
  186. * @ref: reference counter.
  187. * @altsetting: variable-length array of interface structures, one for
  188. * each alternate setting that may be selected. Each one includes a
  189. * set of endpoint configurations. They will be in no particular order.
  190. *
  191. * These structures persist for the lifetime of a usb_device, unlike
  192. * struct usb_interface (which persists only as long as its configuration
  193. * is installed). The altsetting arrays can be accessed through these
  194. * structures at any time, permitting comparison of configurations and
  195. * providing support for the /proc/bus/usb/devices pseudo-file.
  196. */
  197. struct usb_interface_cache {
  198. unsigned num_altsetting; /* number of alternate settings */
  199. struct kref ref; /* reference counter */
  200. /* variable-length array of alternate settings for this interface,
  201. * stored in no particular order */
  202. struct usb_host_interface altsetting[0];
  203. };
  204. #define ref_to_usb_interface_cache(r) \
  205. container_of(r, struct usb_interface_cache, ref)
  206. #define altsetting_to_usb_interface_cache(a) \
  207. container_of(a, struct usb_interface_cache, altsetting[0])
  208. /**
  209. * struct usb_host_config - representation of a device's configuration
  210. * @desc: the device's configuration descriptor.
  211. * @string: pointer to the cached version of the iConfiguration string, if
  212. * present for this configuration.
  213. * @intf_assoc: list of any interface association descriptors in this config
  214. * @interface: array of pointers to usb_interface structures, one for each
  215. * interface in the configuration. The number of interfaces is stored
  216. * in desc.bNumInterfaces. These pointers are valid only while the
  217. * the configuration is active.
  218. * @intf_cache: array of pointers to usb_interface_cache structures, one
  219. * for each interface in the configuration. These structures exist
  220. * for the entire life of the device.
  221. * @extra: pointer to buffer containing all extra descriptors associated
  222. * with this configuration (those preceding the first interface
  223. * descriptor).
  224. * @extralen: length of the extra descriptors buffer.
  225. *
  226. * USB devices may have multiple configurations, but only one can be active
  227. * at any time. Each encapsulates a different operational environment;
  228. * for example, a dual-speed device would have separate configurations for
  229. * full-speed and high-speed operation. The number of configurations
  230. * available is stored in the device descriptor as bNumConfigurations.
  231. *
  232. * A configuration can contain multiple interfaces. Each corresponds to
  233. * a different function of the USB device, and all are available whenever
  234. * the configuration is active. The USB standard says that interfaces
  235. * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot
  236. * of devices get this wrong. In addition, the interface array is not
  237. * guaranteed to be sorted in numerical order. Use usb_ifnum_to_if() to
  238. * look up an interface entry based on its number.
  239. *
  240. * Device drivers should not attempt to activate configurations. The choice
  241. * of which configuration to install is a policy decision based on such
  242. * considerations as available power, functionality provided, and the user's
  243. * desires (expressed through userspace tools). However, drivers can call
  244. * usb_reset_configuration() to reinitialize the current configuration and
  245. * all its interfaces.
  246. */
  247. struct usb_host_config {
  248. struct usb_config_descriptor desc;
  249. char *string; /* iConfiguration string, if present */
  250. /* List of any Interface Association Descriptors in this
  251. * configuration. */
  252. struct usb_interface_assoc_descriptor *intf_assoc[USB_MAXIADS];
  253. /* the interfaces associated with this configuration,
  254. * stored in no particular order */
  255. struct usb_interface *interface[USB_MAXINTERFACES];
  256. /* Interface information available even when this is not the
  257. * active configuration */
  258. struct usb_interface_cache *intf_cache[USB_MAXINTERFACES];
  259. unsigned char *extra; /* Extra descriptors */
  260. int extralen;
  261. };
  262. /* USB2.0 and USB3.0 device BOS descriptor set */
  263. struct usb_host_bos {
  264. struct usb_bos_descriptor *desc;
  265. /* wireless cap descriptor is handled by wusb */
  266. struct usb_ext_cap_descriptor *ext_cap;
  267. struct usb_ss_cap_descriptor *ss_cap;
  268. struct usb_ss_container_id_descriptor *ss_id;
  269. };
  270. int __usb_get_extra_descriptor(char *buffer, unsigned size,
  271. unsigned char type, void **ptr);
  272. #define usb_get_extra_descriptor(ifpoint, type, ptr) \
  273. __usb_get_extra_descriptor((ifpoint)->extra, \
  274. (ifpoint)->extralen, \
  275. type, (void **)ptr)
  276. /* ----------------------------------------------------------------------- */
  277. /* USB device number allocation bitmap */
  278. struct usb_devmap {
  279. unsigned long devicemap[128 / (8*sizeof(unsigned long))];
  280. };
  281. /*
  282. * Allocated per bus (tree of devices) we have:
  283. */
  284. struct usb_bus {
  285. struct device *controller; /* host/master side hardware */
  286. int busnum; /* Bus number (in order of reg) */
  287. const char *bus_name; /* stable id (PCI slot_name etc) */
  288. u8 uses_dma; /* Does the host controller use DMA? */
  289. u8 uses_pio_for_control; /*
  290. * Does the host controller use PIO
  291. * for control transfers?
  292. */
  293. u8 otg_port; /* 0, or number of OTG/HNP port */
  294. unsigned is_b_host:1; /* true during some HNP roleswitches */
  295. unsigned b_hnp_enable:1; /* OTG: did A-Host enable HNP? */
  296. unsigned no_stop_on_short:1; /*
  297. * Quirk: some controllers don't stop
  298. * the ep queue on a short transfer
  299. * with the URB_SHORT_NOT_OK flag set.
  300. */
  301. unsigned sg_tablesize; /* 0 or largest number of sg list entries */
  302. int devnum_next; /* Next open device number in
  303. * round-robin allocation */
  304. struct usb_devmap devmap; /* device address allocation map */
  305. struct usb_device *root_hub; /* Root hub */
  306. struct usb_bus *hs_companion; /* Companion EHCI bus, if any */
  307. struct list_head bus_list; /* list of busses */
  308. int bandwidth_allocated; /* on this bus: how much of the time
  309. * reserved for periodic (intr/iso)
  310. * requests is used, on average?
  311. * Units: microseconds/frame.
  312. * Limits: Full/low speed reserve 90%,
  313. * while high speed reserves 80%.
  314. */
  315. int bandwidth_int_reqs; /* number of Interrupt requests */
  316. int bandwidth_isoc_reqs; /* number of Isoc. requests */
  317. unsigned resuming_ports; /* bit array: resuming root-hub ports */
  318. #if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
  319. struct mon_bus *mon_bus; /* non-null when associated */
  320. int monitored; /* non-zero when monitored */
  321. #endif
  322. };
  323. /* ----------------------------------------------------------------------- */
  324. struct usb_tt;
  325. enum usb_device_removable {
  326. USB_DEVICE_REMOVABLE_UNKNOWN = 0,
  327. USB_DEVICE_REMOVABLE,
  328. USB_DEVICE_FIXED,
  329. };
  330. enum usb_port_connect_type {
  331. USB_PORT_CONNECT_TYPE_UNKNOWN = 0,
  332. USB_PORT_CONNECT_TYPE_HOT_PLUG,
  333. USB_PORT_CONNECT_TYPE_HARD_WIRED,
  334. USB_PORT_NOT_USED,
  335. };
  336. /*
  337. * USB 2.0 Link Power Management (LPM) parameters.
  338. */
  339. struct usb2_lpm_parameters {
  340. /* Best effort service latency indicate how long the host will drive
  341. * resume on an exit from L1.
  342. */
  343. unsigned int besl;
  344. /* Timeout value in microseconds for the L1 inactivity (LPM) timer.
  345. * When the timer counts to zero, the parent hub will initiate a LPM
  346. * transition to L1.
  347. */
  348. int timeout;
  349. };
  350. /*
  351. * USB 3.0 Link Power Management (LPM) parameters.
  352. *
  353. * PEL and SEL are USB 3.0 Link PM latencies for device-initiated LPM exit.
  354. * MEL is the USB 3.0 Link PM latency for host-initiated LPM exit.
  355. * All three are stored in nanoseconds.
  356. */
  357. struct usb3_lpm_parameters {
  358. /*
  359. * Maximum exit latency (MEL) for the host to send a packet to the
  360. * device (either a Ping for isoc endpoints, or a data packet for
  361. * interrupt endpoints), the hubs to decode the packet, and for all hubs
  362. * in the path to transition the links to U0.
  363. */
  364. unsigned int mel;
  365. /*
  366. * Maximum exit latency for a device-initiated LPM transition to bring
  367. * all links into U0. Abbreviated as "PEL" in section 9.4.12 of the USB
  368. * 3.0 spec, with no explanation of what "P" stands for. "Path"?
  369. */
  370. unsigned int pel;
  371. /*
  372. * The System Exit Latency (SEL) includes PEL, and three other
  373. * latencies. After a device initiates a U0 transition, it will take
  374. * some time from when the device sends the ERDY to when it will finally
  375. * receive the data packet. Basically, SEL should be the worse-case
  376. * latency from when a device starts initiating a U0 transition to when
  377. * it will get data.
  378. */
  379. unsigned int sel;
  380. /*
  381. * The idle timeout value that is currently programmed into the parent
  382. * hub for this device. When the timer counts to zero, the parent hub
  383. * will initiate an LPM transition to either U1 or U2.
  384. */
  385. int timeout;
  386. };
  387. /**
  388. * struct usb_device - kernel's representation of a USB device
  389. * @devnum: device number; address on a USB bus
  390. * @devpath: device ID string for use in messages (e.g., /port/...)
  391. * @route: tree topology hex string for use with xHCI
  392. * @state: device state: configured, not attached, etc.
  393. * @speed: device speed: high/full/low (or error)
  394. * @tt: Transaction Translator info; used with low/full speed dev, highspeed hub
  395. * @ttport: device port on that tt hub
  396. * @toggle: one bit for each endpoint, with ([0] = IN, [1] = OUT) endpoints
  397. * @parent: our hub, unless we're the root
  398. * @bus: bus we're part of
  399. * @ep0: endpoint 0 data (default control pipe)
  400. * @dev: generic device interface
  401. * @descriptor: USB device descriptor
  402. * @bos: USB device BOS descriptor set
  403. * @config: all of the device's configs
  404. * @actconfig: the active configuration
  405. * @ep_in: array of IN endpoints
  406. * @ep_out: array of OUT endpoints
  407. * @rawdescriptors: raw descriptors for each config
  408. * @bus_mA: Current available from the bus
  409. * @portnum: parent port number (origin 1)
  410. * @level: number of USB hub ancestors
  411. * @can_submit: URBs may be submitted
  412. * @persist_enabled: USB_PERSIST enabled for this device
  413. * @have_langid: whether string_langid is valid
  414. * @authorized: policy has said we can use it;
  415. * (user space) policy determines if we authorize this device to be
  416. * used or not. By default, wired USB devices are authorized.
  417. * WUSB devices are not, until we authorize them from user space.
  418. * FIXME -- complete doc
  419. * @authenticated: Crypto authentication passed
  420. * @wusb: device is Wireless USB
  421. * @lpm_capable: device supports LPM
  422. * @usb2_hw_lpm_capable: device can perform USB2 hardware LPM
  423. * @usb2_hw_lpm_besl_capable: device can perform USB2 hardware BESL LPM
  424. * @usb2_hw_lpm_enabled: USB2 hardware LPM enabled
  425. * @usb3_lpm_enabled: USB3 hardware LPM enabled
  426. * @string_langid: language ID for strings
  427. * @product: iProduct string, if present (static)
  428. * @manufacturer: iManufacturer string, if present (static)
  429. * @serial: iSerialNumber string, if present (static)
  430. * @filelist: usbfs files that are open to this device
  431. * @maxchild: number of ports if hub
  432. * @quirks: quirks of the whole device
  433. * @urbnum: number of URBs submitted for the whole device
  434. * @active_duration: total time device is not suspended
  435. * @connect_time: time device was first connected
  436. * @do_remote_wakeup: remote wakeup should be enabled
  437. * @reset_resume: needs reset instead of resume
  438. * @port_is_suspended: the upstream port is suspended (L2 or U3)
  439. * @wusb_dev: if this is a Wireless USB device, link to the WUSB
  440. * specific data for the device.
  441. * @slot_id: Slot ID assigned by xHCI
  442. * @removable: Device can be physically removed from this port
  443. * @l1_params: best effor service latency for USB2 L1 LPM state, and L1 timeout.
  444. * @u1_params: exit latencies for USB3 U1 LPM state, and hub-initiated timeout.
  445. * @u2_params: exit latencies for USB3 U2 LPM state, and hub-initiated timeout.
  446. * @lpm_disable_count: Ref count used by usb_disable_lpm() and usb_enable_lpm()
  447. * to keep track of the number of functions that require USB 3.0 Link Power
  448. * Management to be disabled for this usb_device. This count should only
  449. * be manipulated by those functions, with the bandwidth_mutex is held.
  450. *
  451. * Notes:
  452. * Usbcore drivers should not set usbdev->state directly. Instead use
  453. * usb_set_device_state().
  454. */
  455. struct usb_device {
  456. int devnum;
  457. char devpath[16];
  458. u32 route;
  459. enum usb_device_state state;
  460. enum usb_device_speed speed;
  461. struct usb_tt *tt;
  462. int ttport;
  463. unsigned int toggle[2];
  464. struct usb_device *parent;
  465. struct usb_bus *bus;
  466. struct usb_host_endpoint ep0;
  467. struct device dev;
  468. struct usb_device_descriptor descriptor;
  469. struct usb_host_bos *bos;
  470. struct usb_host_config *config;
  471. struct usb_host_config *actconfig;
  472. struct usb_host_endpoint *ep_in[16];
  473. struct usb_host_endpoint *ep_out[16];
  474. char **rawdescriptors;
  475. unsigned short bus_mA;
  476. u8 portnum;
  477. u8 level;
  478. unsigned can_submit:1;
  479. unsigned persist_enabled:1;
  480. unsigned have_langid:1;
  481. unsigned authorized:1;
  482. unsigned authenticated:1;
  483. unsigned wusb:1;
  484. unsigned lpm_capable:1;
  485. unsigned usb2_hw_lpm_capable:1;
  486. unsigned usb2_hw_lpm_besl_capable:1;
  487. unsigned usb2_hw_lpm_enabled:1;
  488. unsigned usb3_lpm_enabled:1;
  489. int string_langid;
  490. /* static strings from the device */
  491. char *product;
  492. char *manufacturer;
  493. char *serial;
  494. struct list_head filelist;
  495. int maxchild;
  496. u32 quirks;
  497. atomic_t urbnum;
  498. unsigned long active_duration;
  499. #ifdef CONFIG_PM
  500. unsigned long connect_time;
  501. unsigned do_remote_wakeup:1;
  502. unsigned reset_resume:1;
  503. unsigned port_is_suspended:1;
  504. #endif
  505. struct wusb_dev *wusb_dev;
  506. int slot_id;
  507. enum usb_device_removable removable;
  508. struct usb2_lpm_parameters l1_params;
  509. struct usb3_lpm_parameters u1_params;
  510. struct usb3_lpm_parameters u2_params;
  511. unsigned lpm_disable_count;
  512. };
  513. #define to_usb_device(d) container_of(d, struct usb_device, dev)
  514. static inline struct usb_device *interface_to_usbdev(struct usb_interface *intf)
  515. {
  516. return to_usb_device(intf->dev.parent);
  517. }
  518. extern struct usb_device *usb_get_dev(struct usb_device *dev);
  519. extern void usb_put_dev(struct usb_device *dev);
  520. extern struct usb_device *usb_hub_find_child(struct usb_device *hdev,
  521. int port1);
  522. /**
  523. * usb_hub_for_each_child - iterate over all child devices on the hub
  524. * @hdev: USB device belonging to the usb hub
  525. * @port1: portnum associated with child device
  526. * @child: child device pointer
  527. */
  528. #define usb_hub_for_each_child(hdev, port1, child) \
  529. for (port1 = 1, child = usb_hub_find_child(hdev, port1); \
  530. port1 <= hdev->maxchild; \
  531. child = usb_hub_find_child(hdev, ++port1)) \
  532. if (!child) continue; else
  533. /* USB device locking */
  534. #define usb_lock_device(udev) device_lock(&(udev)->dev)
  535. #define usb_unlock_device(udev) device_unlock(&(udev)->dev)
  536. #define usb_trylock_device(udev) device_trylock(&(udev)->dev)
  537. extern int usb_lock_device_for_reset(struct usb_device *udev,
  538. const struct usb_interface *iface);
  539. /* USB port reset for device reinitialization */
  540. extern int usb_reset_device(struct usb_device *dev);
  541. extern void usb_queue_reset_device(struct usb_interface *dev);
  542. #ifdef CONFIG_ACPI
  543. extern int usb_acpi_set_power_state(struct usb_device *hdev, int index,
  544. bool enable);
  545. extern bool usb_acpi_power_manageable(struct usb_device *hdev, int index);
  546. #else
  547. static inline int usb_acpi_set_power_state(struct usb_device *hdev, int index,
  548. bool enable) { return 0; }
  549. static inline bool usb_acpi_power_manageable(struct usb_device *hdev, int index)
  550. { return true; }
  551. #endif
  552. /* USB autosuspend and autoresume */
  553. #ifdef CONFIG_PM_RUNTIME
  554. extern void usb_enable_autosuspend(struct usb_device *udev);
  555. extern void usb_disable_autosuspend(struct usb_device *udev);
  556. extern int usb_autopm_get_interface(struct usb_interface *intf);
  557. extern void usb_autopm_put_interface(struct usb_interface *intf);
  558. extern int usb_autopm_get_interface_async(struct usb_interface *intf);
  559. extern void usb_autopm_put_interface_async(struct usb_interface *intf);
  560. extern void usb_autopm_get_interface_no_resume(struct usb_interface *intf);
  561. extern void usb_autopm_put_interface_no_suspend(struct usb_interface *intf);
  562. static inline void usb_mark_last_busy(struct usb_device *udev)
  563. {
  564. pm_runtime_mark_last_busy(&udev->dev);
  565. }
  566. #else
  567. static inline int usb_enable_autosuspend(struct usb_device *udev)
  568. { return 0; }
  569. static inline int usb_disable_autosuspend(struct usb_device *udev)
  570. { return 0; }
  571. static inline int usb_autopm_get_interface(struct usb_interface *intf)
  572. { return 0; }
  573. static inline int usb_autopm_get_interface_async(struct usb_interface *intf)
  574. { return 0; }
  575. static inline void usb_autopm_put_interface(struct usb_interface *intf)
  576. { }
  577. static inline void usb_autopm_put_interface_async(struct usb_interface *intf)
  578. { }
  579. static inline void usb_autopm_get_interface_no_resume(
  580. struct usb_interface *intf)
  581. { }
  582. static inline void usb_autopm_put_interface_no_suspend(
  583. struct usb_interface *intf)
  584. { }
  585. static inline void usb_mark_last_busy(struct usb_device *udev)
  586. { }
  587. #endif
  588. extern int usb_disable_lpm(struct usb_device *udev);
  589. extern void usb_enable_lpm(struct usb_device *udev);
  590. /* Same as above, but these functions lock/unlock the bandwidth_mutex. */
  591. extern int usb_unlocked_disable_lpm(struct usb_device *udev);
  592. extern void usb_unlocked_enable_lpm(struct usb_device *udev);
  593. extern int usb_disable_ltm(struct usb_device *udev);
  594. extern void usb_enable_ltm(struct usb_device *udev);
  595. static inline bool usb_device_supports_ltm(struct usb_device *udev)
  596. {
  597. if (udev->speed != USB_SPEED_SUPER || !udev->bos || !udev->bos->ss_cap)
  598. return false;
  599. return udev->bos->ss_cap->bmAttributes & USB_LTM_SUPPORT;
  600. }
  601. /*-------------------------------------------------------------------------*/
  602. /* for drivers using iso endpoints */
  603. extern int usb_get_current_frame_number(struct usb_device *usb_dev);
  604. /* Sets up a group of bulk endpoints to support multiple stream IDs. */
  605. extern int usb_alloc_streams(struct usb_interface *interface,
  606. struct usb_host_endpoint **eps, unsigned int num_eps,
  607. unsigned int num_streams, gfp_t mem_flags);
  608. /* Reverts a group of bulk endpoints back to not using stream IDs. */
  609. extern void usb_free_streams(struct usb_interface *interface,
  610. struct usb_host_endpoint **eps, unsigned int num_eps,
  611. gfp_t mem_flags);
  612. /* used these for multi-interface device registration */
  613. extern int usb_driver_claim_interface(struct usb_driver *driver,
  614. struct usb_interface *iface, void *priv);
  615. /**
  616. * usb_interface_claimed - returns true iff an interface is claimed
  617. * @iface: the interface being checked
  618. *
  619. * Return: %true (nonzero) iff the interface is claimed, else %false
  620. * (zero).
  621. *
  622. * Note:
  623. * Callers must own the driver model's usb bus readlock. So driver
  624. * probe() entries don't need extra locking, but other call contexts
  625. * may need to explicitly claim that lock.
  626. *
  627. */
  628. static inline int usb_interface_claimed(struct usb_interface *iface)
  629. {
  630. return (iface->dev.driver != NULL);
  631. }
  632. extern void usb_driver_release_interface(struct usb_driver *driver,
  633. struct usb_interface *iface);
  634. const struct usb_device_id *usb_match_id(struct usb_interface *interface,
  635. const struct usb_device_id *id);
  636. extern int usb_match_one_id(struct usb_interface *interface,
  637. const struct usb_device_id *id);
  638. extern int usb_for_each_dev(void *data, int (*fn)(struct usb_device *, void *));
  639. extern struct usb_interface *usb_find_interface(struct usb_driver *drv,
  640. int minor);
  641. extern struct usb_interface *usb_ifnum_to_if(const struct usb_device *dev,
  642. unsigned ifnum);
  643. extern struct usb_host_interface *usb_altnum_to_altsetting(
  644. const struct usb_interface *intf, unsigned int altnum);
  645. extern struct usb_host_interface *usb_find_alt_setting(
  646. struct usb_host_config *config,
  647. unsigned int iface_num,
  648. unsigned int alt_num);
  649. /**
  650. * usb_make_path - returns stable device path in the usb tree
  651. * @dev: the device whose path is being constructed
  652. * @buf: where to put the string
  653. * @size: how big is "buf"?
  654. *
  655. * Return: Length of the string (> 0) or negative if size was too small.
  656. *
  657. * Note:
  658. * This identifier is intended to be "stable", reflecting physical paths in
  659. * hardware such as physical bus addresses for host controllers or ports on
  660. * USB hubs. That makes it stay the same until systems are physically
  661. * reconfigured, by re-cabling a tree of USB devices or by moving USB host
  662. * controllers. Adding and removing devices, including virtual root hubs
  663. * in host controller driver modules, does not change these path identifiers;
  664. * neither does rebooting or re-enumerating. These are more useful identifiers
  665. * than changeable ("unstable") ones like bus numbers or device addresses.
  666. *
  667. * With a partial exception for devices connected to USB 2.0 root hubs, these
  668. * identifiers are also predictable. So long as the device tree isn't changed,
  669. * plugging any USB device into a given hub port always gives it the same path.
  670. * Because of the use of "companion" controllers, devices connected to ports on
  671. * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are
  672. * high speed, and a different one if they are full or low speed.
  673. */
  674. static inline int usb_make_path(struct usb_device *dev, char *buf, size_t size)
  675. {
  676. int actual;
  677. actual = snprintf(buf, size, "usb-%s-%s", dev->bus->bus_name,
  678. dev->devpath);
  679. return (actual >= (int)size) ? -1 : actual;
  680. }
  681. /*-------------------------------------------------------------------------*/
  682. #define USB_DEVICE_ID_MATCH_DEVICE \
  683. (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
  684. #define USB_DEVICE_ID_MATCH_DEV_RANGE \
  685. (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI)
  686. #define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
  687. (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE)
  688. #define USB_DEVICE_ID_MATCH_DEV_INFO \
  689. (USB_DEVICE_ID_MATCH_DEV_CLASS | \
  690. USB_DEVICE_ID_MATCH_DEV_SUBCLASS | \
  691. USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
  692. #define USB_DEVICE_ID_MATCH_INT_INFO \
  693. (USB_DEVICE_ID_MATCH_INT_CLASS | \
  694. USB_DEVICE_ID_MATCH_INT_SUBCLASS | \
  695. USB_DEVICE_ID_MATCH_INT_PROTOCOL)
  696. /**
  697. * USB_DEVICE - macro used to describe a specific usb device
  698. * @vend: the 16 bit USB Vendor ID
  699. * @prod: the 16 bit USB Product ID
  700. *
  701. * This macro is used to create a struct usb_device_id that matches a
  702. * specific device.
  703. */
  704. #define USB_DEVICE(vend, prod) \
  705. .match_flags = USB_DEVICE_ID_MATCH_DEVICE, \
  706. .idVendor = (vend), \
  707. .idProduct = (prod)
  708. /**
  709. * USB_DEVICE_VER - describe a specific usb device with a version range
  710. * @vend: the 16 bit USB Vendor ID
  711. * @prod: the 16 bit USB Product ID
  712. * @lo: the bcdDevice_lo value
  713. * @hi: the bcdDevice_hi value
  714. *
  715. * This macro is used to create a struct usb_device_id that matches a
  716. * specific device, with a version range.
  717. */
  718. #define USB_DEVICE_VER(vend, prod, lo, hi) \
  719. .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, \
  720. .idVendor = (vend), \
  721. .idProduct = (prod), \
  722. .bcdDevice_lo = (lo), \
  723. .bcdDevice_hi = (hi)
  724. /**
  725. * USB_DEVICE_INTERFACE_CLASS - describe a usb device with a specific interface class
  726. * @vend: the 16 bit USB Vendor ID
  727. * @prod: the 16 bit USB Product ID
  728. * @cl: bInterfaceClass value
  729. *
  730. * This macro is used to create a struct usb_device_id that matches a
  731. * specific interface class of devices.
  732. */
  733. #define USB_DEVICE_INTERFACE_CLASS(vend, prod, cl) \
  734. .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
  735. USB_DEVICE_ID_MATCH_INT_CLASS, \
  736. .idVendor = (vend), \
  737. .idProduct = (prod), \
  738. .bInterfaceClass = (cl)
  739. /**
  740. * USB_DEVICE_INTERFACE_PROTOCOL - describe a usb device with a specific interface protocol
  741. * @vend: the 16 bit USB Vendor ID
  742. * @prod: the 16 bit USB Product ID
  743. * @pr: bInterfaceProtocol value
  744. *
  745. * This macro is used to create a struct usb_device_id that matches a
  746. * specific interface protocol of devices.
  747. */
  748. #define USB_DEVICE_INTERFACE_PROTOCOL(vend, prod, pr) \
  749. .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
  750. USB_DEVICE_ID_MATCH_INT_PROTOCOL, \
  751. .idVendor = (vend), \
  752. .idProduct = (prod), \
  753. .bInterfaceProtocol = (pr)
  754. /**
  755. * USB_DEVICE_INTERFACE_NUMBER - describe a usb device with a specific interface number
  756. * @vend: the 16 bit USB Vendor ID
  757. * @prod: the 16 bit USB Product ID
  758. * @num: bInterfaceNumber value
  759. *
  760. * This macro is used to create a struct usb_device_id that matches a
  761. * specific interface number of devices.
  762. */
  763. #define USB_DEVICE_INTERFACE_NUMBER(vend, prod, num) \
  764. .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
  765. USB_DEVICE_ID_MATCH_INT_NUMBER, \
  766. .idVendor = (vend), \
  767. .idProduct = (prod), \
  768. .bInterfaceNumber = (num)
  769. /**
  770. * USB_DEVICE_INFO - macro used to describe a class of usb devices
  771. * @cl: bDeviceClass value
  772. * @sc: bDeviceSubClass value
  773. * @pr: bDeviceProtocol value
  774. *
  775. * This macro is used to create a struct usb_device_id that matches a
  776. * specific class of devices.
  777. */
  778. #define USB_DEVICE_INFO(cl, sc, pr) \
  779. .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, \
  780. .bDeviceClass = (cl), \
  781. .bDeviceSubClass = (sc), \
  782. .bDeviceProtocol = (pr)
  783. /**
  784. * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces
  785. * @cl: bInterfaceClass value
  786. * @sc: bInterfaceSubClass value
  787. * @pr: bInterfaceProtocol value
  788. *
  789. * This macro is used to create a struct usb_device_id that matches a
  790. * specific class of interfaces.
  791. */
  792. #define USB_INTERFACE_INFO(cl, sc, pr) \
  793. .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, \
  794. .bInterfaceClass = (cl), \
  795. .bInterfaceSubClass = (sc), \
  796. .bInterfaceProtocol = (pr)
  797. /**
  798. * USB_DEVICE_AND_INTERFACE_INFO - describe a specific usb device with a class of usb interfaces
  799. * @vend: the 16 bit USB Vendor ID
  800. * @prod: the 16 bit USB Product ID
  801. * @cl: bInterfaceClass value
  802. * @sc: bInterfaceSubClass value
  803. * @pr: bInterfaceProtocol value
  804. *
  805. * This macro is used to create a struct usb_device_id that matches a
  806. * specific device with a specific class of interfaces.
  807. *
  808. * This is especially useful when explicitly matching devices that have
  809. * vendor specific bDeviceClass values, but standards-compliant interfaces.
  810. */
  811. #define USB_DEVICE_AND_INTERFACE_INFO(vend, prod, cl, sc, pr) \
  812. .match_flags = USB_DEVICE_ID_MATCH_INT_INFO \
  813. | USB_DEVICE_ID_MATCH_DEVICE, \
  814. .idVendor = (vend), \
  815. .idProduct = (prod), \
  816. .bInterfaceClass = (cl), \
  817. .bInterfaceSubClass = (sc), \
  818. .bInterfaceProtocol = (pr)
  819. /**
  820. * USB_VENDOR_AND_INTERFACE_INFO - describe a specific usb vendor with a class of usb interfaces
  821. * @vend: the 16 bit USB Vendor ID
  822. * @cl: bInterfaceClass value
  823. * @sc: bInterfaceSubClass value
  824. * @pr: bInterfaceProtocol value
  825. *
  826. * This macro is used to create a struct usb_device_id that matches a
  827. * specific vendor with a specific class of interfaces.
  828. *
  829. * This is especially useful when explicitly matching devices that have
  830. * vendor specific bDeviceClass values, but standards-compliant interfaces.
  831. */
  832. #define USB_VENDOR_AND_INTERFACE_INFO(vend, cl, sc, pr) \
  833. .match_flags = USB_DEVICE_ID_MATCH_INT_INFO \
  834. | USB_DEVICE_ID_MATCH_VENDOR, \
  835. .idVendor = (vend), \
  836. .bInterfaceClass = (cl), \
  837. .bInterfaceSubClass = (sc), \
  838. .bInterfaceProtocol = (pr)
  839. /* ----------------------------------------------------------------------- */
  840. /* Stuff for dynamic usb ids */
  841. struct usb_dynids {
  842. spinlock_t lock;
  843. struct list_head list;
  844. };
  845. struct usb_dynid {
  846. struct list_head node;
  847. struct usb_device_id id;
  848. };
  849. extern ssize_t usb_store_new_id(struct usb_dynids *dynids,
  850. struct device_driver *driver,
  851. const char *buf, size_t count);
  852. extern ssize_t usb_show_dynids(struct usb_dynids *dynids, char *buf);
  853. /**
  854. * struct usbdrv_wrap - wrapper for driver-model structure
  855. * @driver: The driver-model core driver structure.
  856. * @for_devices: Non-zero for device drivers, 0 for interface drivers.
  857. */
  858. struct usbdrv_wrap {
  859. struct device_driver driver;
  860. int for_devices;
  861. };
  862. /**
  863. * struct usb_driver - identifies USB interface driver to usbcore
  864. * @name: The driver name should be unique among USB drivers,
  865. * and should normally be the same as the module name.
  866. * @probe: Called to see if the driver is willing to manage a particular
  867. * interface on a device. If it is, probe returns zero and uses
  868. * usb_set_intfdata() to associate driver-specific data with the
  869. * interface. It may also use usb_set_interface() to specify the
  870. * appropriate altsetting. If unwilling to manage the interface,
  871. * return -ENODEV, if genuine IO errors occurred, an appropriate
  872. * negative errno value.
  873. * @disconnect: Called when the interface is no longer accessible, usually
  874. * because its device has been (or is being) disconnected or the
  875. * driver module is being unloaded.
  876. * @unlocked_ioctl: Used for drivers that want to talk to userspace through
  877. * the "usbfs" filesystem. This lets devices provide ways to
  878. * expose information to user space regardless of where they
  879. * do (or don't) show up otherwise in the filesystem.
  880. * @suspend: Called when the device is going to be suspended by the
  881. * system either from system sleep or runtime suspend context. The
  882. * return value will be ignored in system sleep context, so do NOT
  883. * try to continue using the device if suspend fails in this case.
  884. * Instead, let the resume or reset-resume routine recover from
  885. * the failure.
  886. * @resume: Called when the device is being resumed by the system.
  887. * @reset_resume: Called when the suspended device has been reset instead
  888. * of being resumed.
  889. * @pre_reset: Called by usb_reset_device() when the device is about to be
  890. * reset. This routine must not return until the driver has no active
  891. * URBs for the device, and no more URBs may be submitted until the
  892. * post_reset method is called.
  893. * @post_reset: Called by usb_reset_device() after the device
  894. * has been reset
  895. * @id_table: USB drivers use ID table to support hotplugging.
  896. * Export this with MODULE_DEVICE_TABLE(usb,...). This must be set
  897. * or your driver's probe function will never get called.
  898. * @dynids: used internally to hold the list of dynamically added device
  899. * ids for this driver.
  900. * @drvwrap: Driver-model core structure wrapper.
  901. * @no_dynamic_id: if set to 1, the USB core will not allow dynamic ids to be
  902. * added to this driver by preventing the sysfs file from being created.
  903. * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
  904. * for interfaces bound to this driver.
  905. * @soft_unbind: if set to 1, the USB core will not kill URBs and disable
  906. * endpoints before calling the driver's disconnect method.
  907. * @disable_hub_initiated_lpm: if set to 0, the USB core will not allow hubs
  908. * to initiate lower power link state transitions when an idle timeout
  909. * occurs. Device-initiated USB 3.0 link PM will still be allowed.
  910. *
  911. * USB interface drivers must provide a name, probe() and disconnect()
  912. * methods, and an id_table. Other driver fields are optional.
  913. *
  914. * The id_table is used in hotplugging. It holds a set of descriptors,
  915. * and specialized data may be associated with each entry. That table
  916. * is used by both user and kernel mode hotplugging support.
  917. *
  918. * The probe() and disconnect() methods are called in a context where
  919. * they can sleep, but they should avoid abusing the privilege. Most
  920. * work to connect to a device should be done when the device is opened,
  921. * and undone at the last close. The disconnect code needs to address
  922. * concurrency issues with respect to open() and close() methods, as
  923. * well as forcing all pending I/O requests to complete (by unlinking
  924. * them as necessary, and blocking until the unlinks complete).
  925. */
  926. struct usb_driver {
  927. const char *name;
  928. int (*probe) (struct usb_interface *intf,
  929. const struct usb_device_id *id);
  930. void (*disconnect) (struct usb_interface *intf);
  931. int (*unlocked_ioctl) (struct usb_interface *intf, unsigned int code,
  932. void *buf);
  933. int (*suspend) (struct usb_interface *intf, pm_message_t message);
  934. int (*resume) (struct usb_interface *intf);
  935. int (*reset_resume)(struct usb_interface *intf);
  936. int (*pre_reset)(struct usb_interface *intf);
  937. int (*post_reset)(struct usb_interface *intf);
  938. const struct usb_device_id *id_table;
  939. struct usb_dynids dynids;
  940. struct usbdrv_wrap drvwrap;
  941. unsigned int no_dynamic_id:1;
  942. unsigned int supports_autosuspend:1;
  943. unsigned int disable_hub_initiated_lpm:1;
  944. unsigned int soft_unbind:1;
  945. };
  946. #define to_usb_driver(d) container_of(d, struct usb_driver, drvwrap.driver)
  947. /**
  948. * struct usb_device_driver - identifies USB device driver to usbcore
  949. * @name: The driver name should be unique among USB drivers,
  950. * and should normally be the same as the module name.
  951. * @probe: Called to see if the driver is willing to manage a particular
  952. * device. If it is, probe returns zero and uses dev_set_drvdata()
  953. * to associate driver-specific data with the device. If unwilling
  954. * to manage the device, return a negative errno value.
  955. * @disconnect: Called when the device is no longer accessible, usually
  956. * because it has been (or is being) disconnected or the driver's
  957. * module is being unloaded.
  958. * @suspend: Called when the device is going to be suspended by the system.
  959. * @resume: Called when the device is being resumed by the system.
  960. * @drvwrap: Driver-model core structure wrapper.
  961. * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
  962. * for devices bound to this driver.
  963. *
  964. * USB drivers must provide all the fields listed above except drvwrap.
  965. */
  966. struct usb_device_driver {
  967. const char *name;
  968. int (*probe) (struct usb_device *udev);
  969. void (*disconnect) (struct usb_device *udev);
  970. int (*suspend) (struct usb_device *udev, pm_message_t message);
  971. int (*resume) (struct usb_device *udev, pm_message_t message);
  972. struct usbdrv_wrap drvwrap;
  973. unsigned int supports_autosuspend:1;
  974. };
  975. #define to_usb_device_driver(d) container_of(d, struct usb_device_driver, \
  976. drvwrap.driver)
  977. extern struct bus_type usb_bus_type;
  978. /**
  979. * struct usb_class_driver - identifies a USB driver that wants to use the USB major number
  980. * @name: the usb class device name for this driver. Will show up in sysfs.
  981. * @devnode: Callback to provide a naming hint for a possible
  982. * device node to create.
  983. * @fops: pointer to the struct file_operations of this driver.
  984. * @minor_base: the start of the minor range for this driver.
  985. *
  986. * This structure is used for the usb_register_dev() and
  987. * usb_unregister_dev() functions, to consolidate a number of the
  988. * parameters used for them.
  989. */
  990. struct usb_class_driver {
  991. char *name;
  992. char *(*devnode)(struct device *dev, umode_t *mode);
  993. const struct file_operations *fops;
  994. int minor_base;
  995. };
  996. /*
  997. * use these in module_init()/module_exit()
  998. * and don't forget MODULE_DEVICE_TABLE(usb, ...)
  999. */
  1000. extern int usb_register_driver(struct usb_driver *, struct module *,
  1001. const char *);
  1002. /* use a define to avoid include chaining to get THIS_MODULE & friends */
  1003. #define usb_register(driver) \
  1004. usb_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
  1005. extern void usb_deregister(struct usb_driver *);
  1006. /**
  1007. * module_usb_driver() - Helper macro for registering a USB driver
  1008. * @__usb_driver: usb_driver struct
  1009. *
  1010. * Helper macro for USB drivers which do not do anything special in module
  1011. * init/exit. This eliminates a lot of boilerplate. Each module may only
  1012. * use this macro once, and calling it replaces module_init() and module_exit()
  1013. */
  1014. #define module_usb_driver(__usb_driver) \
  1015. module_driver(__usb_driver, usb_register, \
  1016. usb_deregister)
  1017. extern int usb_register_device_driver(struct usb_device_driver *,
  1018. struct module *);
  1019. extern void usb_deregister_device_driver(struct usb_device_driver *);
  1020. extern int usb_register_dev(struct usb_interface *intf,
  1021. struct usb_class_driver *class_driver);
  1022. extern void usb_deregister_dev(struct usb_interface *intf,
  1023. struct usb_class_driver *class_driver);
  1024. extern int usb_disabled(void);
  1025. /* ----------------------------------------------------------------------- */
  1026. /*
  1027. * URB support, for asynchronous request completions
  1028. */
  1029. /*
  1030. * urb->transfer_flags:
  1031. *
  1032. * Note: URB_DIR_IN/OUT is automatically set in usb_submit_urb().
  1033. */
  1034. #define URB_SHORT_NOT_OK 0x0001 /* report short reads as errors */
  1035. #define URB_ISO_ASAP 0x0002 /* iso-only; use the first unexpired
  1036. * slot in the schedule */
  1037. #define URB_NO_TRANSFER_DMA_MAP 0x0004 /* urb->transfer_dma valid on submit */
  1038. #define URB_NO_FSBR 0x0020 /* UHCI-specific */
  1039. #define URB_ZERO_PACKET 0x0040 /* Finish bulk OUT with short packet */
  1040. #define URB_NO_INTERRUPT 0x0080 /* HINT: no non-error interrupt
  1041. * needed */
  1042. #define URB_FREE_BUFFER 0x0100 /* Free transfer buffer with the URB */
  1043. /* The following flags are used internally by usbcore and HCDs */
  1044. #define URB_DIR_IN 0x0200 /* Transfer from device to host */
  1045. #define URB_DIR_OUT 0
  1046. #define URB_DIR_MASK URB_DIR_IN
  1047. #define URB_DMA_MAP_SINGLE 0x00010000 /* Non-scatter-gather mapping */
  1048. #define URB_DMA_MAP_PAGE 0x00020000 /* HCD-unsupported S-G */
  1049. #define URB_DMA_MAP_SG 0x00040000 /* HCD-supported S-G */
  1050. #define URB_MAP_LOCAL 0x00080000 /* HCD-local-memory mapping */
  1051. #define URB_SETUP_MAP_SINGLE 0x00100000 /* Setup packet DMA mapped */
  1052. #define URB_SETUP_MAP_LOCAL 0x00200000 /* HCD-local setup packet */
  1053. #define URB_DMA_SG_COMBINED 0x00400000 /* S-G entries were combined */
  1054. #define URB_ALIGNED_TEMP_BUFFER 0x00800000 /* Temp buffer was alloc'd */
  1055. struct usb_iso_packet_descriptor {
  1056. unsigned int offset;
  1057. unsigned int length; /* expected length */
  1058. unsigned int actual_length;
  1059. int status;
  1060. };
  1061. struct urb;
  1062. struct usb_anchor {
  1063. struct list_head urb_list;
  1064. wait_queue_head_t wait;
  1065. spinlock_t lock;
  1066. unsigned int poisoned:1;
  1067. };
  1068. static inline void init_usb_anchor(struct usb_anchor *anchor)
  1069. {
  1070. INIT_LIST_HEAD(&anchor->urb_list);
  1071. init_waitqueue_head(&anchor->wait);
  1072. spin_lock_init(&anchor->lock);
  1073. }
  1074. typedef void (*usb_complete_t)(struct urb *);
  1075. /**
  1076. * struct urb - USB Request Block
  1077. * @urb_list: For use by current owner of the URB.
  1078. * @anchor_list: membership in the list of an anchor
  1079. * @anchor: to anchor URBs to a common mooring
  1080. * @ep: Points to the endpoint's data structure. Will eventually
  1081. * replace @pipe.
  1082. * @pipe: Holds endpoint number, direction, type, and more.
  1083. * Create these values with the eight macros available;
  1084. * usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl"
  1085. * (control), "bulk", "int" (interrupt), or "iso" (isochronous).
  1086. * For example usb_sndbulkpipe() or usb_rcvintpipe(). Endpoint
  1087. * numbers range from zero to fifteen. Note that "in" endpoint two
  1088. * is a different endpoint (and pipe) from "out" endpoint two.
  1089. * The current configuration controls the existence, type, and
  1090. * maximum packet size of any given endpoint.
  1091. * @stream_id: the endpoint's stream ID for bulk streams
  1092. * @dev: Identifies the USB device to perform the request.
  1093. * @status: This is read in non-iso completion functions to get the
  1094. * status of the particular request. ISO requests only use it
  1095. * to tell whether the URB was unlinked; detailed status for
  1096. * each frame is in the fields of the iso_frame-desc.
  1097. * @transfer_flags: A variety of flags may be used to affect how URB
  1098. * submission, unlinking, or operation are handled. Different
  1099. * kinds of URB can use different flags.
  1100. * @transfer_buffer: This identifies the buffer to (or from) which the I/O
  1101. * request will be performed unless URB_NO_TRANSFER_DMA_MAP is set
  1102. * (however, do not leave garbage in transfer_buffer even then).
  1103. * This buffer must be suitable for DMA; allocate it with
  1104. * kmalloc() or equivalent. For transfers to "in" endpoints, contents
  1105. * of this buffer will be modified. This buffer is used for the data
  1106. * stage of control transfers.
  1107. * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP,
  1108. * the device driver is saying that it provided this DMA address,
  1109. * which the host controller driver should use in preference to the
  1110. * transfer_buffer.
  1111. * @sg: scatter gather buffer list, the buffer size of each element in
  1112. * the list (except the last) must be divisible by the endpoint's
  1113. * max packet size
  1114. * @num_mapped_sgs: (internal) number of mapped sg entries
  1115. * @num_sgs: number of entries in the sg list
  1116. * @transfer_buffer_length: How big is transfer_buffer. The transfer may
  1117. * be broken up into chunks according to the current maximum packet
  1118. * size for the endpoint, which is a function of the configuration
  1119. * and is encoded in the pipe. When the length is zero, neither
  1120. * transfer_buffer nor transfer_dma is used.
  1121. * @actual_length: This is read in non-iso completion functions, and
  1122. * it tells how many bytes (out of transfer_buffer_length) were
  1123. * transferred. It will normally be the same as requested, unless
  1124. * either an error was reported or a short read was performed.
  1125. * The URB_SHORT_NOT_OK transfer flag may be used to make such
  1126. * short reads be reported as errors.
  1127. * @setup_packet: Only used for control transfers, this points to eight bytes
  1128. * of setup data. Control transfers always start by sending this data
  1129. * to the device. Then transfer_buffer is read or written, if needed.
  1130. * @setup_dma: DMA pointer for the setup packet. The caller must not use
  1131. * this field; setup_packet must point to a valid buffer.
  1132. * @start_frame: Returns the initial frame for isochronous transfers.
  1133. * @number_of_packets: Lists the number of ISO transfer buffers.
  1134. * @interval: Specifies the polling interval for interrupt or isochronous
  1135. * transfers. The units are frames (milliseconds) for full and low
  1136. * speed devices, and microframes (1/8 millisecond) for highspeed
  1137. * and SuperSpeed devices.
  1138. * @error_count: Returns the number of ISO transfers that reported errors.
  1139. * @context: For use in completion functions. This normally points to
  1140. * request-specific driver context.
  1141. * @complete: Completion handler. This URB is passed as the parameter to the
  1142. * completion function. The completion function may then do what
  1143. * it likes with the URB, including resubmitting or freeing it.
  1144. * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to
  1145. * collect the transfer status for each buffer.
  1146. *
  1147. * This structure identifies USB transfer requests. URBs must be allocated by
  1148. * calling usb_alloc_urb() and freed with a call to usb_free_urb().
  1149. * Initialization may be done using various usb_fill_*_urb() functions. URBs
  1150. * are submitted using usb_submit_urb(), and pending requests may be canceled
  1151. * using usb_unlink_urb() or usb_kill_urb().
  1152. *
  1153. * Data Transfer Buffers:
  1154. *
  1155. * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise
  1156. * taken from the general page pool. That is provided by transfer_buffer
  1157. * (control requests also use setup_packet), and host controller drivers
  1158. * perform a dma mapping (and unmapping) for each buffer transferred. Those
  1159. * mapping operations can be expensive on some platforms (perhaps using a dma
  1160. * bounce buffer or talking to an IOMMU),
  1161. * although they're cheap on commodity x86 and ppc hardware.
  1162. *
  1163. * Alternatively, drivers may pass the URB_NO_TRANSFER_DMA_MAP transfer flag,
  1164. * which tells the host controller driver that no such mapping is needed for
  1165. * the transfer_buffer since
  1166. * the device driver is DMA-aware. For example, a device driver might
  1167. * allocate a DMA buffer with usb_alloc_coherent() or call usb_buffer_map().
  1168. * When this transfer flag is provided, host controller drivers will
  1169. * attempt to use the dma address found in the transfer_dma
  1170. * field rather than determining a dma address themselves.
  1171. *
  1172. * Note that transfer_buffer must still be set if the controller
  1173. * does not support DMA (as indicated by bus.uses_dma) and when talking
  1174. * to root hub. If you have to trasfer between highmem zone and the device
  1175. * on such controller, create a bounce buffer or bail out with an error.
  1176. * If transfer_buffer cannot be set (is in highmem) and the controller is DMA
  1177. * capable, assign NULL to it, so that usbmon knows not to use the value.
  1178. * The setup_packet must always be set, so it cannot be located in highmem.
  1179. *
  1180. * Initialization:
  1181. *
  1182. * All URBs submitted must initialize the dev, pipe, transfer_flags (may be
  1183. * zero), and complete fields. All URBs must also initialize
  1184. * transfer_buffer and transfer_buffer_length. They may provide the
  1185. * URB_SHORT_NOT_OK transfer flag, indicating that short reads are
  1186. * to be treated as errors; that flag is invalid for write requests.
  1187. *
  1188. * Bulk URBs may
  1189. * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers
  1190. * should always terminate with a short packet, even if it means adding an
  1191. * extra zero length packet.
  1192. *
  1193. * Control URBs must provide a valid pointer in the setup_packet field.
  1194. * Unlike the transfer_buffer, the setup_packet may not be mapped for DMA
  1195. * beforehand.
  1196. *
  1197. * Interrupt URBs must provide an interval, saying how often (in milliseconds
  1198. * or, for highspeed devices, 125 microsecond units)
  1199. * to poll for transfers. After the URB has been submitted, the interval
  1200. * field reflects how the transfer was actually scheduled.
  1201. * The polling interval may be more frequent than requested.
  1202. * For example, some controllers have a maximum interval of 32 milliseconds,
  1203. * while others support intervals of up to 1024 milliseconds.
  1204. * Isochronous URBs also have transfer intervals. (Note that for isochronous
  1205. * endpoints, as well as high speed interrupt endpoints, the encoding of
  1206. * the transfer interval in the endpoint descriptor is logarithmic.
  1207. * Device drivers must convert that value to linear units themselves.)
  1208. *
  1209. * If an isochronous endpoint queue isn't already running, the host
  1210. * controller will schedule a new URB to start as soon as bandwidth
  1211. * utilization allows. If the queue is running then a new URB will be
  1212. * scheduled to start in the first transfer slot following the end of the
  1213. * preceding URB, if that slot has not already expired. If the slot has
  1214. * expired (which can happen when IRQ delivery is delayed for a long time),
  1215. * the scheduling behavior depends on the URB_ISO_ASAP flag. If the flag
  1216. * is clear then the URB will be scheduled to start in the expired slot,
  1217. * implying that some of its packets will not be transferred; if the flag
  1218. * is set then the URB will be scheduled in the first unexpired slot,
  1219. * breaking the queue's synchronization. Upon URB completion, the
  1220. * start_frame field will be set to the (micro)frame number in which the
  1221. * transfer was scheduled. Ranges for frame counter values are HC-specific
  1222. * and can go from as low as 256 to as high as 65536 frames.
  1223. *
  1224. * Isochronous URBs have a different data transfer model, in part because
  1225. * the quality of service is only "best effort". Callers provide specially
  1226. * allocated URBs, with number_of_packets worth of iso_frame_desc structures
  1227. * at the end. Each such packet is an individual ISO transfer. Isochronous
  1228. * URBs are normally queued, submitted by drivers to arrange that
  1229. * transfers are at least double buffered, and then explicitly resubmitted
  1230. * in completion handlers, so
  1231. * that data (such as audio or video) streams at as constant a rate as the
  1232. * host controller scheduler can support.
  1233. *
  1234. * Completion Callbacks:
  1235. *
  1236. * The completion callback is made in_interrupt(), and one of the first
  1237. * things that a completion handler should do is check the status field.
  1238. * The status field is provided for all URBs. It is used to report
  1239. * unlinked URBs, and status for all non-ISO transfers. It should not
  1240. * be examined before the URB is returned to the completion handler.
  1241. *
  1242. * The context field is normally used to link URBs back to the relevant
  1243. * driver or request state.
  1244. *
  1245. * When the completion callback is invoked for non-isochronous URBs, the
  1246. * actual_length field tells how many bytes were transferred. This field
  1247. * is updated even when the URB terminated with an error or was unlinked.
  1248. *
  1249. * ISO transfer status is reported in the status and actual_length fields
  1250. * of the iso_frame_desc array, and the number of errors is reported in
  1251. * error_count. Completion callbacks for ISO transfers will normally
  1252. * (re)submit URBs to ensure a constant transfer rate.
  1253. *
  1254. * Note that even fields marked "public" should not be touched by the driver
  1255. * when the urb is owned by the hcd, that is, since the call to
  1256. * usb_submit_urb() till the entry into the completion routine.
  1257. */
  1258. struct urb {
  1259. /* private: usb core and host controller only fields in the urb */
  1260. struct kref kref; /* reference count of the URB */
  1261. void *hcpriv; /* private data for host controller */
  1262. atomic_t use_count; /* concurrent submissions counter */
  1263. atomic_t reject; /* submissions will fail */
  1264. int unlinked; /* unlink error code */
  1265. /* public: documented fields in the urb that can be used by drivers */
  1266. struct list_head urb_list; /* list head for use by the urb's
  1267. * current owner */
  1268. struct list_head anchor_list; /* the URB may be anchored */
  1269. struct usb_anchor *anchor;
  1270. struct usb_device *dev; /* (in) pointer to associated device */
  1271. struct usb_host_endpoint *ep; /* (internal) pointer to endpoint */
  1272. unsigned int pipe; /* (in) pipe information */
  1273. unsigned int stream_id; /* (in) stream ID */
  1274. int status; /* (return) non-ISO status */
  1275. unsigned int transfer_flags; /* (in) URB_SHORT_NOT_OK | ...*/
  1276. void *transfer_buffer; /* (in) associated data buffer */
  1277. dma_addr_t transfer_dma; /* (in) dma addr for transfer_buffer */
  1278. struct scatterlist *sg; /* (in) scatter gather buffer list */
  1279. int num_mapped_sgs; /* (internal) mapped sg entries */
  1280. int num_sgs; /* (in) number of entries in the sg list */
  1281. u32 transfer_buffer_length; /* (in) data buffer length */
  1282. u32 actual_length; /* (return) actual transfer length */
  1283. unsigned char *setup_packet; /* (in) setup packet (control only) */
  1284. dma_addr_t setup_dma; /* (in) dma addr for setup_packet */
  1285. int start_frame; /* (modify) start frame (ISO) */
  1286. int number_of_packets; /* (in) number of ISO packets */
  1287. int interval; /* (modify) transfer interval
  1288. * (INT/ISO) */
  1289. int error_count; /* (return) number of ISO errors */
  1290. void *context; /* (in) context for completion */
  1291. usb_complete_t complete; /* (in) completion routine */
  1292. struct usb_iso_packet_descriptor iso_frame_desc[0];
  1293. /* (in) ISO ONLY */
  1294. };
  1295. /* ----------------------------------------------------------------------- */
  1296. /**
  1297. * usb_fill_control_urb - initializes a control urb
  1298. * @urb: pointer to the urb to initialize.
  1299. * @dev: pointer to the struct usb_device for this urb.
  1300. * @pipe: the endpoint pipe
  1301. * @setup_packet: pointer to the setup_packet buffer
  1302. * @transfer_buffer: pointer to the transfer buffer
  1303. * @buffer_length: length of the transfer buffer
  1304. * @complete_fn: pointer to the usb_complete_t function
  1305. * @context: what to set the urb context to.
  1306. *
  1307. * Initializes a control urb with the proper information needed to submit
  1308. * it to a device.
  1309. */
  1310. static inline void usb_fill_control_urb(struct urb *urb,
  1311. struct usb_device *dev,
  1312. unsigned int pipe,
  1313. unsigned char *setup_packet,
  1314. void *transfer_buffer,
  1315. int buffer_length,
  1316. usb_complete_t complete_fn,
  1317. void *context)
  1318. {
  1319. urb->dev = dev;
  1320. urb->pipe = pipe;
  1321. urb->setup_packet = setup_packet;
  1322. urb->transfer_buffer = transfer_buffer;
  1323. urb->transfer_buffer_length = buffer_length;
  1324. urb->complete = complete_fn;
  1325. urb->context = context;
  1326. }
  1327. /**
  1328. * usb_fill_bulk_urb - macro to help initialize a bulk urb
  1329. * @urb: pointer to the urb to initialize.
  1330. * @dev: pointer to the struct usb_device for this urb.
  1331. * @pipe: the endpoint pipe
  1332. * @transfer_buffer: pointer to the transfer buffer
  1333. * @buffer_length: length of the transfer buffer
  1334. * @complete_fn: pointer to the usb_complete_t function
  1335. * @context: what to set the urb context to.
  1336. *
  1337. * Initializes a bulk urb with the proper information needed to submit it
  1338. * to a device.
  1339. */
  1340. static inline void usb_fill_bulk_urb(struct urb *urb,
  1341. struct usb_device *dev,
  1342. unsigned int pipe,
  1343. void *transfer_buffer,
  1344. int buffer_length,
  1345. usb_complete_t complete_fn,
  1346. void *context)
  1347. {
  1348. urb->dev = dev;
  1349. urb->pipe = pipe;
  1350. urb->transfer_buffer = transfer_buffer;
  1351. urb->transfer_buffer_length = buffer_length;
  1352. urb->complete = complete_fn;
  1353. urb->context = context;
  1354. }
  1355. /**
  1356. * usb_fill_int_urb - macro to help initialize a interrupt urb
  1357. * @urb: pointer to the urb to initialize.
  1358. * @dev: pointer to the struct usb_device for this urb.
  1359. * @pipe: the endpoint pipe
  1360. * @transfer_buffer: pointer to the transfer buffer
  1361. * @buffer_length: length of the transfer buffer
  1362. * @complete_fn: pointer to the usb_complete_t function
  1363. * @context: what to set the urb context to.
  1364. * @interval: what to set the urb interval to, encoded like
  1365. * the endpoint descriptor's bInterval value.
  1366. *
  1367. * Initializes a interrupt urb with the proper information needed to submit
  1368. * it to a device.
  1369. *
  1370. * Note that High Speed and SuperSpeed interrupt endpoints use a logarithmic
  1371. * encoding of the endpoint interval, and express polling intervals in
  1372. * microframes (eight per millisecond) rather than in frames (one per
  1373. * millisecond).
  1374. *
  1375. * Wireless USB also uses the logarithmic encoding, but specifies it in units of
  1376. * 128us instead of 125us. For Wireless USB devices, the interval is passed
  1377. * through to the host controller, rather than being translated into microframe
  1378. * units.
  1379. */
  1380. static inline void usb_fill_int_urb(struct urb *urb,
  1381. struct usb_device *dev,
  1382. unsigned int pipe,
  1383. void *transfer_buffer,
  1384. int buffer_length,
  1385. usb_complete_t complete_fn,
  1386. void *context,
  1387. int interval)
  1388. {
  1389. urb->dev = dev;
  1390. urb->pipe = pipe;
  1391. urb->transfer_buffer = transfer_buffer;
  1392. urb->transfer_buffer_length = buffer_length;
  1393. urb->complete = complete_fn;
  1394. urb->context = context;
  1395. if (dev->speed == USB_SPEED_HIGH || dev->speed == USB_SPEED_SUPER) {
  1396. /* make sure interval is within allowed range */
  1397. interval = clamp(interval, 1, 16);
  1398. urb->interval = 1 << (interval - 1);
  1399. } else {
  1400. urb->interval = interval;
  1401. }
  1402. urb->start_frame = -1;
  1403. }
  1404. extern void usb_init_urb(struct urb *urb);
  1405. extern struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags);
  1406. extern void usb_free_urb(struct urb *urb);
  1407. #define usb_put_urb usb_free_urb
  1408. extern struct urb *usb_get_urb(struct urb *urb);
  1409. extern int usb_submit_urb(struct urb *urb, gfp_t mem_flags);
  1410. extern int usb_unlink_urb(struct urb *urb);
  1411. extern void usb_kill_urb(struct urb *urb);
  1412. extern void usb_poison_urb(struct urb *urb);
  1413. extern void usb_unpoison_urb(struct urb *urb);
  1414. extern void usb_block_urb(struct urb *urb);
  1415. extern void usb_kill_anchored_urbs(struct usb_anchor *anchor);
  1416. extern void usb_poison_anchored_urbs(struct usb_anchor *anchor);
  1417. extern void usb_unpoison_anchored_urbs(struct usb_anchor *anchor);
  1418. extern void usb_unlink_anchored_urbs(struct usb_anchor *anchor);
  1419. extern void usb_anchor_urb(struct urb *urb, struct usb_anchor *anchor);
  1420. extern void usb_unanchor_urb(struct urb *urb);
  1421. extern int usb_wait_anchor_empty_timeout(struct usb_anchor *anchor,
  1422. unsigned int timeout);
  1423. extern struct urb *usb_get_from_anchor(struct usb_anchor *anchor);
  1424. extern void usb_scuttle_anchored_urbs(struct usb_anchor *anchor);
  1425. extern int usb_anchor_empty(struct usb_anchor *anchor);
  1426. #define usb_unblock_urb usb_unpoison_urb
  1427. /**
  1428. * usb_urb_dir_in - check if an URB describes an IN transfer
  1429. * @urb: URB to be checked
  1430. *
  1431. * Return: 1 if @urb describes an IN transfer (device-to-host),
  1432. * otherwise 0.
  1433. */
  1434. static inline int usb_urb_dir_in(struct urb *urb)
  1435. {
  1436. return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_IN;
  1437. }
  1438. /**
  1439. * usb_urb_dir_out - check if an URB describes an OUT transfer
  1440. * @urb: URB to be checked
  1441. *
  1442. * Return: 1 if @urb describes an OUT transfer (host-to-device),
  1443. * otherwise 0.
  1444. */
  1445. static inline int usb_urb_dir_out(struct urb *urb)
  1446. {
  1447. return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_OUT;
  1448. }
  1449. void *usb_alloc_coherent(struct usb_device *dev, size_t size,
  1450. gfp_t mem_flags, dma_addr_t *dma);
  1451. void usb_free_coherent(struct usb_device *dev, size_t size,
  1452. void *addr, dma_addr_t dma);
  1453. #if 0
  1454. struct urb *usb_buffer_map(struct urb *urb);
  1455. void usb_buffer_dmasync(struct urb *urb);
  1456. void usb_buffer_unmap(struct urb *urb);
  1457. #endif
  1458. struct scatterlist;
  1459. int usb_buffer_map_sg(const struct usb_device *dev, int is_in,
  1460. struct scatterlist *sg, int nents);
  1461. #if 0
  1462. void usb_buffer_dmasync_sg(const struct usb_device *dev, int is_in,
  1463. struct scatterlist *sg, int n_hw_ents);
  1464. #endif
  1465. void usb_buffer_unmap_sg(const struct usb_device *dev, int is_in,
  1466. struct scatterlist *sg, int n_hw_ents);
  1467. /*-------------------------------------------------------------------*
  1468. * SYNCHRONOUS CALL SUPPORT *
  1469. *-------------------------------------------------------------------*/
  1470. extern int usb_control_msg(struct usb_device *dev, unsigned int pipe,
  1471. __u8 request, __u8 requesttype, __u16 value, __u16 index,
  1472. void *data, __u16 size, int timeout);
  1473. extern int usb_interrupt_msg(struct usb_device *usb_dev, unsigned int pipe,
  1474. void *data, int len, int *actual_length, int timeout);
  1475. extern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,
  1476. void *data, int len, int *actual_length,
  1477. int timeout);
  1478. /* wrappers around usb_control_msg() for the most common standard requests */
  1479. extern int usb_get_descriptor(struct usb_device *dev, unsigned char desctype,
  1480. unsigned char descindex, void *buf, int size);
  1481. extern int usb_get_status(struct usb_device *dev,
  1482. int type, int target, void *data);
  1483. extern int usb_string(struct usb_device *dev, int index,
  1484. char *buf, size_t size);
  1485. /* wrappers that also update important state inside usbcore */
  1486. extern int usb_clear_halt(struct usb_device *dev, int pipe);
  1487. extern int usb_reset_configuration(struct usb_device *dev);
  1488. extern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate);
  1489. extern void usb_reset_endpoint(struct usb_device *dev, unsigned int epaddr);
  1490. /* this request isn't really synchronous, but it belongs with the others */
  1491. extern int usb_driver_set_configuration(struct usb_device *udev, int config);
  1492. /*
  1493. * timeouts, in milliseconds, used for sending/receiving control messages
  1494. * they typically complete within a few frames (msec) after they're issued
  1495. * USB identifies 5 second timeouts, maybe more in a few cases, and a few
  1496. * slow devices (like some MGE Ellipse UPSes) actually push that limit.
  1497. */
  1498. #define USB_CTRL_GET_TIMEOUT 5000
  1499. #define USB_CTRL_SET_TIMEOUT 5000
  1500. /**
  1501. * struct usb_sg_request - support for scatter/gather I/O
  1502. * @status: zero indicates success, else negative errno
  1503. * @bytes: counts bytes transferred.
  1504. *
  1505. * These requests are initialized using usb_sg_init(), and then are used
  1506. * as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most
  1507. * members of the request object aren't for driver access.
  1508. *
  1509. * The status and bytecount values are valid only after usb_sg_wait()
  1510. * returns. If the status is zero, then the bytecount matches the total
  1511. * from the request.
  1512. *
  1513. * After an error completion, drivers may need to clear a halt condition
  1514. * on the endpoint.
  1515. */
  1516. struct usb_sg_request {
  1517. int status;
  1518. size_t bytes;
  1519. /* private:
  1520. * members below are private to usbcore,
  1521. * and are not provided for driver access!
  1522. */
  1523. spinlock_t lock;
  1524. struct usb_device *dev;
  1525. int pipe;
  1526. int entries;
  1527. struct urb **urbs;
  1528. int count;
  1529. struct completion complete;
  1530. };
  1531. int usb_sg_init(
  1532. struct usb_sg_request *io,
  1533. struct usb_device *dev,
  1534. unsigned pipe,
  1535. unsigned period,
  1536. struct scatterlist *sg,
  1537. int nents,
  1538. size_t length,
  1539. gfp_t mem_flags
  1540. );
  1541. void usb_sg_cancel(struct usb_sg_request *io);
  1542. void usb_sg_wait(struct usb_sg_request *io);
  1543. /* ----------------------------------------------------------------------- */
  1544. /*
  1545. * For various legacy reasons, Linux has a small cookie that's paired with
  1546. * a struct usb_device to identify an endpoint queue. Queue characteristics
  1547. * are defined by the endpoint's descriptor. This cookie is called a "pipe",
  1548. * an unsigned int encoded as:
  1549. *
  1550. * - direction: bit 7 (0 = Host-to-Device [Out],
  1551. * 1 = Device-to-Host [In] ...
  1552. * like endpoint bEndpointAddress)
  1553. * - device address: bits 8-14 ... bit positions known to uhci-hcd
  1554. * - endpoint: bits 15-18 ... bit positions known to uhci-hcd
  1555. * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
  1556. * 10 = control, 11 = bulk)
  1557. *
  1558. * Given the device address and endpoint descriptor, pipes are redundant.
  1559. */
  1560. /* NOTE: these are not the standard USB_ENDPOINT_XFER_* values!! */
  1561. /* (yet ... they're the values used by usbfs) */
  1562. #define PIPE_ISOCHRONOUS 0
  1563. #define PIPE_INTERRUPT 1
  1564. #define PIPE_CONTROL 2
  1565. #define PIPE_BULK 3
  1566. #define usb_pipein(pipe) ((pipe) & USB_DIR_IN)
  1567. #define usb_pipeout(pipe) (!usb_pipein(pipe))
  1568. #define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
  1569. #define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
  1570. #define usb_pipetype(pipe) (((pipe) >> 30) & 3)
  1571. #define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
  1572. #define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
  1573. #define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
  1574. #define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
  1575. static inline unsigned int __create_pipe(struct usb_device *dev,
  1576. unsigned int endpoint)
  1577. {
  1578. return (dev->devnum << 8) | (endpoint << 15);
  1579. }
  1580. /* Create various pipes... */
  1581. #define usb_sndctrlpipe(dev, endpoint) \
  1582. ((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint))
  1583. #define usb_rcvctrlpipe(dev, endpoint) \
  1584. ((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
  1585. #define usb_sndisocpipe(dev, endpoint) \
  1586. ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint))
  1587. #define usb_rcvisocpipe(dev, endpoint) \
  1588. ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
  1589. #define usb_sndbulkpipe(dev, endpoint) \
  1590. ((PIPE_BULK << 30) | __create_pipe(dev, endpoint))
  1591. #define usb_rcvbulkpipe(dev, endpoint) \
  1592. ((PIPE_BULK << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
  1593. #define usb_sndintpipe(dev, endpoint) \
  1594. ((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint))
  1595. #define usb_rcvintpipe(dev, endpoint) \
  1596. ((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
  1597. static inline struct usb_host_endpoint *
  1598. usb_pipe_endpoint(struct usb_device *dev, unsigned int pipe)
  1599. {
  1600. struct usb_host_endpoint **eps;
  1601. eps = usb_pipein(pipe) ? dev->ep_in : dev->ep_out;
  1602. return eps[usb_pipeendpoint(pipe)];
  1603. }
  1604. /*-------------------------------------------------------------------------*/
  1605. static inline __u16
  1606. usb_maxpacket(struct usb_device *udev, int pipe, int is_out)
  1607. {
  1608. struct usb_host_endpoint *ep;
  1609. unsigned epnum = usb_pipeendpoint(pipe);
  1610. if (is_out) {
  1611. WARN_ON(usb_pipein(pipe));
  1612. ep = udev->ep_out[epnum];
  1613. } else {
  1614. WARN_ON(usb_pipeout(pipe));
  1615. ep = udev->ep_in[epnum];
  1616. }
  1617. if (!ep)
  1618. return 0;
  1619. /* NOTE: only 0x07ff bits are for packet size... */
  1620. return usb_endpoint_maxp(&ep->desc);
  1621. }
  1622. /* ----------------------------------------------------------------------- */
  1623. /* translate USB error codes to codes user space understands */
  1624. static inline int usb_translate_errors(int error_code)
  1625. {
  1626. switch (error_code) {
  1627. case 0:
  1628. case -ENOMEM:
  1629. case -ENODEV:
  1630. case -EOPNOTSUPP:
  1631. return error_code;
  1632. default:
  1633. return -EIO;
  1634. }
  1635. }
  1636. /* Events from the usb core */
  1637. #define USB_DEVICE_ADD 0x0001
  1638. #define USB_DEVICE_REMOVE 0x0002
  1639. #define USB_BUS_ADD 0x0003
  1640. #define USB_BUS_REMOVE 0x0004
  1641. extern void usb_register_notify(struct notifier_block *nb);
  1642. extern void usb_unregister_notify(struct notifier_block *nb);
  1643. /* debugfs stuff */
  1644. extern struct dentry *usb_debug_root;
  1645. #endif /* __KERNEL__ */
  1646. #endif