drivers/usb/core/hcd-pci.c

   1 /*
   2  * (C) Copyright David Brownell 2000-2002
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU General Public License as published by the
   6  * Free Software Foundation; either version 2 of the License, or (at your
   7  * option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  11  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software Foundation,
  16  * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17  */
  18
  19 #include <linux/kernel.h>
  20 #include <linux/module.h>
  21 #include <linux/pci.h>
  22 #include <linux/usb.h>
  23 #include <linux/usb/hcd.h>
  24
  25 #include <asm/io.h>
  26 #include <asm/irq.h>
  27
  28 #ifdef CONFIG_PPC_PMAC
  29 #include <asm/machdep.h>
  30 #include <asm/pmac_feature.h>
  31 #include <asm/pci-bridge.h>
  32 #include <asm/prom.h>
  33 #endif
  34
  35 #include "usb.h"
  36
  37
  38 /* PCI-based HCs are common, but plenty of non-PCI HCs are used too */
  39
  40 #ifdef CONFIG_PM_SLEEP
  41
  42 /* Coordinate handoffs between EHCI and companion controllers
  43  * during system resume
  44  */
  45
  46 static DEFINE_MUTEX(companions_mutex);
  47
  48 #define CL_UHCI         PCI_CLASS_SERIAL_USB_UHCI
  49 #define CL_OHCI         PCI_CLASS_SERIAL_USB_OHCI
  50 #define CL_EHCI         PCI_CLASS_SERIAL_USB_EHCI
  51
  52 enum companion_action {
  53         SET_HS_COMPANION, CLEAR_HS_COMPANION, WAIT_FOR_COMPANIONS
  54 };
  55
  56 static void companion_common(struct pci_dev *pdev, struct usb_hcd *hcd,
  57                 enum companion_action action)
  58 {
  59         struct pci_dev          *companion;
  60         struct usb_hcd          *companion_hcd;
  61         unsigned int            slot = PCI_SLOT(pdev->devfn);
  62
  63         /* Iterate through other PCI functions in the same slot.
  64          * If pdev is OHCI or UHCI then we are looking for EHCI, and
  65          * vice versa.
  66          */
  67         companion = NULL;
  68         for_each_pci_dev(companion) {
  69                 if (companion->bus != pdev->bus ||
  70                                 PCI_SLOT(companion->devfn) != slot)
  71                         continue;
  72
  73                 /*
  74                  * Companion device should be either UHCI,OHCI or EHCI host
  75                  * controller, otherwise skip.
  76                  */
  77                 if (companion->class != CL_UHCI && companion->class != CL_OHCI &&
  78                                 companion->class != CL_EHCI)
  79                         continue;
  80
  81                 companion_hcd = pci_get_drvdata(companion);
  82                 if (!companion_hcd)
  83                         continue;
  84
  85                 /* For SET_HS_COMPANION, store a pointer to the EHCI bus in
  86                  * the OHCI/UHCI companion bus structure.
  87                  * For CLEAR_HS_COMPANION, clear the pointer to the EHCI bus
  88                  * in the OHCI/UHCI companion bus structure.
  89                  * For WAIT_FOR_COMPANIONS, wait until the OHCI/UHCI
  90                  * companion controllers have fully resumed.
  91                  */
  92
  93                 if ((pdev->class == CL_OHCI || pdev->class == CL_UHCI) &&
  94                                 companion->class == CL_EHCI) {
  95                         /* action must be SET_HS_COMPANION */
  96                         dev_dbg(&companion->dev, "HS companion for %s\n",
  97                                         dev_name(&pdev->dev));
  98                         hcd->self.hs_companion = &companion_hcd->self;
  99
 100                 } else if (pdev->class == CL_EHCI &&
 101                                 (companion->class == CL_OHCI ||
 102                                 companion->class == CL_UHCI)) {
 103                         switch (action) {
 104                         case SET_HS_COMPANION:
 105                                 dev_dbg(&pdev->dev, "HS companion for %s\n",
 106                                                 dev_name(&companion->dev));
 107                                 companion_hcd->self.hs_companion = &hcd->self;
 108                                 break;
 109                         case CLEAR_HS_COMPANION:
 110                                 companion_hcd->self.hs_companion = NULL;
 111                                 break;
 112                         case WAIT_FOR_COMPANIONS:
 113                                 device_pm_wait_for_dev(&pdev->dev,
 114                                                 &companion->dev);
 115                                 break;
 116                         }
 117                 }
 118         }
 119 }
 120
 121 static void set_hs_companion(struct pci_dev *pdev, struct usb_hcd *hcd)
 122 {
 123         mutex_lock(&companions_mutex);
 124         dev_set_drvdata(&pdev->dev, hcd);
 125         companion_common(pdev, hcd, SET_HS_COMPANION);
 126         mutex_unlock(&companions_mutex);
 127 }
 128
 129 static void clear_hs_companion(struct pci_dev *pdev, struct usb_hcd *hcd)
 130 {
 131         mutex_lock(&companions_mutex);
 132         dev_set_drvdata(&pdev->dev, NULL);
 133
 134         /* If pdev is OHCI or UHCI, just clear its hs_companion pointer */
 135         if (pdev->class == CL_OHCI || pdev->class == CL_UHCI)
 136                 hcd->self.hs_companion = NULL;
 137
 138         /* Otherwise search for companion buses and clear their pointers */
 139         else
 140                 companion_common(pdev, hcd, CLEAR_HS_COMPANION);
 141         mutex_unlock(&companions_mutex);
 142 }
 143
 144 static void wait_for_companions(struct pci_dev *pdev, struct usb_hcd *hcd)
 145 {
 146         /* Only EHCI controllers need to wait.
 147          * No locking is needed because a controller cannot be resumed
 148          * while one of its companions is getting unbound.
 149          */
 150         if (pdev->class == CL_EHCI)
 151                 companion_common(pdev, hcd, WAIT_FOR_COMPANIONS);
 152 }
 153
 154 #else /* !CONFIG_PM_SLEEP */
 155
 156 static inline void set_hs_companion(struct pci_dev *d, struct usb_hcd *h) {}
 157 static inline void clear_hs_companion(struct pci_dev *d, struct usb_hcd *h) {}
 158 static inline void wait_for_companions(struct pci_dev *d, struct usb_hcd *h) {}
 159
 160 #endif /* !CONFIG_PM_SLEEP */
 161
 162 /*-------------------------------------------------------------------------*/
 163
 164 /* configure so an HC device and id are always provided */
 165 /* always called with process context; sleeping is OK */
 166
 167 /**
 168  * usb_hcd_pci_probe - initialize PCI-based HCDs
 169  * @dev: USB Host Controller being probed
 170  * @id: pci hotplug id connecting controller to HCD framework
 171  * Context: !in_interrupt()
 172  *
 173  * Allocates basic PCI resources for this USB host controller, and
 174  * then invokes the start() method for the HCD associated with it
 175  * through the hotplug entry's driver_data.
 176  *
 177  * Store this function in the HCD's struct pci_driver as probe().
 178  */
 179 int usb_hcd_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
 180 {
 181         struct hc_driver        *driver;
 182         struct usb_hcd          *hcd;
 183         int                     retval;
 184         int                     hcd_irq = 0;
 185
 186         if (usb_disabled())
 187                 return -ENODEV;
 188
 189         if (!id)
 190                 return -EINVAL;
 191         driver = (struct hc_driver *)id->driver_data;
 192         if (!driver)
 193                 return -EINVAL;
 194
 195         if (pci_enable_device(dev) < 0)
 196                 return -ENODEV;
 197         dev->current_state = PCI_D0;
 198
 199         /*
 200          * The xHCI driver has its own irq management
 201          * make sure irq setup is not touched for xhci in generic hcd code
 202          */
 203         if ((driver->flags & HCD_MASK) != HCD_USB3) {
 204                 if (!dev->irq) {
 205                         dev_err(&dev->dev,
 206                         "Found HC with no IRQ. Check BIOS/PCI %s setup!\n",
 207                                 pci_name(dev));
 208                         retval = -ENODEV;
 209                         goto disable_pci;
 210                 }
 211                 hcd_irq = dev->irq;
 212         }
 213
 214         hcd = usb_create_hcd(driver, &dev->dev, pci_name(dev));
 215         if (!hcd) {
 216                 retval = -ENOMEM;
 217                 goto disable_pci;
 218         }
 219
 220         if (driver->flags & HCD_MEMORY) {
 221                 /* EHCI, OHCI */
 222                 hcd->rsrc_start = pci_resource_start(dev, 0);
 223                 hcd->rsrc_len = pci_resource_len(dev, 0);
 224                 if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len,
 225                                 driver->description)) {
 226                         dev_dbg(&dev->dev, "controller already in use\n");
 227                         retval = -EBUSY;
 228                         goto clear_companion;
 229                 }
 230                 hcd->regs = ioremap_nocache(hcd->rsrc_start, hcd->rsrc_len);
 231                 if (hcd->regs == NULL) {
 232                         dev_dbg(&dev->dev, "error mapping memory\n");
 233                         retval = -EFAULT;
 234                         goto release_mem_region;
 235                 }
 236
 237         } else {
 238                 /* UHCI */
 239                 int     region;
 240
 241                 for (region = 0; region < PCI_ROM_RESOURCE; region++) {
 242                         if (!(pci_resource_flags(dev, region) &
 243                                         IORESOURCE_IO))
 244                                 continue;
 245
 246                         hcd->rsrc_start = pci_resource_start(dev, region);
 247                         hcd->rsrc_len = pci_resource_len(dev, region);
 248                         if (request_region(hcd->rsrc_start, hcd->rsrc_len,
 249                                         driver->description))
 250                                 break;
 251                 }
 252                 if (region == PCI_ROM_RESOURCE) {
 253                         dev_dbg(&dev->dev, "no i/o regions available\n");
 254                         retval = -EBUSY;
 255                         goto clear_companion;
 256                 }
 257         }
 258
 259         pci_set_master(dev);
 260
 261         retval = usb_add_hcd(hcd, hcd_irq, IRQF_SHARED);
 262         if (retval != 0)
 263                 goto unmap_registers;
 264         set_hs_companion(dev, hcd);
 265
 266         if (pci_dev_run_wake(dev))
 267                 pm_runtime_put_noidle(&dev->dev);
 268         return retval;
 269
 270 unmap_registers:
 271         if (driver->flags & HCD_MEMORY) {
 272                 iounmap(hcd->regs);
 273 release_mem_region:
 274                 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
 275         } else
 276                 release_region(hcd->rsrc_start, hcd->rsrc_len);
 277 clear_companion:
 278         clear_hs_companion(dev, hcd);
 279         usb_put_hcd(hcd);
 280 disable_pci:
 281         pci_disable_device(dev);
 282         dev_err(&dev->dev, "init %s fail, %d\n", pci_name(dev), retval);
 283         return retval;
 284 }
 285 EXPORT_SYMBOL_GPL(usb_hcd_pci_probe);
 286
 287
 288 /* may be called without controller electrically present */
 289 /* may be called with controller, bus, and devices active */
 290
 291 /**
 292  * usb_hcd_pci_remove - shutdown processing for PCI-based HCDs
 293  * @dev: USB Host Controller being removed
 294  * Context: !in_interrupt()
 295  *
 296  * Reverses the effect of usb_hcd_pci_probe(), first invoking
 297  * the HCD's stop() method.  It is always called from a thread
 298  * context, normally "rmmod", "apmd", or something similar.
 299  *
 300  * Store this function in the HCD's struct pci_driver as remove().
 301  */
 302 void usb_hcd_pci_remove(struct pci_dev *dev)
 303 {
 304         struct usb_hcd          *hcd;
 305
 306         hcd = pci_get_drvdata(dev);
 307         if (!hcd)
 308                 return;
 309
 310         if (pci_dev_run_wake(dev))
 311                 pm_runtime_get_noresume(&dev->dev);
 312
 313         /* Fake an interrupt request in order to give the driver a chance
 314          * to test whether the controller hardware has been removed (e.g.,
 315          * cardbus physical eject).
 316          */
 317         local_irq_disable();
 318         usb_hcd_irq(0, hcd);
 319         local_irq_enable();
 320
 321         usb_remove_hcd(hcd);
 322         if (hcd->driver->flags & HCD_MEMORY) {
 323                 iounmap(hcd->regs);
 324                 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
 325         } else {
 326                 release_region(hcd->rsrc_start, hcd->rsrc_len);
 327         }
 328         clear_hs_companion(dev, hcd);
 329         usb_put_hcd(hcd);
 330         pci_disable_device(dev);
 331 }
 332 EXPORT_SYMBOL_GPL(usb_hcd_pci_remove);
 333
 334 /**
 335  * usb_hcd_pci_shutdown - shutdown host controller
 336  * @dev: USB Host Controller being shutdown
 337  */
 338 void usb_hcd_pci_shutdown(struct pci_dev *dev)
 339 {
 340         struct usb_hcd          *hcd;
 341
 342         hcd = pci_get_drvdata(dev);
 343         if (!hcd)
 344                 return;
 345
 346         if (test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags) &&
 347                         hcd->driver->shutdown) {
 348                 hcd->driver->shutdown(hcd);
 349                 pci_disable_device(dev);
 350         }
 351 }
 352 EXPORT_SYMBOL_GPL(usb_hcd_pci_shutdown);
 353
 354 #ifdef  CONFIG_PM
 355
 356 #ifdef  CONFIG_PPC_PMAC
 357 static void powermac_set_asic(struct pci_dev *pci_dev, int enable)
 358 {
 359         /* Enanble or disable ASIC clocks for USB */
 360         if (machine_is(powermac)) {
 361                 struct device_node      *of_node;
 362
 363                 of_node = pci_device_to_OF_node(pci_dev);
 364                 if (of_node)
 365                         pmac_call_feature(PMAC_FTR_USB_ENABLE,
 366                                         of_node, 0, enable);
 367         }
 368 }
 369
 370 #else
 371
 372 static inline void powermac_set_asic(struct pci_dev *pci_dev, int enable)
 373 {}
 374
 375 #endif  /* CONFIG_PPC_PMAC */
 376
 377 static int check_root_hub_suspended(struct device *dev)
 378 {
 379         struct pci_dev          *pci_dev = to_pci_dev(dev);
 380         struct usb_hcd          *hcd = pci_get_drvdata(pci_dev);
 381
 382         if (HCD_RH_RUNNING(hcd)) {
 383                 dev_warn(dev, "Root hub is not suspended\n");
 384                 return -EBUSY;
 385         }
 386         if (hcd->shared_hcd) {
 387                 hcd = hcd->shared_hcd;
 388                 if (HCD_RH_RUNNING(hcd)) {
 389                         dev_warn(dev, "Secondary root hub is not suspended\n");
 390                         return -EBUSY;
 391                 }
 392         }
 393         return 0;
 394 }
 395
 396 static int suspend_common(struct device *dev, bool do_wakeup)
 397 {
 398         struct pci_dev          *pci_dev = to_pci_dev(dev);
 399         struct usb_hcd          *hcd = pci_get_drvdata(pci_dev);
 400         int                     retval;
 401
 402         /* Root hub suspend should have stopped all downstream traffic,
 403          * and all bus master traffic.  And done so for both the interface
 404          * and the stub usb_device (which we check here).  But maybe it
 405          * didn't; writing sysfs power/state files ignores such rules...
 406          */
 407         retval = check_root_hub_suspended(dev);
 408         if (retval)
 409                 return retval;
 410
 411         if (hcd->driver->pci_suspend && !HCD_DEAD(hcd)) {
 412                 /* Optimization: Don't suspend if a root-hub wakeup is
 413                  * pending and it would cause the HCD to wake up anyway.
 414                  */
 415                 if (do_wakeup && HCD_WAKEUP_PENDING(hcd))
 416                         return -EBUSY;
 417                 if (do_wakeup && hcd->shared_hcd &&
 418                                 HCD_WAKEUP_PENDING(hcd->shared_hcd))
 419                         return -EBUSY;
 420                 retval = hcd->driver->pci_suspend(hcd, do_wakeup);
 421                 suspend_report_result(hcd->driver->pci_suspend, retval);
 422
 423                 /* Check again in case wakeup raced with pci_suspend */
 424                 if ((retval == 0 && do_wakeup && HCD_WAKEUP_PENDING(hcd)) ||
 425                                 (retval == 0 && do_wakeup && hcd->shared_hcd &&
 426                                  HCD_WAKEUP_PENDING(hcd->shared_hcd))) {
 427                         if (hcd->driver->pci_resume)
 428                                 hcd->driver->pci_resume(hcd, false);
 429                         retval = -EBUSY;
 430                 }
 431                 if (retval)
 432                         return retval;
 433         }
 434
 435         /* If MSI-X is enabled, the driver will have synchronized all vectors
 436          * in pci_suspend(). If MSI or legacy PCI is enabled, that will be
 437          * synchronized here.
 438          */
 439         if (!hcd->msix_enabled)
 440                 synchronize_irq(pci_dev->irq);
 441
 442         /* Downstream ports from this root hub should already be quiesced, so
 443          * there will be no DMA activity.  Now we can shut down the upstream
 444          * link (except maybe for PME# resume signaling).  We'll enter a
 445          * low power state during suspend_noirq, if the hardware allows.
 446          */
 447         pci_disable_device(pci_dev);
 448         return retval;
 449 }
 450
 451 static int resume_common(struct device *dev, int event)
 452 {
 453         struct pci_dev          *pci_dev = to_pci_dev(dev);
 454         struct usb_hcd          *hcd = pci_get_drvdata(pci_dev);
 455         int                     retval;
 456
 457         if (HCD_RH_RUNNING(hcd) ||
 458                         (hcd->shared_hcd &&
 459                          HCD_RH_RUNNING(hcd->shared_hcd))) {
 460                 dev_dbg(dev, "can't resume, not suspended!\n");
 461                 return 0;
 462         }
 463
 464         retval = pci_enable_device(pci_dev);
 465         if (retval < 0) {
 466                 dev_err(dev, "can't re-enable after resume, %d!\n", retval);
 467                 return retval;
 468         }
 469
 470         pci_set_master(pci_dev);
 471
 472         clear_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
 473         if (hcd->shared_hcd)
 474                 clear_bit(HCD_FLAG_SAW_IRQ, &hcd->shared_hcd->flags);
 475
 476         if (hcd->driver->pci_resume && !HCD_DEAD(hcd)) {
 477                 if (event != PM_EVENT_AUTO_RESUME)
 478                         wait_for_companions(pci_dev, hcd);
 479
 480                 retval = hcd->driver->pci_resume(hcd,
 481                                 event == PM_EVENT_RESTORE);
 482                 if (retval) {
 483                         dev_err(dev, "PCI post-resume error %d!\n", retval);
 484                         if (hcd->shared_hcd)
 485                                 usb_hc_died(hcd->shared_hcd);
 486                         usb_hc_died(hcd);
 487                 }
 488         }
 489         return retval;
 490 }
 491
 492 #ifdef  CONFIG_PM_SLEEP
 493
 494 static int hcd_pci_suspend(struct device *dev)
 495 {
 496         return suspend_common(dev, device_may_wakeup(dev));
 497 }
 498
 499 static int hcd_pci_suspend_noirq(struct device *dev)
 500 {
 501         struct pci_dev          *pci_dev = to_pci_dev(dev);
 502         struct usb_hcd          *hcd = pci_get_drvdata(pci_dev);
 503         int                     retval;
 504
 505         retval = check_root_hub_suspended(dev);
 506         if (retval)
 507                 return retval;
 508
 509         pci_save_state(pci_dev);
 510
 511         /* If the root hub is dead rather than suspended, disallow remote
 512          * wakeup.  usb_hc_died() should ensure that both hosts are marked as
 513          * dying, so we only need to check the primary roothub.
 514          */
 515         if (HCD_DEAD(hcd))
 516                 device_set_wakeup_enable(dev, 0);
 517         dev_dbg(dev, "wakeup: %d\n", device_may_wakeup(dev));
 518
 519         /* Possibly enable remote wakeup,
 520          * choose the appropriate low-power state, and go to that state.
 521          */
 522         retval = pci_prepare_to_sleep(pci_dev);
 523         if (retval == -EIO) {           /* Low-power not supported */
 524                 dev_dbg(dev, "--> PCI D0 legacy\n");
 525                 retval = 0;
 526         } else if (retval == 0) {
 527                 dev_dbg(dev, "--> PCI %s\n",
 528                                 pci_power_name(pci_dev->current_state));
 529         } else {
 530                 suspend_report_result(pci_prepare_to_sleep, retval);
 531                 return retval;
 532         }
 533
 534         powermac_set_asic(pci_dev, 0);
 535         return retval;
 536 }
 537
 538 static int hcd_pci_resume_noirq(struct device *dev)
 539 {
 540         struct pci_dev          *pci_dev = to_pci_dev(dev);
 541
 542         powermac_set_asic(pci_dev, 1);
 543
 544         /* Go back to D0 and disable remote wakeup */
 545         pci_back_from_sleep(pci_dev);
 546         return 0;
 547 }
 548
 549 static int hcd_pci_resume(struct device *dev)
 550 {
 551         return resume_common(dev, PM_EVENT_RESUME);
 552 }
 553
 554 static int hcd_pci_restore(struct device *dev)
 555 {
 556         return resume_common(dev, PM_EVENT_RESTORE);
 557 }
 558
 559 #else
 560
 561 #define hcd_pci_suspend         NULL
 562 #define hcd_pci_suspend_noirq   NULL
 563 #define hcd_pci_resume_noirq    NULL
 564 #define hcd_pci_resume          NULL
 565 #define hcd_pci_restore         NULL
 566
 567 #endif  /* CONFIG_PM_SLEEP */
 568
 569 #ifdef  CONFIG_PM_RUNTIME
 570
 571 static int hcd_pci_runtime_suspend(struct device *dev)
 572 {
 573         int     retval;
 574
 575         retval = suspend_common(dev, true);
 576         if (retval == 0)
 577                 powermac_set_asic(to_pci_dev(dev), 0);
 578         dev_dbg(dev, "hcd_pci_runtime_suspend: %d\n", retval);
 579         return retval;
 580 }
 581
 582 static int hcd_pci_runtime_resume(struct device *dev)
 583 {
 584         int     retval;
 585
 586         powermac_set_asic(to_pci_dev(dev), 1);
 587         retval = resume_common(dev, PM_EVENT_AUTO_RESUME);
 588         dev_dbg(dev, "hcd_pci_runtime_resume: %d\n", retval);
 589         return retval;
 590 }
 591
 592 #else
 593
 594 #define hcd_pci_runtime_suspend NULL
 595 #define hcd_pci_runtime_resume  NULL
 596
 597 #endif  /* CONFIG_PM_RUNTIME */
 598
 599 const struct dev_pm_ops usb_hcd_pci_pm_ops = {
 600         .suspend        = hcd_pci_suspend,
 601         .suspend_noirq  = hcd_pci_suspend_noirq,
 602         .resume_noirq   = hcd_pci_resume_noirq,
 603         .resume         = hcd_pci_resume,
 604         .freeze         = check_root_hub_suspended,
 605         .freeze_noirq   = check_root_hub_suspended,
 606         .thaw_noirq     = NULL,
 607         .thaw           = NULL,
 608         .poweroff       = hcd_pci_suspend,
 609         .poweroff_noirq = hcd_pci_suspend_noirq,
 610         .restore_noirq  = hcd_pci_resume_noirq,
 611         .restore        = hcd_pci_restore,
 612         .runtime_suspend = hcd_pci_runtime_suspend,
 613         .runtime_resume = hcd_pci_runtime_resume,
 614 };
 615 EXPORT_SYMBOL_GPL(usb_hcd_pci_pm_ops);
 616
 617 #endif  /* CONFIG_PM */