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