xref: /linux/drivers/pci/pci-driver.c (revision 63307d015b91e626c97bb82e88054af3d0b74643)
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  */
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 
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  */
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  */
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  */
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  */
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 
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 
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 
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  */
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 
390 int __weak pcibios_alloc_irq(struct pci_dev *dev)
391 {
392 	return 0;
393 }
394 
395 void __weak pcibios_free_irq(struct pci_dev *dev)
396 {
397 }
398 
399 #ifdef CONFIG_PCI_IOV
400 static inline bool pci_device_can_probe(struct pci_dev *pdev)
401 {
402 	return (!pdev->is_virtfn || pdev->physfn->sriov->drivers_autoprobe);
403 }
404 #else
405 static inline bool pci_device_can_probe(struct pci_dev *pdev)
406 {
407 	return true;
408 }
409 #endif
410 
411 static int pci_device_probe(struct device *dev)
412 {
413 	int error;
414 	struct pci_dev *pci_dev = to_pci_dev(dev);
415 	struct pci_driver *drv = to_pci_driver(dev->driver);
416 
417 	pci_assign_irq(pci_dev);
418 
419 	error = pcibios_alloc_irq(pci_dev);
420 	if (error < 0)
421 		return error;
422 
423 	pci_dev_get(pci_dev);
424 	if (pci_device_can_probe(pci_dev)) {
425 		error = __pci_device_probe(drv, pci_dev);
426 		if (error) {
427 			pcibios_free_irq(pci_dev);
428 			pci_dev_put(pci_dev);
429 		}
430 	}
431 
432 	return error;
433 }
434 
435 static int pci_device_remove(struct device *dev)
436 {
437 	struct pci_dev *pci_dev = to_pci_dev(dev);
438 	struct pci_driver *drv = pci_dev->driver;
439 
440 	if (drv) {
441 		if (drv->remove) {
442 			pm_runtime_get_sync(dev);
443 			drv->remove(pci_dev);
444 			pm_runtime_put_noidle(dev);
445 		}
446 		pcibios_free_irq(pci_dev);
447 		pci_dev->driver = NULL;
448 		pci_iov_remove(pci_dev);
449 	}
450 
451 	/* Undo the runtime PM settings in local_pci_probe() */
452 	pm_runtime_put_sync(dev);
453 
454 	/*
455 	 * If the device is still on, set the power state as "unknown",
456 	 * since it might change by the next time we load the driver.
457 	 */
458 	if (pci_dev->current_state == PCI_D0)
459 		pci_dev->current_state = PCI_UNKNOWN;
460 
461 	/*
462 	 * We would love to complain here if pci_dev->is_enabled is set, that
463 	 * the driver should have called pci_disable_device(), but the
464 	 * unfortunate fact is there are too many odd BIOS and bridge setups
465 	 * that don't like drivers doing that all of the time.
466 	 * Oh well, we can dream of sane hardware when we sleep, no matter how
467 	 * horrible the crap we have to deal with is when we are awake...
468 	 */
469 
470 	pci_dev_put(pci_dev);
471 	return 0;
472 }
473 
474 static void pci_device_shutdown(struct device *dev)
475 {
476 	struct pci_dev *pci_dev = to_pci_dev(dev);
477 	struct pci_driver *drv = pci_dev->driver;
478 
479 	pm_runtime_resume(dev);
480 
481 	if (drv && drv->shutdown)
482 		drv->shutdown(pci_dev);
483 
484 	/*
485 	 * If this is a kexec reboot, turn off Bus Master bit on the
486 	 * device to tell it to not continue to do DMA. Don't touch
487 	 * devices in D3cold or unknown states.
488 	 * If it is not a kexec reboot, firmware will hit the PCI
489 	 * devices with big hammer and stop their DMA any way.
490 	 */
491 	if (kexec_in_progress && (pci_dev->current_state <= PCI_D3hot))
492 		pci_clear_master(pci_dev);
493 }
494 
495 #ifdef CONFIG_PM
496 
497 /* Auxiliary functions used for system resume and run-time resume. */
498 
499 /**
500  * pci_restore_standard_config - restore standard config registers of PCI device
501  * @pci_dev: PCI device to handle
502  */
503 static int pci_restore_standard_config(struct pci_dev *pci_dev)
504 {
505 	pci_update_current_state(pci_dev, PCI_UNKNOWN);
506 
507 	if (pci_dev->current_state != PCI_D0) {
508 		int error = pci_set_power_state(pci_dev, PCI_D0);
509 		if (error)
510 			return error;
511 	}
512 
513 	pci_restore_state(pci_dev);
514 	pci_pme_restore(pci_dev);
515 	return 0;
516 }
517 
518 #endif
519 
520 #ifdef CONFIG_PM_SLEEP
521 
522 static void pci_pm_default_resume_early(struct pci_dev *pci_dev)
523 {
524 	pci_power_up(pci_dev);
525 	pci_restore_state(pci_dev);
526 	pci_pme_restore(pci_dev);
527 	pci_fixup_device(pci_fixup_resume_early, pci_dev);
528 }
529 
530 /*
531  * Default "suspend" method for devices that have no driver provided suspend,
532  * or not even a driver at all (second part).
533  */
534 static void pci_pm_set_unknown_state(struct pci_dev *pci_dev)
535 {
536 	/*
537 	 * mark its power state as "unknown", since we don't know if
538 	 * e.g. the BIOS will change its device state when we suspend.
539 	 */
540 	if (pci_dev->current_state == PCI_D0)
541 		pci_dev->current_state = PCI_UNKNOWN;
542 }
543 
544 /*
545  * Default "resume" method for devices that have no driver provided resume,
546  * or not even a driver at all (second part).
547  */
548 static int pci_pm_reenable_device(struct pci_dev *pci_dev)
549 {
550 	int retval;
551 
552 	/* if the device was enabled before suspend, reenable */
553 	retval = pci_reenable_device(pci_dev);
554 	/*
555 	 * if the device was busmaster before the suspend, make it busmaster
556 	 * again
557 	 */
558 	if (pci_dev->is_busmaster)
559 		pci_set_master(pci_dev);
560 
561 	return retval;
562 }
563 
564 static int pci_legacy_suspend(struct device *dev, pm_message_t state)
565 {
566 	struct pci_dev *pci_dev = to_pci_dev(dev);
567 	struct pci_driver *drv = pci_dev->driver;
568 
569 	if (drv && drv->suspend) {
570 		pci_power_t prev = pci_dev->current_state;
571 		int error;
572 
573 		error = drv->suspend(pci_dev, state);
574 		suspend_report_result(drv->suspend, error);
575 		if (error)
576 			return error;
577 
578 		if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
579 		    && pci_dev->current_state != PCI_UNKNOWN) {
580 			WARN_ONCE(pci_dev->current_state != prev,
581 				"PCI PM: Device state not saved by %pS\n",
582 				drv->suspend);
583 		}
584 	}
585 
586 	pci_fixup_device(pci_fixup_suspend, pci_dev);
587 
588 	return 0;
589 }
590 
591 static int pci_legacy_suspend_late(struct device *dev, pm_message_t state)
592 {
593 	struct pci_dev *pci_dev = to_pci_dev(dev);
594 	struct pci_driver *drv = pci_dev->driver;
595 
596 	if (drv && drv->suspend_late) {
597 		pci_power_t prev = pci_dev->current_state;
598 		int error;
599 
600 		error = drv->suspend_late(pci_dev, state);
601 		suspend_report_result(drv->suspend_late, error);
602 		if (error)
603 			return error;
604 
605 		if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
606 		    && pci_dev->current_state != PCI_UNKNOWN) {
607 			WARN_ONCE(pci_dev->current_state != prev,
608 				"PCI PM: Device state not saved by %pS\n",
609 				drv->suspend_late);
610 			goto Fixup;
611 		}
612 	}
613 
614 	if (!pci_dev->state_saved)
615 		pci_save_state(pci_dev);
616 
617 	pci_pm_set_unknown_state(pci_dev);
618 
619 Fixup:
620 	pci_fixup_device(pci_fixup_suspend_late, pci_dev);
621 
622 	return 0;
623 }
624 
625 static int pci_legacy_resume_early(struct device *dev)
626 {
627 	struct pci_dev *pci_dev = to_pci_dev(dev);
628 	struct pci_driver *drv = pci_dev->driver;
629 
630 	return drv && drv->resume_early ?
631 			drv->resume_early(pci_dev) : 0;
632 }
633 
634 static int pci_legacy_resume(struct device *dev)
635 {
636 	struct pci_dev *pci_dev = to_pci_dev(dev);
637 	struct pci_driver *drv = pci_dev->driver;
638 
639 	pci_fixup_device(pci_fixup_resume, pci_dev);
640 
641 	return drv && drv->resume ?
642 			drv->resume(pci_dev) : pci_pm_reenable_device(pci_dev);
643 }
644 
645 /* Auxiliary functions used by the new power management framework */
646 
647 static void pci_pm_default_resume(struct pci_dev *pci_dev)
648 {
649 	pci_fixup_device(pci_fixup_resume, pci_dev);
650 	pci_enable_wake(pci_dev, PCI_D0, false);
651 }
652 
653 static void pci_pm_default_suspend(struct pci_dev *pci_dev)
654 {
655 	/* Disable non-bridge devices without PM support */
656 	if (!pci_has_subordinate(pci_dev))
657 		pci_disable_enabled_device(pci_dev);
658 }
659 
660 static bool pci_has_legacy_pm_support(struct pci_dev *pci_dev)
661 {
662 	struct pci_driver *drv = pci_dev->driver;
663 	bool ret = drv && (drv->suspend || drv->suspend_late || drv->resume
664 		|| drv->resume_early);
665 
666 	/*
667 	 * Legacy PM support is used by default, so warn if the new framework is
668 	 * supported as well.  Drivers are supposed to support either the
669 	 * former, or the latter, but not both at the same time.
670 	 */
671 	WARN(ret && drv->driver.pm, "driver %s device %04x:%04x\n",
672 		drv->name, pci_dev->vendor, pci_dev->device);
673 
674 	return ret;
675 }
676 
677 /* New power management framework */
678 
679 static int pci_pm_prepare(struct device *dev)
680 {
681 	struct device_driver *drv = dev->driver;
682 
683 	if (drv && drv->pm && drv->pm->prepare) {
684 		int error = drv->pm->prepare(dev);
685 		if (error < 0)
686 			return error;
687 
688 		if (!error && dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_PREPARE))
689 			return 0;
690 	}
691 	return pci_dev_keep_suspended(to_pci_dev(dev));
692 }
693 
694 static void pci_pm_complete(struct device *dev)
695 {
696 	struct pci_dev *pci_dev = to_pci_dev(dev);
697 
698 	pci_dev_complete_resume(pci_dev);
699 	pm_generic_complete(dev);
700 
701 	/* Resume device if platform firmware has put it in reset-power-on */
702 	if (pm_runtime_suspended(dev) && pm_resume_via_firmware()) {
703 		pci_power_t pre_sleep_state = pci_dev->current_state;
704 
705 		pci_update_current_state(pci_dev, pci_dev->current_state);
706 		if (pci_dev->current_state < pre_sleep_state)
707 			pm_request_resume(dev);
708 	}
709 }
710 
711 #else /* !CONFIG_PM_SLEEP */
712 
713 #define pci_pm_prepare	NULL
714 #define pci_pm_complete	NULL
715 
716 #endif /* !CONFIG_PM_SLEEP */
717 
718 #ifdef CONFIG_SUSPEND
719 static void pcie_pme_root_status_cleanup(struct pci_dev *pci_dev)
720 {
721 	/*
722 	 * Some BIOSes forget to clear Root PME Status bits after system
723 	 * wakeup, which breaks ACPI-based runtime wakeup on PCI Express.
724 	 * Clear those bits now just in case (shouldn't hurt).
725 	 */
726 	if (pci_is_pcie(pci_dev) &&
727 	    (pci_pcie_type(pci_dev) == PCI_EXP_TYPE_ROOT_PORT ||
728 	     pci_pcie_type(pci_dev) == PCI_EXP_TYPE_RC_EC))
729 		pcie_clear_root_pme_status(pci_dev);
730 }
731 
732 static int pci_pm_suspend(struct device *dev)
733 {
734 	struct pci_dev *pci_dev = to_pci_dev(dev);
735 	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
736 
737 	pci_dev->skip_bus_pm = false;
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 %pS\n",
779 				pm->suspend);
780 		}
781 	}
782 
783 	return 0;
784 }
785 
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 
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 %pS\n",
827 				pm->suspend_noirq);
828 			goto Fixup;
829 		}
830 	}
831 
832 	if (pci_dev->skip_bus_pm) {
833 		/*
834 		 * The function is running for the second time in a row without
835 		 * going through full resume, which is possible only during
836 		 * suspend-to-idle in a spurious wakeup case.  Moreover, the
837 		 * device was originally left in D0, so its power state should
838 		 * not be changed here and the device register values saved
839 		 * originally should be restored on resume again.
840 		 */
841 		pci_dev->state_saved = true;
842 	} else if (pci_dev->state_saved) {
843 		if (pci_dev->current_state == PCI_D0)
844 			pci_dev->skip_bus_pm = true;
845 	} else {
846 		pci_save_state(pci_dev);
847 		if (pci_power_manageable(pci_dev))
848 			pci_prepare_to_sleep(pci_dev);
849 	}
850 
851 	dev_dbg(dev, "PCI PM: Suspend power state: %s\n",
852 		pci_power_name(pci_dev->current_state));
853 
854 	pci_pm_set_unknown_state(pci_dev);
855 
856 	/*
857 	 * Some BIOSes from ASUS have a bug: If a USB EHCI host controller's
858 	 * PCI COMMAND register isn't 0, the BIOS assumes that the controller
859 	 * hasn't been quiesced and tries to turn it off.  If the controller
860 	 * is already in D3, this can hang or cause memory corruption.
861 	 *
862 	 * Since the value of the COMMAND register doesn't matter once the
863 	 * device has been suspended, we can safely set it to 0 here.
864 	 */
865 	if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
866 		pci_write_config_word(pci_dev, PCI_COMMAND, 0);
867 
868 Fixup:
869 	pci_fixup_device(pci_fixup_suspend_late, pci_dev);
870 
871 	/*
872 	 * If the target system sleep state is suspend-to-idle, it is sufficient
873 	 * to check whether or not the device's wakeup settings are good for
874 	 * runtime PM.  Otherwise, the pm_resume_via_firmware() check will cause
875 	 * pci_pm_complete() to take care of fixing up the device's state
876 	 * anyway, if need be.
877 	 */
878 	dev->power.may_skip_resume = device_may_wakeup(dev) ||
879 					!device_can_wakeup(dev);
880 
881 	return 0;
882 }
883 
884 static int pci_pm_resume_noirq(struct device *dev)
885 {
886 	struct pci_dev *pci_dev = to_pci_dev(dev);
887 	struct device_driver *drv = dev->driver;
888 	int error = 0;
889 
890 	if (dev_pm_may_skip_resume(dev))
891 		return 0;
892 
893 	/*
894 	 * Devices with DPM_FLAG_SMART_SUSPEND may be left in runtime suspend
895 	 * during system suspend, so update their runtime PM status to "active"
896 	 * as they are going to be put into D0 shortly.
897 	 */
898 	if (dev_pm_smart_suspend_and_suspended(dev))
899 		pm_runtime_set_active(dev);
900 
901 	pci_pm_default_resume_early(pci_dev);
902 
903 	if (pci_has_legacy_pm_support(pci_dev))
904 		return pci_legacy_resume_early(dev);
905 
906 	pcie_pme_root_status_cleanup(pci_dev);
907 
908 	if (drv && drv->pm && drv->pm->resume_noirq)
909 		error = drv->pm->resume_noirq(dev);
910 
911 	return error;
912 }
913 
914 static int pci_pm_resume(struct device *dev)
915 {
916 	struct pci_dev *pci_dev = to_pci_dev(dev);
917 	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
918 	int error = 0;
919 
920 	/*
921 	 * This is necessary for the suspend error path in which resume is
922 	 * called without restoring the standard config registers of the device.
923 	 */
924 	if (pci_dev->state_saved)
925 		pci_restore_standard_config(pci_dev);
926 
927 	if (pci_has_legacy_pm_support(pci_dev))
928 		return pci_legacy_resume(dev);
929 
930 	pci_pm_default_resume(pci_dev);
931 
932 	if (pm) {
933 		if (pm->resume)
934 			error = pm->resume(dev);
935 	} else {
936 		pci_pm_reenable_device(pci_dev);
937 	}
938 
939 	return error;
940 }
941 
942 #else /* !CONFIG_SUSPEND */
943 
944 #define pci_pm_suspend		NULL
945 #define pci_pm_suspend_late	NULL
946 #define pci_pm_suspend_noirq	NULL
947 #define pci_pm_resume		NULL
948 #define pci_pm_resume_noirq	NULL
949 
950 #endif /* !CONFIG_SUSPEND */
951 
952 #ifdef CONFIG_HIBERNATE_CALLBACKS
953 
954 
955 /*
956  * pcibios_pm_ops - provide arch-specific hooks when a PCI device is doing
957  * a hibernate transition
958  */
959 struct dev_pm_ops __weak pcibios_pm_ops;
960 
961 static int pci_pm_freeze(struct device *dev)
962 {
963 	struct pci_dev *pci_dev = to_pci_dev(dev);
964 	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
965 
966 	if (pci_has_legacy_pm_support(pci_dev))
967 		return pci_legacy_suspend(dev, PMSG_FREEZE);
968 
969 	if (!pm) {
970 		pci_pm_default_suspend(pci_dev);
971 		return 0;
972 	}
973 
974 	/*
975 	 * This used to be done in pci_pm_prepare() for all devices and some
976 	 * drivers may depend on it, so do it here.  Ideally, runtime-suspended
977 	 * devices should not be touched during freeze/thaw transitions,
978 	 * however.
979 	 */
980 	if (!dev_pm_smart_suspend_and_suspended(dev)) {
981 		pm_runtime_resume(dev);
982 		pci_dev->state_saved = false;
983 	}
984 
985 	if (pm->freeze) {
986 		int error;
987 
988 		error = pm->freeze(dev);
989 		suspend_report_result(pm->freeze, error);
990 		if (error)
991 			return error;
992 	}
993 
994 	return 0;
995 }
996 
997 static int pci_pm_freeze_late(struct device *dev)
998 {
999 	if (dev_pm_smart_suspend_and_suspended(dev))
1000 		return 0;
1001 
1002 	return pm_generic_freeze_late(dev);
1003 }
1004 
1005 static int pci_pm_freeze_noirq(struct device *dev)
1006 {
1007 	struct pci_dev *pci_dev = to_pci_dev(dev);
1008 	struct device_driver *drv = dev->driver;
1009 
1010 	if (dev_pm_smart_suspend_and_suspended(dev))
1011 		return 0;
1012 
1013 	if (pci_has_legacy_pm_support(pci_dev))
1014 		return pci_legacy_suspend_late(dev, PMSG_FREEZE);
1015 
1016 	if (drv && drv->pm && drv->pm->freeze_noirq) {
1017 		int error;
1018 
1019 		error = drv->pm->freeze_noirq(dev);
1020 		suspend_report_result(drv->pm->freeze_noirq, error);
1021 		if (error)
1022 			return error;
1023 	}
1024 
1025 	if (!pci_dev->state_saved)
1026 		pci_save_state(pci_dev);
1027 
1028 	pci_pm_set_unknown_state(pci_dev);
1029 
1030 	if (pcibios_pm_ops.freeze_noirq)
1031 		return pcibios_pm_ops.freeze_noirq(dev);
1032 
1033 	return 0;
1034 }
1035 
1036 static int pci_pm_thaw_noirq(struct device *dev)
1037 {
1038 	struct pci_dev *pci_dev = to_pci_dev(dev);
1039 	struct device_driver *drv = dev->driver;
1040 	int error = 0;
1041 
1042 	/*
1043 	 * If the device is in runtime suspend, the code below may not work
1044 	 * correctly with it, so skip that code and make the PM core skip all of
1045 	 * the subsequent "thaw" callbacks for the device.
1046 	 */
1047 	if (dev_pm_smart_suspend_and_suspended(dev)) {
1048 		dev_pm_skip_next_resume_phases(dev);
1049 		return 0;
1050 	}
1051 
1052 	if (pcibios_pm_ops.thaw_noirq) {
1053 		error = pcibios_pm_ops.thaw_noirq(dev);
1054 		if (error)
1055 			return error;
1056 	}
1057 
1058 	if (pci_has_legacy_pm_support(pci_dev))
1059 		return pci_legacy_resume_early(dev);
1060 
1061 	/*
1062 	 * pci_restore_state() requires the device to be in D0 (because of MSI
1063 	 * restoration among other things), so force it into D0 in case the
1064 	 * driver's "freeze" callbacks put it into a low-power state directly.
1065 	 */
1066 	pci_set_power_state(pci_dev, PCI_D0);
1067 	pci_restore_state(pci_dev);
1068 
1069 	if (drv && drv->pm && drv->pm->thaw_noirq)
1070 		error = drv->pm->thaw_noirq(dev);
1071 
1072 	return error;
1073 }
1074 
1075 static int pci_pm_thaw(struct device *dev)
1076 {
1077 	struct pci_dev *pci_dev = to_pci_dev(dev);
1078 	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1079 	int error = 0;
1080 
1081 	if (pci_has_legacy_pm_support(pci_dev))
1082 		return pci_legacy_resume(dev);
1083 
1084 	if (pm) {
1085 		if (pm->thaw)
1086 			error = pm->thaw(dev);
1087 	} else {
1088 		pci_pm_reenable_device(pci_dev);
1089 	}
1090 
1091 	pci_dev->state_saved = false;
1092 
1093 	return error;
1094 }
1095 
1096 static int pci_pm_poweroff(struct device *dev)
1097 {
1098 	struct pci_dev *pci_dev = to_pci_dev(dev);
1099 	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1100 
1101 	if (pci_has_legacy_pm_support(pci_dev))
1102 		return pci_legacy_suspend(dev, PMSG_HIBERNATE);
1103 
1104 	if (!pm) {
1105 		pci_pm_default_suspend(pci_dev);
1106 		return 0;
1107 	}
1108 
1109 	/* The reason to do that is the same as in pci_pm_suspend(). */
1110 	if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
1111 	    !pci_dev_keep_suspended(pci_dev))
1112 		pm_runtime_resume(dev);
1113 
1114 	pci_dev->state_saved = false;
1115 	if (pm->poweroff) {
1116 		int error;
1117 
1118 		error = pm->poweroff(dev);
1119 		suspend_report_result(pm->poweroff, error);
1120 		if (error)
1121 			return error;
1122 	}
1123 
1124 	return 0;
1125 }
1126 
1127 static int pci_pm_poweroff_late(struct device *dev)
1128 {
1129 	if (dev_pm_smart_suspend_and_suspended(dev))
1130 		return 0;
1131 
1132 	pci_fixup_device(pci_fixup_suspend, to_pci_dev(dev));
1133 
1134 	return pm_generic_poweroff_late(dev);
1135 }
1136 
1137 static int pci_pm_poweroff_noirq(struct device *dev)
1138 {
1139 	struct pci_dev *pci_dev = to_pci_dev(dev);
1140 	struct device_driver *drv = dev->driver;
1141 
1142 	if (dev_pm_smart_suspend_and_suspended(dev))
1143 		return 0;
1144 
1145 	if (pci_has_legacy_pm_support(to_pci_dev(dev)))
1146 		return pci_legacy_suspend_late(dev, PMSG_HIBERNATE);
1147 
1148 	if (!drv || !drv->pm) {
1149 		pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1150 		return 0;
1151 	}
1152 
1153 	if (drv->pm->poweroff_noirq) {
1154 		int error;
1155 
1156 		error = drv->pm->poweroff_noirq(dev);
1157 		suspend_report_result(drv->pm->poweroff_noirq, error);
1158 		if (error)
1159 			return error;
1160 	}
1161 
1162 	if (!pci_dev->state_saved && !pci_has_subordinate(pci_dev))
1163 		pci_prepare_to_sleep(pci_dev);
1164 
1165 	/*
1166 	 * The reason for doing this here is the same as for the analogous code
1167 	 * in pci_pm_suspend_noirq().
1168 	 */
1169 	if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
1170 		pci_write_config_word(pci_dev, PCI_COMMAND, 0);
1171 
1172 	pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1173 
1174 	if (pcibios_pm_ops.poweroff_noirq)
1175 		return pcibios_pm_ops.poweroff_noirq(dev);
1176 
1177 	return 0;
1178 }
1179 
1180 static int pci_pm_restore_noirq(struct device *dev)
1181 {
1182 	struct pci_dev *pci_dev = to_pci_dev(dev);
1183 	struct device_driver *drv = dev->driver;
1184 	int error = 0;
1185 
1186 	/* This is analogous to the pci_pm_resume_noirq() case. */
1187 	if (dev_pm_smart_suspend_and_suspended(dev))
1188 		pm_runtime_set_active(dev);
1189 
1190 	if (pcibios_pm_ops.restore_noirq) {
1191 		error = pcibios_pm_ops.restore_noirq(dev);
1192 		if (error)
1193 			return error;
1194 	}
1195 
1196 	pci_pm_default_resume_early(pci_dev);
1197 
1198 	if (pci_has_legacy_pm_support(pci_dev))
1199 		return pci_legacy_resume_early(dev);
1200 
1201 	if (drv && drv->pm && drv->pm->restore_noirq)
1202 		error = drv->pm->restore_noirq(dev);
1203 
1204 	return error;
1205 }
1206 
1207 static int pci_pm_restore(struct device *dev)
1208 {
1209 	struct pci_dev *pci_dev = to_pci_dev(dev);
1210 	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1211 	int error = 0;
1212 
1213 	/*
1214 	 * This is necessary for the hibernation error path in which restore is
1215 	 * called without restoring the standard config registers of the device.
1216 	 */
1217 	if (pci_dev->state_saved)
1218 		pci_restore_standard_config(pci_dev);
1219 
1220 	if (pci_has_legacy_pm_support(pci_dev))
1221 		return pci_legacy_resume(dev);
1222 
1223 	pci_pm_default_resume(pci_dev);
1224 
1225 	if (pm) {
1226 		if (pm->restore)
1227 			error = pm->restore(dev);
1228 	} else {
1229 		pci_pm_reenable_device(pci_dev);
1230 	}
1231 
1232 	return error;
1233 }
1234 
1235 #else /* !CONFIG_HIBERNATE_CALLBACKS */
1236 
1237 #define pci_pm_freeze		NULL
1238 #define pci_pm_freeze_late	NULL
1239 #define pci_pm_freeze_noirq	NULL
1240 #define pci_pm_thaw		NULL
1241 #define pci_pm_thaw_noirq	NULL
1242 #define pci_pm_poweroff		NULL
1243 #define pci_pm_poweroff_late	NULL
1244 #define pci_pm_poweroff_noirq	NULL
1245 #define pci_pm_restore		NULL
1246 #define pci_pm_restore_noirq	NULL
1247 
1248 #endif /* !CONFIG_HIBERNATE_CALLBACKS */
1249 
1250 #ifdef CONFIG_PM
1251 
1252 static int pci_pm_runtime_suspend(struct device *dev)
1253 {
1254 	struct pci_dev *pci_dev = to_pci_dev(dev);
1255 	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1256 	pci_power_t prev = pci_dev->current_state;
1257 	int error;
1258 
1259 	/*
1260 	 * If pci_dev->driver is not set (unbound), we leave the device in D0,
1261 	 * but it may go to D3cold when the bridge above it runtime suspends.
1262 	 * Save its config space in case that happens.
1263 	 */
1264 	if (!pci_dev->driver) {
1265 		pci_save_state(pci_dev);
1266 		return 0;
1267 	}
1268 
1269 	pci_dev->state_saved = false;
1270 	if (pm && pm->runtime_suspend) {
1271 		error = pm->runtime_suspend(dev);
1272 		/*
1273 		 * -EBUSY and -EAGAIN is used to request the runtime PM core
1274 		 * to schedule a new suspend, so log the event only with debug
1275 		 * log level.
1276 		 */
1277 		if (error == -EBUSY || error == -EAGAIN) {
1278 			dev_dbg(dev, "can't suspend now (%ps returned %d)\n",
1279 				pm->runtime_suspend, error);
1280 			return error;
1281 		} else if (error) {
1282 			dev_err(dev, "can't suspend (%ps returned %d)\n",
1283 				pm->runtime_suspend, error);
1284 			return error;
1285 		}
1286 	}
1287 
1288 	pci_fixup_device(pci_fixup_suspend, pci_dev);
1289 
1290 	if (pm && pm->runtime_suspend
1291 	    && !pci_dev->state_saved && pci_dev->current_state != PCI_D0
1292 	    && pci_dev->current_state != PCI_UNKNOWN) {
1293 		WARN_ONCE(pci_dev->current_state != prev,
1294 			"PCI PM: State of device not saved by %pS\n",
1295 			pm->runtime_suspend);
1296 		return 0;
1297 	}
1298 
1299 	if (!pci_dev->state_saved) {
1300 		pci_save_state(pci_dev);
1301 		pci_finish_runtime_suspend(pci_dev);
1302 	}
1303 
1304 	return 0;
1305 }
1306 
1307 static int pci_pm_runtime_resume(struct device *dev)
1308 {
1309 	int rc = 0;
1310 	struct pci_dev *pci_dev = to_pci_dev(dev);
1311 	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1312 
1313 	/*
1314 	 * Restoring config space is necessary even if the device is not bound
1315 	 * to a driver because although we left it in D0, it may have gone to
1316 	 * D3cold when the bridge above it runtime suspended.
1317 	 */
1318 	pci_restore_standard_config(pci_dev);
1319 
1320 	if (!pci_dev->driver)
1321 		return 0;
1322 
1323 	pci_fixup_device(pci_fixup_resume_early, pci_dev);
1324 	pci_enable_wake(pci_dev, PCI_D0, false);
1325 	pci_fixup_device(pci_fixup_resume, pci_dev);
1326 
1327 	if (pm && pm->runtime_resume)
1328 		rc = pm->runtime_resume(dev);
1329 
1330 	pci_dev->runtime_d3cold = false;
1331 
1332 	return rc;
1333 }
1334 
1335 static int pci_pm_runtime_idle(struct device *dev)
1336 {
1337 	struct pci_dev *pci_dev = to_pci_dev(dev);
1338 	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1339 	int ret = 0;
1340 
1341 	/*
1342 	 * If pci_dev->driver is not set (unbound), the device should
1343 	 * always remain in D0 regardless of the runtime PM status
1344 	 */
1345 	if (!pci_dev->driver)
1346 		return 0;
1347 
1348 	if (!pm)
1349 		return -ENOSYS;
1350 
1351 	if (pm->runtime_idle)
1352 		ret = pm->runtime_idle(dev);
1353 
1354 	return ret;
1355 }
1356 
1357 static const struct dev_pm_ops pci_dev_pm_ops = {
1358 	.prepare = pci_pm_prepare,
1359 	.complete = pci_pm_complete,
1360 	.suspend = pci_pm_suspend,
1361 	.suspend_late = pci_pm_suspend_late,
1362 	.resume = pci_pm_resume,
1363 	.freeze = pci_pm_freeze,
1364 	.freeze_late = pci_pm_freeze_late,
1365 	.thaw = pci_pm_thaw,
1366 	.poweroff = pci_pm_poweroff,
1367 	.poweroff_late = pci_pm_poweroff_late,
1368 	.restore = pci_pm_restore,
1369 	.suspend_noirq = pci_pm_suspend_noirq,
1370 	.resume_noirq = pci_pm_resume_noirq,
1371 	.freeze_noirq = pci_pm_freeze_noirq,
1372 	.thaw_noirq = pci_pm_thaw_noirq,
1373 	.poweroff_noirq = pci_pm_poweroff_noirq,
1374 	.restore_noirq = pci_pm_restore_noirq,
1375 	.runtime_suspend = pci_pm_runtime_suspend,
1376 	.runtime_resume = pci_pm_runtime_resume,
1377 	.runtime_idle = pci_pm_runtime_idle,
1378 };
1379 
1380 #define PCI_PM_OPS_PTR	(&pci_dev_pm_ops)
1381 
1382 #else /* !CONFIG_PM */
1383 
1384 #define pci_pm_runtime_suspend	NULL
1385 #define pci_pm_runtime_resume	NULL
1386 #define pci_pm_runtime_idle	NULL
1387 
1388 #define PCI_PM_OPS_PTR	NULL
1389 
1390 #endif /* !CONFIG_PM */
1391 
1392 /**
1393  * __pci_register_driver - register a new pci driver
1394  * @drv: the driver structure to register
1395  * @owner: owner module of drv
1396  * @mod_name: module name string
1397  *
1398  * Adds the driver structure to the list of registered drivers.
1399  * Returns a negative value on error, otherwise 0.
1400  * If no error occurred, the driver remains registered even if
1401  * no device was claimed during registration.
1402  */
1403 int __pci_register_driver(struct pci_driver *drv, struct module *owner,
1404 			  const char *mod_name)
1405 {
1406 	/* initialize common driver fields */
1407 	drv->driver.name = drv->name;
1408 	drv->driver.bus = &pci_bus_type;
1409 	drv->driver.owner = owner;
1410 	drv->driver.mod_name = mod_name;
1411 	drv->driver.groups = drv->groups;
1412 
1413 	spin_lock_init(&drv->dynids.lock);
1414 	INIT_LIST_HEAD(&drv->dynids.list);
1415 
1416 	/* register with core */
1417 	return driver_register(&drv->driver);
1418 }
1419 EXPORT_SYMBOL(__pci_register_driver);
1420 
1421 /**
1422  * pci_unregister_driver - unregister a pci driver
1423  * @drv: the driver structure to unregister
1424  *
1425  * Deletes the driver structure from the list of registered PCI drivers,
1426  * gives it a chance to clean up by calling its remove() function for
1427  * each device it was responsible for, and marks those devices as
1428  * driverless.
1429  */
1430 
1431 void pci_unregister_driver(struct pci_driver *drv)
1432 {
1433 	driver_unregister(&drv->driver);
1434 	pci_free_dynids(drv);
1435 }
1436 EXPORT_SYMBOL(pci_unregister_driver);
1437 
1438 static struct pci_driver pci_compat_driver = {
1439 	.name = "compat"
1440 };
1441 
1442 /**
1443  * pci_dev_driver - get the pci_driver of a device
1444  * @dev: the device to query
1445  *
1446  * Returns the appropriate pci_driver structure or %NULL if there is no
1447  * registered driver for the device.
1448  */
1449 struct pci_driver *pci_dev_driver(const struct pci_dev *dev)
1450 {
1451 	if (dev->driver)
1452 		return dev->driver;
1453 	else {
1454 		int i;
1455 		for (i = 0; i <= PCI_ROM_RESOURCE; i++)
1456 			if (dev->resource[i].flags & IORESOURCE_BUSY)
1457 				return &pci_compat_driver;
1458 	}
1459 	return NULL;
1460 }
1461 EXPORT_SYMBOL(pci_dev_driver);
1462 
1463 /**
1464  * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure
1465  * @dev: the PCI device structure to match against
1466  * @drv: the device driver to search for matching PCI device id structures
1467  *
1468  * Used by a driver to check whether a PCI device present in the
1469  * system is in its list of supported devices. Returns the matching
1470  * pci_device_id structure or %NULL if there is no match.
1471  */
1472 static int pci_bus_match(struct device *dev, struct device_driver *drv)
1473 {
1474 	struct pci_dev *pci_dev = to_pci_dev(dev);
1475 	struct pci_driver *pci_drv;
1476 	const struct pci_device_id *found_id;
1477 
1478 	if (!pci_dev->match_driver)
1479 		return 0;
1480 
1481 	pci_drv = to_pci_driver(drv);
1482 	found_id = pci_match_device(pci_drv, pci_dev);
1483 	if (found_id)
1484 		return 1;
1485 
1486 	return 0;
1487 }
1488 
1489 /**
1490  * pci_dev_get - increments the reference count of the pci device structure
1491  * @dev: the device being referenced
1492  *
1493  * Each live reference to a device should be refcounted.
1494  *
1495  * Drivers for PCI devices should normally record such references in
1496  * their probe() methods, when they bind to a device, and release
1497  * them by calling pci_dev_put(), in their disconnect() methods.
1498  *
1499  * A pointer to the device with the incremented reference counter is returned.
1500  */
1501 struct pci_dev *pci_dev_get(struct pci_dev *dev)
1502 {
1503 	if (dev)
1504 		get_device(&dev->dev);
1505 	return dev;
1506 }
1507 EXPORT_SYMBOL(pci_dev_get);
1508 
1509 /**
1510  * pci_dev_put - release a use of the pci device structure
1511  * @dev: device that's been disconnected
1512  *
1513  * Must be called when a user of a device is finished with it.  When the last
1514  * user of the device calls this function, the memory of the device is freed.
1515  */
1516 void pci_dev_put(struct pci_dev *dev)
1517 {
1518 	if (dev)
1519 		put_device(&dev->dev);
1520 }
1521 EXPORT_SYMBOL(pci_dev_put);
1522 
1523 static int pci_uevent(struct device *dev, struct kobj_uevent_env *env)
1524 {
1525 	struct pci_dev *pdev;
1526 
1527 	if (!dev)
1528 		return -ENODEV;
1529 
1530 	pdev = to_pci_dev(dev);
1531 
1532 	if (add_uevent_var(env, "PCI_CLASS=%04X", pdev->class))
1533 		return -ENOMEM;
1534 
1535 	if (add_uevent_var(env, "PCI_ID=%04X:%04X", pdev->vendor, pdev->device))
1536 		return -ENOMEM;
1537 
1538 	if (add_uevent_var(env, "PCI_SUBSYS_ID=%04X:%04X", pdev->subsystem_vendor,
1539 			   pdev->subsystem_device))
1540 		return -ENOMEM;
1541 
1542 	if (add_uevent_var(env, "PCI_SLOT_NAME=%s", pci_name(pdev)))
1543 		return -ENOMEM;
1544 
1545 	if (add_uevent_var(env, "MODALIAS=pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02X",
1546 			   pdev->vendor, pdev->device,
1547 			   pdev->subsystem_vendor, pdev->subsystem_device,
1548 			   (u8)(pdev->class >> 16), (u8)(pdev->class >> 8),
1549 			   (u8)(pdev->class)))
1550 		return -ENOMEM;
1551 
1552 	return 0;
1553 }
1554 
1555 #if defined(CONFIG_PCIEPORTBUS) || defined(CONFIG_EEH)
1556 /**
1557  * pci_uevent_ers - emit a uevent during recovery path of PCI device
1558  * @pdev: PCI device undergoing error recovery
1559  * @err_type: type of error event
1560  */
1561 void pci_uevent_ers(struct pci_dev *pdev, enum pci_ers_result err_type)
1562 {
1563 	int idx = 0;
1564 	char *envp[3];
1565 
1566 	switch (err_type) {
1567 	case PCI_ERS_RESULT_NONE:
1568 	case PCI_ERS_RESULT_CAN_RECOVER:
1569 		envp[idx++] = "ERROR_EVENT=BEGIN_RECOVERY";
1570 		envp[idx++] = "DEVICE_ONLINE=0";
1571 		break;
1572 	case PCI_ERS_RESULT_RECOVERED:
1573 		envp[idx++] = "ERROR_EVENT=SUCCESSFUL_RECOVERY";
1574 		envp[idx++] = "DEVICE_ONLINE=1";
1575 		break;
1576 	case PCI_ERS_RESULT_DISCONNECT:
1577 		envp[idx++] = "ERROR_EVENT=FAILED_RECOVERY";
1578 		envp[idx++] = "DEVICE_ONLINE=0";
1579 		break;
1580 	default:
1581 		break;
1582 	}
1583 
1584 	if (idx > 0) {
1585 		envp[idx++] = NULL;
1586 		kobject_uevent_env(&pdev->dev.kobj, KOBJ_CHANGE, envp);
1587 	}
1588 }
1589 #endif
1590 
1591 static int pci_bus_num_vf(struct device *dev)
1592 {
1593 	return pci_num_vf(to_pci_dev(dev));
1594 }
1595 
1596 /**
1597  * pci_dma_configure - Setup DMA configuration
1598  * @dev: ptr to dev structure
1599  *
1600  * Function to update PCI devices's DMA configuration using the same
1601  * info from the OF node or ACPI node of host bridge's parent (if any).
1602  */
1603 static int pci_dma_configure(struct device *dev)
1604 {
1605 	struct device *bridge;
1606 	int ret = 0;
1607 
1608 	bridge = pci_get_host_bridge_device(to_pci_dev(dev));
1609 
1610 	if (IS_ENABLED(CONFIG_OF) && bridge->parent &&
1611 	    bridge->parent->of_node) {
1612 		ret = of_dma_configure(dev, bridge->parent->of_node, true);
1613 	} else if (has_acpi_companion(bridge)) {
1614 		struct acpi_device *adev = to_acpi_device_node(bridge->fwnode);
1615 
1616 		ret = acpi_dma_configure(dev, acpi_get_dma_attr(adev));
1617 	}
1618 
1619 	pci_put_host_bridge_device(bridge);
1620 	return ret;
1621 }
1622 
1623 struct bus_type pci_bus_type = {
1624 	.name		= "pci",
1625 	.match		= pci_bus_match,
1626 	.uevent		= pci_uevent,
1627 	.probe		= pci_device_probe,
1628 	.remove		= pci_device_remove,
1629 	.shutdown	= pci_device_shutdown,
1630 	.dev_groups	= pci_dev_groups,
1631 	.bus_groups	= pci_bus_groups,
1632 	.drv_groups	= pci_drv_groups,
1633 	.pm		= PCI_PM_OPS_PTR,
1634 	.num_vf		= pci_bus_num_vf,
1635 	.dma_configure	= pci_dma_configure,
1636 };
1637 EXPORT_SYMBOL(pci_bus_type);
1638 
1639 #ifdef CONFIG_PCIEPORTBUS
1640 static int pcie_port_bus_match(struct device *dev, struct device_driver *drv)
1641 {
1642 	struct pcie_device *pciedev;
1643 	struct pcie_port_service_driver *driver;
1644 
1645 	if (drv->bus != &pcie_port_bus_type || dev->bus != &pcie_port_bus_type)
1646 		return 0;
1647 
1648 	pciedev = to_pcie_device(dev);
1649 	driver = to_service_driver(drv);
1650 
1651 	if (driver->service != pciedev->service)
1652 		return 0;
1653 
1654 	if (driver->port_type != PCIE_ANY_PORT &&
1655 	    driver->port_type != pci_pcie_type(pciedev->port))
1656 		return 0;
1657 
1658 	return 1;
1659 }
1660 
1661 struct bus_type pcie_port_bus_type = {
1662 	.name		= "pci_express",
1663 	.match		= pcie_port_bus_match,
1664 };
1665 EXPORT_SYMBOL_GPL(pcie_port_bus_type);
1666 #endif
1667 
1668 static int __init pci_driver_init(void)
1669 {
1670 	int ret;
1671 
1672 	ret = bus_register(&pci_bus_type);
1673 	if (ret)
1674 		return ret;
1675 
1676 #ifdef CONFIG_PCIEPORTBUS
1677 	ret = bus_register(&pcie_port_bus_type);
1678 	if (ret)
1679 		return ret;
1680 #endif
1681 	dma_debug_add_bus(&pci_bus_type);
1682 	return 0;
1683 }
1684 postcore_initcall(pci_driver_init);
1685