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