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