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 27 struct 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 */ 53 int 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 } 79 EXPORT_SYMBOL_GPL(pci_add_dynid); 80 81 static void pci_free_dynids(struct pci_driver *drv) 82 { 83 struct pci_dynid *dynid, *n; 84 85 spin_lock(&drv->dynids.lock); 86 list_for_each_entry_safe(dynid, n, &drv->dynids.list, node) { 87 list_del(&dynid->node); 88 kfree(dynid); 89 } 90 spin_unlock(&drv->dynids.lock); 91 } 92 93 /** 94 * 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 */ 105 const 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 } 117 EXPORT_SYMBOL(pci_match_id); 118 119 static 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 */ 136 static 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 */ 188 static 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 } 246 static 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 */ 256 static 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 } 290 static DRIVER_ATTR_WO(remove_id); 291 292 static struct attribute *pci_drv_attrs[] = { 293 &driver_attr_new_id.attr, 294 &driver_attr_remove_id.attr, 295 NULL, 296 }; 297 ATTRIBUTE_GROUPS(pci_drv); 298 299 struct drv_dev_and_id { 300 struct pci_driver *drv; 301 struct pci_dev *dev; 302 const struct pci_device_id *id; 303 }; 304 305 static 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 341 static 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 350 static 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); 393 out: 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 */ 407 static 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 422 int __weak pcibios_alloc_irq(struct pci_dev *dev) 423 { 424 return 0; 425 } 426 427 void __weak pcibios_free_irq(struct pci_dev *dev) 428 { 429 } 430 431 #ifdef CONFIG_PCI_IOV 432 static 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 438 static inline bool pci_device_can_probe(struct pci_dev *pdev) 439 { 440 return true; 441 } 442 #endif 443 444 static 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 469 static 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 drv->remove(pci_dev); 477 pm_runtime_put_noidle(dev); 478 } 479 pcibios_free_irq(pci_dev); 480 pci_dev->driver = NULL; 481 pci_iov_remove(pci_dev); 482 483 /* Undo the runtime PM settings in local_pci_probe() */ 484 pm_runtime_put_sync(dev); 485 486 /* 487 * If the device is still on, set the power state as "unknown", 488 * since it might change by the next time we load the driver. 489 */ 490 if (pci_dev->current_state == PCI_D0) 491 pci_dev->current_state = PCI_UNKNOWN; 492 493 /* 494 * We would love to complain here if pci_dev->is_enabled is set, that 495 * the driver should have called pci_disable_device(), but the 496 * unfortunate fact is there are too many odd BIOS and bridge setups 497 * that don't like drivers doing that all of the time. 498 * Oh well, we can dream of sane hardware when we sleep, no matter how 499 * horrible the crap we have to deal with is when we are awake... 500 */ 501 502 pci_dev_put(pci_dev); 503 } 504 505 static void pci_device_shutdown(struct device *dev) 506 { 507 struct pci_dev *pci_dev = to_pci_dev(dev); 508 struct pci_driver *drv = pci_dev->driver; 509 510 pm_runtime_resume(dev); 511 512 if (drv && drv->shutdown) 513 drv->shutdown(pci_dev); 514 515 /* 516 * If this is a kexec reboot, turn off Bus Master bit on the 517 * device to tell it to not continue to do DMA. Don't touch 518 * devices in D3cold or unknown states. 519 * If it is not a kexec reboot, firmware will hit the PCI 520 * devices with big hammer and stop their DMA any way. 521 */ 522 if (kexec_in_progress && (pci_dev->current_state <= PCI_D3hot)) 523 pci_clear_master(pci_dev); 524 } 525 526 #ifdef CONFIG_PM_SLEEP 527 528 /* Auxiliary functions used for system resume */ 529 530 /** 531 * pci_restore_standard_config - restore standard config registers of PCI device 532 * @pci_dev: PCI device to handle 533 */ 534 static int pci_restore_standard_config(struct pci_dev *pci_dev) 535 { 536 pci_update_current_state(pci_dev, PCI_UNKNOWN); 537 538 if (pci_dev->current_state != PCI_D0) { 539 int error = pci_set_power_state(pci_dev, PCI_D0); 540 if (error) 541 return error; 542 } 543 544 pci_restore_state(pci_dev); 545 pci_pme_restore(pci_dev); 546 return 0; 547 } 548 #endif /* CONFIG_PM_SLEEP */ 549 550 #ifdef CONFIG_PM 551 552 /* Auxiliary functions used for system resume and run-time resume */ 553 554 static void pci_pm_default_resume(struct pci_dev *pci_dev) 555 { 556 pci_fixup_device(pci_fixup_resume, pci_dev); 557 pci_enable_wake(pci_dev, PCI_D0, false); 558 } 559 560 static void pci_pm_power_up_and_verify_state(struct pci_dev *pci_dev) 561 { 562 pci_power_up(pci_dev); 563 pci_update_current_state(pci_dev, PCI_D0); 564 } 565 566 static void pci_pm_default_resume_early(struct pci_dev *pci_dev) 567 { 568 pci_pm_power_up_and_verify_state(pci_dev); 569 pci_restore_state(pci_dev); 570 pci_pme_restore(pci_dev); 571 } 572 573 static void pci_pm_bridge_power_up_actions(struct pci_dev *pci_dev) 574 { 575 pci_bridge_wait_for_secondary_bus(pci_dev, "resume"); 576 577 /* 578 * When powering on a bridge from D3cold, the whole hierarchy may be 579 * powered on into D0uninitialized state, resume them to give them a 580 * chance to suspend again 581 */ 582 pci_resume_bus(pci_dev->subordinate); 583 } 584 585 #endif /* CONFIG_PM */ 586 587 #ifdef CONFIG_PM_SLEEP 588 589 /* 590 * Default "suspend" method for devices that have no driver provided suspend, 591 * or not even a driver at all (second part). 592 */ 593 static void pci_pm_set_unknown_state(struct pci_dev *pci_dev) 594 { 595 /* 596 * mark its power state as "unknown", since we don't know if 597 * e.g. the BIOS will change its device state when we suspend. 598 */ 599 if (pci_dev->current_state == PCI_D0) 600 pci_dev->current_state = PCI_UNKNOWN; 601 } 602 603 /* 604 * Default "resume" method for devices that have no driver provided resume, 605 * or not even a driver at all (second part). 606 */ 607 static int pci_pm_reenable_device(struct pci_dev *pci_dev) 608 { 609 int retval; 610 611 /* if the device was enabled before suspend, re-enable */ 612 retval = pci_reenable_device(pci_dev); 613 /* 614 * if the device was busmaster before the suspend, make it busmaster 615 * again 616 */ 617 if (pci_dev->is_busmaster) 618 pci_set_master(pci_dev); 619 620 return retval; 621 } 622 623 static int pci_legacy_suspend(struct device *dev, pm_message_t state) 624 { 625 struct pci_dev *pci_dev = to_pci_dev(dev); 626 struct pci_driver *drv = pci_dev->driver; 627 628 if (drv && drv->suspend) { 629 pci_power_t prev = pci_dev->current_state; 630 int error; 631 632 error = drv->suspend(pci_dev, state); 633 suspend_report_result(dev, drv->suspend, error); 634 if (error) 635 return error; 636 637 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0 638 && pci_dev->current_state != PCI_UNKNOWN) { 639 pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev, 640 "PCI PM: Device state not saved by %pS\n", 641 drv->suspend); 642 } 643 } 644 645 pci_fixup_device(pci_fixup_suspend, pci_dev); 646 647 return 0; 648 } 649 650 static int pci_legacy_suspend_late(struct device *dev) 651 { 652 struct pci_dev *pci_dev = to_pci_dev(dev); 653 654 if (!pci_dev->state_saved) 655 pci_save_state(pci_dev); 656 657 pci_pm_set_unknown_state(pci_dev); 658 659 pci_fixup_device(pci_fixup_suspend_late, pci_dev); 660 661 return 0; 662 } 663 664 static int pci_legacy_resume(struct device *dev) 665 { 666 struct pci_dev *pci_dev = to_pci_dev(dev); 667 struct pci_driver *drv = pci_dev->driver; 668 669 pci_fixup_device(pci_fixup_resume, pci_dev); 670 671 return drv && drv->resume ? 672 drv->resume(pci_dev) : pci_pm_reenable_device(pci_dev); 673 } 674 675 /* Auxiliary functions used by the new power management framework */ 676 677 static void pci_pm_default_suspend(struct pci_dev *pci_dev) 678 { 679 /* Disable non-bridge devices without PM support */ 680 if (!pci_has_subordinate(pci_dev)) 681 pci_disable_enabled_device(pci_dev); 682 } 683 684 static bool pci_has_legacy_pm_support(struct pci_dev *pci_dev) 685 { 686 struct pci_driver *drv = pci_dev->driver; 687 bool ret = drv && (drv->suspend || drv->resume); 688 689 /* 690 * Legacy PM support is used by default, so warn if the new framework is 691 * supported as well. Drivers are supposed to support either the 692 * former, or the latter, but not both at the same time. 693 */ 694 pci_WARN(pci_dev, ret && drv->driver.pm, "device %04x:%04x\n", 695 pci_dev->vendor, pci_dev->device); 696 697 return ret; 698 } 699 700 /* New power management framework */ 701 702 static int pci_pm_prepare(struct device *dev) 703 { 704 struct pci_dev *pci_dev = to_pci_dev(dev); 705 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL; 706 707 if (pm && pm->prepare) { 708 int error = pm->prepare(dev); 709 if (error < 0) 710 return error; 711 712 if (!error && dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_PREPARE)) 713 return 0; 714 } 715 if (pci_dev_need_resume(pci_dev)) 716 return 0; 717 718 /* 719 * The PME setting needs to be adjusted here in case the direct-complete 720 * optimization is used with respect to this device. 721 */ 722 pci_dev_adjust_pme(pci_dev); 723 return 1; 724 } 725 726 static void pci_pm_complete(struct device *dev) 727 { 728 struct pci_dev *pci_dev = to_pci_dev(dev); 729 730 pci_dev_complete_resume(pci_dev); 731 pm_generic_complete(dev); 732 733 /* Resume device if platform firmware has put it in reset-power-on */ 734 if (pm_runtime_suspended(dev) && pm_resume_via_firmware()) { 735 pci_power_t pre_sleep_state = pci_dev->current_state; 736 737 pci_refresh_power_state(pci_dev); 738 /* 739 * On platforms with ACPI this check may also trigger for 740 * devices sharing power resources if one of those power 741 * resources has been activated as a result of a change of the 742 * power state of another device sharing it. However, in that 743 * case it is also better to resume the device, in general. 744 */ 745 if (pci_dev->current_state < pre_sleep_state) 746 pm_request_resume(dev); 747 } 748 } 749 750 #else /* !CONFIG_PM_SLEEP */ 751 752 #define pci_pm_prepare NULL 753 #define pci_pm_complete NULL 754 755 #endif /* !CONFIG_PM_SLEEP */ 756 757 #ifdef CONFIG_SUSPEND 758 static void pcie_pme_root_status_cleanup(struct pci_dev *pci_dev) 759 { 760 /* 761 * Some BIOSes forget to clear Root PME Status bits after system 762 * wakeup, which breaks ACPI-based runtime wakeup on PCI Express. 763 * Clear those bits now just in case (shouldn't hurt). 764 */ 765 if (pci_is_pcie(pci_dev) && 766 (pci_pcie_type(pci_dev) == PCI_EXP_TYPE_ROOT_PORT || 767 pci_pcie_type(pci_dev) == PCI_EXP_TYPE_RC_EC)) 768 pcie_clear_root_pme_status(pci_dev); 769 } 770 771 static int pci_pm_suspend(struct device *dev) 772 { 773 struct pci_dev *pci_dev = to_pci_dev(dev); 774 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL; 775 776 pci_dev->skip_bus_pm = false; 777 778 /* 779 * Disabling PTM allows some systems, e.g., Intel mobile chips 780 * since Coffee Lake, to enter a lower-power PM state. 781 */ 782 pci_suspend_ptm(pci_dev); 783 784 if (pci_has_legacy_pm_support(pci_dev)) 785 return pci_legacy_suspend(dev, PMSG_SUSPEND); 786 787 if (!pm) { 788 pci_pm_default_suspend(pci_dev); 789 return 0; 790 } 791 792 /* 793 * PCI devices suspended at run time may need to be resumed at this 794 * point, because in general it may be necessary to reconfigure them for 795 * system suspend. Namely, if the device is expected to wake up the 796 * system from the sleep state, it may have to be reconfigured for this 797 * purpose, or if the device is not expected to wake up the system from 798 * the sleep state, it should be prevented from signaling wakeup events 799 * going forward. 800 * 801 * Also if the driver of the device does not indicate that its system 802 * suspend callbacks can cope with runtime-suspended devices, it is 803 * better to resume the device from runtime suspend here. 804 */ 805 if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) || 806 pci_dev_need_resume(pci_dev)) { 807 pm_runtime_resume(dev); 808 pci_dev->state_saved = false; 809 } else { 810 pci_dev_adjust_pme(pci_dev); 811 } 812 813 if (pm->suspend) { 814 pci_power_t prev = pci_dev->current_state; 815 int error; 816 817 error = pm->suspend(dev); 818 suspend_report_result(dev, pm->suspend, error); 819 if (error) 820 return error; 821 822 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0 823 && pci_dev->current_state != PCI_UNKNOWN) { 824 pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev, 825 "PCI PM: State of device not saved by %pS\n", 826 pm->suspend); 827 } 828 } 829 830 return 0; 831 } 832 833 static int pci_pm_suspend_late(struct device *dev) 834 { 835 if (dev_pm_skip_suspend(dev)) 836 return 0; 837 838 pci_fixup_device(pci_fixup_suspend, to_pci_dev(dev)); 839 840 return pm_generic_suspend_late(dev); 841 } 842 843 static int pci_pm_suspend_noirq(struct device *dev) 844 { 845 struct pci_dev *pci_dev = to_pci_dev(dev); 846 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL; 847 848 if (dev_pm_skip_suspend(dev)) 849 return 0; 850 851 if (pci_has_legacy_pm_support(pci_dev)) 852 return pci_legacy_suspend_late(dev); 853 854 if (!pm) { 855 pci_save_state(pci_dev); 856 goto Fixup; 857 } 858 859 if (pm->suspend_noirq) { 860 pci_power_t prev = pci_dev->current_state; 861 int error; 862 863 error = pm->suspend_noirq(dev); 864 suspend_report_result(dev, pm->suspend_noirq, error); 865 if (error) 866 return error; 867 868 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0 869 && pci_dev->current_state != PCI_UNKNOWN) { 870 pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev, 871 "PCI PM: State of device not saved by %pS\n", 872 pm->suspend_noirq); 873 goto Fixup; 874 } 875 } 876 877 if (!pci_dev->state_saved) { 878 pci_save_state(pci_dev); 879 880 /* 881 * If the device is a bridge with a child in D0 below it, 882 * it needs to stay in D0, so check skip_bus_pm to avoid 883 * putting it into a low-power state in that case. 884 */ 885 if (!pci_dev->skip_bus_pm && pci_power_manageable(pci_dev)) 886 pci_prepare_to_sleep(pci_dev); 887 } 888 889 pci_dbg(pci_dev, "PCI PM: Suspend power state: %s\n", 890 pci_power_name(pci_dev->current_state)); 891 892 if (pci_dev->current_state == PCI_D0) { 893 pci_dev->skip_bus_pm = true; 894 /* 895 * Per PCI PM r1.2, table 6-1, a bridge must be in D0 if any 896 * downstream device is in D0, so avoid changing the power state 897 * of the parent bridge by setting the skip_bus_pm flag for it. 898 */ 899 if (pci_dev->bus->self) 900 pci_dev->bus->self->skip_bus_pm = true; 901 } 902 903 if (pci_dev->skip_bus_pm && pm_suspend_no_platform()) { 904 pci_dbg(pci_dev, "PCI PM: Skipped\n"); 905 goto Fixup; 906 } 907 908 pci_pm_set_unknown_state(pci_dev); 909 910 /* 911 * Some BIOSes from ASUS have a bug: If a USB EHCI host controller's 912 * PCI COMMAND register isn't 0, the BIOS assumes that the controller 913 * hasn't been quiesced and tries to turn it off. If the controller 914 * is already in D3, this can hang or cause memory corruption. 915 * 916 * Since the value of the COMMAND register doesn't matter once the 917 * device has been suspended, we can safely set it to 0 here. 918 */ 919 if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI) 920 pci_write_config_word(pci_dev, PCI_COMMAND, 0); 921 922 Fixup: 923 pci_fixup_device(pci_fixup_suspend_late, pci_dev); 924 925 /* 926 * If the target system sleep state is suspend-to-idle, it is sufficient 927 * to check whether or not the device's wakeup settings are good for 928 * runtime PM. Otherwise, the pm_resume_via_firmware() check will cause 929 * pci_pm_complete() to take care of fixing up the device's state 930 * anyway, if need be. 931 */ 932 if (device_can_wakeup(dev) && !device_may_wakeup(dev)) 933 dev->power.may_skip_resume = false; 934 935 return 0; 936 } 937 938 static int pci_pm_resume_noirq(struct device *dev) 939 { 940 struct pci_dev *pci_dev = to_pci_dev(dev); 941 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL; 942 pci_power_t prev_state = pci_dev->current_state; 943 bool skip_bus_pm = pci_dev->skip_bus_pm; 944 945 if (dev_pm_skip_resume(dev)) 946 return 0; 947 948 /* 949 * In the suspend-to-idle case, devices left in D0 during suspend will 950 * stay in D0, so it is not necessary to restore or update their 951 * configuration here and attempting to put them into D0 again is 952 * pointless, so avoid doing that. 953 */ 954 if (!(skip_bus_pm && pm_suspend_no_platform())) 955 pci_pm_default_resume_early(pci_dev); 956 957 pci_fixup_device(pci_fixup_resume_early, pci_dev); 958 pcie_pme_root_status_cleanup(pci_dev); 959 960 if (!skip_bus_pm && prev_state == PCI_D3cold) 961 pci_pm_bridge_power_up_actions(pci_dev); 962 963 if (pci_has_legacy_pm_support(pci_dev)) 964 return 0; 965 966 if (pm && pm->resume_noirq) 967 return pm->resume_noirq(dev); 968 969 return 0; 970 } 971 972 static int pci_pm_resume_early(struct device *dev) 973 { 974 if (dev_pm_skip_resume(dev)) 975 return 0; 976 977 return pm_generic_resume_early(dev); 978 } 979 980 static int pci_pm_resume(struct device *dev) 981 { 982 struct pci_dev *pci_dev = to_pci_dev(dev); 983 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL; 984 985 /* 986 * This is necessary for the suspend error path in which resume is 987 * called without restoring the standard config registers of the device. 988 */ 989 if (pci_dev->state_saved) 990 pci_restore_standard_config(pci_dev); 991 992 pci_resume_ptm(pci_dev); 993 994 if (pci_has_legacy_pm_support(pci_dev)) 995 return pci_legacy_resume(dev); 996 997 pci_pm_default_resume(pci_dev); 998 999 if (pm) { 1000 if (pm->resume) 1001 return pm->resume(dev); 1002 } else { 1003 pci_pm_reenable_device(pci_dev); 1004 } 1005 1006 return 0; 1007 } 1008 1009 #else /* !CONFIG_SUSPEND */ 1010 1011 #define pci_pm_suspend NULL 1012 #define pci_pm_suspend_late NULL 1013 #define pci_pm_suspend_noirq NULL 1014 #define pci_pm_resume NULL 1015 #define pci_pm_resume_early NULL 1016 #define pci_pm_resume_noirq NULL 1017 1018 #endif /* !CONFIG_SUSPEND */ 1019 1020 #ifdef CONFIG_HIBERNATE_CALLBACKS 1021 1022 static int pci_pm_freeze(struct device *dev) 1023 { 1024 struct pci_dev *pci_dev = to_pci_dev(dev); 1025 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL; 1026 1027 if (pci_has_legacy_pm_support(pci_dev)) 1028 return pci_legacy_suspend(dev, PMSG_FREEZE); 1029 1030 if (!pm) { 1031 pci_pm_default_suspend(pci_dev); 1032 return 0; 1033 } 1034 1035 /* 1036 * Resume all runtime-suspended devices before creating a snapshot 1037 * image of system memory, because the restore kernel generally cannot 1038 * be expected to always handle them consistently and they need to be 1039 * put into the runtime-active metastate during system resume anyway, 1040 * so it is better to ensure that the state saved in the image will be 1041 * always consistent with that. 1042 */ 1043 pm_runtime_resume(dev); 1044 pci_dev->state_saved = false; 1045 1046 if (pm->freeze) { 1047 int error; 1048 1049 error = pm->freeze(dev); 1050 suspend_report_result(dev, pm->freeze, error); 1051 if (error) 1052 return error; 1053 } 1054 1055 return 0; 1056 } 1057 1058 static int pci_pm_freeze_noirq(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 1063 if (pci_has_legacy_pm_support(pci_dev)) 1064 return pci_legacy_suspend_late(dev); 1065 1066 if (pm && pm->freeze_noirq) { 1067 int error; 1068 1069 error = pm->freeze_noirq(dev); 1070 suspend_report_result(dev, pm->freeze_noirq, error); 1071 if (error) 1072 return error; 1073 } 1074 1075 if (!pci_dev->state_saved) 1076 pci_save_state(pci_dev); 1077 1078 pci_pm_set_unknown_state(pci_dev); 1079 1080 return 0; 1081 } 1082 1083 static int pci_pm_thaw_noirq(struct device *dev) 1084 { 1085 struct pci_dev *pci_dev = to_pci_dev(dev); 1086 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL; 1087 1088 /* 1089 * The pm->thaw_noirq() callback assumes the device has been 1090 * returned to D0 and its config state has been restored. 1091 * 1092 * In addition, pci_restore_state() restores MSI-X state in MMIO 1093 * space, which requires the device to be in D0, so return it to D0 1094 * in case the driver's "freeze" callbacks put it into a low-power 1095 * state. 1096 */ 1097 pci_pm_power_up_and_verify_state(pci_dev); 1098 pci_restore_state(pci_dev); 1099 1100 if (pci_has_legacy_pm_support(pci_dev)) 1101 return 0; 1102 1103 if (pm && pm->thaw_noirq) 1104 return pm->thaw_noirq(dev); 1105 1106 return 0; 1107 } 1108 1109 static int pci_pm_thaw(struct device *dev) 1110 { 1111 struct pci_dev *pci_dev = to_pci_dev(dev); 1112 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL; 1113 int error = 0; 1114 1115 if (pci_has_legacy_pm_support(pci_dev)) 1116 return pci_legacy_resume(dev); 1117 1118 if (pm) { 1119 if (pm->thaw) 1120 error = pm->thaw(dev); 1121 } else { 1122 pci_pm_reenable_device(pci_dev); 1123 } 1124 1125 pci_dev->state_saved = false; 1126 1127 return error; 1128 } 1129 1130 static int pci_pm_poweroff(struct device *dev) 1131 { 1132 struct pci_dev *pci_dev = to_pci_dev(dev); 1133 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL; 1134 1135 if (pci_has_legacy_pm_support(pci_dev)) 1136 return pci_legacy_suspend(dev, PMSG_HIBERNATE); 1137 1138 if (!pm) { 1139 pci_pm_default_suspend(pci_dev); 1140 return 0; 1141 } 1142 1143 /* The reason to do that is the same as in pci_pm_suspend(). */ 1144 if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) || 1145 pci_dev_need_resume(pci_dev)) { 1146 pm_runtime_resume(dev); 1147 pci_dev->state_saved = false; 1148 } else { 1149 pci_dev_adjust_pme(pci_dev); 1150 } 1151 1152 if (pm->poweroff) { 1153 int error; 1154 1155 error = pm->poweroff(dev); 1156 suspend_report_result(dev, pm->poweroff, error); 1157 if (error) 1158 return error; 1159 } 1160 1161 return 0; 1162 } 1163 1164 static int pci_pm_poweroff_late(struct device *dev) 1165 { 1166 if (dev_pm_skip_suspend(dev)) 1167 return 0; 1168 1169 pci_fixup_device(pci_fixup_suspend, to_pci_dev(dev)); 1170 1171 return pm_generic_poweroff_late(dev); 1172 } 1173 1174 static int pci_pm_poweroff_noirq(struct device *dev) 1175 { 1176 struct pci_dev *pci_dev = to_pci_dev(dev); 1177 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL; 1178 1179 if (dev_pm_skip_suspend(dev)) 1180 return 0; 1181 1182 if (pci_has_legacy_pm_support(pci_dev)) 1183 return pci_legacy_suspend_late(dev); 1184 1185 if (!pm) { 1186 pci_fixup_device(pci_fixup_suspend_late, pci_dev); 1187 return 0; 1188 } 1189 1190 if (pm->poweroff_noirq) { 1191 int error; 1192 1193 error = pm->poweroff_noirq(dev); 1194 suspend_report_result(dev, pm->poweroff_noirq, error); 1195 if (error) 1196 return error; 1197 } 1198 1199 if (!pci_dev->state_saved && !pci_has_subordinate(pci_dev)) 1200 pci_prepare_to_sleep(pci_dev); 1201 1202 /* 1203 * The reason for doing this here is the same as for the analogous code 1204 * in pci_pm_suspend_noirq(). 1205 */ 1206 if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI) 1207 pci_write_config_word(pci_dev, PCI_COMMAND, 0); 1208 1209 pci_fixup_device(pci_fixup_suspend_late, pci_dev); 1210 1211 return 0; 1212 } 1213 1214 static int pci_pm_restore_noirq(struct device *dev) 1215 { 1216 struct pci_dev *pci_dev = to_pci_dev(dev); 1217 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL; 1218 1219 pci_pm_default_resume_early(pci_dev); 1220 pci_fixup_device(pci_fixup_resume_early, pci_dev); 1221 1222 if (pci_has_legacy_pm_support(pci_dev)) 1223 return 0; 1224 1225 if (pm && pm->restore_noirq) 1226 return pm->restore_noirq(dev); 1227 1228 return 0; 1229 } 1230 1231 static int pci_pm_restore(struct device *dev) 1232 { 1233 struct pci_dev *pci_dev = to_pci_dev(dev); 1234 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL; 1235 1236 /* 1237 * This is necessary for the hibernation error path in which restore is 1238 * called without restoring the standard config registers of the device. 1239 */ 1240 if (pci_dev->state_saved) 1241 pci_restore_standard_config(pci_dev); 1242 1243 if (pci_has_legacy_pm_support(pci_dev)) 1244 return pci_legacy_resume(dev); 1245 1246 pci_pm_default_resume(pci_dev); 1247 1248 if (pm) { 1249 if (pm->restore) 1250 return pm->restore(dev); 1251 } else { 1252 pci_pm_reenable_device(pci_dev); 1253 } 1254 1255 return 0; 1256 } 1257 1258 #else /* !CONFIG_HIBERNATE_CALLBACKS */ 1259 1260 #define pci_pm_freeze NULL 1261 #define pci_pm_freeze_noirq NULL 1262 #define pci_pm_thaw NULL 1263 #define pci_pm_thaw_noirq NULL 1264 #define pci_pm_poweroff NULL 1265 #define pci_pm_poweroff_late NULL 1266 #define pci_pm_poweroff_noirq NULL 1267 #define pci_pm_restore NULL 1268 #define pci_pm_restore_noirq NULL 1269 1270 #endif /* !CONFIG_HIBERNATE_CALLBACKS */ 1271 1272 #ifdef CONFIG_PM 1273 1274 static int pci_pm_runtime_suspend(struct device *dev) 1275 { 1276 struct pci_dev *pci_dev = to_pci_dev(dev); 1277 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL; 1278 pci_power_t prev = pci_dev->current_state; 1279 int error; 1280 1281 pci_suspend_ptm(pci_dev); 1282 1283 /* 1284 * If pci_dev->driver is not set (unbound), we leave the device in D0, 1285 * but it may go to D3cold when the bridge above it runtime suspends. 1286 * Save its config space in case that happens. 1287 */ 1288 if (!pci_dev->driver) { 1289 pci_save_state(pci_dev); 1290 return 0; 1291 } 1292 1293 pci_dev->state_saved = false; 1294 if (pm && pm->runtime_suspend) { 1295 error = pm->runtime_suspend(dev); 1296 /* 1297 * -EBUSY and -EAGAIN is used to request the runtime PM core 1298 * to schedule a new suspend, so log the event only with debug 1299 * log level. 1300 */ 1301 if (error == -EBUSY || error == -EAGAIN) { 1302 pci_dbg(pci_dev, "can't suspend now (%ps returned %d)\n", 1303 pm->runtime_suspend, error); 1304 return error; 1305 } else if (error) { 1306 pci_err(pci_dev, "can't suspend (%ps returned %d)\n", 1307 pm->runtime_suspend, error); 1308 return error; 1309 } 1310 } 1311 1312 pci_fixup_device(pci_fixup_suspend, pci_dev); 1313 1314 if (pm && pm->runtime_suspend 1315 && !pci_dev->state_saved && pci_dev->current_state != PCI_D0 1316 && pci_dev->current_state != PCI_UNKNOWN) { 1317 pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev, 1318 "PCI PM: State of device not saved by %pS\n", 1319 pm->runtime_suspend); 1320 return 0; 1321 } 1322 1323 if (!pci_dev->state_saved) { 1324 pci_save_state(pci_dev); 1325 pci_finish_runtime_suspend(pci_dev); 1326 } 1327 1328 return 0; 1329 } 1330 1331 static int pci_pm_runtime_resume(struct device *dev) 1332 { 1333 struct pci_dev *pci_dev = to_pci_dev(dev); 1334 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL; 1335 pci_power_t prev_state = pci_dev->current_state; 1336 int error = 0; 1337 1338 /* 1339 * Restoring config space is necessary even if the device is not bound 1340 * to a driver because although we left it in D0, it may have gone to 1341 * D3cold when the bridge above it runtime suspended. 1342 */ 1343 pci_pm_default_resume_early(pci_dev); 1344 pci_resume_ptm(pci_dev); 1345 1346 if (!pci_dev->driver) 1347 return 0; 1348 1349 pci_fixup_device(pci_fixup_resume_early, pci_dev); 1350 pci_pm_default_resume(pci_dev); 1351 1352 if (prev_state == PCI_D3cold) 1353 pci_pm_bridge_power_up_actions(pci_dev); 1354 1355 if (pm && pm->runtime_resume) 1356 error = pm->runtime_resume(dev); 1357 1358 return error; 1359 } 1360 1361 static int pci_pm_runtime_idle(struct device *dev) 1362 { 1363 struct pci_dev *pci_dev = to_pci_dev(dev); 1364 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL; 1365 1366 /* 1367 * If pci_dev->driver is not set (unbound), the device should 1368 * always remain in D0 regardless of the runtime PM status 1369 */ 1370 if (!pci_dev->driver) 1371 return 0; 1372 1373 if (!pm) 1374 return -ENOSYS; 1375 1376 if (pm->runtime_idle) 1377 return pm->runtime_idle(dev); 1378 1379 return 0; 1380 } 1381 1382 static const struct dev_pm_ops pci_dev_pm_ops = { 1383 .prepare = pci_pm_prepare, 1384 .complete = pci_pm_complete, 1385 .suspend = pci_pm_suspend, 1386 .suspend_late = pci_pm_suspend_late, 1387 .resume = pci_pm_resume, 1388 .resume_early = pci_pm_resume_early, 1389 .freeze = pci_pm_freeze, 1390 .thaw = pci_pm_thaw, 1391 .poweroff = pci_pm_poweroff, 1392 .poweroff_late = pci_pm_poweroff_late, 1393 .restore = pci_pm_restore, 1394 .suspend_noirq = pci_pm_suspend_noirq, 1395 .resume_noirq = pci_pm_resume_noirq, 1396 .freeze_noirq = pci_pm_freeze_noirq, 1397 .thaw_noirq = pci_pm_thaw_noirq, 1398 .poweroff_noirq = pci_pm_poweroff_noirq, 1399 .restore_noirq = pci_pm_restore_noirq, 1400 .runtime_suspend = pci_pm_runtime_suspend, 1401 .runtime_resume = pci_pm_runtime_resume, 1402 .runtime_idle = pci_pm_runtime_idle, 1403 }; 1404 1405 #define PCI_PM_OPS_PTR (&pci_dev_pm_ops) 1406 1407 #else /* !CONFIG_PM */ 1408 1409 #define pci_pm_runtime_suspend NULL 1410 #define pci_pm_runtime_resume NULL 1411 #define pci_pm_runtime_idle NULL 1412 1413 #define PCI_PM_OPS_PTR NULL 1414 1415 #endif /* !CONFIG_PM */ 1416 1417 /** 1418 * __pci_register_driver - register a new pci driver 1419 * @drv: the driver structure to register 1420 * @owner: owner module of drv 1421 * @mod_name: module name string 1422 * 1423 * Adds the driver structure to the list of registered drivers. 1424 * Returns a negative value on error, otherwise 0. 1425 * If no error occurred, the driver remains registered even if 1426 * no device was claimed during registration. 1427 */ 1428 int __pci_register_driver(struct pci_driver *drv, struct module *owner, 1429 const char *mod_name) 1430 { 1431 /* initialize common driver fields */ 1432 drv->driver.name = drv->name; 1433 drv->driver.bus = &pci_bus_type; 1434 drv->driver.owner = owner; 1435 drv->driver.mod_name = mod_name; 1436 drv->driver.groups = drv->groups; 1437 drv->driver.dev_groups = drv->dev_groups; 1438 1439 spin_lock_init(&drv->dynids.lock); 1440 INIT_LIST_HEAD(&drv->dynids.list); 1441 1442 /* register with core */ 1443 return driver_register(&drv->driver); 1444 } 1445 EXPORT_SYMBOL(__pci_register_driver); 1446 1447 /** 1448 * pci_unregister_driver - unregister a pci driver 1449 * @drv: the driver structure to unregister 1450 * 1451 * Deletes the driver structure from the list of registered PCI drivers, 1452 * gives it a chance to clean up by calling its remove() function for 1453 * each device it was responsible for, and marks those devices as 1454 * driverless. 1455 */ 1456 1457 void pci_unregister_driver(struct pci_driver *drv) 1458 { 1459 driver_unregister(&drv->driver); 1460 pci_free_dynids(drv); 1461 } 1462 EXPORT_SYMBOL(pci_unregister_driver); 1463 1464 static struct pci_driver pci_compat_driver = { 1465 .name = "compat" 1466 }; 1467 1468 /** 1469 * pci_dev_driver - get the pci_driver of a device 1470 * @dev: the device to query 1471 * 1472 * Returns the appropriate pci_driver structure or %NULL if there is no 1473 * registered driver for the device. 1474 */ 1475 struct pci_driver *pci_dev_driver(const struct pci_dev *dev) 1476 { 1477 int i; 1478 1479 if (dev->driver) 1480 return dev->driver; 1481 1482 for (i = 0; i <= PCI_ROM_RESOURCE; i++) 1483 if (dev->resource[i].flags & IORESOURCE_BUSY) 1484 return &pci_compat_driver; 1485 1486 return NULL; 1487 } 1488 EXPORT_SYMBOL(pci_dev_driver); 1489 1490 /** 1491 * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure 1492 * @dev: the PCI device structure to match against 1493 * @drv: the device driver to search for matching PCI device id structures 1494 * 1495 * Used by a driver to check whether a PCI device present in the 1496 * system is in its list of supported devices. Returns the matching 1497 * pci_device_id structure or %NULL if there is no match. 1498 */ 1499 static int pci_bus_match(struct device *dev, struct device_driver *drv) 1500 { 1501 struct pci_dev *pci_dev = to_pci_dev(dev); 1502 struct pci_driver *pci_drv; 1503 const struct pci_device_id *found_id; 1504 1505 if (!pci_dev->match_driver) 1506 return 0; 1507 1508 pci_drv = to_pci_driver(drv); 1509 found_id = pci_match_device(pci_drv, pci_dev); 1510 if (found_id) 1511 return 1; 1512 1513 return 0; 1514 } 1515 1516 /** 1517 * pci_dev_get - increments the reference count of the pci device structure 1518 * @dev: the device being referenced 1519 * 1520 * Each live reference to a device should be refcounted. 1521 * 1522 * Drivers for PCI devices should normally record such references in 1523 * their probe() methods, when they bind to a device, and release 1524 * them by calling pci_dev_put(), in their disconnect() methods. 1525 * 1526 * A pointer to the device with the incremented reference counter is returned. 1527 */ 1528 struct pci_dev *pci_dev_get(struct pci_dev *dev) 1529 { 1530 if (dev) 1531 get_device(&dev->dev); 1532 return dev; 1533 } 1534 EXPORT_SYMBOL(pci_dev_get); 1535 1536 /** 1537 * pci_dev_put - release a use of the pci device structure 1538 * @dev: device that's been disconnected 1539 * 1540 * Must be called when a user of a device is finished with it. When the last 1541 * user of the device calls this function, the memory of the device is freed. 1542 */ 1543 void pci_dev_put(struct pci_dev *dev) 1544 { 1545 if (dev) 1546 put_device(&dev->dev); 1547 } 1548 EXPORT_SYMBOL(pci_dev_put); 1549 1550 static int pci_uevent(const struct device *dev, struct kobj_uevent_env *env) 1551 { 1552 const struct pci_dev *pdev; 1553 1554 if (!dev) 1555 return -ENODEV; 1556 1557 pdev = to_pci_dev(dev); 1558 1559 if (add_uevent_var(env, "PCI_CLASS=%04X", pdev->class)) 1560 return -ENOMEM; 1561 1562 if (add_uevent_var(env, "PCI_ID=%04X:%04X", pdev->vendor, pdev->device)) 1563 return -ENOMEM; 1564 1565 if (add_uevent_var(env, "PCI_SUBSYS_ID=%04X:%04X", pdev->subsystem_vendor, 1566 pdev->subsystem_device)) 1567 return -ENOMEM; 1568 1569 if (add_uevent_var(env, "PCI_SLOT_NAME=%s", pci_name(pdev))) 1570 return -ENOMEM; 1571 1572 if (add_uevent_var(env, "MODALIAS=pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02X", 1573 pdev->vendor, pdev->device, 1574 pdev->subsystem_vendor, pdev->subsystem_device, 1575 (u8)(pdev->class >> 16), (u8)(pdev->class >> 8), 1576 (u8)(pdev->class))) 1577 return -ENOMEM; 1578 1579 return 0; 1580 } 1581 1582 #if defined(CONFIG_PCIEAER) || defined(CONFIG_EEH) 1583 /** 1584 * pci_uevent_ers - emit a uevent during recovery path of PCI device 1585 * @pdev: PCI device undergoing error recovery 1586 * @err_type: type of error event 1587 */ 1588 void pci_uevent_ers(struct pci_dev *pdev, enum pci_ers_result err_type) 1589 { 1590 int idx = 0; 1591 char *envp[3]; 1592 1593 switch (err_type) { 1594 case PCI_ERS_RESULT_NONE: 1595 case PCI_ERS_RESULT_CAN_RECOVER: 1596 envp[idx++] = "ERROR_EVENT=BEGIN_RECOVERY"; 1597 envp[idx++] = "DEVICE_ONLINE=0"; 1598 break; 1599 case PCI_ERS_RESULT_RECOVERED: 1600 envp[idx++] = "ERROR_EVENT=SUCCESSFUL_RECOVERY"; 1601 envp[idx++] = "DEVICE_ONLINE=1"; 1602 break; 1603 case PCI_ERS_RESULT_DISCONNECT: 1604 envp[idx++] = "ERROR_EVENT=FAILED_RECOVERY"; 1605 envp[idx++] = "DEVICE_ONLINE=0"; 1606 break; 1607 default: 1608 break; 1609 } 1610 1611 if (idx > 0) { 1612 envp[idx++] = NULL; 1613 kobject_uevent_env(&pdev->dev.kobj, KOBJ_CHANGE, envp); 1614 } 1615 } 1616 #endif 1617 1618 static int pci_bus_num_vf(struct device *dev) 1619 { 1620 return pci_num_vf(to_pci_dev(dev)); 1621 } 1622 1623 /** 1624 * pci_dma_configure - Setup DMA configuration 1625 * @dev: ptr to dev structure 1626 * 1627 * Function to update PCI devices's DMA configuration using the same 1628 * info from the OF node or ACPI node of host bridge's parent (if any). 1629 */ 1630 static int pci_dma_configure(struct device *dev) 1631 { 1632 struct pci_driver *driver = to_pci_driver(dev->driver); 1633 struct device *bridge; 1634 int ret = 0; 1635 1636 bridge = pci_get_host_bridge_device(to_pci_dev(dev)); 1637 1638 if (IS_ENABLED(CONFIG_OF) && bridge->parent && 1639 bridge->parent->of_node) { 1640 ret = of_dma_configure(dev, bridge->parent->of_node, true); 1641 } else if (has_acpi_companion(bridge)) { 1642 struct acpi_device *adev = to_acpi_device_node(bridge->fwnode); 1643 1644 ret = acpi_dma_configure(dev, acpi_get_dma_attr(adev)); 1645 } 1646 1647 pci_put_host_bridge_device(bridge); 1648 1649 if (!ret && !driver->driver_managed_dma) { 1650 ret = iommu_device_use_default_domain(dev); 1651 if (ret) 1652 arch_teardown_dma_ops(dev); 1653 } 1654 1655 return ret; 1656 } 1657 1658 static void pci_dma_cleanup(struct device *dev) 1659 { 1660 struct pci_driver *driver = to_pci_driver(dev->driver); 1661 1662 if (!driver->driver_managed_dma) 1663 iommu_device_unuse_default_domain(dev); 1664 } 1665 1666 struct bus_type pci_bus_type = { 1667 .name = "pci", 1668 .match = pci_bus_match, 1669 .uevent = pci_uevent, 1670 .probe = pci_device_probe, 1671 .remove = pci_device_remove, 1672 .shutdown = pci_device_shutdown, 1673 .dev_groups = pci_dev_groups, 1674 .bus_groups = pci_bus_groups, 1675 .drv_groups = pci_drv_groups, 1676 .pm = PCI_PM_OPS_PTR, 1677 .num_vf = pci_bus_num_vf, 1678 .dma_configure = pci_dma_configure, 1679 .dma_cleanup = pci_dma_cleanup, 1680 }; 1681 EXPORT_SYMBOL(pci_bus_type); 1682 1683 #ifdef CONFIG_PCIEPORTBUS 1684 static int pcie_port_bus_match(struct device *dev, struct device_driver *drv) 1685 { 1686 struct pcie_device *pciedev; 1687 struct pcie_port_service_driver *driver; 1688 1689 if (drv->bus != &pcie_port_bus_type || dev->bus != &pcie_port_bus_type) 1690 return 0; 1691 1692 pciedev = to_pcie_device(dev); 1693 driver = to_service_driver(drv); 1694 1695 if (driver->service != pciedev->service) 1696 return 0; 1697 1698 if (driver->port_type != PCIE_ANY_PORT && 1699 driver->port_type != pci_pcie_type(pciedev->port)) 1700 return 0; 1701 1702 return 1; 1703 } 1704 1705 struct bus_type pcie_port_bus_type = { 1706 .name = "pci_express", 1707 .match = pcie_port_bus_match, 1708 }; 1709 #endif 1710 1711 static int __init pci_driver_init(void) 1712 { 1713 int ret; 1714 1715 ret = bus_register(&pci_bus_type); 1716 if (ret) 1717 return ret; 1718 1719 #ifdef CONFIG_PCIEPORTBUS 1720 ret = bus_register(&pcie_port_bus_type); 1721 if (ret) 1722 return ret; 1723 #endif 1724 dma_debug_add_bus(&pci_bus_type); 1725 return 0; 1726 } 1727 postcore_initcall(pci_driver_init); 1728