drivers/pci/pci-driver.c

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