hcd.h 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651
  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. char irq_descr[24]; /* driver + bus # */
  68. struct timer_list rh_timer; /* drives root-hub polling */
  69. struct urb *status_urb; /* the current status urb */
  70. #ifdef CONFIG_USB_SUSPEND
  71. struct work_struct wakeup_work; /* for remote wakeup */
  72. #endif
  73. /*
  74. * hardware info/state
  75. */
  76. const struct hc_driver *driver; /* hw-specific hooks */
  77. /* Flags that need to be manipulated atomically because they can
  78. * change while the host controller is running. Always use
  79. * set_bit() or clear_bit() to change their values.
  80. */
  81. unsigned long flags;
  82. #define HCD_FLAG_HW_ACCESSIBLE 0 /* at full power */
  83. #define HCD_FLAG_SAW_IRQ 1
  84. #define HCD_FLAG_POLL_RH 2 /* poll for rh status? */
  85. #define HCD_FLAG_POLL_PENDING 3 /* status has changed? */
  86. #define HCD_FLAG_WAKEUP_PENDING 4 /* root hub is resuming? */
  87. /* The flags can be tested using these macros; they are likely to
  88. * be slightly faster than test_bit().
  89. */
  90. #define HCD_HW_ACCESSIBLE(hcd) ((hcd)->flags & (1U << HCD_FLAG_HW_ACCESSIBLE))
  91. #define HCD_SAW_IRQ(hcd) ((hcd)->flags & (1U << HCD_FLAG_SAW_IRQ))
  92. #define HCD_POLL_RH(hcd) ((hcd)->flags & (1U << HCD_FLAG_POLL_RH))
  93. #define HCD_POLL_PENDING(hcd) ((hcd)->flags & (1U << HCD_FLAG_POLL_PENDING))
  94. #define HCD_WAKEUP_PENDING(hcd) ((hcd)->flags & (1U << HCD_FLAG_WAKEUP_PENDING))
  95. /* Flags that get set only during HCD registration or removal. */
  96. unsigned rh_registered:1;/* is root hub registered? */
  97. unsigned rh_pollable:1; /* may we poll the root hub? */
  98. unsigned msix_enabled:1; /* driver has MSI-X enabled? */
  99. /* The next flag is a stopgap, to be removed when all the HCDs
  100. * support the new root-hub polling mechanism. */
  101. unsigned uses_new_polling:1;
  102. unsigned wireless:1; /* Wireless USB HCD */
  103. unsigned authorized_default:1;
  104. unsigned has_tt:1; /* Integrated TT in root hub */
  105. int irq; /* irq allocated */
  106. void __iomem *regs; /* device memory/io */
  107. u64 rsrc_start; /* memory/io resource start */
  108. u64 rsrc_len; /* memory/io resource length */
  109. unsigned power_budget; /* in mA, 0 = no limit */
  110. /* bandwidth_mutex should be taken before adding or removing
  111. * any new bus bandwidth constraints:
  112. * 1. Before adding a configuration for a new device.
  113. * 2. Before removing the configuration to put the device into
  114. * the addressed state.
  115. * 3. Before selecting a different configuration.
  116. * 4. Before selecting an alternate interface setting.
  117. *
  118. * bandwidth_mutex should be dropped after a successful control message
  119. * to the device, or resetting the bandwidth after a failed attempt.
  120. */
  121. struct mutex bandwidth_mutex;
  122. #define HCD_BUFFER_POOLS 4
  123. struct dma_pool *pool[HCD_BUFFER_POOLS];
  124. int state;
  125. # define __ACTIVE 0x01
  126. # define __SUSPEND 0x04
  127. # define __TRANSIENT 0x80
  128. # define HC_STATE_HALT 0
  129. # define HC_STATE_RUNNING (__ACTIVE)
  130. # define HC_STATE_QUIESCING (__SUSPEND|__TRANSIENT|__ACTIVE)
  131. # define HC_STATE_RESUMING (__SUSPEND|__TRANSIENT)
  132. # define HC_STATE_SUSPENDED (__SUSPEND)
  133. #define HC_IS_RUNNING(state) ((state) & __ACTIVE)
  134. #define HC_IS_SUSPENDED(state) ((state) & __SUSPEND)
  135. /* more shared queuing code would be good; it should support
  136. * smarter scheduling, handle transaction translators, etc;
  137. * input size of periodic table to an interrupt scheduler.
  138. * (ohci 32, uhci 1024, ehci 256/512/1024).
  139. */
  140. /* The HC driver's private data is stored at the end of
  141. * this structure.
  142. */
  143. unsigned long hcd_priv[0]
  144. __attribute__ ((aligned(sizeof(unsigned long))));
  145. };
  146. /* 2.4 does this a bit differently ... */
  147. static inline struct usb_bus *hcd_to_bus(struct usb_hcd *hcd)
  148. {
  149. return &hcd->self;
  150. }
  151. static inline struct usb_hcd *bus_to_hcd(struct usb_bus *bus)
  152. {
  153. return container_of(bus, struct usb_hcd, self);
  154. }
  155. struct hcd_timeout { /* timeouts we allocate */
  156. struct list_head timeout_list;
  157. struct timer_list timer;
  158. };
  159. /*-------------------------------------------------------------------------*/
  160. struct hc_driver {
  161. const char *description; /* "ehci-hcd" etc */
  162. const char *product_desc; /* product/vendor string */
  163. size_t hcd_priv_size; /* size of private data */
  164. /* irq handler */
  165. irqreturn_t (*irq) (struct usb_hcd *hcd);
  166. int flags;
  167. #define HCD_MEMORY 0x0001 /* HC regs use memory (else I/O) */
  168. #define HCD_LOCAL_MEM 0x0002 /* HC needs local memory */
  169. #define HCD_USB11 0x0010 /* USB 1.1 */
  170. #define HCD_USB2 0x0020 /* USB 2.0 */
  171. #define HCD_USB3 0x0040 /* USB 3.0 */
  172. #define HCD_MASK 0x0070
  173. /* called to init HCD and root hub */
  174. int (*reset) (struct usb_hcd *hcd);
  175. int (*start) (struct usb_hcd *hcd);
  176. /* NOTE: these suspend/resume calls relate to the HC as
  177. * a whole, not just the root hub; they're for PCI bus glue.
  178. */
  179. /* called after suspending the hub, before entering D3 etc */
  180. int (*pci_suspend)(struct usb_hcd *hcd, bool do_wakeup);
  181. /* called after entering D0 (etc), before resuming the hub */
  182. int (*pci_resume)(struct usb_hcd *hcd, bool hibernated);
  183. /* cleanly make HCD stop writing memory and doing I/O */
  184. void (*stop) (struct usb_hcd *hcd);
  185. /* shutdown HCD */
  186. void (*shutdown) (struct usb_hcd *hcd);
  187. /* return current frame number */
  188. int (*get_frame_number) (struct usb_hcd *hcd);
  189. /* manage i/o requests, device state */
  190. int (*urb_enqueue)(struct usb_hcd *hcd,
  191. struct urb *urb, gfp_t mem_flags);
  192. int (*urb_dequeue)(struct usb_hcd *hcd,
  193. struct urb *urb, int status);
  194. /* hw synch, freeing endpoint resources that urb_dequeue can't */
  195. void (*endpoint_disable)(struct usb_hcd *hcd,
  196. struct usb_host_endpoint *ep);
  197. /* (optional) reset any endpoint state such as sequence number
  198. and current window */
  199. void (*endpoint_reset)(struct usb_hcd *hcd,
  200. struct usb_host_endpoint *ep);
  201. /* root hub support */
  202. int (*hub_status_data) (struct usb_hcd *hcd, char *buf);
  203. int (*hub_control) (struct usb_hcd *hcd,
  204. u16 typeReq, u16 wValue, u16 wIndex,
  205. char *buf, u16 wLength);
  206. int (*bus_suspend)(struct usb_hcd *);
  207. int (*bus_resume)(struct usb_hcd *);
  208. int (*start_port_reset)(struct usb_hcd *, unsigned port_num);
  209. /* force handover of high-speed port to full-speed companion */
  210. void (*relinquish_port)(struct usb_hcd *, int);
  211. /* has a port been handed over to a companion? */
  212. int (*port_handed_over)(struct usb_hcd *, int);
  213. /* CLEAR_TT_BUFFER completion callback */
  214. void (*clear_tt_buffer_complete)(struct usb_hcd *,
  215. struct usb_host_endpoint *);
  216. /* xHCI specific functions */
  217. /* Called by usb_alloc_dev to alloc HC device structures */
  218. int (*alloc_dev)(struct usb_hcd *, struct usb_device *);
  219. /* Called by usb_disconnect to free HC device structures */
  220. void (*free_dev)(struct usb_hcd *, struct usb_device *);
  221. /* Change a group of bulk endpoints to support multiple stream IDs */
  222. int (*alloc_streams)(struct usb_hcd *hcd, struct usb_device *udev,
  223. struct usb_host_endpoint **eps, unsigned int num_eps,
  224. unsigned int num_streams, gfp_t mem_flags);
  225. /* Reverts a group of bulk endpoints back to not using stream IDs.
  226. * Can fail if we run out of memory.
  227. */
  228. int (*free_streams)(struct usb_hcd *hcd, struct usb_device *udev,
  229. struct usb_host_endpoint **eps, unsigned int num_eps,
  230. gfp_t mem_flags);
  231. /* Bandwidth computation functions */
  232. /* Note that add_endpoint() can only be called once per endpoint before
  233. * check_bandwidth() or reset_bandwidth() must be called.
  234. * drop_endpoint() can only be called once per endpoint also.
  235. * A call to xhci_drop_endpoint() followed by a call to
  236. * xhci_add_endpoint() will add the endpoint to the schedule with
  237. * possibly new parameters denoted by a different endpoint descriptor
  238. * in usb_host_endpoint. A call to xhci_add_endpoint() followed by a
  239. * call to xhci_drop_endpoint() is not allowed.
  240. */
  241. /* Allocate endpoint resources and add them to a new schedule */
  242. int (*add_endpoint)(struct usb_hcd *, struct usb_device *,
  243. struct usb_host_endpoint *);
  244. /* Drop an endpoint from a new schedule */
  245. int (*drop_endpoint)(struct usb_hcd *, struct usb_device *,
  246. struct usb_host_endpoint *);
  247. /* Check that a new hardware configuration, set using
  248. * endpoint_enable and endpoint_disable, does not exceed bus
  249. * bandwidth. This must be called before any set configuration
  250. * or set interface requests are sent to the device.
  251. */
  252. int (*check_bandwidth)(struct usb_hcd *, struct usb_device *);
  253. /* Reset the device schedule to the last known good schedule,
  254. * which was set from a previous successful call to
  255. * check_bandwidth(). This reverts any add_endpoint() and
  256. * drop_endpoint() calls since that last successful call.
  257. * Used for when a check_bandwidth() call fails due to resource
  258. * or bandwidth constraints.
  259. */
  260. void (*reset_bandwidth)(struct usb_hcd *, struct usb_device *);
  261. /* Returns the hardware-chosen device address */
  262. int (*address_device)(struct usb_hcd *, struct usb_device *udev);
  263. /* Notifies the HCD after a hub descriptor is fetched.
  264. * Will block.
  265. */
  266. int (*update_hub_device)(struct usb_hcd *, struct usb_device *hdev,
  267. struct usb_tt *tt, gfp_t mem_flags);
  268. int (*reset_device)(struct usb_hcd *, struct usb_device *);
  269. /* Notifies the HCD after a device is connected and its
  270. * address is set
  271. */
  272. int (*update_device)(struct usb_hcd *, struct usb_device *);
  273. };
  274. extern int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb);
  275. extern int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
  276. int status);
  277. extern void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb);
  278. extern int usb_hcd_submit_urb(struct urb *urb, gfp_t mem_flags);
  279. extern int usb_hcd_unlink_urb(struct urb *urb, int status);
  280. extern void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb,
  281. int status);
  282. extern void unmap_urb_setup_for_dma(struct usb_hcd *, struct urb *);
  283. extern void unmap_urb_for_dma(struct usb_hcd *, struct urb *);
  284. extern void usb_hcd_flush_endpoint(struct usb_device *udev,
  285. struct usb_host_endpoint *ep);
  286. extern void usb_hcd_disable_endpoint(struct usb_device *udev,
  287. struct usb_host_endpoint *ep);
  288. extern void usb_hcd_reset_endpoint(struct usb_device *udev,
  289. struct usb_host_endpoint *ep);
  290. extern void usb_hcd_synchronize_unlinks(struct usb_device *udev);
  291. extern int usb_hcd_alloc_bandwidth(struct usb_device *udev,
  292. struct usb_host_config *new_config,
  293. struct usb_host_interface *old_alt,
  294. struct usb_host_interface *new_alt);
  295. extern int usb_hcd_get_frame_number(struct usb_device *udev);
  296. extern struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
  297. struct device *dev, const char *bus_name);
  298. extern struct usb_hcd *usb_get_hcd(struct usb_hcd *hcd);
  299. extern void usb_put_hcd(struct usb_hcd *hcd);
  300. extern int usb_add_hcd(struct usb_hcd *hcd,
  301. unsigned int irqnum, unsigned long irqflags);
  302. extern void usb_remove_hcd(struct usb_hcd *hcd);
  303. struct platform_device;
  304. extern void usb_hcd_platform_shutdown(struct platform_device *dev);
  305. #ifdef CONFIG_PCI
  306. struct pci_dev;
  307. struct pci_device_id;
  308. extern int usb_hcd_pci_probe(struct pci_dev *dev,
  309. const struct pci_device_id *id);
  310. extern void usb_hcd_pci_remove(struct pci_dev *dev);
  311. extern void usb_hcd_pci_shutdown(struct pci_dev *dev);
  312. #ifdef CONFIG_PM_SLEEP
  313. extern const struct dev_pm_ops usb_hcd_pci_pm_ops;
  314. #endif
  315. #endif /* CONFIG_PCI */
  316. /* pci-ish (pdev null is ok) buffer alloc/mapping support */
  317. int hcd_buffer_create(struct usb_hcd *hcd);
  318. void hcd_buffer_destroy(struct usb_hcd *hcd);
  319. void *hcd_buffer_alloc(struct usb_bus *bus, size_t size,
  320. gfp_t mem_flags, dma_addr_t *dma);
  321. void hcd_buffer_free(struct usb_bus *bus, size_t size,
  322. void *addr, dma_addr_t dma);
  323. /* generic bus glue, needed for host controllers that don't use PCI */
  324. extern irqreturn_t usb_hcd_irq(int irq, void *__hcd);
  325. extern void usb_hc_died(struct usb_hcd *hcd);
  326. extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd);
  327. /* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
  328. #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
  329. #define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep)))
  330. #define usb_settoggle(dev, ep, out, bit) \
  331. ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \
  332. ((bit) << (ep)))
  333. /* -------------------------------------------------------------------------- */
  334. /* Enumeration is only for the hub driver, or HCD virtual root hubs */
  335. extern struct usb_device *usb_alloc_dev(struct usb_device *parent,
  336. struct usb_bus *, unsigned port);
  337. extern int usb_new_device(struct usb_device *dev);
  338. extern void usb_disconnect(struct usb_device **);
  339. extern int usb_get_configuration(struct usb_device *dev);
  340. extern void usb_destroy_configuration(struct usb_device *dev);
  341. /*-------------------------------------------------------------------------*/
  342. /*
  343. * HCD Root Hub support
  344. */
  345. #include <linux/usb/ch11.h>
  346. /*
  347. * As of USB 2.0, full/low speed devices are segregated into trees.
  348. * One type grows from USB 1.1 host controllers (OHCI, UHCI etc).
  349. * The other type grows from high speed hubs when they connect to
  350. * full/low speed devices using "Transaction Translators" (TTs).
  351. *
  352. * TTs should only be known to the hub driver, and high speed bus
  353. * drivers (only EHCI for now). They affect periodic scheduling and
  354. * sometimes control/bulk error recovery.
  355. */
  356. struct usb_device;
  357. struct usb_tt {
  358. struct usb_device *hub; /* upstream highspeed hub */
  359. int multi; /* true means one TT per port */
  360. unsigned think_time; /* think time in ns */
  361. /* for control/bulk error recovery (CLEAR_TT_BUFFER) */
  362. spinlock_t lock;
  363. struct list_head clear_list; /* of usb_tt_clear */
  364. struct work_struct clear_work;
  365. };
  366. struct usb_tt_clear {
  367. struct list_head clear_list;
  368. unsigned tt;
  369. u16 devinfo;
  370. struct usb_hcd *hcd;
  371. struct usb_host_endpoint *ep;
  372. };
  373. extern int usb_hub_clear_tt_buffer(struct urb *urb);
  374. extern void usb_ep0_reinit(struct usb_device *);
  375. /* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
  376. #define DeviceRequest \
  377. ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
  378. #define DeviceOutRequest \
  379. ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
  380. #define InterfaceRequest \
  381. ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
  382. #define EndpointRequest \
  383. ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
  384. #define EndpointOutRequest \
  385. ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
  386. /* class requests from the USB 2.0 hub spec, table 11-15 */
  387. /* GetBusState and SetHubDescriptor are optional, omitted */
  388. #define ClearHubFeature (0x2000 | USB_REQ_CLEAR_FEATURE)
  389. #define ClearPortFeature (0x2300 | USB_REQ_CLEAR_FEATURE)
  390. #define GetHubDescriptor (0xa000 | USB_REQ_GET_DESCRIPTOR)
  391. #define GetHubStatus (0xa000 | USB_REQ_GET_STATUS)
  392. #define GetPortStatus (0xa300 | USB_REQ_GET_STATUS)
  393. #define SetHubFeature (0x2000 | USB_REQ_SET_FEATURE)
  394. #define SetPortFeature (0x2300 | USB_REQ_SET_FEATURE)
  395. /*-------------------------------------------------------------------------*/
  396. /* class requests from USB 3.0 hub spec, table 10-5 */
  397. #define SetHubDepth (0x3000 | HUB_SET_DEPTH)
  398. #define GetPortErrorCount (0x8000 | HUB_GET_PORT_ERR_COUNT)
  399. /*
  400. * Generic bandwidth allocation constants/support
  401. */
  402. #define FRAME_TIME_USECS 1000L
  403. #define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */
  404. /* Trying not to use worst-case bit-stuffing
  405. * of (7/6 * 8 * bytecount) = 9.33 * bytecount */
  406. /* bytecount = data payload byte count */
  407. #define NS_TO_US(ns) ((ns + 500L) / 1000L)
  408. /* convert & round nanoseconds to microseconds */
  409. /*
  410. * Full/low speed bandwidth allocation constants/support.
  411. */
  412. #define BW_HOST_DELAY 1000L /* nanoseconds */
  413. #define BW_HUB_LS_SETUP 333L /* nanoseconds */
  414. /* 4 full-speed bit times (est.) */
  415. #define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */
  416. #define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L)
  417. #define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L)
  418. /*
  419. * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed
  420. * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
  421. * to preallocate bandwidth)
  422. */
  423. #define USB2_HOST_DELAY 5 /* nsec, guess */
  424. #define HS_NSECS(bytes) (((55 * 8 * 2083) \
  425. + (2083UL * (3 + BitTime(bytes))))/1000 \
  426. + USB2_HOST_DELAY)
  427. #define HS_NSECS_ISO(bytes) (((38 * 8 * 2083) \
  428. + (2083UL * (3 + BitTime(bytes))))/1000 \
  429. + USB2_HOST_DELAY)
  430. #define HS_USECS(bytes) NS_TO_US(HS_NSECS(bytes))
  431. #define HS_USECS_ISO(bytes) NS_TO_US(HS_NSECS_ISO(bytes))
  432. extern long usb_calc_bus_time(int speed, int is_input,
  433. int isoc, int bytecount);
  434. /*-------------------------------------------------------------------------*/
  435. extern void usb_set_device_state(struct usb_device *udev,
  436. enum usb_device_state new_state);
  437. /*-------------------------------------------------------------------------*/
  438. /* exported only within usbcore */
  439. extern struct list_head usb_bus_list;
  440. extern struct mutex usb_bus_list_lock;
  441. extern wait_queue_head_t usb_kill_urb_queue;
  442. extern int usb_find_interface_driver(struct usb_device *dev,
  443. struct usb_interface *interface);
  444. #define usb_endpoint_out(ep_dir) (!((ep_dir) & USB_DIR_IN))
  445. #ifdef CONFIG_PM
  446. extern void usb_root_hub_lost_power(struct usb_device *rhdev);
  447. extern int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg);
  448. extern int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg);
  449. #endif /* CONFIG_PM */
  450. #ifdef CONFIG_USB_SUSPEND
  451. extern void usb_hcd_resume_root_hub(struct usb_hcd *hcd);
  452. #else
  453. static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd)
  454. {
  455. return;
  456. }
  457. #endif /* CONFIG_USB_SUSPEND */
  458. /*
  459. * USB device fs stuff
  460. */
  461. #ifdef CONFIG_USB_DEVICEFS
  462. /*
  463. * these are expected to be called from the USB core/hub thread
  464. * with the kernel lock held
  465. */
  466. extern void usbfs_update_special(void);
  467. extern int usbfs_init(void);
  468. extern void usbfs_cleanup(void);
  469. #else /* CONFIG_USB_DEVICEFS */
  470. static inline void usbfs_update_special(void) {}
  471. static inline int usbfs_init(void) { return 0; }
  472. static inline void usbfs_cleanup(void) { }
  473. #endif /* CONFIG_USB_DEVICEFS */
  474. /*-------------------------------------------------------------------------*/
  475. #if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
  476. struct usb_mon_operations {
  477. void (*urb_submit)(struct usb_bus *bus, struct urb *urb);
  478. void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err);
  479. void (*urb_complete)(struct usb_bus *bus, struct urb *urb, int status);
  480. /* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */
  481. };
  482. extern struct usb_mon_operations *mon_ops;
  483. static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb)
  484. {
  485. if (bus->monitored)
  486. (*mon_ops->urb_submit)(bus, urb);
  487. }
  488. static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
  489. int error)
  490. {
  491. if (bus->monitored)
  492. (*mon_ops->urb_submit_error)(bus, urb, error);
  493. }
  494. static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
  495. int status)
  496. {
  497. if (bus->monitored)
  498. (*mon_ops->urb_complete)(bus, urb, status);
  499. }
  500. int usb_mon_register(struct usb_mon_operations *ops);
  501. void usb_mon_deregister(void);
  502. #else
  503. static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {}
  504. static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
  505. int error) {}
  506. static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
  507. int status) {}
  508. #endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */
  509. /*-------------------------------------------------------------------------*/
  510. /* hub.h ... DeviceRemovable in 2.4.2-ac11, gone in 2.4.10 */
  511. /* bleech -- resurfaced in 2.4.11 or 2.4.12 */
  512. #define bitmap DeviceRemovable
  513. /*-------------------------------------------------------------------------*/
  514. /* random stuff */
  515. #define RUN_CONTEXT (in_irq() ? "in_irq" \
  516. : (in_interrupt() ? "in_interrupt" : "can sleep"))
  517. /* This rwsem is for use only by the hub driver and ehci-hcd.
  518. * Nobody else should touch it.
  519. */
  520. extern struct rw_semaphore ehci_cf_port_reset_rwsem;
  521. /* Keep track of which host controller drivers are loaded */
  522. #define USB_UHCI_LOADED 0
  523. #define USB_OHCI_LOADED 1
  524. #define USB_EHCI_LOADED 2
  525. extern unsigned long usb_hcds_loaded;
  526. #endif /* __KERNEL__ */
  527. #endif /* __USB_CORE_HCD_H */