]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - drivers/pci/pci-driver.c
PCI: Return error if cannot probe VF
[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{
402 return (!pdev->is_virtfn || pdev->physfn->sriov->drivers_autoprobe);
403}
404#else
405static inline bool pci_device_can_probe(struct pci_dev *pdev)
406{
407 return true;
408}
409#endif
410
3c78bc61 411static int pci_device_probe(struct device *dev)
1da177e4 412{
890e4847
JL
413 int error;
414 struct pci_dev *pci_dev = to_pci_dev(dev);
415 struct pci_driver *drv = to_pci_driver(dev->driver);
416
76002d8b
AW
417 if (!pci_device_can_probe(pci_dev))
418 return -ENODEV;
419
30fdfb92
MM
420 pci_assign_irq(pci_dev);
421
890e4847
JL
422 error = pcibios_alloc_irq(pci_dev);
423 if (error < 0)
424 return error;
1da177e4 425
1da177e4 426 pci_dev_get(pci_dev);
76002d8b
AW
427 error = __pci_device_probe(drv, pci_dev);
428 if (error) {
429 pcibios_free_irq(pci_dev);
430 pci_dev_put(pci_dev);
890e4847 431 }
1da177e4
LT
432
433 return error;
434}
435
3c78bc61 436static int pci_device_remove(struct device *dev)
1da177e4 437{
3c78bc61
RD
438 struct pci_dev *pci_dev = to_pci_dev(dev);
439 struct pci_driver *drv = pci_dev->driver;
1da177e4
LT
440
441 if (drv) {
f3ec4f87
AS
442 if (drv->remove) {
443 pm_runtime_get_sync(dev);
1da177e4 444 drv->remove(pci_dev);
f3ec4f87
AS
445 pm_runtime_put_noidle(dev);
446 }
890e4847 447 pcibios_free_irq(pci_dev);
1da177e4 448 pci_dev->driver = NULL;
38972375 449 pci_iov_remove(pci_dev);
1da177e4
LT
450 }
451
f3ec4f87 452 /* Undo the runtime PM settings in local_pci_probe() */
967577b0 453 pm_runtime_put_sync(dev);
f3ec4f87 454
2449e06a
SL
455 /*
456 * If the device is still on, set the power state as "unknown",
457 * since it might change by the next time we load the driver.
458 */
459 if (pci_dev->current_state == PCI_D0)
460 pci_dev->current_state = PCI_UNKNOWN;
461
1da177e4
LT
462 /*
463 * We would love to complain here if pci_dev->is_enabled is set, that
464 * the driver should have called pci_disable_device(), but the
465 * unfortunate fact is there are too many odd BIOS and bridge setups
f7625980 466 * that don't like drivers doing that all of the time.
1da177e4
LT
467 * Oh well, we can dream of sane hardware when we sleep, no matter how
468 * horrible the crap we have to deal with is when we are awake...
469 */
470
471 pci_dev_put(pci_dev);
472 return 0;
473}
474
bbb44d9f
RW
475static void pci_device_shutdown(struct device *dev)
476{
477 struct pci_dev *pci_dev = to_pci_dev(dev);
478 struct pci_driver *drv = pci_dev->driver;
479
3ff2de9b
HY
480 pm_runtime_resume(dev);
481
bbb44d9f
RW
482 if (drv && drv->shutdown)
483 drv->shutdown(pci_dev);
5b415f1e 484
b566a22c 485 /*
4fc9bbf9
KA
486 * If this is a kexec reboot, turn off Bus Master bit on the
487 * device to tell it to not continue to do DMA. Don't touch
488 * devices in D3cold or unknown states.
489 * If it is not a kexec reboot, firmware will hit the PCI
490 * devices with big hammer and stop their DMA any way.
b566a22c 491 */
4fc9bbf9 492 if (kexec_in_progress && (pci_dev->current_state <= PCI_D3hot))
6e0eda3c 493 pci_clear_master(pci_dev);
bbb44d9f
RW
494}
495
aa338601 496#ifdef CONFIG_PM
6cbf8214
RW
497
498/* Auxiliary functions used for system resume and run-time resume. */
499
500/**
501 * pci_restore_standard_config - restore standard config registers of PCI device
502 * @pci_dev: PCI device to handle
503 */
504static int pci_restore_standard_config(struct pci_dev *pci_dev)
505{
506 pci_update_current_state(pci_dev, PCI_UNKNOWN);
507
508 if (pci_dev->current_state != PCI_D0) {
509 int error = pci_set_power_state(pci_dev, PCI_D0);
510 if (error)
511 return error;
512 }
513
1d3c16a8 514 pci_restore_state(pci_dev);
0ce3fcaf 515 pci_pme_restore(pci_dev);
1d3c16a8 516 return 0;
6cbf8214
RW
517}
518
db288c9c
RW
519#endif
520
521#ifdef CONFIG_PM_SLEEP
522
6cbf8214
RW
523static void pci_pm_default_resume_early(struct pci_dev *pci_dev)
524{
db288c9c
RW
525 pci_power_up(pci_dev);
526 pci_restore_state(pci_dev);
0ce3fcaf 527 pci_pme_restore(pci_dev);
6cbf8214
RW
528 pci_fixup_device(pci_fixup_resume_early, pci_dev);
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;
bbb44d9f 683
bac2a909
RW
684 if (drv && drv->pm && drv->pm->prepare) {
685 int error = drv->pm->prepare(dev);
08810a41 686 if (error < 0)
bac2a909 687 return error;
08810a41
RW
688
689 if (!error && dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_PREPARE))
690 return 0;
bac2a909
RW
691 }
692 return pci_dev_keep_suspended(to_pci_dev(dev));
bbb44d9f
RW
693}
694
2cef548a
RW
695static void pci_pm_complete(struct device *dev)
696{
a0d2a959
LW
697 struct pci_dev *pci_dev = to_pci_dev(dev);
698
699 pci_dev_complete_resume(pci_dev);
700 pm_generic_complete(dev);
701
702 /* Resume device if platform firmware has put it in reset-power-on */
bd755d77 703 if (pm_runtime_suspended(dev) && pm_resume_via_firmware()) {
a0d2a959
LW
704 pci_power_t pre_sleep_state = pci_dev->current_state;
705
706 pci_update_current_state(pci_dev, pci_dev->current_state);
707 if (pci_dev->current_state < pre_sleep_state)
708 pm_request_resume(dev);
709 }
2cef548a 710}
bbb44d9f 711
6cbf8214
RW
712#else /* !CONFIG_PM_SLEEP */
713
714#define pci_pm_prepare NULL
2cef548a 715#define pci_pm_complete NULL
6cbf8214
RW
716
717#endif /* !CONFIG_PM_SLEEP */
718
bbb44d9f 719#ifdef CONFIG_SUSPEND
a39bd851
BH
720static void pcie_pme_root_status_cleanup(struct pci_dev *pci_dev)
721{
722 /*
723 * Some BIOSes forget to clear Root PME Status bits after system
724 * wakeup, which breaks ACPI-based runtime wakeup on PCI Express.
725 * Clear those bits now just in case (shouldn't hurt).
726 */
727 if (pci_is_pcie(pci_dev) &&
3620c714
BH
728 (pci_pcie_type(pci_dev) == PCI_EXP_TYPE_ROOT_PORT ||
729 pci_pcie_type(pci_dev) == PCI_EXP_TYPE_RC_EC))
a39bd851
BH
730 pcie_clear_root_pme_status(pci_dev);
731}
bbb44d9f
RW
732
733static int pci_pm_suspend(struct device *dev)
734{
735 struct pci_dev *pci_dev = to_pci_dev(dev);
8150f32b 736 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
bbb44d9f 737
ad8cfa1d
RW
738 if (pci_has_legacy_pm_support(pci_dev))
739 return pci_legacy_suspend(dev, PMSG_SUSPEND);
bb808945 740
5294e256
RW
741 if (!pm) {
742 pci_pm_default_suspend(pci_dev);
c4b65157 743 return 0;
5294e256
RW
744 }
745
7cd0602d 746 /*
c4b65157
RW
747 * PCI devices suspended at run time may need to be resumed at this
748 * point, because in general it may be necessary to reconfigure them for
749 * system suspend. Namely, if the device is expected to wake up the
750 * system from the sleep state, it may have to be reconfigured for this
751 * purpose, or if the device is not expected to wake up the system from
752 * the sleep state, it should be prevented from signaling wakeup events
753 * going forward.
754 *
755 * Also if the driver of the device does not indicate that its system
756 * suspend callbacks can cope with runtime-suspended devices, it is
757 * better to resume the device from runtime suspend here.
7cd0602d 758 */
c4b65157 759 if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
656088aa 760 !pci_dev_keep_suspended(pci_dev)) {
c4b65157 761 pm_runtime_resume(dev);
656088aa
RW
762 pci_dev->state_saved = false;
763 }
7cd0602d 764
5294e256
RW
765 if (pm->suspend) {
766 pci_power_t prev = pci_dev->current_state;
767 int error;
768
ddb7c9d2
RW
769 error = pm->suspend(dev);
770 suspend_report_result(pm->suspend, error);
5294e256
RW
771 if (error)
772 return error;
773
46939f8b 774 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
5294e256
RW
775 && pci_dev->current_state != PCI_UNKNOWN) {
776 WARN_ONCE(pci_dev->current_state != prev,
d75f773c 777 "PCI PM: State of device not saved by %pS\n",
5294e256 778 pm->suspend);
5294e256 779 }
bbb44d9f 780 }
fa58d305 781
5294e256 782 return 0;
bbb44d9f
RW
783}
784
c4b65157
RW
785static int pci_pm_suspend_late(struct device *dev)
786{
787 if (dev_pm_smart_suspend_and_suspended(dev))
788 return 0;
789
790 pci_fixup_device(pci_fixup_suspend, to_pci_dev(dev));
791
792 return pm_generic_suspend_late(dev);
793}
794
bbb44d9f 795static int pci_pm_suspend_noirq(struct device *dev)
c8958177 796{
355a72d7 797 struct pci_dev *pci_dev = to_pci_dev(dev);
8150f32b 798 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
c8958177 799
bd755d77
RW
800 if (dev_pm_smart_suspend_and_suspended(dev)) {
801 dev->power.may_skip_resume = true;
c4b65157 802 return 0;
bd755d77 803 }
c4b65157 804
bb808945
RW
805 if (pci_has_legacy_pm_support(pci_dev))
806 return pci_legacy_suspend_late(dev, PMSG_SUSPEND);
807
931ff68a
RW
808 if (!pm) {
809 pci_save_state(pci_dev);
7d2a01b8 810 goto Fixup;
931ff68a 811 }
46939f8b
RW
812
813 if (pm->suspend_noirq) {
814 pci_power_t prev = pci_dev->current_state;
815 int error;
816
817 error = pm->suspend_noirq(dev);
818 suspend_report_result(pm->suspend_noirq, error);
819 if (error)
820 return error;
821
822 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
823 && pci_dev->current_state != PCI_UNKNOWN) {
824 WARN_ONCE(pci_dev->current_state != prev,
d75f773c 825 "PCI PM: State of device not saved by %pS\n",
46939f8b 826 pm->suspend_noirq);
7d2a01b8 827 goto Fixup;
46939f8b 828 }
bbb44d9f
RW
829 }
830
46939f8b
RW
831 if (!pci_dev->state_saved) {
832 pci_save_state(pci_dev);
9d26d3a8 833 if (pci_power_manageable(pci_dev))
46939f8b
RW
834 pci_prepare_to_sleep(pci_dev);
835 }
d67e37d7 836
ca67ab5c
RW
837 dev_dbg(dev, "PCI PM: Suspend power state: %s\n",
838 pci_power_name(pci_dev->current_state));
839
46939f8b
RW
840 pci_pm_set_unknown_state(pci_dev);
841
dbf0e4c7
AS
842 /*
843 * Some BIOSes from ASUS have a bug: If a USB EHCI host controller's
844 * PCI COMMAND register isn't 0, the BIOS assumes that the controller
845 * hasn't been quiesced and tries to turn it off. If the controller
846 * is already in D3, this can hang or cause memory corruption.
847 *
848 * Since the value of the COMMAND register doesn't matter once the
849 * device has been suspended, we can safely set it to 0 here.
850 */
851 if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
852 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
853
7d2a01b8
AN
854Fixup:
855 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
856
bd755d77
RW
857 /*
858 * If the target system sleep state is suspend-to-idle, it is sufficient
859 * to check whether or not the device's wakeup settings are good for
860 * runtime PM. Otherwise, the pm_resume_via_firmware() check will cause
861 * pci_pm_complete() to take care of fixing up the device's state
862 * anyway, if need be.
863 */
864 dev->power.may_skip_resume = device_may_wakeup(dev) ||
865 !device_can_wakeup(dev);
866
46939f8b 867 return 0;
c8958177 868}
1da177e4 869
f6dc1e5e 870static int pci_pm_resume_noirq(struct device *dev)
bbb44d9f
RW
871{
872 struct pci_dev *pci_dev = to_pci_dev(dev);
873 struct device_driver *drv = dev->driver;
355a72d7 874 int error = 0;
bbb44d9f 875
bd755d77
RW
876 if (dev_pm_may_skip_resume(dev))
877 return 0;
878
c4b65157
RW
879 /*
880 * Devices with DPM_FLAG_SMART_SUSPEND may be left in runtime suspend
881 * during system suspend, so update their runtime PM status to "active"
882 * as they are going to be put into D0 shortly.
883 */
884 if (dev_pm_smart_suspend_and_suspended(dev))
885 pm_runtime_set_active(dev);
886
6cbf8214 887 pci_pm_default_resume_early(pci_dev);
aa8c6c93 888
ad8cfa1d 889 if (pci_has_legacy_pm_support(pci_dev))
f6dc1e5e 890 return pci_legacy_resume_early(dev);
bb808945 891
a39bd851
BH
892 pcie_pme_root_status_cleanup(pci_dev);
893
f6dc1e5e
RW
894 if (drv && drv->pm && drv->pm->resume_noirq)
895 error = drv->pm->resume_noirq(dev);
bbb44d9f
RW
896
897 return error;
898}
899
f6dc1e5e 900static int pci_pm_resume(struct device *dev)
bbb44d9f 901{
355a72d7 902 struct pci_dev *pci_dev = to_pci_dev(dev);
8150f32b 903 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
bbb44d9f
RW
904 int error = 0;
905
418e4da3
RW
906 /*
907 * This is necessary for the suspend error path in which resume is
908 * called without restoring the standard config registers of the device.
909 */
910 if (pci_dev->state_saved)
911 pci_restore_standard_config(pci_dev);
912
ad8cfa1d 913 if (pci_has_legacy_pm_support(pci_dev))
f6dc1e5e 914 return pci_legacy_resume(dev);
bb808945 915
5294e256 916 pci_pm_default_resume(pci_dev);
73410429 917
5294e256
RW
918 if (pm) {
919 if (pm->resume)
920 error = pm->resume(dev);
921 } else {
922 pci_pm_reenable_device(pci_dev);
923 }
bbb44d9f 924
999cce4a 925 return error;
bbb44d9f
RW
926}
927
928#else /* !CONFIG_SUSPEND */
929
930#define pci_pm_suspend NULL
c4b65157 931#define pci_pm_suspend_late NULL
bbb44d9f
RW
932#define pci_pm_suspend_noirq NULL
933#define pci_pm_resume NULL
934#define pci_pm_resume_noirq NULL
935
936#endif /* !CONFIG_SUSPEND */
937
1f112cee 938#ifdef CONFIG_HIBERNATE_CALLBACKS
bbb44d9f 939
699c1985
SO
940
941/*
942 * pcibios_pm_ops - provide arch-specific hooks when a PCI device is doing
943 * a hibernate transition
944 */
945struct dev_pm_ops __weak pcibios_pm_ops;
946
bbb44d9f
RW
947static int pci_pm_freeze(struct device *dev)
948{
949 struct pci_dev *pci_dev = to_pci_dev(dev);
8150f32b 950 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
bbb44d9f 951
ad8cfa1d
RW
952 if (pci_has_legacy_pm_support(pci_dev))
953 return pci_legacy_suspend(dev, PMSG_FREEZE);
bb808945 954
5294e256
RW
955 if (!pm) {
956 pci_pm_default_suspend(pci_dev);
957 return 0;
bbb44d9f
RW
958 }
959
7cd0602d
RW
960 /*
961 * This used to be done in pci_pm_prepare() for all devices and some
962 * drivers may depend on it, so do it here. Ideally, runtime-suspended
963 * devices should not be touched during freeze/thaw transitions,
964 * however.
965 */
ae860a19 966 if (!dev_pm_smart_suspend_and_suspended(dev)) {
c4b65157 967 pm_runtime_resume(dev);
ae860a19
MW
968 pci_dev->state_saved = false;
969 }
7cd0602d 970
5294e256
RW
971 if (pm->freeze) {
972 int error;
973
974 error = pm->freeze(dev);
975 suspend_report_result(pm->freeze, error);
976 if (error)
977 return error;
978 }
979
5294e256 980 return 0;
bbb44d9f
RW
981}
982
c4b65157
RW
983static int pci_pm_freeze_late(struct device *dev)
984{
985 if (dev_pm_smart_suspend_and_suspended(dev))
986 return 0;
987
bee344cb 988 return pm_generic_freeze_late(dev);
c4b65157
RW
989}
990
bbb44d9f
RW
991static int pci_pm_freeze_noirq(struct device *dev)
992{
355a72d7 993 struct pci_dev *pci_dev = to_pci_dev(dev);
adf09493 994 struct device_driver *drv = dev->driver;
bbb44d9f 995
c4b65157
RW
996 if (dev_pm_smart_suspend_and_suspended(dev))
997 return 0;
998
bb808945
RW
999 if (pci_has_legacy_pm_support(pci_dev))
1000 return pci_legacy_suspend_late(dev, PMSG_FREEZE);
1001
d67e37d7 1002 if (drv && drv->pm && drv->pm->freeze_noirq) {
46939f8b
RW
1003 int error;
1004
d67e37d7
RW
1005 error = drv->pm->freeze_noirq(dev);
1006 suspend_report_result(drv->pm->freeze_noirq, error);
46939f8b
RW
1007 if (error)
1008 return error;
bbb44d9f
RW
1009 }
1010
46939f8b
RW
1011 if (!pci_dev->state_saved)
1012 pci_save_state(pci_dev);
d67e37d7 1013
46939f8b
RW
1014 pci_pm_set_unknown_state(pci_dev);
1015
699c1985
SO
1016 if (pcibios_pm_ops.freeze_noirq)
1017 return pcibios_pm_ops.freeze_noirq(dev);
1018
46939f8b 1019 return 0;
bbb44d9f
RW
1020}
1021
f6dc1e5e 1022static int pci_pm_thaw_noirq(struct device *dev)
bbb44d9f 1023{
355a72d7 1024 struct pci_dev *pci_dev = to_pci_dev(dev);
bbb44d9f
RW
1025 struct device_driver *drv = dev->driver;
1026 int error = 0;
1027
c4b65157
RW
1028 /*
1029 * If the device is in runtime suspend, the code below may not work
1030 * correctly with it, so skip that code and make the PM core skip all of
1031 * the subsequent "thaw" callbacks for the device.
1032 */
1033 if (dev_pm_smart_suspend_and_suspended(dev)) {
3487972d 1034 dev_pm_skip_next_resume_phases(dev);
c4b65157
RW
1035 return 0;
1036 }
1037
699c1985
SO
1038 if (pcibios_pm_ops.thaw_noirq) {
1039 error = pcibios_pm_ops.thaw_noirq(dev);
1040 if (error)
1041 return error;
1042 }
1043
ad8cfa1d 1044 if (pci_has_legacy_pm_support(pci_dev))
f6dc1e5e 1045 return pci_legacy_resume_early(dev);
bb808945 1046
5839ee73
RW
1047 /*
1048 * pci_restore_state() requires the device to be in D0 (because of MSI
1049 * restoration among other things), so force it into D0 in case the
1050 * driver's "freeze" callbacks put it into a low-power state directly.
1051 */
1052 pci_set_power_state(pci_dev, PCI_D0);
e60514bd 1053 pci_restore_state(pci_dev);
d67e37d7 1054
f6dc1e5e
RW
1055 if (drv && drv->pm && drv->pm->thaw_noirq)
1056 error = drv->pm->thaw_noirq(dev);
bbb44d9f
RW
1057
1058 return error;
1059}
1060
f6dc1e5e 1061static int pci_pm_thaw(struct device *dev)
bbb44d9f 1062{
355a72d7 1063 struct pci_dev *pci_dev = to_pci_dev(dev);
8150f32b 1064 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
bbb44d9f
RW
1065 int error = 0;
1066
ad8cfa1d 1067 if (pci_has_legacy_pm_support(pci_dev))
f6dc1e5e 1068 return pci_legacy_resume(dev);
bb808945 1069
5294e256
RW
1070 if (pm) {
1071 if (pm->thaw)
1072 error = pm->thaw(dev);
1073 } else {
1074 pci_pm_reenable_device(pci_dev);
1075 }
bbb44d9f 1076
4b77b0a2
RW
1077 pci_dev->state_saved = false;
1078
bbb44d9f
RW
1079 return error;
1080}
1081
1082static int pci_pm_poweroff(struct device *dev)
1083{
355a72d7 1084 struct pci_dev *pci_dev = to_pci_dev(dev);
8150f32b 1085 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
bbb44d9f 1086
ad8cfa1d
RW
1087 if (pci_has_legacy_pm_support(pci_dev))
1088 return pci_legacy_suspend(dev, PMSG_HIBERNATE);
bb808945 1089
5294e256
RW
1090 if (!pm) {
1091 pci_pm_default_suspend(pci_dev);
c4b65157 1092 return 0;
5294e256
RW
1093 }
1094
7cd0602d 1095 /* The reason to do that is the same as in pci_pm_suspend(). */
c4b65157
RW
1096 if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
1097 !pci_dev_keep_suspended(pci_dev))
1098 pm_runtime_resume(dev);
7cd0602d 1099
82fee4d6 1100 pci_dev->state_saved = false;
5294e256 1101 if (pm->poweroff) {
46939f8b
RW
1102 int error;
1103
ddb7c9d2
RW
1104 error = pm->poweroff(dev);
1105 suspend_report_result(pm->poweroff, error);
46939f8b
RW
1106 if (error)
1107 return error;
bbb44d9f
RW
1108 }
1109
46939f8b 1110 return 0;
bbb44d9f 1111}
c9b9972b 1112
c4b65157
RW
1113static int pci_pm_poweroff_late(struct device *dev)
1114{
1115 if (dev_pm_smart_suspend_and_suspended(dev))
1116 return 0;
699c1985 1117
c4b65157
RW
1118 pci_fixup_device(pci_fixup_suspend, to_pci_dev(dev));
1119
1120 return pm_generic_poweroff_late(dev);
bbb44d9f
RW
1121}
1122
1123static int pci_pm_poweroff_noirq(struct device *dev)
1124{
46939f8b 1125 struct pci_dev *pci_dev = to_pci_dev(dev);
adf09493 1126 struct device_driver *drv = dev->driver;
bbb44d9f 1127
c4b65157
RW
1128 if (dev_pm_smart_suspend_and_suspended(dev))
1129 return 0;
1130
bb808945
RW
1131 if (pci_has_legacy_pm_support(to_pci_dev(dev)))
1132 return pci_legacy_suspend_late(dev, PMSG_HIBERNATE);
1133
7d2a01b8
AN
1134 if (!drv || !drv->pm) {
1135 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
46939f8b 1136 return 0;
7d2a01b8 1137 }
46939f8b
RW
1138
1139 if (drv->pm->poweroff_noirq) {
1140 int error;
1141
d67e37d7
RW
1142 error = drv->pm->poweroff_noirq(dev);
1143 suspend_report_result(drv->pm->poweroff_noirq, error);
46939f8b
RW
1144 if (error)
1145 return error;
bbb44d9f
RW
1146 }
1147
326c1cda 1148 if (!pci_dev->state_saved && !pci_has_subordinate(pci_dev))
46939f8b
RW
1149 pci_prepare_to_sleep(pci_dev);
1150
0b68c8e2
RW
1151 /*
1152 * The reason for doing this here is the same as for the analogous code
1153 * in pci_pm_suspend_noirq().
1154 */
1155 if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
1156 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
1157
7d2a01b8
AN
1158 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1159
699c1985
SO
1160 if (pcibios_pm_ops.poweroff_noirq)
1161 return pcibios_pm_ops.poweroff_noirq(dev);
1162
46939f8b 1163 return 0;
bbb44d9f
RW
1164}
1165
f6dc1e5e 1166static int pci_pm_restore_noirq(struct device *dev)
bbb44d9f
RW
1167{
1168 struct pci_dev *pci_dev = to_pci_dev(dev);
1169 struct device_driver *drv = dev->driver;
355a72d7 1170 int error = 0;
bbb44d9f 1171
c4b65157
RW
1172 /* This is analogous to the pci_pm_resume_noirq() case. */
1173 if (dev_pm_smart_suspend_and_suspended(dev))
1174 pm_runtime_set_active(dev);
1175
699c1985
SO
1176 if (pcibios_pm_ops.restore_noirq) {
1177 error = pcibios_pm_ops.restore_noirq(dev);
1178 if (error)
1179 return error;
1180 }
1181
6cbf8214 1182 pci_pm_default_resume_early(pci_dev);
aa8c6c93 1183
ad8cfa1d 1184 if (pci_has_legacy_pm_support(pci_dev))
f6dc1e5e 1185 return pci_legacy_resume_early(dev);
bb808945 1186
f6dc1e5e
RW
1187 if (drv && drv->pm && drv->pm->restore_noirq)
1188 error = drv->pm->restore_noirq(dev);
bbb44d9f
RW
1189
1190 return error;
1191}
1192
f6dc1e5e 1193static int pci_pm_restore(struct device *dev)
bbb44d9f
RW
1194{
1195 struct pci_dev *pci_dev = to_pci_dev(dev);
8150f32b 1196 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
bbb44d9f
RW
1197 int error = 0;
1198
418e4da3
RW
1199 /*
1200 * This is necessary for the hibernation error path in which restore is
1201 * called without restoring the standard config registers of the device.
1202 */
1203 if (pci_dev->state_saved)
1204 pci_restore_standard_config(pci_dev);
1205
ad8cfa1d 1206 if (pci_has_legacy_pm_support(pci_dev))
f6dc1e5e 1207 return pci_legacy_resume(dev);
bb808945 1208
5294e256 1209 pci_pm_default_resume(pci_dev);
73410429 1210
5294e256
RW
1211 if (pm) {
1212 if (pm->restore)
1213 error = pm->restore(dev);
1214 } else {
1215 pci_pm_reenable_device(pci_dev);
1216 }
bbb44d9f
RW
1217
1218 return error;
c8958177 1219}
1da177e4 1220
1f112cee 1221#else /* !CONFIG_HIBERNATE_CALLBACKS */
bbb44d9f
RW
1222
1223#define pci_pm_freeze NULL
c4b65157 1224#define pci_pm_freeze_late NULL
bbb44d9f
RW
1225#define pci_pm_freeze_noirq NULL
1226#define pci_pm_thaw NULL
1227#define pci_pm_thaw_noirq NULL
1228#define pci_pm_poweroff NULL
c4b65157 1229#define pci_pm_poweroff_late NULL
bbb44d9f
RW
1230#define pci_pm_poweroff_noirq NULL
1231#define pci_pm_restore NULL
1232#define pci_pm_restore_noirq NULL
1233
1f112cee 1234#endif /* !CONFIG_HIBERNATE_CALLBACKS */
bbb44d9f 1235
fbb988be 1236#ifdef CONFIG_PM
6cbf8214
RW
1237
1238static int pci_pm_runtime_suspend(struct device *dev)
1239{
1240 struct pci_dev *pci_dev = to_pci_dev(dev);
1241 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1242 pci_power_t prev = pci_dev->current_state;
1243 int error;
1244
967577b0 1245 /*
5775b843
RW
1246 * If pci_dev->driver is not set (unbound), we leave the device in D0,
1247 * but it may go to D3cold when the bridge above it runtime suspends.
1248 * Save its config space in case that happens.
967577b0 1249 */
5775b843
RW
1250 if (!pci_dev->driver) {
1251 pci_save_state(pci_dev);
967577b0 1252 return 0;
5775b843 1253 }
967577b0 1254
82fee4d6 1255 pci_dev->state_saved = false;
c5eb1190
JN
1256 if (pm && pm->runtime_suspend) {
1257 error = pm->runtime_suspend(dev);
06bf403d
ID
1258 /*
1259 * -EBUSY and -EAGAIN is used to request the runtime PM core
1260 * to schedule a new suspend, so log the event only with debug
1261 * log level.
1262 */
c5eb1190 1263 if (error == -EBUSY || error == -EAGAIN) {
d75f773c 1264 dev_dbg(dev, "can't suspend now (%ps returned %d)\n",
06bf403d 1265 pm->runtime_suspend, error);
c5eb1190
JN
1266 return error;
1267 } else if (error) {
d75f773c 1268 dev_err(dev, "can't suspend (%ps returned %d)\n",
06bf403d 1269 pm->runtime_suspend, error);
c5eb1190
JN
1270 return error;
1271 }
06bf403d 1272 }
6cbf8214
RW
1273
1274 pci_fixup_device(pci_fixup_suspend, pci_dev);
1275
c5eb1190
JN
1276 if (pm && pm->runtime_suspend
1277 && !pci_dev->state_saved && pci_dev->current_state != PCI_D0
6cbf8214
RW
1278 && pci_dev->current_state != PCI_UNKNOWN) {
1279 WARN_ONCE(pci_dev->current_state != prev,
d75f773c 1280 "PCI PM: State of device not saved by %pS\n",
6cbf8214
RW
1281 pm->runtime_suspend);
1282 return 0;
1283 }
1284
42eca230 1285 if (!pci_dev->state_saved) {
6cbf8214 1286 pci_save_state(pci_dev);
42eca230
DA
1287 pci_finish_runtime_suspend(pci_dev);
1288 }
6cbf8214
RW
1289
1290 return 0;
1291}
1292
1293static int pci_pm_runtime_resume(struct device *dev)
1294{
c5eb1190 1295 int rc = 0;
6cbf8214
RW
1296 struct pci_dev *pci_dev = to_pci_dev(dev);
1297 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1298
967577b0 1299 /*
5775b843
RW
1300 * Restoring config space is necessary even if the device is not bound
1301 * to a driver because although we left it in D0, it may have gone to
1302 * D3cold when the bridge above it runtime suspended.
967577b0 1303 */
5775b843
RW
1304 pci_restore_standard_config(pci_dev);
1305
967577b0
HY
1306 if (!pci_dev->driver)
1307 return 0;
1308
db288c9c 1309 pci_fixup_device(pci_fixup_resume_early, pci_dev);
0847684c 1310 pci_enable_wake(pci_dev, PCI_D0, false);
6cbf8214
RW
1311 pci_fixup_device(pci_fixup_resume, pci_dev);
1312
c5eb1190
JN
1313 if (pm && pm->runtime_resume)
1314 rc = pm->runtime_resume(dev);
448bd857
HY
1315
1316 pci_dev->runtime_d3cold = false;
1317
1318 return rc;
6cbf8214
RW
1319}
1320
1321static int pci_pm_runtime_idle(struct device *dev)
1322{
967577b0 1323 struct pci_dev *pci_dev = to_pci_dev(dev);
6cbf8214 1324 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
45f0a85c 1325 int ret = 0;
6cbf8214 1326
967577b0
HY
1327 /*
1328 * If pci_dev->driver is not set (unbound), the device should
1329 * always remain in D0 regardless of the runtime PM status
1330 */
1331 if (!pci_dev->driver)
45f0a85c 1332 return 0;
967577b0 1333
6cbf8214
RW
1334 if (!pm)
1335 return -ENOSYS;
1336
45f0a85c
RW
1337 if (pm->runtime_idle)
1338 ret = pm->runtime_idle(dev);
6cbf8214 1339
45f0a85c 1340 return ret;
6cbf8214
RW
1341}
1342
f91da04d 1343static const struct dev_pm_ops pci_dev_pm_ops = {
adf09493 1344 .prepare = pci_pm_prepare,
2cef548a 1345 .complete = pci_pm_complete,
adf09493 1346 .suspend = pci_pm_suspend,
c4b65157 1347 .suspend_late = pci_pm_suspend_late,
adf09493
RW
1348 .resume = pci_pm_resume,
1349 .freeze = pci_pm_freeze,
c4b65157 1350 .freeze_late = pci_pm_freeze_late,
adf09493
RW
1351 .thaw = pci_pm_thaw,
1352 .poweroff = pci_pm_poweroff,
c4b65157 1353 .poweroff_late = pci_pm_poweroff_late,
adf09493 1354 .restore = pci_pm_restore,
bbb44d9f
RW
1355 .suspend_noirq = pci_pm_suspend_noirq,
1356 .resume_noirq = pci_pm_resume_noirq,
1357 .freeze_noirq = pci_pm_freeze_noirq,
1358 .thaw_noirq = pci_pm_thaw_noirq,
1359 .poweroff_noirq = pci_pm_poweroff_noirq,
1360 .restore_noirq = pci_pm_restore_noirq,
6cbf8214
RW
1361 .runtime_suspend = pci_pm_runtime_suspend,
1362 .runtime_resume = pci_pm_runtime_resume,
1363 .runtime_idle = pci_pm_runtime_idle,
bbb44d9f
RW
1364};
1365
adf09493 1366#define PCI_PM_OPS_PTR (&pci_dev_pm_ops)
bbb44d9f 1367
fbb988be
RW
1368#else /* !CONFIG_PM */
1369
1370#define pci_pm_runtime_suspend NULL
1371#define pci_pm_runtime_resume NULL
1372#define pci_pm_runtime_idle NULL
bbb44d9f
RW
1373
1374#define PCI_PM_OPS_PTR NULL
1375
fbb988be 1376#endif /* !CONFIG_PM */
bbb44d9f 1377
1da177e4 1378/**
863b18f4 1379 * __pci_register_driver - register a new pci driver
1da177e4 1380 * @drv: the driver structure to register
863b18f4 1381 * @owner: owner module of drv
f95d882d 1382 * @mod_name: module name string
f7625980 1383 *
1da177e4 1384 * Adds the driver structure to the list of registered drivers.
f7625980
BH
1385 * Returns a negative value on error, otherwise 0.
1386 * If no error occurred, the driver remains registered even if
1da177e4
LT
1387 * no device was claimed during registration.
1388 */
725522b5
GKH
1389int __pci_register_driver(struct pci_driver *drv, struct module *owner,
1390 const char *mod_name)
1da177e4 1391{
1da177e4
LT
1392 /* initialize common driver fields */
1393 drv->driver.name = drv->name;
1394 drv->driver.bus = &pci_bus_type;
863b18f4 1395 drv->driver.owner = owner;
725522b5 1396 drv->driver.mod_name = mod_name;
92d50fc1 1397 drv->driver.groups = drv->groups;
50b00755 1398
75865858
GKH
1399 spin_lock_init(&drv->dynids.lock);
1400 INIT_LIST_HEAD(&drv->dynids.list);
1da177e4
LT
1401
1402 /* register with core */
bfb09a86 1403 return driver_register(&drv->driver);
1da177e4 1404}
b7fe9434 1405EXPORT_SYMBOL(__pci_register_driver);
1da177e4
LT
1406
1407/**
1408 * pci_unregister_driver - unregister a pci driver
1409 * @drv: the driver structure to unregister
f7625980 1410 *
1da177e4
LT
1411 * Deletes the driver structure from the list of registered PCI drivers,
1412 * gives it a chance to clean up by calling its remove() function for
1413 * each device it was responsible for, and marks those devices as
1414 * driverless.
1415 */
1416
3c78bc61 1417void pci_unregister_driver(struct pci_driver *drv)
1da177e4
LT
1418{
1419 driver_unregister(&drv->driver);
1420 pci_free_dynids(drv);
1421}
b7fe9434 1422EXPORT_SYMBOL(pci_unregister_driver);
1da177e4
LT
1423
1424static struct pci_driver pci_compat_driver = {
1425 .name = "compat"
1426};
1427
1428/**
1429 * pci_dev_driver - get the pci_driver of a device
1430 * @dev: the device to query
1431 *
f7625980 1432 * Returns the appropriate pci_driver structure or %NULL if there is no
1da177e4
LT
1433 * registered driver for the device.
1434 */
3c78bc61 1435struct pci_driver *pci_dev_driver(const struct pci_dev *dev)
1da177e4
LT
1436{
1437 if (dev->driver)
1438 return dev->driver;
1439 else {
1440 int i;
3c78bc61 1441 for (i = 0; i <= PCI_ROM_RESOURCE; i++)
1da177e4
LT
1442 if (dev->resource[i].flags & IORESOURCE_BUSY)
1443 return &pci_compat_driver;
1444 }
1445 return NULL;
1446}
b7fe9434 1447EXPORT_SYMBOL(pci_dev_driver);
1da177e4
LT
1448
1449/**
1450 * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure
1da177e4 1451 * @dev: the PCI device structure to match against
8f7020d3 1452 * @drv: the device driver to search for matching PCI device id structures
f7625980 1453 *
1da177e4 1454 * Used by a driver to check whether a PCI device present in the
8f7020d3 1455 * system is in its list of supported devices. Returns the matching
1da177e4
LT
1456 * pci_device_id structure or %NULL if there is no match.
1457 */
75865858 1458static int pci_bus_match(struct device *dev, struct device_driver *drv)
1da177e4 1459{
75865858 1460 struct pci_dev *pci_dev = to_pci_dev(dev);
58d9a38f 1461 struct pci_driver *pci_drv;
1da177e4
LT
1462 const struct pci_device_id *found_id;
1463
58d9a38f
YL
1464 if (!pci_dev->match_driver)
1465 return 0;
1466
1467 pci_drv = to_pci_driver(drv);
75865858 1468 found_id = pci_match_device(pci_drv, pci_dev);
1da177e4
LT
1469 if (found_id)
1470 return 1;
1471
75865858 1472 return 0;
1da177e4
LT
1473}
1474
1475/**
1476 * pci_dev_get - increments the reference count of the pci device structure
1477 * @dev: the device being referenced
1478 *
1479 * Each live reference to a device should be refcounted.
1480 *
1481 * Drivers for PCI devices should normally record such references in
1482 * their probe() methods, when they bind to a device, and release
1483 * them by calling pci_dev_put(), in their disconnect() methods.
1484 *
1485 * A pointer to the device with the incremented reference counter is returned.
1486 */
1487struct pci_dev *pci_dev_get(struct pci_dev *dev)
1488{
1489 if (dev)
1490 get_device(&dev->dev);
1491 return dev;
1492}
b7fe9434 1493EXPORT_SYMBOL(pci_dev_get);
1da177e4
LT
1494
1495/**
1496 * pci_dev_put - release a use of the pci device structure
1497 * @dev: device that's been disconnected
1498 *
1499 * Must be called when a user of a device is finished with it. When the last
1500 * user of the device calls this function, the memory of the device is freed.
1501 */
1502void pci_dev_put(struct pci_dev *dev)
1503{
1504 if (dev)
1505 put_device(&dev->dev);
1506}
b7fe9434 1507EXPORT_SYMBOL(pci_dev_put);
1da177e4 1508
8ccc9aa1
BP
1509static int pci_uevent(struct device *dev, struct kobj_uevent_env *env)
1510{
1511 struct pci_dev *pdev;
1512
1513 if (!dev)
1514 return -ENODEV;
1515
1516 pdev = to_pci_dev(dev);
8ccc9aa1
BP
1517
1518 if (add_uevent_var(env, "PCI_CLASS=%04X", pdev->class))
1519 return -ENOMEM;
1520
1521 if (add_uevent_var(env, "PCI_ID=%04X:%04X", pdev->vendor, pdev->device))
1522 return -ENOMEM;
1523
1524 if (add_uevent_var(env, "PCI_SUBSYS_ID=%04X:%04X", pdev->subsystem_vendor,
1525 pdev->subsystem_device))
1526 return -ENOMEM;
1527
1528 if (add_uevent_var(env, "PCI_SLOT_NAME=%s", pci_name(pdev)))
1529 return -ENOMEM;
1530
145b3fe5 1531 if (add_uevent_var(env, "MODALIAS=pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02X",
8ccc9aa1
BP
1532 pdev->vendor, pdev->device,
1533 pdev->subsystem_vendor, pdev->subsystem_device,
1534 (u8)(pdev->class >> 16), (u8)(pdev->class >> 8),
1535 (u8)(pdev->class)))
1536 return -ENOMEM;
efdd4070 1537
8ccc9aa1
BP
1538 return 0;
1539}
1540
2e28bc84 1541#if defined(CONFIG_PCIEPORTBUS) || defined(CONFIG_EEH)
3ecac020
ME
1542/**
1543 * pci_uevent_ers - emit a uevent during recovery path of PCI device
1544 * @pdev: PCI device undergoing error recovery
1545 * @err_type: type of error event
1546 */
1547void pci_uevent_ers(struct pci_dev *pdev, enum pci_ers_result err_type)
1548{
1549 int idx = 0;
1550 char *envp[3];
1551
1552 switch (err_type) {
1553 case PCI_ERS_RESULT_NONE:
1554 case PCI_ERS_RESULT_CAN_RECOVER:
1555 envp[idx++] = "ERROR_EVENT=BEGIN_RECOVERY";
1556 envp[idx++] = "DEVICE_ONLINE=0";
1557 break;
1558 case PCI_ERS_RESULT_RECOVERED:
1559 envp[idx++] = "ERROR_EVENT=SUCCESSFUL_RECOVERY";
1560 envp[idx++] = "DEVICE_ONLINE=1";
1561 break;
1562 case PCI_ERS_RESULT_DISCONNECT:
1563 envp[idx++] = "ERROR_EVENT=FAILED_RECOVERY";
1564 envp[idx++] = "DEVICE_ONLINE=0";
1565 break;
1566 default:
1567 break;
1568 }
1569
1570 if (idx > 0) {
1571 envp[idx++] = NULL;
1572 kobject_uevent_env(&pdev->dev.kobj, KOBJ_CHANGE, envp);
1573 }
1574}
1575#endif
1576
02e0bea6
PS
1577static int pci_bus_num_vf(struct device *dev)
1578{
1579 return pci_num_vf(to_pci_dev(dev));
1580}
1581
07397df2
NG
1582/**
1583 * pci_dma_configure - Setup DMA configuration
1584 * @dev: ptr to dev structure
1585 *
1586 * Function to update PCI devices's DMA configuration using the same
1587 * info from the OF node or ACPI node of host bridge's parent (if any).
1588 */
1589static int pci_dma_configure(struct device *dev)
1590{
1591 struct device *bridge;
1592 int ret = 0;
1593
1594 bridge = pci_get_host_bridge_device(to_pci_dev(dev));
1595
1596 if (IS_ENABLED(CONFIG_OF) && bridge->parent &&
1597 bridge->parent->of_node) {
3d6ce86e 1598 ret = of_dma_configure(dev, bridge->parent->of_node, true);
07397df2
NG
1599 } else if (has_acpi_companion(bridge)) {
1600 struct acpi_device *adev = to_acpi_device_node(bridge->fwnode);
07397df2 1601
e5361ca2 1602 ret = acpi_dma_configure(dev, acpi_get_dma_attr(adev));
07397df2
NG
1603 }
1604
1605 pci_put_host_bridge_device(bridge);
1606 return ret;
1607}
1608
1da177e4
LT
1609struct bus_type pci_bus_type = {
1610 .name = "pci",
1611 .match = pci_bus_match,
312c004d 1612 .uevent = pci_uevent,
b15d686a
RK
1613 .probe = pci_device_probe,
1614 .remove = pci_device_remove,
cbd69dbb 1615 .shutdown = pci_device_shutdown,
5136b2da 1616 .dev_groups = pci_dev_groups,
0f49ba55 1617 .bus_groups = pci_bus_groups,
2229c1fb 1618 .drv_groups = pci_drv_groups,
bbb44d9f 1619 .pm = PCI_PM_OPS_PTR,
02e0bea6 1620 .num_vf = pci_bus_num_vf,
07397df2 1621 .dma_configure = pci_dma_configure,
1da177e4 1622};
b7fe9434 1623EXPORT_SYMBOL(pci_bus_type);
1da177e4 1624
c6c889d9
BH
1625#ifdef CONFIG_PCIEPORTBUS
1626static int pcie_port_bus_match(struct device *dev, struct device_driver *drv)
1627{
1628 struct pcie_device *pciedev;
1629 struct pcie_port_service_driver *driver;
1630
1631 if (drv->bus != &pcie_port_bus_type || dev->bus != &pcie_port_bus_type)
1632 return 0;
1633
1634 pciedev = to_pcie_device(dev);
1635 driver = to_service_driver(drv);
1636
1637 if (driver->service != pciedev->service)
1638 return 0;
1639
1640 if (driver->port_type != PCIE_ANY_PORT &&
1641 driver->port_type != pci_pcie_type(pciedev->port))
1642 return 0;
1643
1644 return 1;
1645}
1646
1647struct bus_type pcie_port_bus_type = {
1648 .name = "pci_express",
1649 .match = pcie_port_bus_match,
1650};
1651EXPORT_SYMBOL_GPL(pcie_port_bus_type);
1652#endif
1653
1da177e4
LT
1654static int __init pci_driver_init(void)
1655{
c6c889d9
BH
1656 int ret;
1657
1658 ret = bus_register(&pci_bus_type);
1659 if (ret)
1660 return ret;
1661
1662#ifdef CONFIG_PCIEPORTBUS
1663 ret = bus_register(&pcie_port_bus_type);
1664 if (ret)
1665 return ret;
1666#endif
a8651194 1667 dma_debug_add_bus(&pci_bus_type);
c6c889d9 1668 return 0;
1da177e4 1669}
1da177e4 1670postcore_initcall(pci_driver_init);