drivers/usb/host/ehci-hcd.c

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