hcd.h 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696
  1. /*
  2. * Copyright (c) 2001-2002 by David Brownell
  3. *
  4. * This program is free software; you can redistribute it and/or modify it
  5. * under the terms of the GNU General Public License as published by the
  6. * Free Software Foundation; either version 2 of the License, or (at your
  7. * option) any later version.
  8. *
  9. * This program is distributed in the hope that it will be useful, but
  10. * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  11. * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  12. * for more details.
  13. *
  14. * You should have received a copy of the GNU General Public License
  15. * along with this program; if not, write to the Free Software Foundation,
  16. * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17. */
  18. #ifndef __USB_CORE_HCD_H
  19. #define __USB_CORE_HCD_H
  20. #ifdef __KERNEL__
  21. #include <linux/rwsem.h>
  22. #define MAX_TOPO_LEVEL 6
  23. /* This file contains declarations of usbcore internals that are mostly
  24. * used or exposed by Host Controller Drivers.
  25. */
  26. /*
  27. * USB Packet IDs (PIDs)
  28. */
  29. #define USB_PID_EXT 0xf0 /* USB 2.0 LPM ECN */
  30. #define USB_PID_OUT 0xe1
  31. #define USB_PID_ACK 0xd2
  32. #define USB_PID_DATA0 0xc3
  33. #define USB_PID_PING 0xb4 /* USB 2.0 */
  34. #define USB_PID_SOF 0xa5
  35. #define USB_PID_NYET 0x96 /* USB 2.0 */
  36. #define USB_PID_DATA2 0x87 /* USB 2.0 */
  37. #define USB_PID_SPLIT 0x78 /* USB 2.0 */
  38. #define USB_PID_IN 0x69
  39. #define USB_PID_NAK 0x5a
  40. #define USB_PID_DATA1 0x4b
  41. #define USB_PID_PREAMBLE 0x3c /* Token mode */
  42. #define USB_PID_ERR 0x3c /* USB 2.0: handshake mode */
  43. #define USB_PID_SETUP 0x2d
  44. #define USB_PID_STALL 0x1e
  45. #define USB_PID_MDATA 0x0f /* USB 2.0 */
  46. /*-------------------------------------------------------------------------*/
  47. /*
  48. * USB Host Controller Driver (usb_hcd) framework
  49. *
  50. * Since "struct usb_bus" is so thin, you can't share much code in it.
  51. * This framework is a layer over that, and should be more sharable.
  52. *
  53. * @authorized_default: Specifies if new devices are authorized to
  54. * connect by default or they require explicit
  55. * user space authorization; this bit is settable
  56. * through /sys/class/usb_host/X/authorized_default.
  57. * For the rest is RO, so we don't lock to r/w it.
  58. */
  59. /*-------------------------------------------------------------------------*/
  60. struct usb_hcd {
  61. /*
  62. * housekeeping
  63. */
  64. struct usb_bus self; /* hcd is-a bus */
  65. struct kref kref; /* reference counter */
  66. const char *product_desc; /* product/vendor string */
  67. int speed; /* Speed for this roothub.
  68. * May be different from
  69. * hcd->driver->flags & HCD_MASK
  70. */
  71. char irq_descr[24]; /* driver + bus # */
  72. struct timer_list rh_timer; /* drives root-hub polling */
  73. struct urb *status_urb; /* the current status urb */
  74. #ifdef CONFIG_USB_SUSPEND
  75. struct work_struct wakeup_work; /* for remote wakeup */
  76. #endif
  77. /*
  78. * hardware info/state
  79. */
  80. const struct hc_driver *driver; /* hw-specific hooks */
  81. /* Flags that need to be manipulated atomically because they can
  82. * change while the host controller is running. Always use
  83. * set_bit() or clear_bit() to change their values.
  84. */
  85. unsigned long flags;
  86. #define HCD_FLAG_HW_ACCESSIBLE 0 /* at full power */
  87. #define HCD_FLAG_POLL_RH 2 /* poll for rh status? */
  88. #define HCD_FLAG_POLL_PENDING 3 /* status has changed? */
  89. #define HCD_FLAG_WAKEUP_PENDING 4 /* root hub is resuming? */
  90. #define HCD_FLAG_RH_RUNNING 5 /* root hub is running? */
  91. #define HCD_FLAG_DEAD 6 /* controller has died? */
  92. /* The flags can be tested using these macros; they are likely to
  93. * be slightly faster than test_bit().
  94. */
  95. #define HCD_HW_ACCESSIBLE(hcd) ((hcd)->flags & (1U << HCD_FLAG_HW_ACCESSIBLE))
  96. #define HCD_POLL_RH(hcd) ((hcd)->flags & (1U << HCD_FLAG_POLL_RH))
  97. #define HCD_POLL_PENDING(hcd) ((hcd)->flags & (1U << HCD_FLAG_POLL_PENDING))
  98. #define HCD_WAKEUP_PENDING(hcd) ((hcd)->flags & (1U << HCD_FLAG_WAKEUP_PENDING))
  99. #define HCD_RH_RUNNING(hcd) ((hcd)->flags & (1U << HCD_FLAG_RH_RUNNING))
  100. #define HCD_DEAD(hcd) ((hcd)->flags & (1U << HCD_FLAG_DEAD))
  101. /* Flags that get set only during HCD registration or removal. */
  102. unsigned rh_registered:1;/* is root hub registered? */
  103. unsigned rh_pollable:1; /* may we poll the root hub? */
  104. unsigned msix_enabled:1; /* driver has MSI-X enabled? */
  105. /* The next flag is a stopgap, to be removed when all the HCDs
  106. * support the new root-hub polling mechanism. */
  107. unsigned uses_new_polling:1;
  108. unsigned wireless:1; /* Wireless USB HCD */
  109. unsigned authorized_default:1;
  110. unsigned has_tt:1; /* Integrated TT in root hub */
  111. unsigned cant_recv_wakeups:1;
  112. unsigned int irq; /* irq allocated */
  113. void __iomem *regs; /* device memory/io */
  114. u64 rsrc_start; /* memory/io resource start */
  115. u64 rsrc_len; /* memory/io resource length */
  116. unsigned power_budget; /* in mA, 0 = no limit */
  117. /* bandwidth_mutex should be taken before adding or removing
  118. * any new bus bandwidth constraints:
  119. * 1. Before adding a configuration for a new device.
  120. * 2. Before removing the configuration to put the device into
  121. * the addressed state.
  122. * 3. Before selecting a different configuration.
  123. * 4. Before selecting an alternate interface setting.
  124. *
  125. * bandwidth_mutex should be dropped after a successful control message
  126. * to the device, or resetting the bandwidth after a failed attempt.
  127. */
  128. struct mutex *bandwidth_mutex;
  129. struct usb_hcd *shared_hcd;
  130. struct usb_hcd *primary_hcd;
  131. #define HCD_BUFFER_POOLS 4
  132. struct dma_pool *pool[HCD_BUFFER_POOLS];
  133. int state;
  134. # define __ACTIVE 0x01
  135. # define __SUSPEND 0x04
  136. # define __TRANSIENT 0x80
  137. # define HC_STATE_HALT 0
  138. # define HC_STATE_RUNNING (__ACTIVE)
  139. # define HC_STATE_QUIESCING (__SUSPEND|__TRANSIENT|__ACTIVE)
  140. # define HC_STATE_RESUMING (__SUSPEND|__TRANSIENT)
  141. # define HC_STATE_SUSPENDED (__SUSPEND)
  142. #define HC_IS_RUNNING(state) ((state) & __ACTIVE)
  143. #define HC_IS_SUSPENDED(state) ((state) & __SUSPEND)
  144. /* more shared queuing code would be good; it should support
  145. * smarter scheduling, handle transaction translators, etc;
  146. * input size of periodic table to an interrupt scheduler.
  147. * (ohci 32, uhci 1024, ehci 256/512/1024).
  148. */
  149. /* The HC driver's private data is stored at the end of
  150. * this structure.
  151. */
  152. unsigned long hcd_priv[0]
  153. __attribute__ ((aligned(sizeof(s64))));
  154. };
  155. /* 2.4 does this a bit differently ... */
  156. static inline struct usb_bus *hcd_to_bus(struct usb_hcd *hcd)
  157. {
  158. return &hcd->self;
  159. }
  160. static inline struct usb_hcd *bus_to_hcd(struct usb_bus *bus)
  161. {
  162. return container_of(bus, struct usb_hcd, self);
  163. }
  164. struct hcd_timeout { /* timeouts we allocate */
  165. struct list_head timeout_list;
  166. struct timer_list timer;
  167. };
  168. /*-------------------------------------------------------------------------*/
  169. struct hc_driver {
  170. const char *description; /* "ehci-hcd" etc */
  171. const char *product_desc; /* product/vendor string */
  172. size_t hcd_priv_size; /* size of private data */
  173. /* irq handler */
  174. irqreturn_t (*irq) (struct usb_hcd *hcd);
  175. int flags;
  176. #define HCD_MEMORY 0x0001 /* HC regs use memory (else I/O) */
  177. #define HCD_LOCAL_MEM 0x0002 /* HC needs local memory */
  178. #define HCD_SHARED 0x0004 /* Two (or more) usb_hcds share HW */
  179. #define HCD_RT_OLD_ENUM 0x0008 /* HC supports short enumeration
  180. on root port */
  181. #define HCD_USB11 0x0010 /* USB 1.1 */
  182. #define HCD_USB2 0x0020 /* USB 2.0 */
  183. #define HCD_USB3 0x0040 /* USB 3.0 */
  184. #define HCD_MASK 0x0070
  185. /* called to init HCD and root hub */
  186. int (*reset) (struct usb_hcd *hcd);
  187. int (*start) (struct usb_hcd *hcd);
  188. /* NOTE: these suspend/resume calls relate to the HC as
  189. * a whole, not just the root hub; they're for PCI bus glue.
  190. */
  191. /* called after suspending the hub, before entering D3 etc */
  192. int (*pci_suspend)(struct usb_hcd *hcd, bool do_wakeup);
  193. /* called after entering D0 (etc), before resuming the hub */
  194. int (*pci_resume)(struct usb_hcd *hcd, bool hibernated);
  195. /* cleanly make HCD stop writing memory and doing I/O */
  196. void (*stop) (struct usb_hcd *hcd);
  197. /* shutdown HCD */
  198. void (*shutdown) (struct usb_hcd *hcd);
  199. /* return current frame number */
  200. int (*get_frame_number) (struct usb_hcd *hcd);
  201. /* manage i/o requests, device state */
  202. int (*urb_enqueue)(struct usb_hcd *hcd,
  203. struct urb *urb, gfp_t mem_flags);
  204. int (*urb_dequeue)(struct usb_hcd *hcd,
  205. struct urb *urb, int status);
  206. /*
  207. * (optional) these hooks allow an HCD to override the default DMA
  208. * mapping and unmapping routines. In general, they shouldn't be
  209. * necessary unless the host controller has special DMA requirements,
  210. * such as alignment contraints. If these are not specified, the
  211. * general usb_hcd_(un)?map_urb_for_dma functions will be used instead
  212. * (and it may be a good idea to call these functions in your HCD
  213. * implementation)
  214. */
  215. int (*map_urb_for_dma)(struct usb_hcd *hcd, struct urb *urb,
  216. gfp_t mem_flags);
  217. void (*unmap_urb_for_dma)(struct usb_hcd *hcd, struct urb *urb);
  218. /* hw synch, freeing endpoint resources that urb_dequeue can't */
  219. void (*endpoint_disable)(struct usb_hcd *hcd,
  220. struct usb_host_endpoint *ep);
  221. /* (optional) reset any endpoint state such as sequence number
  222. and current window */
  223. void (*endpoint_reset)(struct usb_hcd *hcd,
  224. struct usb_host_endpoint *ep);
  225. /* root hub support */
  226. int (*hub_status_data) (struct usb_hcd *hcd, char *buf);
  227. int (*hub_control) (struct usb_hcd *hcd,
  228. u16 typeReq, u16 wValue, u16 wIndex,
  229. char *buf, u16 wLength);
  230. int (*bus_suspend)(struct usb_hcd *);
  231. int (*bus_resume)(struct usb_hcd *);
  232. int (*start_port_reset)(struct usb_hcd *, unsigned port_num);
  233. /* force handover of high-speed port to full-speed companion */
  234. void (*relinquish_port)(struct usb_hcd *, int);
  235. /* has a port been handed over to a companion? */
  236. int (*port_handed_over)(struct usb_hcd *, int);
  237. /* CLEAR_TT_BUFFER completion callback */
  238. void (*clear_tt_buffer_complete)(struct usb_hcd *,
  239. struct usb_host_endpoint *);
  240. /* xHCI specific functions */
  241. /* Called by usb_alloc_dev to alloc HC device structures */
  242. int (*alloc_dev)(struct usb_hcd *, struct usb_device *);
  243. /* Called by usb_disconnect to free HC device structures */
  244. void (*free_dev)(struct usb_hcd *, struct usb_device *);
  245. /* Change a group of bulk endpoints to support multiple stream IDs */
  246. int (*alloc_streams)(struct usb_hcd *hcd, struct usb_device *udev,
  247. struct usb_host_endpoint **eps, unsigned int num_eps,
  248. unsigned int num_streams, gfp_t mem_flags);
  249. /* Reverts a group of bulk endpoints back to not using stream IDs.
  250. * Can fail if we run out of memory.
  251. */
  252. int (*free_streams)(struct usb_hcd *hcd, struct usb_device *udev,
  253. struct usb_host_endpoint **eps, unsigned int num_eps,
  254. gfp_t mem_flags);
  255. /* Bandwidth computation functions */
  256. /* Note that add_endpoint() can only be called once per endpoint before
  257. * check_bandwidth() or reset_bandwidth() must be called.
  258. * drop_endpoint() can only be called once per endpoint also.
  259. * A call to xhci_drop_endpoint() followed by a call to
  260. * xhci_add_endpoint() will add the endpoint to the schedule with
  261. * possibly new parameters denoted by a different endpoint descriptor
  262. * in usb_host_endpoint. A call to xhci_add_endpoint() followed by a
  263. * call to xhci_drop_endpoint() is not allowed.
  264. */
  265. /* Allocate endpoint resources and add them to a new schedule */
  266. int (*add_endpoint)(struct usb_hcd *, struct usb_device *,
  267. struct usb_host_endpoint *);
  268. /* Drop an endpoint from a new schedule */
  269. int (*drop_endpoint)(struct usb_hcd *, struct usb_device *,
  270. struct usb_host_endpoint *);
  271. /* Check that a new hardware configuration, set using
  272. * endpoint_enable and endpoint_disable, does not exceed bus
  273. * bandwidth. This must be called before any set configuration
  274. * or set interface requests are sent to the device.
  275. */
  276. int (*check_bandwidth)(struct usb_hcd *, struct usb_device *);
  277. /* Reset the device schedule to the last known good schedule,
  278. * which was set from a previous successful call to
  279. * check_bandwidth(). This reverts any add_endpoint() and
  280. * drop_endpoint() calls since that last successful call.
  281. * Used for when a check_bandwidth() call fails due to resource
  282. * or bandwidth constraints.
  283. */
  284. void (*reset_bandwidth)(struct usb_hcd *, struct usb_device *);
  285. /* Returns the hardware-chosen device address */
  286. int (*address_device)(struct usb_hcd *, struct usb_device *udev);
  287. /* Notifies the HCD after a hub descriptor is fetched.
  288. * Will block.
  289. */
  290. int (*update_hub_device)(struct usb_hcd *, struct usb_device *hdev,
  291. struct usb_tt *tt, gfp_t mem_flags);
  292. int (*reset_device)(struct usb_hcd *, struct usb_device *);
  293. /* Notifies the HCD after a device is connected and its
  294. * address is set
  295. */
  296. int (*update_device)(struct usb_hcd *, struct usb_device *);
  297. int (*set_usb2_hw_lpm)(struct usb_hcd *, struct usb_device *, int);
  298. /* to log submission/completion events*/
  299. void (*log_urb)(struct urb *urb, char *event, unsigned extra);
  300. void (*dump_regs)(struct usb_hcd *);
  301. void (*set_autosuspend_delay)(struct usb_device *);
  302. void (*reset_sof_bug_handler)(struct usb_hcd *hcd, u32 val);
  303. void (*set_autosuspend)(struct usb_hcd *hcd, int enable_autosuspend);
  304. };
  305. extern int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb);
  306. extern int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
  307. int status);
  308. extern void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb);
  309. extern int usb_hcd_submit_urb(struct urb *urb, gfp_t mem_flags);
  310. extern int usb_hcd_unlink_urb(struct urb *urb, int status);
  311. extern void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb,
  312. int status);
  313. extern int usb_hcd_map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
  314. gfp_t mem_flags);
  315. extern void usb_hcd_unmap_urb_setup_for_dma(struct usb_hcd *, struct urb *);
  316. extern void usb_hcd_unmap_urb_for_dma(struct usb_hcd *, struct urb *);
  317. extern void usb_hcd_flush_endpoint(struct usb_device *udev,
  318. struct usb_host_endpoint *ep);
  319. extern void usb_hcd_disable_endpoint(struct usb_device *udev,
  320. struct usb_host_endpoint *ep);
  321. extern void usb_hcd_reset_endpoint(struct usb_device *udev,
  322. struct usb_host_endpoint *ep);
  323. extern void usb_hcd_synchronize_unlinks(struct usb_device *udev);
  324. extern int usb_hcd_alloc_bandwidth(struct usb_device *udev,
  325. struct usb_host_config *new_config,
  326. struct usb_host_interface *old_alt,
  327. struct usb_host_interface *new_alt);
  328. extern int usb_hcd_get_frame_number(struct usb_device *udev);
  329. extern struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
  330. struct device *dev, const char *bus_name);
  331. extern struct usb_hcd *usb_create_shared_hcd(const struct hc_driver *driver,
  332. struct device *dev, const char *bus_name,
  333. struct usb_hcd *shared_hcd);
  334. extern struct usb_hcd *usb_get_hcd(struct usb_hcd *hcd);
  335. extern void usb_put_hcd(struct usb_hcd *hcd);
  336. extern int usb_hcd_is_primary_hcd(struct usb_hcd *hcd);
  337. #ifdef CONFIG_USB
  338. extern int usb_add_hcd(struct usb_hcd *hcd,
  339. unsigned int irqnum, unsigned long irqflags);
  340. extern void usb_remove_hcd(struct usb_hcd *hcd);
  341. #else
  342. static inline int
  343. usb_add_hcd(struct usb_hcd *hcd, unsigned int irqnum, unsigned long irqflags)
  344. {
  345. return 0;
  346. }
  347. static inline void usb_remove_hcd(struct usb_hcd *hcd) {}
  348. #endif
  349. struct platform_device;
  350. extern void usb_hcd_platform_shutdown(struct platform_device *dev);
  351. #ifdef CONFIG_PCI
  352. struct pci_dev;
  353. struct pci_device_id;
  354. extern int usb_hcd_pci_probe(struct pci_dev *dev,
  355. const struct pci_device_id *id);
  356. extern void usb_hcd_pci_remove(struct pci_dev *dev);
  357. extern void usb_hcd_pci_shutdown(struct pci_dev *dev);
  358. #ifdef CONFIG_PM
  359. extern const struct dev_pm_ops usb_hcd_pci_pm_ops;
  360. #endif
  361. #endif /* CONFIG_PCI */
  362. /* pci-ish (pdev null is ok) buffer alloc/mapping support */
  363. void usb_init_pool_max(void);
  364. int hcd_buffer_create(struct usb_hcd *hcd);
  365. void hcd_buffer_destroy(struct usb_hcd *hcd);
  366. void *hcd_buffer_alloc(struct usb_bus *bus, size_t size,
  367. gfp_t mem_flags, dma_addr_t *dma);
  368. void hcd_buffer_free(struct usb_bus *bus, size_t size,
  369. void *addr, dma_addr_t dma);
  370. /* generic bus glue, needed for host controllers that don't use PCI */
  371. extern irqreturn_t usb_hcd_irq(int irq, void *__hcd);
  372. extern void usb_hc_died(struct usb_hcd *hcd);
  373. extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd);
  374. extern void usb_wakeup_notification(struct usb_device *hdev,
  375. unsigned int portnum);
  376. /* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
  377. #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
  378. #define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep)))
  379. #define usb_settoggle(dev, ep, out, bit) \
  380. ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \
  381. ((bit) << (ep)))
  382. /* -------------------------------------------------------------------------- */
  383. /* Enumeration is only for the hub driver, or HCD virtual root hubs */
  384. extern struct usb_device *usb_alloc_dev(struct usb_device *parent,
  385. struct usb_bus *, unsigned port);
  386. extern int usb_new_device(struct usb_device *dev);
  387. extern void usb_disconnect(struct usb_device **);
  388. extern int usb_get_configuration(struct usb_device *dev);
  389. extern void usb_destroy_configuration(struct usb_device *dev);
  390. /*-------------------------------------------------------------------------*/
  391. /*
  392. * HCD Root Hub support
  393. */
  394. #include <linux/usb/ch11.h>
  395. /*
  396. * As of USB 2.0, full/low speed devices are segregated into trees.
  397. * One type grows from USB 1.1 host controllers (OHCI, UHCI etc).
  398. * The other type grows from high speed hubs when they connect to
  399. * full/low speed devices using "Transaction Translators" (TTs).
  400. *
  401. * TTs should only be known to the hub driver, and high speed bus
  402. * drivers (only EHCI for now). They affect periodic scheduling and
  403. * sometimes control/bulk error recovery.
  404. */
  405. struct usb_device;
  406. struct usb_tt {
  407. struct usb_device *hub; /* upstream highspeed hub */
  408. int multi; /* true means one TT per port */
  409. unsigned think_time; /* think time in ns */
  410. /* for control/bulk error recovery (CLEAR_TT_BUFFER) */
  411. spinlock_t lock;
  412. struct list_head clear_list; /* of usb_tt_clear */
  413. struct work_struct clear_work;
  414. };
  415. struct usb_tt_clear {
  416. struct list_head clear_list;
  417. unsigned tt;
  418. u16 devinfo;
  419. struct usb_hcd *hcd;
  420. struct usb_host_endpoint *ep;
  421. };
  422. extern int usb_hub_clear_tt_buffer(struct urb *urb);
  423. extern void usb_ep0_reinit(struct usb_device *);
  424. /* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
  425. #define DeviceRequest \
  426. ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
  427. #define DeviceOutRequest \
  428. ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
  429. #define InterfaceRequest \
  430. ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
  431. #define EndpointRequest \
  432. ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
  433. #define EndpointOutRequest \
  434. ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
  435. /* class requests from the USB 2.0 hub spec, table 11-15 */
  436. /* GetBusState and SetHubDescriptor are optional, omitted */
  437. #define ClearHubFeature (0x2000 | USB_REQ_CLEAR_FEATURE)
  438. #define ClearPortFeature (0x2300 | USB_REQ_CLEAR_FEATURE)
  439. #define GetHubDescriptor (0xa000 | USB_REQ_GET_DESCRIPTOR)
  440. #define GetHubStatus (0xa000 | USB_REQ_GET_STATUS)
  441. #define GetPortStatus (0xa300 | USB_REQ_GET_STATUS)
  442. #define SetHubFeature (0x2000 | USB_REQ_SET_FEATURE)
  443. #define SetPortFeature (0x2300 | USB_REQ_SET_FEATURE)
  444. /*-------------------------------------------------------------------------*/
  445. /* class requests from USB 3.0 hub spec, table 10-5 */
  446. #define SetHubDepth (0x3000 | HUB_SET_DEPTH)
  447. #define GetPortErrorCount (0x8000 | HUB_GET_PORT_ERR_COUNT)
  448. /*
  449. * Generic bandwidth allocation constants/support
  450. */
  451. #define FRAME_TIME_USECS 1000L
  452. #define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */
  453. /* Trying not to use worst-case bit-stuffing
  454. * of (7/6 * 8 * bytecount) = 9.33 * bytecount */
  455. /* bytecount = data payload byte count */
  456. #define NS_TO_US(ns) ((ns + 500L) / 1000L)
  457. /* convert & round nanoseconds to microseconds */
  458. /*
  459. * Full/low speed bandwidth allocation constants/support.
  460. */
  461. #define BW_HOST_DELAY 1000L /* nanoseconds */
  462. #define BW_HUB_LS_SETUP 333L /* nanoseconds */
  463. /* 4 full-speed bit times (est.) */
  464. #define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */
  465. #define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L)
  466. #define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L)
  467. /*
  468. * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed
  469. * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
  470. * to preallocate bandwidth)
  471. */
  472. #define USB2_HOST_DELAY 5 /* nsec, guess */
  473. #define HS_NSECS(bytes) (((55 * 8 * 2083) \
  474. + (2083UL * (3 + BitTime(bytes))))/1000 \
  475. + USB2_HOST_DELAY)
  476. #define HS_NSECS_ISO(bytes) (((38 * 8 * 2083) \
  477. + (2083UL * (3 + BitTime(bytes))))/1000 \
  478. + USB2_HOST_DELAY)
  479. #define HS_USECS(bytes) NS_TO_US(HS_NSECS(bytes))
  480. #define HS_USECS_ISO(bytes) NS_TO_US(HS_NSECS_ISO(bytes))
  481. extern long usb_calc_bus_time(int speed, int is_input,
  482. int isoc, int bytecount);
  483. /*-------------------------------------------------------------------------*/
  484. extern void usb_set_device_state(struct usb_device *udev,
  485. enum usb_device_state new_state);
  486. /*-------------------------------------------------------------------------*/
  487. /* exported only within usbcore */
  488. extern struct list_head usb_bus_list;
  489. extern struct mutex usb_bus_list_lock;
  490. extern wait_queue_head_t usb_kill_urb_queue;
  491. extern int usb_find_interface_driver(struct usb_device *dev,
  492. struct usb_interface *interface);
  493. #define usb_endpoint_out(ep_dir) (!((ep_dir) & USB_DIR_IN))
  494. #ifdef CONFIG_PM
  495. extern void usb_root_hub_lost_power(struct usb_device *rhdev);
  496. extern int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg);
  497. extern int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg);
  498. #endif /* CONFIG_PM */
  499. #ifdef CONFIG_USB_SUSPEND
  500. extern void usb_hcd_resume_root_hub(struct usb_hcd *hcd);
  501. #else
  502. static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd)
  503. {
  504. return;
  505. }
  506. #endif /* CONFIG_USB_SUSPEND */
  507. /*
  508. * USB device fs stuff
  509. */
  510. #ifdef CONFIG_USB_DEVICEFS
  511. /*
  512. * these are expected to be called from the USB core/hub thread
  513. * with the kernel lock held
  514. */
  515. extern void usbfs_update_special(void);
  516. extern int usbfs_init(void);
  517. extern void usbfs_cleanup(void);
  518. #else /* CONFIG_USB_DEVICEFS */
  519. static inline void usbfs_update_special(void) {}
  520. static inline int usbfs_init(void) { return 0; }
  521. static inline void usbfs_cleanup(void) { }
  522. #endif /* CONFIG_USB_DEVICEFS */
  523. /*-------------------------------------------------------------------------*/
  524. #if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
  525. struct usb_mon_operations {
  526. void (*urb_submit)(struct usb_bus *bus, struct urb *urb);
  527. void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err);
  528. void (*urb_complete)(struct usb_bus *bus, struct urb *urb, int status);
  529. /* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */
  530. };
  531. extern struct usb_mon_operations *mon_ops;
  532. static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb)
  533. {
  534. if (bus->monitored)
  535. (*mon_ops->urb_submit)(bus, urb);
  536. }
  537. static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
  538. int error)
  539. {
  540. if (bus->monitored)
  541. (*mon_ops->urb_submit_error)(bus, urb, error);
  542. }
  543. static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
  544. int status)
  545. {
  546. if (bus->monitored)
  547. (*mon_ops->urb_complete)(bus, urb, status);
  548. }
  549. int usb_mon_register(struct usb_mon_operations *ops);
  550. void usb_mon_deregister(void);
  551. #else
  552. static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {}
  553. static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
  554. int error) {}
  555. static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
  556. int status) {}
  557. #endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */
  558. /*-------------------------------------------------------------------------*/
  559. /* random stuff */
  560. #define RUN_CONTEXT (in_irq() ? "in_irq" \
  561. : (in_interrupt() ? "in_interrupt" : "can sleep"))
  562. /* This rwsem is for use only by the hub driver and ehci-hcd.
  563. * Nobody else should touch it.
  564. */
  565. extern struct rw_semaphore ehci_cf_port_reset_rwsem;
  566. /* Keep track of which host controller drivers are loaded */
  567. #define USB_UHCI_LOADED 0
  568. #define USB_OHCI_LOADED 1
  569. #define USB_EHCI_LOADED 2
  570. extern unsigned long usb_hcds_loaded;
  571. #endif /* __KERNEL__ */
  572. #endif /* __USB_CORE_HCD_H */