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