usb.h 56 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461
  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. struct usb_device;
  19. struct usb_driver;
  20. /*-------------------------------------------------------------------------*/
  21. /*
  22. * Host-side wrappers for standard USB descriptors ... these are parsed
  23. * from the data provided by devices. Parsing turns them from a flat
  24. * sequence of descriptors into a hierarchy:
  25. *
  26. * - devices have one (usually) or more configs;
  27. * - configs have one (often) or more interfaces;
  28. * - interfaces have one (usually) or more settings;
  29. * - each interface setting has zero or (usually) more endpoints.
  30. *
  31. * And there might be other descriptors mixed in with those.
  32. *
  33. * Devices may also have class-specific or vendor-specific descriptors.
  34. */
  35. struct ep_device;
  36. /**
  37. * struct usb_host_endpoint - host-side endpoint descriptor and queue
  38. * @desc: descriptor for this endpoint, wMaxPacketSize in native byteorder
  39. * @urb_list: urbs queued to this endpoint; maintained by usbcore
  40. * @hcpriv: for use by HCD; typically holds hardware dma queue head (QH)
  41. * with one or more transfer descriptors (TDs) per urb
  42. * @ep_dev: ep_device for sysfs info
  43. * @extra: descriptors following this endpoint in the configuration
  44. * @extralen: how many bytes of "extra" are valid
  45. *
  46. * USB requests are always queued to a given endpoint, identified by a
  47. * descriptor within an active interface in a given USB configuration.
  48. */
  49. struct usb_host_endpoint {
  50. struct usb_endpoint_descriptor desc;
  51. struct list_head urb_list;
  52. void *hcpriv;
  53. struct ep_device *ep_dev; /* For sysfs info */
  54. unsigned char *extra; /* Extra descriptors */
  55. int extralen;
  56. };
  57. /* host-side wrapper for one interface setting's parsed descriptors */
  58. struct usb_host_interface {
  59. struct usb_interface_descriptor desc;
  60. /* array of desc.bNumEndpoint endpoints associated with this
  61. * interface setting. these will be in no particular order.
  62. */
  63. struct usb_host_endpoint *endpoint;
  64. char *string; /* iInterface string, if present */
  65. unsigned char *extra; /* Extra descriptors */
  66. int extralen;
  67. };
  68. enum usb_interface_condition {
  69. USB_INTERFACE_UNBOUND = 0,
  70. USB_INTERFACE_BINDING,
  71. USB_INTERFACE_BOUND,
  72. USB_INTERFACE_UNBINDING,
  73. };
  74. /**
  75. * struct usb_interface - what usb device drivers talk to
  76. * @altsetting: array of interface structures, one for each alternate
  77. * setting that may be selected. Each one includes a set of
  78. * endpoint configurations. They will be in no particular order.
  79. * @num_altsetting: number of altsettings defined.
  80. * @cur_altsetting: the current altsetting.
  81. * @driver: the USB driver that is bound to this interface.
  82. * @minor: the minor number assigned to this interface, if this
  83. * interface is bound to a driver that uses the USB major number.
  84. * If this interface does not use the USB major, this field should
  85. * be unused. The driver should set this value in the probe()
  86. * function of the driver, after it has been assigned a minor
  87. * number from the USB core by calling usb_register_dev().
  88. * @condition: binding state of the interface: not bound, binding
  89. * (in probe()), bound to a driver, or unbinding (in disconnect())
  90. * @is_active: flag set when the interface is bound and not suspended.
  91. * @needs_remote_wakeup: flag set when the driver requires remote-wakeup
  92. * capability during autosuspend.
  93. * @dev: driver model's view of this device
  94. * @class_dev: driver model's class view of this device.
  95. * @pm_usage_cnt: PM usage counter for this interface; autosuspend is not
  96. * allowed unless the counter is 0.
  97. *
  98. * USB device drivers attach to interfaces on a physical device. Each
  99. * interface encapsulates a single high level function, such as feeding
  100. * an audio stream to a speaker or reporting a change in a volume control.
  101. * Many USB devices only have one interface. The protocol used to talk to
  102. * an interface's endpoints can be defined in a usb "class" specification,
  103. * or by a product's vendor. The (default) control endpoint is part of
  104. * every interface, but is never listed among the interface's descriptors.
  105. *
  106. * The driver that is bound to the interface can use standard driver model
  107. * calls such as dev_get_drvdata() on the dev member of this structure.
  108. *
  109. * Each interface may have alternate settings. The initial configuration
  110. * of a device sets altsetting 0, but the device driver can change
  111. * that setting using usb_set_interface(). Alternate settings are often
  112. * used to control the the use of periodic endpoints, such as by having
  113. * different endpoints use different amounts of reserved USB bandwidth.
  114. * All standards-conformant USB devices that use isochronous endpoints
  115. * will use them in non-default settings.
  116. *
  117. * The USB specification says that alternate setting numbers must run from
  118. * 0 to one less than the total number of alternate settings. But some
  119. * devices manage to mess this up, and the structures aren't necessarily
  120. * stored in numerical order anyhow. Use usb_altnum_to_altsetting() to
  121. * look up an alternate setting in the altsetting array based on its number.
  122. */
  123. struct usb_interface {
  124. /* array of alternate settings for this interface,
  125. * stored in no particular order */
  126. struct usb_host_interface *altsetting;
  127. struct usb_host_interface *cur_altsetting; /* the currently
  128. * active alternate setting */
  129. unsigned num_altsetting; /* number of alternate settings */
  130. int minor; /* minor number this interface is
  131. * bound to */
  132. enum usb_interface_condition condition; /* state of binding */
  133. unsigned is_active:1; /* the interface is not suspended */
  134. unsigned needs_remote_wakeup:1; /* driver requires remote wakeup */
  135. struct device dev; /* interface specific device info */
  136. struct class_device *class_dev;
  137. int pm_usage_cnt; /* usage counter for autosuspend */
  138. };
  139. #define to_usb_interface(d) container_of(d, struct usb_interface, dev)
  140. #define interface_to_usbdev(intf) \
  141. container_of(intf->dev.parent, struct usb_device, dev)
  142. static inline void *usb_get_intfdata (struct usb_interface *intf)
  143. {
  144. return dev_get_drvdata (&intf->dev);
  145. }
  146. static inline void usb_set_intfdata (struct usb_interface *intf, void *data)
  147. {
  148. dev_set_drvdata(&intf->dev, data);
  149. }
  150. struct usb_interface *usb_get_intf(struct usb_interface *intf);
  151. void usb_put_intf(struct usb_interface *intf);
  152. /* this maximum is arbitrary */
  153. #define USB_MAXINTERFACES 32
  154. /**
  155. * struct usb_interface_cache - long-term representation of a device interface
  156. * @num_altsetting: number of altsettings defined.
  157. * @ref: reference counter.
  158. * @altsetting: variable-length array of interface structures, one for
  159. * each alternate setting that may be selected. Each one includes a
  160. * set of endpoint configurations. They will be in no particular order.
  161. *
  162. * These structures persist for the lifetime of a usb_device, unlike
  163. * struct usb_interface (which persists only as long as its configuration
  164. * is installed). The altsetting arrays can be accessed through these
  165. * structures at any time, permitting comparison of configurations and
  166. * providing support for the /proc/bus/usb/devices pseudo-file.
  167. */
  168. struct usb_interface_cache {
  169. unsigned num_altsetting; /* number of alternate settings */
  170. struct kref ref; /* reference counter */
  171. /* variable-length array of alternate settings for this interface,
  172. * stored in no particular order */
  173. struct usb_host_interface altsetting[0];
  174. };
  175. #define ref_to_usb_interface_cache(r) \
  176. container_of(r, struct usb_interface_cache, ref)
  177. #define altsetting_to_usb_interface_cache(a) \
  178. container_of(a, struct usb_interface_cache, altsetting[0])
  179. /**
  180. * struct usb_host_config - representation of a device's configuration
  181. * @desc: the device's configuration descriptor.
  182. * @string: pointer to the cached version of the iConfiguration string, if
  183. * present for this configuration.
  184. * @interface: array of pointers to usb_interface structures, one for each
  185. * interface in the configuration. The number of interfaces is stored
  186. * in desc.bNumInterfaces. These pointers are valid only while the
  187. * the configuration is active.
  188. * @intf_cache: array of pointers to usb_interface_cache structures, one
  189. * for each interface in the configuration. These structures exist
  190. * for the entire life of the device.
  191. * @extra: pointer to buffer containing all extra descriptors associated
  192. * with this configuration (those preceding the first interface
  193. * descriptor).
  194. * @extralen: length of the extra descriptors buffer.
  195. *
  196. * USB devices may have multiple configurations, but only one can be active
  197. * at any time. Each encapsulates a different operational environment;
  198. * for example, a dual-speed device would have separate configurations for
  199. * full-speed and high-speed operation. The number of configurations
  200. * available is stored in the device descriptor as bNumConfigurations.
  201. *
  202. * A configuration can contain multiple interfaces. Each corresponds to
  203. * a different function of the USB device, and all are available whenever
  204. * the configuration is active. The USB standard says that interfaces
  205. * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot
  206. * of devices get this wrong. In addition, the interface array is not
  207. * guaranteed to be sorted in numerical order. Use usb_ifnum_to_if() to
  208. * look up an interface entry based on its number.
  209. *
  210. * Device drivers should not attempt to activate configurations. The choice
  211. * of which configuration to install is a policy decision based on such
  212. * considerations as available power, functionality provided, and the user's
  213. * desires (expressed through userspace tools). However, drivers can call
  214. * usb_reset_configuration() to reinitialize the current configuration and
  215. * all its interfaces.
  216. */
  217. struct usb_host_config {
  218. struct usb_config_descriptor desc;
  219. char *string; /* iConfiguration string, if present */
  220. /* the interfaces associated with this configuration,
  221. * stored in no particular order */
  222. struct usb_interface *interface[USB_MAXINTERFACES];
  223. /* Interface information available even when this is not the
  224. * active configuration */
  225. struct usb_interface_cache *intf_cache[USB_MAXINTERFACES];
  226. unsigned char *extra; /* Extra descriptors */
  227. int extralen;
  228. };
  229. int __usb_get_extra_descriptor(char *buffer, unsigned size,
  230. unsigned char type, void **ptr);
  231. #define usb_get_extra_descriptor(ifpoint,type,ptr)\
  232. __usb_get_extra_descriptor((ifpoint)->extra,(ifpoint)->extralen,\
  233. type,(void**)ptr)
  234. /* ----------------------------------------------------------------------- */
  235. /* USB device number allocation bitmap */
  236. struct usb_devmap {
  237. unsigned long devicemap[128 / (8*sizeof(unsigned long))];
  238. };
  239. /*
  240. * Allocated per bus (tree of devices) we have:
  241. */
  242. struct usb_bus {
  243. struct device *controller; /* host/master side hardware */
  244. int busnum; /* Bus number (in order of reg) */
  245. char *bus_name; /* stable id (PCI slot_name etc) */
  246. u8 uses_dma; /* Does the host controller use DMA? */
  247. u8 otg_port; /* 0, or number of OTG/HNP port */
  248. unsigned is_b_host:1; /* true during some HNP roleswitches */
  249. unsigned b_hnp_enable:1; /* OTG: did A-Host enable HNP? */
  250. int devnum_next; /* Next open device number in
  251. * round-robin allocation */
  252. struct usb_devmap devmap; /* device address allocation map */
  253. struct usb_device *root_hub; /* Root hub */
  254. struct list_head bus_list; /* list of busses */
  255. int bandwidth_allocated; /* on this bus: how much of the time
  256. * reserved for periodic (intr/iso)
  257. * requests is used, on average?
  258. * Units: microseconds/frame.
  259. * Limits: Full/low speed reserve 90%,
  260. * while high speed reserves 80%.
  261. */
  262. int bandwidth_int_reqs; /* number of Interrupt requests */
  263. int bandwidth_isoc_reqs; /* number of Isoc. requests */
  264. struct dentry *usbfs_dentry; /* usbfs dentry entry for the bus */
  265. struct class_device *class_dev; /* class device for this bus */
  266. #if defined(CONFIG_USB_MON)
  267. struct mon_bus *mon_bus; /* non-null when associated */
  268. int monitored; /* non-zero when monitored */
  269. #endif
  270. };
  271. /* ----------------------------------------------------------------------- */
  272. /* This is arbitrary.
  273. * From USB 2.0 spec Table 11-13, offset 7, a hub can
  274. * have up to 255 ports. The most yet reported is 10.
  275. *
  276. * Current Wireless USB host hardware (Intel i1480 for example) allows
  277. * up to 22 devices to connect. Upcoming hardware might raise that
  278. * limit. Because the arrays need to add a bit for hub status data, we
  279. * do 31, so plus one evens out to four bytes.
  280. */
  281. #define USB_MAXCHILDREN (31)
  282. struct usb_tt;
  283. /*
  284. * struct usb_device - kernel's representation of a USB device
  285. *
  286. * FIXME: Write the kerneldoc!
  287. *
  288. * Usbcore drivers should not set usbdev->state directly. Instead use
  289. * usb_set_device_state().
  290. */
  291. struct usb_device {
  292. int devnum; /* Address on USB bus */
  293. char devpath [16]; /* Use in messages: /port/port/... */
  294. enum usb_device_state state; /* configured, not attached, etc */
  295. enum usb_device_speed speed; /* high/full/low (or error) */
  296. struct usb_tt *tt; /* low/full speed dev, highspeed hub */
  297. int ttport; /* device port on that tt hub */
  298. unsigned int toggle[2]; /* one bit for each endpoint
  299. * ([0] = IN, [1] = OUT) */
  300. struct usb_device *parent; /* our hub, unless we're the root */
  301. struct usb_bus *bus; /* Bus we're part of */
  302. struct usb_host_endpoint ep0;
  303. struct device dev; /* Generic device interface */
  304. struct usb_device_descriptor descriptor;/* Descriptor */
  305. struct usb_host_config *config; /* All of the configs */
  306. struct usb_host_config *actconfig;/* the active configuration */
  307. struct usb_host_endpoint *ep_in[16];
  308. struct usb_host_endpoint *ep_out[16];
  309. char **rawdescriptors; /* Raw descriptors for each config */
  310. unsigned short bus_mA; /* Current available from the bus */
  311. u8 portnum; /* Parent port number (origin 1) */
  312. u8 level; /* Number of USB hub ancestors */
  313. int have_langid; /* whether string_langid is valid */
  314. int string_langid; /* language ID for strings */
  315. /* static strings from the device */
  316. char *product; /* iProduct string, if present */
  317. char *manufacturer; /* iManufacturer string, if present */
  318. char *serial; /* iSerialNumber string, if present */
  319. struct list_head filelist;
  320. struct class_device *class_dev;
  321. struct dentry *usbfs_dentry; /* usbfs dentry entry for the device */
  322. /*
  323. * Child devices - these can be either new devices
  324. * (if this is a hub device), or different instances
  325. * of this same device.
  326. *
  327. * Each instance needs its own set of data structures.
  328. */
  329. int maxchild; /* Number of ports if hub */
  330. struct usb_device *children[USB_MAXCHILDREN];
  331. int pm_usage_cnt; /* usage counter for autosuspend */
  332. #ifdef CONFIG_PM
  333. struct work_struct autosuspend; /* for delayed autosuspends */
  334. struct mutex pm_mutex; /* protects PM operations */
  335. unsigned auto_pm:1; /* autosuspend/resume in progress */
  336. unsigned do_remote_wakeup:1; /* remote wakeup should be enabled */
  337. #endif
  338. };
  339. #define to_usb_device(d) container_of(d, struct usb_device, dev)
  340. extern struct usb_device *usb_get_dev(struct usb_device *dev);
  341. extern void usb_put_dev(struct usb_device *dev);
  342. /* USB device locking */
  343. #define usb_lock_device(udev) down(&(udev)->dev.sem)
  344. #define usb_unlock_device(udev) up(&(udev)->dev.sem)
  345. #define usb_trylock_device(udev) down_trylock(&(udev)->dev.sem)
  346. extern int usb_lock_device_for_reset(struct usb_device *udev,
  347. const struct usb_interface *iface);
  348. /* USB port reset for device reinitialization */
  349. extern int usb_reset_device(struct usb_device *dev);
  350. extern int usb_reset_composite_device(struct usb_device *dev,
  351. struct usb_interface *iface);
  352. extern struct usb_device *usb_find_device(u16 vendor_id, u16 product_id);
  353. /* USB autosuspend and autoresume */
  354. #ifdef CONFIG_USB_SUSPEND
  355. extern int usb_autopm_set_interface(struct usb_interface *intf);
  356. extern int usb_autopm_get_interface(struct usb_interface *intf);
  357. extern void usb_autopm_put_interface(struct usb_interface *intf);
  358. static inline void usb_autopm_enable(struct usb_interface *intf)
  359. {
  360. intf->pm_usage_cnt = 0;
  361. usb_autopm_set_interface(intf);
  362. }
  363. static inline void usb_autopm_disable(struct usb_interface *intf)
  364. {
  365. intf->pm_usage_cnt = 1;
  366. usb_autopm_set_interface(intf);
  367. }
  368. #else
  369. static inline int usb_autopm_set_interface(struct usb_interface *intf)
  370. { return 0; }
  371. static inline int usb_autopm_get_interface(struct usb_interface *intf)
  372. { return 0; }
  373. static inline void usb_autopm_put_interface(struct usb_interface *intf)
  374. { }
  375. static inline void usb_autopm_enable(struct usb_interface *intf)
  376. { }
  377. static inline void usb_autopm_disable(struct usb_interface *intf)
  378. { }
  379. #endif
  380. /*-------------------------------------------------------------------------*/
  381. /* for drivers using iso endpoints */
  382. extern int usb_get_current_frame_number (struct usb_device *usb_dev);
  383. /* used these for multi-interface device registration */
  384. extern int usb_driver_claim_interface(struct usb_driver *driver,
  385. struct usb_interface *iface, void* priv);
  386. /**
  387. * usb_interface_claimed - returns true iff an interface is claimed
  388. * @iface: the interface being checked
  389. *
  390. * Returns true (nonzero) iff the interface is claimed, else false (zero).
  391. * Callers must own the driver model's usb bus readlock. So driver
  392. * probe() entries don't need extra locking, but other call contexts
  393. * may need to explicitly claim that lock.
  394. *
  395. */
  396. static inline int usb_interface_claimed(struct usb_interface *iface) {
  397. return (iface->dev.driver != NULL);
  398. }
  399. extern void usb_driver_release_interface(struct usb_driver *driver,
  400. struct usb_interface *iface);
  401. const struct usb_device_id *usb_match_id(struct usb_interface *interface,
  402. const struct usb_device_id *id);
  403. extern struct usb_interface *usb_find_interface(struct usb_driver *drv,
  404. int minor);
  405. extern struct usb_interface *usb_ifnum_to_if(const struct usb_device *dev,
  406. unsigned ifnum);
  407. extern struct usb_host_interface *usb_altnum_to_altsetting(
  408. const struct usb_interface *intf, unsigned int altnum);
  409. /**
  410. * usb_make_path - returns stable device path in the usb tree
  411. * @dev: the device whose path is being constructed
  412. * @buf: where to put the string
  413. * @size: how big is "buf"?
  414. *
  415. * Returns length of the string (> 0) or negative if size was too small.
  416. *
  417. * This identifier is intended to be "stable", reflecting physical paths in
  418. * hardware such as physical bus addresses for host controllers or ports on
  419. * USB hubs. That makes it stay the same until systems are physically
  420. * reconfigured, by re-cabling a tree of USB devices or by moving USB host
  421. * controllers. Adding and removing devices, including virtual root hubs
  422. * in host controller driver modules, does not change these path identifers;
  423. * neither does rebooting or re-enumerating. These are more useful identifiers
  424. * than changeable ("unstable") ones like bus numbers or device addresses.
  425. *
  426. * With a partial exception for devices connected to USB 2.0 root hubs, these
  427. * identifiers are also predictable. So long as the device tree isn't changed,
  428. * plugging any USB device into a given hub port always gives it the same path.
  429. * Because of the use of "companion" controllers, devices connected to ports on
  430. * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are
  431. * high speed, and a different one if they are full or low speed.
  432. */
  433. static inline int usb_make_path (struct usb_device *dev, char *buf,
  434. size_t size)
  435. {
  436. int actual;
  437. actual = snprintf (buf, size, "usb-%s-%s", dev->bus->bus_name,
  438. dev->devpath);
  439. return (actual >= (int)size) ? -1 : actual;
  440. }
  441. /*-------------------------------------------------------------------------*/
  442. /**
  443. * usb_endpoint_dir_in - check if the endpoint has IN direction
  444. * @epd: endpoint to be checked
  445. *
  446. * Returns true if the endpoint is of type IN, otherwise it returns false.
  447. */
  448. static inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor *epd)
  449. {
  450. return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN);
  451. }
  452. /**
  453. * usb_endpoint_dir_out - check if the endpoint has OUT direction
  454. * @epd: endpoint to be checked
  455. *
  456. * Returns true if the endpoint is of type OUT, otherwise it returns false.
  457. */
  458. static inline int usb_endpoint_dir_out(const struct usb_endpoint_descriptor *epd)
  459. {
  460. return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT);
  461. }
  462. /**
  463. * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type
  464. * @epd: endpoint to be checked
  465. *
  466. * Returns true if the endpoint is of type bulk, otherwise it returns false.
  467. */
  468. static inline int usb_endpoint_xfer_bulk(const struct usb_endpoint_descriptor *epd)
  469. {
  470. return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
  471. USB_ENDPOINT_XFER_BULK);
  472. }
  473. /**
  474. * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type
  475. * @epd: endpoint to be checked
  476. *
  477. * Returns true if the endpoint is of type interrupt, otherwise it returns
  478. * false.
  479. */
  480. static inline int usb_endpoint_xfer_int(const struct usb_endpoint_descriptor *epd)
  481. {
  482. return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
  483. USB_ENDPOINT_XFER_INT);
  484. }
  485. /**
  486. * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type
  487. * @epd: endpoint to be checked
  488. *
  489. * Returns true if the endpoint is of type isochronous, otherwise it returns
  490. * false.
  491. */
  492. static inline int usb_endpoint_xfer_isoc(const struct usb_endpoint_descriptor *epd)
  493. {
  494. return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
  495. USB_ENDPOINT_XFER_ISOC);
  496. }
  497. /**
  498. * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN
  499. * @epd: endpoint to be checked
  500. *
  501. * Returns true if the endpoint has bulk transfer type and IN direction,
  502. * otherwise it returns false.
  503. */
  504. static inline int usb_endpoint_is_bulk_in(const struct usb_endpoint_descriptor *epd)
  505. {
  506. return (usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_in(epd));
  507. }
  508. /**
  509. * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT
  510. * @epd: endpoint to be checked
  511. *
  512. * Returns true if the endpoint has bulk transfer type and OUT direction,
  513. * otherwise it returns false.
  514. */
  515. static inline int usb_endpoint_is_bulk_out(const struct usb_endpoint_descriptor *epd)
  516. {
  517. return (usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_out(epd));
  518. }
  519. /**
  520. * usb_endpoint_is_int_in - check if the endpoint is interrupt IN
  521. * @epd: endpoint to be checked
  522. *
  523. * Returns true if the endpoint has interrupt transfer type and IN direction,
  524. * otherwise it returns false.
  525. */
  526. static inline int usb_endpoint_is_int_in(const struct usb_endpoint_descriptor *epd)
  527. {
  528. return (usb_endpoint_xfer_int(epd) && usb_endpoint_dir_in(epd));
  529. }
  530. /**
  531. * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT
  532. * @epd: endpoint to be checked
  533. *
  534. * Returns true if the endpoint has interrupt transfer type and OUT direction,
  535. * otherwise it returns false.
  536. */
  537. static inline int usb_endpoint_is_int_out(const struct usb_endpoint_descriptor *epd)
  538. {
  539. return (usb_endpoint_xfer_int(epd) && usb_endpoint_dir_out(epd));
  540. }
  541. /**
  542. * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN
  543. * @epd: endpoint to be checked
  544. *
  545. * Returns true if the endpoint has isochronous transfer type and IN direction,
  546. * otherwise it returns false.
  547. */
  548. static inline int usb_endpoint_is_isoc_in(const struct usb_endpoint_descriptor *epd)
  549. {
  550. return (usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_in(epd));
  551. }
  552. /**
  553. * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT
  554. * @epd: endpoint to be checked
  555. *
  556. * Returns true if the endpoint has isochronous transfer type and OUT direction,
  557. * otherwise it returns false.
  558. */
  559. static inline int usb_endpoint_is_isoc_out(const struct usb_endpoint_descriptor *epd)
  560. {
  561. return (usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_out(epd));
  562. }
  563. /*-------------------------------------------------------------------------*/
  564. #define USB_DEVICE_ID_MATCH_DEVICE \
  565. (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
  566. #define USB_DEVICE_ID_MATCH_DEV_RANGE \
  567. (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI)
  568. #define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
  569. (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE)
  570. #define USB_DEVICE_ID_MATCH_DEV_INFO \
  571. (USB_DEVICE_ID_MATCH_DEV_CLASS | \
  572. USB_DEVICE_ID_MATCH_DEV_SUBCLASS | \
  573. USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
  574. #define USB_DEVICE_ID_MATCH_INT_INFO \
  575. (USB_DEVICE_ID_MATCH_INT_CLASS | \
  576. USB_DEVICE_ID_MATCH_INT_SUBCLASS | \
  577. USB_DEVICE_ID_MATCH_INT_PROTOCOL)
  578. /**
  579. * USB_DEVICE - macro used to describe a specific usb device
  580. * @vend: the 16 bit USB Vendor ID
  581. * @prod: the 16 bit USB Product ID
  582. *
  583. * This macro is used to create a struct usb_device_id that matches a
  584. * specific device.
  585. */
  586. #define USB_DEVICE(vend,prod) \
  587. .match_flags = USB_DEVICE_ID_MATCH_DEVICE, .idVendor = (vend), \
  588. .idProduct = (prod)
  589. /**
  590. * USB_DEVICE_VER - macro used to describe a specific usb device with a
  591. * version range
  592. * @vend: the 16 bit USB Vendor ID
  593. * @prod: the 16 bit USB Product ID
  594. * @lo: the bcdDevice_lo value
  595. * @hi: the bcdDevice_hi value
  596. *
  597. * This macro is used to create a struct usb_device_id that matches a
  598. * specific device, with a version range.
  599. */
  600. #define USB_DEVICE_VER(vend,prod,lo,hi) \
  601. .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, \
  602. .idVendor = (vend), .idProduct = (prod), \
  603. .bcdDevice_lo = (lo), .bcdDevice_hi = (hi)
  604. /**
  605. * USB_DEVICE_INFO - macro used to describe a class of usb devices
  606. * @cl: bDeviceClass value
  607. * @sc: bDeviceSubClass value
  608. * @pr: bDeviceProtocol value
  609. *
  610. * This macro is used to create a struct usb_device_id that matches a
  611. * specific class of devices.
  612. */
  613. #define USB_DEVICE_INFO(cl,sc,pr) \
  614. .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, .bDeviceClass = (cl), \
  615. .bDeviceSubClass = (sc), .bDeviceProtocol = (pr)
  616. /**
  617. * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces
  618. * @cl: bInterfaceClass value
  619. * @sc: bInterfaceSubClass value
  620. * @pr: bInterfaceProtocol value
  621. *
  622. * This macro is used to create a struct usb_device_id that matches a
  623. * specific class of interfaces.
  624. */
  625. #define USB_INTERFACE_INFO(cl,sc,pr) \
  626. .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, .bInterfaceClass = (cl), \
  627. .bInterfaceSubClass = (sc), .bInterfaceProtocol = (pr)
  628. /* ----------------------------------------------------------------------- */
  629. struct usb_dynids {
  630. spinlock_t lock;
  631. struct list_head list;
  632. };
  633. /**
  634. * struct usbdrv_wrap - wrapper for driver-model structure
  635. * @driver: The driver-model core driver structure.
  636. * @for_devices: Non-zero for device drivers, 0 for interface drivers.
  637. */
  638. struct usbdrv_wrap {
  639. struct device_driver driver;
  640. int for_devices;
  641. };
  642. /**
  643. * struct usb_driver - identifies USB interface driver to usbcore
  644. * @name: The driver name should be unique among USB drivers,
  645. * and should normally be the same as the module name.
  646. * @probe: Called to see if the driver is willing to manage a particular
  647. * interface on a device. If it is, probe returns zero and uses
  648. * dev_set_drvdata() to associate driver-specific data with the
  649. * interface. It may also use usb_set_interface() to specify the
  650. * appropriate altsetting. If unwilling to manage the interface,
  651. * return a negative errno value.
  652. * @disconnect: Called when the interface is no longer accessible, usually
  653. * because its device has been (or is being) disconnected or the
  654. * driver module is being unloaded.
  655. * @ioctl: Used for drivers that want to talk to userspace through
  656. * the "usbfs" filesystem. This lets devices provide ways to
  657. * expose information to user space regardless of where they
  658. * do (or don't) show up otherwise in the filesystem.
  659. * @suspend: Called when the device is going to be suspended by the system.
  660. * @resume: Called when the device is being resumed by the system.
  661. * @pre_reset: Called by usb_reset_composite_device() when the device
  662. * is about to be reset.
  663. * @post_reset: Called by usb_reset_composite_device() after the device
  664. * has been reset.
  665. * @id_table: USB drivers use ID table to support hotplugging.
  666. * Export this with MODULE_DEVICE_TABLE(usb,...). This must be set
  667. * or your driver's probe function will never get called.
  668. * @dynids: used internally to hold the list of dynamically added device
  669. * ids for this driver.
  670. * @drvwrap: Driver-model core structure wrapper.
  671. * @no_dynamic_id: if set to 1, the USB core will not allow dynamic ids to be
  672. * added to this driver by preventing the sysfs file from being created.
  673. * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
  674. * for interfaces bound to this driver.
  675. *
  676. * USB interface drivers must provide a name, probe() and disconnect()
  677. * methods, and an id_table. Other driver fields are optional.
  678. *
  679. * The id_table is used in hotplugging. It holds a set of descriptors,
  680. * and specialized data may be associated with each entry. That table
  681. * is used by both user and kernel mode hotplugging support.
  682. *
  683. * The probe() and disconnect() methods are called in a context where
  684. * they can sleep, but they should avoid abusing the privilege. Most
  685. * work to connect to a device should be done when the device is opened,
  686. * and undone at the last close. The disconnect code needs to address
  687. * concurrency issues with respect to open() and close() methods, as
  688. * well as forcing all pending I/O requests to complete (by unlinking
  689. * them as necessary, and blocking until the unlinks complete).
  690. */
  691. struct usb_driver {
  692. const char *name;
  693. int (*probe) (struct usb_interface *intf,
  694. const struct usb_device_id *id);
  695. void (*disconnect) (struct usb_interface *intf);
  696. int (*ioctl) (struct usb_interface *intf, unsigned int code,
  697. void *buf);
  698. int (*suspend) (struct usb_interface *intf, pm_message_t message);
  699. int (*resume) (struct usb_interface *intf);
  700. void (*pre_reset) (struct usb_interface *intf);
  701. void (*post_reset) (struct usb_interface *intf);
  702. const struct usb_device_id *id_table;
  703. struct usb_dynids dynids;
  704. struct usbdrv_wrap drvwrap;
  705. unsigned int no_dynamic_id:1;
  706. unsigned int supports_autosuspend:1;
  707. };
  708. #define to_usb_driver(d) container_of(d, struct usb_driver, drvwrap.driver)
  709. /**
  710. * struct usb_device_driver - identifies USB device driver to usbcore
  711. * @name: The driver name should be unique among USB drivers,
  712. * and should normally be the same as the module name.
  713. * @probe: Called to see if the driver is willing to manage a particular
  714. * device. If it is, probe returns zero and uses dev_set_drvdata()
  715. * to associate driver-specific data with the device. If unwilling
  716. * to manage the device, return a negative errno value.
  717. * @disconnect: Called when the device is no longer accessible, usually
  718. * because it has been (or is being) disconnected or the driver's
  719. * module is being unloaded.
  720. * @suspend: Called when the device is going to be suspended by the system.
  721. * @resume: Called when the device is being resumed by the system.
  722. * @drvwrap: Driver-model core structure wrapper.
  723. * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
  724. * for devices bound to this driver.
  725. *
  726. * USB drivers must provide all the fields listed above except drvwrap.
  727. */
  728. struct usb_device_driver {
  729. const char *name;
  730. int (*probe) (struct usb_device *udev);
  731. void (*disconnect) (struct usb_device *udev);
  732. int (*suspend) (struct usb_device *udev, pm_message_t message);
  733. int (*resume) (struct usb_device *udev);
  734. struct usbdrv_wrap drvwrap;
  735. unsigned int supports_autosuspend:1;
  736. };
  737. #define to_usb_device_driver(d) container_of(d, struct usb_device_driver, \
  738. drvwrap.driver)
  739. extern struct bus_type usb_bus_type;
  740. /**
  741. * struct usb_class_driver - identifies a USB driver that wants to use the USB major number
  742. * @name: the usb class device name for this driver. Will show up in sysfs.
  743. * @fops: pointer to the struct file_operations of this driver.
  744. * @minor_base: the start of the minor range for this driver.
  745. *
  746. * This structure is used for the usb_register_dev() and
  747. * usb_unregister_dev() functions, to consolidate a number of the
  748. * parameters used for them.
  749. */
  750. struct usb_class_driver {
  751. char *name;
  752. const struct file_operations *fops;
  753. int minor_base;
  754. };
  755. /*
  756. * use these in module_init()/module_exit()
  757. * and don't forget MODULE_DEVICE_TABLE(usb, ...)
  758. */
  759. extern int usb_register_driver(struct usb_driver *, struct module *);
  760. static inline int usb_register(struct usb_driver *driver)
  761. {
  762. return usb_register_driver(driver, THIS_MODULE);
  763. }
  764. extern void usb_deregister(struct usb_driver *);
  765. extern int usb_register_device_driver(struct usb_device_driver *,
  766. struct module *);
  767. extern void usb_deregister_device_driver(struct usb_device_driver *);
  768. extern int usb_register_dev(struct usb_interface *intf,
  769. struct usb_class_driver *class_driver);
  770. extern void usb_deregister_dev(struct usb_interface *intf,
  771. struct usb_class_driver *class_driver);
  772. extern int usb_disabled(void);
  773. /* ----------------------------------------------------------------------- */
  774. /*
  775. * URB support, for asynchronous request completions
  776. */
  777. /*
  778. * urb->transfer_flags:
  779. */
  780. #define URB_SHORT_NOT_OK 0x0001 /* report short reads as errors */
  781. #define URB_ISO_ASAP 0x0002 /* iso-only, urb->start_frame
  782. * ignored */
  783. #define URB_NO_TRANSFER_DMA_MAP 0x0004 /* urb->transfer_dma valid on submit */
  784. #define URB_NO_SETUP_DMA_MAP 0x0008 /* urb->setup_dma valid on submit */
  785. #define URB_NO_FSBR 0x0020 /* UHCI-specific */
  786. #define URB_ZERO_PACKET 0x0040 /* Finish bulk OUT with short packet */
  787. #define URB_NO_INTERRUPT 0x0080 /* HINT: no non-error interrupt
  788. * needed */
  789. struct usb_iso_packet_descriptor {
  790. unsigned int offset;
  791. unsigned int length; /* expected length */
  792. unsigned int actual_length;
  793. unsigned int status;
  794. };
  795. struct urb;
  796. typedef void (*usb_complete_t)(struct urb *);
  797. /**
  798. * struct urb - USB Request Block
  799. * @urb_list: For use by current owner of the URB.
  800. * @pipe: Holds endpoint number, direction, type, and more.
  801. * Create these values with the eight macros available;
  802. * usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl"
  803. * (control), "bulk", "int" (interrupt), or "iso" (isochronous).
  804. * For example usb_sndbulkpipe() or usb_rcvintpipe(). Endpoint
  805. * numbers range from zero to fifteen. Note that "in" endpoint two
  806. * is a different endpoint (and pipe) from "out" endpoint two.
  807. * The current configuration controls the existence, type, and
  808. * maximum packet size of any given endpoint.
  809. * @dev: Identifies the USB device to perform the request.
  810. * @status: This is read in non-iso completion functions to get the
  811. * status of the particular request. ISO requests only use it
  812. * to tell whether the URB was unlinked; detailed status for
  813. * each frame is in the fields of the iso_frame-desc.
  814. * @transfer_flags: A variety of flags may be used to affect how URB
  815. * submission, unlinking, or operation are handled. Different
  816. * kinds of URB can use different flags.
  817. * @transfer_buffer: This identifies the buffer to (or from) which
  818. * the I/O request will be performed (unless URB_NO_TRANSFER_DMA_MAP
  819. * is set). This buffer must be suitable for DMA; allocate it with
  820. * kmalloc() or equivalent. For transfers to "in" endpoints, contents
  821. * of this buffer will be modified. This buffer is used for the data
  822. * stage of control transfers.
  823. * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP,
  824. * the device driver is saying that it provided this DMA address,
  825. * which the host controller driver should use in preference to the
  826. * transfer_buffer.
  827. * @transfer_buffer_length: How big is transfer_buffer. The transfer may
  828. * be broken up into chunks according to the current maximum packet
  829. * size for the endpoint, which is a function of the configuration
  830. * and is encoded in the pipe. When the length is zero, neither
  831. * transfer_buffer nor transfer_dma is used.
  832. * @actual_length: This is read in non-iso completion functions, and
  833. * it tells how many bytes (out of transfer_buffer_length) were
  834. * transferred. It will normally be the same as requested, unless
  835. * either an error was reported or a short read was performed.
  836. * The URB_SHORT_NOT_OK transfer flag may be used to make such
  837. * short reads be reported as errors.
  838. * @setup_packet: Only used for control transfers, this points to eight bytes
  839. * of setup data. Control transfers always start by sending this data
  840. * to the device. Then transfer_buffer is read or written, if needed.
  841. * @setup_dma: For control transfers with URB_NO_SETUP_DMA_MAP set, the
  842. * device driver has provided this DMA address for the setup packet.
  843. * The host controller driver should use this in preference to
  844. * setup_packet.
  845. * @start_frame: Returns the initial frame for isochronous transfers.
  846. * @number_of_packets: Lists the number of ISO transfer buffers.
  847. * @interval: Specifies the polling interval for interrupt or isochronous
  848. * transfers. The units are frames (milliseconds) for for full and low
  849. * speed devices, and microframes (1/8 millisecond) for highspeed ones.
  850. * @error_count: Returns the number of ISO transfers that reported errors.
  851. * @context: For use in completion functions. This normally points to
  852. * request-specific driver context.
  853. * @complete: Completion handler. This URB is passed as the parameter to the
  854. * completion function. The completion function may then do what
  855. * it likes with the URB, including resubmitting or freeing it.
  856. * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to
  857. * collect the transfer status for each buffer.
  858. *
  859. * This structure identifies USB transfer requests. URBs must be allocated by
  860. * calling usb_alloc_urb() and freed with a call to usb_free_urb().
  861. * Initialization may be done using various usb_fill_*_urb() functions. URBs
  862. * are submitted using usb_submit_urb(), and pending requests may be canceled
  863. * using usb_unlink_urb() or usb_kill_urb().
  864. *
  865. * Data Transfer Buffers:
  866. *
  867. * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise
  868. * taken from the general page pool. That is provided by transfer_buffer
  869. * (control requests also use setup_packet), and host controller drivers
  870. * perform a dma mapping (and unmapping) for each buffer transferred. Those
  871. * mapping operations can be expensive on some platforms (perhaps using a dma
  872. * bounce buffer or talking to an IOMMU),
  873. * although they're cheap on commodity x86 and ppc hardware.
  874. *
  875. * Alternatively, drivers may pass the URB_NO_xxx_DMA_MAP transfer flags,
  876. * which tell the host controller driver that no such mapping is needed since
  877. * the device driver is DMA-aware. For example, a device driver might
  878. * allocate a DMA buffer with usb_buffer_alloc() or call usb_buffer_map().
  879. * When these transfer flags are provided, host controller drivers will
  880. * attempt to use the dma addresses found in the transfer_dma and/or
  881. * setup_dma fields rather than determining a dma address themselves. (Note
  882. * that transfer_buffer and setup_packet must still be set because not all
  883. * host controllers use DMA, nor do virtual root hubs).
  884. *
  885. * Initialization:
  886. *
  887. * All URBs submitted must initialize the dev, pipe, transfer_flags (may be
  888. * zero), and complete fields. All URBs must also initialize
  889. * transfer_buffer and transfer_buffer_length. They may provide the
  890. * URB_SHORT_NOT_OK transfer flag, indicating that short reads are
  891. * to be treated as errors; that flag is invalid for write requests.
  892. *
  893. * Bulk URBs may
  894. * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers
  895. * should always terminate with a short packet, even if it means adding an
  896. * extra zero length packet.
  897. *
  898. * Control URBs must provide a setup_packet. The setup_packet and
  899. * transfer_buffer may each be mapped for DMA or not, independently of
  900. * the other. The transfer_flags bits URB_NO_TRANSFER_DMA_MAP and
  901. * URB_NO_SETUP_DMA_MAP indicate which buffers have already been mapped.
  902. * URB_NO_SETUP_DMA_MAP is ignored for non-control URBs.
  903. *
  904. * Interrupt URBs must provide an interval, saying how often (in milliseconds
  905. * or, for highspeed devices, 125 microsecond units)
  906. * to poll for transfers. After the URB has been submitted, the interval
  907. * field reflects how the transfer was actually scheduled.
  908. * The polling interval may be more frequent than requested.
  909. * For example, some controllers have a maximum interval of 32 milliseconds,
  910. * while others support intervals of up to 1024 milliseconds.
  911. * Isochronous URBs also have transfer intervals. (Note that for isochronous
  912. * endpoints, as well as high speed interrupt endpoints, the encoding of
  913. * the transfer interval in the endpoint descriptor is logarithmic.
  914. * Device drivers must convert that value to linear units themselves.)
  915. *
  916. * Isochronous URBs normally use the URB_ISO_ASAP transfer flag, telling
  917. * the host controller to schedule the transfer as soon as bandwidth
  918. * utilization allows, and then set start_frame to reflect the actual frame
  919. * selected during submission. Otherwise drivers must specify the start_frame
  920. * and handle the case where the transfer can't begin then. However, drivers
  921. * won't know how bandwidth is currently allocated, and while they can
  922. * find the current frame using usb_get_current_frame_number () they can't
  923. * know the range for that frame number. (Ranges for frame counter values
  924. * are HC-specific, and can go from 256 to 65536 frames from "now".)
  925. *
  926. * Isochronous URBs have a different data transfer model, in part because
  927. * the quality of service is only "best effort". Callers provide specially
  928. * allocated URBs, with number_of_packets worth of iso_frame_desc structures
  929. * at the end. Each such packet is an individual ISO transfer. Isochronous
  930. * URBs are normally queued, submitted by drivers to arrange that
  931. * transfers are at least double buffered, and then explicitly resubmitted
  932. * in completion handlers, so
  933. * that data (such as audio or video) streams at as constant a rate as the
  934. * host controller scheduler can support.
  935. *
  936. * Completion Callbacks:
  937. *
  938. * The completion callback is made in_interrupt(), and one of the first
  939. * things that a completion handler should do is check the status field.
  940. * The status field is provided for all URBs. It is used to report
  941. * unlinked URBs, and status for all non-ISO transfers. It should not
  942. * be examined before the URB is returned to the completion handler.
  943. *
  944. * The context field is normally used to link URBs back to the relevant
  945. * driver or request state.
  946. *
  947. * When the completion callback is invoked for non-isochronous URBs, the
  948. * actual_length field tells how many bytes were transferred. This field
  949. * is updated even when the URB terminated with an error or was unlinked.
  950. *
  951. * ISO transfer status is reported in the status and actual_length fields
  952. * of the iso_frame_desc array, and the number of errors is reported in
  953. * error_count. Completion callbacks for ISO transfers will normally
  954. * (re)submit URBs to ensure a constant transfer rate.
  955. *
  956. * Note that even fields marked "public" should not be touched by the driver
  957. * when the urb is owned by the hcd, that is, since the call to
  958. * usb_submit_urb() till the entry into the completion routine.
  959. */
  960. struct urb
  961. {
  962. /* private: usb core and host controller only fields in the urb */
  963. struct kref kref; /* reference count of the URB */
  964. spinlock_t lock; /* lock for the URB */
  965. void *hcpriv; /* private data for host controller */
  966. int bandwidth; /* bandwidth for INT/ISO request */
  967. atomic_t use_count; /* concurrent submissions counter */
  968. u8 reject; /* submissions will fail */
  969. /* public: documented fields in the urb that can be used by drivers */
  970. struct list_head urb_list; /* list head for use by the urb's
  971. * current owner */
  972. struct usb_device *dev; /* (in) pointer to associated device */
  973. unsigned int pipe; /* (in) pipe information */
  974. int status; /* (return) non-ISO status */
  975. unsigned int transfer_flags; /* (in) URB_SHORT_NOT_OK | ...*/
  976. void *transfer_buffer; /* (in) associated data buffer */
  977. dma_addr_t transfer_dma; /* (in) dma addr for transfer_buffer */
  978. int transfer_buffer_length; /* (in) data buffer length */
  979. int actual_length; /* (return) actual transfer length */
  980. unsigned char *setup_packet; /* (in) setup packet (control only) */
  981. dma_addr_t setup_dma; /* (in) dma addr for setup_packet */
  982. int start_frame; /* (modify) start frame (ISO) */
  983. int number_of_packets; /* (in) number of ISO packets */
  984. int interval; /* (modify) transfer interval
  985. * (INT/ISO) */
  986. int error_count; /* (return) number of ISO errors */
  987. void *context; /* (in) context for completion */
  988. usb_complete_t complete; /* (in) completion routine */
  989. struct usb_iso_packet_descriptor iso_frame_desc[0];
  990. /* (in) ISO ONLY */
  991. };
  992. /* ----------------------------------------------------------------------- */
  993. /**
  994. * usb_fill_control_urb - initializes a control urb
  995. * @urb: pointer to the urb to initialize.
  996. * @dev: pointer to the struct usb_device for this urb.
  997. * @pipe: the endpoint pipe
  998. * @setup_packet: pointer to the setup_packet buffer
  999. * @transfer_buffer: pointer to the transfer buffer
  1000. * @buffer_length: length of the transfer buffer
  1001. * @complete_fn: pointer to the usb_complete_t function
  1002. * @context: what to set the urb context to.
  1003. *
  1004. * Initializes a control urb with the proper information needed to submit
  1005. * it to a device.
  1006. */
  1007. static inline void usb_fill_control_urb (struct urb *urb,
  1008. struct usb_device *dev,
  1009. unsigned int pipe,
  1010. unsigned char *setup_packet,
  1011. void *transfer_buffer,
  1012. int buffer_length,
  1013. usb_complete_t complete_fn,
  1014. void *context)
  1015. {
  1016. spin_lock_init(&urb->lock);
  1017. urb->dev = dev;
  1018. urb->pipe = pipe;
  1019. urb->setup_packet = setup_packet;
  1020. urb->transfer_buffer = transfer_buffer;
  1021. urb->transfer_buffer_length = buffer_length;
  1022. urb->complete = complete_fn;
  1023. urb->context = context;
  1024. }
  1025. /**
  1026. * usb_fill_bulk_urb - macro to help initialize a bulk urb
  1027. * @urb: pointer to the urb to initialize.
  1028. * @dev: pointer to the struct usb_device for this urb.
  1029. * @pipe: the endpoint pipe
  1030. * @transfer_buffer: pointer to the transfer buffer
  1031. * @buffer_length: length of the transfer buffer
  1032. * @complete_fn: pointer to the usb_complete_t function
  1033. * @context: what to set the urb context to.
  1034. *
  1035. * Initializes a bulk urb with the proper information needed to submit it
  1036. * to a device.
  1037. */
  1038. static inline void usb_fill_bulk_urb (struct urb *urb,
  1039. struct usb_device *dev,
  1040. unsigned int pipe,
  1041. void *transfer_buffer,
  1042. int buffer_length,
  1043. usb_complete_t complete_fn,
  1044. void *context)
  1045. {
  1046. spin_lock_init(&urb->lock);
  1047. urb->dev = dev;
  1048. urb->pipe = pipe;
  1049. urb->transfer_buffer = transfer_buffer;
  1050. urb->transfer_buffer_length = buffer_length;
  1051. urb->complete = complete_fn;
  1052. urb->context = context;
  1053. }
  1054. /**
  1055. * usb_fill_int_urb - macro to help initialize a interrupt urb
  1056. * @urb: pointer to the urb to initialize.
  1057. * @dev: pointer to the struct usb_device for this urb.
  1058. * @pipe: the endpoint pipe
  1059. * @transfer_buffer: pointer to the transfer buffer
  1060. * @buffer_length: length of the transfer buffer
  1061. * @complete_fn: pointer to the usb_complete_t function
  1062. * @context: what to set the urb context to.
  1063. * @interval: what to set the urb interval to, encoded like
  1064. * the endpoint descriptor's bInterval value.
  1065. *
  1066. * Initializes a interrupt urb with the proper information needed to submit
  1067. * it to a device.
  1068. * Note that high speed interrupt endpoints use a logarithmic encoding of
  1069. * the endpoint interval, and express polling intervals in microframes
  1070. * (eight per millisecond) rather than in frames (one per millisecond).
  1071. */
  1072. static inline void usb_fill_int_urb (struct urb *urb,
  1073. struct usb_device *dev,
  1074. unsigned int pipe,
  1075. void *transfer_buffer,
  1076. int buffer_length,
  1077. usb_complete_t complete_fn,
  1078. void *context,
  1079. int interval)
  1080. {
  1081. spin_lock_init(&urb->lock);
  1082. urb->dev = dev;
  1083. urb->pipe = pipe;
  1084. urb->transfer_buffer = transfer_buffer;
  1085. urb->transfer_buffer_length = buffer_length;
  1086. urb->complete = complete_fn;
  1087. urb->context = context;
  1088. if (dev->speed == USB_SPEED_HIGH)
  1089. urb->interval = 1 << (interval - 1);
  1090. else
  1091. urb->interval = interval;
  1092. urb->start_frame = -1;
  1093. }
  1094. extern void usb_init_urb(struct urb *urb);
  1095. extern struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags);
  1096. extern void usb_free_urb(struct urb *urb);
  1097. #define usb_put_urb usb_free_urb
  1098. extern struct urb *usb_get_urb(struct urb *urb);
  1099. extern int usb_submit_urb(struct urb *urb, gfp_t mem_flags);
  1100. extern int usb_unlink_urb(struct urb *urb);
  1101. extern void usb_kill_urb(struct urb *urb);
  1102. void *usb_buffer_alloc (struct usb_device *dev, size_t size,
  1103. gfp_t mem_flags, dma_addr_t *dma);
  1104. void usb_buffer_free (struct usb_device *dev, size_t size,
  1105. void *addr, dma_addr_t dma);
  1106. #if 0
  1107. struct urb *usb_buffer_map (struct urb *urb);
  1108. void usb_buffer_dmasync (struct urb *urb);
  1109. void usb_buffer_unmap (struct urb *urb);
  1110. #endif
  1111. struct scatterlist;
  1112. int usb_buffer_map_sg(const struct usb_device *dev, unsigned pipe,
  1113. struct scatterlist *sg, int nents);
  1114. #if 0
  1115. void usb_buffer_dmasync_sg(const struct usb_device *dev, unsigned pipe,
  1116. struct scatterlist *sg, int n_hw_ents);
  1117. #endif
  1118. void usb_buffer_unmap_sg(const struct usb_device *dev, unsigned pipe,
  1119. struct scatterlist *sg, int n_hw_ents);
  1120. /*-------------------------------------------------------------------*
  1121. * SYNCHRONOUS CALL SUPPORT *
  1122. *-------------------------------------------------------------------*/
  1123. extern int usb_control_msg(struct usb_device *dev, unsigned int pipe,
  1124. __u8 request, __u8 requesttype, __u16 value, __u16 index,
  1125. void *data, __u16 size, int timeout);
  1126. extern int usb_interrupt_msg(struct usb_device *usb_dev, unsigned int pipe,
  1127. void *data, int len, int *actual_length, int timeout);
  1128. extern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,
  1129. void *data, int len, int *actual_length,
  1130. int timeout);
  1131. /* wrappers around usb_control_msg() for the most common standard requests */
  1132. extern int usb_get_descriptor(struct usb_device *dev, unsigned char desctype,
  1133. unsigned char descindex, void *buf, int size);
  1134. extern int usb_get_status(struct usb_device *dev,
  1135. int type, int target, void *data);
  1136. extern int usb_string(struct usb_device *dev, int index,
  1137. char *buf, size_t size);
  1138. /* wrappers that also update important state inside usbcore */
  1139. extern int usb_clear_halt(struct usb_device *dev, int pipe);
  1140. extern int usb_reset_configuration(struct usb_device *dev);
  1141. extern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate);
  1142. /* this request isn't really synchronous, but it belongs with the others */
  1143. extern int usb_driver_set_configuration(struct usb_device *udev, int config);
  1144. /*
  1145. * timeouts, in milliseconds, used for sending/receiving control messages
  1146. * they typically complete within a few frames (msec) after they're issued
  1147. * USB identifies 5 second timeouts, maybe more in a few cases, and a few
  1148. * slow devices (like some MGE Ellipse UPSes) actually push that limit.
  1149. */
  1150. #define USB_CTRL_GET_TIMEOUT 5000
  1151. #define USB_CTRL_SET_TIMEOUT 5000
  1152. /**
  1153. * struct usb_sg_request - support for scatter/gather I/O
  1154. * @status: zero indicates success, else negative errno
  1155. * @bytes: counts bytes transferred.
  1156. *
  1157. * These requests are initialized using usb_sg_init(), and then are used
  1158. * as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most
  1159. * members of the request object aren't for driver access.
  1160. *
  1161. * The status and bytecount values are valid only after usb_sg_wait()
  1162. * returns. If the status is zero, then the bytecount matches the total
  1163. * from the request.
  1164. *
  1165. * After an error completion, drivers may need to clear a halt condition
  1166. * on the endpoint.
  1167. */
  1168. struct usb_sg_request {
  1169. int status;
  1170. size_t bytes;
  1171. /*
  1172. * members below are private: to usbcore,
  1173. * and are not provided for driver access!
  1174. */
  1175. spinlock_t lock;
  1176. struct usb_device *dev;
  1177. int pipe;
  1178. struct scatterlist *sg;
  1179. int nents;
  1180. int entries;
  1181. struct urb **urbs;
  1182. int count;
  1183. struct completion complete;
  1184. };
  1185. int usb_sg_init (
  1186. struct usb_sg_request *io,
  1187. struct usb_device *dev,
  1188. unsigned pipe,
  1189. unsigned period,
  1190. struct scatterlist *sg,
  1191. int nents,
  1192. size_t length,
  1193. gfp_t mem_flags
  1194. );
  1195. void usb_sg_cancel (struct usb_sg_request *io);
  1196. void usb_sg_wait (struct usb_sg_request *io);
  1197. /* ----------------------------------------------------------------------- */
  1198. /*
  1199. * For various legacy reasons, Linux has a small cookie that's paired with
  1200. * a struct usb_device to identify an endpoint queue. Queue characteristics
  1201. * are defined by the endpoint's descriptor. This cookie is called a "pipe",
  1202. * an unsigned int encoded as:
  1203. *
  1204. * - direction: bit 7 (0 = Host-to-Device [Out],
  1205. * 1 = Device-to-Host [In] ...
  1206. * like endpoint bEndpointAddress)
  1207. * - device address: bits 8-14 ... bit positions known to uhci-hcd
  1208. * - endpoint: bits 15-18 ... bit positions known to uhci-hcd
  1209. * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
  1210. * 10 = control, 11 = bulk)
  1211. *
  1212. * Given the device address and endpoint descriptor, pipes are redundant.
  1213. */
  1214. /* NOTE: these are not the standard USB_ENDPOINT_XFER_* values!! */
  1215. /* (yet ... they're the values used by usbfs) */
  1216. #define PIPE_ISOCHRONOUS 0
  1217. #define PIPE_INTERRUPT 1
  1218. #define PIPE_CONTROL 2
  1219. #define PIPE_BULK 3
  1220. #define usb_pipein(pipe) ((pipe) & USB_DIR_IN)
  1221. #define usb_pipeout(pipe) (!usb_pipein(pipe))
  1222. #define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
  1223. #define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
  1224. #define usb_pipetype(pipe) (((pipe) >> 30) & 3)
  1225. #define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
  1226. #define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
  1227. #define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
  1228. #define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
  1229. /* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
  1230. #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
  1231. #define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep)))
  1232. #define usb_settoggle(dev, ep, out, bit) \
  1233. ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \
  1234. ((bit) << (ep)))
  1235. static inline unsigned int __create_pipe(struct usb_device *dev,
  1236. unsigned int endpoint)
  1237. {
  1238. return (dev->devnum << 8) | (endpoint << 15);
  1239. }
  1240. /* Create various pipes... */
  1241. #define usb_sndctrlpipe(dev,endpoint) \
  1242. ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint))
  1243. #define usb_rcvctrlpipe(dev,endpoint) \
  1244. ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
  1245. #define usb_sndisocpipe(dev,endpoint) \
  1246. ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint))
  1247. #define usb_rcvisocpipe(dev,endpoint) \
  1248. ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
  1249. #define usb_sndbulkpipe(dev,endpoint) \
  1250. ((PIPE_BULK << 30) | __create_pipe(dev,endpoint))
  1251. #define usb_rcvbulkpipe(dev,endpoint) \
  1252. ((PIPE_BULK << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
  1253. #define usb_sndintpipe(dev,endpoint) \
  1254. ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint))
  1255. #define usb_rcvintpipe(dev,endpoint) \
  1256. ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
  1257. /*-------------------------------------------------------------------------*/
  1258. static inline __u16
  1259. usb_maxpacket(struct usb_device *udev, int pipe, int is_out)
  1260. {
  1261. struct usb_host_endpoint *ep;
  1262. unsigned epnum = usb_pipeendpoint(pipe);
  1263. if (is_out) {
  1264. WARN_ON(usb_pipein(pipe));
  1265. ep = udev->ep_out[epnum];
  1266. } else {
  1267. WARN_ON(usb_pipeout(pipe));
  1268. ep = udev->ep_in[epnum];
  1269. }
  1270. if (!ep)
  1271. return 0;
  1272. /* NOTE: only 0x07ff bits are for packet size... */
  1273. return le16_to_cpu(ep->desc.wMaxPacketSize);
  1274. }
  1275. /* ----------------------------------------------------------------------- */
  1276. /* Events from the usb core */
  1277. #define USB_DEVICE_ADD 0x0001
  1278. #define USB_DEVICE_REMOVE 0x0002
  1279. #define USB_BUS_ADD 0x0003
  1280. #define USB_BUS_REMOVE 0x0004
  1281. extern void usb_register_notify(struct notifier_block *nb);
  1282. extern void usb_unregister_notify(struct notifier_block *nb);
  1283. #ifdef DEBUG
  1284. #define dbg(format, arg...) printk(KERN_DEBUG "%s: " format "\n" , \
  1285. __FILE__ , ## arg)
  1286. #else
  1287. #define dbg(format, arg...) do {} while (0)
  1288. #endif
  1289. #define err(format, arg...) printk(KERN_ERR "%s: " format "\n" , \
  1290. __FILE__ , ## arg)
  1291. #define info(format, arg...) printk(KERN_INFO "%s: " format "\n" , \
  1292. __FILE__ , ## arg)
  1293. #define warn(format, arg...) printk(KERN_WARNING "%s: " format "\n" , \
  1294. __FILE__ , ## arg)
  1295. #endif /* __KERNEL__ */
  1296. #endif