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