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