drivers/pci/pci-driver.c

   1 /*
   2  * drivers/pci/pci-driver.c
   3  *
   4  * (C) Copyright 2002-2004, 2007 Greg Kroah-Hartman <greg@kroah.com>
   5  * (C) Copyright 2007 Novell Inc.
   6  *
   7  * Released under the GPL v2 only.
   8  *
   9  */
  10
  11 #include <linux/pci.h>
  12 #include <linux/module.h>
  13 #include <linux/init.h>
  14 #include <linux/device.h>
  15 #include <linux/mempolicy.h>
  16 #include <linux/string.h>
  17 #include <linux/slab.h>
  18 #include <linux/sched.h>
  19 #include <linux/cpu.h>
  20 #include <linux/pm_runtime.h>
  21 #include <linux/suspend.h>
  22 #include <linux/kexec.h>
  23 #include "pci.h"
  24
  25 struct pci_dynid {
  26         struct list_head node;
  27         struct pci_device_id id;
  28 };
  29
  30 /**
  31  * pci_add_dynid - add a new PCI device ID to this driver and re-probe devices
  32  * @drv: target pci driver
  33  * @vendor: PCI vendor ID
  34  * @device: PCI device ID
  35  * @subvendor: PCI subvendor ID
  36  * @subdevice: PCI subdevice ID
  37  * @class: PCI class
  38  * @class_mask: PCI class mask
  39  * @driver_data: private driver data
  40  *
  41  * Adds a new dynamic pci device ID to this driver and causes the
  42  * driver to probe for all devices again.  @drv must have been
  43  * registered prior to calling this function.
  44  *
  45  * CONTEXT:
  46  * Does GFP_KERNEL allocation.
  47  *
  48  * RETURNS:
  49  * 0 on success, -errno on failure.
  50  */
  51 int pci_add_dynid(struct pci_driver *drv,
  52                   unsigned int vendor, unsigned int device,
  53                   unsigned int subvendor, unsigned int subdevice,
  54                   unsigned int class, unsigned int class_mask,
  55                   unsigned long driver_data)
  56 {
  57         struct pci_dynid *dynid;
  58         int retval;
  59
  60         dynid = kzalloc(sizeof(*dynid), GFP_KERNEL);
  61         if (!dynid)
  62                 return -ENOMEM;
  63
  64         dynid->id.vendor = vendor;
  65         dynid->id.device = device;
  66         dynid->id.subvendor = subvendor;
  67         dynid->id.subdevice = subdevice;
  68         dynid->id.class = class;
  69         dynid->id.class_mask = class_mask;
  70         dynid->id.driver_data = driver_data;
  71
  72         spin_lock(&drv->dynids.lock);
  73         list_add_tail(&dynid->node, &drv->dynids.list);
  74         spin_unlock(&drv->dynids.lock);
  75
  76         retval = driver_attach(&drv->driver);
  77
  78         return retval;
  79 }
  80
  81 static void pci_free_dynids(struct pci_driver *drv)
  82 {
  83         struct pci_dynid *dynid, *n;
  84
  85         spin_lock(&drv->dynids.lock);
  86         list_for_each_entry_safe(dynid, n, &drv->dynids.list, node) {
  87                 list_del(&dynid->node);
  88                 kfree(dynid);
  89         }
  90         spin_unlock(&drv->dynids.lock);
  91 }
  92
  93 /**
  94  * store_new_id - sysfs frontend to pci_add_dynid()
  95  * @driver: target device driver
  96  * @buf: buffer for scanning device ID data
  97  * @count: input size
  98  *
  99  * Allow PCI IDs to be added to an existing driver via sysfs.
 100  */
 101 static ssize_t
 102 store_new_id(struct device_driver *driver, const char *buf, size_t count)
 103 {
 104         struct pci_driver *pdrv = to_pci_driver(driver);
 105         const struct pci_device_id *ids = pdrv->id_table;
 106         __u32 vendor, device, subvendor=PCI_ANY_ID,
 107                 subdevice=PCI_ANY_ID, class=0, class_mask=0;
 108         unsigned long driver_data=0;
 109         int fields=0;
 110         int retval;
 111
 112         fields = sscanf(buf, "%x %x %x %x %x %x %lx",
 113                         &vendor, &device, &subvendor, &subdevice,
 114                         &class, &class_mask, &driver_data);
 115         if (fields < 2)
 116                 return -EINVAL;
 117
 118         /* Only accept driver_data values that match an existing id_table
 119            entry */
 120         if (ids) {
 121                 retval = -EINVAL;
 122                 while (ids->vendor || ids->subvendor || ids->class_mask) {
 123                         if (driver_data == ids->driver_data) {
 124                                 retval = 0;
 125                                 break;
 126                         }
 127                         ids++;
 128                 }
 129                 if (retval)     /* No match */
 130                         return retval;
 131         }
 132
 133         retval = pci_add_dynid(pdrv, vendor, device, subvendor, subdevice,
 134                                class, class_mask, driver_data);
 135         if (retval)
 136                 return retval;
 137         return count;
 138 }
 139 static DRIVER_ATTR(new_id, S_IWUSR, NULL, store_new_id);
 140
 141 /**
 142  * store_remove_id - remove a PCI device ID from this driver
 143  * @driver: target device driver
 144  * @buf: buffer for scanning device ID data
 145  * @count: input size
 146  *
 147  * Removes a dynamic pci device ID to this driver.
 148  */
 149 static ssize_t
 150 store_remove_id(struct device_driver *driver, const char *buf, size_t count)
 151 {
 152         struct pci_dynid *dynid, *n;
 153         struct pci_driver *pdrv = to_pci_driver(driver);
 154         __u32 vendor, device, subvendor = PCI_ANY_ID,
 155                 subdevice = PCI_ANY_ID, class = 0, class_mask = 0;
 156         int fields = 0;
 157         int retval = -ENODEV;
 158
 159         fields = sscanf(buf, "%x %x %x %x %x %x",
 160                         &vendor, &device, &subvendor, &subdevice,
 161                         &class, &class_mask);
 162         if (fields < 2)
 163                 return -EINVAL;
 164
 165         spin_lock(&pdrv->dynids.lock);
 166         list_for_each_entry_safe(dynid, n, &pdrv->dynids.list, node) {
 167                 struct pci_device_id *id = &dynid->id;
 168                 if ((id->vendor == vendor) &&
 169                     (id->device == device) &&
 170                     (subvendor == PCI_ANY_ID || id->subvendor == subvendor) &&
 171                     (subdevice == PCI_ANY_ID || id->subdevice == subdevice) &&
 172                     !((id->class ^ class) & class_mask)) {
 173                         list_del(&dynid->node);
 174                         kfree(dynid);
 175                         retval = 0;
 176                         break;
 177                 }
 178         }
 179         spin_unlock(&pdrv->dynids.lock);
 180
 181         if (retval)
 182                 return retval;
 183         return count;
 184 }
 185 static DRIVER_ATTR(remove_id, S_IWUSR, NULL, store_remove_id);
 186
 187 static struct attribute *pci_drv_attrs[] = {
 188         &driver_attr_new_id.attr,
 189         &driver_attr_remove_id.attr,
 190         NULL,
 191 };
 192 ATTRIBUTE_GROUPS(pci_drv);
 193
 194 /**
 195  * pci_match_id - See if a pci device matches a given pci_id table
 196  * @ids: array of PCI device id structures to search in
 197  * @dev: the PCI device structure to match against.
 198  *
 199  * Used by a driver to check whether a PCI device present in the
 200  * system is in its list of supported devices.  Returns the matching
 201  * pci_device_id structure or %NULL if there is no match.
 202  *
 203  * Deprecated, don't use this as it will not catch any dynamic ids
 204  * that a driver might want to check for.
 205  */
 206 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
 207                                          struct pci_dev *dev)
 208 {
 209         if (ids) {
 210                 while (ids->vendor || ids->subvendor || ids->class_mask) {
 211                         if (pci_match_one_device(ids, dev))
 212                                 return ids;
 213                         ids++;
 214                 }
 215         }
 216         return NULL;
 217 }
 218
 219 /**
 220  * pci_match_device - Tell if a PCI device structure has a matching PCI device id structure
 221  * @drv: the PCI driver to match against
 222  * @dev: the PCI device structure to match against
 223  *
 224  * Used by a driver to check whether a PCI device present in the
 225  * system is in its list of supported devices.  Returns the matching
 226  * pci_device_id structure or %NULL if there is no match.
 227  */
 228 static const struct pci_device_id *pci_match_device(struct pci_driver *drv,
 229                                                     struct pci_dev *dev)
 230 {
 231         struct pci_dynid *dynid;
 232
 233         /* Look at the dynamic ids first, before the static ones */
 234         spin_lock(&drv->dynids.lock);
 235         list_for_each_entry(dynid, &drv->dynids.list, node) {
 236                 if (pci_match_one_device(&dynid->id, dev)) {
 237                         spin_unlock(&drv->dynids.lock);
 238                         return &dynid->id;
 239                 }
 240         }
 241         spin_unlock(&drv->dynids.lock);
 242
 243         return pci_match_id(drv->id_table, dev);
 244 }
 245
 246 struct drv_dev_and_id {
 247         struct pci_driver *drv;
 248         struct pci_dev *dev;
 249         const struct pci_device_id *id;
 250 };
 251
 252 static long local_pci_probe(void *_ddi)
 253 {
 254         struct drv_dev_and_id *ddi = _ddi;
 255         struct pci_dev *pci_dev = ddi->dev;
 256         struct pci_driver *pci_drv = ddi->drv;
 257         struct device *dev = &pci_dev->dev;
 258         int rc;
 259
 260         /*
 261          * Unbound PCI devices are always put in D0, regardless of
 262          * runtime PM status.  During probe, the device is set to
 263          * active and the usage count is incremented.  If the driver
 264          * supports runtime PM, it should call pm_runtime_put_noidle()
 265          * in its probe routine and pm_runtime_get_noresume() in its
 266          * remove routine.
 267          */
 268         pm_runtime_get_sync(dev);
 269         pci_dev->driver = pci_drv;
 270         rc = pci_drv->probe(pci_dev, ddi->id);
 271         if (!rc)
 272                 return rc;
 273         if (rc < 0) {
 274                 pci_dev->driver = NULL;
 275                 pm_runtime_put_sync(dev);
 276                 return rc;
 277         }
 278         /*
 279          * Probe function should return < 0 for failure, 0 for success
 280          * Treat values > 0 as success, but warn.
 281          */
 282         dev_warn(dev, "Driver probe function unexpectedly returned %d\n", rc);
 283         return 0;
 284 }
 285
 286 static int pci_call_probe(struct pci_driver *drv, struct pci_dev *dev,
 287                           const struct pci_device_id *id)
 288 {
 289         int error, node;
 290         struct drv_dev_and_id ddi = { drv, dev, id };
 291
 292         /*
 293          * Execute driver initialization on node where the device is
 294          * attached.  This way the driver likely allocates its local memory
 295          * on the right node.
 296          */
 297         node = dev_to_node(&dev->dev);
 298
 299         /*
 300          * On NUMA systems, we are likely to call a PF probe function using
 301          * work_on_cpu().  If that probe calls pci_enable_sriov() (which
 302          * adds the VF devices via pci_bus_add_device()), we may re-enter
 303          * this function to call the VF probe function.  Calling
 304          * work_on_cpu() again will cause a lockdep warning.  Since VFs are
 305          * always on the same node as the PF, we can work around this by
 306          * avoiding work_on_cpu() when we're already on the correct node.
 307          *
 308          * Preemption is enabled, so it's theoretically unsafe to use
 309          * numa_node_id(), but even if we run the probe function on the
 310          * wrong node, it should be functionally correct.
 311          */
 312         if (node >= 0 && node != numa_node_id()) {
 313                 int cpu;
 314
 315                 get_online_cpus();
 316                 cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask);
 317                 if (cpu < nr_cpu_ids)
 318                         error = work_on_cpu(cpu, local_pci_probe, &ddi);
 319                 else
 320                         error = local_pci_probe(&ddi);
 321                 put_online_cpus();
 322         } else
 323                 error = local_pci_probe(&ddi);
 324
 325         return error;
 326 }
 327
 328 /**
 329  * __pci_device_probe - check if a driver wants to claim a specific PCI device
 330  * @drv: driver to call to check if it wants the PCI device
 331  * @pci_dev: PCI device being probed
 332  *
 333  * returns 0 on success, else error.
 334  * side-effect: pci_dev->driver is set to drv when drv claims pci_dev.
 335  */
 336 static int
 337 __pci_device_probe(struct pci_driver *drv, struct pci_dev *pci_dev)
 338 {
 339         const struct pci_device_id *id;
 340         int error = 0;
 341
 342         if (!pci_dev->driver && drv->probe) {
 343                 error = -ENODEV;
 344
 345                 id = pci_match_device(drv, pci_dev);
 346                 if (id)
 347                         error = pci_call_probe(drv, pci_dev, id);
 348                 if (error >= 0)
 349                         error = 0;
 350         }
 351         return error;
 352 }
 353
 354 static int pci_device_probe(struct device * dev)
 355 {
 356         int error = 0;
 357         struct pci_driver *drv;
 358         struct pci_dev *pci_dev;
 359
 360         drv = to_pci_driver(dev->driver);
 361         pci_dev = to_pci_dev(dev);
 362         pci_dev_get(pci_dev);
 363         error = __pci_device_probe(drv, pci_dev);
 364         if (error)
 365                 pci_dev_put(pci_dev);
 366
 367         return error;
 368 }
 369
 370 static int pci_device_remove(struct device * dev)
 371 {
 372         struct pci_dev * pci_dev = to_pci_dev(dev);
 373         struct pci_driver * drv = pci_dev->driver;
 374
 375         if (drv) {
 376                 if (drv->remove) {
 377                         pm_runtime_get_sync(dev);
 378                         drv->remove(pci_dev);
 379                         pm_runtime_put_noidle(dev);
 380                 }
 381                 pci_dev->driver = NULL;
 382         }
 383
 384         /* Undo the runtime PM settings in local_pci_probe() */
 385         pm_runtime_put_sync(dev);
 386
 387         /*
 388          * If the device is still on, set the power state as "unknown",
 389          * since it might change by the next time we load the driver.
 390          */
 391         if (pci_dev->current_state == PCI_D0)
 392                 pci_dev->current_state = PCI_UNKNOWN;
 393
 394         /*
 395          * We would love to complain here if pci_dev->is_enabled is set, that
 396          * the driver should have called pci_disable_device(), but the
 397          * unfortunate fact is there are too many odd BIOS and bridge setups
 398          * that don't like drivers doing that all of the time.
 399          * Oh well, we can dream of sane hardware when we sleep, no matter how
 400          * horrible the crap we have to deal with is when we are awake...
 401          */
 402
 403         pci_dev_put(pci_dev);
 404         return 0;
 405 }
 406
 407 static void pci_device_shutdown(struct device *dev)
 408 {
 409         struct pci_dev *pci_dev = to_pci_dev(dev);
 410         struct pci_driver *drv = pci_dev->driver;
 411
 412         pm_runtime_resume(dev);
 413
 414         if (drv && drv->shutdown)
 415                 drv->shutdown(pci_dev);
 416         pci_msi_shutdown(pci_dev);
 417         pci_msix_shutdown(pci_dev);
 418
 419 #ifdef CONFIG_KEXEC
 420         /*
 421          * If this is a kexec reboot, turn off Bus Master bit on the
 422          * device to tell it to not continue to do DMA. Don't touch
 423          * devices in D3cold or unknown states.
 424          * If it is not a kexec reboot, firmware will hit the PCI
 425          * devices with big hammer and stop their DMA any way.
 426          */
 427         if (kexec_in_progress && (pci_dev->current_state <= PCI_D3hot))
 428                 pci_clear_master(pci_dev);
 429 #endif
 430 }
 431
 432 #ifdef CONFIG_PM
 433
 434 /* Auxiliary functions used for system resume and run-time resume. */
 435
 436 /**
 437  * pci_restore_standard_config - restore standard config registers of PCI device
 438  * @pci_dev: PCI device to handle
 439  */
 440 static int pci_restore_standard_config(struct pci_dev *pci_dev)
 441 {
 442         pci_update_current_state(pci_dev, PCI_UNKNOWN);
 443
 444         if (pci_dev->current_state != PCI_D0) {
 445                 int error = pci_set_power_state(pci_dev, PCI_D0);
 446                 if (error)
 447                         return error;
 448         }
 449
 450         pci_restore_state(pci_dev);
 451         return 0;
 452 }
 453
 454 #endif
 455
 456 #ifdef CONFIG_PM_SLEEP
 457
 458 static void pci_pm_default_resume_early(struct pci_dev *pci_dev)
 459 {
 460         pci_power_up(pci_dev);
 461         pci_restore_state(pci_dev);
 462         pci_fixup_device(pci_fixup_resume_early, pci_dev);
 463 }
 464
 465 /*
 466  * Default "suspend" method for devices that have no driver provided suspend,
 467  * or not even a driver at all (second part).
 468  */
 469 static void pci_pm_set_unknown_state(struct pci_dev *pci_dev)
 470 {
 471         /*
 472          * mark its power state as "unknown", since we don't know if
 473          * e.g. the BIOS will change its device state when we suspend.
 474          */
 475         if (pci_dev->current_state == PCI_D0)
 476                 pci_dev->current_state = PCI_UNKNOWN;
 477 }
 478
 479 /*
 480  * Default "resume" method for devices that have no driver provided resume,
 481  * or not even a driver at all (second part).
 482  */
 483 static int pci_pm_reenable_device(struct pci_dev *pci_dev)
 484 {
 485         int retval;
 486
 487         /* if the device was enabled before suspend, reenable */
 488         retval = pci_reenable_device(pci_dev);
 489         /*
 490          * if the device was busmaster before the suspend, make it busmaster
 491          * again
 492          */
 493         if (pci_dev->is_busmaster)
 494                 pci_set_master(pci_dev);
 495
 496         return retval;
 497 }
 498
 499 static int pci_legacy_suspend(struct device *dev, pm_message_t state)
 500 {
 501         struct pci_dev * pci_dev = to_pci_dev(dev);
 502         struct pci_driver * drv = pci_dev->driver;
 503
 504         if (drv && drv->suspend) {
 505                 pci_power_t prev = pci_dev->current_state;
 506                 int error;
 507
 508                 error = drv->suspend(pci_dev, state);
 509                 suspend_report_result(drv->suspend, error);
 510                 if (error)
 511                         return error;
 512
 513                 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
 514                     && pci_dev->current_state != PCI_UNKNOWN) {
 515                         WARN_ONCE(pci_dev->current_state != prev,
 516                                 "PCI PM: Device state not saved by %pF\n",
 517                                 drv->suspend);
 518                 }
 519         }
 520
 521         pci_fixup_device(pci_fixup_suspend, pci_dev);
 522
 523         return 0;
 524 }
 525
 526 static int pci_legacy_suspend_late(struct device *dev, pm_message_t state)
 527 {
 528         struct pci_dev * pci_dev = to_pci_dev(dev);
 529         struct pci_driver * drv = pci_dev->driver;
 530
 531         if (drv && drv->suspend_late) {
 532                 pci_power_t prev = pci_dev->current_state;
 533                 int error;
 534
 535                 error = drv->suspend_late(pci_dev, state);
 536                 suspend_report_result(drv->suspend_late, error);
 537                 if (error)
 538                         return error;
 539
 540                 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
 541                     && pci_dev->current_state != PCI_UNKNOWN) {
 542                         WARN_ONCE(pci_dev->current_state != prev,
 543                                 "PCI PM: Device state not saved by %pF\n",
 544                                 drv->suspend_late);
 545                         return 0;
 546                 }
 547         }
 548
 549         if (!pci_dev->state_saved)
 550                 pci_save_state(pci_dev);
 551
 552         pci_pm_set_unknown_state(pci_dev);
 553
 554         return 0;
 555 }
 556
 557 static int pci_legacy_resume_early(struct device *dev)
 558 {
 559         struct pci_dev * pci_dev = to_pci_dev(dev);
 560         struct pci_driver * drv = pci_dev->driver;
 561
 562         return drv && drv->resume_early ?
 563                         drv->resume_early(pci_dev) : 0;
 564 }
 565
 566 static int pci_legacy_resume(struct device *dev)
 567 {
 568         struct pci_dev * pci_dev = to_pci_dev(dev);
 569         struct pci_driver * drv = pci_dev->driver;
 570
 571         pci_fixup_device(pci_fixup_resume, pci_dev);
 572
 573         return drv && drv->resume ?
 574                         drv->resume(pci_dev) : pci_pm_reenable_device(pci_dev);
 575 }
 576
 577 /* Auxiliary functions used by the new power management framework */
 578
 579 static void pci_pm_default_resume(struct pci_dev *pci_dev)
 580 {
 581         pci_fixup_device(pci_fixup_resume, pci_dev);
 582
 583         if (!pci_is_bridge(pci_dev))
 584                 pci_enable_wake(pci_dev, PCI_D0, false);
 585 }
 586
 587 static void pci_pm_default_suspend(struct pci_dev *pci_dev)
 588 {
 589         /* Disable non-bridge devices without PM support */
 590         if (!pci_is_bridge(pci_dev))
 591                 pci_disable_enabled_device(pci_dev);
 592 }
 593
 594 static bool pci_has_legacy_pm_support(struct pci_dev *pci_dev)
 595 {
 596         struct pci_driver *drv = pci_dev->driver;
 597         bool ret = drv && (drv->suspend || drv->suspend_late || drv->resume
 598                 || drv->resume_early);
 599
 600         /*
 601          * Legacy PM support is used by default, so warn if the new framework is
 602          * supported as well.  Drivers are supposed to support either the
 603          * former, or the latter, but not both at the same time.
 604          */
 605         WARN(ret && drv->driver.pm, "driver %s device %04x:%04x\n",
 606                 drv->name, pci_dev->vendor, pci_dev->device);
 607
 608         return ret;
 609 }
 610
 611 /* New power management framework */
 612
 613 static int pci_pm_prepare(struct device *dev)
 614 {
 615         struct device_driver *drv = dev->driver;
 616         int error = 0;
 617
 618         /*
 619          * PCI devices suspended at run time need to be resumed at this
 620          * point, because in general it is necessary to reconfigure them for
 621          * system suspend.  Namely, if the device is supposed to wake up the
 622          * system from the sleep state, we may need to reconfigure it for this
 623          * purpose.  In turn, if the device is not supposed to wake up the
 624          * system from the sleep state, we'll have to prevent it from signaling
 625          * wake-up.
 626          */
 627         pm_runtime_resume(dev);
 628
 629         if (drv && drv->pm && drv->pm->prepare)
 630                 error = drv->pm->prepare(dev);
 631
 632         return error;
 633 }
 634
 635
 636 #else /* !CONFIG_PM_SLEEP */
 637
 638 #define pci_pm_prepare  NULL
 639
 640 #endif /* !CONFIG_PM_SLEEP */
 641
 642 #ifdef CONFIG_SUSPEND
 643
 644 static int pci_pm_suspend(struct device *dev)
 645 {
 646         struct pci_dev *pci_dev = to_pci_dev(dev);
 647         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
 648
 649         if (pci_has_legacy_pm_support(pci_dev))
 650                 return pci_legacy_suspend(dev, PMSG_SUSPEND);
 651
 652         if (!pm) {
 653                 pci_pm_default_suspend(pci_dev);
 654                 goto Fixup;
 655         }
 656
 657         pci_dev->state_saved = false;
 658         if (pm->suspend) {
 659                 pci_power_t prev = pci_dev->current_state;
 660                 int error;
 661
 662                 error = pm->suspend(dev);
 663                 suspend_report_result(pm->suspend, error);
 664                 if (error)
 665                         return error;
 666
 667                 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
 668                     && pci_dev->current_state != PCI_UNKNOWN) {
 669                         WARN_ONCE(pci_dev->current_state != prev,
 670                                 "PCI PM: State of device not saved by %pF\n",
 671                                 pm->suspend);
 672                 }
 673         }
 674
 675  Fixup:
 676         pci_fixup_device(pci_fixup_suspend, pci_dev);
 677
 678         return 0;
 679 }
 680
 681 static int pci_pm_suspend_noirq(struct device *dev)
 682 {
 683         struct pci_dev *pci_dev = to_pci_dev(dev);
 684         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
 685
 686         if (pci_has_legacy_pm_support(pci_dev))
 687                 return pci_legacy_suspend_late(dev, PMSG_SUSPEND);
 688
 689         if (!pm) {
 690                 pci_save_state(pci_dev);
 691                 return 0;
 692         }
 693
 694         if (pm->suspend_noirq) {
 695                 pci_power_t prev = pci_dev->current_state;
 696                 int error;
 697
 698                 error = pm->suspend_noirq(dev);
 699                 suspend_report_result(pm->suspend_noirq, error);
 700                 if (error)
 701                         return error;
 702
 703                 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
 704                     && pci_dev->current_state != PCI_UNKNOWN) {
 705                         WARN_ONCE(pci_dev->current_state != prev,
 706                                 "PCI PM: State of device not saved by %pF\n",
 707                                 pm->suspend_noirq);
 708                         return 0;
 709                 }
 710         }
 711
 712         if (!pci_dev->state_saved) {
 713                 pci_save_state(pci_dev);
 714                 if (!pci_is_bridge(pci_dev))
 715                         pci_prepare_to_sleep(pci_dev);
 716         }
 717
 718         pci_pm_set_unknown_state(pci_dev);
 719
 720         /*
 721          * Some BIOSes from ASUS have a bug: If a USB EHCI host controller's
 722          * PCI COMMAND register isn't 0, the BIOS assumes that the controller
 723          * hasn't been quiesced and tries to turn it off.  If the controller
 724          * is already in D3, this can hang or cause memory corruption.
 725          *
 726          * Since the value of the COMMAND register doesn't matter once the
 727          * device has been suspended, we can safely set it to 0 here.
 728          */
 729         if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
 730                 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
 731
 732         return 0;
 733 }
 734
 735 static int pci_pm_resume_noirq(struct device *dev)
 736 {
 737         struct pci_dev *pci_dev = to_pci_dev(dev);
 738         struct device_driver *drv = dev->driver;
 739         int error = 0;
 740
 741         pci_pm_default_resume_early(pci_dev);
 742
 743         if (pci_has_legacy_pm_support(pci_dev))
 744                 return pci_legacy_resume_early(dev);
 745
 746         if (drv && drv->pm && drv->pm->resume_noirq)
 747                 error = drv->pm->resume_noirq(dev);
 748
 749         return error;
 750 }
 751
 752 static int pci_pm_resume(struct device *dev)
 753 {
 754         struct pci_dev *pci_dev = to_pci_dev(dev);
 755         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
 756         int error = 0;
 757
 758         /*
 759          * This is necessary for the suspend error path in which resume is
 760          * called without restoring the standard config registers of the device.
 761          */
 762         if (pci_dev->state_saved)
 763                 pci_restore_standard_config(pci_dev);
 764
 765         if (pci_has_legacy_pm_support(pci_dev))
 766                 return pci_legacy_resume(dev);
 767
 768         pci_pm_default_resume(pci_dev);
 769
 770         if (pm) {
 771                 if (pm->resume)
 772                         error = pm->resume(dev);
 773         } else {
 774                 pci_pm_reenable_device(pci_dev);
 775         }
 776
 777         return error;
 778 }
 779
 780 #else /* !CONFIG_SUSPEND */
 781
 782 #define pci_pm_suspend          NULL
 783 #define pci_pm_suspend_noirq    NULL
 784 #define pci_pm_resume           NULL
 785 #define pci_pm_resume_noirq     NULL
 786
 787 #endif /* !CONFIG_SUSPEND */
 788
 789 #ifdef CONFIG_HIBERNATE_CALLBACKS
 790
 791
 792 /*
 793  * pcibios_pm_ops - provide arch-specific hooks when a PCI device is doing
 794  * a hibernate transition
 795  */
 796 struct dev_pm_ops __weak pcibios_pm_ops;
 797
 798 static int pci_pm_freeze(struct device *dev)
 799 {
 800         struct pci_dev *pci_dev = to_pci_dev(dev);
 801         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
 802
 803         if (pci_has_legacy_pm_support(pci_dev))
 804                 return pci_legacy_suspend(dev, PMSG_FREEZE);
 805
 806         if (!pm) {
 807                 pci_pm_default_suspend(pci_dev);
 808                 return 0;
 809         }
 810
 811         pci_dev->state_saved = false;
 812         if (pm->freeze) {
 813                 int error;
 814
 815                 error = pm->freeze(dev);
 816                 suspend_report_result(pm->freeze, error);
 817                 if (error)
 818                         return error;
 819         }
 820
 821         if (pcibios_pm_ops.freeze)
 822                 return pcibios_pm_ops.freeze(dev);
 823
 824         return 0;
 825 }
 826
 827 static int pci_pm_freeze_noirq(struct device *dev)
 828 {
 829         struct pci_dev *pci_dev = to_pci_dev(dev);
 830         struct device_driver *drv = dev->driver;
 831
 832         if (pci_has_legacy_pm_support(pci_dev))
 833                 return pci_legacy_suspend_late(dev, PMSG_FREEZE);
 834
 835         if (drv && drv->pm && drv->pm->freeze_noirq) {
 836                 int error;
 837
 838                 error = drv->pm->freeze_noirq(dev);
 839                 suspend_report_result(drv->pm->freeze_noirq, error);
 840                 if (error)
 841                         return error;
 842         }
 843
 844         if (!pci_dev->state_saved)
 845                 pci_save_state(pci_dev);
 846
 847         pci_pm_set_unknown_state(pci_dev);
 848
 849         if (pcibios_pm_ops.freeze_noirq)
 850                 return pcibios_pm_ops.freeze_noirq(dev);
 851
 852         return 0;
 853 }
 854
 855 static int pci_pm_thaw_noirq(struct device *dev)
 856 {
 857         struct pci_dev *pci_dev = to_pci_dev(dev);
 858         struct device_driver *drv = dev->driver;
 859         int error = 0;
 860
 861         if (pcibios_pm_ops.thaw_noirq) {
 862                 error = pcibios_pm_ops.thaw_noirq(dev);
 863                 if (error)
 864                         return error;
 865         }
 866
 867         if (pci_has_legacy_pm_support(pci_dev))
 868                 return pci_legacy_resume_early(dev);
 869
 870         pci_update_current_state(pci_dev, PCI_D0);
 871
 872         if (drv && drv->pm && drv->pm->thaw_noirq)
 873                 error = drv->pm->thaw_noirq(dev);
 874
 875         return error;
 876 }
 877
 878 static int pci_pm_thaw(struct device *dev)
 879 {
 880         struct pci_dev *pci_dev = to_pci_dev(dev);
 881         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
 882         int error = 0;
 883
 884         if (pcibios_pm_ops.thaw) {
 885                 error = pcibios_pm_ops.thaw(dev);
 886                 if (error)
 887                         return error;
 888         }
 889
 890         if (pci_has_legacy_pm_support(pci_dev))
 891                 return pci_legacy_resume(dev);
 892
 893         if (pm) {
 894                 if (pm->thaw)
 895                         error = pm->thaw(dev);
 896         } else {
 897                 pci_pm_reenable_device(pci_dev);
 898         }
 899
 900         pci_dev->state_saved = false;
 901
 902         return error;
 903 }
 904
 905 static int pci_pm_poweroff(struct device *dev)
 906 {
 907         struct pci_dev *pci_dev = to_pci_dev(dev);
 908         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
 909
 910         if (pci_has_legacy_pm_support(pci_dev))
 911                 return pci_legacy_suspend(dev, PMSG_HIBERNATE);
 912
 913         if (!pm) {
 914                 pci_pm_default_suspend(pci_dev);
 915                 goto Fixup;
 916         }
 917
 918         pci_dev->state_saved = false;
 919         if (pm->poweroff) {
 920                 int error;
 921
 922                 error = pm->poweroff(dev);
 923                 suspend_report_result(pm->poweroff, error);
 924                 if (error)
 925                         return error;
 926         }
 927
 928  Fixup:
 929         pci_fixup_device(pci_fixup_suspend, pci_dev);
 930
 931         if (pcibios_pm_ops.poweroff)
 932                 return pcibios_pm_ops.poweroff(dev);
 933
 934         return 0;
 935 }
 936
 937 static int pci_pm_poweroff_noirq(struct device *dev)
 938 {
 939         struct pci_dev *pci_dev = to_pci_dev(dev);
 940         struct device_driver *drv = dev->driver;
 941
 942         if (pci_has_legacy_pm_support(to_pci_dev(dev)))
 943                 return pci_legacy_suspend_late(dev, PMSG_HIBERNATE);
 944
 945         if (!drv || !drv->pm)
 946                 return 0;
 947
 948         if (drv->pm->poweroff_noirq) {
 949                 int error;
 950
 951                 error = drv->pm->poweroff_noirq(dev);
 952                 suspend_report_result(drv->pm->poweroff_noirq, error);
 953                 if (error)
 954                         return error;
 955         }
 956
 957         if (!pci_dev->state_saved && !pci_is_bridge(pci_dev))
 958                 pci_prepare_to_sleep(pci_dev);
 959
 960         /*
 961          * The reason for doing this here is the same as for the analogous code
 962          * in pci_pm_suspend_noirq().
 963          */
 964         if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
 965                 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
 966
 967         if (pcibios_pm_ops.poweroff_noirq)
 968                 return pcibios_pm_ops.poweroff_noirq(dev);
 969
 970         return 0;
 971 }
 972
 973 static int pci_pm_restore_noirq(struct device *dev)
 974 {
 975         struct pci_dev *pci_dev = to_pci_dev(dev);
 976         struct device_driver *drv = dev->driver;
 977         int error = 0;
 978
 979         if (pcibios_pm_ops.restore_noirq) {
 980                 error = pcibios_pm_ops.restore_noirq(dev);
 981                 if (error)
 982                         return error;
 983         }
 984
 985         pci_pm_default_resume_early(pci_dev);
 986
 987         if (pci_has_legacy_pm_support(pci_dev))
 988                 return pci_legacy_resume_early(dev);
 989
 990         if (drv && drv->pm && drv->pm->restore_noirq)
 991                 error = drv->pm->restore_noirq(dev);
 992
 993         return error;
 994 }
 995
 996 static int pci_pm_restore(struct device *dev)
 997 {
 998         struct pci_dev *pci_dev = to_pci_dev(dev);
 999         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1000         int error = 0;
1001
1002         if (pcibios_pm_ops.restore) {
1003                 error = pcibios_pm_ops.restore(dev);
1004                 if (error)
1005                         return error;
1006         }
1007
1008         /*
1009          * This is necessary for the hibernation error path in which restore is
1010          * called without restoring the standard config registers of the device.
1011          */
1012         if (pci_dev->state_saved)
1013                 pci_restore_standard_config(pci_dev);
1014
1015         if (pci_has_legacy_pm_support(pci_dev))
1016                 return pci_legacy_resume(dev);
1017
1018         pci_pm_default_resume(pci_dev);
1019
1020         if (pm) {
1021                 if (pm->restore)
1022                         error = pm->restore(dev);
1023         } else {
1024                 pci_pm_reenable_device(pci_dev);
1025         }
1026
1027         return error;
1028 }
1029
1030 #else /* !CONFIG_HIBERNATE_CALLBACKS */
1031
1032 #define pci_pm_freeze           NULL
1033 #define pci_pm_freeze_noirq     NULL
1034 #define pci_pm_thaw             NULL
1035 #define pci_pm_thaw_noirq       NULL
1036 #define pci_pm_poweroff         NULL
1037 #define pci_pm_poweroff_noirq   NULL
1038 #define pci_pm_restore          NULL
1039 #define pci_pm_restore_noirq    NULL
1040
1041 #endif /* !CONFIG_HIBERNATE_CALLBACKS */
1042
1043 #ifdef CONFIG_PM_RUNTIME
1044
1045 static int pci_pm_runtime_suspend(struct device *dev)
1046 {
1047         struct pci_dev *pci_dev = to_pci_dev(dev);
1048         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1049         pci_power_t prev = pci_dev->current_state;
1050         int error;
1051
1052         /*
1053          * If pci_dev->driver is not set (unbound), the device should
1054          * always remain in D0 regardless of the runtime PM status
1055          */
1056         if (!pci_dev->driver)
1057                 return 0;
1058
1059         if (!pm || !pm->runtime_suspend)
1060                 return -ENOSYS;
1061
1062         pci_dev->state_saved = false;
1063         pci_dev->no_d3cold = false;
1064         error = pm->runtime_suspend(dev);
1065         suspend_report_result(pm->runtime_suspend, error);
1066         if (error)
1067                 return error;
1068         if (!pci_dev->d3cold_allowed)
1069                 pci_dev->no_d3cold = true;
1070
1071         pci_fixup_device(pci_fixup_suspend, pci_dev);
1072
1073         if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
1074             && pci_dev->current_state != PCI_UNKNOWN) {
1075                 WARN_ONCE(pci_dev->current_state != prev,
1076                         "PCI PM: State of device not saved by %pF\n",
1077                         pm->runtime_suspend);
1078                 return 0;
1079         }
1080
1081         if (!pci_dev->state_saved) {
1082                 pci_save_state(pci_dev);
1083                 pci_finish_runtime_suspend(pci_dev);
1084         }
1085
1086         return 0;
1087 }
1088
1089 static int pci_pm_runtime_resume(struct device *dev)
1090 {
1091         int rc;
1092         struct pci_dev *pci_dev = to_pci_dev(dev);
1093         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1094
1095         /*
1096          * If pci_dev->driver is not set (unbound), the device should
1097          * always remain in D0 regardless of the runtime PM status
1098          */
1099         if (!pci_dev->driver)
1100                 return 0;
1101
1102         if (!pm || !pm->runtime_resume)
1103                 return -ENOSYS;
1104
1105         pci_restore_standard_config(pci_dev);
1106         pci_fixup_device(pci_fixup_resume_early, pci_dev);
1107         __pci_enable_wake(pci_dev, PCI_D0, true, false);
1108         pci_fixup_device(pci_fixup_resume, pci_dev);
1109
1110         rc = pm->runtime_resume(dev);
1111
1112         pci_dev->runtime_d3cold = false;
1113
1114         return rc;
1115 }
1116
1117 static int pci_pm_runtime_idle(struct device *dev)
1118 {
1119         struct pci_dev *pci_dev = to_pci_dev(dev);
1120         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1121         int ret = 0;
1122
1123         /*
1124          * If pci_dev->driver is not set (unbound), the device should
1125          * always remain in D0 regardless of the runtime PM status
1126          */
1127         if (!pci_dev->driver)
1128                 return 0;
1129
1130         if (!pm)
1131                 return -ENOSYS;
1132
1133         if (pm->runtime_idle)
1134                 ret = pm->runtime_idle(dev);
1135
1136         return ret;
1137 }
1138
1139 #else /* !CONFIG_PM_RUNTIME */
1140
1141 #define pci_pm_runtime_suspend  NULL
1142 #define pci_pm_runtime_resume   NULL
1143 #define pci_pm_runtime_idle     NULL
1144
1145 #endif /* !CONFIG_PM_RUNTIME */
1146
1147 #ifdef CONFIG_PM
1148
1149 static const struct dev_pm_ops pci_dev_pm_ops = {
1150         .prepare = pci_pm_prepare,
1151         .suspend = pci_pm_suspend,
1152         .resume = pci_pm_resume,
1153         .freeze = pci_pm_freeze,
1154         .thaw = pci_pm_thaw,
1155         .poweroff = pci_pm_poweroff,
1156         .restore = pci_pm_restore,
1157         .suspend_noirq = pci_pm_suspend_noirq,
1158         .resume_noirq = pci_pm_resume_noirq,
1159         .freeze_noirq = pci_pm_freeze_noirq,
1160         .thaw_noirq = pci_pm_thaw_noirq,
1161         .poweroff_noirq = pci_pm_poweroff_noirq,
1162         .restore_noirq = pci_pm_restore_noirq,
1163         .runtime_suspend = pci_pm_runtime_suspend,
1164         .runtime_resume = pci_pm_runtime_resume,
1165         .runtime_idle = pci_pm_runtime_idle,
1166 };
1167
1168 #define PCI_PM_OPS_PTR  (&pci_dev_pm_ops)
1169
1170 #else /* !COMFIG_PM_OPS */
1171
1172 #define PCI_PM_OPS_PTR  NULL
1173
1174 #endif /* !COMFIG_PM_OPS */
1175
1176 /**
1177  * __pci_register_driver - register a new pci driver
1178  * @drv: the driver structure to register
1179  * @owner: owner module of drv
1180  * @mod_name: module name string
1181  *
1182  * Adds the driver structure to the list of registered drivers.
1183  * Returns a negative value on error, otherwise 0.
1184  * If no error occurred, the driver remains registered even if
1185  * no device was claimed during registration.
1186  */
1187 int __pci_register_driver(struct pci_driver *drv, struct module *owner,
1188                           const char *mod_name)
1189 {
1190         /* initialize common driver fields */
1191         drv->driver.name = drv->name;
1192         drv->driver.bus = &pci_bus_type;
1193         drv->driver.owner = owner;
1194         drv->driver.mod_name = mod_name;
1195
1196         spin_lock_init(&drv->dynids.lock);
1197         INIT_LIST_HEAD(&drv->dynids.list);
1198
1199         /* register with core */
1200         return driver_register(&drv->driver);
1201 }
1202
1203 /**
1204  * pci_unregister_driver - unregister a pci driver
1205  * @drv: the driver structure to unregister
1206  *
1207  * Deletes the driver structure from the list of registered PCI drivers,
1208  * gives it a chance to clean up by calling its remove() function for
1209  * each device it was responsible for, and marks those devices as
1210  * driverless.
1211  */
1212
1213 void
1214 pci_unregister_driver(struct pci_driver *drv)
1215 {
1216         driver_unregister(&drv->driver);
1217         pci_free_dynids(drv);
1218 }
1219
1220 static struct pci_driver pci_compat_driver = {
1221         .name = "compat"
1222 };
1223
1224 /**
1225  * pci_dev_driver - get the pci_driver of a device
1226  * @dev: the device to query
1227  *
1228  * Returns the appropriate pci_driver structure or %NULL if there is no
1229  * registered driver for the device.
1230  */
1231 struct pci_driver *
1232 pci_dev_driver(const struct pci_dev *dev)
1233 {
1234         if (dev->driver)
1235                 return dev->driver;
1236         else {
1237                 int i;
1238                 for(i=0; i<=PCI_ROM_RESOURCE; i++)
1239                         if (dev->resource[i].flags & IORESOURCE_BUSY)
1240                                 return &pci_compat_driver;
1241         }
1242         return NULL;
1243 }
1244
1245 /**
1246  * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure
1247  * @dev: the PCI device structure to match against
1248  * @drv: the device driver to search for matching PCI device id structures
1249  *
1250  * Used by a driver to check whether a PCI device present in the
1251  * system is in its list of supported devices. Returns the matching
1252  * pci_device_id structure or %NULL if there is no match.
1253  */
1254 static int pci_bus_match(struct device *dev, struct device_driver *drv)
1255 {
1256         struct pci_dev *pci_dev = to_pci_dev(dev);
1257         struct pci_driver *pci_drv;
1258         const struct pci_device_id *found_id;
1259
1260         if (!pci_dev->match_driver)
1261                 return 0;
1262
1263         pci_drv = to_pci_driver(drv);
1264         found_id = pci_match_device(pci_drv, pci_dev);
1265         if (found_id)
1266                 return 1;
1267
1268         return 0;
1269 }
1270
1271 /**
1272  * pci_dev_get - increments the reference count of the pci device structure
1273  * @dev: the device being referenced
1274  *
1275  * Each live reference to a device should be refcounted.
1276  *
1277  * Drivers for PCI devices should normally record such references in
1278  * their probe() methods, when they bind to a device, and release
1279  * them by calling pci_dev_put(), in their disconnect() methods.
1280  *
1281  * A pointer to the device with the incremented reference counter is returned.
1282  */
1283 struct pci_dev *pci_dev_get(struct pci_dev *dev)
1284 {
1285         if (dev)
1286                 get_device(&dev->dev);
1287         return dev;
1288 }
1289
1290 /**
1291  * pci_dev_put - release a use of the pci device structure
1292  * @dev: device that's been disconnected
1293  *
1294  * Must be called when a user of a device is finished with it.  When the last
1295  * user of the device calls this function, the memory of the device is freed.
1296  */
1297 void pci_dev_put(struct pci_dev *dev)
1298 {
1299         if (dev)
1300                 put_device(&dev->dev);
1301 }
1302
1303 static int pci_uevent(struct device *dev, struct kobj_uevent_env *env)
1304 {
1305         struct pci_dev *pdev;
1306
1307         if (!dev)
1308                 return -ENODEV;
1309
1310         pdev = to_pci_dev(dev);
1311         if (!pdev)
1312                 return -ENODEV;
1313
1314         if (add_uevent_var(env, "PCI_CLASS=%04X", pdev->class))
1315                 return -ENOMEM;
1316
1317         if (add_uevent_var(env, "PCI_ID=%04X:%04X", pdev->vendor, pdev->device))
1318                 return -ENOMEM;
1319
1320         if (add_uevent_var(env, "PCI_SUBSYS_ID=%04X:%04X", pdev->subsystem_vendor,
1321                            pdev->subsystem_device))
1322                 return -ENOMEM;
1323
1324         if (add_uevent_var(env, "PCI_SLOT_NAME=%s", pci_name(pdev)))
1325                 return -ENOMEM;
1326
1327         if (add_uevent_var(env, "MODALIAS=pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02x",
1328                            pdev->vendor, pdev->device,
1329                            pdev->subsystem_vendor, pdev->subsystem_device,
1330                            (u8)(pdev->class >> 16), (u8)(pdev->class >> 8),
1331                            (u8)(pdev->class)))
1332                 return -ENOMEM;
1333         return 0;
1334 }
1335
1336 struct bus_type pci_bus_type = {
1337         .name           = "pci",
1338         .match          = pci_bus_match,
1339         .uevent         = pci_uevent,
1340         .probe          = pci_device_probe,
1341         .remove         = pci_device_remove,
1342         .shutdown       = pci_device_shutdown,
1343         .dev_groups     = pci_dev_groups,
1344         .bus_groups     = pci_bus_groups,
1345         .drv_groups     = pci_drv_groups,
1346         .pm             = PCI_PM_OPS_PTR,
1347 };
1348
1349 static int __init pci_driver_init(void)
1350 {
1351         return bus_register(&pci_bus_type);
1352 }
1353
1354 postcore_initcall(pci_driver_init);
1355
1356 EXPORT_SYMBOL_GPL(pci_add_dynid);
1357 EXPORT_SYMBOL(pci_match_id);
1358 EXPORT_SYMBOL(__pci_register_driver);
1359 EXPORT_SYMBOL(pci_unregister_driver);
1360 EXPORT_SYMBOL(pci_dev_driver);
1361 EXPORT_SYMBOL(pci_bus_type);
1362 EXPORT_SYMBOL(pci_dev_get);
1363 EXPORT_SYMBOL(pci_dev_put);