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