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         int                     has_pci_pm;
 204
 205         /* Root hub suspend should have stopped all downstream traffic,
 206          * and all bus master traffic.  And done so for both the interface
 207          * and the stub usb_device (which we check here).  But maybe it
 208          * didn't; writing sysfs power/state files ignores such rules...
 209          *
 210          * We must ignore the FREEZE vs SUSPEND distinction here, because
 211          * otherwise the swsusp will save (and restore) garbage state.
 212          */
 213         if (!(hcd->state == HC_STATE_SUSPENDED ||
 214                         hcd->state == HC_STATE_HALT)) {
 215                 dev_warn(&dev->dev, "Root hub is not suspended\n");
 216                 retval = -EBUSY;
 217                 goto done;
 218         }
 219
 220         /* We might already be suspended (runtime PM -- not yet written) */
 221         if (dev->current_state != PCI_D0)
 222                 goto done;
 223
 224         if (hcd->driver->pci_suspend) {
 225                 retval = hcd->driver->pci_suspend(hcd, message);
 226                 suspend_report_result(hcd->driver->pci_suspend, retval);
 227                 if (retval)
 228                         goto done;
 229         }
 230
 231         synchronize_irq(dev->irq);
 232
 233         /* Downstream ports from this root hub should already be quiesced, so
 234          * there will be no DMA activity.  Now we can shut down the upstream
 235          * link (except maybe for PME# resume signaling) and enter some PCI
 236          * low power state, if the hardware allows.
 237          */
 238         pci_disable_device(dev);
 239
 240         pci_save_state(dev);
 241
 242         /* Don't fail on error to enable wakeup.  We rely on pci code
 243          * to reject requests the hardware can't implement, rather
 244          * than coding the same thing.
 245          */
 246         wake = (hcd->state == HC_STATE_SUSPENDED &&
 247                         device_may_wakeup(&dev->dev));
 248         w = pci_wake_from_d3(dev, wake);
 249         if (w < 0)
 250                 wake = w;
 251         dev_dbg(&dev->dev, "wakeup: %d\n", wake);
 252
 253         /* Don't change state if we don't need to */
 254         if (message.event == PM_EVENT_FREEZE ||
 255                         message.event == PM_EVENT_PRETHAW) {
 256                 dev_dbg(&dev->dev, "--> no state change\n");
 257                 goto done;
 258         }
 259
 260         has_pci_pm = pci_find_capability(dev, PCI_CAP_ID_PM);
 261         if (!has_pci_pm) {
 262                 dev_dbg(&dev->dev, "--> PCI D0 legacy\n");
 263         } else {
 264
 265                 /* NOTE:  dev->current_state becomes nonzero only here, and
 266                  * only for devices that support PCI PM.  Also, exiting
 267                  * PCI_D3 (but not PCI_D1 or PCI_D2) is allowed to reset
 268                  * some device state (e.g. as part of clock reinit).
 269                  */
 270                 retval = pci_set_power_state(dev, PCI_D3hot);
 271                 suspend_report_result(pci_set_power_state, retval);
 272                 if (retval == 0) {
 273                         dev_dbg(&dev->dev, "--> PCI D3\n");
 274                 } else {
 275                         dev_dbg(&dev->dev, "PCI D3 suspend fail, %d\n",
 276                                         retval);
 277                         pci_restore_state(dev);
 278                 }
 279         }
 280
 281 #ifdef CONFIG_PPC_PMAC
 282         if (retval == 0) {
 283                 /* Disable ASIC clocks for USB */
 284                 if (machine_is(powermac)) {
 285                         struct device_node      *of_node;
 286
 287                         of_node = pci_device_to_OF_node(dev);
 288                         if (of_node)
 289                                 pmac_call_feature(PMAC_FTR_USB_ENABLE,
 290                                                         of_node, 0, 0);
 291                 }
 292         }
 293 #endif
 294
 295  done:
 296         return retval;
 297 }
 298 EXPORT_SYMBOL_GPL(usb_hcd_pci_suspend);
 299
 300 /**
 301  * usb_hcd_pci_resume - power management resume of a PCI-based HCD
 302  * @dev: USB Host Controller being resumed
 303  *
 304  * Store this function in the HCD's struct pci_driver as .resume.
 305  */
 306 int usb_hcd_pci_resume(struct pci_dev *dev)
 307 {
 308         struct usb_hcd          *hcd;
 309         int                     retval;
 310
 311 #ifdef CONFIG_PPC_PMAC
 312         /* Reenable ASIC clocks for USB */
 313         if (machine_is(powermac)) {
 314                 struct device_node *of_node;
 315
 316                 of_node = pci_device_to_OF_node(dev);
 317                 if (of_node)
 318                         pmac_call_feature(PMAC_FTR_USB_ENABLE,
 319                                                 of_node, 0, 1);
 320         }
 321 #endif
 322
 323         pci_restore_state(dev);
 324
 325         hcd = pci_get_drvdata(dev);
 326         if (hcd->state != HC_STATE_SUSPENDED) {
 327                 dev_dbg(hcd->self.controller,
 328                                 "can't resume, not suspended!\n");
 329                 return 0;
 330         }
 331
 332         pci_enable_wake(dev, PCI_D0, false);
 333
 334         retval = pci_enable_device(dev);
 335         if (retval < 0) {
 336                 dev_err(&dev->dev, "can't re-enable after resume, %d!\n",
 337                                 retval);
 338                 return retval;
 339         }
 340
 341         pci_set_master(dev);
 342
 343         /* yes, ignore this result too... */
 344         (void) pci_wake_from_d3(dev, 0);
 345
 346         clear_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
 347
 348         if (hcd->driver->pci_resume) {
 349                 retval = hcd->driver->pci_resume(hcd);
 350                 if (retval) {
 351                         dev_err(hcd->self.controller,
 352                                 "PCI post-resume error %d!\n", retval);
 353                         usb_hc_died(hcd);
 354                 }
 355         }
 356         return retval;
 357 }
 358 EXPORT_SYMBOL_GPL(usb_hcd_pci_resume);
 359
 360 #endif  /* CONFIG_PM */
 361
 362 /**
 363  * usb_hcd_pci_shutdown - shutdown host controller
 364  * @dev: USB Host Controller being shutdown
 365  */
 366 void usb_hcd_pci_shutdown(struct pci_dev *dev)
 367 {
 368         struct usb_hcd          *hcd;
 369
 370         hcd = pci_get_drvdata(dev);
 371         if (!hcd)
 372                 return;
 373
 374         if (hcd->driver->shutdown)
 375                 hcd->driver->shutdown(hcd);
 376 }
 377 EXPORT_SYMBOL_GPL(usb_hcd_pci_shutdown);
 378