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