blob: 449466f71040d22e0709800862fc170c66904c52 [file] [log] [blame]
Bjorn Helgaas8cfab3c2018-01-26 12:50:27 -06001// SPDX-License-Identifier: GPL-2.0
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
Greg Kroah-Hartman2b937302007-11-28 12:23:18 -08003 * (C) Copyright 2002-2004, 2007 Greg Kroah-Hartman <greg@kroah.com>
4 * (C) Copyright 2007 Novell Inc.
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 */
6
7#include <linux/pci.h>
8#include <linux/module.h>
9#include <linux/init.h>
10#include <linux/device.h>
Andi Kleend42c6992005-07-06 19:56:03 +020011#include <linux/mempolicy.h>
Tim Schmielau4e57b682005-10-30 15:03:48 -080012#include <linux/string.h>
13#include <linux/slab.h>
Tim Schmielau8c65b4a2005-11-07 00:59:43 -080014#include <linux/sched.h>
Alex Belits69a18b12020-06-25 18:34:42 -040015#include <linux/sched/isolation.h>
Rusty Russell873392c2008-12-31 23:54:56 +103016#include <linux/cpu.h>
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +010017#include <linux/pm_runtime.h>
Rafael J. Wysockieea3fc02011-07-06 10:51:40 +020018#include <linux/suspend.h>
Khalid Aziz4fc9bbf2013-11-27 15:19:25 -070019#include <linux/kexec.h>
Nipun Gupta07397df2018-04-28 08:21:58 +053020#include <linux/of_device.h>
21#include <linux/acpi.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include "pci.h"
Bjorn Helgaasc6c889d2018-03-09 11:06:56 -060023#include "pcie/portdrv.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
Greg Kroah-Hartman75865852005-06-30 02:18:12 -070025struct pci_dynid {
26 struct list_head node;
27 struct pci_device_id id;
28};
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
30/**
Tejun Heo9dba9102009-09-03 15:26:36 +090031 * pci_add_dynid - add a new PCI device ID to this driver and re-probe devices
32 * @drv: target pci driver
33 * @vendor: PCI vendor ID
34 * @device: PCI device ID
35 * @subvendor: PCI subvendor ID
36 * @subdevice: PCI subdevice ID
37 * @class: PCI class
38 * @class_mask: PCI class mask
39 * @driver_data: private driver data
40 *
41 * Adds a new dynamic pci device ID to this driver and causes the
42 * driver to probe for all devices again. @drv must have been
43 * registered prior to calling this function.
44 *
45 * CONTEXT:
46 * Does GFP_KERNEL allocation.
47 *
48 * RETURNS:
49 * 0 on success, -errno on failure.
50 */
51int pci_add_dynid(struct pci_driver *drv,
52 unsigned int vendor, unsigned int device,
53 unsigned int subvendor, unsigned int subdevice,
54 unsigned int class, unsigned int class_mask,
55 unsigned long driver_data)
56{
57 struct pci_dynid *dynid;
Tejun Heo9dba9102009-09-03 15:26:36 +090058
59 dynid = kzalloc(sizeof(*dynid), GFP_KERNEL);
60 if (!dynid)
61 return -ENOMEM;
62
63 dynid->id.vendor = vendor;
64 dynid->id.device = device;
65 dynid->id.subvendor = subvendor;
66 dynid->id.subdevice = subdevice;
67 dynid->id.class = class;
68 dynid->id.class_mask = class_mask;
69 dynid->id.driver_data = driver_data;
70
71 spin_lock(&drv->dynids.lock);
72 list_add_tail(&dynid->node, &drv->dynids.list);
73 spin_unlock(&drv->dynids.lock);
74
Tobias Klauser3b7f1012014-07-25 10:36:14 +020075 return driver_attach(&drv->driver);
Tejun Heo9dba9102009-09-03 15:26:36 +090076}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -060077EXPORT_SYMBOL_GPL(pci_add_dynid);
Tejun Heo9dba9102009-09-03 15:26:36 +090078
79static void pci_free_dynids(struct pci_driver *drv)
80{
81 struct pci_dynid *dynid, *n;
82
83 spin_lock(&drv->dynids.lock);
84 list_for_each_entry_safe(dynid, n, &drv->dynids.list, node) {
85 list_del(&dynid->node);
86 kfree(dynid);
87 }
88 spin_unlock(&drv->dynids.lock);
89}
90
Tejun Heo9dba9102009-09-03 15:26:36 +090091/**
92 * store_new_id - sysfs frontend to pci_add_dynid()
Randy Dunlap8f7020d2005-10-23 11:57:38 -070093 * @driver: target device driver
94 * @buf: buffer for scanning device ID data
95 * @count: input size
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 *
Tejun Heo9dba9102009-09-03 15:26:36 +090097 * Allow PCI IDs to be added to an existing driver via sysfs.
Linus Torvalds1da177e2005-04-16 15:20:36 -070098 */
Greg Kroah-Hartmana9427742017-06-09 11:03:06 +020099static ssize_t new_id_store(struct device_driver *driver, const char *buf,
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400100 size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 struct pci_driver *pdrv = to_pci_driver(driver);
Jean Delvareb41d6cf2008-08-17 21:06:59 +0200103 const struct pci_device_id *ids = pdrv->id_table;
Logan Gunthorpe20a796a2019-02-08 09:54:39 -0700104 u32 vendor, device, subvendor = PCI_ANY_ID,
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400105 subdevice = PCI_ANY_ID, class = 0, class_mask = 0;
106 unsigned long driver_data = 0;
107 int fields = 0;
Bandan Das8895d3b2014-04-01 21:32:59 -0400108 int retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
Jean Delvareb41d6cf2008-08-17 21:06:59 +0200110 fields = sscanf(buf, "%x %x %x %x %x %x %lx",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 &vendor, &device, &subvendor, &subdevice,
112 &class, &class_mask, &driver_data);
Jean Delvare6ba18632007-04-07 17:21:28 +0200113 if (fields < 2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 return -EINVAL;
115
Bandan Das8895d3b2014-04-01 21:32:59 -0400116 if (fields != 7) {
117 struct pci_dev *pdev = kzalloc(sizeof(*pdev), GFP_KERNEL);
118 if (!pdev)
119 return -ENOMEM;
120
121 pdev->vendor = vendor;
122 pdev->device = device;
123 pdev->subsystem_vendor = subvendor;
124 pdev->subsystem_device = subdevice;
125 pdev->class = class;
126
127 if (pci_match_id(pdrv->id_table, pdev))
128 retval = -EEXIST;
129
130 kfree(pdev);
131
132 if (retval)
133 return retval;
134 }
135
Jean Delvareb41d6cf2008-08-17 21:06:59 +0200136 /* Only accept driver_data values that match an existing id_table
137 entry */
Chris Wright2debb4d2008-11-25 19:36:10 -0800138 if (ids) {
139 retval = -EINVAL;
140 while (ids->vendor || ids->subvendor || ids->class_mask) {
141 if (driver_data == ids->driver_data) {
142 retval = 0;
143 break;
144 }
145 ids++;
Jean Delvareb41d6cf2008-08-17 21:06:59 +0200146 }
Chris Wright2debb4d2008-11-25 19:36:10 -0800147 if (retval) /* No match */
148 return retval;
Jean Delvareb41d6cf2008-08-17 21:06:59 +0200149 }
Jean Delvareb41d6cf2008-08-17 21:06:59 +0200150
Tejun Heo9dba9102009-09-03 15:26:36 +0900151 retval = pci_add_dynid(pdrv, vendor, device, subvendor, subdevice,
152 class, class_mask, driver_data);
Greg Kroah-Hartmanb19441a2006-08-28 11:43:25 -0700153 if (retval)
154 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 return count;
156}
Greg Kroah-Hartmana9427742017-06-09 11:03:06 +0200157static DRIVER_ATTR_WO(new_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158
Chris Wright09943752009-02-23 21:52:23 -0800159/**
160 * store_remove_id - remove a PCI device ID from this driver
161 * @driver: target device driver
162 * @buf: buffer for scanning device ID data
163 * @count: input size
164 *
165 * Removes a dynamic pci device ID to this driver.
166 */
Greg Kroah-Hartmana9427742017-06-09 11:03:06 +0200167static ssize_t remove_id_store(struct device_driver *driver, const char *buf,
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400168 size_t count)
Chris Wright09943752009-02-23 21:52:23 -0800169{
170 struct pci_dynid *dynid, *n;
171 struct pci_driver *pdrv = to_pci_driver(driver);
Logan Gunthorpe20a796a2019-02-08 09:54:39 -0700172 u32 vendor, device, subvendor = PCI_ANY_ID,
Chris Wright09943752009-02-23 21:52:23 -0800173 subdevice = PCI_ANY_ID, class = 0, class_mask = 0;
174 int fields = 0;
Zhen Lei92220972015-09-10 18:40:31 +0800175 size_t retval = -ENODEV;
Chris Wright09943752009-02-23 21:52:23 -0800176
177 fields = sscanf(buf, "%x %x %x %x %x %x",
178 &vendor, &device, &subvendor, &subdevice,
179 &class, &class_mask);
180 if (fields < 2)
181 return -EINVAL;
182
183 spin_lock(&pdrv->dynids.lock);
184 list_for_each_entry_safe(dynid, n, &pdrv->dynids.list, node) {
185 struct pci_device_id *id = &dynid->id;
186 if ((id->vendor == vendor) &&
187 (id->device == device) &&
188 (subvendor == PCI_ANY_ID || id->subvendor == subvendor) &&
189 (subdevice == PCI_ANY_ID || id->subdevice == subdevice) &&
190 !((id->class ^ class) & class_mask)) {
191 list_del(&dynid->node);
192 kfree(dynid);
Zhen Lei92220972015-09-10 18:40:31 +0800193 retval = count;
Chris Wright09943752009-02-23 21:52:23 -0800194 break;
195 }
196 }
197 spin_unlock(&pdrv->dynids.lock);
198
Zhen Lei92220972015-09-10 18:40:31 +0800199 return retval;
Chris Wright09943752009-02-23 21:52:23 -0800200}
Greg Kroah-Hartmana9427742017-06-09 11:03:06 +0200201static DRIVER_ATTR_WO(remove_id);
Chris Wright09943752009-02-23 21:52:23 -0800202
Greg Kroah-Hartman2229c1f2013-10-07 14:51:20 -0600203static struct attribute *pci_drv_attrs[] = {
204 &driver_attr_new_id.attr,
205 &driver_attr_remove_id.attr,
206 NULL,
Konstantin Khlebnikovbfb09a82012-08-08 14:47:51 +0400207};
Greg Kroah-Hartman2229c1f2013-10-07 14:51:20 -0600208ATTRIBUTE_GROUPS(pci_drv);
Alan Sterned283e92012-01-24 14:35:13 -0500209
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210/**
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700211 * pci_match_id - See if a pci device matches a given pci_id table
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 * @ids: array of PCI device id structures to search in
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700213 * @dev: the PCI device structure to match against.
214 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 * Used by a driver to check whether a PCI device present in the
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700216 * system is in its list of supported devices. Returns the matching
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217 * pci_device_id structure or %NULL if there is no match.
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700218 *
Randy Dunlap8b607562007-05-09 07:19:14 +0200219 * Deprecated, don't use this as it will not catch any dynamic ids
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700220 * that a driver might want to check for.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 */
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700222const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
223 struct pci_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224{
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700225 if (ids) {
226 while (ids->vendor || ids->subvendor || ids->class_mask) {
227 if (pci_match_one_device(ids, dev))
228 return ids;
229 ids++;
230 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 }
232 return NULL;
233}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -0600234EXPORT_SYMBOL(pci_match_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
Alex Williamson782a9852014-05-20 08:53:21 -0600236static const struct pci_device_id pci_device_id_any = {
237 .vendor = PCI_ANY_ID,
238 .device = PCI_ANY_ID,
239 .subvendor = PCI_ANY_ID,
240 .subdevice = PCI_ANY_ID,
241};
242
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243/**
Randy Dunlapae9608a2007-01-09 21:41:01 -0800244 * pci_match_device - Tell if a PCI device structure has a matching PCI device id structure
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700245 * @drv: the PCI driver to match against
Henrik Kretzschmar39ba4872006-08-15 10:57:16 +0200246 * @dev: the PCI device structure to match against
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700247 *
248 * Used by a driver to check whether a PCI device present in the
249 * system is in its list of supported devices. Returns the matching
250 * pci_device_id structure or %NULL if there is no match.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251 */
Adrian Bunkd73460d2007-10-24 18:27:18 +0200252static const struct pci_device_id *pci_match_device(struct pci_driver *drv,
253 struct pci_dev *dev)
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700254{
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700255 struct pci_dynid *dynid;
Alex Williamson782a9852014-05-20 08:53:21 -0600256 const struct pci_device_id *found_id = NULL;
257
258 /* When driver_override is set, only bind to the matching driver */
259 if (dev->driver_override && strcmp(dev->driver_override, drv->name))
260 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261
Russell King7461b602006-11-29 21:18:04 +0000262 /* Look at the dynamic ids first, before the static ones */
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700263 spin_lock(&drv->dynids.lock);
264 list_for_each_entry(dynid, &drv->dynids.list, node) {
265 if (pci_match_one_device(&dynid->id, dev)) {
Alex Williamson782a9852014-05-20 08:53:21 -0600266 found_id = &dynid->id;
267 break;
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700268 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 }
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700270 spin_unlock(&drv->dynids.lock);
Russell King7461b602006-11-29 21:18:04 +0000271
Alex Williamson782a9852014-05-20 08:53:21 -0600272 if (!found_id)
273 found_id = pci_match_id(drv->id_table, dev);
274
275 /* driver_override will always match, send a dummy id */
276 if (!found_id && dev->driver_override)
277 found_id = &pci_device_id_any;
278
279 return found_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280}
281
Rusty Russell873392c2008-12-31 23:54:56 +1030282struct drv_dev_and_id {
283 struct pci_driver *drv;
284 struct pci_dev *dev;
285 const struct pci_device_id *id;
286};
287
288static long local_pci_probe(void *_ddi)
289{
290 struct drv_dev_and_id *ddi = _ddi;
Huang Ying967577b2012-11-20 16:08:22 +0800291 struct pci_dev *pci_dev = ddi->dev;
292 struct pci_driver *pci_drv = ddi->drv;
293 struct device *dev = &pci_dev->dev;
Alan Sternf3ec4f82010-06-08 15:23:51 -0400294 int rc;
Rusty Russell873392c2008-12-31 23:54:56 +1030295
Huang Ying967577b2012-11-20 16:08:22 +0800296 /*
297 * Unbound PCI devices are always put in D0, regardless of
298 * runtime PM status. During probe, the device is set to
299 * active and the usage count is incremented. If the driver
Rafael J. Wysockia8360062015-09-18 03:08:40 +0200300 * supports runtime PM, it should call pm_runtime_put_noidle(),
301 * or any other runtime PM helper function decrementing the usage
302 * count, in its probe routine and pm_runtime_get_noresume() in
303 * its remove routine.
Alan Sternf3ec4f82010-06-08 15:23:51 -0400304 */
Huang Ying967577b2012-11-20 16:08:22 +0800305 pm_runtime_get_sync(dev);
306 pci_dev->driver = pci_drv;
307 rc = pci_drv->probe(pci_dev, ddi->id);
Stephen M. Cameronf92d74c2013-11-01 14:34:55 -0500308 if (!rc)
309 return rc;
310 if (rc < 0) {
Huang Ying967577b2012-11-20 16:08:22 +0800311 pci_dev->driver = NULL;
312 pm_runtime_put_sync(dev);
Stephen M. Cameronf92d74c2013-11-01 14:34:55 -0500313 return rc;
Alan Sternf3ec4f82010-06-08 15:23:51 -0400314 }
Stephen M. Cameronf92d74c2013-11-01 14:34:55 -0500315 /*
316 * Probe function should return < 0 for failure, 0 for success
317 * Treat values > 0 as success, but warn.
318 */
Bjorn Helgaas6941a0c2019-10-07 07:55:18 -0500319 pci_warn(pci_dev, "Driver probe function unexpectedly returned %d\n",
320 rc);
Stephen M. Cameronf92d74c2013-11-01 14:34:55 -0500321 return 0;
Rusty Russell873392c2008-12-31 23:54:56 +1030322}
323
Thomas Gleixner0b2c2a72017-05-24 10:15:32 +0200324static bool pci_physfn_is_probed(struct pci_dev *dev)
325{
326#ifdef CONFIG_PCI_IOV
327 return dev->is_virtfn && dev->physfn->is_probed;
328#else
329 return false;
330#endif
331}
332
Andi Kleend42c6992005-07-06 19:56:03 +0200333static int pci_call_probe(struct pci_driver *drv, struct pci_dev *dev,
334 const struct pci_device_id *id)
335{
Thomas Gleixner0b2c2a72017-05-24 10:15:32 +0200336 int error, node, cpu;
Alex Belits69a18b12020-06-25 18:34:42 -0400337 int hk_flags = HK_FLAG_DOMAIN | HK_FLAG_WQ;
Rusty Russell873392c2008-12-31 23:54:56 +1030338 struct drv_dev_and_id ddi = { drv, dev, id };
Mike Travisf70316d2008-04-04 18:11:06 -0700339
Alexander Duyck12c31562013-11-18 10:59:59 -0700340 /*
341 * Execute driver initialization on node where the device is
342 * attached. This way the driver likely allocates its local memory
343 * on the right node.
344 */
Rusty Russell873392c2008-12-31 23:54:56 +1030345 node = dev_to_node(&dev->dev);
Thomas Gleixner0b2c2a72017-05-24 10:15:32 +0200346 dev->is_probed = 1;
347
348 cpu_hotplug_disable();
Alexander Duyck12c31562013-11-18 10:59:59 -0700349
350 /*
Thomas Gleixner0b2c2a72017-05-24 10:15:32 +0200351 * Prevent nesting work_on_cpu() for the case where a Virtual Function
352 * device is probed from work_on_cpu() of the Physical device.
Alexander Duyck12c31562013-11-18 10:59:59 -0700353 */
Thomas Gleixner0b2c2a72017-05-24 10:15:32 +0200354 if (node < 0 || node >= MAX_NUMNODES || !node_online(node) ||
355 pci_physfn_is_probed(dev))
356 cpu = nr_cpu_ids;
357 else
Alex Belits69a18b12020-06-25 18:34:42 -0400358 cpu = cpumask_any_and(cpumask_of_node(node),
359 housekeeping_cpumask(hk_flags));
Thomas Gleixner0b2c2a72017-05-24 10:15:32 +0200360
361 if (cpu < nr_cpu_ids)
362 error = work_on_cpu(cpu, local_pci_probe, &ddi);
363 else
Rusty Russell873392c2008-12-31 23:54:56 +1030364 error = local_pci_probe(&ddi);
Alexander Duyck12c31562013-11-18 10:59:59 -0700365
Thomas Gleixner0b2c2a72017-05-24 10:15:32 +0200366 dev->is_probed = 0;
367 cpu_hotplug_enable();
Andi Kleend42c6992005-07-06 19:56:03 +0200368 return error;
369}
370
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371/**
Randy Dunlap23ea3792010-11-18 15:02:31 -0800372 * __pci_device_probe - check if a driver wants to claim a specific PCI device
Randy Dunlap8f7020d2005-10-23 11:57:38 -0700373 * @drv: driver to call to check if it wants the PCI device
374 * @pci_dev: PCI device being probed
Bjorn Helgaasf7625982013-11-14 11:28:18 -0700375 *
Randy Dunlap8f7020d2005-10-23 11:57:38 -0700376 * returns 0 on success, else error.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 * side-effect: pci_dev->driver is set to drv when drv claims pci_dev.
378 */
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400379static int __pci_device_probe(struct pci_driver *drv, struct pci_dev *pci_dev)
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700380{
381 const struct pci_device_id *id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382 int error = 0;
383
384 if (!pci_dev->driver && drv->probe) {
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700385 error = -ENODEV;
386
387 id = pci_match_device(drv, pci_dev);
388 if (id)
Andi Kleend42c6992005-07-06 19:56:03 +0200389 error = pci_call_probe(drv, pci_dev, id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 }
391 return error;
392}
393
Jiang Liu890e4842015-06-10 16:54:58 +0800394int __weak pcibios_alloc_irq(struct pci_dev *dev)
395{
396 return 0;
397}
398
399void __weak pcibios_free_irq(struct pci_dev *dev)
400{
401}
402
Bodong Wang0e7df222017-04-13 01:51:40 +0300403#ifdef CONFIG_PCI_IOV
404static inline bool pci_device_can_probe(struct pci_dev *pdev)
405{
Alex Williamson2d2f4272019-05-09 13:27:22 -0600406 return (!pdev->is_virtfn || pdev->physfn->sriov->drivers_autoprobe ||
407 pdev->driver_override);
Bodong Wang0e7df222017-04-13 01:51:40 +0300408}
409#else
410static inline bool pci_device_can_probe(struct pci_dev *pdev)
411{
412 return true;
413}
414#endif
415
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400416static int pci_device_probe(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417{
Jiang Liu890e4842015-06-10 16:54:58 +0800418 int error;
419 struct pci_dev *pci_dev = to_pci_dev(dev);
420 struct pci_driver *drv = to_pci_driver(dev->driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421
Alex Williamson76002d82019-05-01 11:00:16 -0600422 if (!pci_device_can_probe(pci_dev))
423 return -ENODEV;
424
Matthew Minter30fdfb92017-06-28 15:14:04 -0500425 pci_assign_irq(pci_dev);
426
Jiang Liu890e4842015-06-10 16:54:58 +0800427 error = pcibios_alloc_irq(pci_dev);
428 if (error < 0)
429 return error;
430
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 pci_dev_get(pci_dev);
Alex Williamson76002d82019-05-01 11:00:16 -0600432 error = __pci_device_probe(drv, pci_dev);
433 if (error) {
434 pcibios_free_irq(pci_dev);
435 pci_dev_put(pci_dev);
Jiang Liu890e4842015-06-10 16:54:58 +0800436 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437
438 return error;
439}
440
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400441static int pci_device_remove(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442{
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400443 struct pci_dev *pci_dev = to_pci_dev(dev);
444 struct pci_driver *drv = pci_dev->driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445
446 if (drv) {
Alan Sternf3ec4f82010-06-08 15:23:51 -0400447 if (drv->remove) {
448 pm_runtime_get_sync(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 drv->remove(pci_dev);
Alan Sternf3ec4f82010-06-08 15:23:51 -0400450 pm_runtime_put_noidle(dev);
451 }
Jiang Liu890e4842015-06-10 16:54:58 +0800452 pcibios_free_irq(pci_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 pci_dev->driver = NULL;
Jakub Kicinski38972372018-06-29 15:08:52 -0500454 pci_iov_remove(pci_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 }
456
Alan Sternf3ec4f82010-06-08 15:23:51 -0400457 /* Undo the runtime PM settings in local_pci_probe() */
Huang Ying967577b2012-11-20 16:08:22 +0800458 pm_runtime_put_sync(dev);
Alan Sternf3ec4f82010-06-08 15:23:51 -0400459
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460 /*
Shaohua Li2449e062006-10-20 14:45:32 -0700461 * If the device is still on, set the power state as "unknown",
462 * since it might change by the next time we load the driver.
463 */
464 if (pci_dev->current_state == PCI_D0)
465 pci_dev->current_state = PCI_UNKNOWN;
466
467 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 * We would love to complain here if pci_dev->is_enabled is set, that
469 * the driver should have called pci_disable_device(), but the
470 * unfortunate fact is there are too many odd BIOS and bridge setups
Bjorn Helgaasf7625982013-11-14 11:28:18 -0700471 * that don't like drivers doing that all of the time.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 * Oh well, we can dream of sane hardware when we sleep, no matter how
473 * horrible the crap we have to deal with is when we are awake...
474 */
475
476 pci_dev_put(pci_dev);
477 return 0;
478}
479
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200480static void pci_device_shutdown(struct device *dev)
481{
482 struct pci_dev *pci_dev = to_pci_dev(dev);
483 struct pci_driver *drv = pci_dev->driver;
484
Huang Ying3ff2de92012-10-24 14:54:14 +0800485 pm_runtime_resume(dev);
486
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200487 if (drv && drv->shutdown)
488 drv->shutdown(pci_dev);
Rafael J. Wysocki5b415f12012-02-07 00:50:35 +0100489
490 /*
Khalid Aziz4fc9bbf2013-11-27 15:19:25 -0700491 * If this is a kexec reboot, turn off Bus Master bit on the
492 * device to tell it to not continue to do DMA. Don't touch
493 * devices in D3cold or unknown states.
494 * If it is not a kexec reboot, firmware will hit the PCI
495 * devices with big hammer and stop their DMA any way.
Khalid Azizb566a222012-04-27 13:00:33 -0600496 */
Khalid Aziz4fc9bbf2013-11-27 15:19:25 -0700497 if (kexec_in_progress && (pci_dev->current_state <= PCI_D3hot))
Konstantin Khlebnikov6e0eda32013-03-14 18:49:37 +0400498 pci_clear_master(pci_dev);
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200499}
500
Rafael J. Wysockiaa338602011-02-11 00:06:54 +0100501#ifdef CONFIG_PM
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +0100502
503/* Auxiliary functions used for system resume and run-time resume. */
504
505/**
506 * pci_restore_standard_config - restore standard config registers of PCI device
507 * @pci_dev: PCI device to handle
508 */
509static int pci_restore_standard_config(struct pci_dev *pci_dev)
510{
511 pci_update_current_state(pci_dev, PCI_UNKNOWN);
512
513 if (pci_dev->current_state != PCI_D0) {
514 int error = pci_set_power_state(pci_dev, PCI_D0);
515 if (error)
516 return error;
517 }
518
Jon Mason1d3c16a2010-11-30 17:43:26 -0600519 pci_restore_state(pci_dev);
Rafael J. Wysocki0ce3fca2017-07-12 03:05:39 +0200520 pci_pme_restore(pci_dev);
Jon Mason1d3c16a2010-11-30 17:43:26 -0600521 return 0;
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +0100522}
523
Bjorn Helgaasf7b32a82019-10-12 17:15:57 -0500524static void pci_pm_default_resume(struct pci_dev *pci_dev)
525{
526 pci_fixup_device(pci_fixup_resume, pci_dev);
527 pci_enable_wake(pci_dev, PCI_D0, false);
528}
529
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +0100530#endif
531
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200532#ifdef CONFIG_PM_SLEEP
533
Rafael J. Wysockidb288c92012-07-05 15:20:00 -0600534static void pci_pm_default_resume_early(struct pci_dev *pci_dev)
535{
536 pci_power_up(pci_dev);
Rafael J. Wysocki81cfa592019-11-05 11:13:43 +0100537 pci_update_current_state(pci_dev, PCI_D0);
Rafael J. Wysockidb288c92012-07-05 15:20:00 -0600538 pci_restore_state(pci_dev);
Rafael J. Wysocki0ce3fca2017-07-12 03:05:39 +0200539 pci_pme_restore(pci_dev);
Rafael J. Wysockidb288c92012-07-05 15:20:00 -0600540}
541
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200542/*
543 * Default "suspend" method for devices that have no driver provided suspend,
Rafael J. Wysockifa58d302009-01-07 13:03:42 +0100544 * or not even a driver at all (second part).
545 */
Rafael J. Wysockibb808942009-01-07 14:15:17 +0100546static void pci_pm_set_unknown_state(struct pci_dev *pci_dev)
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200547{
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200548 /*
549 * mark its power state as "unknown", since we don't know if
550 * e.g. the BIOS will change its device state when we suspend.
551 */
552 if (pci_dev->current_state == PCI_D0)
553 pci_dev->current_state = PCI_UNKNOWN;
554}
555
556/*
557 * Default "resume" method for devices that have no driver provided resume,
Rafael J. Wysocki355a72d2008-12-08 00:34:57 +0100558 * or not even a driver at all (second part).
559 */
Rafael J. Wysockibb808942009-01-07 14:15:17 +0100560static int pci_pm_reenable_device(struct pci_dev *pci_dev)
Rafael J. Wysocki355a72d2008-12-08 00:34:57 +0100561{
562 int retval;
563
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200564 /* if the device was enabled before suspend, reenable */
565 retval = pci_reenable_device(pci_dev);
566 /*
567 * if the device was busmaster before the suspend, make it busmaster
568 * again
569 */
570 if (pci_dev->is_busmaster)
571 pci_set_master(pci_dev);
572
573 return retval;
574}
575
576static int pci_legacy_suspend(struct device *dev, pm_message_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577{
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400578 struct pci_dev *pci_dev = to_pci_dev(dev);
579 struct pci_driver *drv = pci_dev->driver;
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100580
Andrew Morton02669492006-03-23 01:38:34 -0800581 if (drv && drv->suspend) {
Rafael J. Wysocki99dadce2009-02-04 01:59:09 +0100582 pci_power_t prev = pci_dev->current_state;
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100583 int error;
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +0100584
Frans Pop57ef8022009-03-16 22:39:56 +0100585 error = drv->suspend(pci_dev, state);
586 suspend_report_result(drv->suspend, error);
587 if (error)
588 return error;
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +0100589
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100590 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
Rafael J. Wysocki99dadce2009-02-04 01:59:09 +0100591 && pci_dev->current_state != PCI_UNKNOWN) {
Bjorn Helgaas12bcae42019-10-07 07:52:28 -0500592 pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev,
593 "PCI PM: Device state not saved by %pS\n",
594 drv->suspend);
Rafael J. Wysocki99dadce2009-02-04 01:59:09 +0100595 }
Andrew Morton02669492006-03-23 01:38:34 -0800596 }
Rafael J. Wysockiad8cfa12009-01-07 13:09:37 +0100597
598 pci_fixup_device(pci_fixup_suspend, pci_dev);
599
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100600 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601}
602
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200603static int pci_legacy_suspend_late(struct device *dev, pm_message_t state)
Linus Torvaldscbd69db2006-06-24 14:50:29 -0700604{
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400605 struct pci_dev *pci_dev = to_pci_dev(dev);
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100606
607 if (!pci_dev->state_saved)
608 pci_save_state(pci_dev);
609
610 pci_pm_set_unknown_state(pci_dev);
611
Andreas Noever7d2a01b2014-06-03 22:04:09 +0200612 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
613
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100614 return 0;
Linus Torvaldscbd69db2006-06-24 14:50:29 -0700615}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200617static int pci_legacy_resume(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618{
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400619 struct pci_dev *pci_dev = to_pci_dev(dev);
620 struct pci_driver *drv = pci_dev->driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621
Rafael J. Wysockiad8cfa12009-01-07 13:09:37 +0100622 pci_fixup_device(pci_fixup_resume, pci_dev);
623
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +0100624 return drv && drv->resume ?
625 drv->resume(pci_dev) : pci_pm_reenable_device(pci_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626}
627
Rafael J. Wysocki571ff752009-01-07 13:05:05 +0100628/* Auxiliary functions used by the new power management framework */
629
Rafael J. Wysocki5294e252009-02-04 02:09:07 +0100630static void pci_pm_default_suspend(struct pci_dev *pci_dev)
Rafael J. Wysocki734104292009-01-07 13:07:15 +0100631{
Rafael J. Wysocki5294e252009-02-04 02:09:07 +0100632 /* Disable non-bridge devices without PM support */
Yijing Wang326c1cd2014-05-04 12:23:36 +0800633 if (!pci_has_subordinate(pci_dev))
Rafael J. Wysockicbbc2f62009-02-04 02:01:15 +0100634 pci_disable_enabled_device(pci_dev);
Rafael J. Wysocki734104292009-01-07 13:07:15 +0100635}
636
Rafael J. Wysocki07e836e2009-01-07 13:06:10 +0100637static bool pci_has_legacy_pm_support(struct pci_dev *pci_dev)
638{
639 struct pci_driver *drv = pci_dev->driver;
Bjorn Helgaas1a1daf02019-10-31 17:37:54 -0500640 bool ret = drv && (drv->suspend || drv->resume);
Rafael J. Wysockibb808942009-01-07 14:15:17 +0100641
642 /*
643 * Legacy PM support is used by default, so warn if the new framework is
644 * supported as well. Drivers are supposed to support either the
645 * former, or the latter, but not both at the same time.
646 */
Bjorn Helgaas12bcae42019-10-07 07:52:28 -0500647 pci_WARN(pci_dev, ret && drv->driver.pm, "device %04x:%04x\n",
648 pci_dev->vendor, pci_dev->device);
Rafael J. Wysockibb808942009-01-07 14:15:17 +0100649
650 return ret;
Rafael J. Wysocki07e836e2009-01-07 13:06:10 +0100651}
652
Rafael J. Wysocki571ff752009-01-07 13:05:05 +0100653/* New power management framework */
654
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200655static int pci_pm_prepare(struct device *dev)
656{
Rafael J. Wysocki0c7376a2019-06-07 00:32:31 +0200657 struct pci_dev *pci_dev = to_pci_dev(dev);
Bjorn Helgaas6da2f2c2019-10-14 13:46:50 -0500658 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200659
Bjorn Helgaas6da2f2c2019-10-14 13:46:50 -0500660 if (pm && pm->prepare) {
661 int error = pm->prepare(dev);
Rafael J. Wysocki08810a412017-10-25 14:12:29 +0200662 if (error < 0)
Rafael J. Wysockibac2a902015-01-21 02:17:42 +0100663 return error;
Rafael J. Wysocki08810a412017-10-25 14:12:29 +0200664
665 if (!error && dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_PREPARE))
666 return 0;
Rafael J. Wysockibac2a902015-01-21 02:17:42 +0100667 }
Rafael J. Wysocki0c7376a2019-06-07 00:32:31 +0200668 if (pci_dev_need_resume(pci_dev))
669 return 0;
670
671 /*
672 * The PME setting needs to be adjusted here in case the direct-complete
673 * optimization is used with respect to this device.
674 */
675 pci_dev_adjust_pme(pci_dev);
676 return 1;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200677}
678
Rafael J. Wysocki2cef5482015-09-30 01:10:24 +0200679static void pci_pm_complete(struct device *dev)
680{
Lukas Wunnera0d2a952016-09-18 05:39:20 +0200681 struct pci_dev *pci_dev = to_pci_dev(dev);
682
683 pci_dev_complete_resume(pci_dev);
684 pm_generic_complete(dev);
685
686 /* Resume device if platform firmware has put it in reset-power-on */
Rafael J. Wysockibd755d72017-11-18 15:33:52 +0100687 if (pm_runtime_suspended(dev) && pm_resume_via_firmware()) {
Lukas Wunnera0d2a952016-09-18 05:39:20 +0200688 pci_power_t pre_sleep_state = pci_dev->current_state;
689
Rafael J. Wysockib51033e2019-06-25 14:09:12 +0200690 pci_refresh_power_state(pci_dev);
691 /*
692 * On platforms with ACPI this check may also trigger for
693 * devices sharing power resources if one of those power
694 * resources has been activated as a result of a change of the
695 * power state of another device sharing it. However, in that
696 * case it is also better to resume the device, in general.
697 */
Lukas Wunnera0d2a952016-09-18 05:39:20 +0200698 if (pci_dev->current_state < pre_sleep_state)
699 pm_request_resume(dev);
700 }
Rafael J. Wysocki2cef5482015-09-30 01:10:24 +0200701}
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200702
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +0100703#else /* !CONFIG_PM_SLEEP */
704
705#define pci_pm_prepare NULL
Rafael J. Wysocki2cef5482015-09-30 01:10:24 +0200706#define pci_pm_complete NULL
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +0100707
708#endif /* !CONFIG_PM_SLEEP */
709
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200710#ifdef CONFIG_SUSPEND
Bjorn Helgaasa39bd852018-03-09 11:06:54 -0600711static void pcie_pme_root_status_cleanup(struct pci_dev *pci_dev)
712{
713 /*
714 * Some BIOSes forget to clear Root PME Status bits after system
715 * wakeup, which breaks ACPI-based runtime wakeup on PCI Express.
716 * Clear those bits now just in case (shouldn't hurt).
717 */
718 if (pci_is_pcie(pci_dev) &&
Bjorn Helgaas3620c712018-03-09 11:06:55 -0600719 (pci_pcie_type(pci_dev) == PCI_EXP_TYPE_ROOT_PORT ||
720 pci_pcie_type(pci_dev) == PCI_EXP_TYPE_RC_EC))
Bjorn Helgaasa39bd852018-03-09 11:06:54 -0600721 pcie_clear_root_pme_status(pci_dev);
722}
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200723
724static int pci_pm_suspend(struct device *dev)
725{
726 struct pci_dev *pci_dev = to_pci_dev(dev);
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700727 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200728
Rafael J. Wysockid491f2b2019-05-17 11:08:50 +0200729 pci_dev->skip_bus_pm = false;
730
Rafael J. Wysockiad8cfa12009-01-07 13:09:37 +0100731 if (pci_has_legacy_pm_support(pci_dev))
732 return pci_legacy_suspend(dev, PMSG_SUSPEND);
Rafael J. Wysockibb808942009-01-07 14:15:17 +0100733
Rafael J. Wysocki5294e252009-02-04 02:09:07 +0100734 if (!pm) {
735 pci_pm_default_suspend(pci_dev);
Rafael J. Wysockic4b65152017-10-26 12:12:22 +0200736 return 0;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200737 }
Rafael J. Wysockifa58d302009-01-07 13:03:42 +0100738
Rafael J. Wysocki7cd06022014-02-26 01:00:30 +0100739 /*
Rafael J. Wysockic4b65152017-10-26 12:12:22 +0200740 * PCI devices suspended at run time may need to be resumed at this
741 * point, because in general it may be necessary to reconfigure them for
742 * system suspend. Namely, if the device is expected to wake up the
743 * system from the sleep state, it may have to be reconfigured for this
744 * purpose, or if the device is not expected to wake up the system from
745 * the sleep state, it should be prevented from signaling wakeup events
746 * going forward.
747 *
748 * Also if the driver of the device does not indicate that its system
749 * suspend callbacks can cope with runtime-suspended devices, it is
750 * better to resume the device from runtime suspend here.
Rafael J. Wysocki7cd06022014-02-26 01:00:30 +0100751 */
Rafael J. Wysockic4b65152017-10-26 12:12:22 +0200752 if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
Rafael J. Wysocki0c7376a2019-06-07 00:32:31 +0200753 pci_dev_need_resume(pci_dev)) {
Rafael J. Wysockic4b65152017-10-26 12:12:22 +0200754 pm_runtime_resume(dev);
Rafael J. Wysocki656088a2018-05-18 10:17:42 +0200755 pci_dev->state_saved = false;
Rafael J. Wysocki0c7376a2019-06-07 00:32:31 +0200756 } else {
757 pci_dev_adjust_pme(pci_dev);
Rafael J. Wysocki656088a2018-05-18 10:17:42 +0200758 }
Rafael J. Wysocki7cd06022014-02-26 01:00:30 +0100759
Rafael J. Wysocki5294e252009-02-04 02:09:07 +0100760 if (pm->suspend) {
761 pci_power_t prev = pci_dev->current_state;
762 int error;
763
764 error = pm->suspend(dev);
765 suspend_report_result(pm->suspend, error);
766 if (error)
767 return error;
768
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100769 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
Rafael J. Wysocki5294e252009-02-04 02:09:07 +0100770 && pci_dev->current_state != PCI_UNKNOWN) {
Bjorn Helgaas12bcae42019-10-07 07:52:28 -0500771 pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev,
772 "PCI PM: State of device not saved by %pS\n",
773 pm->suspend);
Rafael J. Wysocki5294e252009-02-04 02:09:07 +0100774 }
775 }
776
Rafael J. Wysocki5294e252009-02-04 02:09:07 +0100777 return 0;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200778}
779
Rafael J. Wysockic4b65152017-10-26 12:12:22 +0200780static int pci_pm_suspend_late(struct device *dev)
781{
Rafael J. Wysockifa2bfea2020-04-18 18:52:48 +0200782 if (dev_pm_skip_suspend(dev))
Rafael J. Wysockic4b65152017-10-26 12:12:22 +0200783 return 0;
784
785 pci_fixup_device(pci_fixup_suspend, to_pci_dev(dev));
786
787 return pm_generic_suspend_late(dev);
788}
789
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200790static int pci_pm_suspend_noirq(struct device *dev)
Greg KHc8958172005-04-08 14:53:31 +0900791{
Rafael J. Wysocki355a72d2008-12-08 00:34:57 +0100792 struct pci_dev *pci_dev = to_pci_dev(dev);
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700793 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
Greg KHc8958172005-04-08 14:53:31 +0900794
Rafael J. Wysockifa2bfea2020-04-18 18:52:48 +0200795 if (dev_pm_skip_suspend(dev))
Rafael J. Wysockic4b65152017-10-26 12:12:22 +0200796 return 0;
797
Rafael J. Wysockibb808942009-01-07 14:15:17 +0100798 if (pci_has_legacy_pm_support(pci_dev))
799 return pci_legacy_suspend_late(dev, PMSG_SUSPEND);
800
Rafael J. Wysocki931ff682009-03-16 22:40:50 +0100801 if (!pm) {
802 pci_save_state(pci_dev);
Andreas Noever7d2a01b2014-06-03 22:04:09 +0200803 goto Fixup;
Rafael J. Wysocki931ff682009-03-16 22:40:50 +0100804 }
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100805
806 if (pm->suspend_noirq) {
807 pci_power_t prev = pci_dev->current_state;
808 int error;
809
810 error = pm->suspend_noirq(dev);
811 suspend_report_result(pm->suspend_noirq, error);
812 if (error)
813 return error;
814
815 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
816 && pci_dev->current_state != PCI_UNKNOWN) {
Bjorn Helgaas12bcae42019-10-07 07:52:28 -0500817 pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev,
818 "PCI PM: State of device not saved by %pS\n",
819 pm->suspend_noirq);
Andreas Noever7d2a01b2014-06-03 22:04:09 +0200820 goto Fixup;
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100821 }
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200822 }
823
Rafael J. Wysockid491f2b2019-05-17 11:08:50 +0200824 if (pci_dev->skip_bus_pm) {
825 /*
Rafael J. Wysocki3e26c5fee2019-06-13 23:59:45 +0200826 * Either the device is a bridge with a child in D0 below it, or
827 * the function is running for the second time in a row without
Rafael J. Wysockid491f2b2019-05-17 11:08:50 +0200828 * going through full resume, which is possible only during
Rafael J. Wysocki3e26c5fee2019-06-13 23:59:45 +0200829 * suspend-to-idle in a spurious wakeup case. The device should
830 * be in D0 at this point, but if it is a bridge, it may be
831 * necessary to save its state.
Rafael J. Wysockid491f2b2019-05-17 11:08:50 +0200832 */
Rafael J. Wysocki3e26c5fee2019-06-13 23:59:45 +0200833 if (!pci_dev->state_saved)
834 pci_save_state(pci_dev);
835 } else if (!pci_dev->state_saved) {
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100836 pci_save_state(pci_dev);
Mika Westerberg9d26d3a2016-06-02 11:17:12 +0300837 if (pci_power_manageable(pci_dev))
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100838 pci_prepare_to_sleep(pci_dev);
839 }
Rafael J. Wysockid67e37d2009-01-07 13:11:28 +0100840
Bjorn Helgaas6941a0c2019-10-07 07:55:18 -0500841 pci_dbg(pci_dev, "PCI PM: Suspend power state: %s\n",
Rafael J. Wysockica67ab52017-09-30 01:31:15 +0200842 pci_power_name(pci_dev->current_state));
843
Rafael J. Wysocki3e26c5fee2019-06-13 23:59:45 +0200844 if (pci_dev->current_state == PCI_D0) {
845 pci_dev->skip_bus_pm = true;
846 /*
847 * Per PCI PM r1.2, table 6-1, a bridge must be in D0 if any
848 * downstream device is in D0, so avoid changing the power state
849 * of the parent bridge by setting the skip_bus_pm flag for it.
850 */
851 if (pci_dev->bus->self)
852 pci_dev->bus->self->skip_bus_pm = true;
853 }
854
Rafael J. Wysocki471a7392019-06-26 00:20:23 +0200855 if (pci_dev->skip_bus_pm && pm_suspend_no_platform()) {
Bjorn Helgaas6941a0c2019-10-07 07:55:18 -0500856 pci_dbg(pci_dev, "PCI PM: Skipped\n");
Rafael J. Wysocki3e26c5fee2019-06-13 23:59:45 +0200857 goto Fixup;
858 }
859
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100860 pci_pm_set_unknown_state(pci_dev);
861
Alan Sterndbf0e4c2012-07-09 11:09:21 -0400862 /*
863 * Some BIOSes from ASUS have a bug: If a USB EHCI host controller's
864 * PCI COMMAND register isn't 0, the BIOS assumes that the controller
865 * hasn't been quiesced and tries to turn it off. If the controller
866 * is already in D3, this can hang or cause memory corruption.
867 *
868 * Since the value of the COMMAND register doesn't matter once the
869 * device has been suspended, we can safely set it to 0 here.
870 */
871 if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
872 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
873
Andreas Noever7d2a01b2014-06-03 22:04:09 +0200874Fixup:
875 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
876
Rafael J. Wysockibd755d72017-11-18 15:33:52 +0100877 /*
878 * If the target system sleep state is suspend-to-idle, it is sufficient
879 * to check whether or not the device's wakeup settings are good for
880 * runtime PM. Otherwise, the pm_resume_via_firmware() check will cause
881 * pci_pm_complete() to take care of fixing up the device's state
882 * anyway, if need be.
883 */
Rafael J. Wysocki0fe8a1b2020-04-18 18:52:19 +0200884 if (device_can_wakeup(dev) && !device_may_wakeup(dev))
885 dev->power.may_skip_resume = false;
Rafael J. Wysockibd755d72017-11-18 15:33:52 +0100886
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100887 return 0;
Greg KHc8958172005-04-08 14:53:31 +0900888}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200890static int pci_pm_resume_noirq(struct device *dev)
891{
Rafael J. Wysocki355a72d2008-12-08 00:34:57 +0100892 struct pci_dev *pci_dev = to_pci_dev(dev);
Bjorn Helgaas6da2f2c2019-10-14 13:46:50 -0500893 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
Mika Westerbergad9001f2019-11-12 12:16:17 +0300894 pci_power_t prev_state = pci_dev->current_state;
895 bool skip_bus_pm = pci_dev->skip_bus_pm;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200896
Rafael J. Wysocki76c70cb2020-04-18 18:52:30 +0200897 if (dev_pm_skip_resume(dev))
Rafael J. Wysockibd755d72017-11-18 15:33:52 +0100898 return 0;
899
Rafael J. Wysockic4b65152017-10-26 12:12:22 +0200900 /*
Rafael J. Wysocki3e26c5fee2019-06-13 23:59:45 +0200901 * In the suspend-to-idle case, devices left in D0 during suspend will
902 * stay in D0, so it is not necessary to restore or update their
Rafael J. Wysocki471a7392019-06-26 00:20:23 +0200903 * configuration here and attempting to put them into D0 again is
904 * pointless, so avoid doing that.
Rafael J. Wysocki3e26c5fee2019-06-13 23:59:45 +0200905 */
Mika Westerbergad9001f2019-11-12 12:16:17 +0300906 if (!(skip_bus_pm && pm_suspend_no_platform()))
Rafael J. Wysocki3e26c5fee2019-06-13 23:59:45 +0200907 pci_pm_default_resume_early(pci_dev);
908
909 pci_fixup_device(pci_fixup_resume_early, pci_dev);
Bjorn Helgaasec6a75e2019-10-10 16:54:36 -0500910 pcie_pme_root_status_cleanup(pci_dev);
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +0100911
Mika Westerbergad9001f2019-11-12 12:16:17 +0300912 if (!skip_bus_pm && prev_state == PCI_D3cold)
913 pci_bridge_wait_for_secondary_bus(pci_dev);
914
Rafael J. Wysockiad8cfa12009-01-07 13:09:37 +0100915 if (pci_has_legacy_pm_support(pci_dev))
Bjorn Helgaas89cdbc32019-10-31 17:53:04 -0500916 return 0;
Rafael J. Wysockibb808942009-01-07 14:15:17 +0100917
Bjorn Helgaas6da2f2c2019-10-14 13:46:50 -0500918 if (pm && pm->resume_noirq)
919 return pm->resume_noirq(dev);
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200920
Bjorn Helgaas6da2f2c2019-10-14 13:46:50 -0500921 return 0;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200922}
923
Rafael J. Wysocki6e176bf2020-04-18 18:52:08 +0200924static int pci_pm_resume_early(struct device *dev)
925{
Rafael J. Wysocki76c70cb2020-04-18 18:52:30 +0200926 if (dev_pm_skip_resume(dev))
Rafael J. Wysocki6e176bf2020-04-18 18:52:08 +0200927 return 0;
928
929 return pm_generic_resume_early(dev);
930}
931
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +0100932static int pci_pm_resume(struct device *dev)
933{
934 struct pci_dev *pci_dev = to_pci_dev(dev);
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700935 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +0100936
Rafael J. Wysocki418e4da2009-01-26 21:43:08 +0100937 /*
938 * This is necessary for the suspend error path in which resume is
939 * called without restoring the standard config registers of the device.
940 */
941 if (pci_dev->state_saved)
942 pci_restore_standard_config(pci_dev);
943
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +0100944 if (pci_has_legacy_pm_support(pci_dev))
945 return pci_legacy_resume(dev);
946
Rafael J. Wysocki5294e252009-02-04 02:09:07 +0100947 pci_pm_default_resume(pci_dev);
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +0100948
Rafael J. Wysocki5294e252009-02-04 02:09:07 +0100949 if (pm) {
950 if (pm->resume)
Bjorn Helgaas6da2f2c2019-10-14 13:46:50 -0500951 return pm->resume(dev);
Rafael J. Wysocki5294e252009-02-04 02:09:07 +0100952 } else {
953 pci_pm_reenable_device(pci_dev);
954 }
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +0100955
Bjorn Helgaas6da2f2c2019-10-14 13:46:50 -0500956 return 0;
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +0100957}
958
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200959#else /* !CONFIG_SUSPEND */
960
961#define pci_pm_suspend NULL
Rafael J. Wysockic4b65152017-10-26 12:12:22 +0200962#define pci_pm_suspend_late NULL
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200963#define pci_pm_suspend_noirq NULL
964#define pci_pm_resume NULL
Rafael J. Wysocki6e176bf2020-04-18 18:52:08 +0200965#define pci_pm_resume_early NULL
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200966#define pci_pm_resume_noirq NULL
967
968#endif /* !CONFIG_SUSPEND */
969
Rafael J. Wysocki1f112ce2011-04-11 22:54:42 +0200970#ifdef CONFIG_HIBERNATE_CALLBACKS
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200971
Sebastian Ott699c1982013-08-20 16:41:02 +0200972/*
973 * pcibios_pm_ops - provide arch-specific hooks when a PCI device is doing
974 * a hibernate transition
975 */
976struct dev_pm_ops __weak pcibios_pm_ops;
977
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200978static int pci_pm_freeze(struct device *dev)
979{
980 struct pci_dev *pci_dev = to_pci_dev(dev);
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700981 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200982
Rafael J. Wysockiad8cfa12009-01-07 13:09:37 +0100983 if (pci_has_legacy_pm_support(pci_dev))
984 return pci_legacy_suspend(dev, PMSG_FREEZE);
Rafael J. Wysockibb808942009-01-07 14:15:17 +0100985
Rafael J. Wysocki5294e252009-02-04 02:09:07 +0100986 if (!pm) {
987 pci_pm_default_suspend(pci_dev);
988 return 0;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200989 }
990
Rafael J. Wysocki7cd06022014-02-26 01:00:30 +0100991 /*
Rafael J. Wysocki501debd2019-07-01 12:44:25 +0200992 * Resume all runtime-suspended devices before creating a snapshot
993 * image of system memory, because the restore kernel generally cannot
994 * be expected to always handle them consistently and they need to be
995 * put into the runtime-active metastate during system resume anyway,
996 * so it is better to ensure that the state saved in the image will be
997 * always consistent with that.
Rafael J. Wysocki7cd06022014-02-26 01:00:30 +0100998 */
Rafael J. Wysocki501debd2019-07-01 12:44:25 +0200999 pm_runtime_resume(dev);
1000 pci_dev->state_saved = false;
Rafael J. Wysocki7cd06022014-02-26 01:00:30 +01001001
Rafael J. Wysocki5294e252009-02-04 02:09:07 +01001002 if (pm->freeze) {
1003 int error;
1004
1005 error = pm->freeze(dev);
1006 suspend_report_result(pm->freeze, error);
1007 if (error)
1008 return error;
1009 }
1010
Rafael J. Wysocki5294e252009-02-04 02:09:07 +01001011 return 0;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001012}
1013
1014static int pci_pm_freeze_noirq(struct device *dev)
1015{
Rafael J. Wysocki355a72d2008-12-08 00:34:57 +01001016 struct pci_dev *pci_dev = to_pci_dev(dev);
Bjorn Helgaas6da2f2c2019-10-14 13:46:50 -05001017 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001018
Rafael J. Wysockibb808942009-01-07 14:15:17 +01001019 if (pci_has_legacy_pm_support(pci_dev))
1020 return pci_legacy_suspend_late(dev, PMSG_FREEZE);
1021
Bjorn Helgaas6da2f2c2019-10-14 13:46:50 -05001022 if (pm && pm->freeze_noirq) {
Rafael J. Wysocki46939f82009-03-16 22:40:26 +01001023 int error;
1024
Bjorn Helgaas6da2f2c2019-10-14 13:46:50 -05001025 error = pm->freeze_noirq(dev);
1026 suspend_report_result(pm->freeze_noirq, error);
Rafael J. Wysocki46939f82009-03-16 22:40:26 +01001027 if (error)
1028 return error;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001029 }
1030
Rafael J. Wysocki46939f82009-03-16 22:40:26 +01001031 if (!pci_dev->state_saved)
1032 pci_save_state(pci_dev);
Rafael J. Wysockid67e37d2009-01-07 13:11:28 +01001033
Rafael J. Wysocki46939f82009-03-16 22:40:26 +01001034 pci_pm_set_unknown_state(pci_dev);
1035
Sebastian Ott699c1982013-08-20 16:41:02 +02001036 if (pcibios_pm_ops.freeze_noirq)
1037 return pcibios_pm_ops.freeze_noirq(dev);
1038
Rafael J. Wysocki46939f82009-03-16 22:40:26 +01001039 return 0;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001040}
1041
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001042static int pci_pm_thaw_noirq(struct device *dev)
1043{
Rafael J. Wysocki355a72d2008-12-08 00:34:57 +01001044 struct pci_dev *pci_dev = to_pci_dev(dev);
Bjorn Helgaas6da2f2c2019-10-14 13:46:50 -05001045 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1046 int error;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001047
Sebastian Ott699c1982013-08-20 16:41:02 +02001048 if (pcibios_pm_ops.thaw_noirq) {
1049 error = pcibios_pm_ops.thaw_noirq(dev);
1050 if (error)
1051 return error;
1052 }
1053
Rafael J. Wysocki5839ee72017-12-15 03:07:18 +01001054 /*
Bjorn Helgaas89cdbc32019-10-31 17:53:04 -05001055 * The pm->thaw_noirq() callback assumes the device has been
1056 * returned to D0 and its config state has been restored.
Dexuan Cuif2c33cc2019-08-14 01:06:55 +00001057 *
1058 * In addition, pci_restore_state() restores MSI-X state in MMIO
1059 * space, which requires the device to be in D0, so return it to D0
1060 * in case the driver's "freeze" callbacks put it into a low-power
1061 * state.
Rafael J. Wysocki5839ee72017-12-15 03:07:18 +01001062 */
1063 pci_set_power_state(pci_dev, PCI_D0);
Chen Yue60514b2017-05-25 16:49:07 +08001064 pci_restore_state(pci_dev);
Rafael J. Wysockid67e37d2009-01-07 13:11:28 +01001065
Dexuan Cuif2c33cc2019-08-14 01:06:55 +00001066 if (pci_has_legacy_pm_support(pci_dev))
Bjorn Helgaas89cdbc32019-10-31 17:53:04 -05001067 return 0;
Dexuan Cuif2c33cc2019-08-14 01:06:55 +00001068
Bjorn Helgaas6da2f2c2019-10-14 13:46:50 -05001069 if (pm && pm->thaw_noirq)
1070 return pm->thaw_noirq(dev);
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001071
Bjorn Helgaas6da2f2c2019-10-14 13:46:50 -05001072 return 0;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001073}
1074
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +01001075static int pci_pm_thaw(struct device *dev)
1076{
1077 struct pci_dev *pci_dev = to_pci_dev(dev);
Dmitry Torokhov8150f322009-07-24 22:11:32 -07001078 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +01001079 int error = 0;
1080
1081 if (pci_has_legacy_pm_support(pci_dev))
1082 return pci_legacy_resume(dev);
1083
Rafael J. Wysocki5294e252009-02-04 02:09:07 +01001084 if (pm) {
1085 if (pm->thaw)
1086 error = pm->thaw(dev);
1087 } else {
1088 pci_pm_reenable_device(pci_dev);
1089 }
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +01001090
Rafael J. Wysocki4b77b0a2009-09-09 23:49:59 +02001091 pci_dev->state_saved = false;
1092
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +01001093 return error;
1094}
1095
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001096static int pci_pm_poweroff(struct device *dev)
1097{
Rafael J. Wysocki355a72d2008-12-08 00:34:57 +01001098 struct pci_dev *pci_dev = to_pci_dev(dev);
Dmitry Torokhov8150f322009-07-24 22:11:32 -07001099 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001100
Rafael J. Wysockiad8cfa12009-01-07 13:09:37 +01001101 if (pci_has_legacy_pm_support(pci_dev))
1102 return pci_legacy_suspend(dev, PMSG_HIBERNATE);
Rafael J. Wysockibb808942009-01-07 14:15:17 +01001103
Rafael J. Wysocki5294e252009-02-04 02:09:07 +01001104 if (!pm) {
1105 pci_pm_default_suspend(pci_dev);
Rafael J. Wysockic4b65152017-10-26 12:12:22 +02001106 return 0;
Rafael J. Wysocki5294e252009-02-04 02:09:07 +01001107 }
1108
Rafael J. Wysocki7cd06022014-02-26 01:00:30 +01001109 /* The reason to do that is the same as in pci_pm_suspend(). */
Rafael J. Wysockic4b65152017-10-26 12:12:22 +02001110 if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
Rafael J. Wysocki0c7376a2019-06-07 00:32:31 +02001111 pci_dev_need_resume(pci_dev)) {
Rafael J. Wysockic4b65152017-10-26 12:12:22 +02001112 pm_runtime_resume(dev);
Rafael J. Wysocki0c7376a2019-06-07 00:32:31 +02001113 pci_dev->state_saved = false;
1114 } else {
1115 pci_dev_adjust_pme(pci_dev);
1116 }
Rafael J. Wysocki7cd06022014-02-26 01:00:30 +01001117
Rafael J. Wysocki5294e252009-02-04 02:09:07 +01001118 if (pm->poweroff) {
Rafael J. Wysocki46939f82009-03-16 22:40:26 +01001119 int error;
1120
Rafael J. Wysockiddb7c9d2009-02-04 01:56:14 +01001121 error = pm->poweroff(dev);
1122 suspend_report_result(pm->poweroff, error);
Rafael J. Wysocki46939f82009-03-16 22:40:26 +01001123 if (error)
1124 return error;
1125 }
1126
Rafael J. Wysocki46939f82009-03-16 22:40:26 +01001127 return 0;
1128}
1129
Rafael J. Wysockic4b65152017-10-26 12:12:22 +02001130static int pci_pm_poweroff_late(struct device *dev)
1131{
Rafael J. Wysockifa2bfea2020-04-18 18:52:48 +02001132 if (dev_pm_skip_suspend(dev))
Rafael J. Wysockic4b65152017-10-26 12:12:22 +02001133 return 0;
1134
1135 pci_fixup_device(pci_fixup_suspend, to_pci_dev(dev));
1136
1137 return pm_generic_poweroff_late(dev);
1138}
1139
Rafael J. Wysocki46939f82009-03-16 22:40:26 +01001140static int pci_pm_poweroff_noirq(struct device *dev)
1141{
1142 struct pci_dev *pci_dev = to_pci_dev(dev);
Bjorn Helgaas6da2f2c2019-10-14 13:46:50 -05001143 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
Rafael J. Wysocki46939f82009-03-16 22:40:26 +01001144
Rafael J. Wysockifa2bfea2020-04-18 18:52:48 +02001145 if (dev_pm_skip_suspend(dev))
Rafael J. Wysockic4b65152017-10-26 12:12:22 +02001146 return 0;
1147
Bjorn Helgaas6da2f2c2019-10-14 13:46:50 -05001148 if (pci_has_legacy_pm_support(pci_dev))
Rafael J. Wysocki46939f82009-03-16 22:40:26 +01001149 return pci_legacy_suspend_late(dev, PMSG_HIBERNATE);
1150
Bjorn Helgaas6da2f2c2019-10-14 13:46:50 -05001151 if (!pm) {
Andreas Noever7d2a01b2014-06-03 22:04:09 +02001152 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
Rafael J. Wysocki46939f82009-03-16 22:40:26 +01001153 return 0;
Andreas Noever7d2a01b2014-06-03 22:04:09 +02001154 }
Rafael J. Wysocki46939f82009-03-16 22:40:26 +01001155
Bjorn Helgaas6da2f2c2019-10-14 13:46:50 -05001156 if (pm->poweroff_noirq) {
Rafael J. Wysocki46939f82009-03-16 22:40:26 +01001157 int error;
1158
Bjorn Helgaas6da2f2c2019-10-14 13:46:50 -05001159 error = pm->poweroff_noirq(dev);
1160 suspend_report_result(pm->poweroff_noirq, error);
Rafael J. Wysocki46939f82009-03-16 22:40:26 +01001161 if (error)
1162 return error;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001163 }
1164
Yijing Wang326c1cd2014-05-04 12:23:36 +08001165 if (!pci_dev->state_saved && !pci_has_subordinate(pci_dev))
Rafael J. Wysocki5294e252009-02-04 02:09:07 +01001166 pci_prepare_to_sleep(pci_dev);
1167
Rafael J. Wysocki0b68c8e2012-08-12 23:26:07 +02001168 /*
1169 * The reason for doing this here is the same as for the analogous code
1170 * in pci_pm_suspend_noirq().
1171 */
1172 if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
1173 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
1174
Andreas Noever7d2a01b2014-06-03 22:04:09 +02001175 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1176
Sebastian Ott699c1982013-08-20 16:41:02 +02001177 if (pcibios_pm_ops.poweroff_noirq)
1178 return pcibios_pm_ops.poweroff_noirq(dev);
1179
Rafael J. Wysocki46939f82009-03-16 22:40:26 +01001180 return 0;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001181}
1182
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001183static int pci_pm_restore_noirq(struct device *dev)
1184{
1185 struct pci_dev *pci_dev = to_pci_dev(dev);
Bjorn Helgaas6da2f2c2019-10-14 13:46:50 -05001186 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1187 int error;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001188
Sebastian Ott699c1982013-08-20 16:41:02 +02001189 if (pcibios_pm_ops.restore_noirq) {
1190 error = pcibios_pm_ops.restore_noirq(dev);
1191 if (error)
1192 return error;
1193 }
1194
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001195 pci_pm_default_resume_early(pci_dev);
Rafael J. Wysocki3e26c5fee2019-06-13 23:59:45 +02001196 pci_fixup_device(pci_fixup_resume_early, pci_dev);
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +01001197
Rafael J. Wysockiad8cfa12009-01-07 13:09:37 +01001198 if (pci_has_legacy_pm_support(pci_dev))
Bjorn Helgaas89cdbc32019-10-31 17:53:04 -05001199 return 0;
Rafael J. Wysockibb808942009-01-07 14:15:17 +01001200
Bjorn Helgaas6da2f2c2019-10-14 13:46:50 -05001201 if (pm && pm->restore_noirq)
1202 return pm->restore_noirq(dev);
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001203
Bjorn Helgaas6da2f2c2019-10-14 13:46:50 -05001204 return 0;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001205}
1206
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +01001207static int pci_pm_restore(struct device *dev)
1208{
1209 struct pci_dev *pci_dev = to_pci_dev(dev);
Dmitry Torokhov8150f322009-07-24 22:11:32 -07001210 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +01001211
Rafael J. Wysocki418e4da2009-01-26 21:43:08 +01001212 /*
1213 * This is necessary for the hibernation error path in which restore is
1214 * called without restoring the standard config registers of the device.
1215 */
1216 if (pci_dev->state_saved)
1217 pci_restore_standard_config(pci_dev);
1218
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +01001219 if (pci_has_legacy_pm_support(pci_dev))
1220 return pci_legacy_resume(dev);
1221
Rafael J. Wysocki5294e252009-02-04 02:09:07 +01001222 pci_pm_default_resume(pci_dev);
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +01001223
Rafael J. Wysocki5294e252009-02-04 02:09:07 +01001224 if (pm) {
1225 if (pm->restore)
Bjorn Helgaas6da2f2c2019-10-14 13:46:50 -05001226 return pm->restore(dev);
Rafael J. Wysocki5294e252009-02-04 02:09:07 +01001227 } else {
1228 pci_pm_reenable_device(pci_dev);
1229 }
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +01001230
Bjorn Helgaas6da2f2c2019-10-14 13:46:50 -05001231 return 0;
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +01001232}
1233
Rafael J. Wysocki1f112ce2011-04-11 22:54:42 +02001234#else /* !CONFIG_HIBERNATE_CALLBACKS */
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001235
1236#define pci_pm_freeze NULL
1237#define pci_pm_freeze_noirq NULL
1238#define pci_pm_thaw NULL
1239#define pci_pm_thaw_noirq NULL
1240#define pci_pm_poweroff NULL
Rafael J. Wysockic4b65152017-10-26 12:12:22 +02001241#define pci_pm_poweroff_late NULL
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001242#define pci_pm_poweroff_noirq NULL
1243#define pci_pm_restore NULL
1244#define pci_pm_restore_noirq NULL
1245
Rafael J. Wysocki1f112ce2011-04-11 22:54:42 +02001246#endif /* !CONFIG_HIBERNATE_CALLBACKS */
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001247
Rafael J. Wysockifbb988b2014-11-27 23:16:57 +01001248#ifdef CONFIG_PM
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001249
1250static int pci_pm_runtime_suspend(struct device *dev)
1251{
1252 struct pci_dev *pci_dev = to_pci_dev(dev);
1253 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1254 pci_power_t prev = pci_dev->current_state;
1255 int error;
1256
Huang Ying967577b2012-11-20 16:08:22 +08001257 /*
Rafael J. Wysocki5775b842018-03-03 10:53:24 +01001258 * If pci_dev->driver is not set (unbound), we leave the device in D0,
1259 * but it may go to D3cold when the bridge above it runtime suspends.
1260 * Save its config space in case that happens.
Huang Ying967577b2012-11-20 16:08:22 +08001261 */
Rafael J. Wysocki5775b842018-03-03 10:53:24 +01001262 if (!pci_dev->driver) {
1263 pci_save_state(pci_dev);
Huang Ying967577b2012-11-20 16:08:22 +08001264 return 0;
Rafael J. Wysocki5775b842018-03-03 10:53:24 +01001265 }
Huang Ying967577b2012-11-20 16:08:22 +08001266
Rafael J. Wysocki82fee4d2013-02-04 15:56:05 +04001267 pci_dev->state_saved = false;
Jarkko Nikulac5eb1192018-10-23 14:45:52 +03001268 if (pm && pm->runtime_suspend) {
1269 error = pm->runtime_suspend(dev);
Imre Deak06bf4032015-11-30 21:02:55 +02001270 /*
1271 * -EBUSY and -EAGAIN is used to request the runtime PM core
1272 * to schedule a new suspend, so log the event only with debug
1273 * log level.
1274 */
Jarkko Nikulac5eb1192018-10-23 14:45:52 +03001275 if (error == -EBUSY || error == -EAGAIN) {
Bjorn Helgaas6941a0c2019-10-07 07:55:18 -05001276 pci_dbg(pci_dev, "can't suspend now (%ps returned %d)\n",
Imre Deak06bf4032015-11-30 21:02:55 +02001277 pm->runtime_suspend, error);
Jarkko Nikulac5eb1192018-10-23 14:45:52 +03001278 return error;
1279 } else if (error) {
Bjorn Helgaas6941a0c2019-10-07 07:55:18 -05001280 pci_err(pci_dev, "can't suspend (%ps returned %d)\n",
Imre Deak06bf4032015-11-30 21:02:55 +02001281 pm->runtime_suspend, error);
Jarkko Nikulac5eb1192018-10-23 14:45:52 +03001282 return error;
1283 }
Imre Deak06bf4032015-11-30 21:02:55 +02001284 }
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001285
1286 pci_fixup_device(pci_fixup_suspend, pci_dev);
1287
Jarkko Nikulac5eb1192018-10-23 14:45:52 +03001288 if (pm && pm->runtime_suspend
1289 && !pci_dev->state_saved && pci_dev->current_state != PCI_D0
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001290 && pci_dev->current_state != PCI_UNKNOWN) {
Bjorn Helgaas12bcae42019-10-07 07:52:28 -05001291 pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev,
1292 "PCI PM: State of device not saved by %pS\n",
1293 pm->runtime_suspend);
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001294 return 0;
1295 }
1296
Dave Airlie42eca232012-10-29 17:26:54 -06001297 if (!pci_dev->state_saved) {
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001298 pci_save_state(pci_dev);
Dave Airlie42eca232012-10-29 17:26:54 -06001299 pci_finish_runtime_suspend(pci_dev);
1300 }
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001301
1302 return 0;
1303}
1304
1305static int pci_pm_runtime_resume(struct device *dev)
1306{
1307 struct pci_dev *pci_dev = to_pci_dev(dev);
1308 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
Mika Westerbergad9001f2019-11-12 12:16:17 +03001309 pci_power_t prev_state = pci_dev->current_state;
Bjorn Helgaas6da2f2c2019-10-14 13:46:50 -05001310 int error = 0;
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001311
Huang Ying967577b2012-11-20 16:08:22 +08001312 /*
Rafael J. Wysocki5775b842018-03-03 10:53:24 +01001313 * Restoring config space is necessary even if the device is not bound
1314 * to a driver because although we left it in D0, it may have gone to
1315 * D3cold when the bridge above it runtime suspended.
Huang Ying967577b2012-11-20 16:08:22 +08001316 */
Rafael J. Wysocki5775b842018-03-03 10:53:24 +01001317 pci_restore_standard_config(pci_dev);
1318
Huang Ying967577b2012-11-20 16:08:22 +08001319 if (!pci_dev->driver)
1320 return 0;
1321
Rafael J. Wysockidb288c92012-07-05 15:20:00 -06001322 pci_fixup_device(pci_fixup_resume_early, pci_dev);
Bjorn Helgaasf7b32a82019-10-12 17:15:57 -05001323 pci_pm_default_resume(pci_dev);
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001324
Mika Westerbergad9001f2019-11-12 12:16:17 +03001325 if (prev_state == PCI_D3cold)
1326 pci_bridge_wait_for_secondary_bus(pci_dev);
1327
Jarkko Nikulac5eb1192018-10-23 14:45:52 +03001328 if (pm && pm->runtime_resume)
Bjorn Helgaas6da2f2c2019-10-14 13:46:50 -05001329 error = pm->runtime_resume(dev);
Huang Ying448bd852012-06-23 10:23:51 +08001330
1331 pci_dev->runtime_d3cold = false;
1332
Bjorn Helgaas6da2f2c2019-10-14 13:46:50 -05001333 return error;
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001334}
1335
1336static int pci_pm_runtime_idle(struct device *dev)
1337{
Huang Ying967577b2012-11-20 16:08:22 +08001338 struct pci_dev *pci_dev = to_pci_dev(dev);
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001339 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1340
Huang Ying967577b2012-11-20 16:08:22 +08001341 /*
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)
Rafael J. Wysocki45f0a852013-06-03 21:49:52 +02001346 return 0;
Huang Ying967577b2012-11-20 16:08:22 +08001347
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001348 if (!pm)
1349 return -ENOSYS;
1350
Rafael J. Wysocki45f0a852013-06-03 21:49:52 +02001351 if (pm->runtime_idle)
Bjorn Helgaas6da2f2c2019-10-14 13:46:50 -05001352 return pm->runtime_idle(dev);
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001353
Bjorn Helgaas6da2f2c2019-10-14 13:46:50 -05001354 return 0;
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001355}
1356
Sachin Kamatf91da042013-10-04 12:04:44 -06001357static const struct dev_pm_ops pci_dev_pm_ops = {
Rafael J. Wysockiadf09492008-10-06 22:46:05 +02001358 .prepare = pci_pm_prepare,
Rafael J. Wysocki2cef5482015-09-30 01:10:24 +02001359 .complete = pci_pm_complete,
Rafael J. Wysockiadf09492008-10-06 22:46:05 +02001360 .suspend = pci_pm_suspend,
Rafael J. Wysockic4b65152017-10-26 12:12:22 +02001361 .suspend_late = pci_pm_suspend_late,
Rafael J. Wysockiadf09492008-10-06 22:46:05 +02001362 .resume = pci_pm_resume,
Rafael J. Wysocki6e176bf2020-04-18 18:52:08 +02001363 .resume_early = pci_pm_resume_early,
Rafael J. Wysockiadf09492008-10-06 22:46:05 +02001364 .freeze = pci_pm_freeze,
1365 .thaw = pci_pm_thaw,
1366 .poweroff = pci_pm_poweroff,
Rafael J. Wysockic4b65152017-10-26 12:12:22 +02001367 .poweroff_late = pci_pm_poweroff_late,
Rafael J. Wysockiadf09492008-10-06 22:46:05 +02001368 .restore = pci_pm_restore,
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001369 .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,
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001375 .runtime_suspend = pci_pm_runtime_suspend,
1376 .runtime_resume = pci_pm_runtime_resume,
1377 .runtime_idle = pci_pm_runtime_idle,
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001378};
1379
Rafael J. Wysockiadf09492008-10-06 22:46:05 +02001380#define PCI_PM_OPS_PTR (&pci_dev_pm_ops)
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001381
Rafael J. Wysockifbb988b2014-11-27 23:16:57 +01001382#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
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001387
1388#define PCI_PM_OPS_PTR NULL
1389
Rafael J. Wysockifbb988b2014-11-27 23:16:57 +01001390#endif /* !CONFIG_PM */
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001391
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392/**
Laurent riffard863b18f2005-10-27 23:12:54 +02001393 * __pci_register_driver - register a new pci driver
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394 * @drv: the driver structure to register
Laurent riffard863b18f2005-10-27 23:12:54 +02001395 * @owner: owner module of drv
Randy Dunlapf95d8822007-02-10 14:41:56 -08001396 * @mod_name: module name string
Bjorn Helgaasf7625982013-11-14 11:28:18 -07001397 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398 * Adds the driver structure to the list of registered drivers.
Bjorn Helgaasf7625982013-11-14 11:28:18 -07001399 * Returns a negative value on error, otherwise 0.
1400 * If no error occurred, the driver remains registered even if
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401 * no device was claimed during registration.
1402 */
Greg Kroah-Hartman725522b2007-01-15 11:50:02 -08001403int __pci_register_driver(struct pci_driver *drv, struct module *owner,
1404 const char *mod_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406 /* initialize common driver fields */
1407 drv->driver.name = drv->name;
1408 drv->driver.bus = &pci_bus_type;
Laurent riffard863b18f2005-10-27 23:12:54 +02001409 drv->driver.owner = owner;
Greg Kroah-Hartman725522b2007-01-15 11:50:02 -08001410 drv->driver.mod_name = mod_name;
Greg Kroah-Hartman92d50fc2017-07-19 15:01:06 +02001411 drv->driver.groups = drv->groups;
Alan Cox50b00752006-08-16 17:42:18 +01001412
Greg Kroah-Hartman75865852005-06-30 02:18:12 -07001413 spin_lock_init(&drv->dynids.lock);
1414 INIT_LIST_HEAD(&drv->dynids.list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415
1416 /* register with core */
Konstantin Khlebnikovbfb09a82012-08-08 14:47:51 +04001417 return driver_register(&drv->driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001419EXPORT_SYMBOL(__pci_register_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420
1421/**
1422 * pci_unregister_driver - unregister a pci driver
1423 * @drv: the driver structure to unregister
Bjorn Helgaasf7625982013-11-14 11:28:18 -07001424 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425 * 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
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04001431void pci_unregister_driver(struct pci_driver *drv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432{
1433 driver_unregister(&drv->driver);
1434 pci_free_dynids(drv);
1435}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001436EXPORT_SYMBOL(pci_unregister_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437
1438static 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 *
Bjorn Helgaasf7625982013-11-14 11:28:18 -07001446 * Returns the appropriate pci_driver structure or %NULL if there is no
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447 * registered driver for the device.
1448 */
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04001449struct pci_driver *pci_dev_driver(const struct pci_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450{
1451 if (dev->driver)
1452 return dev->driver;
1453 else {
1454 int i;
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04001455 for (i = 0; i <= PCI_ROM_RESOURCE; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456 if (dev->resource[i].flags & IORESOURCE_BUSY)
1457 return &pci_compat_driver;
1458 }
1459 return NULL;
1460}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001461EXPORT_SYMBOL(pci_dev_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462
1463/**
1464 * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465 * @dev: the PCI device structure to match against
Randy Dunlap8f7020d2005-10-23 11:57:38 -07001466 * @drv: the device driver to search for matching PCI device id structures
Bjorn Helgaasf7625982013-11-14 11:28:18 -07001467 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468 * Used by a driver to check whether a PCI device present in the
Randy Dunlap8f7020d2005-10-23 11:57:38 -07001469 * system is in its list of supported devices. Returns the matching
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470 * pci_device_id structure or %NULL if there is no match.
1471 */
Greg Kroah-Hartman75865852005-06-30 02:18:12 -07001472static int pci_bus_match(struct device *dev, struct device_driver *drv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473{
Greg Kroah-Hartman75865852005-06-30 02:18:12 -07001474 struct pci_dev *pci_dev = to_pci_dev(dev);
Yinghai Lu58d9a382013-01-21 13:20:51 -08001475 struct pci_driver *pci_drv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476 const struct pci_device_id *found_id;
1477
Yinghai Lu58d9a382013-01-21 13:20:51 -08001478 if (!pci_dev->match_driver)
1479 return 0;
1480
1481 pci_drv = to_pci_driver(drv);
Greg Kroah-Hartman75865852005-06-30 02:18:12 -07001482 found_id = pci_match_device(pci_drv, pci_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483 if (found_id)
1484 return 1;
1485
Greg Kroah-Hartman75865852005-06-30 02:18:12 -07001486 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001487}
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 */
1501struct pci_dev *pci_dev_get(struct pci_dev *dev)
1502{
1503 if (dev)
1504 get_device(&dev->dev);
1505 return dev;
1506}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001507EXPORT_SYMBOL(pci_dev_get);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508
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 */
1516void pci_dev_put(struct pci_dev *dev)
1517{
1518 if (dev)
1519 put_device(&dev->dev);
1520}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001521EXPORT_SYMBOL(pci_dev_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522
Bill Pemberton8ccc9aa2012-11-21 15:34:58 -05001523static 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);
Bill Pemberton8ccc9aa2012-11-21 15:34:58 -05001531
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
Ricardo Ribalda Delgado145b3fe2014-12-02 17:35:04 +01001545 if (add_uevent_var(env, "MODALIAS=pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02X",
Bill Pemberton8ccc9aa2012-11-21 15:34:58 -05001546 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;
Bjorn Helgaasefdd4072014-04-05 15:08:22 -06001551
Bill Pemberton8ccc9aa2012-11-21 15:34:58 -05001552 return 0;
1553}
1554
Oza Pawandeep2e28bc82018-05-17 16:44:15 -05001555#if defined(CONFIG_PCIEPORTBUS) || defined(CONFIG_EEH)
Michael Ellerman3ecac022018-02-08 23:20:35 +11001556/**
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 */
1561void 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
Phil Sutter02e0bea2017-01-18 14:04:38 +01001591static int pci_bus_num_vf(struct device *dev)
1592{
1593 return pci_num_vf(to_pci_dev(dev));
1594}
1595
Nipun Gupta07397df2018-04-28 08:21:58 +05301596/**
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 */
1603static 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) {
Christoph Hellwig3d6ce862018-05-03 16:25:08 +02001612 ret = of_dma_configure(dev, bridge->parent->of_node, true);
Nipun Gupta07397df2018-04-28 08:21:58 +05301613 } else if (has_acpi_companion(bridge)) {
1614 struct acpi_device *adev = to_acpi_device_node(bridge->fwnode);
Nipun Gupta07397df2018-04-28 08:21:58 +05301615
Robin Murphye5361ca2018-12-06 13:20:49 -08001616 ret = acpi_dma_configure(dev, acpi_get_dma_attr(adev));
Nipun Gupta07397df2018-04-28 08:21:58 +05301617 }
1618
1619 pci_put_host_bridge_device(bridge);
1620 return ret;
1621}
1622
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623struct bus_type pci_bus_type = {
1624 .name = "pci",
1625 .match = pci_bus_match,
Kay Sievers312c0042005-11-16 09:00:00 +01001626 .uevent = pci_uevent,
Russell Kingb15d6862006-01-05 14:30:22 +00001627 .probe = pci_device_probe,
1628 .remove = pci_device_remove,
Linus Torvaldscbd69db2006-06-24 14:50:29 -07001629 .shutdown = pci_device_shutdown,
Greg Kroah-Hartman5136b2d2013-10-06 23:55:40 -07001630 .dev_groups = pci_dev_groups,
Greg Kroah-Hartman0f49ba52013-10-07 14:51:02 -06001631 .bus_groups = pci_bus_groups,
Greg Kroah-Hartman2229c1f2013-10-07 14:51:20 -06001632 .drv_groups = pci_drv_groups,
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001633 .pm = PCI_PM_OPS_PTR,
Phil Sutter02e0bea2017-01-18 14:04:38 +01001634 .num_vf = pci_bus_num_vf,
Nipun Gupta07397df2018-04-28 08:21:58 +05301635 .dma_configure = pci_dma_configure,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636};
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001637EXPORT_SYMBOL(pci_bus_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638
Bjorn Helgaasc6c889d2018-03-09 11:06:56 -06001639#ifdef CONFIG_PCIEPORTBUS
1640static 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
1661struct bus_type pcie_port_bus_type = {
1662 .name = "pci_express",
1663 .match = pcie_port_bus_match,
1664};
1665EXPORT_SYMBOL_GPL(pcie_port_bus_type);
1666#endif
1667
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668static int __init pci_driver_init(void)
1669{
Bjorn Helgaasc6c889d2018-03-09 11:06:56 -06001670 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
Christoph Hellwiga8651192018-07-30 09:38:42 +02001681 dma_debug_add_bus(&pci_bus_type);
Bjorn Helgaasc6c889d2018-03-09 11:06:56 -06001682 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001684postcore_initcall(pci_driver_init);