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