usb.h 62 KB

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