drivers/pci/pci-driver.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * (C) Copyright 2002-2004, 2007 Greg Kroah-Hartman <greg@kroah.com>
   4  * (C) Copyright 2007 Novell Inc.
   5  */
   6
   7 #include <linux/pci.h>
   8 #include <linux/module.h>
   9 #include <linux/init.h>
  10 #include <linux/device.h>
  11 #include <linux/mempolicy.h>
  12 #include <linux/string.h>
  13 #include <linux/slab.h>
  14 #include <linux/sched.h>
  15 #include <linux/sched/isolation.h>
  16 #include <linux/cpu.h>
  17 #include <linux/pm_runtime.h>
  18 #include <linux/suspend.h>
  19 #include <linux/kexec.h>
  20 #include <linux/of_device.h>
  21 #include <linux/acpi.h>
  22 #include <linux/dma-map-ops.h>
  23 #include "pci.h"
  24 #include "pcie/portdrv.h"
  25
  26 struct pci_dynid {
  27         struct list_head node;
  28         struct pci_device_id id;
  29 };
  30
  31 /**
  32  * pci_add_dynid - add a new PCI device ID to this driver and re-probe devices
  33  * @drv: target pci driver
  34  * @vendor: PCI vendor ID
  35  * @device: PCI device ID
  36  * @subvendor: PCI subvendor ID
  37  * @subdevice: PCI subdevice ID
  38  * @class: PCI class
  39  * @class_mask: PCI class mask
  40  * @driver_data: private driver data
  41  *
  42  * Adds a new dynamic pci device ID to this driver and causes the
  43  * driver to probe for all devices again.  @drv must have been
  44  * registered prior to calling this function.
  45  *
  46  * CONTEXT:
  47  * Does GFP_KERNEL allocation.
  48  *
  49  * RETURNS:
  50  * 0 on success, -errno on failure.
  51  */
  52 int pci_add_dynid(struct pci_driver *drv,
  53                   unsigned int vendor, unsigned int device,
  54                   unsigned int subvendor, unsigned int subdevice,
  55                   unsigned int class, unsigned int class_mask,
  56                   unsigned long driver_data)
  57 {
  58         struct pci_dynid *dynid;
  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         return driver_attach(&drv->driver);
  77 }
  78 EXPORT_SYMBOL_GPL(pci_add_dynid);
  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  * store_new_id - sysfs frontend to pci_add_dynid()
  94  * @driver: target device driver
  95  * @buf: buffer for scanning device ID data
  96  * @count: input size
  97  *
  98  * Allow PCI IDs to be added to an existing driver via sysfs.
  99  */
 100 static ssize_t new_id_store(struct device_driver *driver, const char *buf,
 101                             size_t count)
 102 {
 103         struct pci_driver *pdrv = to_pci_driver(driver);
 104         const struct pci_device_id *ids = pdrv->id_table;
 105         u32 vendor, device, subvendor = PCI_ANY_ID,
 106                 subdevice = PCI_ANY_ID, class = 0, class_mask = 0;
 107         unsigned long driver_data = 0;
 108         int fields = 0;
 109         int retval = 0;
 110
 111         fields = sscanf(buf, "%x %x %x %x %x %x %lx",
 112                         &vendor, &device, &subvendor, &subdevice,
 113                         &class, &class_mask, &driver_data);
 114         if (fields < 2)
 115                 return -EINVAL;
 116
 117         if (fields != 7) {
 118                 struct pci_dev *pdev = kzalloc(sizeof(*pdev), GFP_KERNEL);
 119                 if (!pdev)
 120                         return -ENOMEM;
 121
 122                 pdev->vendor = vendor;
 123                 pdev->device = device;
 124                 pdev->subsystem_vendor = subvendor;
 125                 pdev->subsystem_device = subdevice;
 126                 pdev->class = class;
 127
 128                 if (pci_match_id(pdrv->id_table, pdev))
 129                         retval = -EEXIST;
 130
 131                 kfree(pdev);
 132
 133                 if (retval)
 134                         return retval;
 135         }
 136
 137         /* Only accept driver_data values that match an existing id_table
 138            entry */
 139         if (ids) {
 140                 retval = -EINVAL;
 141                 while (ids->vendor || ids->subvendor || ids->class_mask) {
 142                         if (driver_data == ids->driver_data) {
 143                                 retval = 0;
 144                                 break;
 145                         }
 146                         ids++;
 147                 }
 148                 if (retval)     /* No match */
 149                         return retval;
 150         }
 151
 152         retval = pci_add_dynid(pdrv, vendor, device, subvendor, subdevice,
 153                                class, class_mask, driver_data);
 154         if (retval)
 155                 return retval;
 156         return count;
 157 }
 158 static DRIVER_ATTR_WO(new_id);
 159
 160 /**
 161  * store_remove_id - remove a PCI device ID from this driver
 162  * @driver: target device driver
 163  * @buf: buffer for scanning device ID data
 164  * @count: input size
 165  *
 166  * Removes a dynamic pci device ID to this driver.
 167  */
 168 static ssize_t remove_id_store(struct device_driver *driver, const char *buf,
 169                                size_t count)
 170 {
 171         struct pci_dynid *dynid, *n;
 172         struct pci_driver *pdrv = to_pci_driver(driver);
 173         u32 vendor, device, subvendor = PCI_ANY_ID,
 174                 subdevice = PCI_ANY_ID, class = 0, class_mask = 0;
 175         int fields = 0;
 176         size_t retval = -ENODEV;
 177
 178         fields = sscanf(buf, "%x %x %x %x %x %x",
 179                         &vendor, &device, &subvendor, &subdevice,
 180                         &class, &class_mask);
 181         if (fields < 2)
 182                 return -EINVAL;
 183
 184         spin_lock(&pdrv->dynids.lock);
 185         list_for_each_entry_safe(dynid, n, &pdrv->dynids.list, node) {
 186                 struct pci_device_id *id = &dynid->id;
 187                 if ((id->vendor == vendor) &&
 188                     (id->device == device) &&
 189                     (subvendor == PCI_ANY_ID || id->subvendor == subvendor) &&
 190                     (subdevice == PCI_ANY_ID || id->subdevice == subdevice) &&
 191                     !((id->class ^ class) & class_mask)) {
 192                         list_del(&dynid->node);
 193                         kfree(dynid);
 194                         retval = count;
 195                         break;
 196                 }
 197         }
 198         spin_unlock(&pdrv->dynids.lock);
 199
 200         return retval;
 201 }
 202 static DRIVER_ATTR_WO(remove_id);
 203
 204 static struct attribute *pci_drv_attrs[] = {
 205         &driver_attr_new_id.attr,
 206         &driver_attr_remove_id.attr,
 207         NULL,
 208 };
 209 ATTRIBUTE_GROUPS(pci_drv);
 210
 211 /**
 212  * pci_match_id - See if a pci device matches a given pci_id table
 213  * @ids: array of PCI device id structures to search in
 214  * @dev: the PCI device structure to match against.
 215  *
 216  * Used by a driver to check whether a PCI device present in the
 217  * system is in its list of supported devices.  Returns the matching
 218  * pci_device_id structure or %NULL if there is no match.
 219  *
 220  * Deprecated, don't use this as it will not catch any dynamic ids
 221  * that a driver might want to check for.
 222  */
 223 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
 224                                          struct pci_dev *dev)
 225 {
 226         if (ids) {
 227                 while (ids->vendor || ids->subvendor || ids->class_mask) {
 228                         if (pci_match_one_device(ids, dev))
 229                                 return ids;
 230                         ids++;
 231                 }
 232         }
 233         return NULL;
 234 }
 235 EXPORT_SYMBOL(pci_match_id);
 236
 237 static const struct pci_device_id pci_device_id_any = {
 238         .vendor = PCI_ANY_ID,
 239         .device = PCI_ANY_ID,
 240         .subvendor = PCI_ANY_ID,
 241         .subdevice = PCI_ANY_ID,
 242 };
 243
 244 /**
 245  * pci_match_device - Tell if a PCI device structure has a matching PCI device id structure
 246  * @drv: the PCI driver to match against
 247  * @dev: the PCI device structure to match against
 248  *
 249  * Used by a driver to check whether a PCI device present in the
 250  * system is in its list of supported devices.  Returns the matching
 251  * pci_device_id structure or %NULL if there is no match.
 252  */
 253 static const struct pci_device_id *pci_match_device(struct pci_driver *drv,
 254                                                     struct pci_dev *dev)
 255 {
 256         struct pci_dynid *dynid;
 257         const struct pci_device_id *found_id = NULL;
 258
 259         /* When driver_override is set, only bind to the matching driver */
 260         if (dev->driver_override && strcmp(dev->driver_override, drv->name))
 261                 return NULL;
 262
 263         /* Look at the dynamic ids first, before the static ones */
 264         spin_lock(&drv->dynids.lock);
 265         list_for_each_entry(dynid, &drv->dynids.list, node) {
 266                 if (pci_match_one_device(&dynid->id, dev)) {
 267                         found_id = &dynid->id;
 268                         break;
 269                 }
 270         }
 271         spin_unlock(&drv->dynids.lock);
 272
 273         if (!found_id)
 274                 found_id = pci_match_id(drv->id_table, dev);
 275
 276         /* driver_override will always match, send a dummy id */
 277         if (!found_id && dev->driver_override)
 278                 found_id = &pci_device_id_any;
 279
 280         return found_id;
 281 }
 282
 283 struct drv_dev_and_id {
 284         struct pci_driver *drv;
 285         struct pci_dev *dev;
 286         const struct pci_device_id *id;
 287 };
 288
 289 static long local_pci_probe(void *_ddi)
 290 {
 291         struct drv_dev_and_id *ddi = _ddi;
 292         struct pci_dev *pci_dev = ddi->dev;
 293         struct pci_driver *pci_drv = ddi->drv;
 294         struct device *dev = &pci_dev->dev;
 295         int rc;
 296
 297         /*
 298          * Unbound PCI devices are always put in D0, regardless of
 299          * runtime PM status.  During probe, the device is set to
 300          * active and the usage count is incremented.  If the driver
 301          * supports runtime PM, it should call pm_runtime_put_noidle(),
 302          * or any other runtime PM helper function decrementing the usage
 303          * count, in its probe routine and pm_runtime_get_noresume() in
 304          * its remove routine.
 305          */
 306         pm_runtime_get_sync(dev);
 307         pci_dev->driver = pci_drv;
 308         rc = pci_drv->probe(pci_dev, ddi->id);
 309         if (!rc)
 310                 return rc;
 311         if (rc < 0) {
 312                 pci_dev->driver = NULL;
 313                 pm_runtime_put_sync(dev);
 314                 return rc;
 315         }
 316         /*
 317          * Probe function should return < 0 for failure, 0 for success
 318          * Treat values > 0 as success, but warn.
 319          */
 320         pci_warn(pci_dev, "Driver probe function unexpectedly returned %d\n",
 321                  rc);
 322         return 0;
 323 }
 324
 325 static bool pci_physfn_is_probed(struct pci_dev *dev)
 326 {
 327 #ifdef CONFIG_PCI_IOV
 328         return dev->is_virtfn && dev->physfn->is_probed;
 329 #else
 330         return false;
 331 #endif
 332 }
 333
 334 static int pci_call_probe(struct pci_driver *drv, struct pci_dev *dev,
 335                           const struct pci_device_id *id)
 336 {
 337         int error, node, cpu;
 338         int hk_flags = HK_FLAG_DOMAIN | HK_FLAG_WQ;
 339         struct drv_dev_and_id ddi = { drv, dev, id };
 340
 341         /*
 342          * Execute driver initialization on node where the device is
 343          * attached.  This way the driver likely allocates its local memory
 344          * on the right node.
 345          */
 346         node = dev_to_node(&dev->dev);
 347         dev->is_probed = 1;
 348
 349         cpu_hotplug_disable();
 350
 351         /*
 352          * Prevent nesting work_on_cpu() for the case where a Virtual Function
 353          * device is probed from work_on_cpu() of the Physical device.
 354          */
 355         if (node < 0 || node >= MAX_NUMNODES || !node_online(node) ||
 356             pci_physfn_is_probed(dev))
 357                 cpu = nr_cpu_ids;
 358         else
 359                 cpu = cpumask_any_and(cpumask_of_node(node),
 360                                       housekeeping_cpumask(hk_flags));
 361
 362         if (cpu < nr_cpu_ids)
 363                 error = work_on_cpu(cpu, local_pci_probe, &ddi);
 364         else
 365                 error = local_pci_probe(&ddi);
 366
 367         dev->is_probed = 0;
 368         cpu_hotplug_enable();
 369         return error;
 370 }
 371
 372 /**
 373  * __pci_device_probe - check if a driver wants to claim a specific PCI device
 374  * @drv: driver to call to check if it wants the PCI device
 375  * @pci_dev: PCI device being probed
 376  *
 377  * returns 0 on success, else error.
 378  * side-effect: pci_dev->driver is set to drv when drv claims pci_dev.
 379  */
 380 static int __pci_device_probe(struct pci_driver *drv, struct pci_dev *pci_dev)
 381 {
 382         const struct pci_device_id *id;
 383         int error = 0;
 384
 385         if (!pci_dev->driver && drv->probe) {
 386                 error = -ENODEV;
 387
 388                 id = pci_match_device(drv, pci_dev);
 389                 if (id)
 390                         error = pci_call_probe(drv, pci_dev, id);
 391         }
 392         return error;
 393 }
 394
 395 int __weak pcibios_alloc_irq(struct pci_dev *dev)
 396 {
 397         return 0;
 398 }
 399
 400 void __weak pcibios_free_irq(struct pci_dev *dev)
 401 {
 402 }
 403
 404 #ifdef CONFIG_PCI_IOV
 405 static inline bool pci_device_can_probe(struct pci_dev *pdev)
 406 {
 407         return (!pdev->is_virtfn || pdev->physfn->sriov->drivers_autoprobe ||
 408                 pdev->driver_override);
 409 }
 410 #else
 411 static inline bool pci_device_can_probe(struct pci_dev *pdev)
 412 {
 413         return true;
 414 }
 415 #endif
 416
 417 static int pci_device_probe(struct device *dev)
 418 {
 419         int error;
 420         struct pci_dev *pci_dev = to_pci_dev(dev);
 421         struct pci_driver *drv = to_pci_driver(dev->driver);
 422
 423         if (!pci_device_can_probe(pci_dev))
 424                 return -ENODEV;
 425
 426         pci_assign_irq(pci_dev);
 427
 428         error = pcibios_alloc_irq(pci_dev);
 429         if (error < 0)
 430                 return error;
 431
 432         pci_dev_get(pci_dev);
 433         error = __pci_device_probe(drv, pci_dev);
 434         if (error) {
 435                 pcibios_free_irq(pci_dev);
 436                 pci_dev_put(pci_dev);
 437         }
 438
 439         return error;
 440 }
 441
 442 static int pci_device_remove(struct device *dev)
 443 {
 444         struct pci_dev *pci_dev = to_pci_dev(dev);
 445         struct pci_driver *drv = pci_dev->driver;
 446
 447         if (drv) {
 448                 if (drv->remove) {
 449                         pm_runtime_get_sync(dev);
 450                         drv->remove(pci_dev);
 451                         pm_runtime_put_noidle(dev);
 452                 }
 453                 pcibios_free_irq(pci_dev);
 454                 pci_dev->driver = NULL;
 455                 pci_iov_remove(pci_dev);
 456         }
 457
 458         /* Undo the runtime PM settings in local_pci_probe() */
 459         pm_runtime_put_sync(dev);
 460
 461         /*
 462          * If the device is still on, set the power state as "unknown",
 463          * since it might change by the next time we load the driver.
 464          */
 465         if (pci_dev->current_state == PCI_D0)
 466                 pci_dev->current_state = PCI_UNKNOWN;
 467
 468         /*
 469          * We would love to complain here if pci_dev->is_enabled is set, that
 470          * the driver should have called pci_disable_device(), but the
 471          * unfortunate fact is there are too many odd BIOS and bridge setups
 472          * that don't like drivers doing that all of the time.
 473          * Oh well, we can dream of sane hardware when we sleep, no matter how
 474          * horrible the crap we have to deal with is when we are awake...
 475          */
 476
 477         pci_dev_put(pci_dev);
 478         return 0;
 479 }
 480
 481 static void pci_device_shutdown(struct device *dev)
 482 {
 483         struct pci_dev *pci_dev = to_pci_dev(dev);
 484         struct pci_driver *drv = pci_dev->driver;
 485
 486         pm_runtime_resume(dev);
 487
 488         if (drv && drv->shutdown)
 489                 drv->shutdown(pci_dev);
 490
 491         /*
 492          * If this is a kexec reboot, turn off Bus Master bit on the
 493          * device to tell it to not continue to do DMA. Don't touch
 494          * devices in D3cold or unknown states.
 495          * If it is not a kexec reboot, firmware will hit the PCI
 496          * devices with big hammer and stop their DMA any way.
 497          */
 498         if (kexec_in_progress && (pci_dev->current_state <= PCI_D3hot))
 499                 pci_clear_master(pci_dev);
 500 }
 501
 502 #ifdef CONFIG_PM
 503
 504 /* Auxiliary functions used for system resume and run-time resume. */
 505
 506 /**
 507  * pci_restore_standard_config - restore standard config registers of PCI device
 508  * @pci_dev: PCI device to handle
 509  */
 510 static int pci_restore_standard_config(struct pci_dev *pci_dev)
 511 {
 512         pci_update_current_state(pci_dev, PCI_UNKNOWN);
 513
 514         if (pci_dev->current_state != PCI_D0) {
 515                 int error = pci_set_power_state(pci_dev, PCI_D0);
 516                 if (error)
 517                         return error;
 518         }
 519
 520         pci_restore_state(pci_dev);
 521         pci_pme_restore(pci_dev);
 522         return 0;
 523 }
 524
 525 static void pci_pm_default_resume(struct pci_dev *pci_dev)
 526 {
 527         pci_fixup_device(pci_fixup_resume, pci_dev);
 528         pci_enable_wake(pci_dev, PCI_D0, false);
 529 }
 530
 531 #endif
 532
 533 #ifdef CONFIG_PM_SLEEP
 534
 535 static void pci_pm_default_resume_early(struct pci_dev *pci_dev)
 536 {
 537         pci_power_up(pci_dev);
 538         pci_update_current_state(pci_dev, PCI_D0);
 539         pci_restore_state(pci_dev);
 540         pci_pme_restore(pci_dev);
 541 }
 542
 543 /*
 544  * Default "suspend" method for devices that have no driver provided suspend,
 545  * or not even a driver at all (second part).
 546  */
 547 static void pci_pm_set_unknown_state(struct pci_dev *pci_dev)
 548 {
 549         /*
 550          * mark its power state as "unknown", since we don't know if
 551          * e.g. the BIOS will change its device state when we suspend.
 552          */
 553         if (pci_dev->current_state == PCI_D0)
 554                 pci_dev->current_state = PCI_UNKNOWN;
 555 }
 556
 557 /*
 558  * Default "resume" method for devices that have no driver provided resume,
 559  * or not even a driver at all (second part).
 560  */
 561 static int pci_pm_reenable_device(struct pci_dev *pci_dev)
 562 {
 563         int retval;
 564
 565         /* if the device was enabled before suspend, reenable */
 566         retval = pci_reenable_device(pci_dev);
 567         /*
 568          * if the device was busmaster before the suspend, make it busmaster
 569          * again
 570          */
 571         if (pci_dev->is_busmaster)
 572                 pci_set_master(pci_dev);
 573
 574         return retval;
 575 }
 576
 577 static int pci_legacy_suspend(struct device *dev, pm_message_t state)
 578 {
 579         struct pci_dev *pci_dev = to_pci_dev(dev);
 580         struct pci_driver *drv = pci_dev->driver;
 581
 582         if (drv && drv->suspend) {
 583                 pci_power_t prev = pci_dev->current_state;
 584                 int error;
 585
 586                 error = drv->suspend(pci_dev, state);
 587                 suspend_report_result(drv->suspend, error);
 588                 if (error)
 589                         return error;
 590
 591                 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
 592                     && pci_dev->current_state != PCI_UNKNOWN) {
 593                         pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev,
 594                                       "PCI PM: Device state not saved by %pS\n",
 595                                       drv->suspend);
 596                 }
 597         }
 598
 599         pci_fixup_device(pci_fixup_suspend, pci_dev);
 600
 601         return 0;
 602 }
 603
 604 static int pci_legacy_suspend_late(struct device *dev, pm_message_t state)
 605 {
 606         struct pci_dev *pci_dev = to_pci_dev(dev);
 607
 608         if (!pci_dev->state_saved)
 609                 pci_save_state(pci_dev);
 610
 611         pci_pm_set_unknown_state(pci_dev);
 612
 613         pci_fixup_device(pci_fixup_suspend_late, pci_dev);
 614
 615         return 0;
 616 }
 617
 618 static int pci_legacy_resume(struct device *dev)
 619 {
 620         struct pci_dev *pci_dev = to_pci_dev(dev);
 621         struct pci_driver *drv = pci_dev->driver;
 622
 623         pci_fixup_device(pci_fixup_resume, pci_dev);
 624
 625         return drv && drv->resume ?
 626                         drv->resume(pci_dev) : pci_pm_reenable_device(pci_dev);
 627 }
 628
 629 /* Auxiliary functions used by the new power management framework */
 630
 631 static void pci_pm_default_suspend(struct pci_dev *pci_dev)
 632 {
 633         /* Disable non-bridge devices without PM support */
 634         if (!pci_has_subordinate(pci_dev))
 635                 pci_disable_enabled_device(pci_dev);
 636 }
 637
 638 static bool pci_has_legacy_pm_support(struct pci_dev *pci_dev)
 639 {
 640         struct pci_driver *drv = pci_dev->driver;
 641         bool ret = drv && (drv->suspend || drv->resume);
 642
 643         /*
 644          * Legacy PM support is used by default, so warn if the new framework is
 645          * supported as well.  Drivers are supposed to support either the
 646          * former, or the latter, but not both at the same time.
 647          */
 648         pci_WARN(pci_dev, ret && drv->driver.pm, "device %04x:%04x\n",
 649                  pci_dev->vendor, pci_dev->device);
 650
 651         return ret;
 652 }
 653
 654 /* New power management framework */
 655
 656 static int pci_pm_prepare(struct device *dev)
 657 {
 658         struct pci_dev *pci_dev = to_pci_dev(dev);
 659         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
 660
 661         if (pm && pm->prepare) {
 662                 int error = pm->prepare(dev);
 663                 if (error < 0)
 664                         return error;
 665
 666                 if (!error && dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_PREPARE))
 667                         return 0;
 668         }
 669         if (pci_dev_need_resume(pci_dev))
 670                 return 0;
 671
 672         /*
 673          * The PME setting needs to be adjusted here in case the direct-complete
 674          * optimization is used with respect to this device.
 675          */
 676         pci_dev_adjust_pme(pci_dev);
 677         return 1;
 678 }
 679
 680 static void pci_pm_complete(struct device *dev)
 681 {
 682         struct pci_dev *pci_dev = to_pci_dev(dev);
 683
 684         pci_dev_complete_resume(pci_dev);
 685         pm_generic_complete(dev);
 686
 687         /* Resume device if platform firmware has put it in reset-power-on */
 688         if (pm_runtime_suspended(dev) && pm_resume_via_firmware()) {
 689                 pci_power_t pre_sleep_state = pci_dev->current_state;
 690
 691                 pci_refresh_power_state(pci_dev);
 692                 /*
 693                  * On platforms with ACPI this check may also trigger for
 694                  * devices sharing power resources if one of those power
 695                  * resources has been activated as a result of a change of the
 696                  * power state of another device sharing it.  However, in that
 697                  * case it is also better to resume the device, in general.
 698                  */
 699                 if (pci_dev->current_state < pre_sleep_state)
 700                         pm_request_resume(dev);
 701         }
 702 }
 703
 704 #else /* !CONFIG_PM_SLEEP */
 705
 706 #define pci_pm_prepare  NULL
 707 #define pci_pm_complete NULL
 708
 709 #endif /* !CONFIG_PM_SLEEP */
 710
 711 #ifdef CONFIG_SUSPEND
 712 static void pcie_pme_root_status_cleanup(struct pci_dev *pci_dev)
 713 {
 714         /*
 715          * Some BIOSes forget to clear Root PME Status bits after system
 716          * wakeup, which breaks ACPI-based runtime wakeup on PCI Express.
 717          * Clear those bits now just in case (shouldn't hurt).
 718          */
 719         if (pci_is_pcie(pci_dev) &&
 720             (pci_pcie_type(pci_dev) == PCI_EXP_TYPE_ROOT_PORT ||
 721              pci_pcie_type(pci_dev) == PCI_EXP_TYPE_RC_EC))
 722                 pcie_clear_root_pme_status(pci_dev);
 723 }
 724
 725 static int pci_pm_suspend(struct device *dev)
 726 {
 727         struct pci_dev *pci_dev = to_pci_dev(dev);
 728         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
 729
 730         pci_dev->skip_bus_pm = false;
 731
 732         if (pci_has_legacy_pm_support(pci_dev))
 733                 return pci_legacy_suspend(dev, PMSG_SUSPEND);
 734
 735         if (!pm) {
 736                 pci_pm_default_suspend(pci_dev);
 737                 return 0;
 738         }
 739
 740         /*
 741          * PCI devices suspended at run time may need to be resumed at this
 742          * point, because in general it may be necessary to reconfigure them for
 743          * system suspend.  Namely, if the device is expected to wake up the
 744          * system from the sleep state, it may have to be reconfigured for this
 745          * purpose, or if the device is not expected to wake up the system from
 746          * the sleep state, it should be prevented from signaling wakeup events
 747          * going forward.
 748          *
 749          * Also if the driver of the device does not indicate that its system
 750          * suspend callbacks can cope with runtime-suspended devices, it is
 751          * better to resume the device from runtime suspend here.
 752          */
 753         if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
 754             pci_dev_need_resume(pci_dev)) {
 755                 pm_runtime_resume(dev);
 756                 pci_dev->state_saved = false;
 757         } else {
 758                 pci_dev_adjust_pme(pci_dev);
 759         }
 760
 761         if (pm->suspend) {
 762                 pci_power_t prev = pci_dev->current_state;
 763                 int error;
 764
 765                 error = pm->suspend(dev);
 766                 suspend_report_result(pm->suspend, error);
 767                 if (error)
 768                         return error;
 769
 770                 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
 771                     && pci_dev->current_state != PCI_UNKNOWN) {
 772                         pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev,
 773                                       "PCI PM: State of device not saved by %pS\n",
 774                                       pm->suspend);
 775                 }
 776         }
 777
 778         return 0;
 779 }
 780
 781 static int pci_pm_suspend_late(struct device *dev)
 782 {
 783         if (dev_pm_skip_suspend(dev))
 784                 return 0;
 785
 786         pci_fixup_device(pci_fixup_suspend, to_pci_dev(dev));
 787
 788         return pm_generic_suspend_late(dev);
 789 }
 790
 791 static int pci_pm_suspend_noirq(struct device *dev)
 792 {
 793         struct pci_dev *pci_dev = to_pci_dev(dev);
 794         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
 795
 796         if (dev_pm_skip_suspend(dev))
 797                 return 0;
 798
 799         if (pci_has_legacy_pm_support(pci_dev))
 800                 return pci_legacy_suspend_late(dev, PMSG_SUSPEND);
 801
 802         if (!pm) {
 803                 pci_save_state(pci_dev);
 804                 goto Fixup;
 805         }
 806
 807         if (pm->suspend_noirq) {
 808                 pci_power_t prev = pci_dev->current_state;
 809                 int error;
 810
 811                 error = pm->suspend_noirq(dev);
 812                 suspend_report_result(pm->suspend_noirq, error);
 813                 if (error)
 814                         return error;
 815
 816                 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
 817                     && pci_dev->current_state != PCI_UNKNOWN) {
 818                         pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev,
 819                                       "PCI PM: State of device not saved by %pS\n",
 820                                       pm->suspend_noirq);
 821                         goto Fixup;
 822                 }
 823         }
 824
 825         if (pci_dev->skip_bus_pm) {
 826                 /*
 827                  * Either the device is a bridge with a child in D0 below it, or
 828                  * the function is running for the second time in a row without
 829                  * going through full resume, which is possible only during
 830                  * suspend-to-idle in a spurious wakeup case.  The device should
 831                  * be in D0 at this point, but if it is a bridge, it may be
 832                  * necessary to save its state.
 833                  */
 834                 if (!pci_dev->state_saved)
 835                         pci_save_state(pci_dev);
 836         } else if (!pci_dev->state_saved) {
 837                 pci_save_state(pci_dev);
 838                 if (pci_power_manageable(pci_dev))
 839                         pci_prepare_to_sleep(pci_dev);
 840         }
 841
 842         pci_dbg(pci_dev, "PCI PM: Suspend power state: %s\n",
 843                 pci_power_name(pci_dev->current_state));
 844
 845         if (pci_dev->current_state == PCI_D0) {
 846                 pci_dev->skip_bus_pm = true;
 847                 /*
 848                  * Per PCI PM r1.2, table 6-1, a bridge must be in D0 if any
 849                  * downstream device is in D0, so avoid changing the power state
 850                  * of the parent bridge by setting the skip_bus_pm flag for it.
 851                  */
 852                 if (pci_dev->bus->self)
 853                         pci_dev->bus->self->skip_bus_pm = true;
 854         }
 855
 856         if (pci_dev->skip_bus_pm && pm_suspend_no_platform()) {
 857                 pci_dbg(pci_dev, "PCI PM: Skipped\n");
 858                 goto Fixup;
 859         }
 860
 861         pci_pm_set_unknown_state(pci_dev);
 862
 863         /*
 864          * Some BIOSes from ASUS have a bug: If a USB EHCI host controller's
 865          * PCI COMMAND register isn't 0, the BIOS assumes that the controller
 866          * hasn't been quiesced and tries to turn it off.  If the controller
 867          * is already in D3, this can hang or cause memory corruption.
 868          *
 869          * Since the value of the COMMAND register doesn't matter once the
 870          * device has been suspended, we can safely set it to 0 here.
 871          */
 872         if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
 873                 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
 874
 875 Fixup:
 876         pci_fixup_device(pci_fixup_suspend_late, pci_dev);
 877
 878         /*
 879          * If the target system sleep state is suspend-to-idle, it is sufficient
 880          * to check whether or not the device's wakeup settings are good for
 881          * runtime PM.  Otherwise, the pm_resume_via_firmware() check will cause
 882          * pci_pm_complete() to take care of fixing up the device's state
 883          * anyway, if need be.
 884          */
 885         if (device_can_wakeup(dev) && !device_may_wakeup(dev))
 886                 dev->power.may_skip_resume = false;
 887
 888         return 0;
 889 }
 890
 891 static int pci_pm_resume_noirq(struct device *dev)
 892 {
 893         struct pci_dev *pci_dev = to_pci_dev(dev);
 894         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
 895         pci_power_t prev_state = pci_dev->current_state;
 896         bool skip_bus_pm = pci_dev->skip_bus_pm;
 897
 898         if (dev_pm_skip_resume(dev))
 899                 return 0;
 900
 901         /*
 902          * In the suspend-to-idle case, devices left in D0 during suspend will
 903          * stay in D0, so it is not necessary to restore or update their
 904          * configuration here and attempting to put them into D0 again is
 905          * pointless, so avoid doing that.
 906          */
 907         if (!(skip_bus_pm && pm_suspend_no_platform()))
 908                 pci_pm_default_resume_early(pci_dev);
 909
 910         pci_fixup_device(pci_fixup_resume_early, pci_dev);
 911         pcie_pme_root_status_cleanup(pci_dev);
 912
 913         if (!skip_bus_pm && prev_state == PCI_D3cold)
 914                 pci_bridge_wait_for_secondary_bus(pci_dev);
 915
 916         if (pci_has_legacy_pm_support(pci_dev))
 917                 return 0;
 918
 919         if (pm && pm->resume_noirq)
 920                 return pm->resume_noirq(dev);
 921
 922         return 0;
 923 }
 924
 925 static int pci_pm_resume_early(struct device *dev)
 926 {
 927         if (dev_pm_skip_resume(dev))
 928                 return 0;
 929
 930         return pm_generic_resume_early(dev);
 931 }
 932
 933 static int pci_pm_resume(struct device *dev)
 934 {
 935         struct pci_dev *pci_dev = to_pci_dev(dev);
 936         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
 937
 938         /*
 939          * This is necessary for the suspend error path in which resume is
 940          * called without restoring the standard config registers of the device.
 941          */
 942         if (pci_dev->state_saved)
 943                 pci_restore_standard_config(pci_dev);
 944
 945         if (pci_has_legacy_pm_support(pci_dev))
 946                 return pci_legacy_resume(dev);
 947
 948         pci_pm_default_resume(pci_dev);
 949
 950         if (pm) {
 951                 if (pm->resume)
 952                         return pm->resume(dev);
 953         } else {
 954                 pci_pm_reenable_device(pci_dev);
 955         }
 956
 957         return 0;
 958 }
 959
 960 #else /* !CONFIG_SUSPEND */
 961
 962 #define pci_pm_suspend          NULL
 963 #define pci_pm_suspend_late     NULL
 964 #define pci_pm_suspend_noirq    NULL
 965 #define pci_pm_resume           NULL
 966 #define pci_pm_resume_early     NULL
 967 #define pci_pm_resume_noirq     NULL
 968
 969 #endif /* !CONFIG_SUSPEND */
 970
 971 #ifdef CONFIG_HIBERNATE_CALLBACKS
 972
 973 /*
 974  * pcibios_pm_ops - provide arch-specific hooks when a PCI device is doing
 975  * a hibernate transition
 976  */
 977 struct dev_pm_ops __weak pcibios_pm_ops;
 978
 979 static int pci_pm_freeze(struct device *dev)
 980 {
 981         struct pci_dev *pci_dev = to_pci_dev(dev);
 982         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
 983
 984         if (pci_has_legacy_pm_support(pci_dev))
 985                 return pci_legacy_suspend(dev, PMSG_FREEZE);
 986
 987         if (!pm) {
 988                 pci_pm_default_suspend(pci_dev);
 989                 return 0;
 990         }
 991
 992         /*
 993          * Resume all runtime-suspended devices before creating a snapshot
 994          * image of system memory, because the restore kernel generally cannot
 995          * be expected to always handle them consistently and they need to be
 996          * put into the runtime-active metastate during system resume anyway,
 997          * so it is better to ensure that the state saved in the image will be
 998          * always consistent with that.
 999          */
1000         pm_runtime_resume(dev);
1001         pci_dev->state_saved = false;
1002
1003         if (pm->freeze) {
1004                 int error;
1005
1006                 error = pm->freeze(dev);
1007                 suspend_report_result(pm->freeze, error);
1008                 if (error)
1009                         return error;
1010         }
1011
1012         return 0;
1013 }
1014
1015 static int pci_pm_freeze_noirq(struct device *dev)
1016 {
1017         struct pci_dev *pci_dev = to_pci_dev(dev);
1018         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1019
1020         if (pci_has_legacy_pm_support(pci_dev))
1021                 return pci_legacy_suspend_late(dev, PMSG_FREEZE);
1022
1023         if (pm && pm->freeze_noirq) {
1024                 int error;
1025
1026                 error = pm->freeze_noirq(dev);
1027                 suspend_report_result(pm->freeze_noirq, error);
1028                 if (error)
1029                         return error;
1030         }
1031
1032         if (!pci_dev->state_saved)
1033                 pci_save_state(pci_dev);
1034
1035         pci_pm_set_unknown_state(pci_dev);
1036
1037         if (pcibios_pm_ops.freeze_noirq)
1038                 return pcibios_pm_ops.freeze_noirq(dev);
1039
1040         return 0;
1041 }
1042
1043 static int pci_pm_thaw_noirq(struct device *dev)
1044 {
1045         struct pci_dev *pci_dev = to_pci_dev(dev);
1046         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1047         int error;
1048
1049         if (pcibios_pm_ops.thaw_noirq) {
1050                 error = pcibios_pm_ops.thaw_noirq(dev);
1051                 if (error)
1052                         return error;
1053         }
1054
1055         /*
1056          * The pm->thaw_noirq() callback assumes the device has been
1057          * returned to D0 and its config state has been restored.
1058          *
1059          * In addition, pci_restore_state() restores MSI-X state in MMIO
1060          * space, which requires the device to be in D0, so return it to D0
1061          * in case the driver's "freeze" callbacks put it into a low-power
1062          * state.
1063          */
1064         pci_set_power_state(pci_dev, PCI_D0);
1065         pci_restore_state(pci_dev);
1066
1067         if (pci_has_legacy_pm_support(pci_dev))
1068                 return 0;
1069
1070         if (pm && pm->thaw_noirq)
1071                 return pm->thaw_noirq(dev);
1072
1073         return 0;
1074 }
1075
1076 static int pci_pm_thaw(struct device *dev)
1077 {
1078         struct pci_dev *pci_dev = to_pci_dev(dev);
1079         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1080         int error = 0;
1081
1082         if (pci_has_legacy_pm_support(pci_dev))
1083                 return pci_legacy_resume(dev);
1084
1085         if (pm) {
1086                 if (pm->thaw)
1087                         error = pm->thaw(dev);
1088         } else {
1089                 pci_pm_reenable_device(pci_dev);
1090         }
1091
1092         pci_dev->state_saved = false;
1093
1094         return error;
1095 }
1096
1097 static int pci_pm_poweroff(struct device *dev)
1098 {
1099         struct pci_dev *pci_dev = to_pci_dev(dev);
1100         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1101
1102         if (pci_has_legacy_pm_support(pci_dev))
1103                 return pci_legacy_suspend(dev, PMSG_HIBERNATE);
1104
1105         if (!pm) {
1106                 pci_pm_default_suspend(pci_dev);
1107                 return 0;
1108         }
1109
1110         /* The reason to do that is the same as in pci_pm_suspend(). */
1111         if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
1112             pci_dev_need_resume(pci_dev)) {
1113                 pm_runtime_resume(dev);
1114                 pci_dev->state_saved = false;
1115         } else {
1116                 pci_dev_adjust_pme(pci_dev);
1117         }
1118
1119         if (pm->poweroff) {
1120                 int error;
1121
1122                 error = pm->poweroff(dev);
1123                 suspend_report_result(pm->poweroff, error);
1124                 if (error)
1125                         return error;
1126         }
1127
1128         return 0;
1129 }
1130
1131 static int pci_pm_poweroff_late(struct device *dev)
1132 {
1133         if (dev_pm_skip_suspend(dev))
1134                 return 0;
1135
1136         pci_fixup_device(pci_fixup_suspend, to_pci_dev(dev));
1137
1138         return pm_generic_poweroff_late(dev);
1139 }
1140
1141 static int pci_pm_poweroff_noirq(struct device *dev)
1142 {
1143         struct pci_dev *pci_dev = to_pci_dev(dev);
1144         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1145
1146         if (dev_pm_skip_suspend(dev))
1147                 return 0;
1148
1149         if (pci_has_legacy_pm_support(pci_dev))
1150                 return pci_legacy_suspend_late(dev, PMSG_HIBERNATE);
1151
1152         if (!pm) {
1153                 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1154                 return 0;
1155         }
1156
1157         if (pm->poweroff_noirq) {
1158                 int error;
1159
1160                 error = pm->poweroff_noirq(dev);
1161                 suspend_report_result(pm->poweroff_noirq, error);
1162                 if (error)
1163                         return error;
1164         }
1165
1166         if (!pci_dev->state_saved && !pci_has_subordinate(pci_dev))
1167                 pci_prepare_to_sleep(pci_dev);
1168
1169         /*
1170          * The reason for doing this here is the same as for the analogous code
1171          * in pci_pm_suspend_noirq().
1172          */
1173         if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
1174                 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
1175
1176         pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1177
1178         if (pcibios_pm_ops.poweroff_noirq)
1179                 return pcibios_pm_ops.poweroff_noirq(dev);
1180
1181         return 0;
1182 }
1183
1184 static int pci_pm_restore_noirq(struct device *dev)
1185 {
1186         struct pci_dev *pci_dev = to_pci_dev(dev);
1187         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1188         int error;
1189
1190         if (pcibios_pm_ops.restore_noirq) {
1191                 error = pcibios_pm_ops.restore_noirq(dev);
1192                 if (error)
1193                         return error;
1194         }
1195
1196         pci_pm_default_resume_early(pci_dev);
1197         pci_fixup_device(pci_fixup_resume_early, pci_dev);
1198
1199         if (pci_has_legacy_pm_support(pci_dev))
1200                 return 0;
1201
1202         if (pm && pm->restore_noirq)
1203                 return pm->restore_noirq(dev);
1204
1205         return 0;
1206 }
1207
1208 static int pci_pm_restore(struct device *dev)
1209 {
1210         struct pci_dev *pci_dev = to_pci_dev(dev);
1211         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1212
1213         /*
1214          * This is necessary for the hibernation error path in which restore is
1215          * called without restoring the standard config registers of the device.
1216          */
1217         if (pci_dev->state_saved)
1218                 pci_restore_standard_config(pci_dev);
1219
1220         if (pci_has_legacy_pm_support(pci_dev))
1221                 return pci_legacy_resume(dev);
1222
1223         pci_pm_default_resume(pci_dev);
1224
1225         if (pm) {
1226                 if (pm->restore)
1227                         return pm->restore(dev);
1228         } else {
1229                 pci_pm_reenable_device(pci_dev);
1230         }
1231
1232         return 0;
1233 }
1234
1235 #else /* !CONFIG_HIBERNATE_CALLBACKS */
1236
1237 #define pci_pm_freeze           NULL
1238 #define pci_pm_freeze_noirq     NULL
1239 #define pci_pm_thaw             NULL
1240 #define pci_pm_thaw_noirq       NULL
1241 #define pci_pm_poweroff         NULL
1242 #define pci_pm_poweroff_late    NULL
1243 #define pci_pm_poweroff_noirq   NULL
1244 #define pci_pm_restore          NULL
1245 #define pci_pm_restore_noirq    NULL
1246
1247 #endif /* !CONFIG_HIBERNATE_CALLBACKS */
1248
1249 #ifdef CONFIG_PM
1250
1251 static int pci_pm_runtime_suspend(struct device *dev)
1252 {
1253         struct pci_dev *pci_dev = to_pci_dev(dev);
1254         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1255         pci_power_t prev = pci_dev->current_state;
1256         int error;
1257
1258         /*
1259          * If pci_dev->driver is not set (unbound), we leave the device in D0,
1260          * but it may go to D3cold when the bridge above it runtime suspends.
1261          * Save its config space in case that happens.
1262          */
1263         if (!pci_dev->driver) {
1264                 pci_save_state(pci_dev);
1265                 return 0;
1266         }
1267
1268         pci_dev->state_saved = false;
1269         if (pm && pm->runtime_suspend) {
1270                 error = pm->runtime_suspend(dev);
1271                 /*
1272                  * -EBUSY and -EAGAIN is used to request the runtime PM core
1273                  * to schedule a new suspend, so log the event only with debug
1274                  * log level.
1275                  */
1276                 if (error == -EBUSY || error == -EAGAIN) {
1277                         pci_dbg(pci_dev, "can't suspend now (%ps returned %d)\n",
1278                                 pm->runtime_suspend, error);
1279                         return error;
1280                 } else if (error) {
1281                         pci_err(pci_dev, "can't suspend (%ps returned %d)\n",
1282                                 pm->runtime_suspend, error);
1283                         return error;
1284                 }
1285         }
1286
1287         pci_fixup_device(pci_fixup_suspend, pci_dev);
1288
1289         if (pm && pm->runtime_suspend
1290             && !pci_dev->state_saved && pci_dev->current_state != PCI_D0
1291             && pci_dev->current_state != PCI_UNKNOWN) {
1292                 pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev,
1293                               "PCI PM: State of device not saved by %pS\n",
1294                               pm->runtime_suspend);
1295                 return 0;
1296         }
1297
1298         if (!pci_dev->state_saved) {
1299                 pci_save_state(pci_dev);
1300                 pci_finish_runtime_suspend(pci_dev);
1301         }
1302
1303         return 0;
1304 }
1305
1306 static int pci_pm_runtime_resume(struct device *dev)
1307 {
1308         struct pci_dev *pci_dev = to_pci_dev(dev);
1309         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1310         pci_power_t prev_state = pci_dev->current_state;
1311         int error = 0;
1312
1313         /*
1314          * Restoring config space is necessary even if the device is not bound
1315          * to a driver because although we left it in D0, it may have gone to
1316          * D3cold when the bridge above it runtime suspended.
1317          */
1318         pci_restore_standard_config(pci_dev);
1319
1320         if (!pci_dev->driver)
1321                 return 0;
1322
1323         pci_fixup_device(pci_fixup_resume_early, pci_dev);
1324         pci_pm_default_resume(pci_dev);
1325
1326         if (prev_state == PCI_D3cold)
1327                 pci_bridge_wait_for_secondary_bus(pci_dev);
1328
1329         if (pm && pm->runtime_resume)
1330                 error = pm->runtime_resume(dev);
1331
1332         pci_dev->runtime_d3cold = false;
1333
1334         return error;
1335 }
1336
1337 static int pci_pm_runtime_idle(struct device *dev)
1338 {
1339         struct pci_dev *pci_dev = to_pci_dev(dev);
1340         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1341
1342         /*
1343          * If pci_dev->driver is not set (unbound), the device should
1344          * always remain in D0 regardless of the runtime PM status
1345          */
1346         if (!pci_dev->driver)
1347                 return 0;
1348
1349         if (!pm)
1350                 return -ENOSYS;
1351
1352         if (pm->runtime_idle)
1353                 return pm->runtime_idle(dev);
1354
1355         return 0;
1356 }
1357
1358 static const struct dev_pm_ops pci_dev_pm_ops = {
1359         .prepare = pci_pm_prepare,
1360         .complete = pci_pm_complete,
1361         .suspend = pci_pm_suspend,
1362         .suspend_late = pci_pm_suspend_late,
1363         .resume = pci_pm_resume,
1364         .resume_early = pci_pm_resume_early,
1365         .freeze = pci_pm_freeze,
1366         .thaw = pci_pm_thaw,
1367         .poweroff = pci_pm_poweroff,
1368         .poweroff_late = pci_pm_poweroff_late,
1369         .restore = pci_pm_restore,
1370         .suspend_noirq = pci_pm_suspend_noirq,
1371         .resume_noirq = pci_pm_resume_noirq,
1372         .freeze_noirq = pci_pm_freeze_noirq,
1373         .thaw_noirq = pci_pm_thaw_noirq,
1374         .poweroff_noirq = pci_pm_poweroff_noirq,
1375         .restore_noirq = pci_pm_restore_noirq,
1376         .runtime_suspend = pci_pm_runtime_suspend,
1377         .runtime_resume = pci_pm_runtime_resume,
1378         .runtime_idle = pci_pm_runtime_idle,
1379 };
1380
1381 #define PCI_PM_OPS_PTR  (&pci_dev_pm_ops)
1382
1383 #else /* !CONFIG_PM */
1384
1385 #define pci_pm_runtime_suspend  NULL
1386 #define pci_pm_runtime_resume   NULL
1387 #define pci_pm_runtime_idle     NULL
1388
1389 #define PCI_PM_OPS_PTR  NULL
1390
1391 #endif /* !CONFIG_PM */
1392
1393 /**
1394  * __pci_register_driver - register a new pci driver
1395  * @drv: the driver structure to register
1396  * @owner: owner module of drv
1397  * @mod_name: module name string
1398  *
1399  * Adds the driver structure to the list of registered drivers.
1400  * Returns a negative value on error, otherwise 0.
1401  * If no error occurred, the driver remains registered even if
1402  * no device was claimed during registration.
1403  */
1404 int __pci_register_driver(struct pci_driver *drv, struct module *owner,
1405                           const char *mod_name)
1406 {
1407         /* initialize common driver fields */
1408         drv->driver.name = drv->name;
1409         drv->driver.bus = &pci_bus_type;
1410         drv->driver.owner = owner;
1411         drv->driver.mod_name = mod_name;
1412         drv->driver.groups = drv->groups;
1413
1414         spin_lock_init(&drv->dynids.lock);
1415         INIT_LIST_HEAD(&drv->dynids.list);
1416
1417         /* register with core */
1418         return driver_register(&drv->driver);
1419 }
1420 EXPORT_SYMBOL(__pci_register_driver);
1421
1422 /**
1423  * pci_unregister_driver - unregister a pci driver
1424  * @drv: the driver structure to unregister
1425  *
1426  * Deletes the driver structure from the list of registered PCI drivers,
1427  * gives it a chance to clean up by calling its remove() function for
1428  * each device it was responsible for, and marks those devices as
1429  * driverless.
1430  */
1431
1432 void pci_unregister_driver(struct pci_driver *drv)
1433 {
1434         driver_unregister(&drv->driver);
1435         pci_free_dynids(drv);
1436 }
1437 EXPORT_SYMBOL(pci_unregister_driver);
1438
1439 static struct pci_driver pci_compat_driver = {
1440         .name = "compat"
1441 };
1442
1443 /**
1444  * pci_dev_driver - get the pci_driver of a device
1445  * @dev: the device to query
1446  *
1447  * Returns the appropriate pci_driver structure or %NULL if there is no
1448  * registered driver for the device.
1449  */
1450 struct pci_driver *pci_dev_driver(const struct pci_dev *dev)
1451 {
1452         if (dev->driver)
1453                 return dev->driver;
1454         else {
1455                 int i;
1456                 for (i = 0; i <= PCI_ROM_RESOURCE; i++)
1457                         if (dev->resource[i].flags & IORESOURCE_BUSY)
1458                                 return &pci_compat_driver;
1459         }
1460         return NULL;
1461 }
1462 EXPORT_SYMBOL(pci_dev_driver);
1463
1464 /**
1465  * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure
1466  * @dev: the PCI device structure to match against
1467  * @drv: the device driver to search for matching PCI device id structures
1468  *
1469  * Used by a driver to check whether a PCI device present in the
1470  * system is in its list of supported devices. Returns the matching
1471  * pci_device_id structure or %NULL if there is no match.
1472  */
1473 static int pci_bus_match(struct device *dev, struct device_driver *drv)
1474 {
1475         struct pci_dev *pci_dev = to_pci_dev(dev);
1476         struct pci_driver *pci_drv;
1477         const struct pci_device_id *found_id;
1478
1479         if (!pci_dev->match_driver)
1480                 return 0;
1481
1482         pci_drv = to_pci_driver(drv);
1483         found_id = pci_match_device(pci_drv, pci_dev);
1484         if (found_id)
1485                 return 1;
1486
1487         return 0;
1488 }
1489
1490 /**
1491  * pci_dev_get - increments the reference count of the pci device structure
1492  * @dev: the device being referenced
1493  *
1494  * Each live reference to a device should be refcounted.
1495  *
1496  * Drivers for PCI devices should normally record such references in
1497  * their probe() methods, when they bind to a device, and release
1498  * them by calling pci_dev_put(), in their disconnect() methods.
1499  *
1500  * A pointer to the device with the incremented reference counter is returned.
1501  */
1502 struct pci_dev *pci_dev_get(struct pci_dev *dev)
1503 {
1504         if (dev)
1505                 get_device(&dev->dev);
1506         return dev;
1507 }
1508 EXPORT_SYMBOL(pci_dev_get);
1509
1510 /**
1511  * pci_dev_put - release a use of the pci device structure
1512  * @dev: device that's been disconnected
1513  *
1514  * Must be called when a user of a device is finished with it.  When the last
1515  * user of the device calls this function, the memory of the device is freed.
1516  */
1517 void pci_dev_put(struct pci_dev *dev)
1518 {
1519         if (dev)
1520                 put_device(&dev->dev);
1521 }
1522 EXPORT_SYMBOL(pci_dev_put);
1523
1524 static int pci_uevent(struct device *dev, struct kobj_uevent_env *env)
1525 {
1526         struct pci_dev *pdev;
1527
1528         if (!dev)
1529                 return -ENODEV;
1530
1531         pdev = to_pci_dev(dev);
1532
1533         if (add_uevent_var(env, "PCI_CLASS=%04X", pdev->class))
1534                 return -ENOMEM;
1535
1536         if (add_uevent_var(env, "PCI_ID=%04X:%04X", pdev->vendor, pdev->device))
1537                 return -ENOMEM;
1538
1539         if (add_uevent_var(env, "PCI_SUBSYS_ID=%04X:%04X", pdev->subsystem_vendor,
1540                            pdev->subsystem_device))
1541                 return -ENOMEM;
1542
1543         if (add_uevent_var(env, "PCI_SLOT_NAME=%s", pci_name(pdev)))
1544                 return -ENOMEM;
1545
1546         if (add_uevent_var(env, "MODALIAS=pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02X",
1547                            pdev->vendor, pdev->device,
1548                            pdev->subsystem_vendor, pdev->subsystem_device,
1549                            (u8)(pdev->class >> 16), (u8)(pdev->class >> 8),
1550                            (u8)(pdev->class)))
1551                 return -ENOMEM;
1552
1553         return 0;
1554 }
1555
1556 #if defined(CONFIG_PCIEPORTBUS) || defined(CONFIG_EEH)
1557 /**
1558  * pci_uevent_ers - emit a uevent during recovery path of PCI device
1559  * @pdev: PCI device undergoing error recovery
1560  * @err_type: type of error event
1561  */
1562 void pci_uevent_ers(struct pci_dev *pdev, enum pci_ers_result err_type)
1563 {
1564         int idx = 0;
1565         char *envp[3];
1566
1567         switch (err_type) {
1568         case PCI_ERS_RESULT_NONE:
1569         case PCI_ERS_RESULT_CAN_RECOVER:
1570                 envp[idx++] = "ERROR_EVENT=BEGIN_RECOVERY";
1571                 envp[idx++] = "DEVICE_ONLINE=0";
1572                 break;
1573         case PCI_ERS_RESULT_RECOVERED:
1574                 envp[idx++] = "ERROR_EVENT=SUCCESSFUL_RECOVERY";
1575                 envp[idx++] = "DEVICE_ONLINE=1";
1576                 break;
1577         case PCI_ERS_RESULT_DISCONNECT:
1578                 envp[idx++] = "ERROR_EVENT=FAILED_RECOVERY";
1579                 envp[idx++] = "DEVICE_ONLINE=0";
1580                 break;
1581         default:
1582                 break;
1583         }
1584
1585         if (idx > 0) {
1586                 envp[idx++] = NULL;
1587                 kobject_uevent_env(&pdev->dev.kobj, KOBJ_CHANGE, envp);
1588         }
1589 }
1590 #endif
1591
1592 static int pci_bus_num_vf(struct device *dev)
1593 {
1594         return pci_num_vf(to_pci_dev(dev));
1595 }
1596
1597 /**
1598  * pci_dma_configure - Setup DMA configuration
1599  * @dev: ptr to dev structure
1600  *
1601  * Function to update PCI devices's DMA configuration using the same
1602  * info from the OF node or ACPI node of host bridge's parent (if any).
1603  */
1604 static int pci_dma_configure(struct device *dev)
1605 {
1606         struct device *bridge;
1607         int ret = 0;
1608
1609         bridge = pci_get_host_bridge_device(to_pci_dev(dev));
1610
1611         if (IS_ENABLED(CONFIG_OF) && bridge->parent &&
1612             bridge->parent->of_node) {
1613                 ret = of_dma_configure(dev, bridge->parent->of_node, true);
1614         } else if (has_acpi_companion(bridge)) {
1615                 struct acpi_device *adev = to_acpi_device_node(bridge->fwnode);
1616
1617                 ret = acpi_dma_configure(dev, acpi_get_dma_attr(adev));
1618         }
1619
1620         pci_put_host_bridge_device(bridge);
1621         return ret;
1622 }
1623
1624 struct bus_type pci_bus_type = {
1625         .name           = "pci",
1626         .match          = pci_bus_match,
1627         .uevent         = pci_uevent,
1628         .probe          = pci_device_probe,
1629         .remove         = pci_device_remove,
1630         .shutdown       = pci_device_shutdown,
1631         .dev_groups     = pci_dev_groups,
1632         .bus_groups     = pci_bus_groups,
1633         .drv_groups     = pci_drv_groups,
1634         .pm             = PCI_PM_OPS_PTR,
1635         .num_vf         = pci_bus_num_vf,
1636         .dma_configure  = pci_dma_configure,
1637 };
1638 EXPORT_SYMBOL(pci_bus_type);
1639
1640 #ifdef CONFIG_PCIEPORTBUS
1641 static int pcie_port_bus_match(struct device *dev, struct device_driver *drv)
1642 {
1643         struct pcie_device *pciedev;
1644         struct pcie_port_service_driver *driver;
1645
1646         if (drv->bus != &pcie_port_bus_type || dev->bus != &pcie_port_bus_type)
1647                 return 0;
1648
1649         pciedev = to_pcie_device(dev);
1650         driver = to_service_driver(drv);
1651
1652         if (driver->service != pciedev->service)
1653                 return 0;
1654
1655         if (driver->port_type != PCIE_ANY_PORT &&
1656             driver->port_type != pci_pcie_type(pciedev->port))
1657                 return 0;
1658
1659         return 1;
1660 }
1661
1662 struct bus_type pcie_port_bus_type = {
1663         .name           = "pci_express",
1664         .match          = pcie_port_bus_match,
1665 };
1666 EXPORT_SYMBOL_GPL(pcie_port_bus_type);
1667 #endif
1668
1669 static int __init pci_driver_init(void)
1670 {
1671         int ret;
1672
1673         ret = bus_register(&pci_bus_type);
1674         if (ret)
1675                 return ret;
1676
1677 #ifdef CONFIG_PCIEPORTBUS
1678         ret = bus_register(&pcie_port_bus_type);
1679         if (ret)
1680                 return ret;
1681 #endif
1682         dma_debug_add_bus(&pci_bus_type);
1683         return 0;
1684 }
1685 postcore_initcall(pci_driver_init);