Merge branch 'upstream-fixes' of git://git.kernel.org/pub/scm/linux/kernel/git/linvil...
[pandora-kernel.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 /* statistics can be kept for for tuning/monitoring */
25 struct ehci_stats {
26         /* irq usage */
27         unsigned long           normal;
28         unsigned long           error;
29         unsigned long           reclaim;
30         unsigned long           lost_iaa;
31
32         /* termination of urbs from core */
33         unsigned long           complete;
34         unsigned long           unlink;
35 };
36
37 /* ehci_hcd->lock guards shared data against other CPUs:
38  *   ehci_hcd:  async, reclaim, periodic (and shadow), ...
39  *   usb_host_endpoint: hcpriv
40  *   ehci_qh:   qh_next, qtd_list
41  *   ehci_qtd:  qtd_list
42  *
43  * Also, hold this lock when talking to HC registers or
44  * when updating hw_* fields in shared qh/qtd/... structures.
45  */
46
47 #define EHCI_MAX_ROOT_PORTS     15              /* see HCS_N_PORTS */
48
49 struct ehci_hcd {                       /* one per controller */
50         /* glue to PCI and HCD framework */
51         struct ehci_caps __iomem *caps;
52         struct ehci_regs __iomem *regs;
53         struct ehci_dbg_port __iomem *debug;
54
55         __u32                   hcs_params;     /* cached register copy */
56         spinlock_t              lock;
57
58         /* async schedule support */
59         struct ehci_qh          *async;
60         struct ehci_qh          *reclaim;
61         unsigned                reclaim_ready : 1;
62         unsigned                scanning : 1;
63
64         /* periodic schedule support */
65 #define DEFAULT_I_TDPS          1024            /* some HCs can do less */
66         unsigned                periodic_size;
67         __le32                  *periodic;      /* hw periodic table */
68         dma_addr_t              periodic_dma;
69         unsigned                i_thresh;       /* uframes HC might cache */
70
71         union ehci_shadow       *pshadow;       /* mirror hw periodic table */
72         int                     next_uframe;    /* scan periodic, start here */
73         unsigned                periodic_sched; /* periodic activity count */
74
75         /* per root hub port */
76         unsigned long           reset_done [EHCI_MAX_ROOT_PORTS];
77
78         /* per-HC memory pools (could be per-bus, but ...) */
79         struct dma_pool         *qh_pool;       /* qh per active urb */
80         struct dma_pool         *qtd_pool;      /* one or more per qh */
81         struct dma_pool         *itd_pool;      /* itd per iso urb */
82         struct dma_pool         *sitd_pool;     /* sitd per split iso urb */
83
84         struct timer_list       watchdog;
85         unsigned long           actions;
86         unsigned                stamp;
87         unsigned long           next_statechange;
88         u32                     command;
89
90         /* SILICON QUIRKS */
91         unsigned                is_tdi_rh_tt:1; /* TDI roothub with TT */
92         unsigned                no_selective_suspend:1;
93         unsigned                has_fsl_port_bug:1; /* FreeScale */
94
95         u8                      sbrn;           /* packed release number */
96
97         /* irq statistics */
98 #ifdef EHCI_STATS
99         struct ehci_stats       stats;
100 #       define COUNT(x) do { (x)++; } while (0)
101 #else
102 #       define COUNT(x) do {} while (0)
103 #endif
104 };
105
106 /* convert between an HCD pointer and the corresponding EHCI_HCD */
107 static inline struct ehci_hcd *hcd_to_ehci (struct usb_hcd *hcd)
108 {
109         return (struct ehci_hcd *) (hcd->hcd_priv);
110 }
111 static inline struct usb_hcd *ehci_to_hcd (struct ehci_hcd *ehci)
112 {
113         return container_of ((void *) ehci, struct usb_hcd, hcd_priv);
114 }
115
116
117 enum ehci_timer_action {
118         TIMER_IO_WATCHDOG,
119         TIMER_IAA_WATCHDOG,
120         TIMER_ASYNC_SHRINK,
121         TIMER_ASYNC_OFF,
122 };
123
124 static inline void
125 timer_action_done (struct ehci_hcd *ehci, enum ehci_timer_action action)
126 {
127         clear_bit (action, &ehci->actions);
128 }
129
130 static inline void
131 timer_action (struct ehci_hcd *ehci, enum ehci_timer_action action)
132 {
133         if (!test_and_set_bit (action, &ehci->actions)) {
134                 unsigned long t;
135
136                 switch (action) {
137                 case TIMER_IAA_WATCHDOG:
138                         t = EHCI_IAA_JIFFIES;
139                         break;
140                 case TIMER_IO_WATCHDOG:
141                         t = EHCI_IO_JIFFIES;
142                         break;
143                 case TIMER_ASYNC_OFF:
144                         t = EHCI_ASYNC_JIFFIES;
145                         break;
146                 // case TIMER_ASYNC_SHRINK:
147                 default:
148                         t = EHCI_SHRINK_JIFFIES;
149                         break;
150                 }
151                 t += jiffies;
152                 // all timings except IAA watchdog can be overridden.
153                 // async queue SHRINK often precedes IAA.  while it's ready
154                 // to go OFF neither can matter, and afterwards the IO
155                 // watchdog stops unless there's still periodic traffic.
156                 if (action != TIMER_IAA_WATCHDOG
157                                 && t > ehci->watchdog.expires
158                                 && timer_pending (&ehci->watchdog))
159                         return;
160                 mod_timer (&ehci->watchdog, t);
161         }
162 }
163
164 /*-------------------------------------------------------------------------*/
165
166 /* EHCI register interface, corresponds to EHCI Revision 0.95 specification */
167
168 /* Section 2.2 Host Controller Capability Registers */
169 struct ehci_caps {
170         /* these fields are specified as 8 and 16 bit registers,
171          * but some hosts can't perform 8 or 16 bit PCI accesses.
172          */
173         u32             hc_capbase;
174 #define HC_LENGTH(p)            (((p)>>00)&0x00ff)      /* bits 7:0 */
175 #define HC_VERSION(p)           (((p)>>16)&0xffff)      /* bits 31:16 */
176         u32             hcs_params;     /* HCSPARAMS - offset 0x4 */
177 #define HCS_DEBUG_PORT(p)       (((p)>>20)&0xf) /* bits 23:20, debug port? */
178 #define HCS_INDICATOR(p)        ((p)&(1 << 16)) /* true: has port indicators */
179 #define HCS_N_CC(p)             (((p)>>12)&0xf) /* bits 15:12, #companion HCs */
180 #define HCS_N_PCC(p)            (((p)>>8)&0xf)  /* bits 11:8, ports per CC */
181 #define HCS_PORTROUTED(p)       ((p)&(1 << 7))  /* true: port routing */
182 #define HCS_PPC(p)              ((p)&(1 << 4))  /* true: port power control */
183 #define HCS_N_PORTS(p)          (((p)>>0)&0xf)  /* bits 3:0, ports on HC */
184
185         u32             hcc_params;      /* HCCPARAMS - offset 0x8 */
186 #define HCC_EXT_CAPS(p)         (((p)>>8)&0xff) /* for pci extended caps */
187 #define HCC_ISOC_CACHE(p)       ((p)&(1 << 7))  /* true: can cache isoc frame */
188 #define HCC_ISOC_THRES(p)       (((p)>>4)&0x7)  /* bits 6:4, uframes cached */
189 #define HCC_CANPARK(p)          ((p)&(1 << 2))  /* true: can park on async qh */
190 #define HCC_PGM_FRAMELISTLEN(p) ((p)&(1 << 1))  /* true: periodic_size changes*/
191 #define HCC_64BIT_ADDR(p)       ((p)&(1))       /* true: can use 64-bit addr */
192         u8              portroute [8];   /* nibbles for routing - offset 0xC */
193 } __attribute__ ((packed));
194
195
196 /* Section 2.3 Host Controller Operational Registers */
197 struct ehci_regs {
198
199         /* USBCMD: offset 0x00 */
200         u32             command;
201 /* 23:16 is r/w intr rate, in microframes; default "8" == 1/msec */
202 #define CMD_PARK        (1<<11)         /* enable "park" on async qh */
203 #define CMD_PARK_CNT(c) (((c)>>8)&3)    /* how many transfers to park for */
204 #define CMD_LRESET      (1<<7)          /* partial reset (no ports, etc) */
205 #define CMD_IAAD        (1<<6)          /* "doorbell" interrupt async advance */
206 #define CMD_ASE         (1<<5)          /* async schedule enable */
207 #define CMD_PSE         (1<<4)          /* periodic schedule enable */
208 /* 3:2 is periodic frame list size */
209 #define CMD_RESET       (1<<1)          /* reset HC not bus */
210 #define CMD_RUN         (1<<0)          /* start/stop HC */
211
212         /* USBSTS: offset 0x04 */
213         u32             status;
214 #define STS_ASS         (1<<15)         /* Async Schedule Status */
215 #define STS_PSS         (1<<14)         /* Periodic Schedule Status */
216 #define STS_RECL        (1<<13)         /* Reclamation */
217 #define STS_HALT        (1<<12)         /* Not running (any reason) */
218 /* some bits reserved */
219         /* these STS_* flags are also intr_enable bits (USBINTR) */
220 #define STS_IAA         (1<<5)          /* Interrupted on async advance */
221 #define STS_FATAL       (1<<4)          /* such as some PCI access errors */
222 #define STS_FLR         (1<<3)          /* frame list rolled over */
223 #define STS_PCD         (1<<2)          /* port change detect */
224 #define STS_ERR         (1<<1)          /* "error" completion (overflow, ...) */
225 #define STS_INT         (1<<0)          /* "normal" completion (short, ...) */
226
227         /* USBINTR: offset 0x08 */
228         u32             intr_enable;
229
230         /* FRINDEX: offset 0x0C */
231         u32             frame_index;    /* current microframe number */
232         /* CTRLDSSEGMENT: offset 0x10 */
233         u32             segment;        /* address bits 63:32 if needed */
234         /* PERIODICLISTBASE: offset 0x14 */
235         u32             frame_list;     /* points to periodic list */
236         /* ASYNCLISTADDR: offset 0x18 */
237         u32             async_next;     /* address of next async queue head */
238
239         u32             reserved [9];
240
241         /* CONFIGFLAG: offset 0x40 */
242         u32             configured_flag;
243 #define FLAG_CF         (1<<0)          /* true: we'll support "high speed" */
244
245         /* PORTSC: offset 0x44 */
246         u32             port_status [0];        /* up to N_PORTS */
247 /* 31:23 reserved */
248 #define PORT_WKOC_E     (1<<22)         /* wake on overcurrent (enable) */
249 #define PORT_WKDISC_E   (1<<21)         /* wake on disconnect (enable) */
250 #define PORT_WKCONN_E   (1<<20)         /* wake on connect (enable) */
251 /* 19:16 for port testing */
252 #define PORT_LED_OFF    (0<<14)
253 #define PORT_LED_AMBER  (1<<14)
254 #define PORT_LED_GREEN  (2<<14)
255 #define PORT_LED_MASK   (3<<14)
256 #define PORT_OWNER      (1<<13)         /* true: companion hc owns this port */
257 #define PORT_POWER      (1<<12)         /* true: has power (see PPC) */
258 #define PORT_USB11(x) (((x)&(3<<10))==(1<<10))  /* USB 1.1 device */
259 /* 11:10 for detecting lowspeed devices (reset vs release ownership) */
260 /* 9 reserved */
261 #define PORT_RESET      (1<<8)          /* reset port */
262 #define PORT_SUSPEND    (1<<7)          /* suspend port */
263 #define PORT_RESUME     (1<<6)          /* resume it */
264 #define PORT_OCC        (1<<5)          /* over current change */
265 #define PORT_OC         (1<<4)          /* over current active */
266 #define PORT_PEC        (1<<3)          /* port enable change */
267 #define PORT_PE         (1<<2)          /* port enable */
268 #define PORT_CSC        (1<<1)          /* connect status change */
269 #define PORT_CONNECT    (1<<0)          /* device connected */
270 #define PORT_RWC_BITS   (PORT_CSC | PORT_PEC | PORT_OCC)
271 } __attribute__ ((packed));
272
273 /* Appendix C, Debug port ... intended for use with special "debug devices"
274  * that can help if there's no serial console.  (nonstandard enumeration.)
275  */
276 struct ehci_dbg_port {
277         u32     control;
278 #define DBGP_OWNER      (1<<30)
279 #define DBGP_ENABLED    (1<<28)
280 #define DBGP_DONE       (1<<16)
281 #define DBGP_INUSE      (1<<10)
282 #define DBGP_ERRCODE(x) (((x)>>7)&0x07)
283 #       define DBGP_ERR_BAD     1
284 #       define DBGP_ERR_SIGNAL  2
285 #define DBGP_ERROR      (1<<6)
286 #define DBGP_GO         (1<<5)
287 #define DBGP_OUT        (1<<4)
288 #define DBGP_LEN(x)     (((x)>>0)&0x0f)
289         u32     pids;
290 #define DBGP_PID_GET(x)         (((x)>>16)&0xff)
291 #define DBGP_PID_SET(data,tok)  (((data)<<8)|(tok))
292         u32     data03;
293         u32     data47;
294         u32     address;
295 #define DBGP_EPADDR(dev,ep)     (((dev)<<8)|(ep))
296 } __attribute__ ((packed));
297
298 /*-------------------------------------------------------------------------*/
299
300 #define QTD_NEXT(dma)   cpu_to_le32((u32)dma)
301
302 /*
303  * EHCI Specification 0.95 Section 3.5
304  * QTD: describe data transfer components (buffer, direction, ...)
305  * See Fig 3-6 "Queue Element Transfer Descriptor Block Diagram".
306  *
307  * These are associated only with "QH" (Queue Head) structures,
308  * used with control, bulk, and interrupt transfers.
309  */
310 struct ehci_qtd {
311         /* first part defined by EHCI spec */
312         __le32                  hw_next;          /* see EHCI 3.5.1 */
313         __le32                  hw_alt_next;      /* see EHCI 3.5.2 */
314         __le32                  hw_token;         /* see EHCI 3.5.3 */
315 #define QTD_TOGGLE      (1 << 31)       /* data toggle */
316 #define QTD_LENGTH(tok) (((tok)>>16) & 0x7fff)
317 #define QTD_IOC         (1 << 15)       /* interrupt on complete */
318 #define QTD_CERR(tok)   (((tok)>>10) & 0x3)
319 #define QTD_PID(tok)    (((tok)>>8) & 0x3)
320 #define QTD_STS_ACTIVE  (1 << 7)        /* HC may execute this */
321 #define QTD_STS_HALT    (1 << 6)        /* halted on error */
322 #define QTD_STS_DBE     (1 << 5)        /* data buffer error (in HC) */
323 #define QTD_STS_BABBLE  (1 << 4)        /* device was babbling (qtd halted) */
324 #define QTD_STS_XACT    (1 << 3)        /* device gave illegal response */
325 #define QTD_STS_MMF     (1 << 2)        /* incomplete split transaction */
326 #define QTD_STS_STS     (1 << 1)        /* split transaction state */
327 #define QTD_STS_PING    (1 << 0)        /* issue PING? */
328         __le32                  hw_buf [5];        /* see EHCI 3.5.4 */
329         __le32                  hw_buf_hi [5];        /* Appendix B */
330
331         /* the rest is HCD-private */
332         dma_addr_t              qtd_dma;                /* qtd address */
333         struct list_head        qtd_list;               /* sw qtd list */
334         struct urb              *urb;                   /* qtd's urb */
335         size_t                  length;                 /* length of buffer */
336 } __attribute__ ((aligned (32)));
337
338 /* mask NakCnt+T in qh->hw_alt_next */
339 #define QTD_MASK __constant_cpu_to_le32 (~0x1f)
340
341 #define IS_SHORT_READ(token) (QTD_LENGTH (token) != 0 && QTD_PID (token) == 1)
342
343 /*-------------------------------------------------------------------------*/
344
345 /* type tag from {qh,itd,sitd,fstn}->hw_next */
346 #define Q_NEXT_TYPE(dma) ((dma) & __constant_cpu_to_le32 (3 << 1))
347
348 /* values for that type tag */
349 #define Q_TYPE_ITD      __constant_cpu_to_le32 (0 << 1)
350 #define Q_TYPE_QH       __constant_cpu_to_le32 (1 << 1)
351 #define Q_TYPE_SITD     __constant_cpu_to_le32 (2 << 1)
352 #define Q_TYPE_FSTN     __constant_cpu_to_le32 (3 << 1)
353
354 /* next async queue entry, or pointer to interrupt/periodic QH */
355 #define QH_NEXT(dma)    (cpu_to_le32(((u32)dma)&~0x01f)|Q_TYPE_QH)
356
357 /* for periodic/async schedules and qtd lists, mark end of list */
358 #define EHCI_LIST_END   __constant_cpu_to_le32(1) /* "null pointer" to hw */
359
360 /*
361  * Entries in periodic shadow table are pointers to one of four kinds
362  * of data structure.  That's dictated by the hardware; a type tag is
363  * encoded in the low bits of the hardware's periodic schedule.  Use
364  * Q_NEXT_TYPE to get the tag.
365  *
366  * For entries in the async schedule, the type tag always says "qh".
367  */
368 union ehci_shadow {
369         struct ehci_qh          *qh;            /* Q_TYPE_QH */
370         struct ehci_itd         *itd;           /* Q_TYPE_ITD */
371         struct ehci_sitd        *sitd;          /* Q_TYPE_SITD */
372         struct ehci_fstn        *fstn;          /* Q_TYPE_FSTN */
373         __le32                  *hw_next;       /* (all types) */
374         void                    *ptr;
375 };
376
377 /*-------------------------------------------------------------------------*/
378
379 /*
380  * EHCI Specification 0.95 Section 3.6
381  * QH: describes control/bulk/interrupt endpoints
382  * See Fig 3-7 "Queue Head Structure Layout".
383  *
384  * These appear in both the async and (for interrupt) periodic schedules.
385  */
386
387 struct ehci_qh {
388         /* first part defined by EHCI spec */
389         __le32                  hw_next;         /* see EHCI 3.6.1 */
390         __le32                  hw_info1;        /* see EHCI 3.6.2 */
391 #define QH_HEAD         0x00008000
392         __le32                  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         __le32                  hw_current;      /* qtd list - see EHCI 3.6.4 */
399
400         /* qtd overlay (hardware parts of a struct ehci_qtd) */
401         __le32                  hw_qtd_next;
402         __le32                  hw_alt_next;
403         __le32                  hw_token;
404         __le32                  hw_buf [5];
405         __le32                  hw_buf_hi [5];
406
407         /* the rest is HCD-private */
408         dma_addr_t              qh_dma;         /* address of qh */
409         union ehci_shadow       qh_next;        /* ptr to qh; or periodic */
410         struct list_head        qtd_list;       /* sw qtd list */
411         struct ehci_qtd         *dummy;
412         struct ehci_qh          *reclaim;       /* next to reclaim */
413
414         struct ehci_hcd         *ehci;
415         struct kref             kref;
416         unsigned                stamp;
417
418         u8                      qh_state;
419 #define QH_STATE_LINKED         1               /* HC sees this */
420 #define QH_STATE_UNLINK         2               /* HC may still see this */
421 #define QH_STATE_IDLE           3               /* HC doesn't see this */
422 #define QH_STATE_UNLINK_WAIT    4               /* LINKED and on reclaim q */
423 #define QH_STATE_COMPLETING     5               /* don't touch token.HALT */
424
425         /* periodic schedule info */
426         u8                      usecs;          /* intr bandwidth */
427         u8                      gap_uf;         /* uframes split/csplit gap */
428         u8                      c_usecs;        /* ... split completion bw */
429         u16                     tt_usecs;       /* tt downstream bandwidth */
430         unsigned short          period;         /* polling interval */
431         unsigned short          start;          /* where polling starts */
432 #define NO_FRAME ((unsigned short)~0)                   /* pick new start */
433         struct usb_device       *dev;           /* access to TT */
434 } __attribute__ ((aligned (32)));
435
436 /*-------------------------------------------------------------------------*/
437
438 /* description of one iso transaction (up to 3 KB data if highspeed) */
439 struct ehci_iso_packet {
440         /* These will be copied to iTD when scheduling */
441         u64                     bufp;           /* itd->hw_bufp{,_hi}[pg] |= */
442         __le32                  transaction;    /* itd->hw_transaction[i] |= */
443         u8                      cross;          /* buf crosses pages */
444         /* for full speed OUT splits */
445         u32                     buf1;
446 };
447
448 /* temporary schedule data for packets from iso urbs (both speeds)
449  * each packet is one logical usb transaction to the device (not TT),
450  * beginning at stream->next_uframe
451  */
452 struct ehci_iso_sched {
453         struct list_head        td_list;
454         unsigned                span;
455         struct ehci_iso_packet  packet [0];
456 };
457
458 /*
459  * ehci_iso_stream - groups all (s)itds for this endpoint.
460  * acts like a qh would, if EHCI had them for ISO.
461  */
462 struct ehci_iso_stream {
463         /* first two fields match QH, but info1 == 0 */
464         __le32                  hw_next;
465         __le32                  hw_info1;
466
467         u32                     refcount;
468         u8                      bEndpointAddress;
469         u8                      highspeed;
470         u16                     depth;          /* depth in uframes */
471         struct list_head        td_list;        /* queued itds/sitds */
472         struct list_head        free_list;      /* list of unused itds/sitds */
473         struct usb_device       *udev;
474         struct usb_host_endpoint *ep;
475
476         /* output of (re)scheduling */
477         unsigned long           start;          /* jiffies */
478         unsigned long           rescheduled;
479         int                     next_uframe;
480         __le32                  splits;
481
482         /* the rest is derived from the endpoint descriptor,
483          * trusting urb->interval == f(epdesc->bInterval) and
484          * including the extra info for hw_bufp[0..2]
485          */
486         u8                      interval;
487         u8                      usecs, c_usecs;
488         u16                     tt_usecs;
489         u16                     maxp;
490         u16                     raw_mask;
491         unsigned                bandwidth;
492
493         /* This is used to initialize iTD's hw_bufp fields */
494         __le32                  buf0;
495         __le32                  buf1;
496         __le32                  buf2;
497
498         /* this is used to initialize sITD's tt info */
499         __le32                  address;
500 };
501
502 /*-------------------------------------------------------------------------*/
503
504 /*
505  * EHCI Specification 0.95 Section 3.3
506  * Fig 3-4 "Isochronous Transaction Descriptor (iTD)"
507  *
508  * Schedule records for high speed iso xfers
509  */
510 struct ehci_itd {
511         /* first part defined by EHCI spec */
512         __le32                  hw_next;           /* see EHCI 3.3.1 */
513         __le32                  hw_transaction [8]; /* see EHCI 3.3.2 */
514 #define EHCI_ISOC_ACTIVE        (1<<31)        /* activate transfer this slot */
515 #define EHCI_ISOC_BUF_ERR       (1<<30)        /* Data buffer error */
516 #define EHCI_ISOC_BABBLE        (1<<29)        /* babble detected */
517 #define EHCI_ISOC_XACTERR       (1<<28)        /* XactErr - transaction error */
518 #define EHCI_ITD_LENGTH(tok)    (((tok)>>16) & 0x0fff)
519 #define EHCI_ITD_IOC            (1 << 15)       /* interrupt on complete */
520
521 #define ITD_ACTIVE      __constant_cpu_to_le32(EHCI_ISOC_ACTIVE)
522
523         __le32                  hw_bufp [7];    /* see EHCI 3.3.3 */
524         __le32                  hw_bufp_hi [7]; /* Appendix B */
525
526         /* the rest is HCD-private */
527         dma_addr_t              itd_dma;        /* for this itd */
528         union ehci_shadow       itd_next;       /* ptr to periodic q entry */
529
530         struct urb              *urb;
531         struct ehci_iso_stream  *stream;        /* endpoint's queue */
532         struct list_head        itd_list;       /* list of stream's itds */
533
534         /* any/all hw_transactions here may be used by that urb */
535         unsigned                frame;          /* where scheduled */
536         unsigned                pg;
537         unsigned                index[8];       /* in urb->iso_frame_desc */
538         u8                      usecs[8];
539 } __attribute__ ((aligned (32)));
540
541 /*-------------------------------------------------------------------------*/
542
543 /*
544  * EHCI Specification 0.95 Section 3.4
545  * siTD, aka split-transaction isochronous Transfer Descriptor
546  *       ... describe full speed iso xfers through TT in hubs
547  * see Figure 3-5 "Split-transaction Isochronous Transaction Descriptor (siTD)
548  */
549 struct ehci_sitd {
550         /* first part defined by EHCI spec */
551         __le32                  hw_next;
552 /* uses bit field macros above - see EHCI 0.95 Table 3-8 */
553         __le32                  hw_fullspeed_ep;        /* EHCI table 3-9 */
554         __le32                  hw_uframe;              /* EHCI table 3-10 */
555         __le32                  hw_results;             /* EHCI table 3-11 */
556 #define SITD_IOC        (1 << 31)       /* interrupt on completion */
557 #define SITD_PAGE       (1 << 30)       /* buffer 0/1 */
558 #define SITD_LENGTH(x)  (0x3ff & ((x)>>16))
559 #define SITD_STS_ACTIVE (1 << 7)        /* HC may execute this */
560 #define SITD_STS_ERR    (1 << 6)        /* error from TT */
561 #define SITD_STS_DBE    (1 << 5)        /* data buffer error (in HC) */
562 #define SITD_STS_BABBLE (1 << 4)        /* device was babbling */
563 #define SITD_STS_XACT   (1 << 3)        /* illegal IN response */
564 #define SITD_STS_MMF    (1 << 2)        /* incomplete split transaction */
565 #define SITD_STS_STS    (1 << 1)        /* split transaction state */
566
567 #define SITD_ACTIVE     __constant_cpu_to_le32(SITD_STS_ACTIVE)
568
569         __le32                  hw_buf [2];             /* EHCI table 3-12 */
570         __le32                  hw_backpointer;         /* EHCI table 3-13 */
571         __le32                  hw_buf_hi [2];          /* Appendix B */
572
573         /* the rest is HCD-private */
574         dma_addr_t              sitd_dma;
575         union ehci_shadow       sitd_next;      /* ptr to periodic q entry */
576
577         struct urb              *urb;
578         struct ehci_iso_stream  *stream;        /* endpoint's queue */
579         struct list_head        sitd_list;      /* list of stream's sitds */
580         unsigned                frame;
581         unsigned                index;
582 } __attribute__ ((aligned (32)));
583
584 /*-------------------------------------------------------------------------*/
585
586 /*
587  * EHCI Specification 0.96 Section 3.7
588  * Periodic Frame Span Traversal Node (FSTN)
589  *
590  * Manages split interrupt transactions (using TT) that span frame boundaries
591  * into uframes 0/1; see 4.12.2.2.  In those uframes, a "save place" FSTN
592  * makes the HC jump (back) to a QH to scan for fs/ls QH completions until
593  * it hits a "restore" FSTN; then it returns to finish other uframe 0/1 work.
594  */
595 struct ehci_fstn {
596         __le32                  hw_next;        /* any periodic q entry */
597         __le32                  hw_prev;        /* qh or EHCI_LIST_END */
598
599         /* the rest is HCD-private */
600         dma_addr_t              fstn_dma;
601         union ehci_shadow       fstn_next;      /* ptr to periodic q entry */
602 } __attribute__ ((aligned (32)));
603
604 /*-------------------------------------------------------------------------*/
605
606 #ifdef CONFIG_USB_EHCI_ROOT_HUB_TT
607
608 /*
609  * Some EHCI controllers have a Transaction Translator built into the
610  * root hub. This is a non-standard feature.  Each controller will need
611  * to add code to the following inline functions, and call them as
612  * needed (mostly in root hub code).
613  */
614
615 #define ehci_is_TDI(e)                  ((e)->is_tdi_rh_tt)
616
617 /* Returns the speed of a device attached to a port on the root hub. */
618 static inline unsigned int
619 ehci_port_speed(struct ehci_hcd *ehci, unsigned int portsc)
620 {
621         if (ehci_is_TDI(ehci)) {
622                 switch ((portsc>>26)&3) {
623                 case 0:
624                         return 0;
625                 case 1:
626                         return (1<<USB_PORT_FEAT_LOWSPEED);
627                 case 2:
628                 default:
629                         return (1<<USB_PORT_FEAT_HIGHSPEED);
630                 }
631         }
632         return (1<<USB_PORT_FEAT_HIGHSPEED);
633 }
634
635 #else
636
637 #define ehci_is_TDI(e)                  (0)
638
639 #define ehci_port_speed(ehci, portsc)   (1<<USB_PORT_FEAT_HIGHSPEED)
640 #endif
641
642 /*-------------------------------------------------------------------------*/
643
644 #ifdef CONFIG_PPC_83xx
645 /* Some Freescale processors have an erratum in which the TT
646  * port number in the queue head was 0..N-1 instead of 1..N.
647  */
648 #define ehci_has_fsl_portno_bug(e)              ((e)->has_fsl_port_bug)
649 #else
650 #define ehci_has_fsl_portno_bug(e)              (0)
651 #endif
652
653
654 /*-------------------------------------------------------------------------*/
655
656 #ifndef DEBUG
657 #define STUB_DEBUG_FILES
658 #endif  /* DEBUG */
659
660 /*-------------------------------------------------------------------------*/
661
662 #endif /* __LINUX_EHCI_HCD_H */