drivers/usb/host/ehci-hcd.c

   1 /*
   2  * Copyright (c) 2000-2004 by David Brownell
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU General Public License as published by the
   6  * Free Software Foundation; either version 2 of the License, or (at your
   7  * option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  11  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software Foundation,
  16  * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17  */
  18
  19 #include <linux/module.h>
  20 #include <linux/pci.h>
  21 #include <linux/dmapool.h>
  22 #include <linux/kernel.h>
  23 #include <linux/delay.h>
  24 #include <linux/ioport.h>
  25 #include <linux/sched.h>
  26 #include <linux/slab.h>
  27 #include <linux/errno.h>
  28 #include <linux/init.h>
  29 #include <linux/timer.h>
  30 #include <linux/list.h>
  31 #include <linux/interrupt.h>
  32 #include <linux/reboot.h>
  33 #include <linux/usb.h>
  34 #include <linux/moduleparam.h>
  35 #include <linux/dma-mapping.h>
  36
  37 #include "../core/hcd.h"
  38
  39 #include <asm/byteorder.h>
  40 #include <asm/io.h>
  41 #include <asm/irq.h>
  42 #include <asm/system.h>
  43 #include <asm/unaligned.h>
  44 #ifdef CONFIG_PPC_PS3
  45 #include <asm/firmware.h>
  46 #endif
  47
  48
  49 /*-------------------------------------------------------------------------*/
  50
  51 /*
  52  * EHCI hc_driver implementation ... experimental, incomplete.
  53  * Based on the final 1.0 register interface specification.
  54  *
  55  * USB 2.0 shows up in upcoming www.pcmcia.org technology.
  56  * First was PCMCIA, like ISA; then CardBus, which is PCI.
  57  * Next comes "CardBay", using USB 2.0 signals.
  58  *
  59  * Contains additional contributions by Brad Hards, Rory Bolt, and others.
  60  * Special thanks to Intel and VIA for providing host controllers to
  61  * test this driver on, and Cypress (including In-System Design) for
  62  * providing early devices for those host controllers to talk to!
  63  *
  64  * HISTORY:
  65  *
  66  * 2004-05-10 Root hub and PCI suspend/resume support; remote wakeup. (db)
  67  * 2004-02-24 Replace pci_* with generic dma_* API calls (dsaxena@plexity.net)
  68  * 2003-12-29 Rewritten high speed iso transfer support (by Michal Sojka,
  69  *      <sojkam@centrum.cz>, updates by DB).
  70  *
  71  * 2002-11-29   Correct handling for hw async_next register.
  72  * 2002-08-06   Handling for bulk and interrupt transfers is mostly shared;
  73  *      only scheduling is different, no arbitrary limitations.
  74  * 2002-07-25   Sanity check PCI reads, mostly for better cardbus support,
  75  *      clean up HC run state handshaking.
  76  * 2002-05-24   Preliminary FS/LS interrupts, using scheduling shortcuts
  77  * 2002-05-11   Clear TT errors for FS/LS ctrl/bulk.  Fill in some other
  78  *      missing pieces:  enabling 64bit dma, handoff from BIOS/SMM.
  79  * 2002-05-07   Some error path cleanups to report better errors; wmb();
  80  *      use non-CVS version id; better iso bandwidth claim.
  81  * 2002-04-19   Control/bulk/interrupt submit no longer uses giveback() on
  82  *      errors in submit path.  Bugfixes to interrupt scheduling/processing.
  83  * 2002-03-05   Initial high-speed ISO support; reduce ITD memory; shift
  84  *      more checking to generic hcd framework (db).  Make it work with
  85  *      Philips EHCI; reduce PCI traffic; shorten IRQ path (Rory Bolt).
  86  * 2002-01-14   Minor cleanup; version synch.
  87  * 2002-01-08   Fix roothub handoff of FS/LS to companion controllers.
  88  * 2002-01-04   Control/Bulk queuing behaves.
  89  *
  90  * 2001-12-12   Initial patch version for Linux 2.5.1 kernel.
  91  * 2001-June    Works with usb-storage and NEC EHCI on 2.4
  92  */
  93
  94 #define DRIVER_VERSION "10 Dec 2004"
  95 #define DRIVER_AUTHOR "David Brownell"
  96 #define DRIVER_DESC "USB 2.0 'Enhanced' Host Controller (EHCI) Driver"
  97
  98 static const char       hcd_name [] = "ehci_hcd";
  99
 100
 101 #undef EHCI_VERBOSE_DEBUG
 102 #undef EHCI_URB_TRACE
 103
 104 #ifdef DEBUG
 105 #define EHCI_STATS
 106 #endif
 107
 108 /* magic numbers that can affect system performance */
 109 #define EHCI_TUNE_CERR          3       /* 0-3 qtd retries; 0 == don't stop */
 110 #define EHCI_TUNE_RL_HS         4       /* nak throttle; see 4.9 */
 111 #define EHCI_TUNE_RL_TT         0
 112 #define EHCI_TUNE_MULT_HS       1       /* 1-3 transactions/uframe; 4.10.3 */
 113 #define EHCI_TUNE_MULT_TT       1
 114 #define EHCI_TUNE_FLS           2       /* (small) 256 frame schedule */
 115
 116 #define EHCI_IAA_JIFFIES        (HZ/100)        /* arbitrary; ~10 msec */
 117 #define EHCI_IO_JIFFIES         (HZ/10)         /* io watchdog > irq_thresh */
 118 #define EHCI_ASYNC_JIFFIES      (HZ/20)         /* async idle timeout */
 119 #define EHCI_SHRINK_JIFFIES     (HZ/200)        /* async qh unlink delay */
 120
 121 /* Initial IRQ latency:  faster than hw default */
 122 static int log2_irq_thresh = 0;         // 0 to 6
 123 module_param (log2_irq_thresh, int, S_IRUGO);
 124 MODULE_PARM_DESC (log2_irq_thresh, "log2 IRQ latency, 1-64 microframes");
 125
 126 /* initial park setting:  slower than hw default */
 127 static unsigned park = 0;
 128 module_param (park, uint, S_IRUGO);
 129 MODULE_PARM_DESC (park, "park setting; 1-3 back-to-back async packets");
 130
 131 /* for flakey hardware, ignore overcurrent indicators */
 132 static int ignore_oc = 0;
 133 module_param (ignore_oc, bool, S_IRUGO);
 134 MODULE_PARM_DESC (ignore_oc, "ignore bogus hardware overcurrent indications");
 135
 136 #define INTR_MASK (STS_IAA | STS_FATAL | STS_PCD | STS_ERR | STS_INT)
 137
 138 /*-------------------------------------------------------------------------*/
 139
 140 #include "ehci.h"
 141 #include "ehci-dbg.c"
 142
 143 /*-------------------------------------------------------------------------*/
 144
 145 /*
 146  * handshake - spin reading hc until handshake completes or fails
 147  * @ptr: address of hc register to be read
 148  * @mask: bits to look at in result of read
 149  * @done: value of those bits when handshake succeeds
 150  * @usec: timeout in microseconds
 151  *
 152  * Returns negative errno, or zero on success
 153  *
 154  * Success happens when the "mask" bits have the specified value (hardware
 155  * handshake done).  There are two failure modes:  "usec" have passed (major
 156  * hardware flakeout), or the register reads as all-ones (hardware removed).
 157  *
 158  * That last failure should_only happen in cases like physical cardbus eject
 159  * before driver shutdown. But it also seems to be caused by bugs in cardbus
 160  * bridge shutdown:  shutting down the bridge before the devices using it.
 161  */
 162 static int handshake (struct ehci_hcd *ehci, void __iomem *ptr,
 163                       u32 mask, u32 done, int usec)
 164 {
 165         u32     result;
 166
 167         do {
 168                 result = ehci_readl(ehci, ptr);
 169                 if (result == ~(u32)0)          /* card removed */
 170                         return -ENODEV;
 171                 result &= mask;
 172                 if (result == done)
 173                         return 0;
 174                 udelay (1);
 175                 usec--;
 176         } while (usec > 0);
 177         return -ETIMEDOUT;
 178 }
 179
 180 /* force HC to halt state from unknown (EHCI spec section 2.3) */
 181 static int ehci_halt (struct ehci_hcd *ehci)
 182 {
 183         u32     temp = ehci_readl(ehci, &ehci->regs->status);
 184
 185         /* disable any irqs left enabled by previous code */
 186         ehci_writel(ehci, 0, &ehci->regs->intr_enable);
 187
 188         if ((temp & STS_HALT) != 0)
 189                 return 0;
 190
 191         temp = ehci_readl(ehci, &ehci->regs->command);
 192         temp &= ~CMD_RUN;
 193         ehci_writel(ehci, temp, &ehci->regs->command);
 194         return handshake (ehci, &ehci->regs->status,
 195                           STS_HALT, STS_HALT, 16 * 125);
 196 }
 197
 198 /* put TDI/ARC silicon into EHCI mode */
 199 static void tdi_reset (struct ehci_hcd *ehci)
 200 {
 201         u32 __iomem     *reg_ptr;
 202         u32             tmp;
 203
 204         reg_ptr = (u32 __iomem *)(((u8 __iomem *)ehci->regs) + 0x68);
 205         tmp = ehci_readl(ehci, reg_ptr);
 206         tmp |= 0x3;
 207         ehci_writel(ehci, tmp, reg_ptr);
 208 }
 209
 210 /* reset a non-running (STS_HALT == 1) controller */
 211 static int ehci_reset (struct ehci_hcd *ehci)
 212 {
 213         int     retval;
 214         u32     command = ehci_readl(ehci, &ehci->regs->command);
 215
 216         command |= CMD_RESET;
 217         dbg_cmd (ehci, "reset", command);
 218         ehci_writel(ehci, command, &ehci->regs->command);
 219         ehci_to_hcd(ehci)->state = HC_STATE_HALT;
 220         ehci->next_statechange = jiffies;
 221         retval = handshake (ehci, &ehci->regs->command,
 222                             CMD_RESET, 0, 250 * 1000);
 223
 224         if (retval)
 225                 return retval;
 226
 227         if (ehci_is_TDI(ehci))
 228                 tdi_reset (ehci);
 229
 230         return retval;
 231 }
 232
 233 /* idle the controller (from running) */
 234 static void ehci_quiesce (struct ehci_hcd *ehci)
 235 {
 236         u32     temp;
 237
 238 #ifdef DEBUG
 239         if (!HC_IS_RUNNING (ehci_to_hcd(ehci)->state))
 240                 BUG ();
 241 #endif
 242
 243         /* wait for any schedule enables/disables to take effect */
 244         temp = ehci_readl(ehci, &ehci->regs->command) << 10;
 245         temp &= STS_ASS | STS_PSS;
 246         if (handshake (ehci, &ehci->regs->status, STS_ASS | STS_PSS,
 247                                 temp, 16 * 125) != 0) {
 248                 ehci_to_hcd(ehci)->state = HC_STATE_HALT;
 249                 return;
 250         }
 251
 252         /* then disable anything that's still active */
 253         temp = ehci_readl(ehci, &ehci->regs->command);
 254         temp &= ~(CMD_ASE | CMD_IAAD | CMD_PSE);
 255         ehci_writel(ehci, temp, &ehci->regs->command);
 256
 257         /* hardware can take 16 microframes to turn off ... */
 258         if (handshake (ehci, &ehci->regs->status, STS_ASS | STS_PSS,
 259                                 0, 16 * 125) != 0) {
 260                 ehci_to_hcd(ehci)->state = HC_STATE_HALT;
 261                 return;
 262         }
 263 }
 264
 265 /*-------------------------------------------------------------------------*/
 266
 267 static void ehci_work(struct ehci_hcd *ehci);
 268
 269 #include "ehci-hub.c"
 270 #include "ehci-mem.c"
 271 #include "ehci-q.c"
 272 #include "ehci-sched.c"
 273
 274 /*-------------------------------------------------------------------------*/
 275
 276 #ifdef CONFIG_CPU_FREQ
 277
 278 #include <linux/cpufreq.h>
 279
 280 static void ehci_cpufreq_pause (struct ehci_hcd *ehci)
 281 {
 282         unsigned long   flags;
 283
 284         spin_lock_irqsave(&ehci->lock, flags);
 285         if (!ehci->cpufreq_changing++)
 286                 qh_inactivate_split_intr_qhs(ehci);
 287         spin_unlock_irqrestore(&ehci->lock, flags);
 288 }
 289
 290 static void ehci_cpufreq_unpause (struct ehci_hcd *ehci)
 291 {
 292         unsigned long   flags;
 293
 294         spin_lock_irqsave(&ehci->lock, flags);
 295         if (!--ehci->cpufreq_changing)
 296                 qh_reactivate_split_intr_qhs(ehci);
 297         spin_unlock_irqrestore(&ehci->lock, flags);
 298 }
 299
 300 /*
 301  * ehci_cpufreq_notifier is needed to avoid MMF errors that occur when
 302  * EHCI controllers that don't cache many uframes get delayed trying to
 303  * read main memory during CPU frequency transitions.  This can cause
 304  * split interrupt transactions to not be completed in the required uframe.
 305  * This has been observed on the Broadcom/ServerWorks HT1000 controller.
 306  */
 307 static int ehci_cpufreq_notifier(struct notifier_block *nb, unsigned long val,
 308                                  void *data)
 309 {
 310         struct ehci_hcd *ehci = container_of(nb, struct ehci_hcd,
 311                                              cpufreq_transition);
 312
 313         switch (val) {
 314         case CPUFREQ_PRECHANGE:
 315                 ehci_cpufreq_pause(ehci);
 316                 break;
 317         case CPUFREQ_POSTCHANGE:
 318                 ehci_cpufreq_unpause(ehci);
 319                 break;
 320         }
 321         return 0;
 322 }
 323
 324 #endif
 325
 326 /*-------------------------------------------------------------------------*/
 327
 328 static void ehci_watchdog (unsigned long param)
 329 {
 330         struct ehci_hcd         *ehci = (struct ehci_hcd *) param;
 331         unsigned long           flags;
 332
 333         spin_lock_irqsave (&ehci->lock, flags);
 334
 335         /* lost IAA irqs wedge things badly; seen with a vt8235 */
 336         if (ehci->reclaim) {
 337                 u32             status = ehci_readl(ehci, &ehci->regs->status);
 338                 if (status & STS_IAA) {
 339                         ehci_vdbg (ehci, "lost IAA\n");
 340                         COUNT (ehci->stats.lost_iaa);
 341                         ehci_writel(ehci, STS_IAA, &ehci->regs->status);
 342                         ehci->reclaim_ready = 1;
 343                 }
 344         }
 345
 346         /* stop async processing after it's idled a bit */
 347         if (test_bit (TIMER_ASYNC_OFF, &ehci->actions))
 348                 start_unlink_async (ehci, ehci->async);
 349
 350         /* ehci could run by timer, without IRQs ... */
 351         ehci_work (ehci);
 352
 353         spin_unlock_irqrestore (&ehci->lock, flags);
 354 }
 355
 356 /* On some systems, leaving remote wakeup enabled prevents system shutdown.
 357  * The firmware seems to think that powering off is a wakeup event!
 358  * This routine turns off remote wakeup and everything else, on all ports.
 359  */
 360 static void ehci_turn_off_all_ports(struct ehci_hcd *ehci)
 361 {
 362         int     port = HCS_N_PORTS(ehci->hcs_params);
 363
 364         while (port--)
 365                 ehci_writel(ehci, PORT_RWC_BITS,
 366                                 &ehci->regs->port_status[port]);
 367 }
 368
 369 /* ehci_shutdown kick in for silicon on any bus (not just pci, etc).
 370  * This forcibly disables dma and IRQs, helping kexec and other cases
 371  * where the next system software may expect clean state.
 372  */
 373 static void
 374 ehci_shutdown (struct usb_hcd *hcd)
 375 {
 376         struct ehci_hcd *ehci;
 377
 378         ehci = hcd_to_ehci (hcd);
 379         (void) ehci_halt (ehci);
 380         ehci_turn_off_all_ports(ehci);
 381
 382         /* make BIOS/etc use companion controller during reboot */
 383         ehci_writel(ehci, 0, &ehci->regs->configured_flag);
 384
 385         /* unblock posted writes */
 386         ehci_readl(ehci, &ehci->regs->configured_flag);
 387 }
 388
 389 static void ehci_port_power (struct ehci_hcd *ehci, int is_on)
 390 {
 391         unsigned port;
 392
 393         if (!HCS_PPC (ehci->hcs_params))
 394                 return;
 395
 396         ehci_dbg (ehci, "...power%s ports...\n", is_on ? "up" : "down");
 397         for (port = HCS_N_PORTS (ehci->hcs_params); port > 0; )
 398                 (void) ehci_hub_control(ehci_to_hcd(ehci),
 399                                 is_on ? SetPortFeature : ClearPortFeature,
 400                                 USB_PORT_FEAT_POWER,
 401                                 port--, NULL, 0);
 402         /* Flush those writes */
 403         ehci_readl(ehci, &ehci->regs->command);
 404         msleep(20);
 405 }
 406
 407 /*-------------------------------------------------------------------------*/
 408
 409 /*
 410  * ehci_work is called from some interrupts, timers, and so on.
 411  * it calls driver completion functions, after dropping ehci->lock.
 412  */
 413 static void ehci_work (struct ehci_hcd *ehci)
 414 {
 415         timer_action_done (ehci, TIMER_IO_WATCHDOG);
 416         if (ehci->reclaim_ready)
 417                 end_unlink_async (ehci);
 418
 419         /* another CPU may drop ehci->lock during a schedule scan while
 420          * it reports urb completions.  this flag guards against bogus
 421          * attempts at re-entrant schedule scanning.
 422          */
 423         if (ehci->scanning)
 424                 return;
 425         ehci->scanning = 1;
 426         scan_async (ehci);
 427         if (ehci->next_uframe != -1)
 428                 scan_periodic (ehci);
 429         ehci->scanning = 0;
 430
 431         /* the IO watchdog guards against hardware or driver bugs that
 432          * misplace IRQs, and should let us run completely without IRQs.
 433          * such lossage has been observed on both VT6202 and VT8235.
 434          */
 435         if (HC_IS_RUNNING (ehci_to_hcd(ehci)->state) &&
 436                         (ehci->async->qh_next.ptr != NULL ||
 437                          ehci->periodic_sched != 0))
 438                 timer_action (ehci, TIMER_IO_WATCHDOG);
 439 }
 440
 441 static void ehci_stop (struct usb_hcd *hcd)
 442 {
 443         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 444
 445         ehci_dbg (ehci, "stop\n");
 446
 447         /* Turn off port power on all root hub ports. */
 448         ehci_port_power (ehci, 0);
 449
 450         /* no more interrupts ... */
 451         del_timer_sync (&ehci->watchdog);
 452
 453         spin_lock_irq(&ehci->lock);
 454         if (HC_IS_RUNNING (hcd->state))
 455                 ehci_quiesce (ehci);
 456
 457         ehci_reset (ehci);
 458         ehci_writel(ehci, 0, &ehci->regs->intr_enable);
 459         spin_unlock_irq(&ehci->lock);
 460
 461 #ifdef CONFIG_CPU_FREQ
 462         cpufreq_unregister_notifier(&ehci->cpufreq_transition,
 463                                     CPUFREQ_TRANSITION_NOTIFIER);
 464 #endif
 465         /* let companion controllers work when we aren't */
 466         ehci_writel(ehci, 0, &ehci->regs->configured_flag);
 467
 468         remove_companion_file(ehci);
 469         remove_debug_files (ehci);
 470
 471         /* root hub is shut down separately (first, when possible) */
 472         spin_lock_irq (&ehci->lock);
 473         if (ehci->async)
 474                 ehci_work (ehci);
 475         spin_unlock_irq (&ehci->lock);
 476         ehci_mem_cleanup (ehci);
 477
 478 #ifdef  EHCI_STATS
 479         ehci_dbg (ehci, "irq normal %ld err %ld reclaim %ld (lost %ld)\n",
 480                 ehci->stats.normal, ehci->stats.error, ehci->stats.reclaim,
 481                 ehci->stats.lost_iaa);
 482         ehci_dbg (ehci, "complete %ld unlink %ld\n",
 483                 ehci->stats.complete, ehci->stats.unlink);
 484 #endif
 485
 486         dbg_status (ehci, "ehci_stop completed",
 487                     ehci_readl(ehci, &ehci->regs->status));
 488 }
 489
 490 /* one-time init, only for memory state */
 491 static int ehci_init(struct usb_hcd *hcd)
 492 {
 493         struct ehci_hcd         *ehci = hcd_to_ehci(hcd);
 494         u32                     temp;
 495         int                     retval;
 496         u32                     hcc_params;
 497
 498         spin_lock_init(&ehci->lock);
 499
 500         init_timer(&ehci->watchdog);
 501         ehci->watchdog.function = ehci_watchdog;
 502         ehci->watchdog.data = (unsigned long) ehci;
 503
 504         /*
 505          * hw default: 1K periodic list heads, one per frame.
 506          * periodic_size can shrink by USBCMD update if hcc_params allows.
 507          */
 508         ehci->periodic_size = DEFAULT_I_TDPS;
 509         if ((retval = ehci_mem_init(ehci, GFP_KERNEL)) < 0)
 510                 return retval;
 511
 512         /* controllers may cache some of the periodic schedule ... */
 513         hcc_params = ehci_readl(ehci, &ehci->caps->hcc_params);
 514         if (HCC_ISOC_CACHE(hcc_params))         // full frame cache
 515                 ehci->i_thresh = 8;
 516         else                                    // N microframes cached
 517                 ehci->i_thresh = 2 + HCC_ISOC_THRES(hcc_params);
 518
 519         ehci->reclaim = NULL;
 520         ehci->reclaim_ready = 0;
 521         ehci->next_uframe = -1;
 522
 523         /*
 524          * dedicate a qh for the async ring head, since we couldn't unlink
 525          * a 'real' qh without stopping the async schedule [4.8].  use it
 526          * as the 'reclamation list head' too.
 527          * its dummy is used in hw_alt_next of many tds, to prevent the qh
 528          * from automatically advancing to the next td after short reads.
 529          */
 530         ehci->async->qh_next.qh = NULL;
 531         ehci->async->hw_next = QH_NEXT(ehci, ehci->async->qh_dma);
 532         ehci->async->hw_info1 = cpu_to_hc32(ehci, QH_HEAD);
 533         ehci->async->hw_token = cpu_to_hc32(ehci, QTD_STS_HALT);
 534         ehci->async->hw_qtd_next = EHCI_LIST_END(ehci);
 535         ehci->async->qh_state = QH_STATE_LINKED;
 536         ehci->async->hw_alt_next = QTD_NEXT(ehci, ehci->async->dummy->qtd_dma);
 537
 538         /* clear interrupt enables, set irq latency */
 539         if (log2_irq_thresh < 0 || log2_irq_thresh > 6)
 540                 log2_irq_thresh = 0;
 541         temp = 1 << (16 + log2_irq_thresh);
 542         if (HCC_CANPARK(hcc_params)) {
 543                 /* HW default park == 3, on hardware that supports it (like
 544                  * NVidia and ALI silicon), maximizes throughput on the async
 545                  * schedule by avoiding QH fetches between transfers.
 546                  *
 547                  * With fast usb storage devices and NForce2, "park" seems to
 548                  * make problems:  throughput reduction (!), data errors...
 549                  */
 550                 if (park) {
 551                         park = min(park, (unsigned) 3);
 552                         temp |= CMD_PARK;
 553                         temp |= park << 8;
 554                 }
 555                 ehci_dbg(ehci, "park %d\n", park);
 556         }
 557         if (HCC_PGM_FRAMELISTLEN(hcc_params)) {
 558                 /* periodic schedule size can be smaller than default */
 559                 temp &= ~(3 << 2);
 560                 temp |= (EHCI_TUNE_FLS << 2);
 561                 switch (EHCI_TUNE_FLS) {
 562                 case 0: ehci->periodic_size = 1024; break;
 563                 case 1: ehci->periodic_size = 512; break;
 564                 case 2: ehci->periodic_size = 256; break;
 565                 default:        BUG();
 566                 }
 567         }
 568         ehci->command = temp;
 569
 570 #ifdef CONFIG_CPU_FREQ
 571         INIT_LIST_HEAD(&ehci->split_intr_qhs);
 572         /*
 573          * If the EHCI controller caches enough uframes, this probably
 574          * isn't needed unless there are so many low/full speed devices
 575          * that the controller's can't cache it all.
 576          */
 577         ehci->cpufreq_transition.notifier_call = ehci_cpufreq_notifier;
 578         cpufreq_register_notifier(&ehci->cpufreq_transition,
 579                                   CPUFREQ_TRANSITION_NOTIFIER);
 580 #endif
 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         int                     retval;
 589         u32                     temp;
 590         u32                     hcc_params;
 591
 592         hcd->uses_new_polling = 1;
 593         hcd->poll_rh = 0;
 594
 595         /* EHCI spec section 4.1 */
 596         if ((retval = ehci_reset(ehci)) != 0) {
 597                 ehci_mem_cleanup(ehci);
 598                 return retval;
 599         }
 600         ehci_writel(ehci, ehci->periodic_dma, &ehci->regs->frame_list);
 601         ehci_writel(ehci, (u32)ehci->async->qh_dma, &ehci->regs->async_next);
 602
 603         /*
 604          * hcc_params controls whether ehci->regs->segment must (!!!)
 605          * be used; it constrains QH/ITD/SITD and QTD locations.
 606          * pci_pool consistent memory always uses segment zero.
 607          * streaming mappings for I/O buffers, like pci_map_single(),
 608          * can return segments above 4GB, if the device allows.
 609          *
 610          * NOTE:  the dma mask is visible through dma_supported(), so
 611          * drivers can pass this info along ... like NETIF_F_HIGHDMA,
 612          * Scsi_Host.highmem_io, and so forth.  It's readonly to all
 613          * host side drivers though.
 614          */
 615         hcc_params = ehci_readl(ehci, &ehci->caps->hcc_params);
 616         if (HCC_64BIT_ADDR(hcc_params)) {
 617                 ehci_writel(ehci, 0, &ehci->regs->segment);
 618 #if 0
 619 // this is deeply broken on almost all architectures
 620                 if (!dma_set_mask(hcd->self.controller, DMA_64BIT_MASK))
 621                         ehci_info(ehci, "enabled 64bit DMA\n");
 622 #endif
 623         }
 624
 625
 626         // Philips, Intel, and maybe others need CMD_RUN before the
 627         // root hub will detect new devices (why?); NEC doesn't
 628         ehci->command &= ~(CMD_LRESET|CMD_IAAD|CMD_PSE|CMD_ASE|CMD_RESET);
 629         ehci->command |= CMD_RUN;
 630         ehci_writel(ehci, ehci->command, &ehci->regs->command);
 631         dbg_cmd (ehci, "init", ehci->command);
 632
 633         /*
 634          * Start, enabling full USB 2.0 functionality ... usb 1.1 devices
 635          * are explicitly handed to companion controller(s), so no TT is
 636          * involved with the root hub.  (Except where one is integrated,
 637          * and there's no companion controller unless maybe for USB OTG.)
 638          */
 639         hcd->state = HC_STATE_RUNNING;
 640         ehci_writel(ehci, FLAG_CF, &ehci->regs->configured_flag);
 641         ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
 642
 643         temp = HC_VERSION(ehci_readl(ehci, &ehci->caps->hc_capbase));
 644         ehci_info (ehci,
 645                 "USB %x.%x started, EHCI %x.%02x, driver %s%s\n",
 646                 ((ehci->sbrn & 0xf0)>>4), (ehci->sbrn & 0x0f),
 647                 temp >> 8, temp & 0xff, DRIVER_VERSION,
 648                 ignore_oc ? ", overcurrent ignored" : "");
 649
 650         ehci_writel(ehci, INTR_MASK,
 651                     &ehci->regs->intr_enable); /* Turn On Interrupts */
 652
 653         /* GRR this is run-once init(), being done every time the HC starts.
 654          * So long as they're part of class devices, we can't do it init()
 655          * since the class device isn't created that early.
 656          */
 657         create_debug_files(ehci);
 658         create_companion_file(ehci);
 659
 660         return 0;
 661 }
 662
 663 /*-------------------------------------------------------------------------*/
 664
 665 static irqreturn_t ehci_irq (struct usb_hcd *hcd)
 666 {
 667         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 668         u32                     status, pcd_status = 0;
 669         int                     bh;
 670
 671         spin_lock (&ehci->lock);
 672
 673         status = ehci_readl(ehci, &ehci->regs->status);
 674
 675         /* e.g. cardbus physical eject */
 676         if (status == ~(u32) 0) {
 677                 ehci_dbg (ehci, "device removed\n");
 678                 goto dead;
 679         }
 680
 681         status &= INTR_MASK;
 682         if (!status) {                  /* irq sharing? */
 683                 spin_unlock(&ehci->lock);
 684                 return IRQ_NONE;
 685         }
 686
 687         /* clear (just) interrupts */
 688         ehci_writel(ehci, status, &ehci->regs->status);
 689         ehci_readl(ehci, &ehci->regs->command); /* unblock posted write */
 690         bh = 0;
 691
 692 #ifdef  EHCI_VERBOSE_DEBUG
 693         /* unrequested/ignored: Frame List Rollover */
 694         dbg_status (ehci, "irq", status);
 695 #endif
 696
 697         /* INT, ERR, and IAA interrupt rates can be throttled */
 698
 699         /* normal [4.15.1.2] or error [4.15.1.1] completion */
 700         if (likely ((status & (STS_INT|STS_ERR)) != 0)) {
 701                 if (likely ((status & STS_ERR) == 0))
 702                         COUNT (ehci->stats.normal);
 703                 else
 704                         COUNT (ehci->stats.error);
 705                 bh = 1;
 706         }
 707
 708         /* complete the unlinking of some qh [4.15.2.3] */
 709         if (status & STS_IAA) {
 710                 COUNT (ehci->stats.reclaim);
 711                 ehci->reclaim_ready = 1;
 712                 bh = 1;
 713         }
 714
 715         /* remote wakeup [4.3.1] */
 716         if (status & STS_PCD) {
 717                 unsigned        i = HCS_N_PORTS (ehci->hcs_params);
 718                 pcd_status = status;
 719
 720                 /* resume root hub? */
 721                 if (!(ehci_readl(ehci, &ehci->regs->command) & CMD_RUN))
 722                         usb_hcd_resume_root_hub(hcd);
 723
 724                 while (i--) {
 725                         int pstatus = ehci_readl(ehci,
 726                                                  &ehci->regs->port_status [i]);
 727
 728                         if (pstatus & PORT_OWNER)
 729                                 continue;
 730                         if (!(pstatus & PORT_RESUME)
 731                                         || ehci->reset_done [i] != 0)
 732                                 continue;
 733
 734                         /* start 20 msec resume signaling from this port,
 735                          * and make khubd collect PORT_STAT_C_SUSPEND to
 736                          * stop that signaling.
 737                          */
 738                         ehci->reset_done [i] = jiffies + msecs_to_jiffies (20);
 739                         ehci_dbg (ehci, "port %d remote wakeup\n", i + 1);
 740                         mod_timer(&hcd->rh_timer, ehci->reset_done[i]);
 741                 }
 742         }
 743
 744         /* PCI errors [4.15.2.4] */
 745         if (unlikely ((status & STS_FATAL) != 0)) {
 746                 /* bogus "fatal" IRQs appear on some chips... why?  */
 747                 status = ehci_readl(ehci, &ehci->regs->status);
 748                 dbg_cmd (ehci, "fatal", ehci_readl(ehci,
 749                                                    &ehci->regs->command));
 750                 dbg_status (ehci, "fatal", status);
 751                 if (status & STS_HALT) {
 752                         ehci_err (ehci, "fatal error\n");
 753 dead:
 754                         ehci_reset (ehci);
 755                         ehci_writel(ehci, 0, &ehci->regs->configured_flag);
 756                         /* generic layer kills/unlinks all urbs, then
 757                          * uses ehci_stop to clean up the rest
 758                          */
 759                         bh = 1;
 760                 }
 761         }
 762
 763         if (bh)
 764                 ehci_work (ehci);
 765         spin_unlock (&ehci->lock);
 766         if (pcd_status & STS_PCD)
 767                 usb_hcd_poll_rh_status(hcd);
 768         return IRQ_HANDLED;
 769 }
 770
 771 /*-------------------------------------------------------------------------*/
 772
 773 /*
 774  * non-error returns are a promise to giveback() the urb later
 775  * we drop ownership so next owner (or urb unlink) can get it
 776  *
 777  * urb + dev is in hcd.self.controller.urb_list
 778  * we're queueing TDs onto software and hardware lists
 779  *
 780  * hcd-specific init for hcpriv hasn't been done yet
 781  *
 782  * NOTE:  control, bulk, and interrupt share the same code to append TDs
 783  * to a (possibly active) QH, and the same QH scanning code.
 784  */
 785 static int ehci_urb_enqueue (
 786         struct usb_hcd  *hcd,
 787         struct usb_host_endpoint *ep,
 788         struct urb      *urb,
 789         gfp_t           mem_flags
 790 ) {
 791         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 792         struct list_head        qtd_list;
 793
 794         INIT_LIST_HEAD (&qtd_list);
 795
 796         switch (usb_pipetype (urb->pipe)) {
 797         // case PIPE_CONTROL:
 798         // case PIPE_BULK:
 799         default:
 800                 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
 801                         return -ENOMEM;
 802                 return submit_async (ehci, ep, urb, &qtd_list, mem_flags);
 803
 804         case PIPE_INTERRUPT:
 805                 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
 806                         return -ENOMEM;
 807                 return intr_submit (ehci, ep, urb, &qtd_list, mem_flags);
 808
 809         case PIPE_ISOCHRONOUS:
 810                 if (urb->dev->speed == USB_SPEED_HIGH)
 811                         return itd_submit (ehci, urb, mem_flags);
 812                 else
 813                         return sitd_submit (ehci, urb, mem_flags);
 814         }
 815 }
 816
 817 static void unlink_async (struct ehci_hcd *ehci, struct ehci_qh *qh)
 818 {
 819         /* if we need to use IAA and it's busy, defer */
 820         if (qh->qh_state == QH_STATE_LINKED
 821                         && ehci->reclaim
 822                         && HC_IS_RUNNING (ehci_to_hcd(ehci)->state)) {
 823                 struct ehci_qh          *last;
 824
 825                 for (last = ehci->reclaim;
 826                                 last->reclaim;
 827                                 last = last->reclaim)
 828                         continue;
 829                 qh->qh_state = QH_STATE_UNLINK_WAIT;
 830                 last->reclaim = qh;
 831
 832         /* bypass IAA if the hc can't care */
 833         } else if (!HC_IS_RUNNING (ehci_to_hcd(ehci)->state) && ehci->reclaim)
 834                 end_unlink_async (ehci);
 835
 836         /* something else might have unlinked the qh by now */
 837         if (qh->qh_state == QH_STATE_LINKED)
 838                 start_unlink_async (ehci, qh);
 839 }
 840
 841 /* remove from hardware lists
 842  * completions normally happen asynchronously
 843  */
 844
 845 static int ehci_urb_dequeue (struct usb_hcd *hcd, struct urb *urb)
 846 {
 847         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 848         struct ehci_qh          *qh;
 849         unsigned long           flags;
 850
 851         spin_lock_irqsave (&ehci->lock, flags);
 852         switch (usb_pipetype (urb->pipe)) {
 853         // case PIPE_CONTROL:
 854         // case PIPE_BULK:
 855         default:
 856                 qh = (struct ehci_qh *) urb->hcpriv;
 857                 if (!qh)
 858                         break;
 859                 unlink_async (ehci, qh);
 860                 break;
 861
 862         case PIPE_INTERRUPT:
 863                 qh = (struct ehci_qh *) urb->hcpriv;
 864                 if (!qh)
 865                         break;
 866                 switch (qh->qh_state) {
 867                 case QH_STATE_LINKED:
 868                         intr_deschedule (ehci, qh);
 869                         /* FALL THROUGH */
 870                 case QH_STATE_IDLE:
 871                         qh_completions (ehci, qh);
 872                         break;
 873                 default:
 874                         ehci_dbg (ehci, "bogus qh %p state %d\n",
 875                                         qh, qh->qh_state);
 876                         goto done;
 877                 }
 878
 879                 /* reschedule QH iff another request is queued */
 880                 if (!list_empty (&qh->qtd_list)
 881                                 && HC_IS_RUNNING (hcd->state)) {
 882                         int status;
 883
 884                         status = qh_schedule (ehci, qh);
 885                         spin_unlock_irqrestore (&ehci->lock, flags);
 886
 887                         if (status != 0) {
 888                                 // shouldn't happen often, but ...
 889                                 // FIXME kill those tds' urbs
 890                                 err ("can't reschedule qh %p, err %d",
 891                                         qh, status);
 892                         }
 893                         return status;
 894                 }
 895                 break;
 896
 897         case PIPE_ISOCHRONOUS:
 898                 // itd or sitd ...
 899
 900                 // wait till next completion, do it then.
 901                 // completion irqs can wait up to 1024 msec,
 902                 break;
 903         }
 904 done:
 905         spin_unlock_irqrestore (&ehci->lock, flags);
 906         return 0;
 907 }
 908
 909 /*-------------------------------------------------------------------------*/
 910
 911 // bulk qh holds the data toggle
 912
 913 static void
 914 ehci_endpoint_disable (struct usb_hcd *hcd, struct usb_host_endpoint *ep)
 915 {
 916         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 917         unsigned long           flags;
 918         struct ehci_qh          *qh, *tmp;
 919
 920         /* ASSERT:  any requests/urbs are being unlinked */
 921         /* ASSERT:  nobody can be submitting urbs for this any more */
 922
 923 rescan:
 924         spin_lock_irqsave (&ehci->lock, flags);
 925         qh = ep->hcpriv;
 926         if (!qh)
 927                 goto done;
 928
 929         /* endpoints can be iso streams.  for now, we don't
 930          * accelerate iso completions ... so spin a while.
 931          */
 932         if (qh->hw_info1 == 0) {
 933                 ehci_vdbg (ehci, "iso delay\n");
 934                 goto idle_timeout;
 935         }
 936
 937         if (!HC_IS_RUNNING (hcd->state))
 938                 qh->qh_state = QH_STATE_IDLE;
 939         switch (qh->qh_state) {
 940         case QH_STATE_LINKED:
 941                 for (tmp = ehci->async->qh_next.qh;
 942                                 tmp && tmp != qh;
 943                                 tmp = tmp->qh_next.qh)
 944                         continue;
 945                 /* periodic qh self-unlinks on empty */
 946                 if (!tmp)
 947                         goto nogood;
 948                 unlink_async (ehci, qh);
 949                 /* FALL THROUGH */
 950         case QH_STATE_UNLINK:           /* wait for hw to finish? */
 951 idle_timeout:
 952                 spin_unlock_irqrestore (&ehci->lock, flags);
 953                 schedule_timeout_uninterruptible(1);
 954                 goto rescan;
 955         case QH_STATE_IDLE:             /* fully unlinked */
 956                 if (list_empty (&qh->qtd_list)) {
 957                         qh_put (qh);
 958                         break;
 959                 }
 960                 /* else FALL THROUGH */
 961         default:
 962 nogood:
 963                 /* caller was supposed to have unlinked any requests;
 964                  * that's not our job.  just leak this memory.
 965                  */
 966                 ehci_err (ehci, "qh %p (#%02x) state %d%s\n",
 967                         qh, ep->desc.bEndpointAddress, qh->qh_state,
 968                         list_empty (&qh->qtd_list) ? "" : "(has tds)");
 969                 break;
 970         }
 971         ep->hcpriv = NULL;
 972 done:
 973         spin_unlock_irqrestore (&ehci->lock, flags);
 974         return;
 975 }
 976
 977 static int ehci_get_frame (struct usb_hcd *hcd)
 978 {
 979         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 980         return (ehci_readl(ehci, &ehci->regs->frame_index) >> 3) %
 981                 ehci->periodic_size;
 982 }
 983
 984 /*-------------------------------------------------------------------------*/
 985
 986 #define DRIVER_INFO DRIVER_VERSION " " DRIVER_DESC
 987
 988 MODULE_DESCRIPTION (DRIVER_INFO);
 989 MODULE_AUTHOR (DRIVER_AUTHOR);
 990 MODULE_LICENSE ("GPL");
 991
 992 #ifdef CONFIG_PCI
 993 #include "ehci-pci.c"
 994 #define PCI_DRIVER              ehci_pci_driver
 995 #endif
 996
 997 #ifdef CONFIG_MPC834x
 998 #include "ehci-fsl.c"
 999 #define PLATFORM_DRIVER         ehci_fsl_driver
1000 #endif
1001
1002 #ifdef CONFIG_SOC_AU1200
1003 #include "ehci-au1xxx.c"
1004 #define PLATFORM_DRIVER         ehci_hcd_au1xxx_driver
1005 #endif
1006
1007 #ifdef CONFIG_PPC_PS3
1008 #include "ehci-ps3.c"
1009 #define PS3_SYSTEM_BUS_DRIVER   ps3_ehci_sb_driver
1010 #endif
1011
1012 #ifdef CONFIG_440EPX
1013 #include "ehci-ppc-soc.c"
1014 #define PLATFORM_DRIVER         ehci_ppc_soc_driver
1015 #endif
1016
1017 #if !defined(PCI_DRIVER) && !defined(PLATFORM_DRIVER) && \
1018     !defined(PS3_SYSTEM_BUS_DRIVER)
1019 #error "missing bus glue for ehci-hcd"
1020 #endif
1021
1022 static int __init ehci_hcd_init(void)
1023 {
1024         int retval = 0;
1025
1026         pr_debug("%s: block sizes: qh %Zd qtd %Zd itd %Zd sitd %Zd\n",
1027                  hcd_name,
1028                  sizeof(struct ehci_qh), sizeof(struct ehci_qtd),
1029                  sizeof(struct ehci_itd), sizeof(struct ehci_sitd));
1030
1031 #ifdef PLATFORM_DRIVER
1032         retval = platform_driver_register(&PLATFORM_DRIVER);
1033         if (retval < 0)
1034                 return retval;
1035 #endif
1036
1037 #ifdef PCI_DRIVER
1038         retval = pci_register_driver(&PCI_DRIVER);
1039         if (retval < 0) {
1040 #ifdef PLATFORM_DRIVER
1041                 platform_driver_unregister(&PLATFORM_DRIVER);
1042 #endif
1043                 return retval;
1044         }
1045 #endif
1046
1047 #ifdef PS3_SYSTEM_BUS_DRIVER
1048         if (firmware_has_feature(FW_FEATURE_PS3_LV1)) {
1049                 retval = ps3_system_bus_driver_register(
1050                                 &PS3_SYSTEM_BUS_DRIVER);
1051                 if (retval < 0) {
1052 #ifdef PLATFORM_DRIVER
1053                         platform_driver_unregister(&PLATFORM_DRIVER);
1054 #endif
1055 #ifdef PCI_DRIVER
1056                         pci_unregister_driver(&PCI_DRIVER);
1057 #endif
1058                         return retval;
1059                 }
1060         }
1061 #endif
1062
1063         return retval;
1064 }
1065 module_init(ehci_hcd_init);
1066
1067 static void __exit ehci_hcd_cleanup(void)
1068 {
1069 #ifdef PLATFORM_DRIVER
1070         platform_driver_unregister(&PLATFORM_DRIVER);
1071 #endif
1072 #ifdef PCI_DRIVER
1073         pci_unregister_driver(&PCI_DRIVER);
1074 #endif
1075 #ifdef PS3_SYSTEM_BUS_DRIVER
1076         if (firmware_has_feature(FW_FEATURE_PS3_LV1))
1077                 ps3_system_bus_driver_unregister(&PS3_SYSTEM_BUS_DRIVER);
1078 #endif
1079 }
1080 module_exit(ehci_hcd_cleanup);
1081