usb.h 48 KB

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