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-2007 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/slab.h>
  32 #include <linux/errno.h>
  33 #include <linux/unistd.h>
  34 #include <linux/interrupt.h>
  35 #include <linux/spinlock.h>
  36 #include <linux/debugfs.h>
  37 #include <linux/pm.h>
  38 #include <linux/dmapool.h>
  39 #include <linux/dma-mapping.h>
  40 #include <linux/usb.h>
  41 #include <linux/usb/hcd.h>
  42 #include <linux/bitops.h>
  43 #include <linux/dmi.h>
  44
  45 #include <linux/uaccess.h>
  46 #include <asm/io.h>
  47 #include <asm/irq.h>
  48
  49 #include "uhci-hcd.h"
  50
  51 /*
  52  * Version Information
  53  */
  54 #define DRIVER_AUTHOR                                                   \
  55         "Linus 'Frodo Rabbit' Torvalds, Johannes Erdfelt, "             \
  56         "Randy Dunlap, Georg Acher, Deti Fliegl, Thomas Sailer, "       \
  57         "Roman Weissgaerber, Alan Stern"
  58 #define DRIVER_DESC "USB Universal Host Controller Interface driver"
  59
  60 /* for flakey hardware, ignore overcurrent indicators */
  61 static bool ignore_oc;
  62 module_param(ignore_oc, bool, S_IRUGO);
  63 MODULE_PARM_DESC(ignore_oc, "ignore hardware overcurrent indications");
  64
  65 /*
  66  * debug = 0, no debugging messages
  67  * debug = 1, dump failed URBs except for stalls
  68  * debug = 2, dump all failed URBs (including stalls)
  69  *            show all queues in /sys/kernel/debug/uhci/[pci_addr]
  70  * debug = 3, show all TDs in URBs when dumping
  71  */
  72 #ifdef CONFIG_DYNAMIC_DEBUG
  73
  74 static int debug = 1;
  75 module_param(debug, int, S_IRUGO | S_IWUSR);
  76 MODULE_PARM_DESC(debug, "Debug level");
  77 static char *errbuf;
  78
  79 #else
  80
  81 #define debug 0
  82 #define errbuf NULL
  83
  84 #endif
  85
  86
  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 /*
  96  * Calculate the link pointer DMA value for the first Skeleton QH in a frame.
  97  */
  98 static __hc32 uhci_frame_skel_link(struct uhci_hcd *uhci, int frame)
  99 {
 100         int skelnum;
 101
 102         /*
 103          * The interrupt queues will be interleaved as evenly as possible.
 104          * There's not much to be done about period-1 interrupts; they have
 105          * to occur in every frame.  But we can schedule period-2 interrupts
 106          * in odd-numbered frames, period-4 interrupts in frames congruent
 107          * to 2 (mod 4), and so on.  This way each frame only has two
 108          * interrupt QHs, which will help spread out bandwidth utilization.
 109          *
 110          * ffs (Find First bit Set) does exactly what we need:
 111          * 1,3,5,...  => ffs = 0 => use period-2 QH = skelqh[8],
 112          * 2,6,10,... => ffs = 1 => use period-4 QH = skelqh[7], etc.
 113          * ffs >= 7 => not on any high-period queue, so use
 114          *      period-1 QH = skelqh[9].
 115          * Add in UHCI_NUMFRAMES to insure at least one bit is set.
 116          */
 117         skelnum = 8 - (int) __ffs(frame | UHCI_NUMFRAMES);
 118         if (skelnum <= 1)
 119                 skelnum = 9;
 120         return LINK_TO_QH(uhci, uhci->skelqh[skelnum]);
 121 }
 122
 123 #include "uhci-debug.c"
 124 #include "uhci-q.c"
 125 #include "uhci-hub.c"
 126
 127 /*
 128  * Finish up a host controller reset and update the recorded state.
 129  */
 130 static void finish_reset(struct uhci_hcd *uhci)
 131 {
 132         int port;
 133
 134         /* HCRESET doesn't affect the Suspend, Reset, and Resume Detect
 135          * bits in the port status and control registers.
 136          * We have to clear them by hand.
 137          */
 138         for (port = 0; port < uhci->rh_numports; ++port)
 139                 uhci_writew(uhci, 0, USBPORTSC1 + (port * 2));
 140
 141         uhci->port_c_suspend = uhci->resuming_ports = 0;
 142         uhci->rh_state = UHCI_RH_RESET;
 143         uhci->is_stopped = UHCI_IS_STOPPED;
 144         clear_bit(HCD_FLAG_POLL_RH, &uhci_to_hcd(uhci)->flags);
 145 }
 146
 147 /*
 148  * Last rites for a defunct/nonfunctional controller
 149  * or one we don't want to use any more.
 150  */
 151 static void uhci_hc_died(struct uhci_hcd *uhci)
 152 {
 153         uhci_get_current_frame_number(uhci);
 154         uhci->reset_hc(uhci);
 155         finish_reset(uhci);
 156         uhci->dead = 1;
 157
 158         /* The current frame may already be partway finished */
 159         ++uhci->frame_number;
 160 }
 161
 162 /*
 163  * Initialize a controller that was newly discovered or has lost power
 164  * or otherwise been reset while it was suspended.  In none of these cases
 165  * can we be sure of its previous state.
 166  */
 167 static void check_and_reset_hc(struct uhci_hcd *uhci)
 168 {
 169         if (uhci->check_and_reset_hc(uhci))
 170                 finish_reset(uhci);
 171 }
 172
 173 #if defined(CONFIG_USB_UHCI_SUPPORT_NON_PCI_HC)
 174 /*
 175  * The two functions below are generic reset functions that are used on systems
 176  * that do not have keyboard and mouse legacy support. We assume that we are
 177  * running on such a system if CONFIG_USB_UHCI_SUPPORT_NON_PCI_HC is defined.
 178  */
 179
 180 /*
 181  * Make sure the controller is completely inactive, unable to
 182  * generate interrupts or do DMA.
 183  */
 184 static void uhci_generic_reset_hc(struct uhci_hcd *uhci)
 185 {
 186         /* Reset the HC - this will force us to get a
 187          * new notification of any already connected
 188          * ports due to the virtual disconnect that it
 189          * implies.
 190          */
 191         uhci_writew(uhci, USBCMD_HCRESET, USBCMD);
 192         mb();
 193         udelay(5);
 194         if (uhci_readw(uhci, USBCMD) & USBCMD_HCRESET)
 195                 dev_warn(uhci_dev(uhci), "HCRESET not completed yet!\n");
 196
 197         /* Just to be safe, disable interrupt requests and
 198          * make sure the controller is stopped.
 199          */
 200         uhci_writew(uhci, 0, USBINTR);
 201         uhci_writew(uhci, 0, USBCMD);
 202 }
 203
 204 /*
 205  * Initialize a controller that was newly discovered or has just been
 206  * resumed.  In either case we can't be sure of its previous state.
 207  *
 208  * Returns: 1 if the controller was reset, 0 otherwise.
 209  */
 210 static int uhci_generic_check_and_reset_hc(struct uhci_hcd *uhci)
 211 {
 212         unsigned int cmd, intr;
 213
 214         /*
 215          * When restarting a suspended controller, we expect all the
 216          * settings to be the same as we left them:
 217          *
 218          *      Controller is stopped and configured with EGSM set;
 219          *      No interrupts enabled except possibly Resume Detect.
 220          *
 221          * If any of these conditions are violated we do a complete reset.
 222          */
 223
 224         cmd = uhci_readw(uhci, USBCMD);
 225         if ((cmd & USBCMD_RS) || !(cmd & USBCMD_CF) || !(cmd & USBCMD_EGSM)) {
 226                 dev_dbg(uhci_dev(uhci), "%s: cmd = 0x%04x\n",
 227                                 __func__, cmd);
 228                 goto reset_needed;
 229         }
 230
 231         intr = uhci_readw(uhci, USBINTR);
 232         if (intr & (~USBINTR_RESUME)) {
 233                 dev_dbg(uhci_dev(uhci), "%s: intr = 0x%04x\n",
 234                                 __func__, intr);
 235                 goto reset_needed;
 236         }
 237         return 0;
 238
 239 reset_needed:
 240         dev_dbg(uhci_dev(uhci), "Performing full reset\n");
 241         uhci_generic_reset_hc(uhci);
 242         return 1;
 243 }
 244 #endif /* CONFIG_USB_UHCI_SUPPORT_NON_PCI_HC */
 245
 246 /*
 247  * Store the basic register settings needed by the controller.
 248  */
 249 static void configure_hc(struct uhci_hcd *uhci)
 250 {
 251         /* Set the frame length to the default: 1 ms exactly */
 252         uhci_writeb(uhci, USBSOF_DEFAULT, USBSOF);
 253
 254         /* Store the frame list base address */
 255         uhci_writel(uhci, uhci->frame_dma_handle, USBFLBASEADD);
 256
 257         /* Set the current frame number */
 258         uhci_writew(uhci, uhci->frame_number & UHCI_MAX_SOF_NUMBER,
 259                         USBFRNUM);
 260
 261         /* perform any arch/bus specific configuration */
 262         if (uhci->configure_hc)
 263                 uhci->configure_hc(uhci);
 264 }
 265
 266 static int resume_detect_interrupts_are_broken(struct uhci_hcd *uhci)
 267 {
 268         /*
 269          * If we have to ignore overcurrent events then almost by definition
 270          * we can't depend on resume-detect interrupts.
 271          *
 272          * Those interrupts also don't seem to work on ASpeed SoCs.
 273          */
 274         if (ignore_oc || uhci_is_aspeed(uhci))
 275                 return 1;
 276
 277         return uhci->resume_detect_interrupts_are_broken ?
 278                 uhci->resume_detect_interrupts_are_broken(uhci) : 0;
 279 }
 280
 281 static int global_suspend_mode_is_broken(struct uhci_hcd *uhci)
 282 {
 283         return uhci->global_suspend_mode_is_broken ?
 284                 uhci->global_suspend_mode_is_broken(uhci) : 0;
 285 }
 286
 287 static void suspend_rh(struct uhci_hcd *uhci, enum uhci_rh_state new_state)
 288 __releases(uhci->lock)
 289 __acquires(uhci->lock)
 290 {
 291         int auto_stop;
 292         int int_enable, egsm_enable, wakeup_enable;
 293         struct usb_device *rhdev = uhci_to_hcd(uhci)->self.root_hub;
 294
 295         auto_stop = (new_state == UHCI_RH_AUTO_STOPPED);
 296         dev_dbg(&rhdev->dev, "%s%s\n", __func__,
 297                         (auto_stop ? " (auto-stop)" : ""));
 298
 299         /* Start off by assuming Resume-Detect interrupts and EGSM work
 300          * and that remote wakeups should be enabled.
 301          */
 302         egsm_enable = USBCMD_EGSM;
 303         int_enable = USBINTR_RESUME;
 304         wakeup_enable = 1;
 305
 306         /*
 307          * In auto-stop mode, we must be able to detect new connections.
 308          * The user can force us to poll by disabling remote wakeup;
 309          * otherwise we will use the EGSM/RD mechanism.
 310          */
 311         if (auto_stop) {
 312                 if (!device_may_wakeup(&rhdev->dev))
 313                         egsm_enable = int_enable = 0;
 314         }
 315
 316 #ifdef CONFIG_PM
 317         /*
 318          * In bus-suspend mode, we use the wakeup setting specified
 319          * for the root hub.
 320          */
 321         else {
 322                 if (!rhdev->do_remote_wakeup)
 323                         wakeup_enable = 0;
 324         }
 325 #endif
 326
 327         /*
 328          * UHCI doesn't distinguish between wakeup requests from downstream
 329          * devices and local connect/disconnect events.  There's no way to
 330          * enable one without the other; both are controlled by EGSM.  Thus
 331          * if wakeups are disallowed then EGSM must be turned off -- in which
 332          * case remote wakeup requests from downstream during system sleep
 333          * will be lost.
 334          *
 335          * In addition, if EGSM is broken then we can't use it.  Likewise,
 336          * if Resume-Detect interrupts are broken then we can't use them.
 337          *
 338          * Finally, neither EGSM nor RD is useful by itself.  Without EGSM,
 339          * the RD status bit will never get set.  Without RD, the controller
 340          * won't generate interrupts to tell the system about wakeup events.
 341          */
 342         if (!wakeup_enable || global_suspend_mode_is_broken(uhci) ||
 343                         resume_detect_interrupts_are_broken(uhci))
 344                 egsm_enable = int_enable = 0;
 345
 346         uhci->RD_enable = !!int_enable;
 347         uhci_writew(uhci, int_enable, USBINTR);
 348         uhci_writew(uhci, egsm_enable | USBCMD_CF, USBCMD);
 349         mb();
 350         udelay(5);
 351
 352         /* If we're auto-stopping then no devices have been attached
 353          * for a while, so there shouldn't be any active URBs and the
 354          * controller should stop after a few microseconds.  Otherwise
 355          * we will give the controller one frame to stop.
 356          */
 357         if (!auto_stop && !(uhci_readw(uhci, USBSTS) & USBSTS_HCH)) {
 358                 uhci->rh_state = UHCI_RH_SUSPENDING;
 359                 spin_unlock_irq(&uhci->lock);
 360                 msleep(1);
 361                 spin_lock_irq(&uhci->lock);
 362                 if (uhci->dead)
 363                         return;
 364         }
 365         if (!(uhci_readw(uhci, USBSTS) & USBSTS_HCH))
 366                 dev_warn(uhci_dev(uhci), "Controller not stopped yet!\n");
 367
 368         uhci_get_current_frame_number(uhci);
 369
 370         uhci->rh_state = new_state;
 371         uhci->is_stopped = UHCI_IS_STOPPED;
 372
 373         /*
 374          * If remote wakeup is enabled but either EGSM or RD interrupts
 375          * doesn't work, then we won't get an interrupt when a wakeup event
 376          * occurs.  Thus the suspended root hub needs to be polled.
 377          */
 378         if (wakeup_enable && (!int_enable || !egsm_enable))
 379                 set_bit(HCD_FLAG_POLL_RH, &uhci_to_hcd(uhci)->flags);
 380         else
 381                 clear_bit(HCD_FLAG_POLL_RH, &uhci_to_hcd(uhci)->flags);
 382
 383         uhci_scan_schedule(uhci);
 384         uhci_fsbr_off(uhci);
 385 }
 386
 387 static void start_rh(struct uhci_hcd *uhci)
 388 {
 389         uhci->is_stopped = 0;
 390
 391         /*
 392          * Clear stale status bits on Aspeed as we get a stale HCH
 393          * which causes problems later on
 394          */
 395         if (uhci_is_aspeed(uhci))
 396                 uhci_writew(uhci, uhci_readw(uhci, USBSTS), USBSTS);
 397
 398         /* Mark it configured and running with a 64-byte max packet.
 399          * All interrupts are enabled, even though RESUME won't do anything.
 400          */
 401         uhci_writew(uhci, USBCMD_RS | USBCMD_CF | USBCMD_MAXP, USBCMD);
 402         uhci_writew(uhci, USBINTR_TIMEOUT | USBINTR_RESUME |
 403                 USBINTR_IOC | USBINTR_SP, USBINTR);
 404         mb();
 405         uhci->rh_state = UHCI_RH_RUNNING;
 406         set_bit(HCD_FLAG_POLL_RH, &uhci_to_hcd(uhci)->flags);
 407 }
 408
 409 static void wakeup_rh(struct uhci_hcd *uhci)
 410 __releases(uhci->lock)
 411 __acquires(uhci->lock)
 412 {
 413         dev_dbg(&uhci_to_hcd(uhci)->self.root_hub->dev,
 414                         "%s%s\n", __func__,
 415                         uhci->rh_state == UHCI_RH_AUTO_STOPPED ?
 416                                 " (auto-start)" : "");
 417
 418         /* If we are auto-stopped then no devices are attached so there's
 419          * no need for wakeup signals.  Otherwise we send Global Resume
 420          * for 20 ms.
 421          */
 422         if (uhci->rh_state == UHCI_RH_SUSPENDED) {
 423                 unsigned egsm;
 424
 425                 /* Keep EGSM on if it was set before */
 426                 egsm = uhci_readw(uhci, USBCMD) & USBCMD_EGSM;
 427                 uhci->rh_state = UHCI_RH_RESUMING;
 428                 uhci_writew(uhci, USBCMD_FGR | USBCMD_CF | egsm, USBCMD);
 429                 spin_unlock_irq(&uhci->lock);
 430                 msleep(20);
 431                 spin_lock_irq(&uhci->lock);
 432                 if (uhci->dead)
 433                         return;
 434
 435                 /* End Global Resume and wait for EOP to be sent */
 436                 uhci_writew(uhci, USBCMD_CF, USBCMD);
 437                 mb();
 438                 udelay(4);
 439                 if (uhci_readw(uhci, USBCMD) & USBCMD_FGR)
 440                         dev_warn(uhci_dev(uhci), "FGR not stopped yet!\n");
 441         }
 442
 443         start_rh(uhci);
 444
 445         /* Restart root hub polling */
 446         mod_timer(&uhci_to_hcd(uhci)->rh_timer, jiffies);
 447 }
 448
 449 static irqreturn_t uhci_irq(struct usb_hcd *hcd)
 450 {
 451         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
 452         unsigned short status;
 453
 454         /*
 455          * Read the interrupt status, and write it back to clear the
 456          * interrupt cause.  Contrary to the UHCI specification, the
 457          * "HC Halted" status bit is persistent: it is RO, not R/WC.
 458          */
 459         status = uhci_readw(uhci, USBSTS);
 460         if (!(status & ~USBSTS_HCH))    /* shared interrupt, not mine */
 461                 return IRQ_NONE;
 462         uhci_writew(uhci, status, USBSTS);              /* Clear it */
 463
 464         spin_lock(&uhci->lock);
 465         if (unlikely(!uhci->is_initialized))    /* not yet configured */
 466                 goto done;
 467
 468         if (status & ~(USBSTS_USBINT | USBSTS_ERROR | USBSTS_RD)) {
 469                 if (status & USBSTS_HSE)
 470                         dev_err(uhci_dev(uhci),
 471                                 "host system error, PCI problems?\n");
 472                 if (status & USBSTS_HCPE)
 473                         dev_err(uhci_dev(uhci),
 474                                 "host controller process error, something bad happened!\n");
 475                 if (status & USBSTS_HCH) {
 476                         if (uhci->rh_state >= UHCI_RH_RUNNING) {
 477                                 dev_err(uhci_dev(uhci),
 478                                         "host controller halted, very bad!\n");
 479                                 if (debug > 1 && errbuf) {
 480                                         /* Print the schedule for debugging */
 481                                         uhci_sprint_schedule(uhci, errbuf,
 482                                                 ERRBUF_LEN - EXTRA_SPACE);
 483                                         lprintk(errbuf);
 484                                 }
 485                                 uhci_hc_died(uhci);
 486                                 usb_hc_died(hcd);
 487
 488                                 /* Force a callback in case there are
 489                                  * pending unlinks */
 490                                 mod_timer(&hcd->rh_timer, jiffies);
 491                         }
 492                 }
 493         }
 494
 495         if (status & USBSTS_RD) {
 496                 spin_unlock(&uhci->lock);
 497                 usb_hcd_poll_rh_status(hcd);
 498         } else {
 499                 uhci_scan_schedule(uhci);
 500  done:
 501                 spin_unlock(&uhci->lock);
 502         }
 503
 504         return IRQ_HANDLED;
 505 }
 506
 507 /*
 508  * Store the current frame number in uhci->frame_number if the controller
 509  * is running.  Expand from 11 bits (of which we use only 10) to a
 510  * full-sized integer.
 511  *
 512  * Like many other parts of the driver, this code relies on being polled
 513  * more than once per second as long as the controller is running.
 514  */
 515 static void uhci_get_current_frame_number(struct uhci_hcd *uhci)
 516 {
 517         if (!uhci->is_stopped) {
 518                 unsigned delta;
 519
 520                 delta = (uhci_readw(uhci, USBFRNUM) - uhci->frame_number) &
 521                                 (UHCI_NUMFRAMES - 1);
 522                 uhci->frame_number += delta;
 523         }
 524 }
 525
 526 /*
 527  * De-allocate all resources
 528  */
 529 static void release_uhci(struct uhci_hcd *uhci)
 530 {
 531         int i;
 532
 533
 534         spin_lock_irq(&uhci->lock);
 535         uhci->is_initialized = 0;
 536         spin_unlock_irq(&uhci->lock);
 537
 538         debugfs_remove(uhci->dentry);
 539
 540         for (i = 0; i < UHCI_NUM_SKELQH; i++)
 541                 uhci_free_qh(uhci, uhci->skelqh[i]);
 542
 543         uhci_free_td(uhci, uhci->term_td);
 544
 545         dma_pool_destroy(uhci->qh_pool);
 546
 547         dma_pool_destroy(uhci->td_pool);
 548
 549         kfree(uhci->frame_cpu);
 550
 551         dma_free_coherent(uhci_dev(uhci),
 552                         UHCI_NUMFRAMES * sizeof(*uhci->frame),
 553                         uhci->frame, uhci->frame_dma_handle);
 554 }
 555
 556 /*
 557  * Allocate a frame list, and then setup the skeleton
 558  *
 559  * The hardware doesn't really know any difference
 560  * in the queues, but the order does matter for the
 561  * protocols higher up.  The order in which the queues
 562  * are encountered by the hardware is:
 563  *
 564  *  - All isochronous events are handled before any
 565  *    of the queues. We don't do that here, because
 566  *    we'll create the actual TD entries on demand.
 567  *  - The first queue is the high-period interrupt queue.
 568  *  - The second queue is the period-1 interrupt and async
 569  *    (low-speed control, full-speed control, then bulk) queue.
 570  *  - The third queue is the terminating bandwidth reclamation queue,
 571  *    which contains no members, loops back to itself, and is present
 572  *    only when FSBR is on and there are no full-speed control or bulk QHs.
 573  */
 574 static int uhci_start(struct usb_hcd *hcd)
 575 {
 576         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
 577         int retval = -EBUSY;
 578         int i;
 579         struct dentry __maybe_unused *dentry;
 580
 581         hcd->uses_new_polling = 1;
 582         /* Accept arbitrarily long scatter-gather lists */
 583         if (!(hcd->driver->flags & HCD_LOCAL_MEM))
 584                 hcd->self.sg_tablesize = ~0;
 585
 586         spin_lock_init(&uhci->lock);
 587         setup_timer(&uhci->fsbr_timer, uhci_fsbr_timeout,
 588                         (unsigned long) uhci);
 589         INIT_LIST_HEAD(&uhci->idle_qh_list);
 590         init_waitqueue_head(&uhci->waitqh);
 591
 592 #ifdef UHCI_DEBUG_OPS
 593         dentry = debugfs_create_file(hcd->self.bus_name,
 594                         S_IFREG|S_IRUGO|S_IWUSR, uhci_debugfs_root,
 595                         uhci, &uhci_debug_operations);
 596         if (!dentry) {
 597                 dev_err(uhci_dev(uhci), "couldn't create uhci debugfs entry\n");
 598                 return -ENOMEM;
 599         }
 600         uhci->dentry = dentry;
 601 #endif
 602
 603         uhci->frame = dma_alloc_coherent(uhci_dev(uhci),
 604                         UHCI_NUMFRAMES * sizeof(*uhci->frame),
 605                         &uhci->frame_dma_handle, GFP_KERNEL);
 606         if (!uhci->frame) {
 607                 dev_err(uhci_dev(uhci),
 608                         "unable to allocate consistent memory for frame list\n");
 609                 goto err_alloc_frame;
 610         }
 611         memset(uhci->frame, 0, UHCI_NUMFRAMES * sizeof(*uhci->frame));
 612
 613         uhci->frame_cpu = kcalloc(UHCI_NUMFRAMES, sizeof(*uhci->frame_cpu),
 614                         GFP_KERNEL);
 615         if (!uhci->frame_cpu)
 616                 goto err_alloc_frame_cpu;
 617
 618         uhci->td_pool = dma_pool_create("uhci_td", uhci_dev(uhci),
 619                         sizeof(struct uhci_td), 16, 0);
 620         if (!uhci->td_pool) {
 621                 dev_err(uhci_dev(uhci), "unable to create td dma_pool\n");
 622                 goto err_create_td_pool;
 623         }
 624
 625         uhci->qh_pool = dma_pool_create("uhci_qh", uhci_dev(uhci),
 626                         sizeof(struct uhci_qh), 16, 0);
 627         if (!uhci->qh_pool) {
 628                 dev_err(uhci_dev(uhci), "unable to create qh dma_pool\n");
 629                 goto err_create_qh_pool;
 630         }
 631
 632         uhci->term_td = uhci_alloc_td(uhci);
 633         if (!uhci->term_td) {
 634                 dev_err(uhci_dev(uhci), "unable to allocate terminating TD\n");
 635                 goto err_alloc_term_td;
 636         }
 637
 638         for (i = 0; i < UHCI_NUM_SKELQH; i++) {
 639                 uhci->skelqh[i] = uhci_alloc_qh(uhci, NULL, NULL);
 640                 if (!uhci->skelqh[i]) {
 641                         dev_err(uhci_dev(uhci), "unable to allocate QH\n");
 642                         goto err_alloc_skelqh;
 643                 }
 644         }
 645
 646         /*
 647          * 8 Interrupt queues; link all higher int queues to int1 = async
 648          */
 649         for (i = SKEL_ISO + 1; i < SKEL_ASYNC; ++i)
 650                 uhci->skelqh[i]->link = LINK_TO_QH(uhci, uhci->skel_async_qh);
 651         uhci->skel_async_qh->link = UHCI_PTR_TERM(uhci);
 652         uhci->skel_term_qh->link = LINK_TO_QH(uhci, uhci->skel_term_qh);
 653
 654         /* This dummy TD is to work around a bug in Intel PIIX controllers */
 655         uhci_fill_td(uhci, uhci->term_td, 0, uhci_explen(0) |
 656                         (0x7f << TD_TOKEN_DEVADDR_SHIFT) | USB_PID_IN, 0);
 657         uhci->term_td->link = UHCI_PTR_TERM(uhci);
 658         uhci->skel_async_qh->element = uhci->skel_term_qh->element =
 659                 LINK_TO_TD(uhci, uhci->term_td);
 660
 661         /*
 662          * Fill the frame list: make all entries point to the proper
 663          * interrupt queue.
 664          */
 665         for (i = 0; i < UHCI_NUMFRAMES; i++) {
 666
 667                 /* Only place we don't use the frame list routines */
 668                 uhci->frame[i] = uhci_frame_skel_link(uhci, i);
 669         }
 670
 671         /*
 672          * Some architectures require a full mb() to enforce completion of
 673          * the memory writes above before the I/O transfers in configure_hc().
 674          */
 675         mb();
 676
 677         spin_lock_irq(&uhci->lock);
 678         configure_hc(uhci);
 679         uhci->is_initialized = 1;
 680         start_rh(uhci);
 681         spin_unlock_irq(&uhci->lock);
 682         return 0;
 683
 684 /*
 685  * error exits:
 686  */
 687 err_alloc_skelqh:
 688         for (i = 0; i < UHCI_NUM_SKELQH; i++) {
 689                 if (uhci->skelqh[i])
 690                         uhci_free_qh(uhci, uhci->skelqh[i]);
 691         }
 692
 693         uhci_free_td(uhci, uhci->term_td);
 694
 695 err_alloc_term_td:
 696         dma_pool_destroy(uhci->qh_pool);
 697
 698 err_create_qh_pool:
 699         dma_pool_destroy(uhci->td_pool);
 700
 701 err_create_td_pool:
 702         kfree(uhci->frame_cpu);
 703
 704 err_alloc_frame_cpu:
 705         dma_free_coherent(uhci_dev(uhci),
 706                         UHCI_NUMFRAMES * sizeof(*uhci->frame),
 707                         uhci->frame, uhci->frame_dma_handle);
 708
 709 err_alloc_frame:
 710         debugfs_remove(uhci->dentry);
 711
 712         return retval;
 713 }
 714
 715 static void uhci_stop(struct usb_hcd *hcd)
 716 {
 717         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
 718
 719         spin_lock_irq(&uhci->lock);
 720         if (HCD_HW_ACCESSIBLE(hcd) && !uhci->dead)
 721                 uhci_hc_died(uhci);
 722         uhci_scan_schedule(uhci);
 723         spin_unlock_irq(&uhci->lock);
 724         synchronize_irq(hcd->irq);
 725
 726         del_timer_sync(&uhci->fsbr_timer);
 727         release_uhci(uhci);
 728 }
 729
 730 #ifdef CONFIG_PM
 731 static int uhci_rh_suspend(struct usb_hcd *hcd)
 732 {
 733         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
 734         int rc = 0;
 735
 736         spin_lock_irq(&uhci->lock);
 737         if (!HCD_HW_ACCESSIBLE(hcd))
 738                 rc = -ESHUTDOWN;
 739         else if (uhci->dead)
 740                 ;               /* Dead controllers tell no tales */
 741
 742         /* Once the controller is stopped, port resumes that are already
 743          * in progress won't complete.  Hence if remote wakeup is enabled
 744          * for the root hub and any ports are in the middle of a resume or
 745          * remote wakeup, we must fail the suspend.
 746          */
 747         else if (hcd->self.root_hub->do_remote_wakeup &&
 748                         uhci->resuming_ports) {
 749                 dev_dbg(uhci_dev(uhci),
 750                         "suspend failed because a port is resuming\n");
 751                 rc = -EBUSY;
 752         } else
 753                 suspend_rh(uhci, UHCI_RH_SUSPENDED);
 754         spin_unlock_irq(&uhci->lock);
 755         return rc;
 756 }
 757
 758 static int uhci_rh_resume(struct usb_hcd *hcd)
 759 {
 760         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
 761         int rc = 0;
 762
 763         spin_lock_irq(&uhci->lock);
 764         if (!HCD_HW_ACCESSIBLE(hcd))
 765                 rc = -ESHUTDOWN;
 766         else if (!uhci->dead)
 767                 wakeup_rh(uhci);
 768         spin_unlock_irq(&uhci->lock);
 769         return rc;
 770 }
 771
 772 #endif
 773
 774 /* Wait until a particular device/endpoint's QH is idle, and free it */
 775 static void uhci_hcd_endpoint_disable(struct usb_hcd *hcd,
 776                 struct usb_host_endpoint *hep)
 777 {
 778         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
 779         struct uhci_qh *qh;
 780
 781         spin_lock_irq(&uhci->lock);
 782         qh = (struct uhci_qh *) hep->hcpriv;
 783         if (qh == NULL)
 784                 goto done;
 785
 786         while (qh->state != QH_STATE_IDLE) {
 787                 ++uhci->num_waiting;
 788                 spin_unlock_irq(&uhci->lock);
 789                 wait_event_interruptible(uhci->waitqh,
 790                                 qh->state == QH_STATE_IDLE);
 791                 spin_lock_irq(&uhci->lock);
 792                 --uhci->num_waiting;
 793         }
 794
 795         uhci_free_qh(uhci, qh);
 796 done:
 797         spin_unlock_irq(&uhci->lock);
 798 }
 799
 800 static int uhci_hcd_get_frame_number(struct usb_hcd *hcd)
 801 {
 802         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
 803         unsigned frame_number;
 804         unsigned delta;
 805
 806         /* Minimize latency by avoiding the spinlock */
 807         frame_number = uhci->frame_number;
 808         barrier();
 809         delta = (uhci_readw(uhci, USBFRNUM) - frame_number) &
 810                         (UHCI_NUMFRAMES - 1);
 811         return frame_number + delta;
 812 }
 813
 814 /* Determines number of ports on controller */
 815 static int uhci_count_ports(struct usb_hcd *hcd)
 816 {
 817         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
 818         unsigned io_size = (unsigned) hcd->rsrc_len;
 819         int port;
 820
 821         /* The UHCI spec says devices must have 2 ports, and goes on to say
 822          * they may have more but gives no way to determine how many there
 823          * are.  However according to the UHCI spec, Bit 7 of the port
 824          * status and control register is always set to 1.  So we try to
 825          * use this to our advantage.  Another common failure mode when
 826          * a nonexistent register is addressed is to return all ones, so
 827          * we test for that also.
 828          */
 829         for (port = 0; port < (io_size - USBPORTSC1) / 2; port++) {
 830                 unsigned int portstatus;
 831
 832                 portstatus = uhci_readw(uhci, USBPORTSC1 + (port * 2));
 833                 if (!(portstatus & 0x0080) || portstatus == 0xffff)
 834                         break;
 835         }
 836         if (debug)
 837                 dev_info(uhci_dev(uhci), "detected %d ports\n", port);
 838
 839         /* Anything greater than 7 is weird so we'll ignore it. */
 840         if (port > UHCI_RH_MAXCHILD) {
 841                 dev_info(uhci_dev(uhci),
 842                         "port count misdetected? forcing to 2 ports\n");
 843                 port = 2;
 844         }
 845
 846         return port;
 847 }
 848
 849 static const char hcd_name[] = "uhci_hcd";
 850
 851 #ifdef CONFIG_USB_PCI
 852 #include "uhci-pci.c"
 853 #define PCI_DRIVER              uhci_pci_driver
 854 #endif
 855
 856 #ifdef CONFIG_SPARC_LEON
 857 #include "uhci-grlib.c"
 858 #define PLATFORM_DRIVER         uhci_grlib_driver
 859 #endif
 860
 861 #ifdef CONFIG_USB_UHCI_PLATFORM
 862 #include "uhci-platform.c"
 863 #define PLATFORM_DRIVER         uhci_platform_driver
 864 #endif
 865
 866 #if !defined(PCI_DRIVER) && !defined(PLATFORM_DRIVER)
 867 #error "missing bus glue for uhci-hcd"
 868 #endif
 869
 870 static int __init uhci_hcd_init(void)
 871 {
 872         int retval = -ENOMEM;
 873
 874         if (usb_disabled())
 875                 return -ENODEV;
 876
 877         printk(KERN_INFO "uhci_hcd: " DRIVER_DESC "%s\n",
 878                         ignore_oc ? ", overcurrent ignored" : "");
 879         set_bit(USB_UHCI_LOADED, &usb_hcds_loaded);
 880
 881 #ifdef CONFIG_DYNAMIC_DEBUG
 882         errbuf = kmalloc(ERRBUF_LEN, GFP_KERNEL);
 883         if (!errbuf)
 884                 goto errbuf_failed;
 885         uhci_debugfs_root = debugfs_create_dir("uhci", usb_debug_root);
 886         if (!uhci_debugfs_root)
 887                 goto debug_failed;
 888 #endif
 889
 890         uhci_up_cachep = kmem_cache_create("uhci_urb_priv",
 891                 sizeof(struct urb_priv), 0, 0, NULL);
 892         if (!uhci_up_cachep)
 893                 goto up_failed;
 894
 895 #ifdef PLATFORM_DRIVER
 896         retval = platform_driver_register(&PLATFORM_DRIVER);
 897         if (retval < 0)
 898                 goto clean0;
 899 #endif
 900
 901 #ifdef PCI_DRIVER
 902         retval = pci_register_driver(&PCI_DRIVER);
 903         if (retval < 0)
 904                 goto clean1;
 905 #endif
 906
 907         return 0;
 908
 909 #ifdef PCI_DRIVER
 910 clean1:
 911 #endif
 912 #ifdef PLATFORM_DRIVER
 913         platform_driver_unregister(&PLATFORM_DRIVER);
 914 clean0:
 915 #endif
 916         kmem_cache_destroy(uhci_up_cachep);
 917
 918 up_failed:
 919 #if defined(DEBUG) || defined(CONFIG_DYNAMIC_DEBUG)
 920         debugfs_remove(uhci_debugfs_root);
 921
 922 debug_failed:
 923         kfree(errbuf);
 924
 925 errbuf_failed:
 926 #endif
 927
 928         clear_bit(USB_UHCI_LOADED, &usb_hcds_loaded);
 929         return retval;
 930 }
 931
 932 static void __exit uhci_hcd_cleanup(void)
 933 {
 934 #ifdef PLATFORM_DRIVER
 935         platform_driver_unregister(&PLATFORM_DRIVER);
 936 #endif
 937 #ifdef PCI_DRIVER
 938         pci_unregister_driver(&PCI_DRIVER);
 939 #endif
 940         kmem_cache_destroy(uhci_up_cachep);
 941         debugfs_remove(uhci_debugfs_root);
 942 #ifdef CONFIG_DYNAMIC_DEBUG
 943         kfree(errbuf);
 944 #endif
 945         clear_bit(USB_UHCI_LOADED, &usb_hcds_loaded);
 946 }
 947
 948 module_init(uhci_hcd_init);
 949 module_exit(uhci_hcd_cleanup);
 950
 951 MODULE_AUTHOR(DRIVER_AUTHOR);
 952 MODULE_DESCRIPTION(DRIVER_DESC);
 953 MODULE_LICENSE("GPL");