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