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
  24 #include <asm/io.h>
  25 #include <asm/irq.h>
  26
  27 #ifdef CONFIG_PPC_PMAC
  28 #include <asm/machdep.h>
  29 #include <asm/pmac_feature.h>
  30 #include <asm/pci-bridge.h>
  31 #include <asm/prom.h>
  32 #endif
  33
  34 #include "usb.h"
  35 #include "hcd.h"
  36
  37
  38 /* PCI-based HCs are common, but plenty of non-PCI HCs are used too */
  39
  40
  41 /*-------------------------------------------------------------------------*/
  42
  43 /* configure so an HC device and id are always provided */
  44 /* always called with process context; sleeping is OK */
  45
  46 /**
  47  * usb_hcd_pci_probe - initialize PCI-based HCDs
  48  * @dev: USB Host Controller being probed
  49  * @id: pci hotplug id connecting controller to HCD framework
  50  * Context: !in_interrupt()
  51  *
  52  * Allocates basic PCI resources for this USB host controller, and
  53  * then invokes the start() method for the HCD associated with it
  54  * through the hotplug entry's driver_data.
  55  *
  56  * Store this function in the HCD's struct pci_driver as probe().
  57  */
  58 int usb_hcd_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
  59 {
  60         struct hc_driver        *driver;
  61         struct usb_hcd          *hcd;
  62         int                     retval;
  63
  64         if (usb_disabled())
  65                 return -ENODEV;
  66
  67         if (!id)
  68                 return -EINVAL;
  69         driver = (struct hc_driver *)id->driver_data;
  70         if (!driver)
  71                 return -EINVAL;
  72
  73         if (pci_enable_device(dev) < 0)
  74                 return -ENODEV;
  75         dev->current_state = PCI_D0;
  76
  77         if (!dev->irq) {
  78                 dev_err(&dev->dev,
  79                         "Found HC with no IRQ.  Check BIOS/PCI %s setup!\n",
  80                         pci_name(dev));
  81                 retval = -ENODEV;
  82                 goto err1;
  83         }
  84
  85         hcd = usb_create_hcd(driver, &dev->dev, pci_name(dev));
  86         if (!hcd) {
  87                 retval = -ENOMEM;
  88                 goto err1;
  89         }
  90
  91         if (driver->flags & HCD_MEMORY) {
  92                 /* EHCI, OHCI */
  93                 hcd->rsrc_start = pci_resource_start(dev, 0);
  94                 hcd->rsrc_len = pci_resource_len(dev, 0);
  95                 if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len,
  96                                 driver->description)) {
  97                         dev_dbg(&dev->dev, "controller already in use\n");
  98                         retval = -EBUSY;
  99                         goto err2;
 100                 }
 101                 hcd->regs = ioremap_nocache(hcd->rsrc_start, hcd->rsrc_len);
 102                 if (hcd->regs == NULL) {
 103                         dev_dbg(&dev->dev, "error mapping memory\n");
 104                         retval = -EFAULT;
 105                         goto err3;
 106                 }
 107
 108         } else {
 109                 /* UHCI */
 110                 int     region;
 111
 112                 for (region = 0; region < PCI_ROM_RESOURCE; region++) {
 113                         if (!(pci_resource_flags(dev, region) &
 114                                         IORESOURCE_IO))
 115                                 continue;
 116
 117                         hcd->rsrc_start = pci_resource_start(dev, region);
 118                         hcd->rsrc_len = pci_resource_len(dev, region);
 119                         if (request_region(hcd->rsrc_start, hcd->rsrc_len,
 120                                         driver->description))
 121                                 break;
 122                 }
 123                 if (region == PCI_ROM_RESOURCE) {
 124                         dev_dbg(&dev->dev, "no i/o regions available\n");
 125                         retval = -EBUSY;
 126                         goto err1;
 127                 }
 128         }
 129
 130         pci_set_master(dev);
 131
 132         retval = usb_add_hcd(hcd, dev->irq, IRQF_DISABLED | IRQF_SHARED);
 133         if (retval != 0)
 134                 goto err4;
 135         return retval;
 136
 137  err4:
 138         if (driver->flags & HCD_MEMORY) {
 139                 iounmap(hcd->regs);
 140  err3:
 141                 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
 142         } else
 143                 release_region(hcd->rsrc_start, hcd->rsrc_len);
 144  err2:
 145         usb_put_hcd(hcd);
 146  err1:
 147         pci_disable_device(dev);
 148         dev_err(&dev->dev, "init %s fail, %d\n", pci_name(dev), retval);
 149         return retval;
 150 }
 151 EXPORT_SYMBOL_GPL(usb_hcd_pci_probe);
 152
 153
 154 /* may be called without controller electrically present */
 155 /* may be called with controller, bus, and devices active */
 156
 157 /**
 158  * usb_hcd_pci_remove - shutdown processing for PCI-based HCDs
 159  * @dev: USB Host Controller being removed
 160  * Context: !in_interrupt()
 161  *
 162  * Reverses the effect of usb_hcd_pci_probe(), first invoking
 163  * the HCD's stop() method.  It is always called from a thread
 164  * context, normally "rmmod", "apmd", or something similar.
 165  *
 166  * Store this function in the HCD's struct pci_driver as remove().
 167  */
 168 void usb_hcd_pci_remove(struct pci_dev *dev)
 169 {
 170         struct usb_hcd          *hcd;
 171
 172         hcd = pci_get_drvdata(dev);
 173         if (!hcd)
 174                 return;
 175
 176         usb_remove_hcd(hcd);
 177         if (hcd->driver->flags & HCD_MEMORY) {
 178                 iounmap(hcd->regs);
 179                 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
 180         } else {
 181                 release_region(hcd->rsrc_start, hcd->rsrc_len);
 182         }
 183         usb_put_hcd(hcd);
 184         pci_disable_device(dev);
 185 }
 186 EXPORT_SYMBOL_GPL(usb_hcd_pci_remove);
 187
 188
 189 #ifdef  CONFIG_PM
 190
 191 /**
 192  * usb_hcd_pci_suspend - power management suspend of a PCI-based HCD
 193  * @dev: USB Host Controller being suspended
 194  * @message: Power Management message describing this state transition
 195  *
 196  * Store this function in the HCD's struct pci_driver as .suspend.
 197  */
 198 int usb_hcd_pci_suspend(struct pci_dev *dev, pm_message_t message)
 199 {
 200         struct usb_hcd          *hcd = pci_get_drvdata(dev);
 201         int                     retval = 0;
 202         int                     wake, w;
 203
 204         /* Root hub suspend should have stopped all downstream traffic,
 205          * and all bus master traffic.  And done so for both the interface
 206          * and the stub usb_device (which we check here).  But maybe it
 207          * didn't; writing sysfs power/state files ignores such rules...
 208          *
 209          * We must ignore the FREEZE vs SUSPEND distinction here, because
 210          * otherwise the swsusp will save (and restore) garbage state.
 211          */
 212         if (!(hcd->state == HC_STATE_SUSPENDED ||
 213                         hcd->state == HC_STATE_HALT)) {
 214                 dev_warn(&dev->dev, "Root hub is not suspended\n");
 215                 retval = -EBUSY;
 216                 goto done;
 217         }
 218
 219         /* We might already be suspended (runtime PM -- not yet written) */
 220         if (dev->current_state != PCI_D0)
 221                 goto done;
 222
 223         if (hcd->driver->pci_suspend) {
 224                 retval = hcd->driver->pci_suspend(hcd, message);
 225                 suspend_report_result(hcd->driver->pci_suspend, retval);
 226                 if (retval)
 227                         goto done;
 228         }
 229
 230         synchronize_irq(dev->irq);
 231
 232         /* Don't fail on error to enable wakeup.  We rely on pci code
 233          * to reject requests the hardware can't implement, rather
 234          * than coding the same thing.
 235          */
 236         wake = (hcd->state == HC_STATE_SUSPENDED &&
 237                         device_may_wakeup(&dev->dev));
 238         w = pci_wake_from_d3(dev, wake);
 239         if (w < 0)
 240                 wake = w;
 241         dev_dbg(&dev->dev, "wakeup: %d\n", wake);
 242
 243         /* Downstream ports from this root hub should already be quiesced, so
 244          * there will be no DMA activity.  Now we can shut down the upstream
 245          * link (except maybe for PME# resume signaling) and enter some PCI
 246          * low power state, if the hardware allows.
 247          */
 248         pci_disable_device(dev);
 249  done:
 250         return retval;
 251 }
 252 EXPORT_SYMBOL_GPL(usb_hcd_pci_suspend);
 253
 254 /**
 255  * usb_hcd_pci_suspend_late - suspend a PCI-based HCD after IRQs are disabled
 256  * @dev: USB Host Controller being suspended
 257  * @message: Power Management message describing this state transition
 258  *
 259  * Store this function in the HCD's struct pci_driver as .suspend_late.
 260  */
 261 int usb_hcd_pci_suspend_late(struct pci_dev *dev, pm_message_t message)
 262 {
 263         int                     retval = 0;
 264         int                     has_pci_pm;
 265
 266         /* We might already be suspended (runtime PM -- not yet written) */
 267         if (dev->current_state != PCI_D0)
 268                 goto done;
 269
 270         pci_save_state(dev);
 271
 272         /* Don't change state if we don't need to */
 273         if (message.event == PM_EVENT_FREEZE ||
 274                         message.event == PM_EVENT_PRETHAW) {
 275                 dev_dbg(&dev->dev, "--> no state change\n");
 276                 goto done;
 277         }
 278
 279         has_pci_pm = pci_find_capability(dev, PCI_CAP_ID_PM);
 280         if (!has_pci_pm) {
 281                 dev_dbg(&dev->dev, "--> PCI D0 legacy\n");
 282         } else {
 283
 284                 /* NOTE:  dev->current_state becomes nonzero only here, and
 285                  * only for devices that support PCI PM.  Also, exiting
 286                  * PCI_D3 (but not PCI_D1 or PCI_D2) is allowed to reset
 287                  * some device state (e.g. as part of clock reinit).
 288                  */
 289                 retval = pci_set_power_state(dev, PCI_D3hot);
 290                 suspend_report_result(pci_set_power_state, retval);
 291                 if (retval == 0) {
 292                         dev_dbg(&dev->dev, "--> PCI D3\n");
 293                 } else {
 294                         dev_dbg(&dev->dev, "PCI D3 suspend fail, %d\n",
 295                                         retval);
 296                         pci_restore_state(dev);
 297                 }
 298         }
 299
 300 #ifdef CONFIG_PPC_PMAC
 301         if (retval == 0) {
 302                 /* Disable ASIC clocks for USB */
 303                 if (machine_is(powermac)) {
 304                         struct device_node      *of_node;
 305
 306                         of_node = pci_device_to_OF_node(dev);
 307                         if (of_node)
 308                                 pmac_call_feature(PMAC_FTR_USB_ENABLE,
 309                                                         of_node, 0, 0);
 310                 }
 311         }
 312 #endif
 313
 314  done:
 315         return retval;
 316 }
 317 EXPORT_SYMBOL_GPL(usb_hcd_pci_suspend_late);
 318
 319 /**
 320  * usb_hcd_pci_resume_early - resume a PCI-based HCD before IRQs are enabled
 321  * @dev: USB Host Controller being resumed
 322  *
 323  * Store this function in the HCD's struct pci_driver as .resume_early.
 324  */
 325 int usb_hcd_pci_resume_early(struct pci_dev *dev)
 326 {
 327         int             retval = 0;
 328         pci_power_t     state = dev->current_state;
 329
 330 #ifdef CONFIG_PPC_PMAC
 331         /* Reenable ASIC clocks for USB */
 332         if (machine_is(powermac)) {
 333                 struct device_node *of_node;
 334
 335                 of_node = pci_device_to_OF_node(dev);
 336                 if (of_node)
 337                         pmac_call_feature(PMAC_FTR_USB_ENABLE,
 338                                                 of_node, 0, 1);
 339         }
 340 #endif
 341
 342         /* NOTE:  chip docs cover clean "real suspend" cases (what Linux
 343          * calls "standby", "suspend to RAM", and so on).  There are also
 344          * dirty cases when swsusp fakes a suspend in "shutdown" mode.
 345          */
 346         if (state != PCI_D0) {
 347 #ifdef  DEBUG
 348                 int     pci_pm;
 349                 u16     pmcr;
 350
 351                 pci_pm = pci_find_capability(dev, PCI_CAP_ID_PM);
 352                 pci_read_config_word(dev, pci_pm + PCI_PM_CTRL, &pmcr);
 353                 pmcr &= PCI_PM_CTRL_STATE_MASK;
 354                 if (pmcr) {
 355                         /* Clean case:  power to USB and to HC registers was
 356                          * maintained; remote wakeup is easy.
 357                          */
 358                         dev_dbg(&dev->dev, "resume from PCI D%d\n", pmcr);
 359                 } else {
 360                         /* Clean:  HC lost Vcc power, D0 uninitialized
 361                          *   + Vaux may have preserved port and transceiver
 362                          *     state ... for remote wakeup from D3cold
 363                          *   + or not; HCD must reinit + re-enumerate
 364                          *
 365                          * Dirty: D0 semi-initialized cases with swsusp
 366                          *   + after BIOS init
 367                          *   + after Linux init (HCD statically linked)
 368                          */
 369                         dev_dbg(&dev->dev, "resume from previous PCI D%d\n",
 370                                         state);
 371                 }
 372 #endif
 373
 374                 retval = pci_set_power_state(dev, PCI_D0);
 375         } else {
 376                 /* Same basic cases: clean (powered/not), dirty */
 377                 dev_dbg(&dev->dev, "PCI legacy resume\n");
 378         }
 379
 380         if (retval < 0)
 381                 dev_err(&dev->dev, "can't resume: %d\n", retval);
 382         else
 383                 pci_restore_state(dev);
 384
 385         return retval;
 386 }
 387 EXPORT_SYMBOL_GPL(usb_hcd_pci_resume_early);
 388
 389 /**
 390  * usb_hcd_pci_resume - power management resume of a PCI-based HCD
 391  * @dev: USB Host Controller being resumed
 392  *
 393  * Store this function in the HCD's struct pci_driver as .resume.
 394  */
 395 int usb_hcd_pci_resume(struct pci_dev *dev)
 396 {
 397         struct usb_hcd          *hcd;
 398         int                     retval;
 399
 400         hcd = pci_get_drvdata(dev);
 401         if (hcd->state != HC_STATE_SUSPENDED) {
 402                 dev_dbg(hcd->self.controller,
 403                                 "can't resume, not suspended!\n");
 404                 return 0;
 405         }
 406
 407         retval = pci_enable_device(dev);
 408         if (retval < 0) {
 409                 dev_err(&dev->dev, "can't re-enable after resume, %d!\n",
 410                                 retval);
 411                 return retval;
 412         }
 413
 414         pci_set_master(dev);
 415
 416         /* yes, ignore this result too... */
 417         (void) pci_wake_from_d3(dev, 0);
 418
 419         clear_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
 420
 421         if (hcd->driver->pci_resume) {
 422                 retval = hcd->driver->pci_resume(hcd);
 423                 if (retval) {
 424                         dev_err(hcd->self.controller,
 425                                 "PCI post-resume error %d!\n", retval);
 426                         usb_hc_died(hcd);
 427                 }
 428         }
 429         return retval;
 430 }
 431 EXPORT_SYMBOL_GPL(usb_hcd_pci_resume);
 432
 433 #endif  /* CONFIG_PM */
 434
 435 /**
 436  * usb_hcd_pci_shutdown - shutdown host controller
 437  * @dev: USB Host Controller being shutdown
 438  */
 439 void usb_hcd_pci_shutdown(struct pci_dev *dev)
 440 {
 441         struct usb_hcd          *hcd;
 442
 443         hcd = pci_get_drvdata(dev);
 444         if (!hcd)
 445                 return;
 446
 447         if (hcd->driver->shutdown)
 448                 hcd->driver->shutdown(hcd);
 449 }
 450 EXPORT_SYMBOL_GPL(usb_hcd_pci_shutdown);
 451