ehci.h 21 KB

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