Merge tag 'usb-6.8-rc3' of git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/usb
[linux-block.git] / drivers / pci / pci-driver.c
CommitLineData
8cfab3cf 1// SPDX-License-Identifier: GPL-2.0
1da177e4 2/*
2b937303
GKH
3 * (C) Copyright 2002-2004, 2007 Greg Kroah-Hartman <greg@kroah.com>
4 * (C) Copyright 2007 Novell Inc.
1da177e4
LT
5 */
6
7#include <linux/pci.h>
8#include <linux/module.h>
9#include <linux/init.h>
10#include <linux/device.h>
d42c6997 11#include <linux/mempolicy.h>
4e57b681
TS
12#include <linux/string.h>
13#include <linux/slab.h>
8c65b4a6 14#include <linux/sched.h>
69a18b18 15#include <linux/sched/isolation.h>
873392ca 16#include <linux/cpu.h>
6cbf8214 17#include <linux/pm_runtime.h>
eea3fc03 18#include <linux/suspend.h>
4fc9bbf9 19#include <linux/kexec.h>
07397df2
NG
20#include <linux/of_device.h>
21#include <linux/acpi.h>
a1fd09e8 22#include <linux/dma-map-ops.h>
512881ea 23#include <linux/iommu.h>
1da177e4 24#include "pci.h"
c6c889d9 25#include "pcie/portdrv.h"
1da177e4 26
75865858
GKH
27struct pci_dynid {
28 struct list_head node;
29 struct pci_device_id id;
30};
1da177e4 31
9dba910e
TH
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;
9dba910e
TH
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;
3d3c2ae1 72
9dba910e
TH
73 spin_lock(&drv->dynids.lock);
74 list_add_tail(&dynid->node, &drv->dynids.list);
75 spin_unlock(&drv->dynids.lock);
76
3b7f1016 77 return driver_attach(&drv->driver);
9dba910e 78}
b7fe9434 79EXPORT_SYMBOL_GPL(pci_add_dynid);
9dba910e
TH
80
81static void pci_free_dynids(struct pci_driver *drv)
82{
83 struct pci_dynid *dynid, *n;
3d3c2ae1 84
9dba910e
TH
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
1f40704b
ZD
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;
343b7258 140 const struct pci_device_id *found_id = NULL, *ids;
1f40704b
ZD
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
343b7258
MG
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 }
1f40704b
ZD
173
174 /* driver_override will always match, send a dummy id */
343b7258
MG
175 if (dev->driver_override)
176 return &pci_device_id_any;
177 return NULL;
1f40704b
ZD
178}
179
1da177e4 180/**
2f0cd59c 181 * new_id_store - sysfs frontend to pci_add_dynid()
8f7020d3
RD
182 * @driver: target device driver
183 * @buf: buffer for scanning device ID data
184 * @count: input size
1da177e4 185 *
9dba910e 186 * Allow PCI IDs to be added to an existing driver via sysfs.
1da177e4 187 */
a9427741 188static ssize_t new_id_store(struct device_driver *driver, const char *buf,
3c78bc61 189 size_t count)
1da177e4 190{
1da177e4 191 struct pci_driver *pdrv = to_pci_driver(driver);
b41d6cf3 192 const struct pci_device_id *ids = pdrv->id_table;
20a796a9 193 u32 vendor, device, subvendor = PCI_ANY_ID,
3c78bc61
RD
194 subdevice = PCI_ANY_ID, class = 0, class_mask = 0;
195 unsigned long driver_data = 0;
a49287d3 196 int fields;
8895d3bc 197 int retval = 0;
1da177e4 198
b41d6cf3 199 fields = sscanf(buf, "%x %x %x %x %x %x %lx",
1da177e4
LT
200 &vendor, &device, &subvendor, &subdevice,
201 &class, &class_mask, &driver_data);
6ba18636 202 if (fields < 2)
1da177e4
LT
203 return -EINVAL;
204
8895d3bc
BD
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
3853f912 216 if (pci_match_device(pdrv, pdev))
8895d3bc
BD
217 retval = -EEXIST;
218
219 kfree(pdev);
220
221 if (retval)
222 return retval;
223 }
224
b41d6cf3
JD
225 /* Only accept driver_data values that match an existing id_table
226 entry */
2debb4d2
CW
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++;
b41d6cf3 235 }
2debb4d2
CW
236 if (retval) /* No match */
237 return retval;
b41d6cf3 238 }
b41d6cf3 239
9dba910e
TH
240 retval = pci_add_dynid(pdrv, vendor, device, subvendor, subdevice,
241 class, class_mask, driver_data);
b19441af
GKH
242 if (retval)
243 return retval;
1da177e4
LT
244 return count;
245}
a9427741 246static DRIVER_ATTR_WO(new_id);
1da177e4 247
0994375e 248/**
2f0cd59c 249 * remove_id_store - remove a PCI device ID from this driver
0994375e
CW
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 */
a9427741 256static ssize_t remove_id_store(struct device_driver *driver, const char *buf,
3c78bc61 257 size_t count)
0994375e
CW
258{
259 struct pci_dynid *dynid, *n;
260 struct pci_driver *pdrv = to_pci_driver(driver);
20a796a9 261 u32 vendor, device, subvendor = PCI_ANY_ID,
0994375e 262 subdevice = PCI_ANY_ID, class = 0, class_mask = 0;
a49287d3 263 int fields;
9222097f 264 size_t retval = -ENODEV;
0994375e
CW
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);
9222097f 282 retval = count;
0994375e
CW
283 break;
284 }
285 }
286 spin_unlock(&pdrv->dynids.lock);
287
9222097f 288 return retval;
0994375e 289}
a9427741 290static DRIVER_ATTR_WO(remove_id);
0994375e 291
2229c1fb
GKH
292static struct attribute *pci_drv_attrs[] = {
293 &driver_attr_new_id.attr,
294 &driver_attr_remove_id.attr,
295 NULL,
bfb09a86 296};
2229c1fb 297ATTRIBUTE_GROUPS(pci_drv);
0994375e 298
873392ca
RR
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;
967577b0
HY
308 struct pci_dev *pci_dev = ddi->dev;
309 struct pci_driver *pci_drv = ddi->drv;
310 struct device *dev = &pci_dev->dev;
f3ec4f87
AS
311 int rc;
312
967577b0
HY
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
a8360062
RW
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.
f3ec4f87 321 */
967577b0 322 pm_runtime_get_sync(dev);
68da4e0e 323 pci_dev->driver = pci_drv;
967577b0 324 rc = pci_drv->probe(pci_dev, ddi->id);
f92d74c1
SC
325 if (!rc)
326 return rc;
327 if (rc < 0) {
68da4e0e 328 pci_dev->driver = NULL;
967577b0 329 pm_runtime_put_sync(dev);
f92d74c1 330 return rc;
f3ec4f87 331 }
f92d74c1
SC
332 /*
333 * Probe function should return < 0 for failure, 0 for success
334 * Treat values > 0 as success, but warn.
335 */
6941a0c2
BH
336 pci_warn(pci_dev, "Driver probe function unexpectedly returned %d\n",
337 rc);
f92d74c1 338 return 0;
873392ca
RR
339}
340
0b2c2a71
TG
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
d42c6997
AK
350static int pci_call_probe(struct pci_driver *drv, struct pci_dev *dev,
351 const struct pci_device_id *id)
352{
0b2c2a71 353 int error, node, cpu;
873392ca
RR
354 struct drv_dev_and_id ddi = { drv, dev, id };
355
12c3156f
AD
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 */
873392ca 361 node = dev_to_node(&dev->dev);
0b2c2a71
TG
362 dev->is_probed = 1;
363
364 cpu_hotplug_disable();
12c3156f
AD
365
366 /*
0b2c2a71
TG
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.
12c3156f 369 */
0b2c2a71 370 if (node < 0 || node >= MAX_NUMNODES || !node_online(node) ||
9d42ea0d 371 pci_physfn_is_probed(dev)) {
0b2c2a71 372 cpu = nr_cpu_ids;
9d42ea0d
FW
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,
04d4e665
FW
381 housekeeping_cpumask(HK_TYPE_WQ),
382 housekeeping_cpumask(HK_TYPE_DOMAIN));
9d42ea0d 383
69a18b18 384 cpu = cpumask_any_and(cpumask_of_node(node),
9d42ea0d
FW
385 wq_domain_mask);
386 free_cpumask_var(wq_domain_mask);
387 }
0b2c2a71
TG
388
389 if (cpu < nr_cpu_ids)
390 error = work_on_cpu(cpu, local_pci_probe, &ddi);
391 else
873392ca 392 error = local_pci_probe(&ddi);
9d42ea0d 393out:
0b2c2a71
TG
394 dev->is_probed = 0;
395 cpu_hotplug_enable();
d42c6997
AK
396 return error;
397}
398
1da177e4 399/**
23ea3793 400 * __pci_device_probe - check if a driver wants to claim a specific PCI device
8f7020d3
RD
401 * @drv: driver to call to check if it wants the PCI device
402 * @pci_dev: PCI device being probed
f7625980 403 *
8f7020d3 404 * returns 0 on success, else error.
68da4e0e 405 * side-effect: pci_dev->driver is set to drv when drv claims pci_dev.
1da177e4 406 */
3c78bc61 407static int __pci_device_probe(struct pci_driver *drv, struct pci_dev *pci_dev)
75865858
GKH
408{
409 const struct pci_device_id *id;
1da177e4
LT
410 int error = 0;
411
ae232f09 412 if (drv->probe) {
75865858
GKH
413 error = -ENODEV;
414
415 id = pci_match_device(drv, pci_dev);
416 if (id)
d42c6997 417 error = pci_call_probe(drv, pci_dev, id);
1da177e4
LT
418 }
419 return error;
420}
421
890e4847
JL
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
0e7df224
BW
431#ifdef CONFIG_PCI_IOV
432static inline bool pci_device_can_probe(struct pci_dev *pdev)
433{
2d2f4273
AW
434 return (!pdev->is_virtfn || pdev->physfn->sriov->drivers_autoprobe ||
435 pdev->driver_override);
0e7df224
BW
436}
437#else
438static inline bool pci_device_can_probe(struct pci_dev *pdev)
439{
440 return true;
441}
442#endif
443
3c78bc61 444static int pci_device_probe(struct device *dev)
1da177e4 445{
890e4847
JL
446 int error;
447 struct pci_dev *pci_dev = to_pci_dev(dev);
448 struct pci_driver *drv = to_pci_driver(dev->driver);
449
76002d8b
AW
450 if (!pci_device_can_probe(pci_dev))
451 return -ENODEV;
452
30fdfb92
MM
453 pci_assign_irq(pci_dev);
454
890e4847
JL
455 error = pcibios_alloc_irq(pci_dev);
456 if (error < 0)
457 return error;
1da177e4 458
1da177e4 459 pci_dev_get(pci_dev);
76002d8b
AW
460 error = __pci_device_probe(drv, pci_dev);
461 if (error) {
462 pcibios_free_irq(pci_dev);
463 pci_dev_put(pci_dev);
890e4847 464 }
1da177e4
LT
465
466 return error;
467}
468
fc7a6209 469static void pci_device_remove(struct device *dev)
1da177e4 470{
3c78bc61 471 struct pci_dev *pci_dev = to_pci_dev(dev);
e0217c5b 472 struct pci_driver *drv = pci_dev->driver;
1da177e4 473
097d9d41
UKK
474 if (drv->remove) {
475 pm_runtime_get_sync(dev);
476 drv->remove(pci_dev);
477 pm_runtime_put_noidle(dev);
1da177e4 478 }
097d9d41 479 pcibios_free_irq(pci_dev);
68da4e0e 480 pci_dev->driver = NULL;
097d9d41 481 pci_iov_remove(pci_dev);
1da177e4 482
f3ec4f87 483 /* Undo the runtime PM settings in local_pci_probe() */
967577b0 484 pm_runtime_put_sync(dev);
f3ec4f87 485
2449e06a
SL
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
1da177e4
LT
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
f7625980 497 * that don't like drivers doing that all of the time.
1da177e4
LT
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);
1da177e4
LT
503}
504
bbb44d9f
RW
505static void pci_device_shutdown(struct device *dev)
506{
507 struct pci_dev *pci_dev = to_pci_dev(dev);
e0217c5b 508 struct pci_driver *drv = pci_dev->driver;
bbb44d9f 509
3ff2de9b
HY
510 pm_runtime_resume(dev);
511
bbb44d9f
RW
512 if (drv && drv->shutdown)
513 drv->shutdown(pci_dev);
5b415f1e 514
b566a22c 515 /*
4fc9bbf9
KA
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.
b566a22c 521 */
4fc9bbf9 522 if (kexec_in_progress && (pci_dev->current_state <= PCI_D3hot))
6e0eda3c 523 pci_clear_master(pci_dev);
bbb44d9f
RW
524}
525
18a94192 526#ifdef CONFIG_PM_SLEEP
6cbf8214 527
18a94192 528/* Auxiliary functions used for system resume */
6cbf8214
RW
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
1d3c16a8 544 pci_restore_state(pci_dev);
0ce3fcaf 545 pci_pme_restore(pci_dev);
1d3c16a8 546 return 0;
6cbf8214 547}
18a94192
KK
548#endif /* CONFIG_PM_SLEEP */
549
550#ifdef CONFIG_PM
551
552/* Auxiliary functions used for system resume and run-time resume */
6cbf8214 553
f7b32a86
BH
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
0f40ac35 560static void pci_pm_power_up_and_verify_state(struct pci_dev *pci_dev)
6cbf8214 561{
db288c9c 562 pci_power_up(pci_dev);
81cfa590 563 pci_update_current_state(pci_dev, PCI_D0);
0f40ac35
RW
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);
db288c9c 569 pci_restore_state(pci_dev);
0ce3fcaf 570 pci_pme_restore(pci_dev);
6cbf8214
RW
571}
572
730643d3
RW
573static void pci_pm_bridge_power_up_actions(struct pci_dev *pci_dev)
574{
c8245810
MW
575 int ret;
576
577 ret = pci_bridge_wait_for_secondary_bus(pci_dev, "resume");
578 if (ret) {
579 /*
580 * The downstream link failed to come up, so mark the
581 * devices below as disconnected to make sure we don't
582 * attempt to resume them.
583 */
584 pci_walk_bus(pci_dev->subordinate, pci_dev_set_disconnected,
585 NULL);
586 return;
587 }
e74b2b58 588
730643d3
RW
589 /*
590 * When powering on a bridge from D3cold, the whole hierarchy may be
591 * powered on into D0uninitialized state, resume them to give them a
592 * chance to suspend again
593 */
594 pci_resume_bus(pci_dev->subordinate);
595}
596
18a94192
KK
597#endif /* CONFIG_PM */
598
599#ifdef CONFIG_PM_SLEEP
600
fa58d305
RW
601/*
602 * Default "suspend" method for devices that have no driver provided suspend,
603 * or not even a driver at all (second part).
bbb44d9f 604 */
bb808945 605static void pci_pm_set_unknown_state(struct pci_dev *pci_dev)
bbb44d9f 606{
bbb44d9f
RW
607 /*
608 * mark its power state as "unknown", since we don't know if
609 * e.g. the BIOS will change its device state when we suspend.
610 */
611 if (pci_dev->current_state == PCI_D0)
612 pci_dev->current_state = PCI_UNKNOWN;
613}
614
355a72d7
RW
615/*
616 * Default "resume" method for devices that have no driver provided resume,
617 * or not even a driver at all (second part).
618 */
bb808945 619static int pci_pm_reenable_device(struct pci_dev *pci_dev)
355a72d7
RW
620{
621 int retval;
622
b2105b9f 623 /* if the device was enabled before suspend, re-enable */
bbb44d9f
RW
624 retval = pci_reenable_device(pci_dev);
625 /*
626 * if the device was busmaster before the suspend, make it busmaster
627 * again
628 */
629 if (pci_dev->is_busmaster)
630 pci_set_master(pci_dev);
631
632 return retval;
633}
634
635static int pci_legacy_suspend(struct device *dev, pm_message_t state)
1da177e4 636{
3c78bc61 637 struct pci_dev *pci_dev = to_pci_dev(dev);
e0217c5b 638 struct pci_driver *drv = pci_dev->driver;
46939f8b 639
02669492 640 if (drv && drv->suspend) {
99dadce8 641 pci_power_t prev = pci_dev->current_state;
46939f8b 642 int error;
aa8c6c93 643
57ef8026 644 error = drv->suspend(pci_dev, state);
a759de69 645 suspend_report_result(dev, drv->suspend, error);
57ef8026
FP
646 if (error)
647 return error;
aa8c6c93 648
46939f8b 649 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
99dadce8 650 && pci_dev->current_state != PCI_UNKNOWN) {
12bcae44
BH
651 pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev,
652 "PCI PM: Device state not saved by %pS\n",
653 drv->suspend);
99dadce8 654 }
02669492 655 }
ad8cfa1d
RW
656
657 pci_fixup_device(pci_fixup_suspend, pci_dev);
658
46939f8b 659 return 0;
1da177e4
LT
660}
661
5984de0b 662static int pci_legacy_suspend_late(struct device *dev)
cbd69dbb 663{
3c78bc61 664 struct pci_dev *pci_dev = to_pci_dev(dev);
46939f8b
RW
665
666 if (!pci_dev->state_saved)
667 pci_save_state(pci_dev);
668
669 pci_pm_set_unknown_state(pci_dev);
670
7d2a01b8
AN
671 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
672
46939f8b 673 return 0;
cbd69dbb 674}
1da177e4 675
bbb44d9f 676static int pci_legacy_resume(struct device *dev)
1da177e4 677{
3c78bc61 678 struct pci_dev *pci_dev = to_pci_dev(dev);
e0217c5b 679 struct pci_driver *drv = pci_dev->driver;
1da177e4 680
ad8cfa1d
RW
681 pci_fixup_device(pci_fixup_resume, pci_dev);
682
aa8c6c93
RW
683 return drv && drv->resume ?
684 drv->resume(pci_dev) : pci_pm_reenable_device(pci_dev);
1da177e4
LT
685}
686
571ff758
RW
687/* Auxiliary functions used by the new power management framework */
688
5294e256 689static void pci_pm_default_suspend(struct pci_dev *pci_dev)
73410429 690{
5294e256 691 /* Disable non-bridge devices without PM support */
326c1cda 692 if (!pci_has_subordinate(pci_dev))
cbbc2f6b 693 pci_disable_enabled_device(pci_dev);
73410429
RW
694}
695
07e836e8
RW
696static bool pci_has_legacy_pm_support(struct pci_dev *pci_dev)
697{
e0217c5b 698 struct pci_driver *drv = pci_dev->driver;
1a1daf09 699 bool ret = drv && (drv->suspend || drv->resume);
bb808945
RW
700
701 /*
702 * Legacy PM support is used by default, so warn if the new framework is
703 * supported as well. Drivers are supposed to support either the
704 * former, or the latter, but not both at the same time.
705 */
12bcae44
BH
706 pci_WARN(pci_dev, ret && drv->driver.pm, "device %04x:%04x\n",
707 pci_dev->vendor, pci_dev->device);
bb808945
RW
708
709 return ret;
07e836e8
RW
710}
711
571ff758
RW
712/* New power management framework */
713
bbb44d9f
RW
714static int pci_pm_prepare(struct device *dev)
715{
0c7376ad 716 struct pci_dev *pci_dev = to_pci_dev(dev);
6da2f2cc 717 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
bbb44d9f 718
6da2f2cc
BH
719 if (pm && pm->prepare) {
720 int error = pm->prepare(dev);
08810a41 721 if (error < 0)
bac2a909 722 return error;
08810a41
RW
723
724 if (!error && dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_PREPARE))
725 return 0;
bac2a909 726 }
0c7376ad
RW
727 if (pci_dev_need_resume(pci_dev))
728 return 0;
729
730 /*
731 * The PME setting needs to be adjusted here in case the direct-complete
732 * optimization is used with respect to this device.
733 */
734 pci_dev_adjust_pme(pci_dev);
735 return 1;
bbb44d9f
RW
736}
737
2cef548a
RW
738static void pci_pm_complete(struct device *dev)
739{
a0d2a959
LW
740 struct pci_dev *pci_dev = to_pci_dev(dev);
741
742 pci_dev_complete_resume(pci_dev);
743 pm_generic_complete(dev);
744
745 /* Resume device if platform firmware has put it in reset-power-on */
bd755d77 746 if (pm_runtime_suspended(dev) && pm_resume_via_firmware()) {
a0d2a959
LW
747 pci_power_t pre_sleep_state = pci_dev->current_state;
748
b51033e0
RW
749 pci_refresh_power_state(pci_dev);
750 /*
751 * On platforms with ACPI this check may also trigger for
752 * devices sharing power resources if one of those power
753 * resources has been activated as a result of a change of the
754 * power state of another device sharing it. However, in that
755 * case it is also better to resume the device, in general.
756 */
a0d2a959
LW
757 if (pci_dev->current_state < pre_sleep_state)
758 pm_request_resume(dev);
759 }
2cef548a 760}
bbb44d9f 761
6cbf8214
RW
762#else /* !CONFIG_PM_SLEEP */
763
764#define pci_pm_prepare NULL
2cef548a 765#define pci_pm_complete NULL
6cbf8214
RW
766
767#endif /* !CONFIG_PM_SLEEP */
768
bbb44d9f 769#ifdef CONFIG_SUSPEND
a39bd851
BH
770static void pcie_pme_root_status_cleanup(struct pci_dev *pci_dev)
771{
772 /*
773 * Some BIOSes forget to clear Root PME Status bits after system
774 * wakeup, which breaks ACPI-based runtime wakeup on PCI Express.
775 * Clear those bits now just in case (shouldn't hurt).
776 */
777 if (pci_is_pcie(pci_dev) &&
3620c714
BH
778 (pci_pcie_type(pci_dev) == PCI_EXP_TYPE_ROOT_PORT ||
779 pci_pcie_type(pci_dev) == PCI_EXP_TYPE_RC_EC))
a39bd851
BH
780 pcie_clear_root_pme_status(pci_dev);
781}
bbb44d9f
RW
782
783static int pci_pm_suspend(struct device *dev)
784{
785 struct pci_dev *pci_dev = to_pci_dev(dev);
8150f32b 786 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
bbb44d9f 787
d491f2b7
RW
788 pci_dev->skip_bus_pm = false;
789
c01163db
BH
790 /*
791 * Disabling PTM allows some systems, e.g., Intel mobile chips
792 * since Coffee Lake, to enter a lower-power PM state.
793 */
794 pci_suspend_ptm(pci_dev);
795
ad8cfa1d
RW
796 if (pci_has_legacy_pm_support(pci_dev))
797 return pci_legacy_suspend(dev, PMSG_SUSPEND);
bb808945 798
5294e256
RW
799 if (!pm) {
800 pci_pm_default_suspend(pci_dev);
c4b65157 801 return 0;
5294e256
RW
802 }
803
7cd0602d 804 /*
c4b65157
RW
805 * PCI devices suspended at run time may need to be resumed at this
806 * point, because in general it may be necessary to reconfigure them for
807 * system suspend. Namely, if the device is expected to wake up the
808 * system from the sleep state, it may have to be reconfigured for this
809 * purpose, or if the device is not expected to wake up the system from
810 * the sleep state, it should be prevented from signaling wakeup events
811 * going forward.
812 *
813 * Also if the driver of the device does not indicate that its system
814 * suspend callbacks can cope with runtime-suspended devices, it is
815 * better to resume the device from runtime suspend here.
7cd0602d 816 */
c4b65157 817 if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
0c7376ad 818 pci_dev_need_resume(pci_dev)) {
c4b65157 819 pm_runtime_resume(dev);
656088aa 820 pci_dev->state_saved = false;
0c7376ad
RW
821 } else {
822 pci_dev_adjust_pme(pci_dev);
656088aa 823 }
7cd0602d 824
5294e256
RW
825 if (pm->suspend) {
826 pci_power_t prev = pci_dev->current_state;
827 int error;
828
ddb7c9d2 829 error = pm->suspend(dev);
a759de69 830 suspend_report_result(dev, pm->suspend, error);
5294e256
RW
831 if (error)
832 return error;
833
46939f8b 834 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
5294e256 835 && pci_dev->current_state != PCI_UNKNOWN) {
12bcae44
BH
836 pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev,
837 "PCI PM: State of device not saved by %pS\n",
838 pm->suspend);
5294e256 839 }
bbb44d9f 840 }
fa58d305 841
5294e256 842 return 0;
bbb44d9f
RW
843}
844
c4b65157
RW
845static int pci_pm_suspend_late(struct device *dev)
846{
fa2bfead 847 if (dev_pm_skip_suspend(dev))
c4b65157
RW
848 return 0;
849
850 pci_fixup_device(pci_fixup_suspend, to_pci_dev(dev));
851
852 return pm_generic_suspend_late(dev);
853}
854
bbb44d9f 855static int pci_pm_suspend_noirq(struct device *dev)
c8958177 856{
355a72d7 857 struct pci_dev *pci_dev = to_pci_dev(dev);
8150f32b 858 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
c8958177 859
fa2bfead 860 if (dev_pm_skip_suspend(dev))
c4b65157
RW
861 return 0;
862
bb808945 863 if (pci_has_legacy_pm_support(pci_dev))
5984de0b 864 return pci_legacy_suspend_late(dev);
bb808945 865
931ff68a
RW
866 if (!pm) {
867 pci_save_state(pci_dev);
7d2a01b8 868 goto Fixup;
931ff68a 869 }
46939f8b
RW
870
871 if (pm->suspend_noirq) {
872 pci_power_t prev = pci_dev->current_state;
873 int error;
874
875 error = pm->suspend_noirq(dev);
a759de69 876 suspend_report_result(dev, pm->suspend_noirq, error);
46939f8b
RW
877 if (error)
878 return error;
879
880 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
881 && pci_dev->current_state != PCI_UNKNOWN) {
12bcae44
BH
882 pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev,
883 "PCI PM: State of device not saved by %pS\n",
884 pm->suspend_noirq);
7d2a01b8 885 goto Fixup;
46939f8b 886 }
bbb44d9f
RW
887 }
888
4c00cba1
RJ
889 if (!pci_dev->state_saved) {
890 pci_save_state(pci_dev);
891
d491f2b7 892 /*
4c00cba1
RJ
893 * If the device is a bridge with a child in D0 below it,
894 * it needs to stay in D0, so check skip_bus_pm to avoid
895 * putting it into a low-power state in that case.
d491f2b7 896 */
4c00cba1 897 if (!pci_dev->skip_bus_pm && pci_power_manageable(pci_dev))
46939f8b
RW
898 pci_prepare_to_sleep(pci_dev);
899 }
d67e37d7 900
6941a0c2 901 pci_dbg(pci_dev, "PCI PM: Suspend power state: %s\n",
ca67ab5c
RW
902 pci_power_name(pci_dev->current_state));
903
3e26c5fe
RW
904 if (pci_dev->current_state == PCI_D0) {
905 pci_dev->skip_bus_pm = true;
906 /*
907 * Per PCI PM r1.2, table 6-1, a bridge must be in D0 if any
908 * downstream device is in D0, so avoid changing the power state
909 * of the parent bridge by setting the skip_bus_pm flag for it.
910 */
911 if (pci_dev->bus->self)
912 pci_dev->bus->self->skip_bus_pm = true;
913 }
914
471a739a 915 if (pci_dev->skip_bus_pm && pm_suspend_no_platform()) {
6941a0c2 916 pci_dbg(pci_dev, "PCI PM: Skipped\n");
3e26c5fe
RW
917 goto Fixup;
918 }
919
46939f8b
RW
920 pci_pm_set_unknown_state(pci_dev);
921
dbf0e4c7
AS
922 /*
923 * Some BIOSes from ASUS have a bug: If a USB EHCI host controller's
924 * PCI COMMAND register isn't 0, the BIOS assumes that the controller
925 * hasn't been quiesced and tries to turn it off. If the controller
926 * is already in D3, this can hang or cause memory corruption.
927 *
928 * Since the value of the COMMAND register doesn't matter once the
929 * device has been suspended, we can safely set it to 0 here.
930 */
931 if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
932 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
933
7d2a01b8
AN
934Fixup:
935 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
936
bd755d77
RW
937 /*
938 * If the target system sleep state is suspend-to-idle, it is sufficient
939 * to check whether or not the device's wakeup settings are good for
940 * runtime PM. Otherwise, the pm_resume_via_firmware() check will cause
941 * pci_pm_complete() to take care of fixing up the device's state
942 * anyway, if need be.
943 */
0fe8a1be
RW
944 if (device_can_wakeup(dev) && !device_may_wakeup(dev))
945 dev->power.may_skip_resume = false;
bd755d77 946
46939f8b 947 return 0;
c8958177 948}
1da177e4 949
f6dc1e5e 950static int pci_pm_resume_noirq(struct device *dev)
bbb44d9f
RW
951{
952 struct pci_dev *pci_dev = to_pci_dev(dev);
6da2f2cc 953 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
ad9001f2
MW
954 pci_power_t prev_state = pci_dev->current_state;
955 bool skip_bus_pm = pci_dev->skip_bus_pm;
bbb44d9f 956
76c70cb5 957 if (dev_pm_skip_resume(dev))
bd755d77
RW
958 return 0;
959
3e26c5fe
RW
960 /*
961 * In the suspend-to-idle case, devices left in D0 during suspend will
962 * stay in D0, so it is not necessary to restore or update their
471a739a
RW
963 * configuration here and attempting to put them into D0 again is
964 * pointless, so avoid doing that.
3e26c5fe 965 */
ad9001f2 966 if (!(skip_bus_pm && pm_suspend_no_platform()))
3e26c5fe
RW
967 pci_pm_default_resume_early(pci_dev);
968
969 pci_fixup_device(pci_fixup_resume_early, pci_dev);
ec6a75ef 970 pcie_pme_root_status_cleanup(pci_dev);
aa8c6c93 971
ad9001f2 972 if (!skip_bus_pm && prev_state == PCI_D3cold)
730643d3 973 pci_pm_bridge_power_up_actions(pci_dev);
ad9001f2 974
ad8cfa1d 975 if (pci_has_legacy_pm_support(pci_dev))
89cdbc35 976 return 0;
bb808945 977
6da2f2cc
BH
978 if (pm && pm->resume_noirq)
979 return pm->resume_noirq(dev);
bbb44d9f 980
6da2f2cc 981 return 0;
bbb44d9f
RW
982}
983
6e176bf8
RW
984static int pci_pm_resume_early(struct device *dev)
985{
76c70cb5 986 if (dev_pm_skip_resume(dev))
6e176bf8
RW
987 return 0;
988
989 return pm_generic_resume_early(dev);
990}
991
f6dc1e5e 992static int pci_pm_resume(struct device *dev)
bbb44d9f 993{
355a72d7 994 struct pci_dev *pci_dev = to_pci_dev(dev);
8150f32b 995 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
bbb44d9f 996
418e4da3
RW
997 /*
998 * This is necessary for the suspend error path in which resume is
999 * called without restoring the standard config registers of the device.
1000 */
1001 if (pci_dev->state_saved)
1002 pci_restore_standard_config(pci_dev);
1003
c01163db
BH
1004 pci_resume_ptm(pci_dev);
1005
ad8cfa1d 1006 if (pci_has_legacy_pm_support(pci_dev))
f6dc1e5e 1007 return pci_legacy_resume(dev);
bb808945 1008
5294e256 1009 pci_pm_default_resume(pci_dev);
73410429 1010
5294e256
RW
1011 if (pm) {
1012 if (pm->resume)
6da2f2cc 1013 return pm->resume(dev);
5294e256
RW
1014 } else {
1015 pci_pm_reenable_device(pci_dev);
1016 }
bbb44d9f 1017
6da2f2cc 1018 return 0;
bbb44d9f
RW
1019}
1020
1021#else /* !CONFIG_SUSPEND */
1022
1023#define pci_pm_suspend NULL
c4b65157 1024#define pci_pm_suspend_late NULL
bbb44d9f
RW
1025#define pci_pm_suspend_noirq NULL
1026#define pci_pm_resume NULL
6e176bf8 1027#define pci_pm_resume_early NULL
bbb44d9f
RW
1028#define pci_pm_resume_noirq NULL
1029
1030#endif /* !CONFIG_SUSPEND */
1031
1f112cee 1032#ifdef CONFIG_HIBERNATE_CALLBACKS
bbb44d9f
RW
1033
1034static int pci_pm_freeze(struct device *dev)
1035{
1036 struct pci_dev *pci_dev = to_pci_dev(dev);
8150f32b 1037 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
bbb44d9f 1038
ad8cfa1d
RW
1039 if (pci_has_legacy_pm_support(pci_dev))
1040 return pci_legacy_suspend(dev, PMSG_FREEZE);
bb808945 1041
5294e256
RW
1042 if (!pm) {
1043 pci_pm_default_suspend(pci_dev);
1044 return 0;
bbb44d9f
RW
1045 }
1046
7cd0602d 1047 /*
501debd4
RW
1048 * Resume all runtime-suspended devices before creating a snapshot
1049 * image of system memory, because the restore kernel generally cannot
1050 * be expected to always handle them consistently and they need to be
1051 * put into the runtime-active metastate during system resume anyway,
1052 * so it is better to ensure that the state saved in the image will be
1053 * always consistent with that.
7cd0602d 1054 */
501debd4
RW
1055 pm_runtime_resume(dev);
1056 pci_dev->state_saved = false;
7cd0602d 1057
5294e256
RW
1058 if (pm->freeze) {
1059 int error;
1060
1061 error = pm->freeze(dev);
a759de69 1062 suspend_report_result(dev, pm->freeze, error);
5294e256
RW
1063 if (error)
1064 return error;
1065 }
1066
5294e256 1067 return 0;
bbb44d9f
RW
1068}
1069
1070static int pci_pm_freeze_noirq(struct device *dev)
1071{
355a72d7 1072 struct pci_dev *pci_dev = to_pci_dev(dev);
6da2f2cc 1073 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
bbb44d9f 1074
bb808945 1075 if (pci_has_legacy_pm_support(pci_dev))
5984de0b 1076 return pci_legacy_suspend_late(dev);
bb808945 1077
6da2f2cc 1078 if (pm && pm->freeze_noirq) {
46939f8b
RW
1079 int error;
1080
6da2f2cc 1081 error = pm->freeze_noirq(dev);
a759de69 1082 suspend_report_result(dev, pm->freeze_noirq, error);
46939f8b
RW
1083 if (error)
1084 return error;
bbb44d9f
RW
1085 }
1086
46939f8b
RW
1087 if (!pci_dev->state_saved)
1088 pci_save_state(pci_dev);
d67e37d7 1089
46939f8b
RW
1090 pci_pm_set_unknown_state(pci_dev);
1091
1092 return 0;
bbb44d9f
RW
1093}
1094
f6dc1e5e 1095static int pci_pm_thaw_noirq(struct device *dev)
bbb44d9f 1096{
355a72d7 1097 struct pci_dev *pci_dev = to_pci_dev(dev);
6da2f2cc 1098 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
699c1985 1099
5839ee73 1100 /*
89cdbc35
BH
1101 * The pm->thaw_noirq() callback assumes the device has been
1102 * returned to D0 and its config state has been restored.
f2c33cca
DC
1103 *
1104 * In addition, pci_restore_state() restores MSI-X state in MMIO
1105 * space, which requires the device to be in D0, so return it to D0
1106 * in case the driver's "freeze" callbacks put it into a low-power
1107 * state.
5839ee73 1108 */
0f40ac35 1109 pci_pm_power_up_and_verify_state(pci_dev);
e60514bd 1110 pci_restore_state(pci_dev);
d67e37d7 1111
f2c33cca 1112 if (pci_has_legacy_pm_support(pci_dev))
89cdbc35 1113 return 0;
f2c33cca 1114
6da2f2cc
BH
1115 if (pm && pm->thaw_noirq)
1116 return pm->thaw_noirq(dev);
bbb44d9f 1117
6da2f2cc 1118 return 0;
bbb44d9f
RW
1119}
1120
f6dc1e5e 1121static int pci_pm_thaw(struct device *dev)
bbb44d9f 1122{
355a72d7 1123 struct pci_dev *pci_dev = to_pci_dev(dev);
8150f32b 1124 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
bbb44d9f
RW
1125 int error = 0;
1126
ad8cfa1d 1127 if (pci_has_legacy_pm_support(pci_dev))
f6dc1e5e 1128 return pci_legacy_resume(dev);
bb808945 1129
5294e256
RW
1130 if (pm) {
1131 if (pm->thaw)
1132 error = pm->thaw(dev);
1133 } else {
1134 pci_pm_reenable_device(pci_dev);
1135 }
bbb44d9f 1136
4b77b0a2
RW
1137 pci_dev->state_saved = false;
1138
bbb44d9f
RW
1139 return error;
1140}
1141
1142static int pci_pm_poweroff(struct device *dev)
1143{
355a72d7 1144 struct pci_dev *pci_dev = to_pci_dev(dev);
8150f32b 1145 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
bbb44d9f 1146
ad8cfa1d
RW
1147 if (pci_has_legacy_pm_support(pci_dev))
1148 return pci_legacy_suspend(dev, PMSG_HIBERNATE);
bb808945 1149
5294e256
RW
1150 if (!pm) {
1151 pci_pm_default_suspend(pci_dev);
c4b65157 1152 return 0;
5294e256
RW
1153 }
1154
7cd0602d 1155 /* The reason to do that is the same as in pci_pm_suspend(). */
c4b65157 1156 if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
0c7376ad 1157 pci_dev_need_resume(pci_dev)) {
c4b65157 1158 pm_runtime_resume(dev);
0c7376ad
RW
1159 pci_dev->state_saved = false;
1160 } else {
1161 pci_dev_adjust_pme(pci_dev);
1162 }
7cd0602d 1163
5294e256 1164 if (pm->poweroff) {
46939f8b
RW
1165 int error;
1166
ddb7c9d2 1167 error = pm->poweroff(dev);
a759de69 1168 suspend_report_result(dev, pm->poweroff, error);
46939f8b
RW
1169 if (error)
1170 return error;
bbb44d9f
RW
1171 }
1172
46939f8b 1173 return 0;
bbb44d9f 1174}
c9b9972b 1175
c4b65157
RW
1176static int pci_pm_poweroff_late(struct device *dev)
1177{
fa2bfead 1178 if (dev_pm_skip_suspend(dev))
c4b65157 1179 return 0;
699c1985 1180
c4b65157
RW
1181 pci_fixup_device(pci_fixup_suspend, to_pci_dev(dev));
1182
1183 return pm_generic_poweroff_late(dev);
bbb44d9f
RW
1184}
1185
1186static int pci_pm_poweroff_noirq(struct device *dev)
1187{
46939f8b 1188 struct pci_dev *pci_dev = to_pci_dev(dev);
6da2f2cc 1189 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
bbb44d9f 1190
fa2bfead 1191 if (dev_pm_skip_suspend(dev))
c4b65157
RW
1192 return 0;
1193
6da2f2cc 1194 if (pci_has_legacy_pm_support(pci_dev))
5984de0b 1195 return pci_legacy_suspend_late(dev);
bb808945 1196
6da2f2cc 1197 if (!pm) {
7d2a01b8 1198 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
46939f8b 1199 return 0;
7d2a01b8 1200 }
46939f8b 1201
6da2f2cc 1202 if (pm->poweroff_noirq) {
46939f8b
RW
1203 int error;
1204
6da2f2cc 1205 error = pm->poweroff_noirq(dev);
a759de69 1206 suspend_report_result(dev, pm->poweroff_noirq, error);
46939f8b
RW
1207 if (error)
1208 return error;
bbb44d9f
RW
1209 }
1210
326c1cda 1211 if (!pci_dev->state_saved && !pci_has_subordinate(pci_dev))
46939f8b
RW
1212 pci_prepare_to_sleep(pci_dev);
1213
0b68c8e2
RW
1214 /*
1215 * The reason for doing this here is the same as for the analogous code
1216 * in pci_pm_suspend_noirq().
1217 */
1218 if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
1219 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
1220
7d2a01b8
AN
1221 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1222
46939f8b 1223 return 0;
bbb44d9f
RW
1224}
1225
f6dc1e5e 1226static int pci_pm_restore_noirq(struct device *dev)
bbb44d9f
RW
1227{
1228 struct pci_dev *pci_dev = to_pci_dev(dev);
6da2f2cc 1229 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
699c1985 1230
6cbf8214 1231 pci_pm_default_resume_early(pci_dev);
3e26c5fe 1232 pci_fixup_device(pci_fixup_resume_early, pci_dev);
aa8c6c93 1233
ad8cfa1d 1234 if (pci_has_legacy_pm_support(pci_dev))
89cdbc35 1235 return 0;
bb808945 1236
6da2f2cc
BH
1237 if (pm && pm->restore_noirq)
1238 return pm->restore_noirq(dev);
bbb44d9f 1239
6da2f2cc 1240 return 0;
bbb44d9f
RW
1241}
1242
f6dc1e5e 1243static int pci_pm_restore(struct device *dev)
bbb44d9f
RW
1244{
1245 struct pci_dev *pci_dev = to_pci_dev(dev);
8150f32b 1246 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
bbb44d9f 1247
418e4da3
RW
1248 /*
1249 * This is necessary for the hibernation error path in which restore is
1250 * called without restoring the standard config registers of the device.
1251 */
1252 if (pci_dev->state_saved)
1253 pci_restore_standard_config(pci_dev);
1254
ad8cfa1d 1255 if (pci_has_legacy_pm_support(pci_dev))
f6dc1e5e 1256 return pci_legacy_resume(dev);
bb808945 1257
5294e256 1258 pci_pm_default_resume(pci_dev);
73410429 1259
5294e256
RW
1260 if (pm) {
1261 if (pm->restore)
6da2f2cc 1262 return pm->restore(dev);
5294e256
RW
1263 } else {
1264 pci_pm_reenable_device(pci_dev);
1265 }
bbb44d9f 1266
6da2f2cc 1267 return 0;
c8958177 1268}
1da177e4 1269
1f112cee 1270#else /* !CONFIG_HIBERNATE_CALLBACKS */
bbb44d9f
RW
1271
1272#define pci_pm_freeze NULL
1273#define pci_pm_freeze_noirq NULL
1274#define pci_pm_thaw NULL
1275#define pci_pm_thaw_noirq NULL
1276#define pci_pm_poweroff NULL
c4b65157 1277#define pci_pm_poweroff_late NULL
bbb44d9f
RW
1278#define pci_pm_poweroff_noirq NULL
1279#define pci_pm_restore NULL
1280#define pci_pm_restore_noirq NULL
1281
1f112cee 1282#endif /* !CONFIG_HIBERNATE_CALLBACKS */
bbb44d9f 1283
fbb988be 1284#ifdef CONFIG_PM
6cbf8214
RW
1285
1286static int pci_pm_runtime_suspend(struct device *dev)
1287{
1288 struct pci_dev *pci_dev = to_pci_dev(dev);
1289 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1290 pci_power_t prev = pci_dev->current_state;
1291 int error;
1292
c01163db
BH
1293 pci_suspend_ptm(pci_dev);
1294
967577b0 1295 /*
e0217c5b
BH
1296 * If pci_dev->driver is not set (unbound), we leave the device in D0,
1297 * but it may go to D3cold when the bridge above it runtime suspends.
1298 * Save its config space in case that happens.
967577b0 1299 */
e0217c5b 1300 if (!pci_dev->driver) {
5775b843 1301 pci_save_state(pci_dev);
967577b0 1302 return 0;
5775b843 1303 }
967577b0 1304
82fee4d6 1305 pci_dev->state_saved = false;
c5eb1190
JN
1306 if (pm && pm->runtime_suspend) {
1307 error = pm->runtime_suspend(dev);
06bf403d
ID
1308 /*
1309 * -EBUSY and -EAGAIN is used to request the runtime PM core
1310 * to schedule a new suspend, so log the event only with debug
1311 * log level.
1312 */
c5eb1190 1313 if (error == -EBUSY || error == -EAGAIN) {
6941a0c2 1314 pci_dbg(pci_dev, "can't suspend now (%ps returned %d)\n",
06bf403d 1315 pm->runtime_suspend, error);
c5eb1190
JN
1316 return error;
1317 } else if (error) {
6941a0c2 1318 pci_err(pci_dev, "can't suspend (%ps returned %d)\n",
06bf403d 1319 pm->runtime_suspend, error);
c5eb1190
JN
1320 return error;
1321 }
06bf403d 1322 }
6cbf8214
RW
1323
1324 pci_fixup_device(pci_fixup_suspend, pci_dev);
1325
c5eb1190
JN
1326 if (pm && pm->runtime_suspend
1327 && !pci_dev->state_saved && pci_dev->current_state != PCI_D0
6cbf8214 1328 && pci_dev->current_state != PCI_UNKNOWN) {
12bcae44
BH
1329 pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev,
1330 "PCI PM: State of device not saved by %pS\n",
1331 pm->runtime_suspend);
6cbf8214
RW
1332 return 0;
1333 }
1334
42eca230 1335 if (!pci_dev->state_saved) {
6cbf8214 1336 pci_save_state(pci_dev);
42eca230
DA
1337 pci_finish_runtime_suspend(pci_dev);
1338 }
6cbf8214
RW
1339
1340 return 0;
1341}
1342
1343static int pci_pm_runtime_resume(struct device *dev)
1344{
1345 struct pci_dev *pci_dev = to_pci_dev(dev);
1346 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
ad9001f2 1347 pci_power_t prev_state = pci_dev->current_state;
6da2f2cc 1348 int error = 0;
6cbf8214 1349
967577b0 1350 /*
5775b843
RW
1351 * Restoring config space is necessary even if the device is not bound
1352 * to a driver because although we left it in D0, it may have gone to
1353 * D3cold when the bridge above it runtime suspended.
967577b0 1354 */
9a605831 1355 pci_pm_default_resume_early(pci_dev);
c01163db 1356 pci_resume_ptm(pci_dev);
5775b843 1357
e0217c5b 1358 if (!pci_dev->driver)
967577b0
HY
1359 return 0;
1360
db288c9c 1361 pci_fixup_device(pci_fixup_resume_early, pci_dev);
f7b32a86 1362 pci_pm_default_resume(pci_dev);
6cbf8214 1363
ad9001f2 1364 if (prev_state == PCI_D3cold)
730643d3 1365 pci_pm_bridge_power_up_actions(pci_dev);
ad9001f2 1366
c5eb1190 1367 if (pm && pm->runtime_resume)
6da2f2cc 1368 error = pm->runtime_resume(dev);
448bd857 1369
6da2f2cc 1370 return error;
6cbf8214
RW
1371}
1372
1373static int pci_pm_runtime_idle(struct device *dev)
1374{
e0217c5b 1375 struct pci_dev *pci_dev = to_pci_dev(dev);
6cbf8214
RW
1376 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1377
967577b0 1378 /*
e0217c5b
BH
1379 * If pci_dev->driver is not set (unbound), the device should
1380 * always remain in D0 regardless of the runtime PM status
967577b0 1381 */
e0217c5b 1382 if (!pci_dev->driver)
45f0a85c 1383 return 0;
967577b0 1384
6cbf8214
RW
1385 if (!pm)
1386 return -ENOSYS;
1387
45f0a85c 1388 if (pm->runtime_idle)
6da2f2cc 1389 return pm->runtime_idle(dev);
6cbf8214 1390
6da2f2cc 1391 return 0;
6cbf8214
RW
1392}
1393
f91da04d 1394static const struct dev_pm_ops pci_dev_pm_ops = {
adf09493 1395 .prepare = pci_pm_prepare,
2cef548a 1396 .complete = pci_pm_complete,
adf09493 1397 .suspend = pci_pm_suspend,
c4b65157 1398 .suspend_late = pci_pm_suspend_late,
adf09493 1399 .resume = pci_pm_resume,
6e176bf8 1400 .resume_early = pci_pm_resume_early,
adf09493
RW
1401 .freeze = pci_pm_freeze,
1402 .thaw = pci_pm_thaw,
1403 .poweroff = pci_pm_poweroff,
c4b65157 1404 .poweroff_late = pci_pm_poweroff_late,
adf09493 1405 .restore = pci_pm_restore,
bbb44d9f
RW
1406 .suspend_noirq = pci_pm_suspend_noirq,
1407 .resume_noirq = pci_pm_resume_noirq,
1408 .freeze_noirq = pci_pm_freeze_noirq,
1409 .thaw_noirq = pci_pm_thaw_noirq,
1410 .poweroff_noirq = pci_pm_poweroff_noirq,
1411 .restore_noirq = pci_pm_restore_noirq,
6cbf8214
RW
1412 .runtime_suspend = pci_pm_runtime_suspend,
1413 .runtime_resume = pci_pm_runtime_resume,
1414 .runtime_idle = pci_pm_runtime_idle,
bbb44d9f
RW
1415};
1416
adf09493 1417#define PCI_PM_OPS_PTR (&pci_dev_pm_ops)
bbb44d9f 1418
fbb988be
RW
1419#else /* !CONFIG_PM */
1420
1421#define pci_pm_runtime_suspend NULL
1422#define pci_pm_runtime_resume NULL
1423#define pci_pm_runtime_idle NULL
bbb44d9f
RW
1424
1425#define PCI_PM_OPS_PTR NULL
1426
fbb988be 1427#endif /* !CONFIG_PM */
bbb44d9f 1428
1da177e4 1429/**
863b18f4 1430 * __pci_register_driver - register a new pci driver
1da177e4 1431 * @drv: the driver structure to register
863b18f4 1432 * @owner: owner module of drv
f95d882d 1433 * @mod_name: module name string
f7625980 1434 *
1da177e4 1435 * Adds the driver structure to the list of registered drivers.
f7625980
BH
1436 * Returns a negative value on error, otherwise 0.
1437 * If no error occurred, the driver remains registered even if
1da177e4
LT
1438 * no device was claimed during registration.
1439 */
725522b5
GKH
1440int __pci_register_driver(struct pci_driver *drv, struct module *owner,
1441 const char *mod_name)
1da177e4 1442{
1da177e4
LT
1443 /* initialize common driver fields */
1444 drv->driver.name = drv->name;
1445 drv->driver.bus = &pci_bus_type;
863b18f4 1446 drv->driver.owner = owner;
725522b5 1447 drv->driver.mod_name = mod_name;
92d50fc1 1448 drv->driver.groups = drv->groups;
ded13b9c 1449 drv->driver.dev_groups = drv->dev_groups;
50b00755 1450
75865858
GKH
1451 spin_lock_init(&drv->dynids.lock);
1452 INIT_LIST_HEAD(&drv->dynids.list);
1da177e4
LT
1453
1454 /* register with core */
bfb09a86 1455 return driver_register(&drv->driver);
1da177e4 1456}
b7fe9434 1457EXPORT_SYMBOL(__pci_register_driver);
1da177e4
LT
1458
1459/**
1460 * pci_unregister_driver - unregister a pci driver
1461 * @drv: the driver structure to unregister
f7625980 1462 *
1da177e4
LT
1463 * Deletes the driver structure from the list of registered PCI drivers,
1464 * gives it a chance to clean up by calling its remove() function for
1465 * each device it was responsible for, and marks those devices as
1466 * driverless.
1467 */
1468
3c78bc61 1469void pci_unregister_driver(struct pci_driver *drv)
1da177e4
LT
1470{
1471 driver_unregister(&drv->driver);
1472 pci_free_dynids(drv);
1473}
b7fe9434 1474EXPORT_SYMBOL(pci_unregister_driver);
1da177e4
LT
1475
1476static struct pci_driver pci_compat_driver = {
1477 .name = "compat"
1478};
1479
1480/**
1481 * pci_dev_driver - get the pci_driver of a device
1482 * @dev: the device to query
1483 *
f7625980 1484 * Returns the appropriate pci_driver structure or %NULL if there is no
1da177e4
LT
1485 * registered driver for the device.
1486 */
3c78bc61 1487struct pci_driver *pci_dev_driver(const struct pci_dev *dev)
1da177e4 1488{
1ec09529
BH
1489 int i;
1490
e0217c5b
BH
1491 if (dev->driver)
1492 return dev->driver;
1ec09529
BH
1493
1494 for (i = 0; i <= PCI_ROM_RESOURCE; i++)
1495 if (dev->resource[i].flags & IORESOURCE_BUSY)
1496 return &pci_compat_driver;
1497
1da177e4
LT
1498 return NULL;
1499}
b7fe9434 1500EXPORT_SYMBOL(pci_dev_driver);
1da177e4
LT
1501
1502/**
1503 * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure
1da177e4 1504 * @dev: the PCI device structure to match against
8f7020d3 1505 * @drv: the device driver to search for matching PCI device id structures
f7625980 1506 *
1da177e4 1507 * Used by a driver to check whether a PCI device present in the
8f7020d3 1508 * system is in its list of supported devices. Returns the matching
1da177e4
LT
1509 * pci_device_id structure or %NULL if there is no match.
1510 */
75865858 1511static int pci_bus_match(struct device *dev, struct device_driver *drv)
1da177e4 1512{
75865858 1513 struct pci_dev *pci_dev = to_pci_dev(dev);
58d9a38f 1514 struct pci_driver *pci_drv;
1da177e4
LT
1515 const struct pci_device_id *found_id;
1516
58d9a38f
YL
1517 if (!pci_dev->match_driver)
1518 return 0;
1519
1520 pci_drv = to_pci_driver(drv);
75865858 1521 found_id = pci_match_device(pci_drv, pci_dev);
1da177e4
LT
1522 if (found_id)
1523 return 1;
1524
75865858 1525 return 0;
1da177e4
LT
1526}
1527
1528/**
1529 * pci_dev_get - increments the reference count of the pci device structure
1530 * @dev: the device being referenced
1531 *
1532 * Each live reference to a device should be refcounted.
1533 *
1534 * Drivers for PCI devices should normally record such references in
1535 * their probe() methods, when they bind to a device, and release
1536 * them by calling pci_dev_put(), in their disconnect() methods.
1537 *
1538 * A pointer to the device with the incremented reference counter is returned.
1539 */
1540struct pci_dev *pci_dev_get(struct pci_dev *dev)
1541{
1542 if (dev)
1543 get_device(&dev->dev);
1544 return dev;
1545}
b7fe9434 1546EXPORT_SYMBOL(pci_dev_get);
1da177e4
LT
1547
1548/**
1549 * pci_dev_put - release a use of the pci device structure
1550 * @dev: device that's been disconnected
1551 *
1552 * Must be called when a user of a device is finished with it. When the last
1553 * user of the device calls this function, the memory of the device is freed.
1554 */
1555void pci_dev_put(struct pci_dev *dev)
1556{
1557 if (dev)
1558 put_device(&dev->dev);
1559}
b7fe9434 1560EXPORT_SYMBOL(pci_dev_put);
1da177e4 1561
2a81ada3 1562static int pci_uevent(const struct device *dev, struct kobj_uevent_env *env)
8ccc9aa1 1563{
2a81ada3 1564 const struct pci_dev *pdev;
8ccc9aa1
BP
1565
1566 if (!dev)
1567 return -ENODEV;
1568
1569 pdev = to_pci_dev(dev);
8ccc9aa1
BP
1570
1571 if (add_uevent_var(env, "PCI_CLASS=%04X", pdev->class))
1572 return -ENOMEM;
1573
1574 if (add_uevent_var(env, "PCI_ID=%04X:%04X", pdev->vendor, pdev->device))
1575 return -ENOMEM;
1576
1577 if (add_uevent_var(env, "PCI_SUBSYS_ID=%04X:%04X", pdev->subsystem_vendor,
1578 pdev->subsystem_device))
1579 return -ENOMEM;
1580
1581 if (add_uevent_var(env, "PCI_SLOT_NAME=%s", pci_name(pdev)))
1582 return -ENOMEM;
1583
145b3fe5 1584 if (add_uevent_var(env, "MODALIAS=pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02X",
8ccc9aa1
BP
1585 pdev->vendor, pdev->device,
1586 pdev->subsystem_vendor, pdev->subsystem_device,
1587 (u8)(pdev->class >> 16), (u8)(pdev->class >> 8),
1588 (u8)(pdev->class)))
1589 return -ENOMEM;
efdd4070 1590
8ccc9aa1
BP
1591 return 0;
1592}
1593
f9a6c8ad 1594#if defined(CONFIG_PCIEAER) || defined(CONFIG_EEH)
3ecac020
ME
1595/**
1596 * pci_uevent_ers - emit a uevent during recovery path of PCI device
1597 * @pdev: PCI device undergoing error recovery
1598 * @err_type: type of error event
1599 */
1600void pci_uevent_ers(struct pci_dev *pdev, enum pci_ers_result err_type)
1601{
1602 int idx = 0;
1603 char *envp[3];
1604
1605 switch (err_type) {
1606 case PCI_ERS_RESULT_NONE:
1607 case PCI_ERS_RESULT_CAN_RECOVER:
1608 envp[idx++] = "ERROR_EVENT=BEGIN_RECOVERY";
1609 envp[idx++] = "DEVICE_ONLINE=0";
1610 break;
1611 case PCI_ERS_RESULT_RECOVERED:
1612 envp[idx++] = "ERROR_EVENT=SUCCESSFUL_RECOVERY";
1613 envp[idx++] = "DEVICE_ONLINE=1";
1614 break;
1615 case PCI_ERS_RESULT_DISCONNECT:
1616 envp[idx++] = "ERROR_EVENT=FAILED_RECOVERY";
1617 envp[idx++] = "DEVICE_ONLINE=0";
1618 break;
1619 default:
1620 break;
1621 }
1622
1623 if (idx > 0) {
1624 envp[idx++] = NULL;
1625 kobject_uevent_env(&pdev->dev.kobj, KOBJ_CHANGE, envp);
1626 }
1627}
1628#endif
1629
02e0bea6
PS
1630static int pci_bus_num_vf(struct device *dev)
1631{
1632 return pci_num_vf(to_pci_dev(dev));
1633}
1634
07397df2
NG
1635/**
1636 * pci_dma_configure - Setup DMA configuration
1637 * @dev: ptr to dev structure
1638 *
1639 * Function to update PCI devices's DMA configuration using the same
1640 * info from the OF node or ACPI node of host bridge's parent (if any).
1641 */
1642static int pci_dma_configure(struct device *dev)
1643{
512881ea 1644 struct pci_driver *driver = to_pci_driver(dev->driver);
07397df2
NG
1645 struct device *bridge;
1646 int ret = 0;
1647
1648 bridge = pci_get_host_bridge_device(to_pci_dev(dev));
1649
1650 if (IS_ENABLED(CONFIG_OF) && bridge->parent &&
1651 bridge->parent->of_node) {
3d6ce86e 1652 ret = of_dma_configure(dev, bridge->parent->of_node, true);
07397df2
NG
1653 } else if (has_acpi_companion(bridge)) {
1654 struct acpi_device *adev = to_acpi_device_node(bridge->fwnode);
07397df2 1655
e5361ca2 1656 ret = acpi_dma_configure(dev, acpi_get_dma_attr(adev));
07397df2
NG
1657 }
1658
1659 pci_put_host_bridge_device(bridge);
512881ea
LB
1660
1661 if (!ret && !driver->driver_managed_dma) {
1662 ret = iommu_device_use_default_domain(dev);
1663 if (ret)
1664 arch_teardown_dma_ops(dev);
1665 }
1666
07397df2
NG
1667 return ret;
1668}
1669
512881ea
LB
1670static void pci_dma_cleanup(struct device *dev)
1671{
1672 struct pci_driver *driver = to_pci_driver(dev->driver);
1673
1674 if (!driver->driver_managed_dma)
1675 iommu_device_unuse_default_domain(dev);
1676}
1677
1da177e4
LT
1678struct bus_type pci_bus_type = {
1679 .name = "pci",
1680 .match = pci_bus_match,
312c004d 1681 .uevent = pci_uevent,
b15d686a
RK
1682 .probe = pci_device_probe,
1683 .remove = pci_device_remove,
cbd69dbb 1684 .shutdown = pci_device_shutdown,
5136b2da 1685 .dev_groups = pci_dev_groups,
0f49ba55 1686 .bus_groups = pci_bus_groups,
2229c1fb 1687 .drv_groups = pci_drv_groups,
bbb44d9f 1688 .pm = PCI_PM_OPS_PTR,
02e0bea6 1689 .num_vf = pci_bus_num_vf,
07397df2 1690 .dma_configure = pci_dma_configure,
512881ea 1691 .dma_cleanup = pci_dma_cleanup,
1da177e4 1692};
b7fe9434 1693EXPORT_SYMBOL(pci_bus_type);
1da177e4 1694
c6c889d9
BH
1695#ifdef CONFIG_PCIEPORTBUS
1696static int pcie_port_bus_match(struct device *dev, struct device_driver *drv)
1697{
1698 struct pcie_device *pciedev;
1699 struct pcie_port_service_driver *driver;
1700
1701 if (drv->bus != &pcie_port_bus_type || dev->bus != &pcie_port_bus_type)
1702 return 0;
1703
1704 pciedev = to_pcie_device(dev);
1705 driver = to_service_driver(drv);
1706
1707 if (driver->service != pciedev->service)
1708 return 0;
1709
1710 if (driver->port_type != PCIE_ANY_PORT &&
1711 driver->port_type != pci_pcie_type(pciedev->port))
1712 return 0;
1713
1714 return 1;
1715}
1716
1717struct bus_type pcie_port_bus_type = {
1718 .name = "pci_express",
1719 .match = pcie_port_bus_match,
1720};
c6c889d9
BH
1721#endif
1722
1da177e4
LT
1723static int __init pci_driver_init(void)
1724{
c6c889d9
BH
1725 int ret;
1726
1727 ret = bus_register(&pci_bus_type);
1728 if (ret)
1729 return ret;
1730
1731#ifdef CONFIG_PCIEPORTBUS
1732 ret = bus_register(&pcie_port_bus_type);
1733 if (ret)
1734 return ret;
1735#endif
a8651194 1736 dma_debug_add_bus(&pci_bus_type);
c6c889d9 1737 return 0;
1da177e4 1738}
1da177e4 1739postcore_initcall(pci_driver_init);