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