drivers/usb/host/ehci-hcd.c

   1 /*
   2  * Enhanced Host Controller Interface (EHCI) driver for USB.
   3  *
   4  * Maintainer: Alan Stern <stern@rowland.harvard.edu>
   5  *
   6  * Copyright (c) 2000-2004 by David Brownell
   7  *
   8  * This program is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU General Public License as published by the
  10  * Free Software Foundation; either version 2 of the License, or (at your
  11  * option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  15  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  16  * for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software Foundation,
  20  * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21  */
  22
  23 #include <linux/module.h>
  24 #include <linux/pci.h>
  25 #include <linux/dmapool.h>
  26 #include <linux/kernel.h>
  27 #include <linux/delay.h>
  28 #include <linux/ioport.h>
  29 #include <linux/sched.h>
  30 #include <linux/vmalloc.h>
  31 #include <linux/errno.h>
  32 #include <linux/init.h>
  33 #include <linux/hrtimer.h>
  34 #include <linux/list.h>
  35 #include <linux/interrupt.h>
  36 #include <linux/usb.h>
  37 #include <linux/usb/hcd.h>
  38 #include <linux/usb/otg.h>
  39 #include <linux/moduleparam.h>
  40 #include <linux/dma-mapping.h>
  41 #include <linux/debugfs.h>
  42 #include <linux/slab.h>
  43
  44 #include <asm/byteorder.h>
  45 #include <asm/io.h>
  46 #include <asm/irq.h>
  47 #include <asm/unaligned.h>
  48
  49 #if defined(CONFIG_PPC_PS3)
  50 #include <asm/firmware.h>
  51 #endif
  52
  53 /*-------------------------------------------------------------------------*/
  54
  55 /*
  56  * EHCI hc_driver implementation ... experimental, incomplete.
  57  * Based on the final 1.0 register interface specification.
  58  *
  59  * USB 2.0 shows up in upcoming www.pcmcia.org technology.
  60  * First was PCMCIA, like ISA; then CardBus, which is PCI.
  61  * Next comes "CardBay", using USB 2.0 signals.
  62  *
  63  * Contains additional contributions by Brad Hards, Rory Bolt, and others.
  64  * Special thanks to Intel and VIA for providing host controllers to
  65  * test this driver on, and Cypress (including In-System Design) for
  66  * providing early devices for those host controllers to talk to!
  67  */
  68
  69 #define DRIVER_AUTHOR "David Brownell"
  70 #define DRIVER_DESC "USB 2.0 'Enhanced' Host Controller (EHCI) Driver"
  71
  72 static const char       hcd_name [] = "ehci_hcd";
  73
  74
  75 #undef EHCI_URB_TRACE
  76
  77 /* magic numbers that can affect system performance */
  78 #define EHCI_TUNE_CERR          3       /* 0-3 qtd retries; 0 == don't stop */
  79 #define EHCI_TUNE_RL_HS         4       /* nak throttle; see 4.9 */
  80 #define EHCI_TUNE_RL_TT         0
  81 #define EHCI_TUNE_MULT_HS       1       /* 1-3 transactions/uframe; 4.10.3 */
  82 #define EHCI_TUNE_MULT_TT       1
  83 /*
  84  * Some drivers think it's safe to schedule isochronous transfers more than
  85  * 256 ms into the future (partly as a result of an old bug in the scheduling
  86  * code).  In an attempt to avoid trouble, we will use a minimum scheduling
  87  * length of 512 frames instead of 256.
  88  */
  89 #define EHCI_TUNE_FLS           1       /* (medium) 512-frame schedule */
  90
  91 /* Initial IRQ latency:  faster than hw default */
  92 static int log2_irq_thresh = 0;         // 0 to 6
  93 module_param (log2_irq_thresh, int, S_IRUGO);
  94 MODULE_PARM_DESC (log2_irq_thresh, "log2 IRQ latency, 1-64 microframes");
  95
  96 /* initial park setting:  slower than hw default */
  97 static unsigned park = 0;
  98 module_param (park, uint, S_IRUGO);
  99 MODULE_PARM_DESC (park, "park setting; 1-3 back-to-back async packets");
 100
 101 /* for flakey hardware, ignore overcurrent indicators */
 102 static bool ignore_oc;
 103 module_param (ignore_oc, bool, S_IRUGO);
 104 MODULE_PARM_DESC (ignore_oc, "ignore bogus hardware overcurrent indications");
 105
 106 #define INTR_MASK (STS_IAA | STS_FATAL | STS_PCD | STS_ERR | STS_INT)
 107
 108 /*-------------------------------------------------------------------------*/
 109
 110 #include "ehci.h"
 111 #include "pci-quirks.h"
 112
 113 static void compute_tt_budget(u8 budget_table[EHCI_BANDWIDTH_SIZE],
 114                 struct ehci_tt *tt);
 115
 116 /*
 117  * The MosChip MCS9990 controller updates its microframe counter
 118  * a little before the frame counter, and occasionally we will read
 119  * the invalid intermediate value.  Avoid problems by checking the
 120  * microframe number (the low-order 3 bits); if they are 0 then
 121  * re-read the register to get the correct value.
 122  */
 123 static unsigned ehci_moschip_read_frame_index(struct ehci_hcd *ehci)
 124 {
 125         unsigned uf;
 126
 127         uf = ehci_readl(ehci, &ehci->regs->frame_index);
 128         if (unlikely((uf & 7) == 0))
 129                 uf = ehci_readl(ehci, &ehci->regs->frame_index);
 130         return uf;
 131 }
 132
 133 static inline unsigned ehci_read_frame_index(struct ehci_hcd *ehci)
 134 {
 135         if (ehci->frame_index_bug)
 136                 return ehci_moschip_read_frame_index(ehci);
 137         return ehci_readl(ehci, &ehci->regs->frame_index);
 138 }
 139
 140 #include "ehci-dbg.c"
 141
 142 /*-------------------------------------------------------------------------*/
 143
 144 /*
 145  * ehci_handshake - spin reading hc until handshake completes or fails
 146  * @ptr: address of hc register to be read
 147  * @mask: bits to look at in result of read
 148  * @done: value of those bits when handshake succeeds
 149  * @usec: timeout in microseconds
 150  *
 151  * Returns negative errno, or zero on success
 152  *
 153  * Success happens when the "mask" bits have the specified value (hardware
 154  * handshake done).  There are two failure modes:  "usec" have passed (major
 155  * hardware flakeout), or the register reads as all-ones (hardware removed).
 156  *
 157  * That last failure should_only happen in cases like physical cardbus eject
 158  * before driver shutdown. But it also seems to be caused by bugs in cardbus
 159  * bridge shutdown:  shutting down the bridge before the devices using it.
 160  */
 161 int ehci_handshake(struct ehci_hcd *ehci, void __iomem *ptr,
 162                    u32 mask, u32 done, int usec)
 163 {
 164         u32     result;
 165
 166         do {
 167                 result = ehci_readl(ehci, ptr);
 168                 if (result == ~(u32)0)          /* card removed */
 169                         return -ENODEV;
 170                 result &= mask;
 171                 if (result == done)
 172                         return 0;
 173                 udelay (1);
 174                 usec--;
 175         } while (usec > 0);
 176         return -ETIMEDOUT;
 177 }
 178 EXPORT_SYMBOL_GPL(ehci_handshake);
 179
 180 /* check TDI/ARC silicon is in host mode */
 181 static int tdi_in_host_mode (struct ehci_hcd *ehci)
 182 {
 183         u32             tmp;
 184
 185         tmp = ehci_readl(ehci, &ehci->regs->usbmode);
 186         return (tmp & 3) == USBMODE_CM_HC;
 187 }
 188
 189 /*
 190  * Force HC to halt state from unknown (EHCI spec section 2.3).
 191  * Must be called with interrupts enabled and the lock not held.
 192  */
 193 static int ehci_halt (struct ehci_hcd *ehci)
 194 {
 195         u32     temp;
 196
 197         spin_lock_irq(&ehci->lock);
 198
 199         /* disable any irqs left enabled by previous code */
 200         ehci_writel(ehci, 0, &ehci->regs->intr_enable);
 201
 202         if (ehci_is_TDI(ehci) && !tdi_in_host_mode(ehci)) {
 203                 spin_unlock_irq(&ehci->lock);
 204                 return 0;
 205         }
 206
 207         /*
 208          * This routine gets called during probe before ehci->command
 209          * has been initialized, so we can't rely on its value.
 210          */
 211         ehci->command &= ~CMD_RUN;
 212         temp = ehci_readl(ehci, &ehci->regs->command);
 213         temp &= ~(CMD_RUN | CMD_IAAD);
 214         ehci_writel(ehci, temp, &ehci->regs->command);
 215
 216         spin_unlock_irq(&ehci->lock);
 217         synchronize_irq(ehci_to_hcd(ehci)->irq);
 218
 219         return ehci_handshake(ehci, &ehci->regs->status,
 220                           STS_HALT, STS_HALT, 16 * 125);
 221 }
 222
 223 /* put TDI/ARC silicon into EHCI mode */
 224 static void tdi_reset (struct ehci_hcd *ehci)
 225 {
 226         u32             tmp;
 227
 228         tmp = ehci_readl(ehci, &ehci->regs->usbmode);
 229         tmp |= USBMODE_CM_HC;
 230         /* The default byte access to MMR space is LE after
 231          * controller reset. Set the required endian mode
 232          * for transfer buffers to match the host microprocessor
 233          */
 234         if (ehci_big_endian_mmio(ehci))
 235                 tmp |= USBMODE_BE;
 236         ehci_writel(ehci, tmp, &ehci->regs->usbmode);
 237 }
 238
 239 /*
 240  * Reset a non-running (STS_HALT == 1) controller.
 241  * Must be called with interrupts enabled and the lock not held.
 242  */
 243 int ehci_reset(struct ehci_hcd *ehci)
 244 {
 245         int     retval;
 246         u32     command = ehci_readl(ehci, &ehci->regs->command);
 247
 248         /* If the EHCI debug controller is active, special care must be
 249          * taken before and after a host controller reset */
 250         if (ehci->debug && !dbgp_reset_prep(ehci_to_hcd(ehci)))
 251                 ehci->debug = NULL;
 252
 253         command |= CMD_RESET;
 254         dbg_cmd (ehci, "reset", command);
 255         ehci_writel(ehci, command, &ehci->regs->command);
 256         ehci->rh_state = EHCI_RH_HALTED;
 257         ehci->next_statechange = jiffies;
 258         retval = ehci_handshake(ehci, &ehci->regs->command,
 259                             CMD_RESET, 0, 250 * 1000);
 260
 261         if (ehci->has_hostpc) {
 262                 ehci_writel(ehci, USBMODE_EX_HC | USBMODE_EX_VBPS,
 263                                 &ehci->regs->usbmode_ex);
 264                 ehci_writel(ehci, TXFIFO_DEFAULT, &ehci->regs->txfill_tuning);
 265         }
 266         if (retval)
 267                 return retval;
 268
 269         if (ehci_is_TDI(ehci))
 270                 tdi_reset (ehci);
 271
 272         if (ehci->debug)
 273                 dbgp_external_startup(ehci_to_hcd(ehci));
 274
 275         ehci->port_c_suspend = ehci->suspended_ports =
 276                         ehci->resuming_ports = 0;
 277         return retval;
 278 }
 279 EXPORT_SYMBOL_GPL(ehci_reset);
 280
 281 /*
 282  * Idle the controller (turn off the schedules).
 283  * Must be called with interrupts enabled and the lock not held.
 284  */
 285 static void ehci_quiesce (struct ehci_hcd *ehci)
 286 {
 287         u32     temp;
 288
 289         if (ehci->rh_state != EHCI_RH_RUNNING)
 290                 return;
 291
 292         /* wait for any schedule enables/disables to take effect */
 293         temp = (ehci->command << 10) & (STS_ASS | STS_PSS);
 294         ehci_handshake(ehci, &ehci->regs->status, STS_ASS | STS_PSS, temp,
 295                         16 * 125);
 296
 297         /* then disable anything that's still active */
 298         spin_lock_irq(&ehci->lock);
 299         ehci->command &= ~(CMD_ASE | CMD_PSE);
 300         ehci_writel(ehci, ehci->command, &ehci->regs->command);
 301         spin_unlock_irq(&ehci->lock);
 302
 303         /* hardware can take 16 microframes to turn off ... */
 304         ehci_handshake(ehci, &ehci->regs->status, STS_ASS | STS_PSS, 0,
 305                         16 * 125);
 306 }
 307
 308 /*-------------------------------------------------------------------------*/
 309
 310 static void end_iaa_cycle(struct ehci_hcd *ehci);
 311 static void end_unlink_async(struct ehci_hcd *ehci);
 312 static void unlink_empty_async(struct ehci_hcd *ehci);
 313 static void ehci_work(struct ehci_hcd *ehci);
 314 static void start_unlink_intr(struct ehci_hcd *ehci, struct ehci_qh *qh);
 315 static void end_unlink_intr(struct ehci_hcd *ehci, struct ehci_qh *qh);
 316 static int ehci_port_power(struct ehci_hcd *ehci, int portnum, bool enable);
 317
 318 #include "ehci-timer.c"
 319 #include "ehci-hub.c"
 320 #include "ehci-mem.c"
 321 #include "ehci-q.c"
 322 #include "ehci-sched.c"
 323 #include "ehci-sysfs.c"
 324
 325 /*-------------------------------------------------------------------------*/
 326
 327 /* On some systems, leaving remote wakeup enabled prevents system shutdown.
 328  * The firmware seems to think that powering off is a wakeup event!
 329  * This routine turns off remote wakeup and everything else, on all ports.
 330  */
 331 static void ehci_turn_off_all_ports(struct ehci_hcd *ehci)
 332 {
 333         int     port = HCS_N_PORTS(ehci->hcs_params);
 334
 335         while (port--) {
 336                 spin_unlock_irq(&ehci->lock);
 337                 ehci_port_power(ehci, port, false);
 338                 spin_lock_irq(&ehci->lock);
 339                 ehci_writel(ehci, PORT_RWC_BITS,
 340                                 &ehci->regs->port_status[port]);
 341         }
 342 }
 343
 344 /*
 345  * Halt HC, turn off all ports, and let the BIOS use the companion controllers.
 346  * Must be called with interrupts enabled and the lock not held.
 347  */
 348 static void ehci_silence_controller(struct ehci_hcd *ehci)
 349 {
 350         ehci_halt(ehci);
 351
 352         spin_lock_irq(&ehci->lock);
 353         ehci->rh_state = EHCI_RH_HALTED;
 354         ehci_turn_off_all_ports(ehci);
 355
 356         /* make BIOS/etc use companion controller during reboot */
 357         ehci_writel(ehci, 0, &ehci->regs->configured_flag);
 358
 359         /* unblock posted writes */
 360         ehci_readl(ehci, &ehci->regs->configured_flag);
 361         spin_unlock_irq(&ehci->lock);
 362 }
 363
 364 /* ehci_shutdown kick in for silicon on any bus (not just pci, etc).
 365  * This forcibly disables dma and IRQs, helping kexec and other cases
 366  * where the next system software may expect clean state.
 367  */
 368 static void ehci_shutdown(struct usb_hcd *hcd)
 369 {
 370         struct ehci_hcd *ehci = hcd_to_ehci(hcd);
 371
 372         /**
 373          * Protect the system from crashing at system shutdown in cases where
 374          * usb host is not added yet from OTG controller driver.
 375          * As ehci_setup() not done yet, so stop accessing registers or
 376          * variables initialized in ehci_setup()
 377          */
 378         if (!ehci->sbrn)
 379                 return;
 380
 381         spin_lock_irq(&ehci->lock);
 382         ehci->shutdown = true;
 383         ehci->rh_state = EHCI_RH_STOPPING;
 384         ehci->enabled_hrtimer_events = 0;
 385         spin_unlock_irq(&ehci->lock);
 386
 387         ehci_silence_controller(ehci);
 388
 389         hrtimer_cancel(&ehci->hrtimer);
 390 }
 391
 392 /*-------------------------------------------------------------------------*/
 393
 394 /*
 395  * ehci_work is called from some interrupts, timers, and so on.
 396  * it calls driver completion functions, after dropping ehci->lock.
 397  */
 398 static void ehci_work (struct ehci_hcd *ehci)
 399 {
 400         /* another CPU may drop ehci->lock during a schedule scan while
 401          * it reports urb completions.  this flag guards against bogus
 402          * attempts at re-entrant schedule scanning.
 403          */
 404         if (ehci->scanning) {
 405                 ehci->need_rescan = true;
 406                 return;
 407         }
 408         ehci->scanning = true;
 409
 410  rescan:
 411         ehci->need_rescan = false;
 412         if (ehci->async_count)
 413                 scan_async(ehci);
 414         if (ehci->intr_count > 0)
 415                 scan_intr(ehci);
 416         if (ehci->isoc_count > 0)
 417                 scan_isoc(ehci);
 418         if (ehci->need_rescan)
 419                 goto rescan;
 420         ehci->scanning = false;
 421
 422         /* the IO watchdog guards against hardware or driver bugs that
 423          * misplace IRQs, and should let us run completely without IRQs.
 424          * such lossage has been observed on both VT6202 and VT8235.
 425          */
 426         turn_on_io_watchdog(ehci);
 427 }
 428
 429 /*
 430  * Called when the ehci_hcd module is removed.
 431  */
 432 static void ehci_stop (struct usb_hcd *hcd)
 433 {
 434         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 435
 436         ehci_dbg (ehci, "stop\n");
 437
 438         /* no more interrupts ... */
 439
 440         spin_lock_irq(&ehci->lock);
 441         ehci->enabled_hrtimer_events = 0;
 442         spin_unlock_irq(&ehci->lock);
 443
 444         ehci_quiesce(ehci);
 445         ehci_silence_controller(ehci);
 446         ehci_reset (ehci);
 447
 448         hrtimer_cancel(&ehci->hrtimer);
 449         remove_sysfs_files(ehci);
 450         remove_debug_files (ehci);
 451
 452         /* root hub is shut down separately (first, when possible) */
 453         spin_lock_irq (&ehci->lock);
 454         end_free_itds(ehci);
 455         spin_unlock_irq (&ehci->lock);
 456         ehci_mem_cleanup (ehci);
 457
 458         if (ehci->amd_pll_fix == 1)
 459                 usb_amd_dev_put();
 460
 461         dbg_status (ehci, "ehci_stop completed",
 462                     ehci_readl(ehci, &ehci->regs->status));
 463 }
 464
 465 /* one-time init, only for memory state */
 466 static int ehci_init(struct usb_hcd *hcd)
 467 {
 468         struct ehci_hcd         *ehci = hcd_to_ehci(hcd);
 469         u32                     temp;
 470         int                     retval;
 471         u32                     hcc_params;
 472         struct ehci_qh_hw       *hw;
 473
 474         spin_lock_init(&ehci->lock);
 475
 476         /*
 477          * keep io watchdog by default, those good HCDs could turn off it later
 478          */
 479         ehci->need_io_watchdog = 1;
 480
 481         hrtimer_init(&ehci->hrtimer, CLOCK_MONOTONIC, HRTIMER_MODE_ABS);
 482         ehci->hrtimer.function = ehci_hrtimer_func;
 483         ehci->next_hrtimer_event = EHCI_HRTIMER_NO_EVENT;
 484
 485         hcc_params = ehci_readl(ehci, &ehci->caps->hcc_params);
 486
 487         /*
 488          * by default set standard 80% (== 100 usec/uframe) max periodic
 489          * bandwidth as required by USB 2.0
 490          */
 491         ehci->uframe_periodic_max = 100;
 492
 493         /*
 494          * hw default: 1K periodic list heads, one per frame.
 495          * periodic_size can shrink by USBCMD update if hcc_params allows.
 496          */
 497         ehci->periodic_size = DEFAULT_I_TDPS;
 498         INIT_LIST_HEAD(&ehci->async_unlink);
 499         INIT_LIST_HEAD(&ehci->async_idle);
 500         INIT_LIST_HEAD(&ehci->intr_unlink_wait);
 501         INIT_LIST_HEAD(&ehci->intr_unlink);
 502         INIT_LIST_HEAD(&ehci->intr_qh_list);
 503         INIT_LIST_HEAD(&ehci->cached_itd_list);
 504         INIT_LIST_HEAD(&ehci->cached_sitd_list);
 505         INIT_LIST_HEAD(&ehci->tt_list);
 506
 507         if (HCC_PGM_FRAMELISTLEN(hcc_params)) {
 508                 /* periodic schedule size can be smaller than default */
 509                 switch (EHCI_TUNE_FLS) {
 510                 case 0: ehci->periodic_size = 1024; break;
 511                 case 1: ehci->periodic_size = 512; break;
 512                 case 2: ehci->periodic_size = 256; break;
 513                 default:        BUG();
 514                 }
 515         }
 516         if ((retval = ehci_mem_init(ehci, GFP_KERNEL)) < 0)
 517                 return retval;
 518
 519         /* controllers may cache some of the periodic schedule ... */
 520         if (HCC_ISOC_CACHE(hcc_params))         // full frame cache
 521                 ehci->i_thresh = 0;
 522         else                                    // N microframes cached
 523                 ehci->i_thresh = 2 + HCC_ISOC_THRES(hcc_params);
 524
 525         /*
 526          * dedicate a qh for the async ring head, since we couldn't unlink
 527          * a 'real' qh without stopping the async schedule [4.8].  use it
 528          * as the 'reclamation list head' too.
 529          * its dummy is used in hw_alt_next of many tds, to prevent the qh
 530          * from automatically advancing to the next td after short reads.
 531          */
 532         ehci->async->qh_next.qh = NULL;
 533         hw = ehci->async->hw;
 534         hw->hw_next = QH_NEXT(ehci, ehci->async->qh_dma);
 535         hw->hw_info1 = cpu_to_hc32(ehci, QH_HEAD);
 536 #if defined(CONFIG_PPC_PS3)
 537         hw->hw_info1 |= cpu_to_hc32(ehci, QH_INACTIVATE);
 538 #endif
 539         hw->hw_token = cpu_to_hc32(ehci, QTD_STS_HALT);
 540         hw->hw_qtd_next = EHCI_LIST_END(ehci);
 541         ehci->async->qh_state = QH_STATE_LINKED;
 542         hw->hw_alt_next = QTD_NEXT(ehci, ehci->async->dummy->qtd_dma);
 543
 544         /* clear interrupt enables, set irq latency */
 545         if (log2_irq_thresh < 0 || log2_irq_thresh > 6)
 546                 log2_irq_thresh = 0;
 547         temp = 1 << (16 + log2_irq_thresh);
 548         if (HCC_PER_PORT_CHANGE_EVENT(hcc_params)) {
 549                 ehci->has_ppcd = 1;
 550                 ehci_dbg(ehci, "enable per-port change event\n");
 551                 temp |= CMD_PPCEE;
 552         }
 553         if (HCC_CANPARK(hcc_params)) {
 554                 /* HW default park == 3, on hardware that supports it (like
 555                  * NVidia and ALI silicon), maximizes throughput on the async
 556                  * schedule by avoiding QH fetches between transfers.
 557                  *
 558                  * With fast usb storage devices and NForce2, "park" seems to
 559                  * make problems:  throughput reduction (!), data errors...
 560                  */
 561                 if (park) {
 562                         park = min(park, (unsigned) 3);
 563                         temp |= CMD_PARK;
 564                         temp |= park << 8;
 565                 }
 566                 ehci_dbg(ehci, "park %d\n", park);
 567         }
 568         if (HCC_PGM_FRAMELISTLEN(hcc_params)) {
 569                 /* periodic schedule size can be smaller than default */
 570                 temp &= ~(3 << 2);
 571                 temp |= (EHCI_TUNE_FLS << 2);
 572         }
 573         ehci->command = temp;
 574
 575         /* Accept arbitrarily long scatter-gather lists */
 576         if (!(hcd->driver->flags & HCD_LOCAL_MEM))
 577                 hcd->self.sg_tablesize = ~0;
 578
 579         /* Prepare for unlinking active QHs */
 580         ehci->old_current = ~0;
 581         return 0;
 582 }
 583
 584 /* start HC running; it's halted, ehci_init() has been run (once) */
 585 static int ehci_run (struct usb_hcd *hcd)
 586 {
 587         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 588         u32                     temp;
 589         u32                     hcc_params;
 590         int                     rc;
 591
 592         hcd->uses_new_polling = 1;
 593
 594         /* EHCI spec section 4.1 */
 595
 596         ehci_writel(ehci, ehci->periodic_dma, &ehci->regs->frame_list);
 597         ehci_writel(ehci, (u32)ehci->async->qh_dma, &ehci->regs->async_next);
 598
 599         /*
 600          * hcc_params controls whether ehci->regs->segment must (!!!)
 601          * be used; it constrains QH/ITD/SITD and QTD locations.
 602          * dma_pool consistent memory always uses segment zero.
 603          * streaming mappings for I/O buffers, like pci_map_single(),
 604          * can return segments above 4GB, if the device allows.
 605          *
 606          * NOTE:  the dma mask is visible through dev->dma_mask, so
 607          * drivers can pass this info along ... like NETIF_F_HIGHDMA,
 608          * Scsi_Host.highmem_io, and so forth.  It's readonly to all
 609          * host side drivers though.
 610          */
 611         hcc_params = ehci_readl(ehci, &ehci->caps->hcc_params);
 612         if (HCC_64BIT_ADDR(hcc_params)) {
 613                 ehci_writel(ehci, 0, &ehci->regs->segment);
 614 #if 0
 615 // this is deeply broken on almost all architectures
 616                 if (!dma_set_mask(hcd->self.controller, DMA_BIT_MASK(64)))
 617                         ehci_info(ehci, "enabled 64bit DMA\n");
 618 #endif
 619         }
 620
 621
 622         // Philips, Intel, and maybe others need CMD_RUN before the
 623         // root hub will detect new devices (why?); NEC doesn't
 624         ehci->command &= ~(CMD_LRESET|CMD_IAAD|CMD_PSE|CMD_ASE|CMD_RESET);
 625         ehci->command |= CMD_RUN;
 626         ehci_writel(ehci, ehci->command, &ehci->regs->command);
 627         dbg_cmd (ehci, "init", ehci->command);
 628
 629         /*
 630          * Start, enabling full USB 2.0 functionality ... usb 1.1 devices
 631          * are explicitly handed to companion controller(s), so no TT is
 632          * involved with the root hub.  (Except where one is integrated,
 633          * and there's no companion controller unless maybe for USB OTG.)
 634          *
 635          * Turning on the CF flag will transfer ownership of all ports
 636          * from the companions to the EHCI controller.  If any of the
 637          * companions are in the middle of a port reset at the time, it
 638          * could cause trouble.  Write-locking ehci_cf_port_reset_rwsem
 639          * guarantees that no resets are in progress.  After we set CF,
 640          * a short delay lets the hardware catch up; new resets shouldn't
 641          * be started before the port switching actions could complete.
 642          */
 643         down_write(&ehci_cf_port_reset_rwsem);
 644         ehci->rh_state = EHCI_RH_RUNNING;
 645         ehci_writel(ehci, FLAG_CF, &ehci->regs->configured_flag);
 646
 647         /* Wait until HC become operational */
 648         ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
 649         msleep(5);
 650         rc = ehci_handshake(ehci, &ehci->regs->status, STS_HALT, 0, 100 * 1000);
 651
 652         up_write(&ehci_cf_port_reset_rwsem);
 653
 654         if (rc) {
 655                 ehci_err(ehci, "USB %x.%x, controller refused to start: %d\n",
 656                          ((ehci->sbrn & 0xf0)>>4), (ehci->sbrn & 0x0f), rc);
 657                 return rc;
 658         }
 659
 660         ehci->last_periodic_enable = ktime_get_real();
 661
 662         temp = HC_VERSION(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
 663         ehci_info (ehci,
 664                 "USB %x.%x started, EHCI %x.%02x%s\n",
 665                 ((ehci->sbrn & 0xf0)>>4), (ehci->sbrn & 0x0f),
 666                 temp >> 8, temp & 0xff,
 667                 ignore_oc ? ", overcurrent ignored" : "");
 668
 669         ehci_writel(ehci, INTR_MASK,
 670                     &ehci->regs->intr_enable); /* Turn On Interrupts */
 671
 672         /* GRR this is run-once init(), being done every time the HC starts.
 673          * So long as they're part of class devices, we can't do it init()
 674          * since the class device isn't created that early.
 675          */
 676         create_debug_files(ehci);
 677         create_sysfs_files(ehci);
 678
 679         return 0;
 680 }
 681
 682 int ehci_setup(struct usb_hcd *hcd)
 683 {
 684         struct ehci_hcd *ehci = hcd_to_ehci(hcd);
 685         int retval;
 686
 687         ehci->regs = (void __iomem *)ehci->caps +
 688             HC_LENGTH(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
 689         dbg_hcs_params(ehci, "reset");
 690         dbg_hcc_params(ehci, "reset");
 691
 692         /* cache this readonly data; minimize chip reads */
 693         ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);
 694
 695         ehci->sbrn = HCD_USB2;
 696
 697         /* data structure init */
 698         retval = ehci_init(hcd);
 699         if (retval)
 700                 return retval;
 701
 702         retval = ehci_halt(ehci);
 703         if (retval) {
 704                 ehci_mem_cleanup(ehci);
 705                 return retval;
 706         }
 707
 708         ehci_reset(ehci);
 709
 710         return 0;
 711 }
 712 EXPORT_SYMBOL_GPL(ehci_setup);
 713
 714 /*-------------------------------------------------------------------------*/
 715
 716 static irqreturn_t ehci_irq (struct usb_hcd *hcd)
 717 {
 718         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 719         u32                     status, masked_status, pcd_status = 0, cmd;
 720         int                     bh;
 721         unsigned long           flags;
 722
 723         /*
 724          * For threadirqs option we use spin_lock_irqsave() variant to prevent
 725          * deadlock with ehci hrtimer callback, because hrtimer callbacks run
 726          * in interrupt context even when threadirqs is specified. We can go
 727          * back to spin_lock() variant when hrtimer callbacks become threaded.
 728          */
 729         spin_lock_irqsave(&ehci->lock, flags);
 730
 731         status = ehci_readl(ehci, &ehci->regs->status);
 732
 733         /* e.g. cardbus physical eject */
 734         if (status == ~(u32) 0) {
 735                 ehci_dbg (ehci, "device removed\n");
 736                 goto dead;
 737         }
 738
 739         /*
 740          * We don't use STS_FLR, but some controllers don't like it to
 741          * remain on, so mask it out along with the other status bits.
 742          */
 743         masked_status = status & (INTR_MASK | STS_FLR);
 744
 745         /* Shared IRQ? */
 746         if (!masked_status || unlikely(ehci->rh_state == EHCI_RH_HALTED)) {
 747                 spin_unlock_irqrestore(&ehci->lock, flags);
 748                 return IRQ_NONE;
 749         }
 750
 751         /* clear (just) interrupts */
 752         ehci_writel(ehci, masked_status, &ehci->regs->status);
 753         cmd = ehci_readl(ehci, &ehci->regs->command);
 754         bh = 0;
 755
 756         /* normal [4.15.1.2] or error [4.15.1.1] completion */
 757         if (likely ((status & (STS_INT|STS_ERR)) != 0)) {
 758                 if (likely ((status & STS_ERR) == 0))
 759                         COUNT (ehci->stats.normal);
 760                 else
 761                         COUNT (ehci->stats.error);
 762                 bh = 1;
 763         }
 764
 765         /* complete the unlinking of some qh [4.15.2.3] */
 766         if (status & STS_IAA) {
 767
 768                 /* Turn off the IAA watchdog */
 769                 ehci->enabled_hrtimer_events &= ~BIT(EHCI_HRTIMER_IAA_WATCHDOG);
 770
 771                 /*
 772                  * Mild optimization: Allow another IAAD to reset the
 773                  * hrtimer, if one occurs before the next expiration.
 774                  * In theory we could always cancel the hrtimer, but
 775                  * tests show that about half the time it will be reset
 776                  * for some other event anyway.
 777                  */
 778                 if (ehci->next_hrtimer_event == EHCI_HRTIMER_IAA_WATCHDOG)
 779                         ++ehci->next_hrtimer_event;
 780
 781                 /* guard against (alleged) silicon errata */
 782                 if (cmd & CMD_IAAD)
 783                         ehci_dbg(ehci, "IAA with IAAD still set?\n");
 784                 if (ehci->iaa_in_progress)
 785                         COUNT(ehci->stats.iaa);
 786                 end_iaa_cycle(ehci);
 787         }
 788
 789         /* remote wakeup [4.3.1] */
 790         if (status & STS_PCD) {
 791                 unsigned        i = HCS_N_PORTS (ehci->hcs_params);
 792                 u32             ppcd = ~0;
 793
 794                 /* kick root hub later */
 795                 pcd_status = status;
 796
 797                 /* resume root hub? */
 798                 if (ehci->rh_state == EHCI_RH_SUSPENDED)
 799                         usb_hcd_resume_root_hub(hcd);
 800
 801                 /* get per-port change detect bits */
 802                 if (ehci->has_ppcd)
 803                         ppcd = status >> 16;
 804
 805                 while (i--) {
 806                         int pstatus;
 807
 808                         /* leverage per-port change bits feature */
 809                         if (!(ppcd & (1 << i)))
 810                                 continue;
 811                         pstatus = ehci_readl(ehci,
 812                                          &ehci->regs->port_status[i]);
 813
 814                         if (pstatus & PORT_OWNER)
 815                                 continue;
 816                         if (!(test_bit(i, &ehci->suspended_ports) &&
 817                                         ((pstatus & PORT_RESUME) ||
 818                                                 !(pstatus & PORT_SUSPEND)) &&
 819                                         (pstatus & PORT_PE) &&
 820                                         ehci->reset_done[i] == 0))
 821                                 continue;
 822
 823                         /* start USB_RESUME_TIMEOUT msec resume signaling from
 824                          * this port, and make hub_wq collect
 825                          * PORT_STAT_C_SUSPEND to stop that signaling.
 826                          */
 827                         ehci->reset_done[i] = jiffies +
 828                                 msecs_to_jiffies(USB_RESUME_TIMEOUT);
 829                         set_bit(i, &ehci->resuming_ports);
 830                         ehci_dbg (ehci, "port %d remote wakeup\n", i + 1);
 831                         usb_hcd_start_port_resume(&hcd->self, i);
 832                         mod_timer(&hcd->rh_timer, ehci->reset_done[i]);
 833                 }
 834         }
 835
 836         /* PCI errors [4.15.2.4] */
 837         if (unlikely ((status & STS_FATAL) != 0)) {
 838                 ehci_err(ehci, "fatal error\n");
 839                 dbg_cmd(ehci, "fatal", cmd);
 840                 dbg_status(ehci, "fatal", status);
 841 dead:
 842                 usb_hc_died(hcd);
 843
 844                 /* Don't let the controller do anything more */
 845                 ehci->shutdown = true;
 846                 ehci->rh_state = EHCI_RH_STOPPING;
 847                 ehci->command &= ~(CMD_RUN | CMD_ASE | CMD_PSE);
 848                 ehci_writel(ehci, ehci->command, &ehci->regs->command);
 849                 ehci_writel(ehci, 0, &ehci->regs->intr_enable);
 850                 ehci_handle_controller_death(ehci);
 851
 852                 /* Handle completions when the controller stops */
 853                 bh = 0;
 854         }
 855
 856         if (bh)
 857                 ehci_work (ehci);
 858         spin_unlock_irqrestore(&ehci->lock, flags);
 859         if (pcd_status)
 860                 usb_hcd_poll_rh_status(hcd);
 861         return IRQ_HANDLED;
 862 }
 863
 864 /*-------------------------------------------------------------------------*/
 865
 866 /*
 867  * non-error returns are a promise to giveback() the urb later
 868  * we drop ownership so next owner (or urb unlink) can get it
 869  *
 870  * urb + dev is in hcd.self.controller.urb_list
 871  * we're queueing TDs onto software and hardware lists
 872  *
 873  * hcd-specific init for hcpriv hasn't been done yet
 874  *
 875  * NOTE:  control, bulk, and interrupt share the same code to append TDs
 876  * to a (possibly active) QH, and the same QH scanning code.
 877  */
 878 static int ehci_urb_enqueue (
 879         struct usb_hcd  *hcd,
 880         struct urb      *urb,
 881         gfp_t           mem_flags
 882 ) {
 883         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 884         struct list_head        qtd_list;
 885
 886         INIT_LIST_HEAD (&qtd_list);
 887
 888         switch (usb_pipetype (urb->pipe)) {
 889         case PIPE_CONTROL:
 890                 /* qh_completions() code doesn't handle all the fault cases
 891                  * in multi-TD control transfers.  Even 1KB is rare anyway.
 892                  */
 893                 if (urb->transfer_buffer_length > (16 * 1024))
 894                         return -EMSGSIZE;
 895                 /* FALLTHROUGH */
 896         /* case PIPE_BULK: */
 897         default:
 898                 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
 899                         return -ENOMEM;
 900                 return submit_async(ehci, urb, &qtd_list, mem_flags);
 901
 902         case PIPE_INTERRUPT:
 903                 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
 904                         return -ENOMEM;
 905                 return intr_submit(ehci, urb, &qtd_list, mem_flags);
 906
 907         case PIPE_ISOCHRONOUS:
 908                 if (urb->dev->speed == USB_SPEED_HIGH)
 909                         return itd_submit (ehci, urb, mem_flags);
 910                 else
 911                         return sitd_submit (ehci, urb, mem_flags);
 912         }
 913 }
 914
 915 /* remove from hardware lists
 916  * completions normally happen asynchronously
 917  */
 918
 919 static int ehci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
 920 {
 921         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 922         struct ehci_qh          *qh;
 923         unsigned long           flags;
 924         int                     rc;
 925
 926         spin_lock_irqsave (&ehci->lock, flags);
 927         rc = usb_hcd_check_unlink_urb(hcd, urb, status);
 928         if (rc)
 929                 goto done;
 930
 931         if (usb_pipetype(urb->pipe) == PIPE_ISOCHRONOUS) {
 932                 /*
 933                  * We don't expedite dequeue for isochronous URBs.
 934                  * Just wait until they complete normally or their
 935                  * time slot expires.
 936                  */
 937         } else {
 938                 qh = (struct ehci_qh *) urb->hcpriv;
 939                 qh->unlink_reason |= QH_UNLINK_REQUESTED;
 940                 switch (qh->qh_state) {
 941                 case QH_STATE_LINKED:
 942                         if (usb_pipetype(urb->pipe) == PIPE_INTERRUPT)
 943                                 start_unlink_intr(ehci, qh);
 944                         else
 945                                 start_unlink_async(ehci, qh);
 946                         break;
 947                 case QH_STATE_COMPLETING:
 948                         qh->dequeue_during_giveback = 1;
 949                         break;
 950                 case QH_STATE_UNLINK:
 951                 case QH_STATE_UNLINK_WAIT:
 952                         /* already started */
 953                         break;
 954                 case QH_STATE_IDLE:
 955                         /* QH might be waiting for a Clear-TT-Buffer */
 956                         qh_completions(ehci, qh);
 957                         break;
 958                 }
 959         }
 960 done:
 961         spin_unlock_irqrestore (&ehci->lock, flags);
 962         return rc;
 963 }
 964
 965 /*-------------------------------------------------------------------------*/
 966
 967 // bulk qh holds the data toggle
 968
 969 static void
 970 ehci_endpoint_disable (struct usb_hcd *hcd, struct usb_host_endpoint *ep)
 971 {
 972         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 973         unsigned long           flags;
 974         struct ehci_qh          *qh;
 975
 976         /* ASSERT:  any requests/urbs are being unlinked */
 977         /* ASSERT:  nobody can be submitting urbs for this any more */
 978
 979 rescan:
 980         spin_lock_irqsave (&ehci->lock, flags);
 981         qh = ep->hcpriv;
 982         if (!qh)
 983                 goto done;
 984
 985         /* endpoints can be iso streams.  for now, we don't
 986          * accelerate iso completions ... so spin a while.
 987          */
 988         if (qh->hw == NULL) {
 989                 struct ehci_iso_stream  *stream = ep->hcpriv;
 990
 991                 if (!list_empty(&stream->td_list))
 992                         goto idle_timeout;
 993
 994                 /* BUG_ON(!list_empty(&stream->free_list)); */
 995                 reserve_release_iso_bandwidth(ehci, stream, -1);
 996                 kfree(stream);
 997                 goto done;
 998         }
 999
1000         qh->unlink_reason |= QH_UNLINK_REQUESTED;
1001         switch (qh->qh_state) {
1002         case QH_STATE_LINKED:
1003                 if (list_empty(&qh->qtd_list))
1004                         qh->unlink_reason |= QH_UNLINK_QUEUE_EMPTY;
1005                 else
1006                         WARN_ON(1);
1007                 if (usb_endpoint_type(&ep->desc) != USB_ENDPOINT_XFER_INT)
1008                         start_unlink_async(ehci, qh);
1009                 else
1010                         start_unlink_intr(ehci, qh);
1011                 /* FALL THROUGH */
1012         case QH_STATE_COMPLETING:       /* already in unlinking */
1013         case QH_STATE_UNLINK:           /* wait for hw to finish? */
1014         case QH_STATE_UNLINK_WAIT:
1015 idle_timeout:
1016                 spin_unlock_irqrestore (&ehci->lock, flags);
1017                 schedule_timeout_uninterruptible(1);
1018                 goto rescan;
1019         case QH_STATE_IDLE:             /* fully unlinked */
1020                 if (qh->clearing_tt)
1021                         goto idle_timeout;
1022                 if (list_empty (&qh->qtd_list)) {
1023                         if (qh->ps.bw_uperiod)
1024                                 reserve_release_intr_bandwidth(ehci, qh, -1);
1025                         qh_destroy(ehci, qh);
1026                         break;
1027                 }
1028                 /* else FALL THROUGH */
1029         default:
1030                 /* caller was supposed to have unlinked any requests;
1031                  * that's not our job.  just leak this memory.
1032                  */
1033                 ehci_err (ehci, "qh %p (#%02x) state %d%s\n",
1034                         qh, ep->desc.bEndpointAddress, qh->qh_state,
1035                         list_empty (&qh->qtd_list) ? "" : "(has tds)");
1036                 break;
1037         }
1038  done:
1039         ep->hcpriv = NULL;
1040         spin_unlock_irqrestore (&ehci->lock, flags);
1041 }
1042
1043 static void
1044 ehci_endpoint_reset(struct usb_hcd *hcd, struct usb_host_endpoint *ep)
1045 {
1046         struct ehci_hcd         *ehci = hcd_to_ehci(hcd);
1047         struct ehci_qh          *qh;
1048         int                     eptype = usb_endpoint_type(&ep->desc);
1049         int                     epnum = usb_endpoint_num(&ep->desc);
1050         int                     is_out = usb_endpoint_dir_out(&ep->desc);
1051         unsigned long           flags;
1052
1053         if (eptype != USB_ENDPOINT_XFER_BULK && eptype != USB_ENDPOINT_XFER_INT)
1054                 return;
1055
1056         spin_lock_irqsave(&ehci->lock, flags);
1057         qh = ep->hcpriv;
1058
1059         /* For Bulk and Interrupt endpoints we maintain the toggle state
1060          * in the hardware; the toggle bits in udev aren't used at all.
1061          * When an endpoint is reset by usb_clear_halt() we must reset
1062          * the toggle bit in the QH.
1063          */
1064         if (qh) {
1065                 if (!list_empty(&qh->qtd_list)) {
1066                         WARN_ONCE(1, "clear_halt for a busy endpoint\n");
1067                 } else {
1068                         /* The toggle value in the QH can't be updated
1069                          * while the QH is active.  Unlink it now;
1070                          * re-linking will call qh_refresh().
1071                          */
1072                         usb_settoggle(qh->ps.udev, epnum, is_out, 0);
1073                         qh->unlink_reason |= QH_UNLINK_REQUESTED;
1074                         if (eptype == USB_ENDPOINT_XFER_BULK)
1075                                 start_unlink_async(ehci, qh);
1076                         else
1077                                 start_unlink_intr(ehci, qh);
1078                 }
1079         }
1080         spin_unlock_irqrestore(&ehci->lock, flags);
1081 }
1082
1083 static int ehci_get_frame (struct usb_hcd *hcd)
1084 {
1085         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
1086         return (ehci_read_frame_index(ehci) >> 3) % ehci->periodic_size;
1087 }
1088
1089 /*-------------------------------------------------------------------------*/
1090
1091 /* Device addition and removal */
1092
1093 static void ehci_remove_device(struct usb_hcd *hcd, struct usb_device *udev)
1094 {
1095         struct ehci_hcd         *ehci = hcd_to_ehci(hcd);
1096
1097         spin_lock_irq(&ehci->lock);
1098         drop_tt(udev);
1099         spin_unlock_irq(&ehci->lock);
1100 }
1101
1102 /*-------------------------------------------------------------------------*/
1103
1104 #ifdef  CONFIG_PM
1105
1106 /* suspend/resume, section 4.3 */
1107
1108 /* These routines handle the generic parts of controller suspend/resume */
1109
1110 int ehci_suspend(struct usb_hcd *hcd, bool do_wakeup)
1111 {
1112         struct ehci_hcd         *ehci = hcd_to_ehci(hcd);
1113
1114         if (time_before(jiffies, ehci->next_statechange))
1115                 msleep(10);
1116
1117         /*
1118          * Root hub was already suspended.  Disable IRQ emission and
1119          * mark HW unaccessible.  The PM and USB cores make sure that
1120          * the root hub is either suspended or stopped.
1121          */
1122         ehci_prepare_ports_for_controller_suspend(ehci, do_wakeup);
1123
1124         spin_lock_irq(&ehci->lock);
1125         ehci_writel(ehci, 0, &ehci->regs->intr_enable);
1126         (void) ehci_readl(ehci, &ehci->regs->intr_enable);
1127
1128         clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1129         spin_unlock_irq(&ehci->lock);
1130
1131         synchronize_irq(hcd->irq);
1132
1133         /* Check for race with a wakeup request */
1134         if (do_wakeup && HCD_WAKEUP_PENDING(hcd)) {
1135                 ehci_resume(hcd, false);
1136                 return -EBUSY;
1137         }
1138
1139         return 0;
1140 }
1141 EXPORT_SYMBOL_GPL(ehci_suspend);
1142
1143 /* Returns 0 if power was preserved, 1 if power was lost */
1144 int ehci_resume(struct usb_hcd *hcd, bool force_reset)
1145 {
1146         struct ehci_hcd         *ehci = hcd_to_ehci(hcd);
1147
1148         if (time_before(jiffies, ehci->next_statechange))
1149                 msleep(100);
1150
1151         /* Mark hardware accessible again as we are back to full power by now */
1152         set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1153
1154         if (ehci->shutdown)
1155                 return 0;               /* Controller is dead */
1156
1157         /*
1158          * If CF is still set and reset isn't forced
1159          * then we maintained suspend power.
1160          * Just undo the effect of ehci_suspend().
1161          */
1162         if (ehci_readl(ehci, &ehci->regs->configured_flag) == FLAG_CF &&
1163                         !force_reset) {
1164                 int     mask = INTR_MASK;
1165
1166                 ehci_prepare_ports_for_controller_resume(ehci);
1167
1168                 spin_lock_irq(&ehci->lock);
1169                 if (ehci->shutdown)
1170                         goto skip;
1171
1172                 if (!hcd->self.root_hub->do_remote_wakeup)
1173                         mask &= ~STS_PCD;
1174                 ehci_writel(ehci, mask, &ehci->regs->intr_enable);
1175                 ehci_readl(ehci, &ehci->regs->intr_enable);
1176  skip:
1177                 spin_unlock_irq(&ehci->lock);
1178                 return 0;
1179         }
1180
1181         /*
1182          * Else reset, to cope with power loss or resume from hibernation
1183          * having let the firmware kick in during reboot.
1184          */
1185         usb_root_hub_lost_power(hcd->self.root_hub);
1186         (void) ehci_halt(ehci);
1187         (void) ehci_reset(ehci);
1188
1189         spin_lock_irq(&ehci->lock);
1190         if (ehci->shutdown)
1191                 goto skip;
1192
1193         ehci_writel(ehci, ehci->command, &ehci->regs->command);
1194         ehci_writel(ehci, FLAG_CF, &ehci->regs->configured_flag);
1195         ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
1196
1197         ehci->rh_state = EHCI_RH_SUSPENDED;
1198         spin_unlock_irq(&ehci->lock);
1199
1200         return 1;
1201 }
1202 EXPORT_SYMBOL_GPL(ehci_resume);
1203
1204 #endif
1205
1206 /*-------------------------------------------------------------------------*/
1207
1208 /*
1209  * Generic structure: This gets copied for platform drivers so that
1210  * individual entries can be overridden as needed.
1211  */
1212
1213 static const struct hc_driver ehci_hc_driver = {
1214         .description =          hcd_name,
1215         .product_desc =         "EHCI Host Controller",
1216         .hcd_priv_size =        sizeof(struct ehci_hcd),
1217
1218         /*
1219          * generic hardware linkage
1220          */
1221         .irq =                  ehci_irq,
1222         .flags =                HCD_MEMORY | HCD_USB2 | HCD_BH,
1223
1224         /*
1225          * basic lifecycle operations
1226          */
1227         .reset =                ehci_setup,
1228         .start =                ehci_run,
1229         .stop =                 ehci_stop,
1230         .shutdown =             ehci_shutdown,
1231
1232         /*
1233          * managing i/o requests and associated device resources
1234          */
1235         .urb_enqueue =          ehci_urb_enqueue,
1236         .urb_dequeue =          ehci_urb_dequeue,
1237         .endpoint_disable =     ehci_endpoint_disable,
1238         .endpoint_reset =       ehci_endpoint_reset,
1239         .clear_tt_buffer_complete =     ehci_clear_tt_buffer_complete,
1240
1241         /*
1242          * scheduling support
1243          */
1244         .get_frame_number =     ehci_get_frame,
1245
1246         /*
1247          * root hub support
1248          */
1249         .hub_status_data =      ehci_hub_status_data,
1250         .hub_control =          ehci_hub_control,
1251         .bus_suspend =          ehci_bus_suspend,
1252         .bus_resume =           ehci_bus_resume,
1253         .relinquish_port =      ehci_relinquish_port,
1254         .port_handed_over =     ehci_port_handed_over,
1255
1256         /*
1257          * device support
1258          */
1259         .free_dev =             ehci_remove_device,
1260 };
1261
1262 void ehci_init_driver(struct hc_driver *drv,
1263                 const struct ehci_driver_overrides *over)
1264 {
1265         /* Copy the generic table to drv and then apply the overrides */
1266         *drv = ehci_hc_driver;
1267
1268         if (over) {
1269                 drv->hcd_priv_size += over->extra_priv_size;
1270                 if (over->reset)
1271                         drv->reset = over->reset;
1272                 if (over->port_power)
1273                         drv->port_power = over->port_power;
1274         }
1275 }
1276 EXPORT_SYMBOL_GPL(ehci_init_driver);
1277
1278 /*-------------------------------------------------------------------------*/
1279
1280 MODULE_DESCRIPTION(DRIVER_DESC);
1281 MODULE_AUTHOR (DRIVER_AUTHOR);
1282 MODULE_LICENSE ("GPL");
1283
1284 #ifdef CONFIG_USB_EHCI_SH
1285 #include "ehci-sh.c"
1286 #define PLATFORM_DRIVER         ehci_hcd_sh_driver
1287 #endif
1288
1289 #ifdef CONFIG_PPC_PS3
1290 #include "ehci-ps3.c"
1291 #define PS3_SYSTEM_BUS_DRIVER   ps3_ehci_driver
1292 #endif
1293
1294 #ifdef CONFIG_USB_EHCI_HCD_PPC_OF
1295 #include "ehci-ppc-of.c"
1296 #define OF_PLATFORM_DRIVER      ehci_hcd_ppc_of_driver
1297 #endif
1298
1299 #ifdef CONFIG_XPS_USB_HCD_XILINX
1300 #include "ehci-xilinx-of.c"
1301 #define XILINX_OF_PLATFORM_DRIVER       ehci_hcd_xilinx_of_driver
1302 #endif
1303
1304 #ifdef CONFIG_TILE_USB
1305 #include "ehci-tilegx.c"
1306 #define PLATFORM_DRIVER         ehci_hcd_tilegx_driver
1307 #endif
1308
1309 #ifdef CONFIG_USB_EHCI_HCD_PMC_MSP
1310 #include "ehci-pmcmsp.c"
1311 #define PLATFORM_DRIVER         ehci_hcd_msp_driver
1312 #endif
1313
1314 #ifdef CONFIG_SPARC_LEON
1315 #include "ehci-grlib.c"
1316 #define PLATFORM_DRIVER         ehci_grlib_driver
1317 #endif
1318
1319 #ifdef CONFIG_USB_EHCI_MV
1320 #include "ehci-mv.c"
1321 #define        PLATFORM_DRIVER         ehci_mv_driver
1322 #endif
1323
1324 static int __init ehci_hcd_init(void)
1325 {
1326         int retval = 0;
1327
1328         if (usb_disabled())
1329                 return -ENODEV;
1330
1331         printk(KERN_INFO "%s: " DRIVER_DESC "\n", hcd_name);
1332         set_bit(USB_EHCI_LOADED, &usb_hcds_loaded);
1333         if (test_bit(USB_UHCI_LOADED, &usb_hcds_loaded) ||
1334                         test_bit(USB_OHCI_LOADED, &usb_hcds_loaded))
1335                 printk(KERN_WARNING "Warning! ehci_hcd should always be loaded"
1336                                 " before uhci_hcd and ohci_hcd, not after\n");
1337
1338         pr_debug("%s: block sizes: qh %zd qtd %zd itd %zd sitd %zd\n",
1339                  hcd_name,
1340                  sizeof(struct ehci_qh), sizeof(struct ehci_qtd),
1341                  sizeof(struct ehci_itd), sizeof(struct ehci_sitd));
1342
1343 #ifdef CONFIG_DYNAMIC_DEBUG
1344         ehci_debug_root = debugfs_create_dir("ehci", usb_debug_root);
1345         if (!ehci_debug_root) {
1346                 retval = -ENOENT;
1347                 goto err_debug;
1348         }
1349 #endif
1350
1351 #ifdef PLATFORM_DRIVER
1352         retval = platform_driver_register(&PLATFORM_DRIVER);
1353         if (retval < 0)
1354                 goto clean0;
1355 #endif
1356
1357 #ifdef PS3_SYSTEM_BUS_DRIVER
1358         retval = ps3_ehci_driver_register(&PS3_SYSTEM_BUS_DRIVER);
1359         if (retval < 0)
1360                 goto clean2;
1361 #endif
1362
1363 #ifdef OF_PLATFORM_DRIVER
1364         retval = platform_driver_register(&OF_PLATFORM_DRIVER);
1365         if (retval < 0)
1366                 goto clean3;
1367 #endif
1368
1369 #ifdef XILINX_OF_PLATFORM_DRIVER
1370         retval = platform_driver_register(&XILINX_OF_PLATFORM_DRIVER);
1371         if (retval < 0)
1372                 goto clean4;
1373 #endif
1374         return retval;
1375
1376 #ifdef XILINX_OF_PLATFORM_DRIVER
1377         /* platform_driver_unregister(&XILINX_OF_PLATFORM_DRIVER); */
1378 clean4:
1379 #endif
1380 #ifdef OF_PLATFORM_DRIVER
1381         platform_driver_unregister(&OF_PLATFORM_DRIVER);
1382 clean3:
1383 #endif
1384 #ifdef PS3_SYSTEM_BUS_DRIVER
1385         ps3_ehci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER);
1386 clean2:
1387 #endif
1388 #ifdef PLATFORM_DRIVER
1389         platform_driver_unregister(&PLATFORM_DRIVER);
1390 clean0:
1391 #endif
1392 #ifdef CONFIG_DYNAMIC_DEBUG
1393         debugfs_remove(ehci_debug_root);
1394         ehci_debug_root = NULL;
1395 err_debug:
1396 #endif
1397         clear_bit(USB_EHCI_LOADED, &usb_hcds_loaded);
1398         return retval;
1399 }
1400 module_init(ehci_hcd_init);
1401
1402 static void __exit ehci_hcd_cleanup(void)
1403 {
1404 #ifdef XILINX_OF_PLATFORM_DRIVER
1405         platform_driver_unregister(&XILINX_OF_PLATFORM_DRIVER);
1406 #endif
1407 #ifdef OF_PLATFORM_DRIVER
1408         platform_driver_unregister(&OF_PLATFORM_DRIVER);
1409 #endif
1410 #ifdef PLATFORM_DRIVER
1411         platform_driver_unregister(&PLATFORM_DRIVER);
1412 #endif
1413 #ifdef PS3_SYSTEM_BUS_DRIVER
1414         ps3_ehci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER);
1415 #endif
1416 #ifdef CONFIG_DYNAMIC_DEBUG
1417         debugfs_remove(ehci_debug_root);
1418 #endif
1419         clear_bit(USB_EHCI_LOADED, &usb_hcds_loaded);
1420 }
1421 module_exit(ehci_hcd_cleanup);