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