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/timer.h>
  34 #include <linux/ktime.h>
  35 #include <linux/list.h>
  36 #include <linux/interrupt.h>
  37 #include <linux/usb.h>
  38 #include <linux/usb/hcd.h>
  39 #include <linux/moduleparam.h>
  40 #include <linux/dma-mapping.h>
  41 #include <linux/debugfs.h>
  42 #include <linux/slab.h>
  43 #include <linux/uaccess.h>
  44
  45 #include <asm/byteorder.h>
  46 #include <asm/io.h>
  47 #include <asm/irq.h>
  48 #include <asm/unaligned.h>
  49
  50 #if defined(CONFIG_PPC_PS3)
  51 #include <asm/firmware.h>
  52 #endif
  53
  54 /*-------------------------------------------------------------------------*/
  55
  56 /*
  57  * EHCI hc_driver implementation ... experimental, incomplete.
  58  * Based on the final 1.0 register interface specification.
  59  *
  60  * USB 2.0 shows up in upcoming www.pcmcia.org technology.
  61  * First was PCMCIA, like ISA; then CardBus, which is PCI.
  62  * Next comes "CardBay", using USB 2.0 signals.
  63  *
  64  * Contains additional contributions by Brad Hards, Rory Bolt, and others.
  65  * Special thanks to Intel and VIA for providing host controllers to
  66  * test this driver on, and Cypress (including In-System Design) for
  67  * providing early devices for those host controllers to talk to!
  68  */
  69
  70 #define DRIVER_AUTHOR "David Brownell"
  71 #define DRIVER_DESC "USB 2.0 'Enhanced' Host Controller (EHCI) Driver"
  72
  73 static const char       hcd_name [] = "ehci_hcd";
  74
  75
  76 #undef VERBOSE_DEBUG
  77 #undef EHCI_URB_TRACE
  78
  79 #ifdef DEBUG
  80 #define EHCI_STATS
  81 #endif
  82
  83 /* magic numbers that can affect system performance */
  84 #define EHCI_TUNE_CERR          3       /* 0-3 qtd retries; 0 == don't stop */
  85 #define EHCI_TUNE_RL_HS         4       /* nak throttle; see 4.9 */
  86 #define EHCI_TUNE_RL_TT         0
  87 #define EHCI_TUNE_MULT_HS       1       /* 1-3 transactions/uframe; 4.10.3 */
  88 #define EHCI_TUNE_MULT_TT       1
  89 /*
  90  * Some drivers think it's safe to schedule isochronous transfers more than
  91  * 256 ms into the future (partly as a result of an old bug in the scheduling
  92  * code).  In an attempt to avoid trouble, we will use a minimum scheduling
  93  * length of 512 frames instead of 256.
  94  */
  95 #define EHCI_TUNE_FLS           1       /* (medium) 512-frame schedule */
  96
  97 #define EHCI_IAA_MSECS          10              /* arbitrary */
  98 #define EHCI_IO_JIFFIES         (HZ/10)         /* io watchdog > irq_thresh */
  99 #define EHCI_ASYNC_JIFFIES      (HZ/20)         /* async idle timeout */
 100 #define EHCI_SHRINK_JIFFIES     (DIV_ROUND_UP(HZ, 200) + 1)
 101                                                 /* 5-ms async qh unlink delay */
 102
 103 /* Initial IRQ latency:  faster than hw default */
 104 static int log2_irq_thresh = 0;         // 0 to 6
 105 module_param (log2_irq_thresh, int, S_IRUGO);
 106 MODULE_PARM_DESC (log2_irq_thresh, "log2 IRQ latency, 1-64 microframes");
 107
 108 /* initial park setting:  slower than hw default */
 109 static unsigned park = 0;
 110 module_param (park, uint, S_IRUGO);
 111 MODULE_PARM_DESC (park, "park setting; 1-3 back-to-back async packets");
 112
 113 /* for flakey hardware, ignore overcurrent indicators */
 114 static bool ignore_oc = 0;
 115 module_param (ignore_oc, bool, S_IRUGO);
 116 MODULE_PARM_DESC (ignore_oc, "ignore bogus hardware overcurrent indications");
 117
 118 /* for link power management(LPM) feature */
 119 static unsigned int hird;
 120 module_param(hird, int, S_IRUGO);
 121 MODULE_PARM_DESC(hird, "host initiated resume duration, +1 for each 75us");
 122
 123 #define INTR_MASK (STS_IAA | STS_FATAL | STS_PCD | STS_ERR | STS_INT)
 124
 125 /*-------------------------------------------------------------------------*/
 126
 127 #include "ehci.h"
 128 #include "ehci-dbg.c"
 129 #include "pci-quirks.h"
 130
 131 /*-------------------------------------------------------------------------*/
 132
 133 static void
 134 timer_action(struct ehci_hcd *ehci, enum ehci_timer_action action)
 135 {
 136         /* Don't override timeouts which shrink or (later) disable
 137          * the async ring; just the I/O watchdog.  Note that if a
 138          * SHRINK were pending, OFF would never be requested.
 139          */
 140         if (timer_pending(&ehci->watchdog)
 141                         && ((BIT(TIMER_ASYNC_SHRINK) | BIT(TIMER_ASYNC_OFF))
 142                                 & ehci->actions))
 143                 return;
 144
 145         if (!test_and_set_bit(action, &ehci->actions)) {
 146                 unsigned long t;
 147
 148                 switch (action) {
 149                 case TIMER_IO_WATCHDOG:
 150                         if (!ehci->need_io_watchdog)
 151                                 return;
 152                         t = EHCI_IO_JIFFIES;
 153                         break;
 154                 case TIMER_ASYNC_OFF:
 155                         t = EHCI_ASYNC_JIFFIES;
 156                         break;
 157                 /* case TIMER_ASYNC_SHRINK: */
 158                 default:
 159                         t = EHCI_SHRINK_JIFFIES;
 160                         break;
 161                 }
 162                 mod_timer(&ehci->watchdog, t + jiffies);
 163         }
 164 }
 165
 166 /*-------------------------------------------------------------------------*/
 167
 168 /*
 169  * handshake - spin reading hc until handshake completes or fails
 170  * @ptr: address of hc register to be read
 171  * @mask: bits to look at in result of read
 172  * @done: value of those bits when handshake succeeds
 173  * @usec: timeout in microseconds
 174  *
 175  * Returns negative errno, or zero on success
 176  *
 177  * Success happens when the "mask" bits have the specified value (hardware
 178  * handshake done).  There are two failure modes:  "usec" have passed (major
 179  * hardware flakeout), or the register reads as all-ones (hardware removed).
 180  *
 181  * That last failure should_only happen in cases like physical cardbus eject
 182  * before driver shutdown. But it also seems to be caused by bugs in cardbus
 183  * bridge shutdown:  shutting down the bridge before the devices using it.
 184  */
 185 static int handshake (struct ehci_hcd *ehci, void __iomem *ptr,
 186                       u32 mask, u32 done, int usec)
 187 {
 188         u32     result;
 189
 190         do {
 191                 result = ehci_readl(ehci, ptr);
 192                 if (result == ~(u32)0)          /* card removed */
 193                         return -ENODEV;
 194                 result &= mask;
 195                 if (result == done)
 196                         return 0;
 197                 udelay (1);
 198                 usec--;
 199         } while (usec > 0);
 200         return -ETIMEDOUT;
 201 }
 202
 203 /* check TDI/ARC silicon is in host mode */
 204 static int tdi_in_host_mode (struct ehci_hcd *ehci)
 205 {
 206         u32 __iomem     *reg_ptr;
 207         u32             tmp;
 208
 209         reg_ptr = (u32 __iomem *)(((u8 __iomem *)ehci->regs) + USBMODE);
 210         tmp = ehci_readl(ehci, reg_ptr);
 211         return (tmp & 3) == USBMODE_CM_HC;
 212 }
 213
 214 /* force HC to halt state from unknown (EHCI spec section 2.3) */
 215 static int ehci_halt (struct ehci_hcd *ehci)
 216 {
 217         u32     temp = ehci_readl(ehci, &ehci->regs->status);
 218
 219         /* disable any irqs left enabled by previous code */
 220         ehci_writel(ehci, 0, &ehci->regs->intr_enable);
 221
 222         if (ehci_is_TDI(ehci) && tdi_in_host_mode(ehci) == 0) {
 223                 return 0;
 224         }
 225
 226         if ((temp & STS_HALT) != 0)
 227                 return 0;
 228
 229         /*
 230          * This routine gets called during probe before ehci->command
 231          * has been initialized, so we can't rely on its value.
 232          */
 233         ehci->command &= ~CMD_RUN;
 234         temp = ehci_readl(ehci, &ehci->regs->command);
 235         temp &= ~(CMD_RUN | CMD_IAAD);
 236         ehci_writel(ehci, temp, &ehci->regs->command);
 237         return handshake (ehci, &ehci->regs->status,
 238                           STS_HALT, STS_HALT, 16 * 125);
 239 }
 240
 241 #if defined(CONFIG_USB_SUSPEND) && defined(CONFIG_PPC_PS3)
 242
 243 /*
 244  * The EHCI controller of the Cell Super Companion Chip used in the
 245  * PS3 will stop the root hub after all root hub ports are suspended.
 246  * When in this condition handshake will return -ETIMEDOUT.  The
 247  * STS_HLT bit will not be set, so inspection of the frame index is
 248  * used here to test for the condition.  If the condition is found
 249  * return success to allow the USB suspend to complete.
 250  */
 251
 252 static int handshake_for_broken_root_hub(struct ehci_hcd *ehci,
 253                                          void __iomem *ptr, u32 mask, u32 done,
 254                                          int usec)
 255 {
 256         unsigned int old_index;
 257         int error;
 258
 259         if (!firmware_has_feature(FW_FEATURE_PS3_LV1))
 260                 return -ETIMEDOUT;
 261
 262         old_index = ehci_read_frame_index(ehci);
 263
 264         error = handshake(ehci, ptr, mask, done, usec);
 265
 266         if (error == -ETIMEDOUT && ehci_read_frame_index(ehci) == old_index)
 267                 return 0;
 268
 269         return error;
 270 }
 271
 272 #else
 273
 274 static int handshake_for_broken_root_hub(struct ehci_hcd *ehci,
 275                                          void __iomem *ptr, u32 mask, u32 done,
 276                                          int usec)
 277 {
 278         return -ETIMEDOUT;
 279 }
 280
 281 #endif
 282
 283 static int handshake_on_error_set_halt(struct ehci_hcd *ehci, void __iomem *ptr,
 284                                        u32 mask, u32 done, int usec)
 285 {
 286         int error;
 287
 288         error = handshake(ehci, ptr, mask, done, usec);
 289         if (error == -ETIMEDOUT)
 290                 error = handshake_for_broken_root_hub(ehci, ptr, mask, done,
 291                                                       usec);
 292
 293         if (error) {
 294                 ehci_halt(ehci);
 295                 ehci->rh_state = EHCI_RH_HALTED;
 296                 ehci_err(ehci, "force halt; handshake %p %08x %08x -> %d\n",
 297                         ptr, mask, done, error);
 298         }
 299
 300         return error;
 301 }
 302
 303 /* put TDI/ARC silicon into EHCI mode */
 304 static void tdi_reset (struct ehci_hcd *ehci)
 305 {
 306         u32 __iomem     *reg_ptr;
 307         u32             tmp;
 308
 309         reg_ptr = (u32 __iomem *)(((u8 __iomem *)ehci->regs) + USBMODE);
 310         tmp = ehci_readl(ehci, reg_ptr);
 311         tmp |= USBMODE_CM_HC;
 312         /* The default byte access to MMR space is LE after
 313          * controller reset. Set the required endian mode
 314          * for transfer buffers to match the host microprocessor
 315          */
 316         if (ehci_big_endian_mmio(ehci))
 317                 tmp |= USBMODE_BE;
 318         ehci_writel(ehci, tmp, reg_ptr);
 319 }
 320
 321 /* reset a non-running (STS_HALT == 1) controller */
 322 static int ehci_reset (struct ehci_hcd *ehci)
 323 {
 324         int     retval;
 325         u32     command = ehci_readl(ehci, &ehci->regs->command);
 326
 327         /* If the EHCI debug controller is active, special care must be
 328          * taken before and after a host controller reset */
 329         if (ehci->debug && !dbgp_reset_prep())
 330                 ehci->debug = NULL;
 331
 332         command |= CMD_RESET;
 333         dbg_cmd (ehci, "reset", command);
 334         ehci_writel(ehci, command, &ehci->regs->command);
 335         ehci->rh_state = EHCI_RH_HALTED;
 336         ehci->next_statechange = jiffies;
 337         retval = handshake (ehci, &ehci->regs->command,
 338                             CMD_RESET, 0, 250 * 1000);
 339
 340         if (ehci->has_hostpc) {
 341                 ehci_writel(ehci, USBMODE_EX_HC | USBMODE_EX_VBPS,
 342                         (u32 __iomem *)(((u8 *)ehci->regs) + USBMODE_EX));
 343                 ehci_writel(ehci, TXFIFO_DEFAULT,
 344                         (u32 __iomem *)(((u8 *)ehci->regs) + TXFILLTUNING));
 345         }
 346         if (retval)
 347                 return retval;
 348
 349         if (ehci_is_TDI(ehci))
 350                 tdi_reset (ehci);
 351
 352         if (ehci->debug)
 353                 dbgp_external_startup();
 354
 355         ehci->command = ehci_readl(ehci, &ehci->regs->command);
 356         ehci->port_c_suspend = ehci->suspended_ports =
 357                         ehci->resuming_ports = 0;
 358         return retval;
 359 }
 360
 361 /* idle the controller (from running) */
 362 static void ehci_quiesce (struct ehci_hcd *ehci)
 363 {
 364         u32     temp;
 365
 366 #ifdef DEBUG
 367         if (ehci->rh_state != EHCI_RH_RUNNING)
 368                 BUG ();
 369 #endif
 370
 371         /* wait for any schedule enables/disables to take effect */
 372         temp = (ehci->command << 10) & (STS_ASS | STS_PSS);
 373         if (handshake_on_error_set_halt(ehci, &ehci->regs->status,
 374                                         STS_ASS | STS_PSS, temp, 16 * 125))
 375                 return;
 376
 377         /* then disable anything that's still active */
 378         ehci->command &= ~(CMD_ASE | CMD_PSE);
 379         ehci_writel(ehci, ehci->command, &ehci->regs->command);
 380
 381         /* hardware can take 16 microframes to turn off ... */
 382         handshake_on_error_set_halt(ehci, &ehci->regs->status,
 383                                     STS_ASS | STS_PSS, 0, 16 * 125);
 384 }
 385
 386 /*-------------------------------------------------------------------------*/
 387
 388 static void end_unlink_async(struct ehci_hcd *ehci);
 389 static void ehci_work(struct ehci_hcd *ehci);
 390
 391 #include "ehci-hub.c"
 392 #include "ehci-lpm.c"
 393 #include "ehci-mem.c"
 394 #include "ehci-q.c"
 395 #include "ehci-sched.c"
 396 #include "ehci-sysfs.c"
 397
 398 /*-------------------------------------------------------------------------*/
 399
 400 static void ehci_iaa_watchdog(unsigned long param)
 401 {
 402         struct ehci_hcd         *ehci = (struct ehci_hcd *) param;
 403         unsigned long           flags;
 404
 405         spin_lock_irqsave (&ehci->lock, flags);
 406
 407         /* Lost IAA irqs wedge things badly; seen first with a vt8235.
 408          * So we need this watchdog, but must protect it against both
 409          * (a) SMP races against real IAA firing and retriggering, and
 410          * (b) clean HC shutdown, when IAA watchdog was pending.
 411          */
 412         if (ehci->reclaim
 413                         && !timer_pending(&ehci->iaa_watchdog)
 414                         && ehci->rh_state == EHCI_RH_RUNNING) {
 415                 u32 cmd, status;
 416
 417                 /* If we get here, IAA is *REALLY* late.  It's barely
 418                  * conceivable that the system is so busy that CMD_IAAD
 419                  * is still legitimately set, so let's be sure it's
 420                  * clear before we read STS_IAA.  (The HC should clear
 421                  * CMD_IAAD when it sets STS_IAA.)
 422                  */
 423                 cmd = ehci_readl(ehci, &ehci->regs->command);
 424
 425                 /* If IAA is set here it either legitimately triggered
 426                  * before we cleared IAAD above (but _way_ late, so we'll
 427                  * still count it as lost) ... or a silicon erratum:
 428                  * - VIA seems to set IAA without triggering the IRQ;
 429                  * - IAAD potentially cleared without setting IAA.
 430                  */
 431                 status = ehci_readl(ehci, &ehci->regs->status);
 432                 if ((status & STS_IAA) || !(cmd & CMD_IAAD)) {
 433                         COUNT (ehci->stats.lost_iaa);
 434                         ehci_writel(ehci, STS_IAA, &ehci->regs->status);
 435                 }
 436
 437                 ehci_vdbg(ehci, "IAA watchdog: status %x cmd %x\n",
 438                                 status, cmd);
 439                 end_unlink_async(ehci);
 440         }
 441
 442         spin_unlock_irqrestore(&ehci->lock, flags);
 443 }
 444
 445 static void ehci_watchdog(unsigned long param)
 446 {
 447         struct ehci_hcd         *ehci = (struct ehci_hcd *) param;
 448         unsigned long           flags;
 449
 450         spin_lock_irqsave(&ehci->lock, flags);
 451
 452         /* stop async processing after it's idled a bit */
 453         if (test_bit (TIMER_ASYNC_OFF, &ehci->actions))
 454                 start_unlink_async (ehci, ehci->async);
 455
 456         /* ehci could run by timer, without IRQs ... */
 457         ehci_work (ehci);
 458
 459         spin_unlock_irqrestore (&ehci->lock, flags);
 460 }
 461
 462 /* On some systems, leaving remote wakeup enabled prevents system shutdown.
 463  * The firmware seems to think that powering off is a wakeup event!
 464  * This routine turns off remote wakeup and everything else, on all ports.
 465  */
 466 static void ehci_turn_off_all_ports(struct ehci_hcd *ehci)
 467 {
 468         int     port = HCS_N_PORTS(ehci->hcs_params);
 469
 470         while (port--)
 471                 ehci_writel(ehci, PORT_RWC_BITS,
 472                                 &ehci->regs->port_status[port]);
 473 }
 474
 475 /*
 476  * Halt HC, turn off all ports, and let the BIOS use the companion controllers.
 477  * Should be called with ehci->lock held.
 478  */
 479 static void ehci_silence_controller(struct ehci_hcd *ehci)
 480 {
 481         ehci_halt(ehci);
 482         ehci_turn_off_all_ports(ehci);
 483
 484         /* make BIOS/etc use companion controller during reboot */
 485         ehci_writel(ehci, 0, &ehci->regs->configured_flag);
 486
 487         /* unblock posted writes */
 488         ehci_readl(ehci, &ehci->regs->configured_flag);
 489 }
 490
 491 /* ehci_shutdown kick in for silicon on any bus (not just pci, etc).
 492  * This forcibly disables dma and IRQs, helping kexec and other cases
 493  * where the next system software may expect clean state.
 494  */
 495 static void ehci_shutdown(struct usb_hcd *hcd)
 496 {
 497         struct ehci_hcd *ehci = hcd_to_ehci(hcd);
 498
 499         del_timer_sync(&ehci->watchdog);
 500         del_timer_sync(&ehci->iaa_watchdog);
 501
 502         spin_lock_irq(&ehci->lock);
 503         ehci_silence_controller(ehci);
 504         spin_unlock_irq(&ehci->lock);
 505 }
 506
 507 static void ehci_port_power (struct ehci_hcd *ehci, int is_on)
 508 {
 509         unsigned port;
 510
 511         if (!HCS_PPC (ehci->hcs_params))
 512                 return;
 513
 514         ehci_dbg (ehci, "...power%s ports...\n", is_on ? "up" : "down");
 515         for (port = HCS_N_PORTS (ehci->hcs_params); port > 0; )
 516                 (void) ehci_hub_control(ehci_to_hcd(ehci),
 517                                 is_on ? SetPortFeature : ClearPortFeature,
 518                                 USB_PORT_FEAT_POWER,
 519                                 port--, NULL, 0);
 520         /* Flush those writes */
 521         ehci_readl(ehci, &ehci->regs->command);
 522         msleep(20);
 523 }
 524
 525 /*-------------------------------------------------------------------------*/
 526
 527 /*
 528  * ehci_work is called from some interrupts, timers, and so on.
 529  * it calls driver completion functions, after dropping ehci->lock.
 530  */
 531 static void ehci_work (struct ehci_hcd *ehci)
 532 {
 533         timer_action_done (ehci, TIMER_IO_WATCHDOG);
 534
 535         /* another CPU may drop ehci->lock during a schedule scan while
 536          * it reports urb completions.  this flag guards against bogus
 537          * attempts at re-entrant schedule scanning.
 538          */
 539         if (ehci->scanning)
 540                 return;
 541         ehci->scanning = 1;
 542         scan_async (ehci);
 543         if (ehci->next_uframe != -1)
 544                 scan_periodic (ehci);
 545         ehci->scanning = 0;
 546
 547         /* the IO watchdog guards against hardware or driver bugs that
 548          * misplace IRQs, and should let us run completely without IRQs.
 549          * such lossage has been observed on both VT6202 and VT8235.
 550          */
 551         if (ehci->rh_state == EHCI_RH_RUNNING &&
 552                         (ehci->async->qh_next.ptr != NULL ||
 553                          ehci->periodic_sched != 0))
 554                 timer_action (ehci, TIMER_IO_WATCHDOG);
 555 }
 556
 557 /*
 558  * Called when the ehci_hcd module is removed.
 559  */
 560 static void ehci_stop (struct usb_hcd *hcd)
 561 {
 562         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 563
 564         ehci_dbg (ehci, "stop\n");
 565
 566         /* no more interrupts ... */
 567         del_timer_sync (&ehci->watchdog);
 568         del_timer_sync(&ehci->iaa_watchdog);
 569
 570         spin_lock_irq(&ehci->lock);
 571         if (ehci->rh_state == EHCI_RH_RUNNING)
 572                 ehci_quiesce (ehci);
 573
 574         ehci_silence_controller(ehci);
 575         ehci_reset (ehci);
 576         spin_unlock_irq(&ehci->lock);
 577
 578         remove_sysfs_files(ehci);
 579         remove_debug_files (ehci);
 580
 581         /* root hub is shut down separately (first, when possible) */
 582         spin_lock_irq (&ehci->lock);
 583         if (ehci->async)
 584                 ehci_work (ehci);
 585         spin_unlock_irq (&ehci->lock);
 586         ehci_mem_cleanup (ehci);
 587
 588         if (ehci->amd_pll_fix == 1)
 589                 usb_amd_dev_put();
 590
 591 #ifdef  EHCI_STATS
 592         ehci_dbg (ehci, "irq normal %ld err %ld reclaim %ld (lost %ld)\n",
 593                 ehci->stats.normal, ehci->stats.error, ehci->stats.reclaim,
 594                 ehci->stats.lost_iaa);
 595         ehci_dbg (ehci, "complete %ld unlink %ld\n",
 596                 ehci->stats.complete, ehci->stats.unlink);
 597 #endif
 598
 599         dbg_status (ehci, "ehci_stop completed",
 600                     ehci_readl(ehci, &ehci->regs->status));
 601 }
 602
 603 /* one-time init, only for memory state */
 604 static int ehci_init(struct usb_hcd *hcd)
 605 {
 606         struct ehci_hcd         *ehci = hcd_to_ehci(hcd);
 607         u32                     temp;
 608         int                     retval;
 609         u32                     hcc_params;
 610         struct ehci_qh_hw       *hw;
 611
 612         spin_lock_init(&ehci->lock);
 613
 614         /*
 615          * keep io watchdog by default, those good HCDs could turn off it later
 616          */
 617         ehci->need_io_watchdog = 1;
 618         init_timer(&ehci->watchdog);
 619         ehci->watchdog.function = ehci_watchdog;
 620         ehci->watchdog.data = (unsigned long) ehci;
 621
 622         init_timer(&ehci->iaa_watchdog);
 623         ehci->iaa_watchdog.function = ehci_iaa_watchdog;
 624         ehci->iaa_watchdog.data = (unsigned long) ehci;
 625
 626         hcc_params = ehci_readl(ehci, &ehci->caps->hcc_params);
 627
 628         /*
 629          * by default set standard 80% (== 100 usec/uframe) max periodic
 630          * bandwidth as required by USB 2.0
 631          */
 632         ehci->uframe_periodic_max = 100;
 633
 634         /*
 635          * hw default: 1K periodic list heads, one per frame.
 636          * periodic_size can shrink by USBCMD update if hcc_params allows.
 637          */
 638         ehci->periodic_size = DEFAULT_I_TDPS;
 639         INIT_LIST_HEAD(&ehci->cached_itd_list);
 640         INIT_LIST_HEAD(&ehci->cached_sitd_list);
 641
 642         if (HCC_PGM_FRAMELISTLEN(hcc_params)) {
 643                 /* periodic schedule size can be smaller than default */
 644                 switch (EHCI_TUNE_FLS) {
 645                 case 0: ehci->periodic_size = 1024; break;
 646                 case 1: ehci->periodic_size = 512; break;
 647                 case 2: ehci->periodic_size = 256; break;
 648                 default:        BUG();
 649                 }
 650         }
 651         if ((retval = ehci_mem_init(ehci, GFP_KERNEL)) < 0)
 652                 return retval;
 653
 654         /* controllers may cache some of the periodic schedule ... */
 655         if (HCC_ISOC_CACHE(hcc_params))         // full frame cache
 656                 ehci->i_thresh = 2 + 8;
 657         else                                    // N microframes cached
 658                 ehci->i_thresh = 2 + HCC_ISOC_THRES(hcc_params);
 659
 660         ehci->reclaim = NULL;
 661         ehci->next_uframe = -1;
 662         ehci->clock_frame = -1;
 663
 664         /*
 665          * dedicate a qh for the async ring head, since we couldn't unlink
 666          * a 'real' qh without stopping the async schedule [4.8].  use it
 667          * as the 'reclamation list head' too.
 668          * its dummy is used in hw_alt_next of many tds, to prevent the qh
 669          * from automatically advancing to the next td after short reads.
 670          */
 671         ehci->async->qh_next.qh = NULL;
 672         hw = ehci->async->hw;
 673         hw->hw_next = QH_NEXT(ehci, ehci->async->qh_dma);
 674         hw->hw_info1 = cpu_to_hc32(ehci, QH_HEAD);
 675         hw->hw_info1 |= cpu_to_hc32(ehci, (1 << 7));    /* I = 1 */
 676         hw->hw_token = cpu_to_hc32(ehci, QTD_STS_HALT);
 677         hw->hw_qtd_next = EHCI_LIST_END(ehci);
 678         ehci->async->qh_state = QH_STATE_LINKED;
 679         hw->hw_alt_next = QTD_NEXT(ehci, ehci->async->dummy->qtd_dma);
 680
 681         /* clear interrupt enables, set irq latency */
 682         if (log2_irq_thresh < 0 || log2_irq_thresh > 6)
 683                 log2_irq_thresh = 0;
 684         temp = 1 << (16 + log2_irq_thresh);
 685         if (HCC_PER_PORT_CHANGE_EVENT(hcc_params)) {
 686                 ehci->has_ppcd = 1;
 687                 ehci_dbg(ehci, "enable per-port change event\n");
 688                 temp |= CMD_PPCEE;
 689         }
 690         if (HCC_CANPARK(hcc_params)) {
 691                 /* HW default park == 3, on hardware that supports it (like
 692                  * NVidia and ALI silicon), maximizes throughput on the async
 693                  * schedule by avoiding QH fetches between transfers.
 694                  *
 695                  * With fast usb storage devices and NForce2, "park" seems to
 696                  * make problems:  throughput reduction (!), data errors...
 697                  */
 698                 if (park) {
 699                         park = min(park, (unsigned) 3);
 700                         temp |= CMD_PARK;
 701                         temp |= park << 8;
 702                 }
 703                 ehci_dbg(ehci, "park %d\n", park);
 704         }
 705         if (HCC_PGM_FRAMELISTLEN(hcc_params)) {
 706                 /* periodic schedule size can be smaller than default */
 707                 temp &= ~(3 << 2);
 708                 temp |= (EHCI_TUNE_FLS << 2);
 709         }
 710         if (HCC_LPM(hcc_params)) {
 711                 /* support link power management EHCI 1.1 addendum */
 712                 ehci_dbg(ehci, "support lpm\n");
 713                 ehci->has_lpm = 1;
 714                 if (hird > 0xf) {
 715                         ehci_dbg(ehci, "hird %d invalid, use default 0",
 716                         hird);
 717                         hird = 0;
 718                 }
 719                 temp |= hird << 24;
 720         }
 721         ehci->command = temp;
 722
 723         /* Accept arbitrarily long scatter-gather lists */
 724         if (!(hcd->driver->flags & HCD_LOCAL_MEM))
 725                 hcd->self.sg_tablesize = ~0;
 726         return 0;
 727 }
 728
 729 /* start HC running; it's halted, ehci_init() has been run (once) */
 730 static int ehci_run (struct usb_hcd *hcd)
 731 {
 732         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 733         u32                     temp;
 734         u32                     hcc_params;
 735
 736         hcd->uses_new_polling = 1;
 737
 738         /* EHCI spec section 4.1 */
 739
 740         ehci_writel(ehci, ehci->periodic_dma, &ehci->regs->frame_list);
 741         ehci_writel(ehci, (u32)ehci->async->qh_dma, &ehci->regs->async_next);
 742
 743         /*
 744          * hcc_params controls whether ehci->regs->segment must (!!!)
 745          * be used; it constrains QH/ITD/SITD and QTD locations.
 746          * pci_pool consistent memory always uses segment zero.
 747          * streaming mappings for I/O buffers, like pci_map_single(),
 748          * can return segments above 4GB, if the device allows.
 749          *
 750          * NOTE:  the dma mask is visible through dma_supported(), so
 751          * drivers can pass this info along ... like NETIF_F_HIGHDMA,
 752          * Scsi_Host.highmem_io, and so forth.  It's readonly to all
 753          * host side drivers though.
 754          */
 755         hcc_params = ehci_readl(ehci, &ehci->caps->hcc_params);
 756         if (HCC_64BIT_ADDR(hcc_params)) {
 757                 ehci_writel(ehci, 0, &ehci->regs->segment);
 758 #if 0
 759 // this is deeply broken on almost all architectures
 760                 if (!dma_set_mask(hcd->self.controller, DMA_BIT_MASK(64)))
 761                         ehci_info(ehci, "enabled 64bit DMA\n");
 762 #endif
 763         }
 764
 765
 766         // Philips, Intel, and maybe others need CMD_RUN before the
 767         // root hub will detect new devices (why?); NEC doesn't
 768         ehci->command &= ~(CMD_LRESET|CMD_IAAD|CMD_PSE|CMD_ASE|CMD_RESET);
 769         ehci->command |= CMD_RUN;
 770         ehci_writel(ehci, ehci->command, &ehci->regs->command);
 771         dbg_cmd (ehci, "init", ehci->command);
 772
 773         /*
 774          * Start, enabling full USB 2.0 functionality ... usb 1.1 devices
 775          * are explicitly handed to companion controller(s), so no TT is
 776          * involved with the root hub.  (Except where one is integrated,
 777          * and there's no companion controller unless maybe for USB OTG.)
 778          *
 779          * Turning on the CF flag will transfer ownership of all ports
 780          * from the companions to the EHCI controller.  If any of the
 781          * companions are in the middle of a port reset at the time, it
 782          * could cause trouble.  Write-locking ehci_cf_port_reset_rwsem
 783          * guarantees that no resets are in progress.  After we set CF,
 784          * a short delay lets the hardware catch up; new resets shouldn't
 785          * be started before the port switching actions could complete.
 786          */
 787         down_write(&ehci_cf_port_reset_rwsem);
 788         ehci->rh_state = EHCI_RH_RUNNING;
 789         ehci_writel(ehci, FLAG_CF, &ehci->regs->configured_flag);
 790         ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
 791         msleep(5);
 792         up_write(&ehci_cf_port_reset_rwsem);
 793         ehci->last_periodic_enable = ktime_get_real();
 794
 795         temp = HC_VERSION(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
 796         ehci_info (ehci,
 797                 "USB %x.%x started, EHCI %x.%02x%s\n",
 798                 ((ehci->sbrn & 0xf0)>>4), (ehci->sbrn & 0x0f),
 799                 temp >> 8, temp & 0xff,
 800                 ignore_oc ? ", overcurrent ignored" : "");
 801
 802         ehci_writel(ehci, INTR_MASK,
 803                     &ehci->regs->intr_enable); /* Turn On Interrupts */
 804
 805         /* GRR this is run-once init(), being done every time the HC starts.
 806          * So long as they're part of class devices, we can't do it init()
 807          * since the class device isn't created that early.
 808          */
 809         create_debug_files(ehci);
 810         create_sysfs_files(ehci);
 811
 812         return 0;
 813 }
 814
 815 static int __maybe_unused ehci_setup (struct usb_hcd *hcd)
 816 {
 817         struct ehci_hcd *ehci = hcd_to_ehci(hcd);
 818         int retval;
 819
 820         ehci->regs = (void __iomem *)ehci->caps +
 821             HC_LENGTH(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
 822         dbg_hcs_params(ehci, "reset");
 823         dbg_hcc_params(ehci, "reset");
 824
 825         /* cache this readonly data; minimize chip reads */
 826         ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);
 827
 828         ehci->sbrn = HCD_USB2;
 829
 830         retval = ehci_halt(ehci);
 831         if (retval)
 832                 return retval;
 833
 834         /* data structure init */
 835         retval = ehci_init(hcd);
 836         if (retval)
 837                 return retval;
 838
 839         ehci_reset(ehci);
 840
 841         return 0;
 842 }
 843
 844 /*-------------------------------------------------------------------------*/
 845
 846 static irqreturn_t ehci_irq (struct usb_hcd *hcd)
 847 {
 848         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 849         u32                     status, masked_status, pcd_status = 0, cmd;
 850         int                     bh;
 851
 852         spin_lock (&ehci->lock);
 853
 854         status = ehci_readl(ehci, &ehci->regs->status);
 855
 856         /* e.g. cardbus physical eject */
 857         if (status == ~(u32) 0) {
 858                 ehci_dbg (ehci, "device removed\n");
 859                 goto dead;
 860         }
 861
 862         /*
 863          * We don't use STS_FLR, but some controllers don't like it to
 864          * remain on, so mask it out along with the other status bits.
 865          */
 866         masked_status = status & (INTR_MASK | STS_FLR);
 867
 868         /* Shared IRQ? */
 869         if (!masked_status || unlikely(ehci->rh_state == EHCI_RH_HALTED)) {
 870                 spin_unlock(&ehci->lock);
 871                 return IRQ_NONE;
 872         }
 873
 874         /* clear (just) interrupts */
 875         ehci_writel(ehci, masked_status, &ehci->regs->status);
 876         cmd = ehci_readl(ehci, &ehci->regs->command);
 877         bh = 0;
 878
 879 #ifdef  VERBOSE_DEBUG
 880         /* unrequested/ignored: Frame List Rollover */
 881         dbg_status (ehci, "irq", status);
 882 #endif
 883
 884         /* INT, ERR, and IAA interrupt rates can be throttled */
 885
 886         /* normal [4.15.1.2] or error [4.15.1.1] completion */
 887         if (likely ((status & (STS_INT|STS_ERR)) != 0)) {
 888                 if (likely ((status & STS_ERR) == 0))
 889                         COUNT (ehci->stats.normal);
 890                 else
 891                         COUNT (ehci->stats.error);
 892                 bh = 1;
 893         }
 894
 895         /* complete the unlinking of some qh [4.15.2.3] */
 896         if (status & STS_IAA) {
 897                 /* guard against (alleged) silicon errata */
 898                 if (cmd & CMD_IAAD)
 899                         ehci_dbg(ehci, "IAA with IAAD still set?\n");
 900                 if (ehci->reclaim) {
 901                         COUNT(ehci->stats.reclaim);
 902                         end_unlink_async(ehci);
 903                 } else
 904                         ehci_dbg(ehci, "IAA with nothing to reclaim?\n");
 905         }
 906
 907         /* remote wakeup [4.3.1] */
 908         if (status & STS_PCD) {
 909                 unsigned        i = HCS_N_PORTS (ehci->hcs_params);
 910                 u32             ppcd = 0;
 911
 912                 /* kick root hub later */
 913                 pcd_status = status;
 914
 915                 /* resume root hub? */
 916                 if (ehci->rh_state == EHCI_RH_SUSPENDED)
 917                         usb_hcd_resume_root_hub(hcd);
 918
 919                 /* get per-port change detect bits */
 920                 if (ehci->has_ppcd)
 921                         ppcd = status >> 16;
 922
 923                 while (i--) {
 924                         int pstatus;
 925
 926                         /* leverage per-port change bits feature */
 927                         if (ehci->has_ppcd && !(ppcd & (1 << i)))
 928                                 continue;
 929                         pstatus = ehci_readl(ehci,
 930                                          &ehci->regs->port_status[i]);
 931
 932                         if (pstatus & PORT_OWNER)
 933                                 continue;
 934                         if (!(test_bit(i, &ehci->suspended_ports) &&
 935                                         ((pstatus & PORT_RESUME) ||
 936                                                 !(pstatus & PORT_SUSPEND)) &&
 937                                         (pstatus & PORT_PE) &&
 938                                         ehci->reset_done[i] == 0))
 939                                 continue;
 940
 941                         /* start 20 msec resume signaling from this port,
 942                          * and make khubd collect PORT_STAT_C_SUSPEND to
 943                          * stop that signaling.  Use 5 ms extra for safety,
 944                          * like usb_port_resume() does.
 945                          */
 946                         ehci->reset_done[i] = jiffies + msecs_to_jiffies(25);
 947                         set_bit(i, &ehci->resuming_ports);
 948                         ehci_dbg (ehci, "port %d remote wakeup\n", i + 1);
 949                         mod_timer(&hcd->rh_timer, ehci->reset_done[i]);
 950                 }
 951         }
 952
 953         /* PCI errors [4.15.2.4] */
 954         if (unlikely ((status & STS_FATAL) != 0)) {
 955                 ehci_err(ehci, "fatal error\n");
 956                 dbg_cmd(ehci, "fatal", cmd);
 957                 dbg_status(ehci, "fatal", status);
 958                 ehci_halt(ehci);
 959 dead:
 960                 ehci_reset(ehci);
 961                 ehci_writel(ehci, 0, &ehci->regs->configured_flag);
 962                 usb_hc_died(hcd);
 963                 /* generic layer kills/unlinks all urbs, then
 964                  * uses ehci_stop to clean up the rest
 965                  */
 966                 bh = 1;
 967         }
 968
 969         if (bh)
 970                 ehci_work (ehci);
 971         spin_unlock (&ehci->lock);
 972         if (pcd_status)
 973                 usb_hcd_poll_rh_status(hcd);
 974         return IRQ_HANDLED;
 975 }
 976
 977 /*-------------------------------------------------------------------------*/
 978
 979 /*
 980  * non-error returns are a promise to giveback() the urb later
 981  * we drop ownership so next owner (or urb unlink) can get it
 982  *
 983  * urb + dev is in hcd.self.controller.urb_list
 984  * we're queueing TDs onto software and hardware lists
 985  *
 986  * hcd-specific init for hcpriv hasn't been done yet
 987  *
 988  * NOTE:  control, bulk, and interrupt share the same code to append TDs
 989  * to a (possibly active) QH, and the same QH scanning code.
 990  */
 991 static int ehci_urb_enqueue (
 992         struct usb_hcd  *hcd,
 993         struct urb      *urb,
 994         gfp_t           mem_flags
 995 ) {
 996         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 997         struct list_head        qtd_list;
 998
 999         INIT_LIST_HEAD (&qtd_list);
1000
1001         switch (usb_pipetype (urb->pipe)) {
1002         case PIPE_CONTROL:
1003                 /* qh_completions() code doesn't handle all the fault cases
1004                  * in multi-TD control transfers.  Even 1KB is rare anyway.
1005                  */
1006                 if (urb->transfer_buffer_length > (16 * 1024))
1007                         return -EMSGSIZE;
1008                 /* FALLTHROUGH */
1009         /* case PIPE_BULK: */
1010         default:
1011                 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
1012                         return -ENOMEM;
1013                 return submit_async(ehci, urb, &qtd_list, mem_flags);
1014
1015         case PIPE_INTERRUPT:
1016                 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
1017                         return -ENOMEM;
1018                 return intr_submit(ehci, urb, &qtd_list, mem_flags);
1019
1020         case PIPE_ISOCHRONOUS:
1021                 if (urb->dev->speed == USB_SPEED_HIGH)
1022                         return itd_submit (ehci, urb, mem_flags);
1023                 else
1024                         return sitd_submit (ehci, urb, mem_flags);
1025         }
1026 }
1027
1028 static void unlink_async (struct ehci_hcd *ehci, struct ehci_qh *qh)
1029 {
1030         /* failfast */
1031         if (ehci->rh_state != EHCI_RH_RUNNING && ehci->reclaim)
1032                 end_unlink_async(ehci);
1033
1034         /* If the QH isn't linked then there's nothing we can do
1035          * unless we were called during a giveback, in which case
1036          * qh_completions() has to deal with it.
1037          */
1038         if (qh->qh_state != QH_STATE_LINKED) {
1039                 if (qh->qh_state == QH_STATE_COMPLETING)
1040                         qh->needs_rescan = 1;
1041                 return;
1042         }
1043
1044         /* defer till later if busy */
1045         if (ehci->reclaim) {
1046                 struct ehci_qh          *last;
1047
1048                 for (last = ehci->reclaim;
1049                                 last->reclaim;
1050                                 last = last->reclaim)
1051                         continue;
1052                 qh->qh_state = QH_STATE_UNLINK_WAIT;
1053                 last->reclaim = qh;
1054
1055         /* start IAA cycle */
1056         } else
1057                 start_unlink_async (ehci, qh);
1058 }
1059
1060 /* remove from hardware lists
1061  * completions normally happen asynchronously
1062  */
1063
1064 static int ehci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
1065 {
1066         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
1067         struct ehci_qh          *qh;
1068         unsigned long           flags;
1069         int                     rc;
1070
1071         spin_lock_irqsave (&ehci->lock, flags);
1072         rc = usb_hcd_check_unlink_urb(hcd, urb, status);
1073         if (rc)
1074                 goto done;
1075
1076         switch (usb_pipetype (urb->pipe)) {
1077         // case PIPE_CONTROL:
1078         // case PIPE_BULK:
1079         default:
1080                 qh = (struct ehci_qh *) urb->hcpriv;
1081                 if (!qh)
1082                         break;
1083                 switch (qh->qh_state) {
1084                 case QH_STATE_LINKED:
1085                 case QH_STATE_COMPLETING:
1086                         unlink_async(ehci, qh);
1087                         break;
1088                 case QH_STATE_UNLINK:
1089                 case QH_STATE_UNLINK_WAIT:
1090                         /* already started */
1091                         break;
1092                 case QH_STATE_IDLE:
1093                         /* QH might be waiting for a Clear-TT-Buffer */
1094                         qh_completions(ehci, qh);
1095                         break;
1096                 }
1097                 break;
1098
1099         case PIPE_INTERRUPT:
1100                 qh = (struct ehci_qh *) urb->hcpriv;
1101                 if (!qh)
1102                         break;
1103                 switch (qh->qh_state) {
1104                 case QH_STATE_LINKED:
1105                 case QH_STATE_COMPLETING:
1106                         intr_deschedule (ehci, qh);
1107                         break;
1108                 case QH_STATE_IDLE:
1109                         qh_completions (ehci, qh);
1110                         break;
1111                 default:
1112                         ehci_dbg (ehci, "bogus qh %p state %d\n",
1113                                         qh, qh->qh_state);
1114                         goto done;
1115                 }
1116                 break;
1117
1118         case PIPE_ISOCHRONOUS:
1119                 // itd or sitd ...
1120
1121                 // wait till next completion, do it then.
1122                 // completion irqs can wait up to 1024 msec,
1123                 break;
1124         }
1125 done:
1126         spin_unlock_irqrestore (&ehci->lock, flags);
1127         return rc;
1128 }
1129
1130 /*-------------------------------------------------------------------------*/
1131
1132 // bulk qh holds the data toggle
1133
1134 static void
1135 ehci_endpoint_disable (struct usb_hcd *hcd, struct usb_host_endpoint *ep)
1136 {
1137         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
1138         unsigned long           flags;
1139         struct ehci_qh          *qh, *tmp;
1140
1141         /* ASSERT:  any requests/urbs are being unlinked */
1142         /* ASSERT:  nobody can be submitting urbs for this any more */
1143
1144 rescan:
1145         spin_lock_irqsave (&ehci->lock, flags);
1146         qh = ep->hcpriv;
1147         if (!qh)
1148                 goto done;
1149
1150         /* endpoints can be iso streams.  for now, we don't
1151          * accelerate iso completions ... so spin a while.
1152          */
1153         if (qh->hw == NULL) {
1154                 ehci_vdbg (ehci, "iso delay\n");
1155                 goto idle_timeout;
1156         }
1157
1158         if (ehci->rh_state != EHCI_RH_RUNNING)
1159                 qh->qh_state = QH_STATE_IDLE;
1160         switch (qh->qh_state) {
1161         case QH_STATE_LINKED:
1162         case QH_STATE_COMPLETING:
1163                 for (tmp = ehci->async->qh_next.qh;
1164                                 tmp && tmp != qh;
1165                                 tmp = tmp->qh_next.qh)
1166                         continue;
1167                 /* periodic qh self-unlinks on empty, and a COMPLETING qh
1168                  * may already be unlinked.
1169                  */
1170                 if (tmp)
1171                         unlink_async(ehci, qh);
1172                 /* FALL THROUGH */
1173         case QH_STATE_UNLINK:           /* wait for hw to finish? */
1174         case QH_STATE_UNLINK_WAIT:
1175 idle_timeout:
1176                 spin_unlock_irqrestore (&ehci->lock, flags);
1177                 schedule_timeout_uninterruptible(1);
1178                 goto rescan;
1179         case QH_STATE_IDLE:             /* fully unlinked */
1180                 if (qh->clearing_tt)
1181                         goto idle_timeout;
1182                 if (list_empty (&qh->qtd_list)) {
1183                         qh_put (qh);
1184                         break;
1185                 }
1186                 /* else FALL THROUGH */
1187         default:
1188                 /* caller was supposed to have unlinked any requests;
1189                  * that's not our job.  just leak this memory.
1190                  */
1191                 ehci_err (ehci, "qh %p (#%02x) state %d%s\n",
1192                         qh, ep->desc.bEndpointAddress, qh->qh_state,
1193                         list_empty (&qh->qtd_list) ? "" : "(has tds)");
1194                 break;
1195         }
1196         ep->hcpriv = NULL;
1197 done:
1198         spin_unlock_irqrestore (&ehci->lock, flags);
1199 }
1200
1201 static void
1202 ehci_endpoint_reset(struct usb_hcd *hcd, struct usb_host_endpoint *ep)
1203 {
1204         struct ehci_hcd         *ehci = hcd_to_ehci(hcd);
1205         struct ehci_qh          *qh;
1206         int                     eptype = usb_endpoint_type(&ep->desc);
1207         int                     epnum = usb_endpoint_num(&ep->desc);
1208         int                     is_out = usb_endpoint_dir_out(&ep->desc);
1209         unsigned long           flags;
1210
1211         if (eptype != USB_ENDPOINT_XFER_BULK && eptype != USB_ENDPOINT_XFER_INT)
1212                 return;
1213
1214         spin_lock_irqsave(&ehci->lock, flags);
1215         qh = ep->hcpriv;
1216
1217         /* For Bulk and Interrupt endpoints we maintain the toggle state
1218          * in the hardware; the toggle bits in udev aren't used at all.
1219          * When an endpoint is reset by usb_clear_halt() we must reset
1220          * the toggle bit in the QH.
1221          */
1222         if (qh) {
1223                 usb_settoggle(qh->dev, epnum, is_out, 0);
1224                 if (!list_empty(&qh->qtd_list)) {
1225                         WARN_ONCE(1, "clear_halt for a busy endpoint\n");
1226                 } else if (qh->qh_state == QH_STATE_LINKED ||
1227                                 qh->qh_state == QH_STATE_COMPLETING) {
1228
1229                         /* The toggle value in the QH can't be updated
1230                          * while the QH is active.  Unlink it now;
1231                          * re-linking will call qh_refresh().
1232                          */
1233                         if (eptype == USB_ENDPOINT_XFER_BULK)
1234                                 unlink_async(ehci, qh);
1235                         else
1236                                 intr_deschedule(ehci, qh);
1237                 }
1238         }
1239         spin_unlock_irqrestore(&ehci->lock, flags);
1240 }
1241
1242 static int ehci_get_frame (struct usb_hcd *hcd)
1243 {
1244         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
1245         return (ehci_read_frame_index(ehci) >> 3) % ehci->periodic_size;
1246 }
1247
1248 /*-------------------------------------------------------------------------*/
1249 /*
1250  * The EHCI in ChipIdea HDRC cannot be a separate module or device,
1251  * because its registers (and irq) are shared between host/gadget/otg
1252  * functions  and in order to facilitate role switching we cannot
1253  * give the ehci driver exclusive access to those.
1254  */
1255 #ifndef CHIPIDEA_EHCI
1256
1257 MODULE_DESCRIPTION(DRIVER_DESC);
1258 MODULE_AUTHOR (DRIVER_AUTHOR);
1259 MODULE_LICENSE ("GPL");
1260
1261 #ifdef CONFIG_PCI
1262 #include "ehci-pci.c"
1263 #define PCI_DRIVER              ehci_pci_driver
1264 #endif
1265
1266 #ifdef CONFIG_USB_EHCI_FSL
1267 #include "ehci-fsl.c"
1268 #define PLATFORM_DRIVER         ehci_fsl_driver
1269 #endif
1270
1271 #ifdef CONFIG_USB_EHCI_MXC
1272 #include "ehci-mxc.c"
1273 #define PLATFORM_DRIVER         ehci_mxc_driver
1274 #endif
1275
1276 #ifdef CONFIG_USB_EHCI_SH
1277 #include "ehci-sh.c"
1278 #define PLATFORM_DRIVER         ehci_hcd_sh_driver
1279 #endif
1280
1281 #ifdef CONFIG_MIPS_ALCHEMY
1282 #include "ehci-au1xxx.c"
1283 #define PLATFORM_DRIVER         ehci_hcd_au1xxx_driver
1284 #endif
1285
1286 #ifdef CONFIG_USB_EHCI_HCD_OMAP
1287 #include "ehci-omap.c"
1288 #define        PLATFORM_DRIVER         ehci_hcd_omap_driver
1289 #endif
1290
1291 #ifdef CONFIG_PPC_PS3
1292 #include "ehci-ps3.c"
1293 #define PS3_SYSTEM_BUS_DRIVER   ps3_ehci_driver
1294 #endif
1295
1296 #ifdef CONFIG_USB_EHCI_HCD_PPC_OF
1297 #include "ehci-ppc-of.c"
1298 #define OF_PLATFORM_DRIVER      ehci_hcd_ppc_of_driver
1299 #endif
1300
1301 #ifdef CONFIG_XPS_USB_HCD_XILINX
1302 #include "ehci-xilinx-of.c"
1303 #define XILINX_OF_PLATFORM_DRIVER       ehci_hcd_xilinx_of_driver
1304 #endif
1305
1306 #ifdef CONFIG_PLAT_ORION
1307 #include "ehci-orion.c"
1308 #define PLATFORM_DRIVER         ehci_orion_driver
1309 #endif
1310
1311 #ifdef CONFIG_ARCH_IXP4XX
1312 #include "ehci-ixp4xx.c"
1313 #define PLATFORM_DRIVER         ixp4xx_ehci_driver
1314 #endif
1315
1316 #ifdef CONFIG_USB_W90X900_EHCI
1317 #include "ehci-w90x900.c"
1318 #define PLATFORM_DRIVER         ehci_hcd_w90x900_driver
1319 #endif
1320
1321 #ifdef CONFIG_ARCH_AT91
1322 #include "ehci-atmel.c"
1323 #define PLATFORM_DRIVER         ehci_atmel_driver
1324 #endif
1325
1326 #ifdef CONFIG_USB_OCTEON_EHCI
1327 #include "ehci-octeon.c"
1328 #define PLATFORM_DRIVER         ehci_octeon_driver
1329 #endif
1330
1331 #ifdef CONFIG_USB_CNS3XXX_EHCI
1332 #include "ehci-cns3xxx.c"
1333 #define PLATFORM_DRIVER         cns3xxx_ehci_driver
1334 #endif
1335
1336 #ifdef CONFIG_ARCH_VT8500
1337 #include "ehci-vt8500.c"
1338 #define PLATFORM_DRIVER         vt8500_ehci_driver
1339 #endif
1340
1341 #ifdef CONFIG_PLAT_SPEAR
1342 #include "ehci-spear.c"
1343 #define PLATFORM_DRIVER         spear_ehci_hcd_driver
1344 #endif
1345
1346 #ifdef CONFIG_USB_EHCI_MSM
1347 #include "ehci-msm.c"
1348 #define PLATFORM_DRIVER         ehci_msm_driver
1349 #endif
1350
1351 #ifdef CONFIG_USB_EHCI_HCD_PMC_MSP
1352 #include "ehci-pmcmsp.c"
1353 #define PLATFORM_DRIVER         ehci_hcd_msp_driver
1354 #endif
1355
1356 #ifdef CONFIG_USB_EHCI_TEGRA
1357 #include "ehci-tegra.c"
1358 #define PLATFORM_DRIVER         tegra_ehci_driver
1359 #endif
1360
1361 #ifdef CONFIG_USB_EHCI_S5P
1362 #include "ehci-s5p.c"
1363 #define PLATFORM_DRIVER         s5p_ehci_driver
1364 #endif
1365
1366 #ifdef CONFIG_SPARC_LEON
1367 #include "ehci-grlib.c"
1368 #define PLATFORM_DRIVER         ehci_grlib_driver
1369 #endif
1370
1371 #ifdef CONFIG_CPU_XLR
1372 #include "ehci-xls.c"
1373 #define PLATFORM_DRIVER         ehci_xls_driver
1374 #endif
1375
1376 #ifdef CONFIG_USB_EHCI_MV
1377 #include "ehci-mv.c"
1378 #define        PLATFORM_DRIVER         ehci_mv_driver
1379 #endif
1380
1381 #ifdef CONFIG_MACH_LOONGSON1
1382 #include "ehci-ls1x.c"
1383 #define PLATFORM_DRIVER         ehci_ls1x_driver
1384 #endif
1385
1386 #ifdef CONFIG_MIPS_SEAD3
1387 #include "ehci-sead3.c"
1388 #define PLATFORM_DRIVER         ehci_hcd_sead3_driver
1389 #endif
1390
1391 #ifdef CONFIG_USB_EHCI_HCD_PLATFORM
1392 #include "ehci-platform.c"
1393 #define PLATFORM_DRIVER         ehci_platform_driver
1394 #endif
1395
1396 #if !defined(PCI_DRIVER) && !defined(PLATFORM_DRIVER) && \
1397     !defined(PS3_SYSTEM_BUS_DRIVER) && !defined(OF_PLATFORM_DRIVER) && \
1398     !defined(XILINX_OF_PLATFORM_DRIVER)
1399 #error "missing bus glue for ehci-hcd"
1400 #endif
1401
1402 static int __init ehci_hcd_init(void)
1403 {
1404         int retval = 0;
1405
1406         if (usb_disabled())
1407                 return -ENODEV;
1408
1409         printk(KERN_INFO "%s: " DRIVER_DESC "\n", hcd_name);
1410         set_bit(USB_EHCI_LOADED, &usb_hcds_loaded);
1411         if (test_bit(USB_UHCI_LOADED, &usb_hcds_loaded) ||
1412                         test_bit(USB_OHCI_LOADED, &usb_hcds_loaded))
1413                 printk(KERN_WARNING "Warning! ehci_hcd should always be loaded"
1414                                 " before uhci_hcd and ohci_hcd, not after\n");
1415
1416         pr_debug("%s: block sizes: qh %Zd qtd %Zd itd %Zd sitd %Zd\n",
1417                  hcd_name,
1418                  sizeof(struct ehci_qh), sizeof(struct ehci_qtd),
1419                  sizeof(struct ehci_itd), sizeof(struct ehci_sitd));
1420
1421 #ifdef DEBUG
1422         ehci_debug_root = debugfs_create_dir("ehci", usb_debug_root);
1423         if (!ehci_debug_root) {
1424                 retval = -ENOENT;
1425                 goto err_debug;
1426         }
1427 #endif
1428
1429 #ifdef PLATFORM_DRIVER
1430         retval = platform_driver_register(&PLATFORM_DRIVER);
1431         if (retval < 0)
1432                 goto clean0;
1433 #endif
1434
1435 #ifdef PCI_DRIVER
1436         retval = pci_register_driver(&PCI_DRIVER);
1437         if (retval < 0)
1438                 goto clean1;
1439 #endif
1440
1441 #ifdef PS3_SYSTEM_BUS_DRIVER
1442         retval = ps3_ehci_driver_register(&PS3_SYSTEM_BUS_DRIVER);
1443         if (retval < 0)
1444                 goto clean2;
1445 #endif
1446
1447 #ifdef OF_PLATFORM_DRIVER
1448         retval = platform_driver_register(&OF_PLATFORM_DRIVER);
1449         if (retval < 0)
1450                 goto clean3;
1451 #endif
1452
1453 #ifdef XILINX_OF_PLATFORM_DRIVER
1454         retval = platform_driver_register(&XILINX_OF_PLATFORM_DRIVER);
1455         if (retval < 0)
1456                 goto clean4;
1457 #endif
1458         return retval;
1459
1460 #ifdef XILINX_OF_PLATFORM_DRIVER
1461         /* platform_driver_unregister(&XILINX_OF_PLATFORM_DRIVER); */
1462 clean4:
1463 #endif
1464 #ifdef OF_PLATFORM_DRIVER
1465         platform_driver_unregister(&OF_PLATFORM_DRIVER);
1466 clean3:
1467 #endif
1468 #ifdef PS3_SYSTEM_BUS_DRIVER
1469         ps3_ehci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER);
1470 clean2:
1471 #endif
1472 #ifdef PCI_DRIVER
1473         pci_unregister_driver(&PCI_DRIVER);
1474 clean1:
1475 #endif
1476 #ifdef PLATFORM_DRIVER
1477         platform_driver_unregister(&PLATFORM_DRIVER);
1478 clean0:
1479 #endif
1480 #ifdef DEBUG
1481         debugfs_remove(ehci_debug_root);
1482         ehci_debug_root = NULL;
1483 err_debug:
1484 #endif
1485         clear_bit(USB_EHCI_LOADED, &usb_hcds_loaded);
1486         return retval;
1487 }
1488 module_init(ehci_hcd_init);
1489
1490 static void __exit ehci_hcd_cleanup(void)
1491 {
1492 #ifdef XILINX_OF_PLATFORM_DRIVER
1493         platform_driver_unregister(&XILINX_OF_PLATFORM_DRIVER);
1494 #endif
1495 #ifdef OF_PLATFORM_DRIVER
1496         platform_driver_unregister(&OF_PLATFORM_DRIVER);
1497 #endif
1498 #ifdef PLATFORM_DRIVER
1499         platform_driver_unregister(&PLATFORM_DRIVER);
1500 #endif
1501 #ifdef PCI_DRIVER
1502         pci_unregister_driver(&PCI_DRIVER);
1503 #endif
1504 #ifdef PS3_SYSTEM_BUS_DRIVER
1505         ps3_ehci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER);
1506 #endif
1507 #ifdef DEBUG
1508         debugfs_remove(ehci_debug_root);
1509 #endif
1510         clear_bit(USB_EHCI_LOADED, &usb_hcds_loaded);
1511 }
1512 module_exit(ehci_hcd_cleanup);
1513
1514 #endif /* CHIPIDEA_EHCI */