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