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