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