Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * Copyright (c) 2001-2002 by David Brownell | |
53bd6a60 | 3 | * |
1da177e4 LT |
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 | ||
19 | #ifndef __LINUX_EHCI_HCD_H | |
20 | #define __LINUX_EHCI_HCD_H | |
21 | ||
22 | /* definitions used for the EHCI driver */ | |
23 | ||
6dbd682b SR |
24 | /* |
25 | * __hc32 and __hc16 are "Host Controller" types, they may be equivalent to | |
26 | * __leXX (normally) or __beXX (given EHCI_BIG_ENDIAN_DESC), depending on | |
27 | * the host controller implementation. | |
28 | * | |
29 | * To facilitate the strongest possible byte-order checking from "sparse" | |
30 | * and so on, we use __leXX unless that's not practical. | |
31 | */ | |
32 | #ifdef CONFIG_USB_EHCI_BIG_ENDIAN_DESC | |
33 | typedef __u32 __bitwise __hc32; | |
34 | typedef __u16 __bitwise __hc16; | |
35 | #else | |
36 | #define __hc32 __le32 | |
37 | #define __hc16 __le16 | |
38 | #endif | |
39 | ||
411c9403 | 40 | /* statistics can be kept for tuning/monitoring */ |
9ec6e9d3 RQ |
41 | #ifdef DEBUG |
42 | #define EHCI_STATS | |
43 | #endif | |
44 | ||
1da177e4 LT |
45 | struct ehci_stats { |
46 | /* irq usage */ | |
47 | unsigned long normal; | |
48 | unsigned long error; | |
99ac5b1e | 49 | unsigned long iaa; |
1da177e4 LT |
50 | unsigned long lost_iaa; |
51 | ||
52 | /* termination of urbs from core */ | |
53 | unsigned long complete; | |
54 | unsigned long unlink; | |
55 | }; | |
56 | ||
57 | /* ehci_hcd->lock guards shared data against other CPUs: | |
99ac5b1e | 58 | * ehci_hcd: async, unlink, periodic (and shadow), ... |
1da177e4 LT |
59 | * usb_host_endpoint: hcpriv |
60 | * ehci_qh: qh_next, qtd_list | |
61 | * ehci_qtd: qtd_list | |
62 | * | |
63 | * Also, hold this lock when talking to HC registers or | |
64 | * when updating hw_* fields in shared qh/qtd/... structures. | |
65 | */ | |
66 | ||
67 | #define EHCI_MAX_ROOT_PORTS 15 /* see HCS_N_PORTS */ | |
68 | ||
c0c53dbc AS |
69 | /* |
70 | * ehci_rh_state values of EHCI_RH_RUNNING or above mean that the | |
71 | * controller may be doing DMA. Lower values mean there's no DMA. | |
72 | */ | |
e8799906 AS |
73 | enum ehci_rh_state { |
74 | EHCI_RH_HALTED, | |
75 | EHCI_RH_SUSPENDED, | |
c0c53dbc AS |
76 | EHCI_RH_RUNNING, |
77 | EHCI_RH_STOPPING | |
e8799906 AS |
78 | }; |
79 | ||
d58b4bcc AS |
80 | /* |
81 | * Timer events, ordered by increasing delay length. | |
82 | * Always update event_delays_ns[] and event_handlers[] (defined in | |
83 | * ehci-timer.c) in parallel with this list. | |
84 | */ | |
85 | enum ehci_hrtimer_event { | |
31446610 | 86 | EHCI_HRTIMER_POLL_ASS, /* Poll for async schedule off */ |
3ca9aeba | 87 | EHCI_HRTIMER_POLL_PSS, /* Poll for periodic schedule off */ |
bf6387bc | 88 | EHCI_HRTIMER_POLL_DEAD, /* Wait for dead controller to stop */ |
df202255 | 89 | EHCI_HRTIMER_UNLINK_INTR, /* Wait for interrupt QH unlink */ |
55934eb3 | 90 | EHCI_HRTIMER_FREE_ITDS, /* Wait for unused iTDs and siTDs */ |
32830f20 | 91 | EHCI_HRTIMER_ASYNC_UNLINKS, /* Unlink empty async QHs */ |
9d938747 | 92 | EHCI_HRTIMER_IAA_WATCHDOG, /* Handle lost IAA interrupts */ |
3ca9aeba | 93 | EHCI_HRTIMER_DISABLE_PERIODIC, /* Wait to disable periodic sched */ |
31446610 | 94 | EHCI_HRTIMER_DISABLE_ASYNC, /* Wait to disable async sched */ |
18aafe64 | 95 | EHCI_HRTIMER_IO_WATCHDOG, /* Check for missing IRQs */ |
d58b4bcc AS |
96 | EHCI_HRTIMER_NUM_EVENTS /* Must come last */ |
97 | }; | |
98 | #define EHCI_HRTIMER_NO_EVENT 99 | |
99 | ||
1da177e4 | 100 | struct ehci_hcd { /* one per controller */ |
d58b4bcc AS |
101 | /* timing support */ |
102 | enum ehci_hrtimer_event next_hrtimer_event; | |
103 | unsigned enabled_hrtimer_events; | |
104 | ktime_t hr_timeouts[EHCI_HRTIMER_NUM_EVENTS]; | |
105 | struct hrtimer hrtimer; | |
106 | ||
3ca9aeba | 107 | int PSS_poll_count; |
31446610 | 108 | int ASS_poll_count; |
bf6387bc | 109 | int died_poll_count; |
3ca9aeba | 110 | |
56c1e26d DB |
111 | /* glue to PCI and HCD framework */ |
112 | struct ehci_caps __iomem *caps; | |
113 | struct ehci_regs __iomem *regs; | |
114 | struct ehci_dbg_port __iomem *debug; | |
115 | ||
116 | __u32 hcs_params; /* cached register copy */ | |
1da177e4 | 117 | spinlock_t lock; |
e8799906 | 118 | enum ehci_rh_state rh_state; |
1da177e4 | 119 | |
df202255 | 120 | /* general schedule support */ |
361aabf3 AS |
121 | bool scanning:1; |
122 | bool need_rescan:1; | |
df202255 | 123 | bool intr_unlinking:1; |
214ac7a0 | 124 | bool iaa_in_progress:1; |
3c273a05 | 125 | bool async_unlinking:1; |
43fe3a99 | 126 | bool shutdown:1; |
569b394f | 127 | struct ehci_qh *qh_scan_next; |
df202255 | 128 | |
1da177e4 LT |
129 | /* async schedule support */ |
130 | struct ehci_qh *async; | |
3d091a6f | 131 | struct ehci_qh *dummy; /* For AMD quirk use */ |
6e018751 | 132 | struct list_head async_unlink; |
214ac7a0 | 133 | struct list_head async_idle; |
32830f20 | 134 | unsigned async_unlink_cycle; |
31446610 | 135 | unsigned async_count; /* async activity count */ |
1da177e4 LT |
136 | |
137 | /* periodic schedule support */ | |
138 | #define DEFAULT_I_TDPS 1024 /* some HCs can do less */ | |
139 | unsigned periodic_size; | |
6dbd682b | 140 | __hc32 *periodic; /* hw periodic table */ |
1da177e4 | 141 | dma_addr_t periodic_dma; |
569b394f | 142 | struct list_head intr_qh_list; |
1da177e4 LT |
143 | unsigned i_thresh; /* uframes HC might cache */ |
144 | ||
145 | union ehci_shadow *pshadow; /* mirror hw periodic table */ | |
6e018751 | 146 | struct list_head intr_unlink; |
df202255 | 147 | unsigned intr_unlink_cycle; |
f4289078 | 148 | unsigned now_frame; /* frame from HC hardware */ |
c3ee9b76 | 149 | unsigned last_iso_frame; /* last frame scanned for iso */ |
569b394f AS |
150 | unsigned intr_count; /* intr activity count */ |
151 | unsigned isoc_count; /* isoc activity count */ | |
3ca9aeba | 152 | unsigned periodic_count; /* periodic activity count */ |
cc62a7eb KS |
153 | unsigned uframe_periodic_max; /* max periodic time per uframe */ |
154 | ||
1da177e4 | 155 | |
f4289078 | 156 | /* list of itds & sitds completed while now_frame was still active */ |
9aa09d2f | 157 | struct list_head cached_itd_list; |
55934eb3 | 158 | struct ehci_itd *last_itd_to_free; |
0e5f231b | 159 | struct list_head cached_sitd_list; |
55934eb3 | 160 | struct ehci_sitd *last_sitd_to_free; |
9aa09d2f | 161 | |
1da177e4 LT |
162 | /* per root hub port */ |
163 | unsigned long reset_done [EHCI_MAX_ROOT_PORTS]; | |
383975d7 | 164 | |
57e06c11 AS |
165 | /* bit vectors (one bit per port) */ |
166 | unsigned long bus_suspended; /* which ports were | |
167 | already suspended at the start of a bus suspend */ | |
168 | unsigned long companion_ports; /* which ports are | |
169 | dedicated to the companion controller */ | |
383975d7 AS |
170 | unsigned long owned_ports; /* which ports are |
171 | owned by the companion during a bus suspend */ | |
d1f114d1 AS |
172 | unsigned long port_c_suspend; /* which ports have |
173 | the change-suspend feature turned on */ | |
eafe5b99 AS |
174 | unsigned long suspended_ports; /* which ports are |
175 | suspended */ | |
a448e4dc AS |
176 | unsigned long resuming_ports; /* which ports have |
177 | started to resume */ | |
1da177e4 LT |
178 | |
179 | /* per-HC memory pools (could be per-bus, but ...) */ | |
180 | struct dma_pool *qh_pool; /* qh per active urb */ | |
181 | struct dma_pool *qtd_pool; /* one or more per qh */ | |
182 | struct dma_pool *itd_pool; /* itd per iso urb */ | |
183 | struct dma_pool *sitd_pool; /* sitd per split iso urb */ | |
184 | ||
68335e81 | 185 | unsigned random_frame; |
1da177e4 | 186 | unsigned long next_statechange; |
ee4ecb8a | 187 | ktime_t last_periodic_enable; |
1da177e4 LT |
188 | u32 command; |
189 | ||
8cd42e97 | 190 | /* SILICON QUIRKS */ |
f8aeb3bb | 191 | unsigned no_selective_suspend:1; |
8cd42e97 | 192 | unsigned has_fsl_port_bug:1; /* FreeScale */ |
083522d7 | 193 | unsigned big_endian_mmio:1; |
6dbd682b | 194 | unsigned big_endian_desc:1; |
c430131a | 195 | unsigned big_endian_capbase:1; |
796bcae7 | 196 | unsigned has_amcc_usb23:1; |
403dbd36 | 197 | unsigned need_io_watchdog:1; |
ad93562b | 198 | unsigned amd_pll_fix:1; |
3d091a6f | 199 | unsigned use_dummy_qh:1; /* AMD Frame List table quirk*/ |
2f7ac6c1 | 200 | unsigned has_synopsys_hc_bug:1; /* Synopsys HC */ |
68aa95d5 | 201 | unsigned frame_index_bug:1; /* MosChip (AKA NetMos) */ |
e6604a7f | 202 | unsigned need_oc_pp_cycle:1; /* MPC834X port power */ |
0660fe75 | 203 | unsigned imx28_write_fix:1; /* For Freescale i.MX28 */ |
796bcae7 VB |
204 | |
205 | /* required for usb32 quirk */ | |
206 | #define OHCI_CTRL_HCFS (3 << 6) | |
207 | #define OHCI_USB_OPER (2 << 6) | |
208 | #define OHCI_USB_SUSPEND (3 << 6) | |
209 | ||
210 | #define OHCI_HCCTRL_OFFSET 0x4 | |
211 | #define OHCI_HCCTRL_LEN 0x4 | |
212 | __hc32 *ohci_hcctrl_reg; | |
331ac6b2 | 213 | unsigned has_hostpc:1; |
5a9cdf33 | 214 | unsigned has_ppcd:1; /* support per-port change bits */ |
f8aeb3bb | 215 | u8 sbrn; /* packed release number */ |
1da177e4 | 216 | |
1da177e4 LT |
217 | /* irq statistics */ |
218 | #ifdef EHCI_STATS | |
219 | struct ehci_stats stats; | |
220 | # define COUNT(x) do { (x)++; } while (0) | |
221 | #else | |
222 | # define COUNT(x) do {} while (0) | |
694cc208 TJ |
223 | #endif |
224 | ||
225 | /* debug files */ | |
226 | #ifdef DEBUG | |
227 | struct dentry *debug_dir; | |
1da177e4 | 228 | #endif |
9debc179 AS |
229 | |
230 | /* platform-specific data -- must come last */ | |
231 | unsigned long priv[0] __aligned(sizeof(s64)); | |
1da177e4 LT |
232 | }; |
233 | ||
53bd6a60 | 234 | /* convert between an HCD pointer and the corresponding EHCI_HCD */ |
1da177e4 LT |
235 | static inline struct ehci_hcd *hcd_to_ehci (struct usb_hcd *hcd) |
236 | { | |
237 | return (struct ehci_hcd *) (hcd->hcd_priv); | |
238 | } | |
239 | static inline struct usb_hcd *ehci_to_hcd (struct ehci_hcd *ehci) | |
240 | { | |
241 | return container_of ((void *) ehci, struct usb_hcd, hcd_priv); | |
242 | } | |
243 | ||
1da177e4 LT |
244 | /*-------------------------------------------------------------------------*/ |
245 | ||
0af36739 | 246 | #include <linux/usb/ehci_def.h> |
1da177e4 LT |
247 | |
248 | /*-------------------------------------------------------------------------*/ | |
249 | ||
6dbd682b | 250 | #define QTD_NEXT(ehci, dma) cpu_to_hc32(ehci, (u32)dma) |
1da177e4 LT |
251 | |
252 | /* | |
253 | * EHCI Specification 0.95 Section 3.5 | |
53bd6a60 | 254 | * QTD: describe data transfer components (buffer, direction, ...) |
1da177e4 LT |
255 | * See Fig 3-6 "Queue Element Transfer Descriptor Block Diagram". |
256 | * | |
257 | * These are associated only with "QH" (Queue Head) structures, | |
258 | * used with control, bulk, and interrupt transfers. | |
259 | */ | |
260 | struct ehci_qtd { | |
261 | /* first part defined by EHCI spec */ | |
6dbd682b SR |
262 | __hc32 hw_next; /* see EHCI 3.5.1 */ |
263 | __hc32 hw_alt_next; /* see EHCI 3.5.2 */ | |
264 | __hc32 hw_token; /* see EHCI 3.5.3 */ | |
1da177e4 LT |
265 | #define QTD_TOGGLE (1 << 31) /* data toggle */ |
266 | #define QTD_LENGTH(tok) (((tok)>>16) & 0x7fff) | |
267 | #define QTD_IOC (1 << 15) /* interrupt on complete */ | |
268 | #define QTD_CERR(tok) (((tok)>>10) & 0x3) | |
269 | #define QTD_PID(tok) (((tok)>>8) & 0x3) | |
270 | #define QTD_STS_ACTIVE (1 << 7) /* HC may execute this */ | |
271 | #define QTD_STS_HALT (1 << 6) /* halted on error */ | |
272 | #define QTD_STS_DBE (1 << 5) /* data buffer error (in HC) */ | |
273 | #define QTD_STS_BABBLE (1 << 4) /* device was babbling (qtd halted) */ | |
274 | #define QTD_STS_XACT (1 << 3) /* device gave illegal response */ | |
275 | #define QTD_STS_MMF (1 << 2) /* incomplete split transaction */ | |
276 | #define QTD_STS_STS (1 << 1) /* split transaction state */ | |
277 | #define QTD_STS_PING (1 << 0) /* issue PING? */ | |
6dbd682b SR |
278 | |
279 | #define ACTIVE_BIT(ehci) cpu_to_hc32(ehci, QTD_STS_ACTIVE) | |
280 | #define HALT_BIT(ehci) cpu_to_hc32(ehci, QTD_STS_HALT) | |
281 | #define STATUS_BIT(ehci) cpu_to_hc32(ehci, QTD_STS_STS) | |
282 | ||
283 | __hc32 hw_buf [5]; /* see EHCI 3.5.4 */ | |
284 | __hc32 hw_buf_hi [5]; /* Appendix B */ | |
1da177e4 LT |
285 | |
286 | /* the rest is HCD-private */ | |
287 | dma_addr_t qtd_dma; /* qtd address */ | |
288 | struct list_head qtd_list; /* sw qtd list */ | |
289 | struct urb *urb; /* qtd's urb */ | |
290 | size_t length; /* length of buffer */ | |
291 | } __attribute__ ((aligned (32))); | |
292 | ||
293 | /* mask NakCnt+T in qh->hw_alt_next */ | |
6dbd682b | 294 | #define QTD_MASK(ehci) cpu_to_hc32 (ehci, ~0x1f) |
1da177e4 LT |
295 | |
296 | #define IS_SHORT_READ(token) (QTD_LENGTH (token) != 0 && QTD_PID (token) == 1) | |
297 | ||
298 | /*-------------------------------------------------------------------------*/ | |
299 | ||
300 | /* type tag from {qh,itd,sitd,fstn}->hw_next */ | |
6dbd682b | 301 | #define Q_NEXT_TYPE(ehci,dma) ((dma) & cpu_to_hc32(ehci, 3 << 1)) |
1da177e4 | 302 | |
6dbd682b SR |
303 | /* |
304 | * Now the following defines are not converted using the | |
551509d2 | 305 | * cpu_to_le32() macro anymore, since we have to support |
6dbd682b SR |
306 | * "dynamic" switching between be and le support, so that the driver |
307 | * can be used on one system with SoC EHCI controller using big-endian | |
308 | * descriptors as well as a normal little-endian PCI EHCI controller. | |
309 | */ | |
1da177e4 | 310 | /* values for that type tag */ |
6dbd682b SR |
311 | #define Q_TYPE_ITD (0 << 1) |
312 | #define Q_TYPE_QH (1 << 1) | |
313 | #define Q_TYPE_SITD (2 << 1) | |
314 | #define Q_TYPE_FSTN (3 << 1) | |
1da177e4 LT |
315 | |
316 | /* next async queue entry, or pointer to interrupt/periodic QH */ | |
6dbd682b | 317 | #define QH_NEXT(ehci,dma) (cpu_to_hc32(ehci, (((u32)dma)&~0x01f)|Q_TYPE_QH)) |
1da177e4 LT |
318 | |
319 | /* for periodic/async schedules and qtd lists, mark end of list */ | |
6dbd682b | 320 | #define EHCI_LIST_END(ehci) cpu_to_hc32(ehci, 1) /* "null pointer" to hw */ |
1da177e4 LT |
321 | |
322 | /* | |
323 | * Entries in periodic shadow table are pointers to one of four kinds | |
324 | * of data structure. That's dictated by the hardware; a type tag is | |
325 | * encoded in the low bits of the hardware's periodic schedule. Use | |
326 | * Q_NEXT_TYPE to get the tag. | |
327 | * | |
328 | * For entries in the async schedule, the type tag always says "qh". | |
329 | */ | |
330 | union ehci_shadow { | |
53bd6a60 | 331 | struct ehci_qh *qh; /* Q_TYPE_QH */ |
1da177e4 LT |
332 | struct ehci_itd *itd; /* Q_TYPE_ITD */ |
333 | struct ehci_sitd *sitd; /* Q_TYPE_SITD */ | |
334 | struct ehci_fstn *fstn; /* Q_TYPE_FSTN */ | |
6dbd682b | 335 | __hc32 *hw_next; /* (all types) */ |
1da177e4 LT |
336 | void *ptr; |
337 | }; | |
338 | ||
339 | /*-------------------------------------------------------------------------*/ | |
340 | ||
341 | /* | |
342 | * EHCI Specification 0.95 Section 3.6 | |
343 | * QH: describes control/bulk/interrupt endpoints | |
344 | * See Fig 3-7 "Queue Head Structure Layout". | |
345 | * | |
346 | * These appear in both the async and (for interrupt) periodic schedules. | |
347 | */ | |
348 | ||
3807e26d AD |
349 | /* first part defined by EHCI spec */ |
350 | struct ehci_qh_hw { | |
6dbd682b SR |
351 | __hc32 hw_next; /* see EHCI 3.6.1 */ |
352 | __hc32 hw_info1; /* see EHCI 3.6.2 */ | |
4c53de72 AS |
353 | #define QH_CONTROL_EP (1 << 27) /* FS/LS control endpoint */ |
354 | #define QH_HEAD (1 << 15) /* Head of async reclamation list */ | |
355 | #define QH_TOGGLE_CTL (1 << 14) /* Data toggle control */ | |
356 | #define QH_HIGH_SPEED (2 << 12) /* Endpoint speed */ | |
357 | #define QH_LOW_SPEED (1 << 12) | |
358 | #define QH_FULL_SPEED (0 << 12) | |
359 | #define QH_INACTIVATE (1 << 7) /* Inactivate on next transaction */ | |
6dbd682b | 360 | __hc32 hw_info2; /* see EHCI 3.6.2 */ |
7dedacf4 DB |
361 | #define QH_SMASK 0x000000ff |
362 | #define QH_CMASK 0x0000ff00 | |
363 | #define QH_HUBADDR 0x007f0000 | |
364 | #define QH_HUBPORT 0x3f800000 | |
365 | #define QH_MULT 0xc0000000 | |
6dbd682b | 366 | __hc32 hw_current; /* qtd list - see EHCI 3.6.4 */ |
53bd6a60 | 367 | |
1da177e4 | 368 | /* qtd overlay (hardware parts of a struct ehci_qtd) */ |
6dbd682b SR |
369 | __hc32 hw_qtd_next; |
370 | __hc32 hw_alt_next; | |
371 | __hc32 hw_token; | |
372 | __hc32 hw_buf [5]; | |
373 | __hc32 hw_buf_hi [5]; | |
3807e26d | 374 | } __attribute__ ((aligned(32))); |
1da177e4 | 375 | |
3807e26d | 376 | struct ehci_qh { |
8c5bf7be | 377 | struct ehci_qh_hw *hw; /* Must come first */ |
1da177e4 LT |
378 | /* the rest is HCD-private */ |
379 | dma_addr_t qh_dma; /* address of qh */ | |
380 | union ehci_shadow qh_next; /* ptr to qh; or periodic */ | |
381 | struct list_head qtd_list; /* sw qtd list */ | |
569b394f | 382 | struct list_head intr_node; /* list of intr QHs */ |
1da177e4 | 383 | struct ehci_qtd *dummy; |
6e018751 | 384 | struct list_head unlink_node; |
1da177e4 | 385 | |
df202255 | 386 | unsigned unlink_cycle; |
1da177e4 LT |
387 | |
388 | u8 qh_state; | |
389 | #define QH_STATE_LINKED 1 /* HC sees this */ | |
390 | #define QH_STATE_UNLINK 2 /* HC may still see this */ | |
391 | #define QH_STATE_IDLE 3 /* HC doesn't see this */ | |
99ac5b1e | 392 | #define QH_STATE_UNLINK_WAIT 4 /* LINKED and on unlink q */ |
1da177e4 LT |
393 | #define QH_STATE_COMPLETING 5 /* don't touch token.HALT */ |
394 | ||
a2c2706e AS |
395 | u8 xacterrs; /* XactErr retry counter */ |
396 | #define QH_XACTERR_MAX 32 /* XactErr retry limit */ | |
397 | ||
1da177e4 LT |
398 | /* periodic schedule info */ |
399 | u8 usecs; /* intr bandwidth */ | |
400 | u8 gap_uf; /* uframes split/csplit gap */ | |
401 | u8 c_usecs; /* ... split completion bw */ | |
d0384200 | 402 | u16 tt_usecs; /* tt downstream bandwidth */ |
1da177e4 LT |
403 | unsigned short period; /* polling interval */ |
404 | unsigned short start; /* where polling starts */ | |
405 | #define NO_FRAME ((unsigned short)~0) /* pick new start */ | |
914b7012 | 406 | |
1da177e4 | 407 | struct usb_device *dev; /* access to TT */ |
e04f5f7e | 408 | unsigned is_out:1; /* bulk or intr OUT */ |
914b7012 | 409 | unsigned clearing_tt:1; /* Clear-TT-Buf in progress */ |
7bc782d7 AS |
410 | unsigned dequeue_during_giveback:1; |
411 | unsigned exception:1; /* got a fault, or an unlink | |
412 | was requested */ | |
3807e26d | 413 | }; |
1da177e4 LT |
414 | |
415 | /*-------------------------------------------------------------------------*/ | |
416 | ||
417 | /* description of one iso transaction (up to 3 KB data if highspeed) */ | |
418 | struct ehci_iso_packet { | |
419 | /* These will be copied to iTD when scheduling */ | |
420 | u64 bufp; /* itd->hw_bufp{,_hi}[pg] |= */ | |
6dbd682b | 421 | __hc32 transaction; /* itd->hw_transaction[i] |= */ |
1da177e4 LT |
422 | u8 cross; /* buf crosses pages */ |
423 | /* for full speed OUT splits */ | |
424 | u32 buf1; | |
425 | }; | |
426 | ||
427 | /* temporary schedule data for packets from iso urbs (both speeds) | |
428 | * each packet is one logical usb transaction to the device (not TT), | |
429 | * beginning at stream->next_uframe | |
430 | */ | |
431 | struct ehci_iso_sched { | |
432 | struct list_head td_list; | |
433 | unsigned span; | |
434 | struct ehci_iso_packet packet [0]; | |
435 | }; | |
436 | ||
437 | /* | |
438 | * ehci_iso_stream - groups all (s)itds for this endpoint. | |
439 | * acts like a qh would, if EHCI had them for ISO. | |
440 | */ | |
441 | struct ehci_iso_stream { | |
1082f57a CL |
442 | /* first field matches ehci_hq, but is NULL */ |
443 | struct ehci_qh_hw *hw; | |
1da177e4 | 444 | |
1da177e4 LT |
445 | u8 bEndpointAddress; |
446 | u8 highspeed; | |
1da177e4 LT |
447 | struct list_head td_list; /* queued itds/sitds */ |
448 | struct list_head free_list; /* list of unused itds/sitds */ | |
449 | struct usb_device *udev; | |
53bd6a60 | 450 | struct usb_host_endpoint *ep; |
1da177e4 LT |
451 | |
452 | /* output of (re)scheduling */ | |
1da177e4 | 453 | int next_uframe; |
6dbd682b | 454 | __hc32 splits; |
1da177e4 LT |
455 | |
456 | /* the rest is derived from the endpoint descriptor, | |
457 | * trusting urb->interval == f(epdesc->bInterval) and | |
458 | * including the extra info for hw_bufp[0..2] | |
459 | */ | |
1da177e4 | 460 | u8 usecs, c_usecs; |
c06d4dcf | 461 | u16 interval; |
d0384200 | 462 | u16 tt_usecs; |
1da177e4 LT |
463 | u16 maxp; |
464 | u16 raw_mask; | |
465 | unsigned bandwidth; | |
466 | ||
467 | /* This is used to initialize iTD's hw_bufp fields */ | |
6dbd682b SR |
468 | __hc32 buf0; |
469 | __hc32 buf1; | |
470 | __hc32 buf2; | |
1da177e4 LT |
471 | |
472 | /* this is used to initialize sITD's tt info */ | |
6dbd682b | 473 | __hc32 address; |
1da177e4 LT |
474 | }; |
475 | ||
476 | /*-------------------------------------------------------------------------*/ | |
477 | ||
478 | /* | |
479 | * EHCI Specification 0.95 Section 3.3 | |
480 | * Fig 3-4 "Isochronous Transaction Descriptor (iTD)" | |
481 | * | |
482 | * Schedule records for high speed iso xfers | |
483 | */ | |
484 | struct ehci_itd { | |
485 | /* first part defined by EHCI spec */ | |
6dbd682b SR |
486 | __hc32 hw_next; /* see EHCI 3.3.1 */ |
487 | __hc32 hw_transaction [8]; /* see EHCI 3.3.2 */ | |
1da177e4 LT |
488 | #define EHCI_ISOC_ACTIVE (1<<31) /* activate transfer this slot */ |
489 | #define EHCI_ISOC_BUF_ERR (1<<30) /* Data buffer error */ | |
490 | #define EHCI_ISOC_BABBLE (1<<29) /* babble detected */ | |
491 | #define EHCI_ISOC_XACTERR (1<<28) /* XactErr - transaction error */ | |
492 | #define EHCI_ITD_LENGTH(tok) (((tok)>>16) & 0x0fff) | |
493 | #define EHCI_ITD_IOC (1 << 15) /* interrupt on complete */ | |
494 | ||
6dbd682b | 495 | #define ITD_ACTIVE(ehci) cpu_to_hc32(ehci, EHCI_ISOC_ACTIVE) |
1da177e4 | 496 | |
6dbd682b SR |
497 | __hc32 hw_bufp [7]; /* see EHCI 3.3.3 */ |
498 | __hc32 hw_bufp_hi [7]; /* Appendix B */ | |
1da177e4 LT |
499 | |
500 | /* the rest is HCD-private */ | |
501 | dma_addr_t itd_dma; /* for this itd */ | |
502 | union ehci_shadow itd_next; /* ptr to periodic q entry */ | |
503 | ||
504 | struct urb *urb; | |
505 | struct ehci_iso_stream *stream; /* endpoint's queue */ | |
506 | struct list_head itd_list; /* list of stream's itds */ | |
507 | ||
508 | /* any/all hw_transactions here may be used by that urb */ | |
509 | unsigned frame; /* where scheduled */ | |
510 | unsigned pg; | |
511 | unsigned index[8]; /* in urb->iso_frame_desc */ | |
1da177e4 LT |
512 | } __attribute__ ((aligned (32))); |
513 | ||
514 | /*-------------------------------------------------------------------------*/ | |
515 | ||
516 | /* | |
53bd6a60 | 517 | * EHCI Specification 0.95 Section 3.4 |
1da177e4 LT |
518 | * siTD, aka split-transaction isochronous Transfer Descriptor |
519 | * ... describe full speed iso xfers through TT in hubs | |
520 | * see Figure 3-5 "Split-transaction Isochronous Transaction Descriptor (siTD) | |
521 | */ | |
522 | struct ehci_sitd { | |
523 | /* first part defined by EHCI spec */ | |
6dbd682b | 524 | __hc32 hw_next; |
1da177e4 | 525 | /* uses bit field macros above - see EHCI 0.95 Table 3-8 */ |
6dbd682b SR |
526 | __hc32 hw_fullspeed_ep; /* EHCI table 3-9 */ |
527 | __hc32 hw_uframe; /* EHCI table 3-10 */ | |
528 | __hc32 hw_results; /* EHCI table 3-11 */ | |
1da177e4 LT |
529 | #define SITD_IOC (1 << 31) /* interrupt on completion */ |
530 | #define SITD_PAGE (1 << 30) /* buffer 0/1 */ | |
531 | #define SITD_LENGTH(x) (0x3ff & ((x)>>16)) | |
532 | #define SITD_STS_ACTIVE (1 << 7) /* HC may execute this */ | |
533 | #define SITD_STS_ERR (1 << 6) /* error from TT */ | |
534 | #define SITD_STS_DBE (1 << 5) /* data buffer error (in HC) */ | |
535 | #define SITD_STS_BABBLE (1 << 4) /* device was babbling */ | |
536 | #define SITD_STS_XACT (1 << 3) /* illegal IN response */ | |
537 | #define SITD_STS_MMF (1 << 2) /* incomplete split transaction */ | |
538 | #define SITD_STS_STS (1 << 1) /* split transaction state */ | |
539 | ||
6dbd682b | 540 | #define SITD_ACTIVE(ehci) cpu_to_hc32(ehci, SITD_STS_ACTIVE) |
1da177e4 | 541 | |
6dbd682b SR |
542 | __hc32 hw_buf [2]; /* EHCI table 3-12 */ |
543 | __hc32 hw_backpointer; /* EHCI table 3-13 */ | |
544 | __hc32 hw_buf_hi [2]; /* Appendix B */ | |
1da177e4 LT |
545 | |
546 | /* the rest is HCD-private */ | |
547 | dma_addr_t sitd_dma; | |
548 | union ehci_shadow sitd_next; /* ptr to periodic q entry */ | |
549 | ||
550 | struct urb *urb; | |
551 | struct ehci_iso_stream *stream; /* endpoint's queue */ | |
552 | struct list_head sitd_list; /* list of stream's sitds */ | |
553 | unsigned frame; | |
554 | unsigned index; | |
555 | } __attribute__ ((aligned (32))); | |
556 | ||
557 | /*-------------------------------------------------------------------------*/ | |
558 | ||
559 | /* | |
560 | * EHCI Specification 0.96 Section 3.7 | |
561 | * Periodic Frame Span Traversal Node (FSTN) | |
562 | * | |
563 | * Manages split interrupt transactions (using TT) that span frame boundaries | |
564 | * into uframes 0/1; see 4.12.2.2. In those uframes, a "save place" FSTN | |
565 | * makes the HC jump (back) to a QH to scan for fs/ls QH completions until | |
566 | * it hits a "restore" FSTN; then it returns to finish other uframe 0/1 work. | |
567 | */ | |
568 | struct ehci_fstn { | |
6dbd682b SR |
569 | __hc32 hw_next; /* any periodic q entry */ |
570 | __hc32 hw_prev; /* qh or EHCI_LIST_END */ | |
1da177e4 LT |
571 | |
572 | /* the rest is HCD-private */ | |
573 | dma_addr_t fstn_dma; | |
574 | union ehci_shadow fstn_next; /* ptr to periodic q entry */ | |
575 | } __attribute__ ((aligned (32))); | |
576 | ||
577 | /*-------------------------------------------------------------------------*/ | |
578 | ||
16032c4f AS |
579 | /* Prepare the PORTSC wakeup flags during controller suspend/resume */ |
580 | ||
4147200d AS |
581 | #define ehci_prepare_ports_for_controller_suspend(ehci, do_wakeup) \ |
582 | ehci_adjust_port_wakeup_flags(ehci, true, do_wakeup); | |
16032c4f | 583 | |
4147200d AS |
584 | #define ehci_prepare_ports_for_controller_resume(ehci) \ |
585 | ehci_adjust_port_wakeup_flags(ehci, false, false); | |
16032c4f AS |
586 | |
587 | /*-------------------------------------------------------------------------*/ | |
588 | ||
1da177e4 LT |
589 | #ifdef CONFIG_USB_EHCI_ROOT_HUB_TT |
590 | ||
591 | /* | |
592 | * Some EHCI controllers have a Transaction Translator built into the | |
593 | * root hub. This is a non-standard feature. Each controller will need | |
594 | * to add code to the following inline functions, and call them as | |
595 | * needed (mostly in root hub code). | |
596 | */ | |
597 | ||
a8e51775 | 598 | #define ehci_is_TDI(e) (ehci_to_hcd(e)->has_tt) |
1da177e4 LT |
599 | |
600 | /* Returns the speed of a device attached to a port on the root hub. */ | |
601 | static inline unsigned int | |
602 | ehci_port_speed(struct ehci_hcd *ehci, unsigned int portsc) | |
603 | { | |
604 | if (ehci_is_TDI(ehci)) { | |
331ac6b2 | 605 | switch ((portsc >> (ehci->has_hostpc ? 25 : 26)) & 3) { |
1da177e4 LT |
606 | case 0: |
607 | return 0; | |
608 | case 1: | |
288ead45 | 609 | return USB_PORT_STAT_LOW_SPEED; |
1da177e4 LT |
610 | case 2: |
611 | default: | |
288ead45 | 612 | return USB_PORT_STAT_HIGH_SPEED; |
1da177e4 LT |
613 | } |
614 | } | |
288ead45 | 615 | return USB_PORT_STAT_HIGH_SPEED; |
1da177e4 LT |
616 | } |
617 | ||
618 | #else | |
619 | ||
620 | #define ehci_is_TDI(e) (0) | |
621 | ||
288ead45 | 622 | #define ehci_port_speed(ehci, portsc) USB_PORT_STAT_HIGH_SPEED |
1da177e4 LT |
623 | #endif |
624 | ||
8cd42e97 KG |
625 | /*-------------------------------------------------------------------------*/ |
626 | ||
627 | #ifdef CONFIG_PPC_83xx | |
628 | /* Some Freescale processors have an erratum in which the TT | |
629 | * port number in the queue head was 0..N-1 instead of 1..N. | |
630 | */ | |
631 | #define ehci_has_fsl_portno_bug(e) ((e)->has_fsl_port_bug) | |
632 | #else | |
633 | #define ehci_has_fsl_portno_bug(e) (0) | |
634 | #endif | |
635 | ||
083522d7 BH |
636 | /* |
637 | * While most USB host controllers implement their registers in | |
638 | * little-endian format, a minority (celleb companion chip) implement | |
639 | * them in big endian format. | |
640 | * | |
641 | * This attempts to support either format at compile time without a | |
642 | * runtime penalty, or both formats with the additional overhead | |
643 | * of checking a flag bit. | |
c430131a JA |
644 | * |
645 | * ehci_big_endian_capbase is a special quirk for controllers that | |
646 | * implement the HC capability registers as separate registers and not | |
647 | * as fields of a 32-bit register. | |
083522d7 BH |
648 | */ |
649 | ||
650 | #ifdef CONFIG_USB_EHCI_BIG_ENDIAN_MMIO | |
651 | #define ehci_big_endian_mmio(e) ((e)->big_endian_mmio) | |
c430131a | 652 | #define ehci_big_endian_capbase(e) ((e)->big_endian_capbase) |
083522d7 BH |
653 | #else |
654 | #define ehci_big_endian_mmio(e) 0 | |
c430131a | 655 | #define ehci_big_endian_capbase(e) 0 |
083522d7 BH |
656 | #endif |
657 | ||
6dbd682b SR |
658 | /* |
659 | * Big-endian read/write functions are arch-specific. | |
660 | * Other arches can be added if/when they're needed. | |
6dbd682b | 661 | */ |
91bc4d31 VB |
662 | #if defined(CONFIG_ARM) && defined(CONFIG_ARCH_IXP4XX) |
663 | #define readl_be(addr) __raw_readl((__force unsigned *)addr) | |
664 | #define writel_be(val, addr) __raw_writel(val, (__force unsigned *)addr) | |
665 | #endif | |
666 | ||
6dbd682b SR |
667 | static inline unsigned int ehci_readl(const struct ehci_hcd *ehci, |
668 | __u32 __iomem * regs) | |
083522d7 | 669 | { |
d728e327 | 670 | #ifdef CONFIG_USB_EHCI_BIG_ENDIAN_MMIO |
083522d7 | 671 | return ehci_big_endian_mmio(ehci) ? |
68f50e52 AV |
672 | readl_be(regs) : |
673 | readl(regs); | |
d728e327 | 674 | #else |
68f50e52 | 675 | return readl(regs); |
d728e327 | 676 | #endif |
083522d7 BH |
677 | } |
678 | ||
0660fe75 PC |
679 | #ifdef CONFIG_SOC_IMX28 |
680 | static inline void imx28_ehci_writel(const unsigned int val, | |
681 | volatile __u32 __iomem *addr) | |
682 | { | |
683 | __asm__ ("swp %0, %0, [%1]" : : "r"(val), "r"(addr)); | |
684 | } | |
685 | #else | |
686 | static inline void imx28_ehci_writel(const unsigned int val, | |
687 | volatile __u32 __iomem *addr) | |
688 | { | |
689 | } | |
690 | #endif | |
6dbd682b SR |
691 | static inline void ehci_writel(const struct ehci_hcd *ehci, |
692 | const unsigned int val, __u32 __iomem *regs) | |
083522d7 | 693 | { |
d728e327 | 694 | #ifdef CONFIG_USB_EHCI_BIG_ENDIAN_MMIO |
083522d7 | 695 | ehci_big_endian_mmio(ehci) ? |
68f50e52 AV |
696 | writel_be(val, regs) : |
697 | writel(val, regs); | |
d728e327 | 698 | #else |
0660fe75 PC |
699 | if (ehci->imx28_write_fix) |
700 | imx28_ehci_writel(val, regs); | |
701 | else | |
702 | writel(val, regs); | |
d728e327 | 703 | #endif |
083522d7 | 704 | } |
8cd42e97 | 705 | |
796bcae7 VB |
706 | /* |
707 | * On certain ppc-44x SoC there is a HW issue, that could only worked around with | |
708 | * explicit suspend/operate of OHCI. This function hereby makes sense only on that arch. | |
25985edc | 709 | * Other common bits are dependent on has_amcc_usb23 quirk flag. |
796bcae7 VB |
710 | */ |
711 | #ifdef CONFIG_44x | |
712 | static inline void set_ohci_hcfs(struct ehci_hcd *ehci, int operational) | |
713 | { | |
714 | u32 hc_control; | |
715 | ||
716 | hc_control = (readl_be(ehci->ohci_hcctrl_reg) & ~OHCI_CTRL_HCFS); | |
717 | if (operational) | |
718 | hc_control |= OHCI_USB_OPER; | |
719 | else | |
720 | hc_control |= OHCI_USB_SUSPEND; | |
721 | ||
722 | writel_be(hc_control, ehci->ohci_hcctrl_reg); | |
723 | (void) readl_be(ehci->ohci_hcctrl_reg); | |
724 | } | |
725 | #else | |
726 | static inline void set_ohci_hcfs(struct ehci_hcd *ehci, int operational) | |
727 | { } | |
728 | #endif | |
729 | ||
1da177e4 LT |
730 | /*-------------------------------------------------------------------------*/ |
731 | ||
6dbd682b SR |
732 | /* |
733 | * The AMCC 440EPx not only implements its EHCI registers in big-endian | |
734 | * format, but also its DMA data structures (descriptors). | |
735 | * | |
736 | * EHCI controllers accessed through PCI work normally (little-endian | |
737 | * everywhere), so we won't bother supporting a BE-only mode for now. | |
738 | */ | |
739 | #ifdef CONFIG_USB_EHCI_BIG_ENDIAN_DESC | |
740 | #define ehci_big_endian_desc(e) ((e)->big_endian_desc) | |
741 | ||
742 | /* cpu to ehci */ | |
743 | static inline __hc32 cpu_to_hc32 (const struct ehci_hcd *ehci, const u32 x) | |
744 | { | |
745 | return ehci_big_endian_desc(ehci) | |
746 | ? (__force __hc32)cpu_to_be32(x) | |
747 | : (__force __hc32)cpu_to_le32(x); | |
748 | } | |
749 | ||
750 | /* ehci to cpu */ | |
751 | static inline u32 hc32_to_cpu (const struct ehci_hcd *ehci, const __hc32 x) | |
752 | { | |
753 | return ehci_big_endian_desc(ehci) | |
754 | ? be32_to_cpu((__force __be32)x) | |
755 | : le32_to_cpu((__force __le32)x); | |
756 | } | |
757 | ||
758 | static inline u32 hc32_to_cpup (const struct ehci_hcd *ehci, const __hc32 *x) | |
759 | { | |
760 | return ehci_big_endian_desc(ehci) | |
761 | ? be32_to_cpup((__force __be32 *)x) | |
762 | : le32_to_cpup((__force __le32 *)x); | |
763 | } | |
764 | ||
765 | #else | |
766 | ||
767 | /* cpu to ehci */ | |
768 | static inline __hc32 cpu_to_hc32 (const struct ehci_hcd *ehci, const u32 x) | |
769 | { | |
770 | return cpu_to_le32(x); | |
771 | } | |
772 | ||
773 | /* ehci to cpu */ | |
774 | static inline u32 hc32_to_cpu (const struct ehci_hcd *ehci, const __hc32 x) | |
775 | { | |
776 | return le32_to_cpu(x); | |
777 | } | |
778 | ||
779 | static inline u32 hc32_to_cpup (const struct ehci_hcd *ehci, const __hc32 *x) | |
780 | { | |
781 | return le32_to_cpup(x); | |
782 | } | |
783 | ||
784 | #endif | |
785 | ||
786 | /*-------------------------------------------------------------------------*/ | |
787 | ||
d6064aca AS |
788 | #define ehci_dbg(ehci, fmt, args...) \ |
789 | dev_dbg(ehci_to_hcd(ehci)->self.controller , fmt , ## args) | |
790 | #define ehci_err(ehci, fmt, args...) \ | |
791 | dev_err(ehci_to_hcd(ehci)->self.controller , fmt , ## args) | |
792 | #define ehci_info(ehci, fmt, args...) \ | |
793 | dev_info(ehci_to_hcd(ehci)->self.controller , fmt , ## args) | |
794 | #define ehci_warn(ehci, fmt, args...) \ | |
795 | dev_warn(ehci_to_hcd(ehci)->self.controller , fmt , ## args) | |
796 | ||
797 | #ifdef VERBOSE_DEBUG | |
798 | # define ehci_vdbg ehci_dbg | |
799 | #else | |
800 | static inline void ehci_vdbg(struct ehci_hcd *ehci, ...) {} | |
801 | #endif | |
802 | ||
1da177e4 LT |
803 | #ifndef DEBUG |
804 | #define STUB_DEBUG_FILES | |
805 | #endif /* DEBUG */ | |
806 | ||
807 | /*-------------------------------------------------------------------------*/ | |
808 | ||
3e023203 AS |
809 | /* Declarations of things exported for use by ehci platform drivers */ |
810 | ||
811 | struct ehci_driver_overrides { | |
3e023203 AS |
812 | size_t extra_priv_size; |
813 | int (*reset)(struct usb_hcd *hcd); | |
814 | }; | |
815 | ||
816 | extern void ehci_init_driver(struct hc_driver *drv, | |
817 | const struct ehci_driver_overrides *over); | |
818 | extern int ehci_setup(struct usb_hcd *hcd); | |
819 | ||
820 | #ifdef CONFIG_PM | |
821 | extern int ehci_suspend(struct usb_hcd *hcd, bool do_wakeup); | |
822 | extern int ehci_resume(struct usb_hcd *hcd, bool hibernated); | |
823 | #endif /* CONFIG_PM */ | |
824 | ||
1da177e4 | 825 | #endif /* __LINUX_EHCI_HCD_H */ |