ehci.h 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721
  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 __LINUX_EHCI_HCD_H
  19. #define __LINUX_EHCI_HCD_H
  20. /* definitions used for the EHCI driver */
  21. /*
  22. * __hc32 and __hc16 are "Host Controller" types, they may be equivalent to
  23. * __leXX (normally) or __beXX (given EHCI_BIG_ENDIAN_DESC), depending on
  24. * the host controller implementation.
  25. *
  26. * To facilitate the strongest possible byte-order checking from "sparse"
  27. * and so on, we use __leXX unless that's not practical.
  28. */
  29. #ifdef CONFIG_USB_EHCI_BIG_ENDIAN_DESC
  30. typedef __u32 __bitwise __hc32;
  31. typedef __u16 __bitwise __hc16;
  32. #else
  33. #define __hc32 __le32
  34. #define __hc16 __le16
  35. #endif
  36. /* statistics can be kept for tuning/monitoring */
  37. struct ehci_stats {
  38. /* irq usage */
  39. unsigned long normal;
  40. unsigned long error;
  41. unsigned long reclaim;
  42. unsigned long lost_iaa;
  43. /* termination of urbs from core */
  44. unsigned long complete;
  45. unsigned long unlink;
  46. };
  47. /* ehci_hcd->lock guards shared data against other CPUs:
  48. * ehci_hcd: async, reclaim, periodic (and shadow), ...
  49. * usb_host_endpoint: hcpriv
  50. * ehci_qh: qh_next, qtd_list
  51. * ehci_qtd: qtd_list
  52. *
  53. * Also, hold this lock when talking to HC registers or
  54. * when updating hw_* fields in shared qh/qtd/... structures.
  55. */
  56. #define EHCI_MAX_ROOT_PORTS 15 /* see HCS_N_PORTS */
  57. struct ehci_hcd { /* one per controller */
  58. /* glue to PCI and HCD framework */
  59. struct ehci_caps __iomem *caps;
  60. struct ehci_regs __iomem *regs;
  61. struct ehci_dbg_port __iomem *debug;
  62. __u32 hcs_params; /* cached register copy */
  63. spinlock_t lock;
  64. /* async schedule support */
  65. struct ehci_qh *async;
  66. struct ehci_qh *reclaim;
  67. unsigned scanning : 1;
  68. /* periodic schedule support */
  69. #define DEFAULT_I_TDPS 1024 /* some HCs can do less */
  70. unsigned periodic_size;
  71. __hc32 *periodic; /* hw periodic table */
  72. dma_addr_t periodic_dma;
  73. unsigned i_thresh; /* uframes HC might cache */
  74. union ehci_shadow *pshadow; /* mirror hw periodic table */
  75. int next_uframe; /* scan periodic, start here */
  76. unsigned periodic_sched; /* periodic activity count */
  77. /* list of itds completed while clock_frame was still active */
  78. struct list_head cached_itd_list;
  79. unsigned clock_frame;
  80. /* per root hub port */
  81. unsigned long reset_done [EHCI_MAX_ROOT_PORTS];
  82. /* bit vectors (one bit per port) */
  83. unsigned long bus_suspended; /* which ports were
  84. already suspended at the start of a bus suspend */
  85. unsigned long companion_ports; /* which ports are
  86. dedicated to the companion controller */
  87. unsigned long owned_ports; /* which ports are
  88. owned by the companion during a bus suspend */
  89. unsigned long port_c_suspend; /* which ports have
  90. the change-suspend feature turned on */
  91. unsigned long suspended_ports; /* which ports are
  92. suspended */
  93. /* per-HC memory pools (could be per-bus, but ...) */
  94. struct dma_pool *qh_pool; /* qh per active urb */
  95. struct dma_pool *qtd_pool; /* one or more per qh */
  96. struct dma_pool *itd_pool; /* itd per iso urb */
  97. struct dma_pool *sitd_pool; /* sitd per split iso urb */
  98. struct timer_list iaa_watchdog;
  99. struct timer_list watchdog;
  100. unsigned long actions;
  101. unsigned stamp;
  102. unsigned random_frame;
  103. unsigned long next_statechange;
  104. u32 command;
  105. /* SILICON QUIRKS */
  106. unsigned no_selective_suspend:1;
  107. unsigned has_fsl_port_bug:1; /* FreeScale */
  108. unsigned big_endian_mmio:1;
  109. unsigned big_endian_desc:1;
  110. unsigned has_amcc_usb23:1;
  111. unsigned need_io_watchdog:1;
  112. /* required for usb32 quirk */
  113. #define OHCI_CTRL_HCFS (3 << 6)
  114. #define OHCI_USB_OPER (2 << 6)
  115. #define OHCI_USB_SUSPEND (3 << 6)
  116. #define OHCI_HCCTRL_OFFSET 0x4
  117. #define OHCI_HCCTRL_LEN 0x4
  118. __hc32 *ohci_hcctrl_reg;
  119. unsigned has_hostpc:1;
  120. u8 sbrn; /* packed release number */
  121. /* irq statistics */
  122. #ifdef EHCI_STATS
  123. struct ehci_stats stats;
  124. # define COUNT(x) do { (x)++; } while (0)
  125. #else
  126. # define COUNT(x) do {} while (0)
  127. #endif
  128. /* debug files */
  129. #ifdef DEBUG
  130. struct dentry *debug_dir;
  131. struct dentry *debug_async;
  132. struct dentry *debug_periodic;
  133. struct dentry *debug_registers;
  134. #endif
  135. };
  136. /* convert between an HCD pointer and the corresponding EHCI_HCD */
  137. static inline struct ehci_hcd *hcd_to_ehci (struct usb_hcd *hcd)
  138. {
  139. return (struct ehci_hcd *) (hcd->hcd_priv);
  140. }
  141. static inline struct usb_hcd *ehci_to_hcd (struct ehci_hcd *ehci)
  142. {
  143. return container_of ((void *) ehci, struct usb_hcd, hcd_priv);
  144. }
  145. static inline void
  146. iaa_watchdog_start(struct ehci_hcd *ehci)
  147. {
  148. WARN_ON(timer_pending(&ehci->iaa_watchdog));
  149. mod_timer(&ehci->iaa_watchdog,
  150. jiffies + msecs_to_jiffies(EHCI_IAA_MSECS));
  151. }
  152. static inline void iaa_watchdog_done(struct ehci_hcd *ehci)
  153. {
  154. del_timer(&ehci->iaa_watchdog);
  155. }
  156. enum ehci_timer_action {
  157. TIMER_IO_WATCHDOG,
  158. TIMER_ASYNC_SHRINK,
  159. TIMER_ASYNC_OFF,
  160. };
  161. static inline void
  162. timer_action_done (struct ehci_hcd *ehci, enum ehci_timer_action action)
  163. {
  164. clear_bit (action, &ehci->actions);
  165. }
  166. static void free_cached_itd_list(struct ehci_hcd *ehci);
  167. /*-------------------------------------------------------------------------*/
  168. #include <linux/usb/ehci_def.h>
  169. /*-------------------------------------------------------------------------*/
  170. #define QTD_NEXT(ehci, dma) cpu_to_hc32(ehci, (u32)dma)
  171. /*
  172. * EHCI Specification 0.95 Section 3.5
  173. * QTD: describe data transfer components (buffer, direction, ...)
  174. * See Fig 3-6 "Queue Element Transfer Descriptor Block Diagram".
  175. *
  176. * These are associated only with "QH" (Queue Head) structures,
  177. * used with control, bulk, and interrupt transfers.
  178. */
  179. struct ehci_qtd {
  180. /* first part defined by EHCI spec */
  181. __hc32 hw_next; /* see EHCI 3.5.1 */
  182. __hc32 hw_alt_next; /* see EHCI 3.5.2 */
  183. __hc32 hw_token; /* see EHCI 3.5.3 */
  184. #define QTD_TOGGLE (1 << 31) /* data toggle */
  185. #define QTD_LENGTH(tok) (((tok)>>16) & 0x7fff)
  186. #define QTD_IOC (1 << 15) /* interrupt on complete */
  187. #define QTD_CERR(tok) (((tok)>>10) & 0x3)
  188. #define QTD_PID(tok) (((tok)>>8) & 0x3)
  189. #define QTD_STS_ACTIVE (1 << 7) /* HC may execute this */
  190. #define QTD_STS_HALT (1 << 6) /* halted on error */
  191. #define QTD_STS_DBE (1 << 5) /* data buffer error (in HC) */
  192. #define QTD_STS_BABBLE (1 << 4) /* device was babbling (qtd halted) */
  193. #define QTD_STS_XACT (1 << 3) /* device gave illegal response */
  194. #define QTD_STS_MMF (1 << 2) /* incomplete split transaction */
  195. #define QTD_STS_STS (1 << 1) /* split transaction state */
  196. #define QTD_STS_PING (1 << 0) /* issue PING? */
  197. #define ACTIVE_BIT(ehci) cpu_to_hc32(ehci, QTD_STS_ACTIVE)
  198. #define HALT_BIT(ehci) cpu_to_hc32(ehci, QTD_STS_HALT)
  199. #define STATUS_BIT(ehci) cpu_to_hc32(ehci, QTD_STS_STS)
  200. __hc32 hw_buf [5]; /* see EHCI 3.5.4 */
  201. __hc32 hw_buf_hi [5]; /* Appendix B */
  202. /* the rest is HCD-private */
  203. dma_addr_t qtd_dma; /* qtd address */
  204. struct list_head qtd_list; /* sw qtd list */
  205. struct urb *urb; /* qtd's urb */
  206. size_t length; /* length of buffer */
  207. } __attribute__ ((aligned (32)));
  208. /* mask NakCnt+T in qh->hw_alt_next */
  209. #define QTD_MASK(ehci) cpu_to_hc32 (ehci, ~0x1f)
  210. #define IS_SHORT_READ(token) (QTD_LENGTH (token) != 0 && QTD_PID (token) == 1)
  211. /*-------------------------------------------------------------------------*/
  212. /* type tag from {qh,itd,sitd,fstn}->hw_next */
  213. #define Q_NEXT_TYPE(ehci,dma) ((dma) & cpu_to_hc32(ehci, 3 << 1))
  214. /*
  215. * Now the following defines are not converted using the
  216. * cpu_to_le32() macro anymore, since we have to support
  217. * "dynamic" switching between be and le support, so that the driver
  218. * can be used on one system with SoC EHCI controller using big-endian
  219. * descriptors as well as a normal little-endian PCI EHCI controller.
  220. */
  221. /* values for that type tag */
  222. #define Q_TYPE_ITD (0 << 1)
  223. #define Q_TYPE_QH (1 << 1)
  224. #define Q_TYPE_SITD (2 << 1)
  225. #define Q_TYPE_FSTN (3 << 1)
  226. /* next async queue entry, or pointer to interrupt/periodic QH */
  227. #define QH_NEXT(ehci,dma) (cpu_to_hc32(ehci, (((u32)dma)&~0x01f)|Q_TYPE_QH))
  228. /* for periodic/async schedules and qtd lists, mark end of list */
  229. #define EHCI_LIST_END(ehci) cpu_to_hc32(ehci, 1) /* "null pointer" to hw */
  230. /*
  231. * Entries in periodic shadow table are pointers to one of four kinds
  232. * of data structure. That's dictated by the hardware; a type tag is
  233. * encoded in the low bits of the hardware's periodic schedule. Use
  234. * Q_NEXT_TYPE to get the tag.
  235. *
  236. * For entries in the async schedule, the type tag always says "qh".
  237. */
  238. union ehci_shadow {
  239. struct ehci_qh *qh; /* Q_TYPE_QH */
  240. struct ehci_itd *itd; /* Q_TYPE_ITD */
  241. struct ehci_sitd *sitd; /* Q_TYPE_SITD */
  242. struct ehci_fstn *fstn; /* Q_TYPE_FSTN */
  243. __hc32 *hw_next; /* (all types) */
  244. void *ptr;
  245. };
  246. /*-------------------------------------------------------------------------*/
  247. /*
  248. * EHCI Specification 0.95 Section 3.6
  249. * QH: describes control/bulk/interrupt endpoints
  250. * See Fig 3-7 "Queue Head Structure Layout".
  251. *
  252. * These appear in both the async and (for interrupt) periodic schedules.
  253. */
  254. /* first part defined by EHCI spec */
  255. struct ehci_qh_hw {
  256. __hc32 hw_next; /* see EHCI 3.6.1 */
  257. __hc32 hw_info1; /* see EHCI 3.6.2 */
  258. #define QH_HEAD 0x00008000
  259. __hc32 hw_info2; /* see EHCI 3.6.2 */
  260. #define QH_SMASK 0x000000ff
  261. #define QH_CMASK 0x0000ff00
  262. #define QH_HUBADDR 0x007f0000
  263. #define QH_HUBPORT 0x3f800000
  264. #define QH_MULT 0xc0000000
  265. __hc32 hw_current; /* qtd list - see EHCI 3.6.4 */
  266. /* qtd overlay (hardware parts of a struct ehci_qtd) */
  267. __hc32 hw_qtd_next;
  268. __hc32 hw_alt_next;
  269. __hc32 hw_token;
  270. __hc32 hw_buf [5];
  271. __hc32 hw_buf_hi [5];
  272. } __attribute__ ((aligned(32)));
  273. struct ehci_qh {
  274. struct ehci_qh_hw *hw;
  275. /* the rest is HCD-private */
  276. dma_addr_t qh_dma; /* address of qh */
  277. union ehci_shadow qh_next; /* ptr to qh; or periodic */
  278. struct list_head qtd_list; /* sw qtd list */
  279. struct ehci_qtd *dummy;
  280. struct ehci_qh *reclaim; /* next to reclaim */
  281. struct ehci_hcd *ehci;
  282. /*
  283. * Do NOT use atomic operations for QH refcounting. On some CPUs
  284. * (PPC7448 for example), atomic operations cannot be performed on
  285. * memory that is cache-inhibited (i.e. being used for DMA).
  286. * Spinlocks are used to protect all QH fields.
  287. */
  288. u32 refcount;
  289. unsigned stamp;
  290. u8 needs_rescan; /* Dequeue during giveback */
  291. u8 qh_state;
  292. #define QH_STATE_LINKED 1 /* HC sees this */
  293. #define QH_STATE_UNLINK 2 /* HC may still see this */
  294. #define QH_STATE_IDLE 3 /* HC doesn't see this */
  295. #define QH_STATE_UNLINK_WAIT 4 /* LINKED and on reclaim q */
  296. #define QH_STATE_COMPLETING 5 /* don't touch token.HALT */
  297. u8 xacterrs; /* XactErr retry counter */
  298. #define QH_XACTERR_MAX 32 /* XactErr retry limit */
  299. /* periodic schedule info */
  300. u8 usecs; /* intr bandwidth */
  301. u8 gap_uf; /* uframes split/csplit gap */
  302. u8 c_usecs; /* ... split completion bw */
  303. u16 tt_usecs; /* tt downstream bandwidth */
  304. unsigned short period; /* polling interval */
  305. unsigned short start; /* where polling starts */
  306. #define NO_FRAME ((unsigned short)~0) /* pick new start */
  307. struct usb_device *dev; /* access to TT */
  308. unsigned clearing_tt:1; /* Clear-TT-Buf in progress */
  309. };
  310. /*-------------------------------------------------------------------------*/
  311. /* description of one iso transaction (up to 3 KB data if highspeed) */
  312. struct ehci_iso_packet {
  313. /* These will be copied to iTD when scheduling */
  314. u64 bufp; /* itd->hw_bufp{,_hi}[pg] |= */
  315. __hc32 transaction; /* itd->hw_transaction[i] |= */
  316. u8 cross; /* buf crosses pages */
  317. /* for full speed OUT splits */
  318. u32 buf1;
  319. };
  320. /* temporary schedule data for packets from iso urbs (both speeds)
  321. * each packet is one logical usb transaction to the device (not TT),
  322. * beginning at stream->next_uframe
  323. */
  324. struct ehci_iso_sched {
  325. struct list_head td_list;
  326. unsigned span;
  327. struct ehci_iso_packet packet [0];
  328. };
  329. /*
  330. * ehci_iso_stream - groups all (s)itds for this endpoint.
  331. * acts like a qh would, if EHCI had them for ISO.
  332. */
  333. struct ehci_iso_stream {
  334. /* first two fields match QH, but info1 == 0 */
  335. __hc32 hw_next;
  336. __hc32 hw_info1;
  337. u32 refcount;
  338. u8 bEndpointAddress;
  339. u8 highspeed;
  340. u16 depth; /* depth in uframes */
  341. struct list_head td_list; /* queued itds/sitds */
  342. struct list_head free_list; /* list of unused itds/sitds */
  343. struct usb_device *udev;
  344. struct usb_host_endpoint *ep;
  345. /* output of (re)scheduling */
  346. unsigned long start; /* jiffies */
  347. unsigned long rescheduled;
  348. int next_uframe;
  349. __hc32 splits;
  350. /* the rest is derived from the endpoint descriptor,
  351. * trusting urb->interval == f(epdesc->bInterval) and
  352. * including the extra info for hw_bufp[0..2]
  353. */
  354. u8 usecs, c_usecs;
  355. u16 interval;
  356. u16 tt_usecs;
  357. u16 maxp;
  358. u16 raw_mask;
  359. unsigned bandwidth;
  360. /* This is used to initialize iTD's hw_bufp fields */
  361. __hc32 buf0;
  362. __hc32 buf1;
  363. __hc32 buf2;
  364. /* this is used to initialize sITD's tt info */
  365. __hc32 address;
  366. };
  367. /*-------------------------------------------------------------------------*/
  368. /*
  369. * EHCI Specification 0.95 Section 3.3
  370. * Fig 3-4 "Isochronous Transaction Descriptor (iTD)"
  371. *
  372. * Schedule records for high speed iso xfers
  373. */
  374. struct ehci_itd {
  375. /* first part defined by EHCI spec */
  376. __hc32 hw_next; /* see EHCI 3.3.1 */
  377. __hc32 hw_transaction [8]; /* see EHCI 3.3.2 */
  378. #define EHCI_ISOC_ACTIVE (1<<31) /* activate transfer this slot */
  379. #define EHCI_ISOC_BUF_ERR (1<<30) /* Data buffer error */
  380. #define EHCI_ISOC_BABBLE (1<<29) /* babble detected */
  381. #define EHCI_ISOC_XACTERR (1<<28) /* XactErr - transaction error */
  382. #define EHCI_ITD_LENGTH(tok) (((tok)>>16) & 0x0fff)
  383. #define EHCI_ITD_IOC (1 << 15) /* interrupt on complete */
  384. #define ITD_ACTIVE(ehci) cpu_to_hc32(ehci, EHCI_ISOC_ACTIVE)
  385. __hc32 hw_bufp [7]; /* see EHCI 3.3.3 */
  386. __hc32 hw_bufp_hi [7]; /* Appendix B */
  387. /* the rest is HCD-private */
  388. dma_addr_t itd_dma; /* for this itd */
  389. union ehci_shadow itd_next; /* ptr to periodic q entry */
  390. struct urb *urb;
  391. struct ehci_iso_stream *stream; /* endpoint's queue */
  392. struct list_head itd_list; /* list of stream's itds */
  393. /* any/all hw_transactions here may be used by that urb */
  394. unsigned frame; /* where scheduled */
  395. unsigned pg;
  396. unsigned index[8]; /* in urb->iso_frame_desc */
  397. } __attribute__ ((aligned (32)));
  398. /*-------------------------------------------------------------------------*/
  399. /*
  400. * EHCI Specification 0.95 Section 3.4
  401. * siTD, aka split-transaction isochronous Transfer Descriptor
  402. * ... describe full speed iso xfers through TT in hubs
  403. * see Figure 3-5 "Split-transaction Isochronous Transaction Descriptor (siTD)
  404. */
  405. struct ehci_sitd {
  406. /* first part defined by EHCI spec */
  407. __hc32 hw_next;
  408. /* uses bit field macros above - see EHCI 0.95 Table 3-8 */
  409. __hc32 hw_fullspeed_ep; /* EHCI table 3-9 */
  410. __hc32 hw_uframe; /* EHCI table 3-10 */
  411. __hc32 hw_results; /* EHCI table 3-11 */
  412. #define SITD_IOC (1 << 31) /* interrupt on completion */
  413. #define SITD_PAGE (1 << 30) /* buffer 0/1 */
  414. #define SITD_LENGTH(x) (0x3ff & ((x)>>16))
  415. #define SITD_STS_ACTIVE (1 << 7) /* HC may execute this */
  416. #define SITD_STS_ERR (1 << 6) /* error from TT */
  417. #define SITD_STS_DBE (1 << 5) /* data buffer error (in HC) */
  418. #define SITD_STS_BABBLE (1 << 4) /* device was babbling */
  419. #define SITD_STS_XACT (1 << 3) /* illegal IN response */
  420. #define SITD_STS_MMF (1 << 2) /* incomplete split transaction */
  421. #define SITD_STS_STS (1 << 1) /* split transaction state */
  422. #define SITD_ACTIVE(ehci) cpu_to_hc32(ehci, SITD_STS_ACTIVE)
  423. __hc32 hw_buf [2]; /* EHCI table 3-12 */
  424. __hc32 hw_backpointer; /* EHCI table 3-13 */
  425. __hc32 hw_buf_hi [2]; /* Appendix B */
  426. /* the rest is HCD-private */
  427. dma_addr_t sitd_dma;
  428. union ehci_shadow sitd_next; /* ptr to periodic q entry */
  429. struct urb *urb;
  430. struct ehci_iso_stream *stream; /* endpoint's queue */
  431. struct list_head sitd_list; /* list of stream's sitds */
  432. unsigned frame;
  433. unsigned index;
  434. } __attribute__ ((aligned (32)));
  435. /*-------------------------------------------------------------------------*/
  436. /*
  437. * EHCI Specification 0.96 Section 3.7
  438. * Periodic Frame Span Traversal Node (FSTN)
  439. *
  440. * Manages split interrupt transactions (using TT) that span frame boundaries
  441. * into uframes 0/1; see 4.12.2.2. In those uframes, a "save place" FSTN
  442. * makes the HC jump (back) to a QH to scan for fs/ls QH completions until
  443. * it hits a "restore" FSTN; then it returns to finish other uframe 0/1 work.
  444. */
  445. struct ehci_fstn {
  446. __hc32 hw_next; /* any periodic q entry */
  447. __hc32 hw_prev; /* qh or EHCI_LIST_END */
  448. /* the rest is HCD-private */
  449. dma_addr_t fstn_dma;
  450. union ehci_shadow fstn_next; /* ptr to periodic q entry */
  451. } __attribute__ ((aligned (32)));
  452. /*-------------------------------------------------------------------------*/
  453. #ifdef CONFIG_USB_EHCI_ROOT_HUB_TT
  454. /*
  455. * Some EHCI controllers have a Transaction Translator built into the
  456. * root hub. This is a non-standard feature. Each controller will need
  457. * to add code to the following inline functions, and call them as
  458. * needed (mostly in root hub code).
  459. */
  460. #define ehci_is_TDI(e) (ehci_to_hcd(e)->has_tt)
  461. /* Returns the speed of a device attached to a port on the root hub. */
  462. static inline unsigned int
  463. ehci_port_speed(struct ehci_hcd *ehci, unsigned int portsc)
  464. {
  465. if (ehci_is_TDI(ehci)) {
  466. switch ((portsc >> (ehci->has_hostpc ? 25 : 26)) & 3) {
  467. case 0:
  468. return 0;
  469. case 1:
  470. return (1<<USB_PORT_FEAT_LOWSPEED);
  471. case 2:
  472. default:
  473. return (1<<USB_PORT_FEAT_HIGHSPEED);
  474. }
  475. }
  476. return (1<<USB_PORT_FEAT_HIGHSPEED);
  477. }
  478. #else
  479. #define ehci_is_TDI(e) (0)
  480. #define ehci_port_speed(ehci, portsc) (1<<USB_PORT_FEAT_HIGHSPEED)
  481. #endif
  482. /*-------------------------------------------------------------------------*/
  483. #ifdef CONFIG_PPC_83xx
  484. /* Some Freescale processors have an erratum in which the TT
  485. * port number in the queue head was 0..N-1 instead of 1..N.
  486. */
  487. #define ehci_has_fsl_portno_bug(e) ((e)->has_fsl_port_bug)
  488. #else
  489. #define ehci_has_fsl_portno_bug(e) (0)
  490. #endif
  491. /*
  492. * While most USB host controllers implement their registers in
  493. * little-endian format, a minority (celleb companion chip) implement
  494. * them in big endian format.
  495. *
  496. * This attempts to support either format at compile time without a
  497. * runtime penalty, or both formats with the additional overhead
  498. * of checking a flag bit.
  499. */
  500. #ifdef CONFIG_USB_EHCI_BIG_ENDIAN_MMIO
  501. #define ehci_big_endian_mmio(e) ((e)->big_endian_mmio)
  502. #else
  503. #define ehci_big_endian_mmio(e) 0
  504. #endif
  505. /*
  506. * Big-endian read/write functions are arch-specific.
  507. * Other arches can be added if/when they're needed.
  508. */
  509. #if defined(CONFIG_ARM) && defined(CONFIG_ARCH_IXP4XX)
  510. #define readl_be(addr) __raw_readl((__force unsigned *)addr)
  511. #define writel_be(val, addr) __raw_writel(val, (__force unsigned *)addr)
  512. #endif
  513. static inline unsigned int ehci_readl(const struct ehci_hcd *ehci,
  514. __u32 __iomem * regs)
  515. {
  516. #ifdef CONFIG_USB_EHCI_BIG_ENDIAN_MMIO
  517. return ehci_big_endian_mmio(ehci) ?
  518. readl_be(regs) :
  519. readl(regs);
  520. #else
  521. return readl(regs);
  522. #endif
  523. }
  524. static inline void ehci_writel(const struct ehci_hcd *ehci,
  525. const unsigned int val, __u32 __iomem *regs)
  526. {
  527. #ifdef CONFIG_USB_EHCI_BIG_ENDIAN_MMIO
  528. ehci_big_endian_mmio(ehci) ?
  529. writel_be(val, regs) :
  530. writel(val, regs);
  531. #else
  532. writel(val, regs);
  533. #endif
  534. }
  535. /*
  536. * On certain ppc-44x SoC there is a HW issue, that could only worked around with
  537. * explicit suspend/operate of OHCI. This function hereby makes sense only on that arch.
  538. * Other common bits are dependant on has_amcc_usb23 quirk flag.
  539. */
  540. #ifdef CONFIG_44x
  541. static inline void set_ohci_hcfs(struct ehci_hcd *ehci, int operational)
  542. {
  543. u32 hc_control;
  544. hc_control = (readl_be(ehci->ohci_hcctrl_reg) & ~OHCI_CTRL_HCFS);
  545. if (operational)
  546. hc_control |= OHCI_USB_OPER;
  547. else
  548. hc_control |= OHCI_USB_SUSPEND;
  549. writel_be(hc_control, ehci->ohci_hcctrl_reg);
  550. (void) readl_be(ehci->ohci_hcctrl_reg);
  551. }
  552. #else
  553. static inline void set_ohci_hcfs(struct ehci_hcd *ehci, int operational)
  554. { }
  555. #endif
  556. /*-------------------------------------------------------------------------*/
  557. /*
  558. * The AMCC 440EPx not only implements its EHCI registers in big-endian
  559. * format, but also its DMA data structures (descriptors).
  560. *
  561. * EHCI controllers accessed through PCI work normally (little-endian
  562. * everywhere), so we won't bother supporting a BE-only mode for now.
  563. */
  564. #ifdef CONFIG_USB_EHCI_BIG_ENDIAN_DESC
  565. #define ehci_big_endian_desc(e) ((e)->big_endian_desc)
  566. /* cpu to ehci */
  567. static inline __hc32 cpu_to_hc32 (const struct ehci_hcd *ehci, const u32 x)
  568. {
  569. return ehci_big_endian_desc(ehci)
  570. ? (__force __hc32)cpu_to_be32(x)
  571. : (__force __hc32)cpu_to_le32(x);
  572. }
  573. /* ehci to cpu */
  574. static inline u32 hc32_to_cpu (const struct ehci_hcd *ehci, const __hc32 x)
  575. {
  576. return ehci_big_endian_desc(ehci)
  577. ? be32_to_cpu((__force __be32)x)
  578. : le32_to_cpu((__force __le32)x);
  579. }
  580. static inline u32 hc32_to_cpup (const struct ehci_hcd *ehci, const __hc32 *x)
  581. {
  582. return ehci_big_endian_desc(ehci)
  583. ? be32_to_cpup((__force __be32 *)x)
  584. : le32_to_cpup((__force __le32 *)x);
  585. }
  586. #else
  587. /* cpu to ehci */
  588. static inline __hc32 cpu_to_hc32 (const struct ehci_hcd *ehci, const u32 x)
  589. {
  590. return cpu_to_le32(x);
  591. }
  592. /* ehci to cpu */
  593. static inline u32 hc32_to_cpu (const struct ehci_hcd *ehci, const __hc32 x)
  594. {
  595. return le32_to_cpu(x);
  596. }
  597. static inline u32 hc32_to_cpup (const struct ehci_hcd *ehci, const __hc32 *x)
  598. {
  599. return le32_to_cpup(x);
  600. }
  601. #endif
  602. /*-------------------------------------------------------------------------*/
  603. #ifndef DEBUG
  604. #define STUB_DEBUG_FILES
  605. #endif /* DEBUG */
  606. /*-------------------------------------------------------------------------*/
  607. #endif /* __LINUX_EHCI_HCD_H */