drivers/usb/host/fusbh200.h

   1 #ifndef __LINUX_FUSBH200_H
   2 #define __LINUX_FUSBH200_H
   3
   4 /* definitions used for the EHCI driver */
   5
   6 /*
   7  * __hc32 and __hc16 are "Host Controller" types, they may be equivalent to
   8  * __leXX (normally) or __beXX (given FUSBH200_BIG_ENDIAN_DESC), depending on
   9  * the host controller implementation.
  10  *
  11  * To facilitate the strongest possible byte-order checking from "sparse"
  12  * and so on, we use __leXX unless that's not practical.
  13  */
  14 #define __hc32  __le32
  15 #define __hc16  __le16
  16
  17 /* statistics can be kept for tuning/monitoring */
  18 struct fusbh200_stats {
  19         /* irq usage */
  20         unsigned long           normal;
  21         unsigned long           error;
  22         unsigned long           iaa;
  23         unsigned long           lost_iaa;
  24
  25         /* termination of urbs from core */
  26         unsigned long           complete;
  27         unsigned long           unlink;
  28 };
  29
  30 /* fusbh200_hcd->lock guards shared data against other CPUs:
  31  *   fusbh200_hcd:      async, unlink, periodic (and shadow), ...
  32  *   usb_host_endpoint: hcpriv
  33  *   fusbh200_qh:       qh_next, qtd_list
  34  *   fusbh200_qtd:      qtd_list
  35  *
  36  * Also, hold this lock when talking to HC registers or
  37  * when updating hw_* fields in shared qh/qtd/... structures.
  38  */
  39
  40 #define FUSBH200_MAX_ROOT_PORTS 1               /* see HCS_N_PORTS */
  41
  42 /*
  43  * fusbh200_rh_state values of FUSBH200_RH_RUNNING or above mean that the
  44  * controller may be doing DMA.  Lower values mean there's no DMA.
  45  */
  46 enum fusbh200_rh_state {
  47         FUSBH200_RH_HALTED,
  48         FUSBH200_RH_SUSPENDED,
  49         FUSBH200_RH_RUNNING,
  50         FUSBH200_RH_STOPPING
  51 };
  52
  53 /*
  54  * Timer events, ordered by increasing delay length.
  55  * Always update event_delays_ns[] and event_handlers[] (defined in
  56  * ehci-timer.c) in parallel with this list.
  57  */
  58 enum fusbh200_hrtimer_event {
  59         FUSBH200_HRTIMER_POLL_ASS,              /* Poll for async schedule off */
  60         FUSBH200_HRTIMER_POLL_PSS,              /* Poll for periodic schedule off */
  61         FUSBH200_HRTIMER_POLL_DEAD,             /* Wait for dead controller to stop */
  62         FUSBH200_HRTIMER_UNLINK_INTR,   /* Wait for interrupt QH unlink */
  63         FUSBH200_HRTIMER_FREE_ITDS,             /* Wait for unused iTDs and siTDs */
  64         FUSBH200_HRTIMER_ASYNC_UNLINKS, /* Unlink empty async QHs */
  65         FUSBH200_HRTIMER_IAA_WATCHDOG,  /* Handle lost IAA interrupts */
  66         FUSBH200_HRTIMER_DISABLE_PERIODIC,      /* Wait to disable periodic sched */
  67         FUSBH200_HRTIMER_DISABLE_ASYNC, /* Wait to disable async sched */
  68         FUSBH200_HRTIMER_IO_WATCHDOG,   /* Check for missing IRQs */
  69         FUSBH200_HRTIMER_NUM_EVENTS             /* Must come last */
  70 };
  71 #define FUSBH200_HRTIMER_NO_EVENT       99
  72
  73 struct fusbh200_hcd {                   /* one per controller */
  74         /* timing support */
  75         enum fusbh200_hrtimer_event     next_hrtimer_event;
  76         unsigned                enabled_hrtimer_events;
  77         ktime_t                 hr_timeouts[FUSBH200_HRTIMER_NUM_EVENTS];
  78         struct hrtimer          hrtimer;
  79
  80         int                     PSS_poll_count;
  81         int                     ASS_poll_count;
  82         int                     died_poll_count;
  83
  84         /* glue to PCI and HCD framework */
  85         struct fusbh200_caps __iomem *caps;
  86         struct fusbh200_regs __iomem *regs;
  87         struct fusbh200_dbg_port __iomem *debug;
  88
  89         __u32                   hcs_params;     /* cached register copy */
  90         spinlock_t              lock;
  91         enum fusbh200_rh_state  rh_state;
  92
  93         /* general schedule support */
  94         bool                    scanning:1;
  95         bool                    need_rescan:1;
  96         bool                    intr_unlinking:1;
  97         bool                    async_unlinking:1;
  98         bool                    shutdown:1;
  99         struct fusbh200_qh              *qh_scan_next;
 100
 101         /* async schedule support */
 102         struct fusbh200_qh              *async;
 103         struct fusbh200_qh              *dummy;         /* For AMD quirk use */
 104         struct fusbh200_qh              *async_unlink;
 105         struct fusbh200_qh              *async_unlink_last;
 106         struct fusbh200_qh              *async_iaa;
 107         unsigned                async_unlink_cycle;
 108         unsigned                async_count;    /* async activity count */
 109
 110         /* periodic schedule support */
 111 #define DEFAULT_I_TDPS          1024            /* some HCs can do less */
 112         unsigned                periodic_size;
 113         __hc32                  *periodic;      /* hw periodic table */
 114         dma_addr_t              periodic_dma;
 115         struct list_head        intr_qh_list;
 116         unsigned                i_thresh;       /* uframes HC might cache */
 117
 118         union fusbh200_shadow   *pshadow;       /* mirror hw periodic table */
 119         struct fusbh200_qh              *intr_unlink;
 120         struct fusbh200_qh              *intr_unlink_last;
 121         unsigned                intr_unlink_cycle;
 122         unsigned                now_frame;      /* frame from HC hardware */
 123         unsigned                next_frame;     /* scan periodic, start here */
 124         unsigned                intr_count;     /* intr activity count */
 125         unsigned                isoc_count;     /* isoc activity count */
 126         unsigned                periodic_count; /* periodic activity count */
 127         unsigned                uframe_periodic_max; /* max periodic time per uframe */
 128
 129
 130         /* list of itds completed while now_frame was still active */
 131         struct list_head        cached_itd_list;
 132         struct fusbh200_itd     *last_itd_to_free;
 133
 134         /* per root hub port */
 135         unsigned long           reset_done [FUSBH200_MAX_ROOT_PORTS];
 136
 137         /* bit vectors (one bit per port) */
 138         unsigned long           bus_suspended;          /* which ports were
 139                         already suspended at the start of a bus suspend */
 140         unsigned long           companion_ports;        /* which ports are
 141                         dedicated to the companion controller */
 142         unsigned long           owned_ports;            /* which ports are
 143                         owned by the companion during a bus suspend */
 144         unsigned long           port_c_suspend;         /* which ports have
 145                         the change-suspend feature turned on */
 146         unsigned long           suspended_ports;        /* which ports are
 147                         suspended */
 148         unsigned long           resuming_ports;         /* which ports have
 149                         started to resume */
 150
 151         /* per-HC memory pools (could be per-bus, but ...) */
 152         struct dma_pool         *qh_pool;       /* qh per active urb */
 153         struct dma_pool         *qtd_pool;      /* one or more per qh */
 154         struct dma_pool         *itd_pool;      /* itd per iso urb */
 155
 156         unsigned                random_frame;
 157         unsigned long           next_statechange;
 158         ktime_t                 last_periodic_enable;
 159         u32                     command;
 160
 161         /* SILICON QUIRKS */
 162         unsigned                need_io_watchdog:1;
 163         unsigned                fs_i_thresh:1;  /* Intel iso scheduling */
 164
 165         u8                      sbrn;           /* packed release number */
 166
 167         /* irq statistics */
 168 #ifdef FUSBH200_STATS
 169         struct fusbh200_stats   stats;
 170 #       define COUNT(x) do { (x)++; } while (0)
 171 #else
 172 #       define COUNT(x) do {} while (0)
 173 #endif
 174
 175         /* debug files */
 176         struct dentry           *debug_dir;
 177 };
 178
 179 /* convert between an HCD pointer and the corresponding FUSBH200_HCD */
 180 static inline struct fusbh200_hcd *hcd_to_fusbh200 (struct usb_hcd *hcd)
 181 {
 182         return (struct fusbh200_hcd *) (hcd->hcd_priv);
 183 }
 184 static inline struct usb_hcd *fusbh200_to_hcd (struct fusbh200_hcd *fusbh200)
 185 {
 186         return container_of ((void *) fusbh200, struct usb_hcd, hcd_priv);
 187 }
 188
 189 /*-------------------------------------------------------------------------*/
 190
 191 /* EHCI register interface, corresponds to EHCI Revision 0.95 specification */
 192
 193 /* Section 2.2 Host Controller Capability Registers */
 194 struct fusbh200_caps {
 195         /* these fields are specified as 8 and 16 bit registers,
 196          * but some hosts can't perform 8 or 16 bit PCI accesses.
 197          * some hosts treat caplength and hciversion as parts of a 32-bit
 198          * register, others treat them as two separate registers, this
 199          * affects the memory map for big endian controllers.
 200          */
 201         u32             hc_capbase;
 202 #define HC_LENGTH(fusbh200, p)  (0x00ff&((p) >> /* bits 7:0 / offset 00h */ \
 203                                 (fusbh200_big_endian_capbase(fusbh200) ? 24 : 0)))
 204 #define HC_VERSION(fusbh200, p) (0xffff&((p) >> /* bits 31:16 / offset 02h */ \
 205                                 (fusbh200_big_endian_capbase(fusbh200) ? 0 : 16)))
 206         u32             hcs_params;     /* HCSPARAMS - offset 0x4 */
 207 #define HCS_N_PORTS(p)          (((p)>>0)&0xf)  /* bits 3:0, ports on HC */
 208
 209         u32             hcc_params;      /* HCCPARAMS - offset 0x8 */
 210 #define HCC_CANPARK(p)          ((p)&(1 << 2))  /* true: can park on async qh */
 211 #define HCC_PGM_FRAMELISTLEN(p) ((p)&(1 << 1))  /* true: periodic_size changes*/
 212         u8              portroute[8];    /* nibbles for routing - offset 0xC */
 213 };
 214
 215
 216 /* Section 2.3 Host Controller Operational Registers */
 217 struct fusbh200_regs {
 218
 219         /* USBCMD: offset 0x00 */
 220         u32             command;
 221
 222 /* EHCI 1.1 addendum */
 223 /* 23:16 is r/w intr rate, in microframes; default "8" == 1/msec */
 224 #define CMD_PARK        (1<<11)         /* enable "park" on async qh */
 225 #define CMD_PARK_CNT(c) (((c)>>8)&3)    /* how many transfers to park for */
 226 #define CMD_IAAD        (1<<6)          /* "doorbell" interrupt async advance */
 227 #define CMD_ASE         (1<<5)          /* async schedule enable */
 228 #define CMD_PSE         (1<<4)          /* periodic schedule enable */
 229 /* 3:2 is periodic frame list size */
 230 #define CMD_RESET       (1<<1)          /* reset HC not bus */
 231 #define CMD_RUN         (1<<0)          /* start/stop HC */
 232
 233         /* USBSTS: offset 0x04 */
 234         u32             status;
 235 #define STS_ASS         (1<<15)         /* Async Schedule Status */
 236 #define STS_PSS         (1<<14)         /* Periodic Schedule Status */
 237 #define STS_RECL        (1<<13)         /* Reclamation */
 238 #define STS_HALT        (1<<12)         /* Not running (any reason) */
 239 /* some bits reserved */
 240         /* these STS_* flags are also intr_enable bits (USBINTR) */
 241 #define STS_IAA         (1<<5)          /* Interrupted on async advance */
 242 #define STS_FATAL       (1<<4)          /* such as some PCI access errors */
 243 #define STS_FLR         (1<<3)          /* frame list rolled over */
 244 #define STS_PCD         (1<<2)          /* port change detect */
 245 #define STS_ERR         (1<<1)          /* "error" completion (overflow, ...) */
 246 #define STS_INT         (1<<0)          /* "normal" completion (short, ...) */
 247
 248         /* USBINTR: offset 0x08 */
 249         u32             intr_enable;
 250
 251         /* FRINDEX: offset 0x0C */
 252         u32             frame_index;    /* current microframe number */
 253         /* CTRLDSSEGMENT: offset 0x10 */
 254         u32             segment;        /* address bits 63:32 if needed */
 255         /* PERIODICLISTBASE: offset 0x14 */
 256         u32             frame_list;     /* points to periodic list */
 257         /* ASYNCLISTADDR: offset 0x18 */
 258         u32             async_next;     /* address of next async queue head */
 259
 260         u32     reserved1;
 261         /* PORTSC: offset 0x20 */
 262         u32     port_status;
 263 /* 31:23 reserved */
 264 #define PORT_USB11(x) (((x)&(3<<10)) == (1<<10))        /* USB 1.1 device */
 265 #define PORT_RESET      (1<<8)          /* reset port */
 266 #define PORT_SUSPEND    (1<<7)          /* suspend port */
 267 #define PORT_RESUME     (1<<6)          /* resume it */
 268 #define PORT_PEC        (1<<3)          /* port enable change */
 269 #define PORT_PE         (1<<2)          /* port enable */
 270 #define PORT_CSC        (1<<1)          /* connect status change */
 271 #define PORT_CONNECT    (1<<0)          /* device connected */
 272 #define PORT_RWC_BITS   (PORT_CSC | PORT_PEC)
 273
 274         u32     reserved2[3];
 275
 276         /* BMCSR: offset 0x30 */
 277         u32     bmcsr; /* Bus Moniter Control/Status Register */
 278 #define BMCSR_HOST_SPD_TYP      (3<<9)
 279 #define BMCSR_VBUS_OFF          (1<<4)
 280 #define BMCSR_INT_POLARITY      (1<<3)
 281
 282         /* BMISR: offset 0x34 */
 283         u32     bmisr; /* Bus Moniter Interrupt Status Register*/
 284 #define BMISR_OVC               (1<<1)
 285
 286         /* BMIER: offset 0x38 */
 287         u32     bmier; /* Bus Moniter Interrupt Enable Register */
 288 #define BMIER_OVC_EN            (1<<1)
 289 #define BMIER_VBUS_ERR_EN       (1<<0)
 290 };
 291
 292 /* Appendix C, Debug port ... intended for use with special "debug devices"
 293  * that can help if there's no serial console.  (nonstandard enumeration.)
 294  */
 295 struct fusbh200_dbg_port {
 296         u32     control;
 297 #define DBGP_OWNER      (1<<30)
 298 #define DBGP_ENABLED    (1<<28)
 299 #define DBGP_DONE       (1<<16)
 300 #define DBGP_INUSE      (1<<10)
 301 #define DBGP_ERRCODE(x) (((x)>>7)&0x07)
 302 #       define DBGP_ERR_BAD     1
 303 #       define DBGP_ERR_SIGNAL  2
 304 #define DBGP_ERROR      (1<<6)
 305 #define DBGP_GO         (1<<5)
 306 #define DBGP_OUT        (1<<4)
 307 #define DBGP_LEN(x)     (((x)>>0)&0x0f)
 308         u32     pids;
 309 #define DBGP_PID_GET(x)         (((x)>>16)&0xff)
 310 #define DBGP_PID_SET(data, tok) (((data)<<8)|(tok))
 311         u32     data03;
 312         u32     data47;
 313         u32     address;
 314 #define DBGP_EPADDR(dev, ep)    (((dev)<<8)|(ep))
 315 };
 316
 317 #ifdef CONFIG_EARLY_PRINTK_DBGP
 318 #include <linux/init.h>
 319 extern int __init early_dbgp_init(char *s);
 320 extern struct console early_dbgp_console;
 321 #endif /* CONFIG_EARLY_PRINTK_DBGP */
 322
 323 struct usb_hcd;
 324
 325 static inline int xen_dbgp_reset_prep(struct usb_hcd *hcd)
 326 {
 327         return 1; /* Shouldn't this be 0? */
 328 }
 329
 330 static inline int xen_dbgp_external_startup(struct usb_hcd *hcd)
 331 {
 332         return -1;
 333 }
 334
 335 #ifdef CONFIG_EARLY_PRINTK_DBGP
 336 /* Call backs from fusbh200 host driver to fusbh200 debug driver */
 337 extern int dbgp_external_startup(struct usb_hcd *);
 338 extern int dbgp_reset_prep(struct usb_hcd *hcd);
 339 #else
 340 static inline int dbgp_reset_prep(struct usb_hcd *hcd)
 341 {
 342         return xen_dbgp_reset_prep(hcd);
 343 }
 344 static inline int dbgp_external_startup(struct usb_hcd *hcd)
 345 {
 346         return xen_dbgp_external_startup(hcd);
 347 }
 348 #endif
 349
 350 /*-------------------------------------------------------------------------*/
 351
 352 #define QTD_NEXT(fusbh200, dma) cpu_to_hc32(fusbh200, (u32)dma)
 353
 354 /*
 355  * EHCI Specification 0.95 Section 3.5
 356  * QTD: describe data transfer components (buffer, direction, ...)
 357  * See Fig 3-6 "Queue Element Transfer Descriptor Block Diagram".
 358  *
 359  * These are associated only with "QH" (Queue Head) structures,
 360  * used with control, bulk, and interrupt transfers.
 361  */
 362 struct fusbh200_qtd {
 363         /* first part defined by EHCI spec */
 364         __hc32                  hw_next;        /* see EHCI 3.5.1 */
 365         __hc32                  hw_alt_next;    /* see EHCI 3.5.2 */
 366         __hc32                  hw_token;       /* see EHCI 3.5.3 */
 367 #define QTD_TOGGLE      (1 << 31)       /* data toggle */
 368 #define QTD_LENGTH(tok) (((tok)>>16) & 0x7fff)
 369 #define QTD_IOC         (1 << 15)       /* interrupt on complete */
 370 #define QTD_CERR(tok)   (((tok)>>10) & 0x3)
 371 #define QTD_PID(tok)    (((tok)>>8) & 0x3)
 372 #define QTD_STS_ACTIVE  (1 << 7)        /* HC may execute this */
 373 #define QTD_STS_HALT    (1 << 6)        /* halted on error */
 374 #define QTD_STS_DBE     (1 << 5)        /* data buffer error (in HC) */
 375 #define QTD_STS_BABBLE  (1 << 4)        /* device was babbling (qtd halted) */
 376 #define QTD_STS_XACT    (1 << 3)        /* device gave illegal response */
 377 #define QTD_STS_MMF     (1 << 2)        /* incomplete split transaction */
 378 #define QTD_STS_STS     (1 << 1)        /* split transaction state */
 379 #define QTD_STS_PING    (1 << 0)        /* issue PING? */
 380
 381 #define ACTIVE_BIT(fusbh200)    cpu_to_hc32(fusbh200, QTD_STS_ACTIVE)
 382 #define HALT_BIT(fusbh200)              cpu_to_hc32(fusbh200, QTD_STS_HALT)
 383 #define STATUS_BIT(fusbh200)    cpu_to_hc32(fusbh200, QTD_STS_STS)
 384
 385         __hc32                  hw_buf [5];        /* see EHCI 3.5.4 */
 386         __hc32                  hw_buf_hi [5];        /* Appendix B */
 387
 388         /* the rest is HCD-private */
 389         dma_addr_t              qtd_dma;                /* qtd address */
 390         struct list_head        qtd_list;               /* sw qtd list */
 391         struct urb              *urb;                   /* qtd's urb */
 392         size_t                  length;                 /* length of buffer */
 393 } __attribute__ ((aligned (32)));
 394
 395 /* mask NakCnt+T in qh->hw_alt_next */
 396 #define QTD_MASK(fusbh200)      cpu_to_hc32 (fusbh200, ~0x1f)
 397
 398 #define IS_SHORT_READ(token) (QTD_LENGTH (token) != 0 && QTD_PID (token) == 1)
 399
 400 /*-------------------------------------------------------------------------*/
 401
 402 /* type tag from {qh,itd,fstn}->hw_next */
 403 #define Q_NEXT_TYPE(fusbh200,dma)       ((dma) & cpu_to_hc32(fusbh200, 3 << 1))
 404
 405 /*
 406  * Now the following defines are not converted using the
 407  * cpu_to_le32() macro anymore, since we have to support
 408  * "dynamic" switching between be and le support, so that the driver
 409  * can be used on one system with SoC EHCI controller using big-endian
 410  * descriptors as well as a normal little-endian PCI EHCI controller.
 411  */
 412 /* values for that type tag */
 413 #define Q_TYPE_ITD      (0 << 1)
 414 #define Q_TYPE_QH       (1 << 1)
 415 #define Q_TYPE_SITD     (2 << 1)
 416 #define Q_TYPE_FSTN     (3 << 1)
 417
 418 /* next async queue entry, or pointer to interrupt/periodic QH */
 419 #define QH_NEXT(fusbh200,dma)   (cpu_to_hc32(fusbh200, (((u32)dma)&~0x01f)|Q_TYPE_QH))
 420
 421 /* for periodic/async schedules and qtd lists, mark end of list */
 422 #define FUSBH200_LIST_END(fusbh200)     cpu_to_hc32(fusbh200, 1) /* "null pointer" to hw */
 423
 424 /*
 425  * Entries in periodic shadow table are pointers to one of four kinds
 426  * of data structure.  That's dictated by the hardware; a type tag is
 427  * encoded in the low bits of the hardware's periodic schedule.  Use
 428  * Q_NEXT_TYPE to get the tag.
 429  *
 430  * For entries in the async schedule, the type tag always says "qh".
 431  */
 432 union fusbh200_shadow {
 433         struct fusbh200_qh      *qh;            /* Q_TYPE_QH */
 434         struct fusbh200_itd     *itd;           /* Q_TYPE_ITD */
 435         struct fusbh200_fstn    *fstn;          /* Q_TYPE_FSTN */
 436         __hc32                  *hw_next;       /* (all types) */
 437         void                    *ptr;
 438 };
 439
 440 /*-------------------------------------------------------------------------*/
 441
 442 /*
 443  * EHCI Specification 0.95 Section 3.6
 444  * QH: describes control/bulk/interrupt endpoints
 445  * See Fig 3-7 "Queue Head Structure Layout".
 446  *
 447  * These appear in both the async and (for interrupt) periodic schedules.
 448  */
 449
 450 /* first part defined by EHCI spec */
 451 struct fusbh200_qh_hw {
 452         __hc32                  hw_next;        /* see EHCI 3.6.1 */
 453         __hc32                  hw_info1;       /* see EHCI 3.6.2 */
 454 #define QH_CONTROL_EP   (1 << 27)       /* FS/LS control endpoint */
 455 #define QH_HEAD         (1 << 15)       /* Head of async reclamation list */
 456 #define QH_TOGGLE_CTL   (1 << 14)       /* Data toggle control */
 457 #define QH_HIGH_SPEED   (2 << 12)       /* Endpoint speed */
 458 #define QH_LOW_SPEED    (1 << 12)
 459 #define QH_FULL_SPEED   (0 << 12)
 460 #define QH_INACTIVATE   (1 << 7)        /* Inactivate on next transaction */
 461         __hc32                  hw_info2;        /* see EHCI 3.6.2 */
 462 #define QH_SMASK        0x000000ff
 463 #define QH_CMASK        0x0000ff00
 464 #define QH_HUBADDR      0x007f0000
 465 #define QH_HUBPORT      0x3f800000
 466 #define QH_MULT         0xc0000000
 467         __hc32                  hw_current;     /* qtd list - see EHCI 3.6.4 */
 468
 469         /* qtd overlay (hardware parts of a struct fusbh200_qtd) */
 470         __hc32                  hw_qtd_next;
 471         __hc32                  hw_alt_next;
 472         __hc32                  hw_token;
 473         __hc32                  hw_buf [5];
 474         __hc32                  hw_buf_hi [5];
 475 } __attribute__ ((aligned(32)));
 476
 477 struct fusbh200_qh {
 478         struct fusbh200_qh_hw   *hw;            /* Must come first */
 479         /* the rest is HCD-private */
 480         dma_addr_t              qh_dma;         /* address of qh */
 481         union fusbh200_shadow   qh_next;        /* ptr to qh; or periodic */
 482         struct list_head        qtd_list;       /* sw qtd list */
 483         struct list_head        intr_node;      /* list of intr QHs */
 484         struct fusbh200_qtd             *dummy;
 485         struct fusbh200_qh              *unlink_next;   /* next on unlink list */
 486
 487         unsigned                unlink_cycle;
 488
 489         u8                      needs_rescan;   /* Dequeue during giveback */
 490         u8                      qh_state;
 491 #define QH_STATE_LINKED         1               /* HC sees this */
 492 #define QH_STATE_UNLINK         2               /* HC may still see this */
 493 #define QH_STATE_IDLE           3               /* HC doesn't see this */
 494 #define QH_STATE_UNLINK_WAIT    4               /* LINKED and on unlink q */
 495 #define QH_STATE_COMPLETING     5               /* don't touch token.HALT */
 496
 497         u8                      xacterrs;       /* XactErr retry counter */
 498 #define QH_XACTERR_MAX          32              /* XactErr retry limit */
 499
 500         /* periodic schedule info */
 501         u8                      usecs;          /* intr bandwidth */
 502         u8                      gap_uf;         /* uframes split/csplit gap */
 503         u8                      c_usecs;        /* ... split completion bw */
 504         u16                     tt_usecs;       /* tt downstream bandwidth */
 505         unsigned short          period;         /* polling interval */
 506         unsigned short          start;          /* where polling starts */
 507 #define NO_FRAME ((unsigned short)~0)                   /* pick new start */
 508
 509         struct usb_device       *dev;           /* access to TT */
 510         unsigned                is_out:1;       /* bulk or intr OUT */
 511         unsigned                clearing_tt:1;  /* Clear-TT-Buf in progress */
 512 };
 513
 514 /*-------------------------------------------------------------------------*/
 515
 516 /* description of one iso transaction (up to 3 KB data if highspeed) */
 517 struct fusbh200_iso_packet {
 518         /* These will be copied to iTD when scheduling */
 519         u64                     bufp;           /* itd->hw_bufp{,_hi}[pg] |= */
 520         __hc32                  transaction;    /* itd->hw_transaction[i] |= */
 521         u8                      cross;          /* buf crosses pages */
 522         /* for full speed OUT splits */
 523         u32                     buf1;
 524 };
 525
 526 /* temporary schedule data for packets from iso urbs (both speeds)
 527  * each packet is one logical usb transaction to the device (not TT),
 528  * beginning at stream->next_uframe
 529  */
 530 struct fusbh200_iso_sched {
 531         struct list_head        td_list;
 532         unsigned                span;
 533         struct fusbh200_iso_packet      packet [0];
 534 };
 535
 536 /*
 537  * fusbh200_iso_stream - groups all (s)itds for this endpoint.
 538  * acts like a qh would, if EHCI had them for ISO.
 539  */
 540 struct fusbh200_iso_stream {
 541         /* first field matches fusbh200_hq, but is NULL */
 542         struct fusbh200_qh_hw   *hw;
 543
 544         u8                      bEndpointAddress;
 545         u8                      highspeed;
 546         struct list_head        td_list;        /* queued itds */
 547         struct list_head        free_list;      /* list of unused itds */
 548         struct usb_device       *udev;
 549         struct usb_host_endpoint *ep;
 550
 551         /* output of (re)scheduling */
 552         int                     next_uframe;
 553         __hc32                  splits;
 554
 555         /* the rest is derived from the endpoint descriptor,
 556          * trusting urb->interval == f(epdesc->bInterval) and
 557          * including the extra info for hw_bufp[0..2]
 558          */
 559         u8                      usecs, c_usecs;
 560         u16                     interval;
 561         u16                     tt_usecs;
 562         u16                     maxp;
 563         u16                     raw_mask;
 564         unsigned                bandwidth;
 565
 566         /* This is used to initialize iTD's hw_bufp fields */
 567         __hc32                  buf0;
 568         __hc32                  buf1;
 569         __hc32                  buf2;
 570
 571         /* this is used to initialize sITD's tt info */
 572         __hc32                  address;
 573 };
 574
 575 /*-------------------------------------------------------------------------*/
 576
 577 /*
 578  * EHCI Specification 0.95 Section 3.3
 579  * Fig 3-4 "Isochronous Transaction Descriptor (iTD)"
 580  *
 581  * Schedule records for high speed iso xfers
 582  */
 583 struct fusbh200_itd {
 584         /* first part defined by EHCI spec */
 585         __hc32                  hw_next;           /* see EHCI 3.3.1 */
 586         __hc32                  hw_transaction [8]; /* see EHCI 3.3.2 */
 587 #define FUSBH200_ISOC_ACTIVE        (1<<31)        /* activate transfer this slot */
 588 #define FUSBH200_ISOC_BUF_ERR       (1<<30)        /* Data buffer error */
 589 #define FUSBH200_ISOC_BABBLE        (1<<29)        /* babble detected */
 590 #define FUSBH200_ISOC_XACTERR       (1<<28)        /* XactErr - transaction error */
 591 #define FUSBH200_ITD_LENGTH(tok)        (((tok)>>16) & 0x0fff)
 592 #define FUSBH200_ITD_IOC                (1 << 15)       /* interrupt on complete */
 593
 594 #define ITD_ACTIVE(fusbh200)    cpu_to_hc32(fusbh200, FUSBH200_ISOC_ACTIVE)
 595
 596         __hc32                  hw_bufp [7];    /* see EHCI 3.3.3 */
 597         __hc32                  hw_bufp_hi [7]; /* Appendix B */
 598
 599         /* the rest is HCD-private */
 600         dma_addr_t              itd_dma;        /* for this itd */
 601         union fusbh200_shadow   itd_next;       /* ptr to periodic q entry */
 602
 603         struct urb              *urb;
 604         struct fusbh200_iso_stream      *stream;        /* endpoint's queue */
 605         struct list_head        itd_list;       /* list of stream's itds */
 606
 607         /* any/all hw_transactions here may be used by that urb */
 608         unsigned                frame;          /* where scheduled */
 609         unsigned                pg;
 610         unsigned                index[8];       /* in urb->iso_frame_desc */
 611 } __attribute__ ((aligned (32)));
 612
 613 /*-------------------------------------------------------------------------*/
 614
 615 /*
 616  * EHCI Specification 0.96 Section 3.7
 617  * Periodic Frame Span Traversal Node (FSTN)
 618  *
 619  * Manages split interrupt transactions (using TT) that span frame boundaries
 620  * into uframes 0/1; see 4.12.2.2.  In those uframes, a "save place" FSTN
 621  * makes the HC jump (back) to a QH to scan for fs/ls QH completions until
 622  * it hits a "restore" FSTN; then it returns to finish other uframe 0/1 work.
 623  */
 624 struct fusbh200_fstn {
 625         __hc32                  hw_next;        /* any periodic q entry */
 626         __hc32                  hw_prev;        /* qh or FUSBH200_LIST_END */
 627
 628         /* the rest is HCD-private */
 629         dma_addr_t              fstn_dma;
 630         union fusbh200_shadow   fstn_next;      /* ptr to periodic q entry */
 631 } __attribute__ ((aligned (32)));
 632
 633 /*-------------------------------------------------------------------------*/
 634
 635 /* Prepare the PORTSC wakeup flags during controller suspend/resume */
 636
 637 #define fusbh200_prepare_ports_for_controller_suspend(fusbh200, do_wakeup)      \
 638                 fusbh200_adjust_port_wakeup_flags(fusbh200, true, do_wakeup);
 639
 640 #define fusbh200_prepare_ports_for_controller_resume(fusbh200)                  \
 641                 fusbh200_adjust_port_wakeup_flags(fusbh200, false, false);
 642
 643 /*-------------------------------------------------------------------------*/
 644
 645 /*
 646  * Some EHCI controllers have a Transaction Translator built into the
 647  * root hub. This is a non-standard feature.  Each controller will need
 648  * to add code to the following inline functions, and call them as
 649  * needed (mostly in root hub code).
 650  */
 651
 652 static inline unsigned int
 653 fusbh200_get_speed(struct fusbh200_hcd *fusbh200, unsigned int portsc)
 654 {
 655         return (readl(&fusbh200->regs->bmcsr)
 656                 & BMCSR_HOST_SPD_TYP) >> 9;
 657 }
 658
 659 /* Returns the speed of a device attached to a port on the root hub. */
 660 static inline unsigned int
 661 fusbh200_port_speed(struct fusbh200_hcd *fusbh200, unsigned int portsc)
 662 {
 663         switch (fusbh200_get_speed(fusbh200, portsc)) {
 664         case 0:
 665                 return 0;
 666         case 1:
 667                 return USB_PORT_STAT_LOW_SPEED;
 668         case 2:
 669         default:
 670                 return USB_PORT_STAT_HIGH_SPEED;
 671         }
 672 }
 673
 674 /*-------------------------------------------------------------------------*/
 675
 676 #define fusbh200_has_fsl_portno_bug(e)          (0)
 677
 678 /*
 679  * While most USB host controllers implement their registers in
 680  * little-endian format, a minority (celleb companion chip) implement
 681  * them in big endian format.
 682  *
 683  * This attempts to support either format at compile time without a
 684  * runtime penalty, or both formats with the additional overhead
 685  * of checking a flag bit.
 686  *
 687  */
 688
 689 #define fusbh200_big_endian_mmio(e)     0
 690 #define fusbh200_big_endian_capbase(e)  0
 691
 692 static inline unsigned int fusbh200_readl(const struct fusbh200_hcd *fusbh200,
 693                 __u32 __iomem * regs)
 694 {
 695         return readl(regs);
 696 }
 697
 698 static inline void fusbh200_writel(const struct fusbh200_hcd *fusbh200,
 699                 const unsigned int val, __u32 __iomem *regs)
 700 {
 701         writel(val, regs);
 702 }
 703
 704 /* cpu to fusbh200 */
 705 static inline __hc32 cpu_to_hc32 (const struct fusbh200_hcd *fusbh200, const u32 x)
 706 {
 707         return cpu_to_le32(x);
 708 }
 709
 710 /* fusbh200 to cpu */
 711 static inline u32 hc32_to_cpu (const struct fusbh200_hcd *fusbh200, const __hc32 x)
 712 {
 713         return le32_to_cpu(x);
 714 }
 715
 716 static inline u32 hc32_to_cpup (const struct fusbh200_hcd *fusbh200, const __hc32 *x)
 717 {
 718         return le32_to_cpup(x);
 719 }
 720
 721 /*-------------------------------------------------------------------------*/
 722
 723 static inline unsigned fusbh200_read_frame_index(struct fusbh200_hcd *fusbh200)
 724 {
 725         return fusbh200_readl(fusbh200, &fusbh200->regs->frame_index);
 726 }
 727
 728 #define fusbh200_itdlen(urb, desc, t) ({                        \
 729         usb_pipein((urb)->pipe) ?                               \
 730         (desc)->length - FUSBH200_ITD_LENGTH(t) :                       \
 731         FUSBH200_ITD_LENGTH(t);                                 \
 732 })
 733 /*-------------------------------------------------------------------------*/
 734
 735 #endif /* __LINUX_FUSBH200_H */