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