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