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 static void ehci_watchdog (unsigned long param)
 277 {
 278         struct ehci_hcd         *ehci = (struct ehci_hcd *) param;
 279         unsigned long           flags;
 280
 281         spin_lock_irqsave (&ehci->lock, flags);
 282
 283         /* lost IAA irqs wedge things badly; seen with a vt8235 */
 284         if (ehci->reclaim) {
 285                 u32             status = ehci_readl(ehci, &ehci->regs->status);
 286                 if (status & STS_IAA) {
 287                         ehci_vdbg (ehci, "lost IAA\n");
 288                         COUNT (ehci->stats.lost_iaa);
 289                         ehci_writel(ehci, STS_IAA, &ehci->regs->status);
 290                         ehci->reclaim_ready = 1;
 291                 }
 292         }
 293
 294         /* stop async processing after it's idled a bit */
 295         if (test_bit (TIMER_ASYNC_OFF, &ehci->actions))
 296                 start_unlink_async (ehci, ehci->async);
 297
 298         /* ehci could run by timer, without IRQs ... */
 299         ehci_work (ehci);
 300
 301         spin_unlock_irqrestore (&ehci->lock, flags);
 302 }
 303
 304 /* On some systems, leaving remote wakeup enabled prevents system shutdown.
 305  * The firmware seems to think that powering off is a wakeup event!
 306  * This routine turns off remote wakeup and everything else, on all ports.
 307  */
 308 static void ehci_turn_off_all_ports(struct ehci_hcd *ehci)
 309 {
 310         int     port = HCS_N_PORTS(ehci->hcs_params);
 311
 312         while (port--)
 313                 ehci_writel(ehci, PORT_RWC_BITS,
 314                                 &ehci->regs->port_status[port]);
 315 }
 316
 317 /* ehci_shutdown kick in for silicon on any bus (not just pci, etc).
 318  * This forcibly disables dma and IRQs, helping kexec and other cases
 319  * where the next system software may expect clean state.
 320  */
 321 static void
 322 ehci_shutdown (struct usb_hcd *hcd)
 323 {
 324         struct ehci_hcd *ehci;
 325
 326         ehci = hcd_to_ehci (hcd);
 327         (void) ehci_halt (ehci);
 328         ehci_turn_off_all_ports(ehci);
 329
 330         /* make BIOS/etc use companion controller during reboot */
 331         ehci_writel(ehci, 0, &ehci->regs->configured_flag);
 332
 333         /* unblock posted writes */
 334         ehci_readl(ehci, &ehci->regs->configured_flag);
 335 }
 336
 337 static void ehci_port_power (struct ehci_hcd *ehci, int is_on)
 338 {
 339         unsigned port;
 340
 341         if (!HCS_PPC (ehci->hcs_params))
 342                 return;
 343
 344         ehci_dbg (ehci, "...power%s ports...\n", is_on ? "up" : "down");
 345         for (port = HCS_N_PORTS (ehci->hcs_params); port > 0; )
 346                 (void) ehci_hub_control(ehci_to_hcd(ehci),
 347                                 is_on ? SetPortFeature : ClearPortFeature,
 348                                 USB_PORT_FEAT_POWER,
 349                                 port--, NULL, 0);
 350         msleep(20);
 351 }
 352
 353 /*-------------------------------------------------------------------------*/
 354
 355 /*
 356  * ehci_work is called from some interrupts, timers, and so on.
 357  * it calls driver completion functions, after dropping ehci->lock.
 358  */
 359 static void ehci_work (struct ehci_hcd *ehci)
 360 {
 361         timer_action_done (ehci, TIMER_IO_WATCHDOG);
 362         if (ehci->reclaim_ready)
 363                 end_unlink_async (ehci);
 364
 365         /* another CPU may drop ehci->lock during a schedule scan while
 366          * it reports urb completions.  this flag guards against bogus
 367          * attempts at re-entrant schedule scanning.
 368          */
 369         if (ehci->scanning)
 370                 return;
 371         ehci->scanning = 1;
 372         scan_async (ehci);
 373         if (ehci->next_uframe != -1)
 374                 scan_periodic (ehci);
 375         ehci->scanning = 0;
 376
 377         /* the IO watchdog guards against hardware or driver bugs that
 378          * misplace IRQs, and should let us run completely without IRQs.
 379          * such lossage has been observed on both VT6202 and VT8235.
 380          */
 381         if (HC_IS_RUNNING (ehci_to_hcd(ehci)->state) &&
 382                         (ehci->async->qh_next.ptr != NULL ||
 383                          ehci->periodic_sched != 0))
 384                 timer_action (ehci, TIMER_IO_WATCHDOG);
 385 }
 386
 387 static void ehci_stop (struct usb_hcd *hcd)
 388 {
 389         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 390
 391         ehci_dbg (ehci, "stop\n");
 392
 393         /* Turn off port power on all root hub ports. */
 394         ehci_port_power (ehci, 0);
 395
 396         /* no more interrupts ... */
 397         del_timer_sync (&ehci->watchdog);
 398
 399         spin_lock_irq(&ehci->lock);
 400         if (HC_IS_RUNNING (hcd->state))
 401                 ehci_quiesce (ehci);
 402
 403         ehci_reset (ehci);
 404         ehci_writel(ehci, 0, &ehci->regs->intr_enable);
 405         spin_unlock_irq(&ehci->lock);
 406
 407         /* let companion controllers work when we aren't */
 408         ehci_writel(ehci, 0, &ehci->regs->configured_flag);
 409
 410         remove_companion_file(ehci);
 411         remove_debug_files (ehci);
 412
 413         /* root hub is shut down separately (first, when possible) */
 414         spin_lock_irq (&ehci->lock);
 415         if (ehci->async)
 416                 ehci_work (ehci);
 417         spin_unlock_irq (&ehci->lock);
 418         ehci_mem_cleanup (ehci);
 419
 420 #ifdef  EHCI_STATS
 421         ehci_dbg (ehci, "irq normal %ld err %ld reclaim %ld (lost %ld)\n",
 422                 ehci->stats.normal, ehci->stats.error, ehci->stats.reclaim,
 423                 ehci->stats.lost_iaa);
 424         ehci_dbg (ehci, "complete %ld unlink %ld\n",
 425                 ehci->stats.complete, ehci->stats.unlink);
 426 #endif
 427
 428         dbg_status (ehci, "ehci_stop completed",
 429                     ehci_readl(ehci, &ehci->regs->status));
 430 }
 431
 432 /* one-time init, only for memory state */
 433 static int ehci_init(struct usb_hcd *hcd)
 434 {
 435         struct ehci_hcd         *ehci = hcd_to_ehci(hcd);
 436         u32                     temp;
 437         int                     retval;
 438         u32                     hcc_params;
 439
 440         spin_lock_init(&ehci->lock);
 441
 442         init_timer(&ehci->watchdog);
 443         ehci->watchdog.function = ehci_watchdog;
 444         ehci->watchdog.data = (unsigned long) ehci;
 445
 446         /*
 447          * hw default: 1K periodic list heads, one per frame.
 448          * periodic_size can shrink by USBCMD update if hcc_params allows.
 449          */
 450         ehci->periodic_size = DEFAULT_I_TDPS;
 451         if ((retval = ehci_mem_init(ehci, GFP_KERNEL)) < 0)
 452                 return retval;
 453
 454         /* controllers may cache some of the periodic schedule ... */
 455         hcc_params = ehci_readl(ehci, &ehci->caps->hcc_params);
 456         if (HCC_ISOC_CACHE(hcc_params))         // full frame cache
 457                 ehci->i_thresh = 8;
 458         else                                    // N microframes cached
 459                 ehci->i_thresh = 2 + HCC_ISOC_THRES(hcc_params);
 460
 461         ehci->reclaim = NULL;
 462         ehci->reclaim_ready = 0;
 463         ehci->next_uframe = -1;
 464
 465         /*
 466          * dedicate a qh for the async ring head, since we couldn't unlink
 467          * a 'real' qh without stopping the async schedule [4.8].  use it
 468          * as the 'reclamation list head' too.
 469          * its dummy is used in hw_alt_next of many tds, to prevent the qh
 470          * from automatically advancing to the next td after short reads.
 471          */
 472         ehci->async->qh_next.qh = NULL;
 473         ehci->async->hw_next = QH_NEXT(ehci->async->qh_dma);
 474         ehci->async->hw_info1 = cpu_to_le32(QH_HEAD);
 475         ehci->async->hw_token = cpu_to_le32(QTD_STS_HALT);
 476         ehci->async->hw_qtd_next = EHCI_LIST_END;
 477         ehci->async->qh_state = QH_STATE_LINKED;
 478         ehci->async->hw_alt_next = QTD_NEXT(ehci->async->dummy->qtd_dma);
 479
 480         /* clear interrupt enables, set irq latency */
 481         if (log2_irq_thresh < 0 || log2_irq_thresh > 6)
 482                 log2_irq_thresh = 0;
 483         temp = 1 << (16 + log2_irq_thresh);
 484         if (HCC_CANPARK(hcc_params)) {
 485                 /* HW default park == 3, on hardware that supports it (like
 486                  * NVidia and ALI silicon), maximizes throughput on the async
 487                  * schedule by avoiding QH fetches between transfers.
 488                  *
 489                  * With fast usb storage devices and NForce2, "park" seems to
 490                  * make problems:  throughput reduction (!), data errors...
 491                  */
 492                 if (park) {
 493                         park = min(park, (unsigned) 3);
 494                         temp |= CMD_PARK;
 495                         temp |= park << 8;
 496                 }
 497                 ehci_dbg(ehci, "park %d\n", park);
 498         }
 499         if (HCC_PGM_FRAMELISTLEN(hcc_params)) {
 500                 /* periodic schedule size can be smaller than default */
 501                 temp &= ~(3 << 2);
 502                 temp |= (EHCI_TUNE_FLS << 2);
 503                 switch (EHCI_TUNE_FLS) {
 504                 case 0: ehci->periodic_size = 1024; break;
 505                 case 1: ehci->periodic_size = 512; break;
 506                 case 2: ehci->periodic_size = 256; break;
 507                 default:        BUG();
 508                 }
 509         }
 510         ehci->command = temp;
 511
 512         return 0;
 513 }
 514
 515 /* start HC running; it's halted, ehci_init() has been run (once) */
 516 static int ehci_run (struct usb_hcd *hcd)
 517 {
 518         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 519         int                     retval;
 520         u32                     temp;
 521         u32                     hcc_params;
 522
 523         hcd->uses_new_polling = 1;
 524         hcd->poll_rh = 0;
 525
 526         /* EHCI spec section 4.1 */
 527         if ((retval = ehci_reset(ehci)) != 0) {
 528                 ehci_mem_cleanup(ehci);
 529                 return retval;
 530         }
 531         ehci_writel(ehci, ehci->periodic_dma, &ehci->regs->frame_list);
 532         ehci_writel(ehci, (u32)ehci->async->qh_dma, &ehci->regs->async_next);
 533
 534         /*
 535          * hcc_params controls whether ehci->regs->segment must (!!!)
 536          * be used; it constrains QH/ITD/SITD and QTD locations.
 537          * pci_pool consistent memory always uses segment zero.
 538          * streaming mappings for I/O buffers, like pci_map_single(),
 539          * can return segments above 4GB, if the device allows.
 540          *
 541          * NOTE:  the dma mask is visible through dma_supported(), so
 542          * drivers can pass this info along ... like NETIF_F_HIGHDMA,
 543          * Scsi_Host.highmem_io, and so forth.  It's readonly to all
 544          * host side drivers though.
 545          */
 546         hcc_params = ehci_readl(ehci, &ehci->caps->hcc_params);
 547         if (HCC_64BIT_ADDR(hcc_params)) {
 548                 ehci_writel(ehci, 0, &ehci->regs->segment);
 549 #if 0
 550 // this is deeply broken on almost all architectures
 551                 if (!dma_set_mask(hcd->self.controller, DMA_64BIT_MASK))
 552                         ehci_info(ehci, "enabled 64bit DMA\n");
 553 #endif
 554         }
 555
 556
 557         // Philips, Intel, and maybe others need CMD_RUN before the
 558         // root hub will detect new devices (why?); NEC doesn't
 559         ehci->command &= ~(CMD_LRESET|CMD_IAAD|CMD_PSE|CMD_ASE|CMD_RESET);
 560         ehci->command |= CMD_RUN;
 561         ehci_writel(ehci, ehci->command, &ehci->regs->command);
 562         dbg_cmd (ehci, "init", ehci->command);
 563
 564         /*
 565          * Start, enabling full USB 2.0 functionality ... usb 1.1 devices
 566          * are explicitly handed to companion controller(s), so no TT is
 567          * involved with the root hub.  (Except where one is integrated,
 568          * and there's no companion controller unless maybe for USB OTG.)
 569          */
 570         hcd->state = HC_STATE_RUNNING;
 571         ehci_writel(ehci, FLAG_CF, &ehci->regs->configured_flag);
 572         ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
 573
 574         temp = HC_VERSION(ehci_readl(ehci, &ehci->caps->hc_capbase));
 575         ehci_info (ehci,
 576                 "USB %x.%x started, EHCI %x.%02x, driver %s%s\n",
 577                 ((ehci->sbrn & 0xf0)>>4), (ehci->sbrn & 0x0f),
 578                 temp >> 8, temp & 0xff, DRIVER_VERSION,
 579                 ignore_oc ? ", overcurrent ignored" : "");
 580
 581         ehci_writel(ehci, INTR_MASK,
 582                     &ehci->regs->intr_enable); /* Turn On Interrupts */
 583
 584         /* GRR this is run-once init(), being done every time the HC starts.
 585          * So long as they're part of class devices, we can't do it init()
 586          * since the class device isn't created that early.
 587          */
 588         create_debug_files(ehci);
 589         create_companion_file(ehci);
 590
 591         return 0;
 592 }
 593
 594 /*-------------------------------------------------------------------------*/
 595
 596 static irqreturn_t ehci_irq (struct usb_hcd *hcd)
 597 {
 598         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 599         u32                     status, pcd_status = 0;
 600         int                     bh;
 601
 602         spin_lock (&ehci->lock);
 603
 604         status = ehci_readl(ehci, &ehci->regs->status);
 605
 606         /* e.g. cardbus physical eject */
 607         if (status == ~(u32) 0) {
 608                 ehci_dbg (ehci, "device removed\n");
 609                 goto dead;
 610         }
 611
 612         status &= INTR_MASK;
 613         if (!status) {                  /* irq sharing? */
 614                 spin_unlock(&ehci->lock);
 615                 return IRQ_NONE;
 616         }
 617
 618         /* clear (just) interrupts */
 619         ehci_writel(ehci, status, &ehci->regs->status);
 620         ehci_readl(ehci, &ehci->regs->command); /* unblock posted write */
 621         bh = 0;
 622
 623 #ifdef  EHCI_VERBOSE_DEBUG
 624         /* unrequested/ignored: Frame List Rollover */
 625         dbg_status (ehci, "irq", status);
 626 #endif
 627
 628         /* INT, ERR, and IAA interrupt rates can be throttled */
 629
 630         /* normal [4.15.1.2] or error [4.15.1.1] completion */
 631         if (likely ((status & (STS_INT|STS_ERR)) != 0)) {
 632                 if (likely ((status & STS_ERR) == 0))
 633                         COUNT (ehci->stats.normal);
 634                 else
 635                         COUNT (ehci->stats.error);
 636                 bh = 1;
 637         }
 638
 639         /* complete the unlinking of some qh [4.15.2.3] */
 640         if (status & STS_IAA) {
 641                 COUNT (ehci->stats.reclaim);
 642                 ehci->reclaim_ready = 1;
 643                 bh = 1;
 644         }
 645
 646         /* remote wakeup [4.3.1] */
 647         if (status & STS_PCD) {
 648                 unsigned        i = HCS_N_PORTS (ehci->hcs_params);
 649                 pcd_status = status;
 650
 651                 /* resume root hub? */
 652                 if (!(ehci_readl(ehci, &ehci->regs->command) & CMD_RUN))
 653                         usb_hcd_resume_root_hub(hcd);
 654
 655                 while (i--) {
 656                         int pstatus = ehci_readl(ehci,
 657                                                  &ehci->regs->port_status [i]);
 658
 659                         if (pstatus & PORT_OWNER)
 660                                 continue;
 661                         if (!(pstatus & PORT_RESUME)
 662                                         || ehci->reset_done [i] != 0)
 663                                 continue;
 664
 665                         /* start 20 msec resume signaling from this port,
 666                          * and make khubd collect PORT_STAT_C_SUSPEND to
 667                          * stop that signaling.
 668                          */
 669                         ehci->reset_done [i] = jiffies + msecs_to_jiffies (20);
 670                         ehci_dbg (ehci, "port %d remote wakeup\n", i + 1);
 671                         mod_timer(&hcd->rh_timer, ehci->reset_done[i]);
 672                 }
 673         }
 674
 675         /* PCI errors [4.15.2.4] */
 676         if (unlikely ((status & STS_FATAL) != 0)) {
 677                 /* bogus "fatal" IRQs appear on some chips... why?  */
 678                 status = ehci_readl(ehci, &ehci->regs->status);
 679                 dbg_cmd (ehci, "fatal", ehci_readl(ehci,
 680                                                    &ehci->regs->command));
 681                 dbg_status (ehci, "fatal", status);
 682                 if (status & STS_HALT) {
 683                         ehci_err (ehci, "fatal error\n");
 684 dead:
 685                         ehci_reset (ehci);
 686                         ehci_writel(ehci, 0, &ehci->regs->configured_flag);
 687                         /* generic layer kills/unlinks all urbs, then
 688                          * uses ehci_stop to clean up the rest
 689                          */
 690                         bh = 1;
 691                 }
 692         }
 693
 694         if (bh)
 695                 ehci_work (ehci);
 696         spin_unlock (&ehci->lock);
 697         if (pcd_status & STS_PCD)
 698                 usb_hcd_poll_rh_status(hcd);
 699         return IRQ_HANDLED;
 700 }
 701
 702 /*-------------------------------------------------------------------------*/
 703
 704 /*
 705  * non-error returns are a promise to giveback() the urb later
 706  * we drop ownership so next owner (or urb unlink) can get it
 707  *
 708  * urb + dev is in hcd.self.controller.urb_list
 709  * we're queueing TDs onto software and hardware lists
 710  *
 711  * hcd-specific init for hcpriv hasn't been done yet
 712  *
 713  * NOTE:  control, bulk, and interrupt share the same code to append TDs
 714  * to a (possibly active) QH, and the same QH scanning code.
 715  */
 716 static int ehci_urb_enqueue (
 717         struct usb_hcd  *hcd,
 718         struct usb_host_endpoint *ep,
 719         struct urb      *urb,
 720         gfp_t           mem_flags
 721 ) {
 722         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 723         struct list_head        qtd_list;
 724
 725         INIT_LIST_HEAD (&qtd_list);
 726
 727         switch (usb_pipetype (urb->pipe)) {
 728         // case PIPE_CONTROL:
 729         // case PIPE_BULK:
 730         default:
 731                 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
 732                         return -ENOMEM;
 733                 return submit_async (ehci, ep, urb, &qtd_list, mem_flags);
 734
 735         case PIPE_INTERRUPT:
 736                 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
 737                         return -ENOMEM;
 738                 return intr_submit (ehci, ep, urb, &qtd_list, mem_flags);
 739
 740         case PIPE_ISOCHRONOUS:
 741                 if (urb->dev->speed == USB_SPEED_HIGH)
 742                         return itd_submit (ehci, urb, mem_flags);
 743                 else
 744                         return sitd_submit (ehci, urb, mem_flags);
 745         }
 746 }
 747
 748 static void unlink_async (struct ehci_hcd *ehci, struct ehci_qh *qh)
 749 {
 750         /* if we need to use IAA and it's busy, defer */
 751         if (qh->qh_state == QH_STATE_LINKED
 752                         && ehci->reclaim
 753                         && HC_IS_RUNNING (ehci_to_hcd(ehci)->state)) {
 754                 struct ehci_qh          *last;
 755
 756                 for (last = ehci->reclaim;
 757                                 last->reclaim;
 758                                 last = last->reclaim)
 759                         continue;
 760                 qh->qh_state = QH_STATE_UNLINK_WAIT;
 761                 last->reclaim = qh;
 762
 763         /* bypass IAA if the hc can't care */
 764         } else if (!HC_IS_RUNNING (ehci_to_hcd(ehci)->state) && ehci->reclaim)
 765                 end_unlink_async (ehci);
 766
 767         /* something else might have unlinked the qh by now */
 768         if (qh->qh_state == QH_STATE_LINKED)
 769                 start_unlink_async (ehci, qh);
 770 }
 771
 772 /* remove from hardware lists
 773  * completions normally happen asynchronously
 774  */
 775
 776 static int ehci_urb_dequeue (struct usb_hcd *hcd, struct urb *urb)
 777 {
 778         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 779         struct ehci_qh          *qh;
 780         unsigned long           flags;
 781
 782         spin_lock_irqsave (&ehci->lock, flags);
 783         switch (usb_pipetype (urb->pipe)) {
 784         // case PIPE_CONTROL:
 785         // case PIPE_BULK:
 786         default:
 787                 qh = (struct ehci_qh *) urb->hcpriv;
 788                 if (!qh)
 789                         break;
 790                 unlink_async (ehci, qh);
 791                 break;
 792
 793         case PIPE_INTERRUPT:
 794                 qh = (struct ehci_qh *) urb->hcpriv;
 795                 if (!qh)
 796                         break;
 797                 switch (qh->qh_state) {
 798                 case QH_STATE_LINKED:
 799                         intr_deschedule (ehci, qh);
 800                         /* FALL THROUGH */
 801                 case QH_STATE_IDLE:
 802                         qh_completions (ehci, qh);
 803                         break;
 804                 default:
 805                         ehci_dbg (ehci, "bogus qh %p state %d\n",
 806                                         qh, qh->qh_state);
 807                         goto done;
 808                 }
 809
 810                 /* reschedule QH iff another request is queued */
 811                 if (!list_empty (&qh->qtd_list)
 812                                 && HC_IS_RUNNING (hcd->state)) {
 813                         int status;
 814
 815                         status = qh_schedule (ehci, qh);
 816                         spin_unlock_irqrestore (&ehci->lock, flags);
 817
 818                         if (status != 0) {
 819                                 // shouldn't happen often, but ...
 820                                 // FIXME kill those tds' urbs
 821                                 err ("can't reschedule qh %p, err %d",
 822                                         qh, status);
 823                         }
 824                         return status;
 825                 }
 826                 break;
 827
 828         case PIPE_ISOCHRONOUS:
 829                 // itd or sitd ...
 830
 831                 // wait till next completion, do it then.
 832                 // completion irqs can wait up to 1024 msec,
 833                 break;
 834         }
 835 done:
 836         spin_unlock_irqrestore (&ehci->lock, flags);
 837         return 0;
 838 }
 839
 840 /*-------------------------------------------------------------------------*/
 841
 842 // bulk qh holds the data toggle
 843
 844 static void
 845 ehci_endpoint_disable (struct usb_hcd *hcd, struct usb_host_endpoint *ep)
 846 {
 847         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 848         unsigned long           flags;
 849         struct ehci_qh          *qh, *tmp;
 850
 851         /* ASSERT:  any requests/urbs are being unlinked */
 852         /* ASSERT:  nobody can be submitting urbs for this any more */
 853
 854 rescan:
 855         spin_lock_irqsave (&ehci->lock, flags);
 856         qh = ep->hcpriv;
 857         if (!qh)
 858                 goto done;
 859
 860         /* endpoints can be iso streams.  for now, we don't
 861          * accelerate iso completions ... so spin a while.
 862          */
 863         if (qh->hw_info1 == 0) {
 864                 ehci_vdbg (ehci, "iso delay\n");
 865                 goto idle_timeout;
 866         }
 867
 868         if (!HC_IS_RUNNING (hcd->state))
 869                 qh->qh_state = QH_STATE_IDLE;
 870         switch (qh->qh_state) {
 871         case QH_STATE_LINKED:
 872                 for (tmp = ehci->async->qh_next.qh;
 873                                 tmp && tmp != qh;
 874                                 tmp = tmp->qh_next.qh)
 875                         continue;
 876                 /* periodic qh self-unlinks on empty */
 877                 if (!tmp)
 878                         goto nogood;
 879                 unlink_async (ehci, qh);
 880                 /* FALL THROUGH */
 881         case QH_STATE_UNLINK:           /* wait for hw to finish? */
 882 idle_timeout:
 883                 spin_unlock_irqrestore (&ehci->lock, flags);
 884                 schedule_timeout_uninterruptible(1);
 885                 goto rescan;
 886         case QH_STATE_IDLE:             /* fully unlinked */
 887                 if (list_empty (&qh->qtd_list)) {
 888                         qh_put (qh);
 889                         break;
 890                 }
 891                 /* else FALL THROUGH */
 892         default:
 893 nogood:
 894                 /* caller was supposed to have unlinked any requests;
 895                  * that's not our job.  just leak this memory.
 896                  */
 897                 ehci_err (ehci, "qh %p (#%02x) state %d%s\n",
 898                         qh, ep->desc.bEndpointAddress, qh->qh_state,
 899                         list_empty (&qh->qtd_list) ? "" : "(has tds)");
 900                 break;
 901         }
 902         ep->hcpriv = NULL;
 903 done:
 904         spin_unlock_irqrestore (&ehci->lock, flags);
 905         return;
 906 }
 907
 908 static int ehci_get_frame (struct usb_hcd *hcd)
 909 {
 910         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 911         return (ehci_readl(ehci, &ehci->regs->frame_index) >> 3) %
 912                 ehci->periodic_size;
 913 }
 914
 915 /*-------------------------------------------------------------------------*/
 916
 917 #define DRIVER_INFO DRIVER_VERSION " " DRIVER_DESC
 918
 919 MODULE_DESCRIPTION (DRIVER_INFO);
 920 MODULE_AUTHOR (DRIVER_AUTHOR);
 921 MODULE_LICENSE ("GPL");
 922
 923 #ifdef CONFIG_PCI
 924 #include "ehci-pci.c"
 925 #define PCI_DRIVER              ehci_pci_driver
 926 #endif
 927
 928 #ifdef CONFIG_MPC834x
 929 #include "ehci-fsl.c"
 930 #define PLATFORM_DRIVER         ehci_fsl_driver
 931 #endif
 932
 933 #ifdef CONFIG_SOC_AU1200
 934 #include "ehci-au1xxx.c"
 935 #define PLATFORM_DRIVER         ehci_hcd_au1xxx_driver
 936 #endif
 937
 938 #ifdef CONFIG_PPC_PS3
 939 #include "ehci-ps3.c"
 940 #define PS3_SYSTEM_BUS_DRIVER   ps3_ehci_sb_driver
 941 #endif
 942
 943 #if !defined(PCI_DRIVER) && !defined(PLATFORM_DRIVER) && \
 944     !defined(PS3_SYSTEM_BUS_DRIVER)
 945 #error "missing bus glue for ehci-hcd"
 946 #endif
 947
 948 static int __init ehci_hcd_init(void)
 949 {
 950         int retval = 0;
 951
 952         pr_debug("%s: block sizes: qh %Zd qtd %Zd itd %Zd sitd %Zd\n",
 953                  hcd_name,
 954                  sizeof(struct ehci_qh), sizeof(struct ehci_qtd),
 955                  sizeof(struct ehci_itd), sizeof(struct ehci_sitd));
 956
 957 #ifdef PLATFORM_DRIVER
 958         retval = platform_driver_register(&PLATFORM_DRIVER);
 959         if (retval < 0)
 960                 return retval;
 961 #endif
 962
 963 #ifdef PCI_DRIVER
 964         retval = pci_register_driver(&PCI_DRIVER);
 965         if (retval < 0) {
 966 #ifdef PLATFORM_DRIVER
 967                 platform_driver_unregister(&PLATFORM_DRIVER);
 968 #endif
 969                 return retval;
 970         }
 971 #endif
 972
 973 #ifdef PS3_SYSTEM_BUS_DRIVER
 974         if (firmware_has_feature(FW_FEATURE_PS3_LV1)) {
 975                 retval = ps3_system_bus_driver_register(
 976                                 &PS3_SYSTEM_BUS_DRIVER);
 977                 if (retval < 0) {
 978 #ifdef PLATFORM_DRIVER
 979                         platform_driver_unregister(&PLATFORM_DRIVER);
 980 #endif
 981 #ifdef PCI_DRIVER
 982                         pci_unregister_driver(&PCI_DRIVER);
 983 #endif
 984                         return retval;
 985                 }
 986         }
 987 #endif
 988
 989         return retval;
 990 }
 991 module_init(ehci_hcd_init);
 992
 993 static void __exit ehci_hcd_cleanup(void)
 994 {
 995 #ifdef PLATFORM_DRIVER
 996         platform_driver_unregister(&PLATFORM_DRIVER);
 997 #endif
 998 #ifdef PCI_DRIVER
 999         pci_unregister_driver(&PCI_DRIVER);
1000 #endif
1001 #ifdef PS3_SYSTEM_BUS_DRIVER
1002         if (firmware_has_feature(FW_FEATURE_PS3_LV1))
1003                 ps3_system_bus_driver_unregister(&PS3_SYSTEM_BUS_DRIVER);
1004 #endif
1005 }
1006 module_exit(ehci_hcd_cleanup);
1007