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