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