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