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