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