blob: 2b3c89425bb5d03296ceb7d5fa71213fdf5f8025 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * drivers/pci/pci-driver.c
3 *
Greg Kroah-Hartman2b937302007-11-28 12:23:18 -08004 * (C) Copyright 2002-2004, 2007 Greg Kroah-Hartman <greg@kroah.com>
5 * (C) Copyright 2007 Novell Inc.
6 *
7 * Released under the GPL v2 only.
8 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 */
10
11#include <linux/pci.h>
12#include <linux/module.h>
13#include <linux/init.h>
14#include <linux/device.h>
Andi Kleend42c6992005-07-06 19:56:03 +020015#include <linux/mempolicy.h>
Tim Schmielau4e57b682005-10-30 15:03:48 -080016#include <linux/string.h>
17#include <linux/slab.h>
Tim Schmielau8c65b4a2005-11-07 00:59:43 -080018#include <linux/sched.h>
Rusty Russell873392c2008-12-31 23:54:56 +103019#include <linux/cpu.h>
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +010020#include <linux/pm_runtime.h>
Rafael J. Wysockieea3fc032011-07-06 10:51:40 +020021#include <linux/suspend.h>
Khalid Aziz4fc9bbf2013-11-27 15:19:25 -070022#include <linux/kexec.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#include "pci.h"
24
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 */
Ryan Desfosses3c78bc62014-04-18 20:13:49 -040099static ssize_t store_new_id(struct device_driver *driver, const char *buf,
100 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;
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400104 __u32 vendor, device, subvendor = PCI_ANY_ID,
105 subdevice = PCI_ANY_ID, class = 0, class_mask = 0;
106 unsigned long driver_data = 0;
107 int fields = 0;
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-Hartman2229c1f2013-10-07 14:51:20 -0600157static DRIVER_ATTR(new_id, S_IWUSR, NULL, store_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 */
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400167static ssize_t store_remove_id(struct device_driver *driver, const char *buf,
168 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);
172 __u32 vendor, device, subvendor = PCI_ANY_ID,
173 subdevice = PCI_ANY_ID, class = 0, class_mask = 0;
174 int fields = 0;
175 int retval = -ENODEV;
176
177 fields = sscanf(buf, "%x %x %x %x %x %x",
178 &vendor, &device, &subvendor, &subdevice,
179 &class, &class_mask);
180 if (fields < 2)
181 return -EINVAL;
182
183 spin_lock(&pdrv->dynids.lock);
184 list_for_each_entry_safe(dynid, n, &pdrv->dynids.list, node) {
185 struct pci_device_id *id = &dynid->id;
186 if ((id->vendor == vendor) &&
187 (id->device == device) &&
188 (subvendor == PCI_ANY_ID || id->subvendor == subvendor) &&
189 (subdevice == PCI_ANY_ID || id->subdevice == subdevice) &&
190 !((id->class ^ class) & class_mask)) {
191 list_del(&dynid->node);
192 kfree(dynid);
193 retval = 0;
194 break;
195 }
196 }
197 spin_unlock(&pdrv->dynids.lock);
198
199 if (retval)
200 return retval;
201 return count;
202}
Greg Kroah-Hartman2229c1f2013-10-07 14:51:20 -0600203static DRIVER_ATTR(remove_id, S_IWUSR, NULL, store_remove_id);
Chris Wright09943752009-02-23 21:52:23 -0800204
Greg Kroah-Hartman2229c1f2013-10-07 14:51:20 -0600205static struct attribute *pci_drv_attrs[] = {
206 &driver_attr_new_id.attr,
207 &driver_attr_remove_id.attr,
208 NULL,
Konstantin Khlebnikovbfb09a82012-08-08 14:47:51 +0400209};
Greg Kroah-Hartman2229c1f2013-10-07 14:51:20 -0600210ATTRIBUTE_GROUPS(pci_drv);
Alan Sterned283e92012-01-24 14:35:13 -0500211
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212/**
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700213 * pci_match_id - See if a pci device matches a given pci_id table
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 * @ids: array of PCI device id structures to search in
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700215 * @dev: the PCI device structure to match against.
216 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217 * Used by a driver to check whether a PCI device present in the
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700218 * system is in its list of supported devices. Returns the matching
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 * pci_device_id structure or %NULL if there is no match.
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700220 *
Randy Dunlap8b607562007-05-09 07:19:14 +0200221 * Deprecated, don't use this as it will not catch any dynamic ids
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700222 * that a driver might want to check for.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 */
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700224const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
225 struct pci_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226{
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700227 if (ids) {
228 while (ids->vendor || ids->subvendor || ids->class_mask) {
229 if (pci_match_one_device(ids, dev))
230 return ids;
231 ids++;
232 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 }
234 return NULL;
235}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -0600236EXPORT_SYMBOL(pci_match_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237
Alex Williamson782a9852014-05-20 08:53:21 -0600238static const struct pci_device_id pci_device_id_any = {
239 .vendor = PCI_ANY_ID,
240 .device = PCI_ANY_ID,
241 .subvendor = PCI_ANY_ID,
242 .subdevice = PCI_ANY_ID,
243};
244
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245/**
Randy Dunlapae9608a2007-01-09 21:41:01 -0800246 * pci_match_device - Tell if a PCI device structure has a matching PCI device id structure
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700247 * @drv: the PCI driver to match against
Henrik Kretzschmar39ba4872006-08-15 10:57:16 +0200248 * @dev: the PCI device structure to match against
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700249 *
250 * Used by a driver to check whether a PCI device present in the
251 * system is in its list of supported devices. Returns the matching
252 * pci_device_id structure or %NULL if there is no match.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 */
Adrian Bunkd73460d2007-10-24 18:27:18 +0200254static const struct pci_device_id *pci_match_device(struct pci_driver *drv,
255 struct pci_dev *dev)
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700256{
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700257 struct pci_dynid *dynid;
Alex Williamson782a9852014-05-20 08:53:21 -0600258 const struct pci_device_id *found_id = NULL;
259
260 /* When driver_override is set, only bind to the matching driver */
261 if (dev->driver_override && strcmp(dev->driver_override, drv->name))
262 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263
Russell King7461b602006-11-29 21:18:04 +0000264 /* Look at the dynamic ids first, before the static ones */
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700265 spin_lock(&drv->dynids.lock);
266 list_for_each_entry(dynid, &drv->dynids.list, node) {
267 if (pci_match_one_device(&dynid->id, dev)) {
Alex Williamson782a9852014-05-20 08:53:21 -0600268 found_id = &dynid->id;
269 break;
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700270 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271 }
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700272 spin_unlock(&drv->dynids.lock);
Russell King7461b602006-11-29 21:18:04 +0000273
Alex Williamson782a9852014-05-20 08:53:21 -0600274 if (!found_id)
275 found_id = pci_match_id(drv->id_table, dev);
276
277 /* driver_override will always match, send a dummy id */
278 if (!found_id && dev->driver_override)
279 found_id = &pci_device_id_any;
280
281 return found_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282}
283
Rusty Russell873392c2008-12-31 23:54:56 +1030284struct drv_dev_and_id {
285 struct pci_driver *drv;
286 struct pci_dev *dev;
287 const struct pci_device_id *id;
288};
289
290static long local_pci_probe(void *_ddi)
291{
292 struct drv_dev_and_id *ddi = _ddi;
Huang Ying967577b2012-11-20 16:08:22 +0800293 struct pci_dev *pci_dev = ddi->dev;
294 struct pci_driver *pci_drv = ddi->drv;
295 struct device *dev = &pci_dev->dev;
Alan Sternf3ec4f82010-06-08 15:23:51 -0400296 int rc;
Rusty Russell873392c2008-12-31 23:54:56 +1030297
Huang Ying967577b2012-11-20 16:08:22 +0800298 /*
299 * Unbound PCI devices are always put in D0, regardless of
300 * runtime PM status. During probe, the device is set to
301 * active and the usage count is incremented. If the driver
302 * supports runtime PM, it should call pm_runtime_put_noidle()
303 * in its probe routine and pm_runtime_get_noresume() in its
304 * remove routine.
Alan Sternf3ec4f82010-06-08 15:23:51 -0400305 */
Huang Ying967577b2012-11-20 16:08:22 +0800306 pm_runtime_get_sync(dev);
307 pci_dev->driver = pci_drv;
308 rc = pci_drv->probe(pci_dev, ddi->id);
Stephen M. Cameronf92d74c2013-11-01 14:34:55 -0500309 if (!rc)
310 return rc;
311 if (rc < 0) {
Huang Ying967577b2012-11-20 16:08:22 +0800312 pci_dev->driver = NULL;
313 pm_runtime_put_sync(dev);
Stephen M. Cameronf92d74c2013-11-01 14:34:55 -0500314 return rc;
Alan Sternf3ec4f82010-06-08 15:23:51 -0400315 }
Stephen M. Cameronf92d74c2013-11-01 14:34:55 -0500316 /*
317 * Probe function should return < 0 for failure, 0 for success
318 * Treat values > 0 as success, but warn.
319 */
320 dev_warn(dev, "Driver probe function unexpectedly returned %d\n", rc);
321 return 0;
Rusty Russell873392c2008-12-31 23:54:56 +1030322}
323
Andi Kleend42c6992005-07-06 19:56:03 +0200324static int pci_call_probe(struct pci_driver *drv, struct pci_dev *dev,
325 const struct pci_device_id *id)
326{
Rusty Russell873392c2008-12-31 23:54:56 +1030327 int error, node;
328 struct drv_dev_and_id ddi = { drv, dev, id };
Mike Travisf70316d2008-04-04 18:11:06 -0700329
Alexander Duyck12c31562013-11-18 10:59:59 -0700330 /*
331 * Execute driver initialization on node where the device is
332 * attached. This way the driver likely allocates its local memory
333 * on the right node.
334 */
Rusty Russell873392c2008-12-31 23:54:56 +1030335 node = dev_to_node(&dev->dev);
Alexander Duyck12c31562013-11-18 10:59:59 -0700336
337 /*
338 * On NUMA systems, we are likely to call a PF probe function using
339 * work_on_cpu(). If that probe calls pci_enable_sriov() (which
340 * adds the VF devices via pci_bus_add_device()), we may re-enter
341 * this function to call the VF probe function. Calling
342 * work_on_cpu() again will cause a lockdep warning. Since VFs are
343 * always on the same node as the PF, we can work around this by
344 * avoiding work_on_cpu() when we're already on the correct node.
345 *
346 * Preemption is enabled, so it's theoretically unsafe to use
347 * numa_node_id(), but even if we run the probe function on the
348 * wrong node, it should be functionally correct.
349 */
350 if (node >= 0 && node != numa_node_id()) {
Rusty Russell873392c2008-12-31 23:54:56 +1030351 int cpu;
Rusty Russell873392c2008-12-31 23:54:56 +1030352
353 get_online_cpus();
Rusty Russella70f7302009-03-13 14:49:46 +1030354 cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask);
Rusty Russell873392c2008-12-31 23:54:56 +1030355 if (cpu < nr_cpu_ids)
356 error = work_on_cpu(cpu, local_pci_probe, &ddi);
357 else
358 error = local_pci_probe(&ddi);
359 put_online_cpus();
360 } else
361 error = local_pci_probe(&ddi);
Alexander Duyck12c31562013-11-18 10:59:59 -0700362
Andi Kleend42c6992005-07-06 19:56:03 +0200363 return error;
364}
365
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366/**
Randy Dunlap23ea3792010-11-18 15:02:31 -0800367 * __pci_device_probe - check if a driver wants to claim a specific PCI device
Randy Dunlap8f7020d2005-10-23 11:57:38 -0700368 * @drv: driver to call to check if it wants the PCI device
369 * @pci_dev: PCI device being probed
Bjorn Helgaasf7625982013-11-14 11:28:18 -0700370 *
Randy Dunlap8f7020d2005-10-23 11:57:38 -0700371 * returns 0 on success, else error.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 * side-effect: pci_dev->driver is set to drv when drv claims pci_dev.
373 */
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400374static int __pci_device_probe(struct pci_driver *drv, struct pci_dev *pci_dev)
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700375{
376 const struct pci_device_id *id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 int error = 0;
378
379 if (!pci_dev->driver && drv->probe) {
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700380 error = -ENODEV;
381
382 id = pci_match_device(drv, pci_dev);
383 if (id)
Andi Kleend42c6992005-07-06 19:56:03 +0200384 error = pci_call_probe(drv, pci_dev, id);
Huang Ying967577b2012-11-20 16:08:22 +0800385 if (error >= 0)
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700386 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 }
388 return error;
389}
390
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400391static int pci_device_probe(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392{
393 int error = 0;
394 struct pci_driver *drv;
395 struct pci_dev *pci_dev;
396
397 drv = to_pci_driver(dev->driver);
398 pci_dev = to_pci_dev(dev);
399 pci_dev_get(pci_dev);
400 error = __pci_device_probe(drv, pci_dev);
401 if (error)
402 pci_dev_put(pci_dev);
403
404 return error;
405}
406
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400407static int pci_device_remove(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408{
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400409 struct pci_dev *pci_dev = to_pci_dev(dev);
410 struct pci_driver *drv = pci_dev->driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411
412 if (drv) {
Alan Sternf3ec4f82010-06-08 15:23:51 -0400413 if (drv->remove) {
414 pm_runtime_get_sync(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 drv->remove(pci_dev);
Alan Sternf3ec4f82010-06-08 15:23:51 -0400416 pm_runtime_put_noidle(dev);
417 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 pci_dev->driver = NULL;
419 }
420
Alan Sternf3ec4f82010-06-08 15:23:51 -0400421 /* Undo the runtime PM settings in local_pci_probe() */
Huang Ying967577b2012-11-20 16:08:22 +0800422 pm_runtime_put_sync(dev);
Alan Sternf3ec4f82010-06-08 15:23:51 -0400423
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424 /*
Shaohua Li2449e062006-10-20 14:45:32 -0700425 * If the device is still on, set the power state as "unknown",
426 * since it might change by the next time we load the driver.
427 */
428 if (pci_dev->current_state == PCI_D0)
429 pci_dev->current_state = PCI_UNKNOWN;
430
431 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 * We would love to complain here if pci_dev->is_enabled is set, that
433 * the driver should have called pci_disable_device(), but the
434 * unfortunate fact is there are too many odd BIOS and bridge setups
Bjorn Helgaasf7625982013-11-14 11:28:18 -0700435 * that don't like drivers doing that all of the time.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436 * Oh well, we can dream of sane hardware when we sleep, no matter how
437 * horrible the crap we have to deal with is when we are awake...
438 */
439
440 pci_dev_put(pci_dev);
441 return 0;
442}
443
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200444static void pci_device_shutdown(struct device *dev)
445{
446 struct pci_dev *pci_dev = to_pci_dev(dev);
447 struct pci_driver *drv = pci_dev->driver;
448
Huang Ying3ff2de92012-10-24 14:54:14 +0800449 pm_runtime_resume(dev);
450
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200451 if (drv && drv->shutdown)
452 drv->shutdown(pci_dev);
453 pci_msi_shutdown(pci_dev);
454 pci_msix_shutdown(pci_dev);
Rafael J. Wysocki5b415f12012-02-07 00:50:35 +0100455
Khalid Aziz4fc9bbf2013-11-27 15:19:25 -0700456#ifdef CONFIG_KEXEC
Rafael J. Wysocki5b415f12012-02-07 00:50:35 +0100457 /*
Khalid Aziz4fc9bbf2013-11-27 15:19:25 -0700458 * If this is a kexec reboot, turn off Bus Master bit on the
459 * device to tell it to not continue to do DMA. Don't touch
460 * devices in D3cold or unknown states.
461 * If it is not a kexec reboot, firmware will hit the PCI
462 * devices with big hammer and stop their DMA any way.
Khalid Azizb566a222012-04-27 13:00:33 -0600463 */
Khalid Aziz4fc9bbf2013-11-27 15:19:25 -0700464 if (kexec_in_progress && (pci_dev->current_state <= PCI_D3hot))
Konstantin Khlebnikov6e0eda32013-03-14 18:49:37 +0400465 pci_clear_master(pci_dev);
Khalid Aziz4fc9bbf2013-11-27 15:19:25 -0700466#endif
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200467}
468
Rafael J. Wysockiaa338602011-02-11 00:06:54 +0100469#ifdef CONFIG_PM
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +0100470
471/* Auxiliary functions used for system resume and run-time resume. */
472
473/**
474 * pci_restore_standard_config - restore standard config registers of PCI device
475 * @pci_dev: PCI device to handle
476 */
477static int pci_restore_standard_config(struct pci_dev *pci_dev)
478{
479 pci_update_current_state(pci_dev, PCI_UNKNOWN);
480
481 if (pci_dev->current_state != PCI_D0) {
482 int error = pci_set_power_state(pci_dev, PCI_D0);
483 if (error)
484 return error;
485 }
486
Jon Mason1d3c16a2010-11-30 17:43:26 -0600487 pci_restore_state(pci_dev);
488 return 0;
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +0100489}
490
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +0100491#endif
492
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200493#ifdef CONFIG_PM_SLEEP
494
Rafael J. Wysockidb288c92012-07-05 15:20:00 -0600495static void pci_pm_default_resume_early(struct pci_dev *pci_dev)
496{
497 pci_power_up(pci_dev);
498 pci_restore_state(pci_dev);
499 pci_fixup_device(pci_fixup_resume_early, pci_dev);
500}
501
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200502/*
503 * Default "suspend" method for devices that have no driver provided suspend,
Rafael J. Wysockifa58d302009-01-07 13:03:42 +0100504 * or not even a driver at all (second part).
505 */
Rafael J. Wysockibb808942009-01-07 14:15:17 +0100506static void pci_pm_set_unknown_state(struct pci_dev *pci_dev)
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200507{
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200508 /*
509 * mark its power state as "unknown", since we don't know if
510 * e.g. the BIOS will change its device state when we suspend.
511 */
512 if (pci_dev->current_state == PCI_D0)
513 pci_dev->current_state = PCI_UNKNOWN;
514}
515
516/*
517 * Default "resume" method for devices that have no driver provided resume,
Rafael J. Wysocki355a72d2008-12-08 00:34:57 +0100518 * or not even a driver at all (second part).
519 */
Rafael J. Wysockibb808942009-01-07 14:15:17 +0100520static int pci_pm_reenable_device(struct pci_dev *pci_dev)
Rafael J. Wysocki355a72d2008-12-08 00:34:57 +0100521{
522 int retval;
523
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200524 /* if the device was enabled before suspend, reenable */
525 retval = pci_reenable_device(pci_dev);
526 /*
527 * if the device was busmaster before the suspend, make it busmaster
528 * again
529 */
530 if (pci_dev->is_busmaster)
531 pci_set_master(pci_dev);
532
533 return retval;
534}
535
536static int pci_legacy_suspend(struct device *dev, pm_message_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537{
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400538 struct pci_dev *pci_dev = to_pci_dev(dev);
539 struct pci_driver *drv = pci_dev->driver;
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100540
Andrew Morton02669492006-03-23 01:38:34 -0800541 if (drv && drv->suspend) {
Rafael J. Wysocki99dadce2009-02-04 01:59:09 +0100542 pci_power_t prev = pci_dev->current_state;
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100543 int error;
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +0100544
Frans Pop57ef8022009-03-16 22:39:56 +0100545 error = drv->suspend(pci_dev, state);
546 suspend_report_result(drv->suspend, error);
547 if (error)
548 return error;
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +0100549
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100550 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
Rafael J. Wysocki99dadce2009-02-04 01:59:09 +0100551 && pci_dev->current_state != PCI_UNKNOWN) {
552 WARN_ONCE(pci_dev->current_state != prev,
553 "PCI PM: Device state not saved by %pF\n",
554 drv->suspend);
Rafael J. Wysocki99dadce2009-02-04 01:59:09 +0100555 }
Andrew Morton02669492006-03-23 01:38:34 -0800556 }
Rafael J. Wysockiad8cfa12009-01-07 13:09:37 +0100557
558 pci_fixup_device(pci_fixup_suspend, pci_dev);
559
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100560 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561}
562
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200563static int pci_legacy_suspend_late(struct device *dev, pm_message_t state)
Linus Torvaldscbd69db2006-06-24 14:50:29 -0700564{
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400565 struct pci_dev *pci_dev = to_pci_dev(dev);
566 struct pci_driver *drv = pci_dev->driver;
Linus Torvaldscbd69db2006-06-24 14:50:29 -0700567
568 if (drv && drv->suspend_late) {
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100569 pci_power_t prev = pci_dev->current_state;
570 int error;
571
Frans Pop57ef8022009-03-16 22:39:56 +0100572 error = drv->suspend_late(pci_dev, state);
573 suspend_report_result(drv->suspend_late, error);
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100574 if (error)
575 return error;
576
577 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
578 && pci_dev->current_state != PCI_UNKNOWN) {
579 WARN_ONCE(pci_dev->current_state != prev,
580 "PCI PM: Device state not saved by %pF\n",
581 drv->suspend_late);
Andreas Noever7d2a01b2014-06-03 22:04:09 +0200582 goto Fixup;
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100583 }
Linus Torvaldscbd69db2006-06-24 14:50:29 -0700584 }
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100585
586 if (!pci_dev->state_saved)
587 pci_save_state(pci_dev);
588
589 pci_pm_set_unknown_state(pci_dev);
590
Andreas Noever7d2a01b2014-06-03 22:04:09 +0200591Fixup:
592 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
593
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100594 return 0;
Linus Torvaldscbd69db2006-06-24 14:50:29 -0700595}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +0100597static int pci_legacy_resume_early(struct device *dev)
598{
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400599 struct pci_dev *pci_dev = to_pci_dev(dev);
600 struct pci_driver *drv = pci_dev->driver;
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +0100601
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +0100602 return drv && drv->resume_early ?
603 drv->resume_early(pci_dev) : 0;
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +0100604}
605
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200606static int pci_legacy_resume(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607{
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400608 struct pci_dev *pci_dev = to_pci_dev(dev);
609 struct pci_driver *drv = pci_dev->driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610
Rafael J. Wysockiad8cfa12009-01-07 13:09:37 +0100611 pci_fixup_device(pci_fixup_resume, pci_dev);
612
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +0100613 return drv && drv->resume ?
614 drv->resume(pci_dev) : pci_pm_reenable_device(pci_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615}
616
Rafael J. Wysocki571ff752009-01-07 13:05:05 +0100617/* Auxiliary functions used by the new power management framework */
618
Rafael J. Wysocki5294e252009-02-04 02:09:07 +0100619static void pci_pm_default_resume(struct pci_dev *pci_dev)
Rafael J. Wysocki571ff752009-01-07 13:05:05 +0100620{
Rafael J. Wysocki734104292009-01-07 13:07:15 +0100621 pci_fixup_device(pci_fixup_resume, pci_dev);
622
Yijing Wang326c1cd2014-05-04 12:23:36 +0800623 if (!pci_has_subordinate(pci_dev))
Rafael J. Wysocki5294e252009-02-04 02:09:07 +0100624 pci_enable_wake(pci_dev, PCI_D0, false);
Rafael J. Wysocki571ff752009-01-07 13:05:05 +0100625}
626
Rafael J. Wysocki5294e252009-02-04 02:09:07 +0100627static void pci_pm_default_suspend(struct pci_dev *pci_dev)
Rafael J. Wysocki734104292009-01-07 13:07:15 +0100628{
Rafael J. Wysocki5294e252009-02-04 02:09:07 +0100629 /* Disable non-bridge devices without PM support */
Yijing Wang326c1cd2014-05-04 12:23:36 +0800630 if (!pci_has_subordinate(pci_dev))
Rafael J. Wysockicbbc2f62009-02-04 02:01:15 +0100631 pci_disable_enabled_device(pci_dev);
Rafael J. Wysocki734104292009-01-07 13:07:15 +0100632}
633
Rafael J. Wysocki07e836e2009-01-07 13:06:10 +0100634static bool pci_has_legacy_pm_support(struct pci_dev *pci_dev)
635{
636 struct pci_driver *drv = pci_dev->driver;
Rafael J. Wysockibb808942009-01-07 14:15:17 +0100637 bool ret = drv && (drv->suspend || drv->suspend_late || drv->resume
Rafael J. Wysocki07e836e2009-01-07 13:06:10 +0100638 || drv->resume_early);
Rafael J. Wysockibb808942009-01-07 14:15:17 +0100639
640 /*
641 * Legacy PM support is used by default, so warn if the new framework is
642 * supported as well. Drivers are supposed to support either the
643 * former, or the latter, but not both at the same time.
644 */
David Fries82440a82011-11-20 15:29:46 -0600645 WARN(ret && drv->driver.pm, "driver %s device %04x:%04x\n",
646 drv->name, pci_dev->vendor, pci_dev->device);
Rafael J. Wysockibb808942009-01-07 14:15:17 +0100647
648 return ret;
Rafael J. Wysocki07e836e2009-01-07 13:06:10 +0100649}
650
Rafael J. Wysocki571ff752009-01-07 13:05:05 +0100651/* New power management framework */
652
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200653static int pci_pm_prepare(struct device *dev)
654{
655 struct device_driver *drv = dev->driver;
656 int error = 0;
657
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +0100658 /*
Rafael J. Wysocki7cd06022014-02-26 01:00:30 +0100659 * Devices having power.ignore_children set may still be necessary for
660 * suspending their children in the next phase of device suspend.
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +0100661 */
Rafael J. Wysocki7cd06022014-02-26 01:00:30 +0100662 if (dev->power.ignore_children)
663 pm_runtime_resume(dev);
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +0100664
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200665 if (drv && drv->pm && drv->pm->prepare)
666 error = drv->pm->prepare(dev);
667
668 return error;
669}
670
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200671
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +0100672#else /* !CONFIG_PM_SLEEP */
673
674#define pci_pm_prepare NULL
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +0100675
676#endif /* !CONFIG_PM_SLEEP */
677
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200678#ifdef CONFIG_SUSPEND
679
680static int pci_pm_suspend(struct device *dev)
681{
682 struct pci_dev *pci_dev = to_pci_dev(dev);
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700683 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200684
Rafael J. Wysockiad8cfa12009-01-07 13:09:37 +0100685 if (pci_has_legacy_pm_support(pci_dev))
686 return pci_legacy_suspend(dev, PMSG_SUSPEND);
Rafael J. Wysockibb808942009-01-07 14:15:17 +0100687
Rafael J. Wysocki5294e252009-02-04 02:09:07 +0100688 if (!pm) {
689 pci_pm_default_suspend(pci_dev);
690 goto Fixup;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200691 }
Rafael J. Wysockifa58d302009-01-07 13:03:42 +0100692
Rafael J. Wysocki7cd06022014-02-26 01:00:30 +0100693 /*
694 * PCI devices suspended at run time need to be resumed at this point,
695 * because in general it is necessary to reconfigure them for system
696 * suspend. Namely, if the device is supposed to wake up the system
697 * from the sleep state, we may need to reconfigure it for this purpose.
698 * In turn, if the device is not supposed to wake up the system from the
699 * sleep state, we'll have to prevent it from signaling wake-up.
700 */
701 pm_runtime_resume(dev);
702
Rafael J. Wysocki82fee4d2013-02-04 15:56:05 +0400703 pci_dev->state_saved = false;
Rafael J. Wysocki5294e252009-02-04 02:09:07 +0100704 if (pm->suspend) {
705 pci_power_t prev = pci_dev->current_state;
706 int error;
707
708 error = pm->suspend(dev);
709 suspend_report_result(pm->suspend, error);
710 if (error)
711 return error;
712
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100713 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
Rafael J. Wysocki5294e252009-02-04 02:09:07 +0100714 && pci_dev->current_state != PCI_UNKNOWN) {
715 WARN_ONCE(pci_dev->current_state != prev,
716 "PCI PM: State of device not saved by %pF\n",
717 pm->suspend);
Rafael J. Wysocki5294e252009-02-04 02:09:07 +0100718 }
719 }
720
Rafael J. Wysocki5294e252009-02-04 02:09:07 +0100721 Fixup:
722 pci_fixup_device(pci_fixup_suspend, pci_dev);
723
724 return 0;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200725}
726
727static int pci_pm_suspend_noirq(struct device *dev)
Greg KHc8958172005-04-08 14:53:31 +0900728{
Rafael J. Wysocki355a72d2008-12-08 00:34:57 +0100729 struct pci_dev *pci_dev = to_pci_dev(dev);
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700730 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
Greg KHc8958172005-04-08 14:53:31 +0900731
Rafael J. Wysockibb808942009-01-07 14:15:17 +0100732 if (pci_has_legacy_pm_support(pci_dev))
733 return pci_legacy_suspend_late(dev, PMSG_SUSPEND);
734
Rafael J. Wysocki931ff682009-03-16 22:40:50 +0100735 if (!pm) {
736 pci_save_state(pci_dev);
Andreas Noever7d2a01b2014-06-03 22:04:09 +0200737 goto Fixup;
Rafael J. Wysocki931ff682009-03-16 22:40:50 +0100738 }
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100739
740 if (pm->suspend_noirq) {
741 pci_power_t prev = pci_dev->current_state;
742 int error;
743
744 error = pm->suspend_noirq(dev);
745 suspend_report_result(pm->suspend_noirq, error);
746 if (error)
747 return error;
748
749 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
750 && pci_dev->current_state != PCI_UNKNOWN) {
751 WARN_ONCE(pci_dev->current_state != prev,
752 "PCI PM: State of device not saved by %pF\n",
753 pm->suspend_noirq);
Andreas Noever7d2a01b2014-06-03 22:04:09 +0200754 goto Fixup;
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100755 }
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200756 }
757
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100758 if (!pci_dev->state_saved) {
759 pci_save_state(pci_dev);
Yijing Wang326c1cd2014-05-04 12:23:36 +0800760 if (!pci_has_subordinate(pci_dev))
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100761 pci_prepare_to_sleep(pci_dev);
762 }
Rafael J. Wysockid67e37d2009-01-07 13:11:28 +0100763
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100764 pci_pm_set_unknown_state(pci_dev);
765
Alan Sterndbf0e4c2012-07-09 11:09:21 -0400766 /*
767 * Some BIOSes from ASUS have a bug: If a USB EHCI host controller's
768 * PCI COMMAND register isn't 0, the BIOS assumes that the controller
769 * hasn't been quiesced and tries to turn it off. If the controller
770 * is already in D3, this can hang or cause memory corruption.
771 *
772 * Since the value of the COMMAND register doesn't matter once the
773 * device has been suspended, we can safely set it to 0 here.
774 */
775 if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
776 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
777
Andreas Noever7d2a01b2014-06-03 22:04:09 +0200778Fixup:
779 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
780
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100781 return 0;
Greg KHc8958172005-04-08 14:53:31 +0900782}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200784static int pci_pm_resume_noirq(struct device *dev)
785{
Rafael J. Wysocki355a72d2008-12-08 00:34:57 +0100786 struct pci_dev *pci_dev = to_pci_dev(dev);
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200787 struct device_driver *drv = dev->driver;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200788 int error = 0;
789
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +0100790 pci_pm_default_resume_early(pci_dev);
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +0100791
Rafael J. Wysockiad8cfa12009-01-07 13:09:37 +0100792 if (pci_has_legacy_pm_support(pci_dev))
Rafael J. Wysockibb808942009-01-07 14:15:17 +0100793 return pci_legacy_resume_early(dev);
Rafael J. Wysockibb808942009-01-07 14:15:17 +0100794
Rafael J. Wysockid67e37d2009-01-07 13:11:28 +0100795 if (drv && drv->pm && drv->pm->resume_noirq)
796 error = drv->pm->resume_noirq(dev);
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200797
798 return error;
799}
800
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +0100801static int pci_pm_resume(struct device *dev)
802{
803 struct pci_dev *pci_dev = to_pci_dev(dev);
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700804 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +0100805 int error = 0;
806
Rafael J. Wysocki418e4da2009-01-26 21:43:08 +0100807 /*
808 * This is necessary for the suspend error path in which resume is
809 * called without restoring the standard config registers of the device.
810 */
811 if (pci_dev->state_saved)
812 pci_restore_standard_config(pci_dev);
813
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +0100814 if (pci_has_legacy_pm_support(pci_dev))
815 return pci_legacy_resume(dev);
816
Rafael J. Wysocki5294e252009-02-04 02:09:07 +0100817 pci_pm_default_resume(pci_dev);
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +0100818
Rafael J. Wysocki5294e252009-02-04 02:09:07 +0100819 if (pm) {
820 if (pm->resume)
821 error = pm->resume(dev);
822 } else {
823 pci_pm_reenable_device(pci_dev);
824 }
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +0100825
Rafael J. Wysocki999cce42009-09-09 23:51:27 +0200826 return error;
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +0100827}
828
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200829#else /* !CONFIG_SUSPEND */
830
831#define pci_pm_suspend NULL
832#define pci_pm_suspend_noirq NULL
833#define pci_pm_resume NULL
834#define pci_pm_resume_noirq NULL
835
836#endif /* !CONFIG_SUSPEND */
837
Rafael J. Wysocki1f112ce2011-04-11 22:54:42 +0200838#ifdef CONFIG_HIBERNATE_CALLBACKS
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200839
Sebastian Ott699c1982013-08-20 16:41:02 +0200840
841/*
842 * pcibios_pm_ops - provide arch-specific hooks when a PCI device is doing
843 * a hibernate transition
844 */
845struct dev_pm_ops __weak pcibios_pm_ops;
846
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200847static int pci_pm_freeze(struct device *dev)
848{
849 struct pci_dev *pci_dev = to_pci_dev(dev);
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700850 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200851
Rafael J. Wysockiad8cfa12009-01-07 13:09:37 +0100852 if (pci_has_legacy_pm_support(pci_dev))
853 return pci_legacy_suspend(dev, PMSG_FREEZE);
Rafael J. Wysockibb808942009-01-07 14:15:17 +0100854
Rafael J. Wysocki5294e252009-02-04 02:09:07 +0100855 if (!pm) {
856 pci_pm_default_suspend(pci_dev);
857 return 0;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200858 }
859
Rafael J. Wysocki7cd06022014-02-26 01:00:30 +0100860 /*
861 * This used to be done in pci_pm_prepare() for all devices and some
862 * drivers may depend on it, so do it here. Ideally, runtime-suspended
863 * devices should not be touched during freeze/thaw transitions,
864 * however.
865 */
866 pm_runtime_resume(dev);
867
Rafael J. Wysocki82fee4d2013-02-04 15:56:05 +0400868 pci_dev->state_saved = false;
Rafael J. Wysocki5294e252009-02-04 02:09:07 +0100869 if (pm->freeze) {
870 int error;
871
872 error = pm->freeze(dev);
873 suspend_report_result(pm->freeze, error);
874 if (error)
875 return error;
876 }
877
Sebastian Ott699c1982013-08-20 16:41:02 +0200878 if (pcibios_pm_ops.freeze)
879 return pcibios_pm_ops.freeze(dev);
880
Rafael J. Wysocki5294e252009-02-04 02:09:07 +0100881 return 0;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200882}
883
884static int pci_pm_freeze_noirq(struct device *dev)
885{
Rafael J. Wysocki355a72d2008-12-08 00:34:57 +0100886 struct pci_dev *pci_dev = to_pci_dev(dev);
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200887 struct device_driver *drv = dev->driver;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200888
Rafael J. Wysockibb808942009-01-07 14:15:17 +0100889 if (pci_has_legacy_pm_support(pci_dev))
890 return pci_legacy_suspend_late(dev, PMSG_FREEZE);
891
Rafael J. Wysockid67e37d2009-01-07 13:11:28 +0100892 if (drv && drv->pm && drv->pm->freeze_noirq) {
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100893 int error;
894
Rafael J. Wysockid67e37d2009-01-07 13:11:28 +0100895 error = drv->pm->freeze_noirq(dev);
896 suspend_report_result(drv->pm->freeze_noirq, error);
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100897 if (error)
898 return error;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200899 }
900
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100901 if (!pci_dev->state_saved)
902 pci_save_state(pci_dev);
Rafael J. Wysockid67e37d2009-01-07 13:11:28 +0100903
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100904 pci_pm_set_unknown_state(pci_dev);
905
Sebastian Ott699c1982013-08-20 16:41:02 +0200906 if (pcibios_pm_ops.freeze_noirq)
907 return pcibios_pm_ops.freeze_noirq(dev);
908
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100909 return 0;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200910}
911
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200912static int pci_pm_thaw_noirq(struct device *dev)
913{
Rafael J. Wysocki355a72d2008-12-08 00:34:57 +0100914 struct pci_dev *pci_dev = to_pci_dev(dev);
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200915 struct device_driver *drv = dev->driver;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200916 int error = 0;
917
Sebastian Ott699c1982013-08-20 16:41:02 +0200918 if (pcibios_pm_ops.thaw_noirq) {
919 error = pcibios_pm_ops.thaw_noirq(dev);
920 if (error)
921 return error;
922 }
923
Rafael J. Wysockiad8cfa12009-01-07 13:09:37 +0100924 if (pci_has_legacy_pm_support(pci_dev))
Rafael J. Wysockibb808942009-01-07 14:15:17 +0100925 return pci_legacy_resume_early(dev);
Rafael J. Wysockibb808942009-01-07 14:15:17 +0100926
Rafael J. Wysockid67e37d2009-01-07 13:11:28 +0100927 pci_update_current_state(pci_dev, PCI_D0);
928
929 if (drv && drv->pm && drv->pm->thaw_noirq)
930 error = drv->pm->thaw_noirq(dev);
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200931
932 return error;
933}
934
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +0100935static int pci_pm_thaw(struct device *dev)
936{
937 struct pci_dev *pci_dev = to_pci_dev(dev);
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700938 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +0100939 int error = 0;
940
Sebastian Ott699c1982013-08-20 16:41:02 +0200941 if (pcibios_pm_ops.thaw) {
942 error = pcibios_pm_ops.thaw(dev);
943 if (error)
944 return error;
945 }
946
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +0100947 if (pci_has_legacy_pm_support(pci_dev))
948 return pci_legacy_resume(dev);
949
Rafael J. Wysocki5294e252009-02-04 02:09:07 +0100950 if (pm) {
951 if (pm->thaw)
952 error = pm->thaw(dev);
953 } else {
954 pci_pm_reenable_device(pci_dev);
955 }
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +0100956
Rafael J. Wysocki4b77b0a2009-09-09 23:49:59 +0200957 pci_dev->state_saved = false;
958
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +0100959 return error;
960}
961
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200962static int pci_pm_poweroff(struct device *dev)
963{
Rafael J. Wysocki355a72d2008-12-08 00:34:57 +0100964 struct pci_dev *pci_dev = to_pci_dev(dev);
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700965 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +0200966
Rafael J. Wysockiad8cfa12009-01-07 13:09:37 +0100967 if (pci_has_legacy_pm_support(pci_dev))
968 return pci_legacy_suspend(dev, PMSG_HIBERNATE);
Rafael J. Wysockibb808942009-01-07 14:15:17 +0100969
Rafael J. Wysocki5294e252009-02-04 02:09:07 +0100970 if (!pm) {
971 pci_pm_default_suspend(pci_dev);
972 goto Fixup;
973 }
974
Rafael J. Wysocki7cd06022014-02-26 01:00:30 +0100975 /* The reason to do that is the same as in pci_pm_suspend(). */
976 pm_runtime_resume(dev);
977
Rafael J. Wysocki82fee4d2013-02-04 15:56:05 +0400978 pci_dev->state_saved = false;
Rafael J. Wysocki5294e252009-02-04 02:09:07 +0100979 if (pm->poweroff) {
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100980 int error;
981
Rafael J. Wysockiddb7c9d2009-02-04 01:56:14 +0100982 error = pm->poweroff(dev);
983 suspend_report_result(pm->poweroff, error);
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100984 if (error)
985 return error;
986 }
987
988 Fixup:
989 pci_fixup_device(pci_fixup_suspend, pci_dev);
990
Sebastian Ott699c1982013-08-20 16:41:02 +0200991 if (pcibios_pm_ops.poweroff)
992 return pcibios_pm_ops.poweroff(dev);
993
Rafael J. Wysocki46939f82009-03-16 22:40:26 +0100994 return 0;
995}
996
997static int pci_pm_poweroff_noirq(struct device *dev)
998{
999 struct pci_dev *pci_dev = to_pci_dev(dev);
1000 struct device_driver *drv = dev->driver;
1001
1002 if (pci_has_legacy_pm_support(to_pci_dev(dev)))
1003 return pci_legacy_suspend_late(dev, PMSG_HIBERNATE);
1004
Andreas Noever7d2a01b2014-06-03 22:04:09 +02001005 if (!drv || !drv->pm) {
1006 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
Rafael J. Wysocki46939f82009-03-16 22:40:26 +01001007 return 0;
Andreas Noever7d2a01b2014-06-03 22:04:09 +02001008 }
Rafael J. Wysocki46939f82009-03-16 22:40:26 +01001009
1010 if (drv->pm->poweroff_noirq) {
1011 int error;
1012
1013 error = drv->pm->poweroff_noirq(dev);
1014 suspend_report_result(drv->pm->poweroff_noirq, error);
1015 if (error)
1016 return error;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001017 }
1018
Yijing Wang326c1cd2014-05-04 12:23:36 +08001019 if (!pci_dev->state_saved && !pci_has_subordinate(pci_dev))
Rafael J. Wysocki5294e252009-02-04 02:09:07 +01001020 pci_prepare_to_sleep(pci_dev);
1021
Rafael J. Wysocki0b68c8e2012-08-12 23:26:07 +02001022 /*
1023 * The reason for doing this here is the same as for the analogous code
1024 * in pci_pm_suspend_noirq().
1025 */
1026 if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
1027 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
1028
Andreas Noever7d2a01b2014-06-03 22:04:09 +02001029 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1030
Sebastian Ott699c1982013-08-20 16:41:02 +02001031 if (pcibios_pm_ops.poweroff_noirq)
1032 return pcibios_pm_ops.poweroff_noirq(dev);
1033
Rafael J. Wysocki46939f82009-03-16 22:40:26 +01001034 return 0;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001035}
1036
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001037static int pci_pm_restore_noirq(struct device *dev)
1038{
1039 struct pci_dev *pci_dev = to_pci_dev(dev);
Rafael J. Wysockiadf09492008-10-06 22:46:05 +02001040 struct device_driver *drv = dev->driver;
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001041 int error = 0;
1042
Sebastian Ott699c1982013-08-20 16:41:02 +02001043 if (pcibios_pm_ops.restore_noirq) {
1044 error = pcibios_pm_ops.restore_noirq(dev);
1045 if (error)
1046 return error;
1047 }
1048
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001049 pci_pm_default_resume_early(pci_dev);
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +01001050
Rafael J. Wysockiad8cfa12009-01-07 13:09:37 +01001051 if (pci_has_legacy_pm_support(pci_dev))
Rafael J. Wysockibb808942009-01-07 14:15:17 +01001052 return pci_legacy_resume_early(dev);
Rafael J. Wysockibb808942009-01-07 14:15:17 +01001053
Rafael J. Wysockid67e37d2009-01-07 13:11:28 +01001054 if (drv && drv->pm && drv->pm->restore_noirq)
1055 error = drv->pm->restore_noirq(dev);
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001056
1057 return error;
1058}
1059
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +01001060static int pci_pm_restore(struct device *dev)
1061{
1062 struct pci_dev *pci_dev = to_pci_dev(dev);
Dmitry Torokhov8150f322009-07-24 22:11:32 -07001063 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +01001064 int error = 0;
1065
Sebastian Ott699c1982013-08-20 16:41:02 +02001066 if (pcibios_pm_ops.restore) {
1067 error = pcibios_pm_ops.restore(dev);
1068 if (error)
1069 return error;
1070 }
1071
Rafael J. Wysocki418e4da2009-01-26 21:43:08 +01001072 /*
1073 * This is necessary for the hibernation error path in which restore is
1074 * called without restoring the standard config registers of the device.
1075 */
1076 if (pci_dev->state_saved)
1077 pci_restore_standard_config(pci_dev);
1078
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +01001079 if (pci_has_legacy_pm_support(pci_dev))
1080 return pci_legacy_resume(dev);
1081
Rafael J. Wysocki5294e252009-02-04 02:09:07 +01001082 pci_pm_default_resume(pci_dev);
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +01001083
Rafael J. Wysocki5294e252009-02-04 02:09:07 +01001084 if (pm) {
1085 if (pm->restore)
1086 error = pm->restore(dev);
1087 } else {
1088 pci_pm_reenable_device(pci_dev);
1089 }
Rafael J. Wysockif6dc1e52009-01-07 13:12:22 +01001090
1091 return error;
1092}
1093
Rafael J. Wysocki1f112ce2011-04-11 22:54:42 +02001094#else /* !CONFIG_HIBERNATE_CALLBACKS */
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001095
1096#define pci_pm_freeze NULL
1097#define pci_pm_freeze_noirq NULL
1098#define pci_pm_thaw NULL
1099#define pci_pm_thaw_noirq NULL
1100#define pci_pm_poweroff NULL
1101#define pci_pm_poweroff_noirq NULL
1102#define pci_pm_restore NULL
1103#define pci_pm_restore_noirq NULL
1104
Rafael J. Wysocki1f112ce2011-04-11 22:54:42 +02001105#endif /* !CONFIG_HIBERNATE_CALLBACKS */
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001106
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001107#ifdef CONFIG_PM_RUNTIME
1108
1109static int pci_pm_runtime_suspend(struct device *dev)
1110{
1111 struct pci_dev *pci_dev = to_pci_dev(dev);
1112 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1113 pci_power_t prev = pci_dev->current_state;
1114 int error;
1115
Huang Ying967577b2012-11-20 16:08:22 +08001116 /*
1117 * If pci_dev->driver is not set (unbound), the device should
1118 * always remain in D0 regardless of the runtime PM status
1119 */
1120 if (!pci_dev->driver)
1121 return 0;
1122
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001123 if (!pm || !pm->runtime_suspend)
1124 return -ENOSYS;
1125
Rafael J. Wysocki82fee4d2013-02-04 15:56:05 +04001126 pci_dev->state_saved = false;
Huang Ying448bd852012-06-23 10:23:51 +08001127 pci_dev->no_d3cold = false;
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001128 error = pm->runtime_suspend(dev);
1129 suspend_report_result(pm->runtime_suspend, error);
1130 if (error)
1131 return error;
Huang Ying448bd852012-06-23 10:23:51 +08001132 if (!pci_dev->d3cold_allowed)
1133 pci_dev->no_d3cold = true;
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001134
1135 pci_fixup_device(pci_fixup_suspend, pci_dev);
1136
1137 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
1138 && pci_dev->current_state != PCI_UNKNOWN) {
1139 WARN_ONCE(pci_dev->current_state != prev,
1140 "PCI PM: State of device not saved by %pF\n",
1141 pm->runtime_suspend);
1142 return 0;
1143 }
1144
Dave Airlie42eca232012-10-29 17:26:54 -06001145 if (!pci_dev->state_saved) {
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001146 pci_save_state(pci_dev);
Dave Airlie42eca232012-10-29 17:26:54 -06001147 pci_finish_runtime_suspend(pci_dev);
1148 }
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001149
1150 return 0;
1151}
1152
1153static int pci_pm_runtime_resume(struct device *dev)
1154{
Huang Ying448bd852012-06-23 10:23:51 +08001155 int rc;
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001156 struct pci_dev *pci_dev = to_pci_dev(dev);
1157 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1158
Huang Ying967577b2012-11-20 16:08:22 +08001159 /*
1160 * If pci_dev->driver is not set (unbound), the device should
1161 * always remain in D0 regardless of the runtime PM status
1162 */
1163 if (!pci_dev->driver)
1164 return 0;
1165
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001166 if (!pm || !pm->runtime_resume)
1167 return -ENOSYS;
1168
Rafael J. Wysockidb288c92012-07-05 15:20:00 -06001169 pci_restore_standard_config(pci_dev);
1170 pci_fixup_device(pci_fixup_resume_early, pci_dev);
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001171 __pci_enable_wake(pci_dev, PCI_D0, true, false);
1172 pci_fixup_device(pci_fixup_resume, pci_dev);
1173
Huang Ying448bd852012-06-23 10:23:51 +08001174 rc = pm->runtime_resume(dev);
1175
1176 pci_dev->runtime_d3cold = false;
1177
1178 return rc;
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001179}
1180
1181static int pci_pm_runtime_idle(struct device *dev)
1182{
Huang Ying967577b2012-11-20 16:08:22 +08001183 struct pci_dev *pci_dev = to_pci_dev(dev);
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001184 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
Rafael J. Wysocki45f0a852013-06-03 21:49:52 +02001185 int ret = 0;
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001186
Huang Ying967577b2012-11-20 16:08:22 +08001187 /*
1188 * If pci_dev->driver is not set (unbound), the device should
1189 * always remain in D0 regardless of the runtime PM status
1190 */
1191 if (!pci_dev->driver)
Rafael J. Wysocki45f0a852013-06-03 21:49:52 +02001192 return 0;
Huang Ying967577b2012-11-20 16:08:22 +08001193
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001194 if (!pm)
1195 return -ENOSYS;
1196
Rafael J. Wysocki45f0a852013-06-03 21:49:52 +02001197 if (pm->runtime_idle)
1198 ret = pm->runtime_idle(dev);
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001199
Rafael J. Wysocki45f0a852013-06-03 21:49:52 +02001200 return ret;
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001201}
1202
1203#else /* !CONFIG_PM_RUNTIME */
1204
1205#define pci_pm_runtime_suspend NULL
1206#define pci_pm_runtime_resume NULL
1207#define pci_pm_runtime_idle NULL
1208
1209#endif /* !CONFIG_PM_RUNTIME */
1210
Rafael J. Wysockiaa338602011-02-11 00:06:54 +01001211#ifdef CONFIG_PM
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001212
Sachin Kamatf91da042013-10-04 12:04:44 -06001213static const struct dev_pm_ops pci_dev_pm_ops = {
Rafael J. Wysockiadf09492008-10-06 22:46:05 +02001214 .prepare = pci_pm_prepare,
Rafael J. Wysockiadf09492008-10-06 22:46:05 +02001215 .suspend = pci_pm_suspend,
1216 .resume = pci_pm_resume,
1217 .freeze = pci_pm_freeze,
1218 .thaw = pci_pm_thaw,
1219 .poweroff = pci_pm_poweroff,
1220 .restore = pci_pm_restore,
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001221 .suspend_noirq = pci_pm_suspend_noirq,
1222 .resume_noirq = pci_pm_resume_noirq,
1223 .freeze_noirq = pci_pm_freeze_noirq,
1224 .thaw_noirq = pci_pm_thaw_noirq,
1225 .poweroff_noirq = pci_pm_poweroff_noirq,
1226 .restore_noirq = pci_pm_restore_noirq,
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001227 .runtime_suspend = pci_pm_runtime_suspend,
1228 .runtime_resume = pci_pm_runtime_resume,
1229 .runtime_idle = pci_pm_runtime_idle,
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001230};
1231
Rafael J. Wysockiadf09492008-10-06 22:46:05 +02001232#define PCI_PM_OPS_PTR (&pci_dev_pm_ops)
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001233
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001234#else /* !COMFIG_PM_OPS */
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001235
1236#define PCI_PM_OPS_PTR NULL
1237
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01001238#endif /* !COMFIG_PM_OPS */
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001239
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240/**
Laurent riffard863b18f2005-10-27 23:12:54 +02001241 * __pci_register_driver - register a new pci driver
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242 * @drv: the driver structure to register
Laurent riffard863b18f2005-10-27 23:12:54 +02001243 * @owner: owner module of drv
Randy Dunlapf95d8822007-02-10 14:41:56 -08001244 * @mod_name: module name string
Bjorn Helgaasf7625982013-11-14 11:28:18 -07001245 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246 * Adds the driver structure to the list of registered drivers.
Bjorn Helgaasf7625982013-11-14 11:28:18 -07001247 * Returns a negative value on error, otherwise 0.
1248 * If no error occurred, the driver remains registered even if
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249 * no device was claimed during registration.
1250 */
Greg Kroah-Hartman725522b2007-01-15 11:50:02 -08001251int __pci_register_driver(struct pci_driver *drv, struct module *owner,
1252 const char *mod_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254 /* initialize common driver fields */
1255 drv->driver.name = drv->name;
1256 drv->driver.bus = &pci_bus_type;
Laurent riffard863b18f2005-10-27 23:12:54 +02001257 drv->driver.owner = owner;
Greg Kroah-Hartman725522b2007-01-15 11:50:02 -08001258 drv->driver.mod_name = mod_name;
Alan Cox50b00752006-08-16 17:42:18 +01001259
Greg Kroah-Hartman75865852005-06-30 02:18:12 -07001260 spin_lock_init(&drv->dynids.lock);
1261 INIT_LIST_HEAD(&drv->dynids.list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262
1263 /* register with core */
Konstantin Khlebnikovbfb09a82012-08-08 14:47:51 +04001264 return driver_register(&drv->driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001266EXPORT_SYMBOL(__pci_register_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267
1268/**
1269 * pci_unregister_driver - unregister a pci driver
1270 * @drv: the driver structure to unregister
Bjorn Helgaasf7625982013-11-14 11:28:18 -07001271 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 * Deletes the driver structure from the list of registered PCI drivers,
1273 * gives it a chance to clean up by calling its remove() function for
1274 * each device it was responsible for, and marks those devices as
1275 * driverless.
1276 */
1277
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04001278void pci_unregister_driver(struct pci_driver *drv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279{
1280 driver_unregister(&drv->driver);
1281 pci_free_dynids(drv);
1282}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001283EXPORT_SYMBOL(pci_unregister_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284
1285static struct pci_driver pci_compat_driver = {
1286 .name = "compat"
1287};
1288
1289/**
1290 * pci_dev_driver - get the pci_driver of a device
1291 * @dev: the device to query
1292 *
Bjorn Helgaasf7625982013-11-14 11:28:18 -07001293 * Returns the appropriate pci_driver structure or %NULL if there is no
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294 * registered driver for the device.
1295 */
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04001296struct pci_driver *pci_dev_driver(const struct pci_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297{
1298 if (dev->driver)
1299 return dev->driver;
1300 else {
1301 int i;
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04001302 for (i = 0; i <= PCI_ROM_RESOURCE; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303 if (dev->resource[i].flags & IORESOURCE_BUSY)
1304 return &pci_compat_driver;
1305 }
1306 return NULL;
1307}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001308EXPORT_SYMBOL(pci_dev_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309
1310/**
1311 * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312 * @dev: the PCI device structure to match against
Randy Dunlap8f7020d2005-10-23 11:57:38 -07001313 * @drv: the device driver to search for matching PCI device id structures
Bjorn Helgaasf7625982013-11-14 11:28:18 -07001314 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315 * Used by a driver to check whether a PCI device present in the
Randy Dunlap8f7020d2005-10-23 11:57:38 -07001316 * system is in its list of supported devices. Returns the matching
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317 * pci_device_id structure or %NULL if there is no match.
1318 */
Greg Kroah-Hartman75865852005-06-30 02:18:12 -07001319static int pci_bus_match(struct device *dev, struct device_driver *drv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320{
Greg Kroah-Hartman75865852005-06-30 02:18:12 -07001321 struct pci_dev *pci_dev = to_pci_dev(dev);
Yinghai Lu58d9a382013-01-21 13:20:51 -08001322 struct pci_driver *pci_drv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323 const struct pci_device_id *found_id;
1324
Yinghai Lu58d9a382013-01-21 13:20:51 -08001325 if (!pci_dev->match_driver)
1326 return 0;
1327
1328 pci_drv = to_pci_driver(drv);
Greg Kroah-Hartman75865852005-06-30 02:18:12 -07001329 found_id = pci_match_device(pci_drv, pci_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330 if (found_id)
1331 return 1;
1332
Greg Kroah-Hartman75865852005-06-30 02:18:12 -07001333 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334}
1335
1336/**
1337 * pci_dev_get - increments the reference count of the pci device structure
1338 * @dev: the device being referenced
1339 *
1340 * Each live reference to a device should be refcounted.
1341 *
1342 * Drivers for PCI devices should normally record such references in
1343 * their probe() methods, when they bind to a device, and release
1344 * them by calling pci_dev_put(), in their disconnect() methods.
1345 *
1346 * A pointer to the device with the incremented reference counter is returned.
1347 */
1348struct pci_dev *pci_dev_get(struct pci_dev *dev)
1349{
1350 if (dev)
1351 get_device(&dev->dev);
1352 return dev;
1353}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001354EXPORT_SYMBOL(pci_dev_get);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355
1356/**
1357 * pci_dev_put - release a use of the pci device structure
1358 * @dev: device that's been disconnected
1359 *
1360 * Must be called when a user of a device is finished with it. When the last
1361 * user of the device calls this function, the memory of the device is freed.
1362 */
1363void pci_dev_put(struct pci_dev *dev)
1364{
1365 if (dev)
1366 put_device(&dev->dev);
1367}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001368EXPORT_SYMBOL(pci_dev_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369
Bill Pemberton8ccc9aa2012-11-21 15:34:58 -05001370static int pci_uevent(struct device *dev, struct kobj_uevent_env *env)
1371{
1372 struct pci_dev *pdev;
1373
1374 if (!dev)
1375 return -ENODEV;
1376
1377 pdev = to_pci_dev(dev);
Bill Pemberton8ccc9aa2012-11-21 15:34:58 -05001378
1379 if (add_uevent_var(env, "PCI_CLASS=%04X", pdev->class))
1380 return -ENOMEM;
1381
1382 if (add_uevent_var(env, "PCI_ID=%04X:%04X", pdev->vendor, pdev->device))
1383 return -ENOMEM;
1384
1385 if (add_uevent_var(env, "PCI_SUBSYS_ID=%04X:%04X", pdev->subsystem_vendor,
1386 pdev->subsystem_device))
1387 return -ENOMEM;
1388
1389 if (add_uevent_var(env, "PCI_SLOT_NAME=%s", pci_name(pdev)))
1390 return -ENOMEM;
1391
1392 if (add_uevent_var(env, "MODALIAS=pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02x",
1393 pdev->vendor, pdev->device,
1394 pdev->subsystem_vendor, pdev->subsystem_device,
1395 (u8)(pdev->class >> 16), (u8)(pdev->class >> 8),
1396 (u8)(pdev->class)))
1397 return -ENOMEM;
Bjorn Helgaasefdd4072014-04-05 15:08:22 -06001398
Bill Pemberton8ccc9aa2012-11-21 15:34:58 -05001399 return 0;
1400}
1401
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402struct bus_type pci_bus_type = {
1403 .name = "pci",
1404 .match = pci_bus_match,
Kay Sievers312c0042005-11-16 09:00:00 +01001405 .uevent = pci_uevent,
Russell Kingb15d6862006-01-05 14:30:22 +00001406 .probe = pci_device_probe,
1407 .remove = pci_device_remove,
Linus Torvaldscbd69db2006-06-24 14:50:29 -07001408 .shutdown = pci_device_shutdown,
Greg Kroah-Hartman5136b2d2013-10-06 23:55:40 -07001409 .dev_groups = pci_dev_groups,
Greg Kroah-Hartman0f49ba52013-10-07 14:51:02 -06001410 .bus_groups = pci_bus_groups,
Greg Kroah-Hartman2229c1f2013-10-07 14:51:20 -06001411 .drv_groups = pci_drv_groups,
Rafael J. Wysockibbb44d92008-05-20 00:49:04 +02001412 .pm = PCI_PM_OPS_PTR,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413};
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001414EXPORT_SYMBOL(pci_bus_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415
1416static int __init pci_driver_init(void)
1417{
1418 return bus_register(&pci_bus_type);
1419}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420postcore_initcall(pci_driver_init);