drivers/usb/host/uhci-hcd.c

   1 /*
   2  * Universal Host Controller Interface driver for USB.
   3  *
   4  * Maintainer: Alan Stern <stern@rowland.harvard.edu>
   5  *
   6  * (C) Copyright 1999 Linus Torvalds
   7  * (C) Copyright 1999-2002 Johannes Erdfelt, johannes@erdfelt.com
   8  * (C) Copyright 1999 Randy Dunlap
   9  * (C) Copyright 1999 Georg Acher, acher@in.tum.de
  10  * (C) Copyright 1999 Deti Fliegl, deti@fliegl.de
  11  * (C) Copyright 1999 Thomas Sailer, sailer@ife.ee.ethz.ch
  12  * (C) Copyright 1999 Roman Weissgaerber, weissg@vienna.at
  13  * (C) Copyright 2000 Yggdrasil Computing, Inc. (port of new PCI interface
  14  *               support from usb-ohci.c by Adam Richter, adam@yggdrasil.com).
  15  * (C) Copyright 1999 Gregory P. Smith (from usb-ohci.c)
  16  * (C) Copyright 2004-2006 Alan Stern, stern@rowland.harvard.edu
  17  *
  18  * Intel documents this fairly well, and as far as I know there
  19  * are no royalties or anything like that, but even so there are
  20  * people who decided that they want to do the same thing in a
  21  * completely different way.
  22  *
  23  */
  24
  25 #include <linux/module.h>
  26 #include <linux/pci.h>
  27 #include <linux/kernel.h>
  28 #include <linux/init.h>
  29 #include <linux/delay.h>
  30 #include <linux/ioport.h>
  31 #include <linux/sched.h>
  32 #include <linux/slab.h>
  33 #include <linux/errno.h>
  34 #include <linux/unistd.h>
  35 #include <linux/interrupt.h>
  36 #include <linux/spinlock.h>
  37 #include <linux/debugfs.h>
  38 #include <linux/pm.h>
  39 #include <linux/dmapool.h>
  40 #include <linux/dma-mapping.h>
  41 #include <linux/usb.h>
  42 #include <linux/bitops.h>
  43 #include <linux/dmi.h>
  44
  45 #include <asm/uaccess.h>
  46 #include <asm/io.h>
  47 #include <asm/irq.h>
  48 #include <asm/system.h>
  49
  50 #include "../core/hcd.h"
  51 #include "uhci-hcd.h"
  52 #include "pci-quirks.h"
  53
  54 /*
  55  * Version Information
  56  */
  57 #define DRIVER_VERSION "v3.0"
  58 #define DRIVER_AUTHOR "Linus 'Frodo Rabbit' Torvalds, Johannes Erdfelt, \
  59 Randy Dunlap, Georg Acher, Deti Fliegl, Thomas Sailer, Roman Weissgaerber, \
  60 Alan Stern"
  61 #define DRIVER_DESC "USB Universal Host Controller Interface driver"
  62
  63 /* for flakey hardware, ignore overcurrent indicators */
  64 static int ignore_oc;
  65 module_param(ignore_oc, bool, S_IRUGO);
  66 MODULE_PARM_DESC(ignore_oc, "ignore hardware overcurrent indications");
  67
  68 /*
  69  * debug = 0, no debugging messages
  70  * debug = 1, dump failed URBs except for stalls
  71  * debug = 2, dump all failed URBs (including stalls)
  72  *            show all queues in /debug/uhci/[pci_addr]
  73  * debug = 3, show all TDs in URBs when dumping
  74  */
  75 #ifdef DEBUG
  76 #define DEBUG_CONFIGURED        1
  77 static int debug = 1;
  78 module_param(debug, int, S_IRUGO | S_IWUSR);
  79 MODULE_PARM_DESC(debug, "Debug level");
  80
  81 #else
  82 #define DEBUG_CONFIGURED        0
  83 #define debug                   0
  84 #endif
  85
  86 static char *errbuf;
  87 #define ERRBUF_LEN    (32 * 1024)
  88
  89 static struct kmem_cache *uhci_up_cachep;       /* urb_priv */
  90
  91 static void suspend_rh(struct uhci_hcd *uhci, enum uhci_rh_state new_state);
  92 static void wakeup_rh(struct uhci_hcd *uhci);
  93 static void uhci_get_current_frame_number(struct uhci_hcd *uhci);
  94
  95 #include "uhci-debug.c"
  96 #include "uhci-q.c"
  97 #include "uhci-hub.c"
  98
  99 /*
 100  * Finish up a host controller reset and update the recorded state.
 101  */
 102 static void finish_reset(struct uhci_hcd *uhci)
 103 {
 104         int port;
 105
 106         /* HCRESET doesn't affect the Suspend, Reset, and Resume Detect
 107          * bits in the port status and control registers.
 108          * We have to clear them by hand.
 109          */
 110         for (port = 0; port < uhci->rh_numports; ++port)
 111                 outw(0, uhci->io_addr + USBPORTSC1 + (port * 2));
 112
 113         uhci->port_c_suspend = uhci->resuming_ports = 0;
 114         uhci->rh_state = UHCI_RH_RESET;
 115         uhci->is_stopped = UHCI_IS_STOPPED;
 116         uhci_to_hcd(uhci)->state = HC_STATE_HALT;
 117         uhci_to_hcd(uhci)->poll_rh = 0;
 118
 119         uhci->dead = 0;         /* Full reset resurrects the controller */
 120 }
 121
 122 /*
 123  * Last rites for a defunct/nonfunctional controller
 124  * or one we don't want to use any more.
 125  */
 126 static void uhci_hc_died(struct uhci_hcd *uhci)
 127 {
 128         uhci_get_current_frame_number(uhci);
 129         uhci_reset_hc(to_pci_dev(uhci_dev(uhci)), uhci->io_addr);
 130         finish_reset(uhci);
 131         uhci->dead = 1;
 132
 133         /* The current frame may already be partway finished */
 134         ++uhci->frame_number;
 135 }
 136
 137 /*
 138  * Initialize a controller that was newly discovered or has lost power
 139  * or otherwise been reset while it was suspended.  In none of these cases
 140  * can we be sure of its previous state.
 141  */
 142 static void check_and_reset_hc(struct uhci_hcd *uhci)
 143 {
 144         if (uhci_check_and_reset_hc(to_pci_dev(uhci_dev(uhci)), uhci->io_addr))
 145                 finish_reset(uhci);
 146 }
 147
 148 /*
 149  * Store the basic register settings needed by the controller.
 150  */
 151 static void configure_hc(struct uhci_hcd *uhci)
 152 {
 153         /* Set the frame length to the default: 1 ms exactly */
 154         outb(USBSOF_DEFAULT, uhci->io_addr + USBSOF);
 155
 156         /* Store the frame list base address */
 157         outl(uhci->frame_dma_handle, uhci->io_addr + USBFLBASEADD);
 158
 159         /* Set the current frame number */
 160         outw(uhci->frame_number & UHCI_MAX_SOF_NUMBER,
 161                         uhci->io_addr + USBFRNUM);
 162
 163         /* Mark controller as not halted before we enable interrupts */
 164         uhci_to_hcd(uhci)->state = HC_STATE_SUSPENDED;
 165         mb();
 166
 167         /* Enable PIRQ */
 168         pci_write_config_word(to_pci_dev(uhci_dev(uhci)), USBLEGSUP,
 169                         USBLEGSUP_DEFAULT);
 170 }
 171
 172
 173 static int resume_detect_interrupts_are_broken(struct uhci_hcd *uhci)
 174 {
 175         int port;
 176
 177         /* If we have to ignore overcurrent events then almost by definition
 178          * we can't depend on resume-detect interrupts. */
 179         if (ignore_oc)
 180                 return 1;
 181
 182         switch (to_pci_dev(uhci_dev(uhci))->vendor) {
 183             default:
 184                 break;
 185
 186             case PCI_VENDOR_ID_GENESYS:
 187                 /* Genesys Logic's GL880S controllers don't generate
 188                  * resume-detect interrupts.
 189                  */
 190                 return 1;
 191
 192             case PCI_VENDOR_ID_INTEL:
 193                 /* Some of Intel's USB controllers have a bug that causes
 194                  * resume-detect interrupts if any port has an over-current
 195                  * condition.  To make matters worse, some motherboards
 196                  * hardwire unused USB ports' over-current inputs active!
 197                  * To prevent problems, we will not enable resume-detect
 198                  * interrupts if any ports are OC.
 199                  */
 200                 for (port = 0; port < uhci->rh_numports; ++port) {
 201                         if (inw(uhci->io_addr + USBPORTSC1 + port * 2) &
 202                                         USBPORTSC_OC)
 203                                 return 1;
 204                 }
 205                 break;
 206         }
 207         return 0;
 208 }
 209
 210 static int remote_wakeup_is_broken(struct uhci_hcd *uhci)
 211 {
 212         int port;
 213         char *sys_info;
 214         static char bad_Asus_board[] = "A7V8X";
 215
 216         /* One of Asus's motherboards has a bug which causes it to
 217          * wake up immediately from suspend-to-RAM if any of the ports
 218          * are connected.  In such cases we will not set EGSM.
 219          */
 220         sys_info = dmi_get_system_info(DMI_BOARD_NAME);
 221         if (sys_info && !strcmp(sys_info, bad_Asus_board)) {
 222                 for (port = 0; port < uhci->rh_numports; ++port) {
 223                         if (inw(uhci->io_addr + USBPORTSC1 + port * 2) &
 224                                         USBPORTSC_CCS)
 225                                 return 1;
 226                 }
 227         }
 228
 229         return 0;
 230 }
 231
 232 static void suspend_rh(struct uhci_hcd *uhci, enum uhci_rh_state new_state)
 233 __releases(uhci->lock)
 234 __acquires(uhci->lock)
 235 {
 236         int auto_stop;
 237         int int_enable, egsm_enable;
 238
 239         auto_stop = (new_state == UHCI_RH_AUTO_STOPPED);
 240         dev_dbg(&uhci_to_hcd(uhci)->self.root_hub->dev,
 241                         "%s%s\n", __FUNCTION__,
 242                         (auto_stop ? " (auto-stop)" : ""));
 243
 244         /* If we get a suspend request when we're already auto-stopped
 245          * then there's nothing to do.
 246          */
 247         if (uhci->rh_state == UHCI_RH_AUTO_STOPPED) {
 248                 uhci->rh_state = new_state;
 249                 return;
 250         }
 251
 252         /* Enable resume-detect interrupts if they work.
 253          * Then enter Global Suspend mode if _it_ works, still configured.
 254          */
 255         egsm_enable = USBCMD_EGSM;
 256         uhci->working_RD = 1;
 257         int_enable = USBINTR_RESUME;
 258         if (remote_wakeup_is_broken(uhci))
 259                 egsm_enable = 0;
 260         if (resume_detect_interrupts_are_broken(uhci) || !egsm_enable ||
 261                         !device_may_wakeup(
 262                                 &uhci_to_hcd(uhci)->self.root_hub->dev))
 263                 uhci->working_RD = int_enable = 0;
 264
 265         outw(int_enable, uhci->io_addr + USBINTR);
 266         outw(egsm_enable | USBCMD_CF, uhci->io_addr + USBCMD);
 267         mb();
 268         udelay(5);
 269
 270         /* If we're auto-stopping then no devices have been attached
 271          * for a while, so there shouldn't be any active URBs and the
 272          * controller should stop after a few microseconds.  Otherwise
 273          * we will give the controller one frame to stop.
 274          */
 275         if (!auto_stop && !(inw(uhci->io_addr + USBSTS) & USBSTS_HCH)) {
 276                 uhci->rh_state = UHCI_RH_SUSPENDING;
 277                 spin_unlock_irq(&uhci->lock);
 278                 msleep(1);
 279                 spin_lock_irq(&uhci->lock);
 280                 if (uhci->dead)
 281                         return;
 282         }
 283         if (!(inw(uhci->io_addr + USBSTS) & USBSTS_HCH))
 284                 dev_warn(&uhci_to_hcd(uhci)->self.root_hub->dev,
 285                         "Controller not stopped yet!\n");
 286
 287         uhci_get_current_frame_number(uhci);
 288
 289         uhci->rh_state = new_state;
 290         uhci->is_stopped = UHCI_IS_STOPPED;
 291         uhci_to_hcd(uhci)->poll_rh = !int_enable;
 292
 293         uhci_scan_schedule(uhci);
 294         uhci_fsbr_off(uhci);
 295 }
 296
 297 static void start_rh(struct uhci_hcd *uhci)
 298 {
 299         uhci_to_hcd(uhci)->state = HC_STATE_RUNNING;
 300         uhci->is_stopped = 0;
 301
 302         /* Mark it configured and running with a 64-byte max packet.
 303          * All interrupts are enabled, even though RESUME won't do anything.
 304          */
 305         outw(USBCMD_RS | USBCMD_CF | USBCMD_MAXP, uhci->io_addr + USBCMD);
 306         outw(USBINTR_TIMEOUT | USBINTR_RESUME | USBINTR_IOC | USBINTR_SP,
 307                         uhci->io_addr + USBINTR);
 308         mb();
 309         uhci->rh_state = UHCI_RH_RUNNING;
 310         uhci_to_hcd(uhci)->poll_rh = 1;
 311 }
 312
 313 static void wakeup_rh(struct uhci_hcd *uhci)
 314 __releases(uhci->lock)
 315 __acquires(uhci->lock)
 316 {
 317         dev_dbg(&uhci_to_hcd(uhci)->self.root_hub->dev,
 318                         "%s%s\n", __FUNCTION__,
 319                         uhci->rh_state == UHCI_RH_AUTO_STOPPED ?
 320                                 " (auto-start)" : "");
 321
 322         /* If we are auto-stopped then no devices are attached so there's
 323          * no need for wakeup signals.  Otherwise we send Global Resume
 324          * for 20 ms.
 325          */
 326         if (uhci->rh_state == UHCI_RH_SUSPENDED) {
 327                 uhci->rh_state = UHCI_RH_RESUMING;
 328                 outw(USBCMD_FGR | USBCMD_EGSM | USBCMD_CF,
 329                                 uhci->io_addr + USBCMD);
 330                 spin_unlock_irq(&uhci->lock);
 331                 msleep(20);
 332                 spin_lock_irq(&uhci->lock);
 333                 if (uhci->dead)
 334                         return;
 335
 336                 /* End Global Resume and wait for EOP to be sent */
 337                 outw(USBCMD_CF, uhci->io_addr + USBCMD);
 338                 mb();
 339                 udelay(4);
 340                 if (inw(uhci->io_addr + USBCMD) & USBCMD_FGR)
 341                         dev_warn(uhci_dev(uhci), "FGR not stopped yet!\n");
 342         }
 343
 344         start_rh(uhci);
 345
 346         /* Restart root hub polling */
 347         mod_timer(&uhci_to_hcd(uhci)->rh_timer, jiffies);
 348 }
 349
 350 static irqreturn_t uhci_irq(struct usb_hcd *hcd)
 351 {
 352         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
 353         unsigned short status;
 354         unsigned long flags;
 355
 356         /*
 357          * Read the interrupt status, and write it back to clear the
 358          * interrupt cause.  Contrary to the UHCI specification, the
 359          * "HC Halted" status bit is persistent: it is RO, not R/WC.
 360          */
 361         status = inw(uhci->io_addr + USBSTS);
 362         if (!(status & ~USBSTS_HCH))    /* shared interrupt, not mine */
 363                 return IRQ_NONE;
 364         outw(status, uhci->io_addr + USBSTS);           /* Clear it */
 365
 366         if (status & ~(USBSTS_USBINT | USBSTS_ERROR | USBSTS_RD)) {
 367                 if (status & USBSTS_HSE)
 368                         dev_err(uhci_dev(uhci), "host system error, "
 369                                         "PCI problems?\n");
 370                 if (status & USBSTS_HCPE)
 371                         dev_err(uhci_dev(uhci), "host controller process "
 372                                         "error, something bad happened!\n");
 373                 if (status & USBSTS_HCH) {
 374                         spin_lock_irqsave(&uhci->lock, flags);
 375                         if (uhci->rh_state >= UHCI_RH_RUNNING) {
 376                                 dev_err(uhci_dev(uhci),
 377                                         "host controller halted, "
 378                                         "very bad!\n");
 379                                 if (debug > 1 && errbuf) {
 380                                         /* Print the schedule for debugging */
 381                                         uhci_sprint_schedule(uhci,
 382                                                         errbuf, ERRBUF_LEN);
 383                                         lprintk(errbuf);
 384                                 }
 385                                 uhci_hc_died(uhci);
 386
 387                                 /* Force a callback in case there are
 388                                  * pending unlinks */
 389                                 mod_timer(&hcd->rh_timer, jiffies);
 390                         }
 391                         spin_unlock_irqrestore(&uhci->lock, flags);
 392                 }
 393         }
 394
 395         if (status & USBSTS_RD)
 396                 usb_hcd_poll_rh_status(hcd);
 397         else {
 398                 spin_lock_irqsave(&uhci->lock, flags);
 399                 uhci_scan_schedule(uhci);
 400                 spin_unlock_irqrestore(&uhci->lock, flags);
 401         }
 402
 403         return IRQ_HANDLED;
 404 }
 405
 406 /*
 407  * Store the current frame number in uhci->frame_number if the controller
 408  * is runnning.  Expand from 11 bits (of which we use only 10) to a
 409  * full-sized integer.
 410  *
 411  * Like many other parts of the driver, this code relies on being polled
 412  * more than once per second as long as the controller is running.
 413  */
 414 static void uhci_get_current_frame_number(struct uhci_hcd *uhci)
 415 {
 416         if (!uhci->is_stopped) {
 417                 unsigned delta;
 418
 419                 delta = (inw(uhci->io_addr + USBFRNUM) - uhci->frame_number) &
 420                                 (UHCI_NUMFRAMES - 1);
 421                 uhci->frame_number += delta;
 422         }
 423 }
 424
 425 /*
 426  * De-allocate all resources
 427  */
 428 static void release_uhci(struct uhci_hcd *uhci)
 429 {
 430         int i;
 431
 432         if (DEBUG_CONFIGURED) {
 433                 spin_lock_irq(&uhci->lock);
 434                 uhci->is_initialized = 0;
 435                 spin_unlock_irq(&uhci->lock);
 436
 437                 debugfs_remove(uhci->dentry);
 438         }
 439
 440         for (i = 0; i < UHCI_NUM_SKELQH; i++)
 441                 uhci_free_qh(uhci, uhci->skelqh[i]);
 442
 443         uhci_free_td(uhci, uhci->term_td);
 444
 445         dma_pool_destroy(uhci->qh_pool);
 446
 447         dma_pool_destroy(uhci->td_pool);
 448
 449         kfree(uhci->frame_cpu);
 450
 451         dma_free_coherent(uhci_dev(uhci),
 452                         UHCI_NUMFRAMES * sizeof(*uhci->frame),
 453                         uhci->frame, uhci->frame_dma_handle);
 454 }
 455
 456 static int uhci_init(struct usb_hcd *hcd)
 457 {
 458         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
 459         unsigned io_size = (unsigned) hcd->rsrc_len;
 460         int port;
 461
 462         uhci->io_addr = (unsigned long) hcd->rsrc_start;
 463
 464         /* The UHCI spec says devices must have 2 ports, and goes on to say
 465          * they may have more but gives no way to determine how many there
 466          * are.  However according to the UHCI spec, Bit 7 of the port
 467          * status and control register is always set to 1.  So we try to
 468          * use this to our advantage.  Another common failure mode when
 469          * a nonexistent register is addressed is to return all ones, so
 470          * we test for that also.
 471          */
 472         for (port = 0; port < (io_size - USBPORTSC1) / 2; port++) {
 473                 unsigned int portstatus;
 474
 475                 portstatus = inw(uhci->io_addr + USBPORTSC1 + (port * 2));
 476                 if (!(portstatus & 0x0080) || portstatus == 0xffff)
 477                         break;
 478         }
 479         if (debug)
 480                 dev_info(uhci_dev(uhci), "detected %d ports\n", port);
 481
 482         /* Anything greater than 7 is weird so we'll ignore it. */
 483         if (port > UHCI_RH_MAXCHILD) {
 484                 dev_info(uhci_dev(uhci), "port count misdetected? "
 485                                 "forcing to 2 ports\n");
 486                 port = 2;
 487         }
 488         uhci->rh_numports = port;
 489
 490         /* Kick BIOS off this hardware and reset if the controller
 491          * isn't already safely quiescent.
 492          */
 493         check_and_reset_hc(uhci);
 494         return 0;
 495 }
 496
 497 /* Make sure the controller is quiescent and that we're not using it
 498  * any more.  This is mainly for the benefit of programs which, like kexec,
 499  * expect the hardware to be idle: not doing DMA or generating IRQs.
 500  *
 501  * This routine may be called in a damaged or failing kernel.  Hence we
 502  * do not acquire the spinlock before shutting down the controller.
 503  */
 504 static void uhci_shutdown(struct pci_dev *pdev)
 505 {
 506         struct usb_hcd *hcd = (struct usb_hcd *) pci_get_drvdata(pdev);
 507
 508         uhci_hc_died(hcd_to_uhci(hcd));
 509 }
 510
 511 /*
 512  * Allocate a frame list, and then setup the skeleton
 513  *
 514  * The hardware doesn't really know any difference
 515  * in the queues, but the order does matter for the
 516  * protocols higher up. The order is:
 517  *
 518  *  - any isochronous events handled before any
 519  *    of the queues. We don't do that here, because
 520  *    we'll create the actual TD entries on demand.
 521  *  - The first queue is the interrupt queue.
 522  *  - The second queue is the control queue, split into low- and full-speed
 523  *  - The third queue is bulk queue.
 524  *  - The fourth queue is the bandwidth reclamation queue, which loops back
 525  *    to the full-speed control queue.
 526  */
 527 static int uhci_start(struct usb_hcd *hcd)
 528 {
 529         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
 530         int retval = -EBUSY;
 531         int i;
 532         struct dentry *dentry;
 533
 534         hcd->uses_new_polling = 1;
 535
 536         spin_lock_init(&uhci->lock);
 537         setup_timer(&uhci->fsbr_timer, uhci_fsbr_timeout,
 538                         (unsigned long) uhci);
 539         INIT_LIST_HEAD(&uhci->idle_qh_list);
 540         init_waitqueue_head(&uhci->waitqh);
 541
 542         if (DEBUG_CONFIGURED) {
 543                 dentry = debugfs_create_file(hcd->self.bus_name,
 544                                 S_IFREG|S_IRUGO|S_IWUSR, uhci_debugfs_root,
 545                                 uhci, &uhci_debug_operations);
 546                 if (!dentry) {
 547                         dev_err(uhci_dev(uhci), "couldn't create uhci "
 548                                         "debugfs entry\n");
 549                         retval = -ENOMEM;
 550                         goto err_create_debug_entry;
 551                 }
 552                 uhci->dentry = dentry;
 553         }
 554
 555         uhci->frame = dma_alloc_coherent(uhci_dev(uhci),
 556                         UHCI_NUMFRAMES * sizeof(*uhci->frame),
 557                         &uhci->frame_dma_handle, 0);
 558         if (!uhci->frame) {
 559                 dev_err(uhci_dev(uhci), "unable to allocate "
 560                                 "consistent memory for frame list\n");
 561                 goto err_alloc_frame;
 562         }
 563         memset(uhci->frame, 0, UHCI_NUMFRAMES * sizeof(*uhci->frame));
 564
 565         uhci->frame_cpu = kcalloc(UHCI_NUMFRAMES, sizeof(*uhci->frame_cpu),
 566                         GFP_KERNEL);
 567         if (!uhci->frame_cpu) {
 568                 dev_err(uhci_dev(uhci), "unable to allocate "
 569                                 "memory for frame pointers\n");
 570                 goto err_alloc_frame_cpu;
 571         }
 572
 573         uhci->td_pool = dma_pool_create("uhci_td", uhci_dev(uhci),
 574                         sizeof(struct uhci_td), 16, 0);
 575         if (!uhci->td_pool) {
 576                 dev_err(uhci_dev(uhci), "unable to create td dma_pool\n");
 577                 goto err_create_td_pool;
 578         }
 579
 580         uhci->qh_pool = dma_pool_create("uhci_qh", uhci_dev(uhci),
 581                         sizeof(struct uhci_qh), 16, 0);
 582         if (!uhci->qh_pool) {
 583                 dev_err(uhci_dev(uhci), "unable to create qh dma_pool\n");
 584                 goto err_create_qh_pool;
 585         }
 586
 587         uhci->term_td = uhci_alloc_td(uhci);
 588         if (!uhci->term_td) {
 589                 dev_err(uhci_dev(uhci), "unable to allocate terminating TD\n");
 590                 goto err_alloc_term_td;
 591         }
 592
 593         for (i = 0; i < UHCI_NUM_SKELQH; i++) {
 594                 uhci->skelqh[i] = uhci_alloc_qh(uhci, NULL, NULL);
 595                 if (!uhci->skelqh[i]) {
 596                         dev_err(uhci_dev(uhci), "unable to allocate QH\n");
 597                         goto err_alloc_skelqh;
 598                 }
 599         }
 600
 601         /*
 602          * 8 Interrupt queues; link all higher int queues to int1,
 603          * then link int1 to control and control to bulk
 604          */
 605         uhci->skel_int128_qh->link =
 606                         uhci->skel_int64_qh->link =
 607                         uhci->skel_int32_qh->link =
 608                         uhci->skel_int16_qh->link =
 609                         uhci->skel_int8_qh->link =
 610                         uhci->skel_int4_qh->link =
 611                         uhci->skel_int2_qh->link = UHCI_PTR_QH |
 612                         cpu_to_le32(uhci->skel_int1_qh->dma_handle);
 613
 614         uhci->skel_int1_qh->link = UHCI_PTR_QH |
 615                         cpu_to_le32(uhci->skel_ls_control_qh->dma_handle);
 616         uhci->skel_ls_control_qh->link = UHCI_PTR_QH |
 617                         cpu_to_le32(uhci->skel_fs_control_qh->dma_handle);
 618         uhci->skel_fs_control_qh->link = UHCI_PTR_QH |
 619                         cpu_to_le32(uhci->skel_bulk_qh->dma_handle);
 620         uhci->skel_bulk_qh->link = UHCI_PTR_QH |
 621                         cpu_to_le32(uhci->skel_term_qh->dma_handle);
 622
 623         /* This dummy TD is to work around a bug in Intel PIIX controllers */
 624         uhci_fill_td(uhci->term_td, 0, uhci_explen(0) |
 625                 (0x7f << TD_TOKEN_DEVADDR_SHIFT) | USB_PID_IN, 0);
 626         uhci->term_td->link = cpu_to_le32(uhci->term_td->dma_handle);
 627
 628         uhci->skel_term_qh->link = UHCI_PTR_TERM;
 629         uhci->skel_term_qh->element = cpu_to_le32(uhci->term_td->dma_handle);
 630
 631         /*
 632          * Fill the frame list: make all entries point to the proper
 633          * interrupt queue.
 634          *
 635          * The interrupt queues will be interleaved as evenly as possible.
 636          * There's not much to be done about period-1 interrupts; they have
 637          * to occur in every frame.  But we can schedule period-2 interrupts
 638          * in odd-numbered frames, period-4 interrupts in frames congruent
 639          * to 2 (mod 4), and so on.  This way each frame only has two
 640          * interrupt QHs, which will help spread out bandwidth utilization.
 641          */
 642         for (i = 0; i < UHCI_NUMFRAMES; i++) {
 643                 int irq;
 644
 645                 /*
 646                  * ffs (Find First bit Set) does exactly what we need:
 647                  * 1,3,5,...  => ffs = 0 => use skel_int2_qh = skelqh[8],
 648                  * 2,6,10,... => ffs = 1 => use skel_int4_qh = skelqh[7], etc.
 649                  * ffs >= 7 => not on any high-period queue, so use
 650                  *      skel_int1_qh = skelqh[9].
 651                  * Add UHCI_NUMFRAMES to insure at least one bit is set.
 652                  */
 653                 irq = 8 - (int) __ffs(i + UHCI_NUMFRAMES);
 654                 if (irq <= 1)
 655                         irq = 9;
 656
 657                 /* Only place we don't use the frame list routines */
 658                 uhci->frame[i] = UHCI_PTR_QH |
 659                                 cpu_to_le32(uhci->skelqh[irq]->dma_handle);
 660         }
 661
 662         /*
 663          * Some architectures require a full mb() to enforce completion of
 664          * the memory writes above before the I/O transfers in configure_hc().
 665          */
 666         mb();
 667
 668         configure_hc(uhci);
 669         uhci->is_initialized = 1;
 670         start_rh(uhci);
 671         return 0;
 672
 673 /*
 674  * error exits:
 675  */
 676 err_alloc_skelqh:
 677         for (i = 0; i < UHCI_NUM_SKELQH; i++) {
 678                 if (uhci->skelqh[i])
 679                         uhci_free_qh(uhci, uhci->skelqh[i]);
 680         }
 681
 682         uhci_free_td(uhci, uhci->term_td);
 683
 684 err_alloc_term_td:
 685         dma_pool_destroy(uhci->qh_pool);
 686
 687 err_create_qh_pool:
 688         dma_pool_destroy(uhci->td_pool);
 689
 690 err_create_td_pool:
 691         kfree(uhci->frame_cpu);
 692
 693 err_alloc_frame_cpu:
 694         dma_free_coherent(uhci_dev(uhci),
 695                         UHCI_NUMFRAMES * sizeof(*uhci->frame),
 696                         uhci->frame, uhci->frame_dma_handle);
 697
 698 err_alloc_frame:
 699         debugfs_remove(uhci->dentry);
 700
 701 err_create_debug_entry:
 702         return retval;
 703 }
 704
 705 static void uhci_stop(struct usb_hcd *hcd)
 706 {
 707         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
 708
 709         spin_lock_irq(&uhci->lock);
 710         if (test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags) && !uhci->dead)
 711                 uhci_hc_died(uhci);
 712         uhci_scan_schedule(uhci);
 713         spin_unlock_irq(&uhci->lock);
 714
 715         del_timer_sync(&uhci->fsbr_timer);
 716         release_uhci(uhci);
 717 }
 718
 719 #ifdef CONFIG_PM
 720 static int uhci_rh_suspend(struct usb_hcd *hcd)
 721 {
 722         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
 723         int rc = 0;
 724
 725         spin_lock_irq(&uhci->lock);
 726         if (!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags))
 727                 rc = -ESHUTDOWN;
 728         else if (!uhci->dead)
 729                 suspend_rh(uhci, UHCI_RH_SUSPENDED);
 730         spin_unlock_irq(&uhci->lock);
 731         return rc;
 732 }
 733
 734 static int uhci_rh_resume(struct usb_hcd *hcd)
 735 {
 736         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
 737         int rc = 0;
 738
 739         spin_lock_irq(&uhci->lock);
 740         if (!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)) {
 741                 dev_warn(&hcd->self.root_hub->dev, "HC isn't running!\n");
 742                 rc = -ESHUTDOWN;
 743         } else if (!uhci->dead)
 744                 wakeup_rh(uhci);
 745         spin_unlock_irq(&uhci->lock);
 746         return rc;
 747 }
 748
 749 static int uhci_suspend(struct usb_hcd *hcd, pm_message_t message)
 750 {
 751         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
 752         int rc = 0;
 753
 754         dev_dbg(uhci_dev(uhci), "%s\n", __FUNCTION__);
 755
 756         spin_lock_irq(&uhci->lock);
 757         if (!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags) || uhci->dead)
 758                 goto done_okay;         /* Already suspended or dead */
 759
 760         if (uhci->rh_state > UHCI_RH_SUSPENDED) {
 761                 dev_warn(uhci_dev(uhci), "Root hub isn't suspended!\n");
 762                 rc = -EBUSY;
 763                 goto done;
 764         };
 765
 766         /* All PCI host controllers are required to disable IRQ generation
 767          * at the source, so we must turn off PIRQ.
 768          */
 769         pci_write_config_word(to_pci_dev(uhci_dev(uhci)), USBLEGSUP, 0);
 770         mb();
 771         hcd->poll_rh = 0;
 772
 773         /* FIXME: Enable non-PME# remote wakeup? */
 774
 775         /* make sure snapshot being resumed re-enumerates everything */
 776         if (message.event == PM_EVENT_PRETHAW)
 777                 uhci_hc_died(uhci);
 778
 779 done_okay:
 780         clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
 781 done:
 782         spin_unlock_irq(&uhci->lock);
 783         return rc;
 784 }
 785
 786 static int uhci_resume(struct usb_hcd *hcd)
 787 {
 788         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
 789
 790         dev_dbg(uhci_dev(uhci), "%s\n", __FUNCTION__);
 791
 792         /* Since we aren't in D3 any more, it's safe to set this flag
 793          * even if the controller was dead.
 794          */
 795         set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
 796         mb();
 797
 798         spin_lock_irq(&uhci->lock);
 799
 800         /* FIXME: Disable non-PME# remote wakeup? */
 801
 802         /* The firmware or a boot kernel may have changed the controller
 803          * settings during a system wakeup.  Check it and reconfigure
 804          * to avoid problems.
 805          */
 806         check_and_reset_hc(uhci);
 807
 808         /* If the controller was dead before, it's back alive now */
 809         configure_hc(uhci);
 810
 811         if (uhci->rh_state == UHCI_RH_RESET) {
 812
 813                 /* The controller had to be reset */
 814                 usb_root_hub_lost_power(hcd->self.root_hub);
 815                 suspend_rh(uhci, UHCI_RH_SUSPENDED);
 816         }
 817
 818         spin_unlock_irq(&uhci->lock);
 819
 820         if (!uhci->working_RD) {
 821                 /* Suspended root hub needs to be polled */
 822                 hcd->poll_rh = 1;
 823                 usb_hcd_poll_rh_status(hcd);
 824         }
 825         return 0;
 826 }
 827 #endif
 828
 829 /* Wait until a particular device/endpoint's QH is idle, and free it */
 830 static void uhci_hcd_endpoint_disable(struct usb_hcd *hcd,
 831                 struct usb_host_endpoint *hep)
 832 {
 833         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
 834         struct uhci_qh *qh;
 835
 836         spin_lock_irq(&uhci->lock);
 837         qh = (struct uhci_qh *) hep->hcpriv;
 838         if (qh == NULL)
 839                 goto done;
 840
 841         while (qh->state != QH_STATE_IDLE) {
 842                 ++uhci->num_waiting;
 843                 spin_unlock_irq(&uhci->lock);
 844                 wait_event_interruptible(uhci->waitqh,
 845                                 qh->state == QH_STATE_IDLE);
 846                 spin_lock_irq(&uhci->lock);
 847                 --uhci->num_waiting;
 848         }
 849
 850         uhci_free_qh(uhci, qh);
 851 done:
 852         spin_unlock_irq(&uhci->lock);
 853 }
 854
 855 static int uhci_hcd_get_frame_number(struct usb_hcd *hcd)
 856 {
 857         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
 858         unsigned frame_number;
 859         unsigned delta;
 860
 861         /* Minimize latency by avoiding the spinlock */
 862         frame_number = uhci->frame_number;
 863         barrier();
 864         delta = (inw(uhci->io_addr + USBFRNUM) - frame_number) &
 865                         (UHCI_NUMFRAMES - 1);
 866         return frame_number + delta;
 867 }
 868
 869 static const char hcd_name[] = "uhci_hcd";
 870
 871 static const struct hc_driver uhci_driver = {
 872         .description =          hcd_name,
 873         .product_desc =         "UHCI Host Controller",
 874         .hcd_priv_size =        sizeof(struct uhci_hcd),
 875
 876         /* Generic hardware linkage */
 877         .irq =                  uhci_irq,
 878         .flags =                HCD_USB11,
 879
 880         /* Basic lifecycle operations */
 881         .reset =                uhci_init,
 882         .start =                uhci_start,
 883 #ifdef CONFIG_PM
 884         .suspend =              uhci_suspend,
 885         .resume =               uhci_resume,
 886         .bus_suspend =          uhci_rh_suspend,
 887         .bus_resume =           uhci_rh_resume,
 888 #endif
 889         .stop =                 uhci_stop,
 890
 891         .urb_enqueue =          uhci_urb_enqueue,
 892         .urb_dequeue =          uhci_urb_dequeue,
 893
 894         .endpoint_disable =     uhci_hcd_endpoint_disable,
 895         .get_frame_number =     uhci_hcd_get_frame_number,
 896
 897         .hub_status_data =      uhci_hub_status_data,
 898         .hub_control =          uhci_hub_control,
 899 };
 900
 901 static const struct pci_device_id uhci_pci_ids[] = { {
 902         /* handle any USB UHCI controller */
 903         PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_UHCI, ~0),
 904         .driver_data =  (unsigned long) &uhci_driver,
 905         }, { /* end: all zeroes */ }
 906 };
 907
 908 MODULE_DEVICE_TABLE(pci, uhci_pci_ids);
 909
 910 static struct pci_driver uhci_pci_driver = {
 911         .name =         (char *)hcd_name,
 912         .id_table =     uhci_pci_ids,
 913
 914         .probe =        usb_hcd_pci_probe,
 915         .remove =       usb_hcd_pci_remove,
 916         .shutdown =     uhci_shutdown,
 917
 918 #ifdef  CONFIG_PM
 919         .suspend =      usb_hcd_pci_suspend,
 920         .resume =       usb_hcd_pci_resume,
 921 #endif  /* PM */
 922 };
 923
 924 static int __init uhci_hcd_init(void)
 925 {
 926         int retval = -ENOMEM;
 927
 928         printk(KERN_INFO DRIVER_DESC " " DRIVER_VERSION "%s\n",
 929                         ignore_oc ? ", overcurrent ignored" : "");
 930
 931         if (usb_disabled())
 932                 return -ENODEV;
 933
 934         if (DEBUG_CONFIGURED) {
 935                 errbuf = kmalloc(ERRBUF_LEN, GFP_KERNEL);
 936                 if (!errbuf)
 937                         goto errbuf_failed;
 938                 uhci_debugfs_root = debugfs_create_dir("uhci", NULL);
 939                 if (!uhci_debugfs_root)
 940                         goto debug_failed;
 941         }
 942
 943         uhci_up_cachep = kmem_cache_create("uhci_urb_priv",
 944                 sizeof(struct urb_priv), 0, 0, NULL, NULL);
 945         if (!uhci_up_cachep)
 946                 goto up_failed;
 947
 948         retval = pci_register_driver(&uhci_pci_driver);
 949         if (retval)
 950                 goto init_failed;
 951
 952         return 0;
 953
 954 init_failed:
 955         kmem_cache_destroy(uhci_up_cachep);
 956
 957 up_failed:
 958         debugfs_remove(uhci_debugfs_root);
 959
 960 debug_failed:
 961         kfree(errbuf);
 962
 963 errbuf_failed:
 964
 965         return retval;
 966 }
 967
 968 static void __exit uhci_hcd_cleanup(void)
 969 {
 970         pci_unregister_driver(&uhci_pci_driver);
 971         kmem_cache_destroy(uhci_up_cachep);
 972         debugfs_remove(uhci_debugfs_root);
 973         kfree(errbuf);
 974 }
 975
 976 module_init(uhci_hcd_init);
 977 module_exit(uhci_hcd_cleanup);
 978
 979 MODULE_AUTHOR(DRIVER_AUTHOR);
 980 MODULE_DESCRIPTION(DRIVER_DESC);
 981 MODULE_LICENSE("GPL");