pci-driver.c 41.9 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0
L
Linus Torvalds 已提交
2
/*
3 4
 * (C) Copyright 2002-2004, 2007 Greg Kroah-Hartman <greg@kroah.com>
 * (C) Copyright 2007 Novell Inc.
L
Linus Torvalds 已提交
5 6 7 8 9 10
 */

#include <linux/pci.h>
#include <linux/module.h>
#include <linux/init.h>
#include <linux/device.h>
11
#include <linux/mempolicy.h>
T
Tim Schmielau 已提交
12 13
#include <linux/string.h>
#include <linux/slab.h>
14
#include <linux/sched.h>
15
#include <linux/cpu.h>
16
#include <linux/pm_runtime.h>
17
#include <linux/suspend.h>
18
#include <linux/kexec.h>
19 20
#include <linux/of_device.h>
#include <linux/acpi.h>
L
Linus Torvalds 已提交
21
#include "pci.h"
22
#include "pcie/portdrv.h"
L
Linus Torvalds 已提交
23

24 25 26 27
struct pci_dynid {
	struct list_head node;
	struct pci_device_id id;
};
L
Linus Torvalds 已提交
28

T
Tejun Heo 已提交
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
/**
 * pci_add_dynid - add a new PCI device ID to this driver and re-probe devices
 * @drv: target pci driver
 * @vendor: PCI vendor ID
 * @device: PCI device ID
 * @subvendor: PCI subvendor ID
 * @subdevice: PCI subdevice ID
 * @class: PCI class
 * @class_mask: PCI class mask
 * @driver_data: private driver data
 *
 * Adds a new dynamic pci device ID to this driver and causes the
 * driver to probe for all devices again.  @drv must have been
 * registered prior to calling this function.
 *
 * CONTEXT:
 * Does GFP_KERNEL allocation.
 *
 * RETURNS:
 * 0 on success, -errno on failure.
 */
int pci_add_dynid(struct pci_driver *drv,
		  unsigned int vendor, unsigned int device,
		  unsigned int subvendor, unsigned int subdevice,
		  unsigned int class, unsigned int class_mask,
		  unsigned long driver_data)
{
	struct pci_dynid *dynid;

	dynid = kzalloc(sizeof(*dynid), GFP_KERNEL);
	if (!dynid)
		return -ENOMEM;

	dynid->id.vendor = vendor;
	dynid->id.device = device;
	dynid->id.subvendor = subvendor;
	dynid->id.subdevice = subdevice;
	dynid->id.class = class;
	dynid->id.class_mask = class_mask;
	dynid->id.driver_data = driver_data;
69

T
Tejun Heo 已提交
70 71 72 73
	spin_lock(&drv->dynids.lock);
	list_add_tail(&dynid->node, &drv->dynids.list);
	spin_unlock(&drv->dynids.lock);

74
	return driver_attach(&drv->driver);
T
Tejun Heo 已提交
75
}
76
EXPORT_SYMBOL_GPL(pci_add_dynid);
T
Tejun Heo 已提交
77 78 79 80

static void pci_free_dynids(struct pci_driver *drv)
{
	struct pci_dynid *dynid, *n;
81

T
Tejun Heo 已提交
82 83 84 85 86 87 88 89
	spin_lock(&drv->dynids.lock);
	list_for_each_entry_safe(dynid, n, &drv->dynids.list, node) {
		list_del(&dynid->node);
		kfree(dynid);
	}
	spin_unlock(&drv->dynids.lock);
}

L
Linus Torvalds 已提交
90
/**
T
Tejun Heo 已提交
91
 * store_new_id - sysfs frontend to pci_add_dynid()
R
Randy Dunlap 已提交
92 93 94
 * @driver: target device driver
 * @buf: buffer for scanning device ID data
 * @count: input size
L
Linus Torvalds 已提交
95
 *
T
Tejun Heo 已提交
96
 * Allow PCI IDs to be added to an existing driver via sysfs.
L
Linus Torvalds 已提交
97
 */
98
static ssize_t new_id_store(struct device_driver *driver, const char *buf,
R
Ryan Desfosses 已提交
99
			    size_t count)
L
Linus Torvalds 已提交
100 101
{
	struct pci_driver *pdrv = to_pci_driver(driver);
102
	const struct pci_device_id *ids = pdrv->id_table;
103
	u32 vendor, device, subvendor = PCI_ANY_ID,
R
Ryan Desfosses 已提交
104 105 106
		subdevice = PCI_ANY_ID, class = 0, class_mask = 0;
	unsigned long driver_data = 0;
	int fields = 0;
107
	int retval = 0;
L
Linus Torvalds 已提交
108

109
	fields = sscanf(buf, "%x %x %x %x %x %x %lx",
L
Linus Torvalds 已提交
110 111
			&vendor, &device, &subvendor, &subdevice,
			&class, &class_mask, &driver_data);
112
	if (fields < 2)
L
Linus Torvalds 已提交
113 114
		return -EINVAL;

115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
	if (fields != 7) {
		struct pci_dev *pdev = kzalloc(sizeof(*pdev), GFP_KERNEL);
		if (!pdev)
			return -ENOMEM;

		pdev->vendor = vendor;
		pdev->device = device;
		pdev->subsystem_vendor = subvendor;
		pdev->subsystem_device = subdevice;
		pdev->class = class;

		if (pci_match_id(pdrv->id_table, pdev))
			retval = -EEXIST;

		kfree(pdev);

		if (retval)
			return retval;
	}

135 136
	/* Only accept driver_data values that match an existing id_table
	   entry */
137 138 139 140 141 142 143 144
	if (ids) {
		retval = -EINVAL;
		while (ids->vendor || ids->subvendor || ids->class_mask) {
			if (driver_data == ids->driver_data) {
				retval = 0;
				break;
			}
			ids++;
145
		}
146 147
		if (retval)	/* No match */
			return retval;
148 149
	}

T
Tejun Heo 已提交
150 151
	retval = pci_add_dynid(pdrv, vendor, device, subvendor, subdevice,
			       class, class_mask, driver_data);
152 153
	if (retval)
		return retval;
L
Linus Torvalds 已提交
154 155
	return count;
}
156
static DRIVER_ATTR_WO(new_id);
L
Linus Torvalds 已提交
157

C
Chris Wright 已提交
158 159 160 161 162 163 164 165
/**
 * store_remove_id - remove a PCI device ID from this driver
 * @driver: target device driver
 * @buf: buffer for scanning device ID data
 * @count: input size
 *
 * Removes a dynamic pci device ID to this driver.
 */
166
static ssize_t remove_id_store(struct device_driver *driver, const char *buf,
R
Ryan Desfosses 已提交
167
			       size_t count)
C
Chris Wright 已提交
168 169 170
{
	struct pci_dynid *dynid, *n;
	struct pci_driver *pdrv = to_pci_driver(driver);
171
	u32 vendor, device, subvendor = PCI_ANY_ID,
C
Chris Wright 已提交
172 173
		subdevice = PCI_ANY_ID, class = 0, class_mask = 0;
	int fields = 0;
174
	size_t retval = -ENODEV;
C
Chris Wright 已提交
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191

	fields = sscanf(buf, "%x %x %x %x %x %x",
			&vendor, &device, &subvendor, &subdevice,
			&class, &class_mask);
	if (fields < 2)
		return -EINVAL;

	spin_lock(&pdrv->dynids.lock);
	list_for_each_entry_safe(dynid, n, &pdrv->dynids.list, node) {
		struct pci_device_id *id = &dynid->id;
		if ((id->vendor == vendor) &&
		    (id->device == device) &&
		    (subvendor == PCI_ANY_ID || id->subvendor == subvendor) &&
		    (subdevice == PCI_ANY_ID || id->subdevice == subdevice) &&
		    !((id->class ^ class) & class_mask)) {
			list_del(&dynid->node);
			kfree(dynid);
192
			retval = count;
C
Chris Wright 已提交
193 194 195 196 197
			break;
		}
	}
	spin_unlock(&pdrv->dynids.lock);

198
	return retval;
C
Chris Wright 已提交
199
}
200
static DRIVER_ATTR_WO(remove_id);
C
Chris Wright 已提交
201

202 203 204 205
static struct attribute *pci_drv_attrs[] = {
	&driver_attr_new_id.attr,
	&driver_attr_remove_id.attr,
	NULL,
206
};
207
ATTRIBUTE_GROUPS(pci_drv);
C
Chris Wright 已提交
208

L
Linus Torvalds 已提交
209
/**
210
 * pci_match_id - See if a pci device matches a given pci_id table
L
Linus Torvalds 已提交
211
 * @ids: array of PCI device id structures to search in
212 213
 * @dev: the PCI device structure to match against.
 *
L
Linus Torvalds 已提交
214
 * Used by a driver to check whether a PCI device present in the
215
 * system is in its list of supported devices.  Returns the matching
L
Linus Torvalds 已提交
216
 * pci_device_id structure or %NULL if there is no match.
217
 *
R
Randy Dunlap 已提交
218
 * Deprecated, don't use this as it will not catch any dynamic ids
219
 * that a driver might want to check for.
L
Linus Torvalds 已提交
220
 */
221 222
const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
					 struct pci_dev *dev)
L
Linus Torvalds 已提交
223
{
224 225 226 227 228 229
	if (ids) {
		while (ids->vendor || ids->subvendor || ids->class_mask) {
			if (pci_match_one_device(ids, dev))
				return ids;
			ids++;
		}
L
Linus Torvalds 已提交
230 231 232
	}
	return NULL;
}
233
EXPORT_SYMBOL(pci_match_id);
L
Linus Torvalds 已提交
234

235 236 237 238 239 240 241
static const struct pci_device_id pci_device_id_any = {
	.vendor = PCI_ANY_ID,
	.device = PCI_ANY_ID,
	.subvendor = PCI_ANY_ID,
	.subdevice = PCI_ANY_ID,
};

L
Linus Torvalds 已提交
242
/**
R
Randy Dunlap 已提交
243
 * pci_match_device - Tell if a PCI device structure has a matching PCI device id structure
244
 * @drv: the PCI driver to match against
245
 * @dev: the PCI device structure to match against
246 247 248 249
 *
 * Used by a driver to check whether a PCI device present in the
 * system is in its list of supported devices.  Returns the matching
 * pci_device_id structure or %NULL if there is no match.
L
Linus Torvalds 已提交
250
 */
A
Adrian Bunk 已提交
251 252
static const struct pci_device_id *pci_match_device(struct pci_driver *drv,
						    struct pci_dev *dev)
253 254
{
	struct pci_dynid *dynid;
255 256 257 258 259
	const struct pci_device_id *found_id = NULL;

	/* When driver_override is set, only bind to the matching driver */
	if (dev->driver_override && strcmp(dev->driver_override, drv->name))
		return NULL;
L
Linus Torvalds 已提交
260

261
	/* Look at the dynamic ids first, before the static ones */
262 263 264
	spin_lock(&drv->dynids.lock);
	list_for_each_entry(dynid, &drv->dynids.list, node) {
		if (pci_match_one_device(&dynid->id, dev)) {
265 266
			found_id = &dynid->id;
			break;
267
		}
L
Linus Torvalds 已提交
268
	}
269
	spin_unlock(&drv->dynids.lock);
270

271 272 273 274 275 276 277 278
	if (!found_id)
		found_id = pci_match_id(drv->id_table, dev);

	/* driver_override will always match, send a dummy id */
	if (!found_id && dev->driver_override)
		found_id = &pci_device_id_any;

	return found_id;
L
Linus Torvalds 已提交
279 280
}

281 282 283 284 285 286 287 288 289
struct drv_dev_and_id {
	struct pci_driver *drv;
	struct pci_dev *dev;
	const struct pci_device_id *id;
};

static long local_pci_probe(void *_ddi)
{
	struct drv_dev_and_id *ddi = _ddi;
290 291 292
	struct pci_dev *pci_dev = ddi->dev;
	struct pci_driver *pci_drv = ddi->drv;
	struct device *dev = &pci_dev->dev;
293 294
	int rc;

295 296 297 298
	/*
	 * Unbound PCI devices are always put in D0, regardless of
	 * runtime PM status.  During probe, the device is set to
	 * active and the usage count is incremented.  If the driver
299 300 301 302
	 * supports runtime PM, it should call pm_runtime_put_noidle(),
	 * or any other runtime PM helper function decrementing the usage
	 * count, in its probe routine and pm_runtime_get_noresume() in
	 * its remove routine.
303
	 */
304 305 306
	pm_runtime_get_sync(dev);
	pci_dev->driver = pci_drv;
	rc = pci_drv->probe(pci_dev, ddi->id);
307 308 309
	if (!rc)
		return rc;
	if (rc < 0) {
310 311
		pci_dev->driver = NULL;
		pm_runtime_put_sync(dev);
312
		return rc;
313
	}
314 315 316 317
	/*
	 * Probe function should return < 0 for failure, 0 for success
	 * Treat values > 0 as success, but warn.
	 */
318 319
	pci_warn(pci_dev, "Driver probe function unexpectedly returned %d\n",
		 rc);
320
	return 0;
321 322
}

323 324 325 326 327 328 329 330 331
static bool pci_physfn_is_probed(struct pci_dev *dev)
{
#ifdef CONFIG_PCI_IOV
	return dev->is_virtfn && dev->physfn->is_probed;
#else
	return false;
#endif
}

332 333 334
static int pci_call_probe(struct pci_driver *drv, struct pci_dev *dev,
			  const struct pci_device_id *id)
{
335
	int error, node, cpu;
336 337
	struct drv_dev_and_id ddi = { drv, dev, id };

338 339 340 341 342
	/*
	 * Execute driver initialization on node where the device is
	 * attached.  This way the driver likely allocates its local memory
	 * on the right node.
	 */
343
	node = dev_to_node(&dev->dev);
344 345 346
	dev->is_probed = 1;

	cpu_hotplug_disable();
347 348

	/*
349 350
	 * Prevent nesting work_on_cpu() for the case where a Virtual Function
	 * device is probed from work_on_cpu() of the Physical device.
351
	 */
352 353 354 355
	if (node < 0 || node >= MAX_NUMNODES || !node_online(node) ||
	    pci_physfn_is_probed(dev))
		cpu = nr_cpu_ids;
	else
356
		cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask);
357 358 359 360

	if (cpu < nr_cpu_ids)
		error = work_on_cpu(cpu, local_pci_probe, &ddi);
	else
361
		error = local_pci_probe(&ddi);
362

363 364
	dev->is_probed = 0;
	cpu_hotplug_enable();
365 366 367
	return error;
}

L
Linus Torvalds 已提交
368
/**
369
 * __pci_device_probe - check if a driver wants to claim a specific PCI device
R
Randy Dunlap 已提交
370 371
 * @drv: driver to call to check if it wants the PCI device
 * @pci_dev: PCI device being probed
372
 *
R
Randy Dunlap 已提交
373
 * returns 0 on success, else error.
L
Linus Torvalds 已提交
374 375
 * side-effect: pci_dev->driver is set to drv when drv claims pci_dev.
 */
R
Ryan Desfosses 已提交
376
static int __pci_device_probe(struct pci_driver *drv, struct pci_dev *pci_dev)
377 378
{
	const struct pci_device_id *id;
L
Linus Torvalds 已提交
379 380 381
	int error = 0;

	if (!pci_dev->driver && drv->probe) {
382 383 384 385
		error = -ENODEV;

		id = pci_match_device(drv, pci_dev);
		if (id)
386
			error = pci_call_probe(drv, pci_dev, id);
L
Linus Torvalds 已提交
387 388 389 390
	}
	return error;
}

391 392 393 394 395 396 397 398 399
int __weak pcibios_alloc_irq(struct pci_dev *dev)
{
	return 0;
}

void __weak pcibios_free_irq(struct pci_dev *dev)
{
}

400 401 402
#ifdef CONFIG_PCI_IOV
static inline bool pci_device_can_probe(struct pci_dev *pdev)
{
403 404
	return (!pdev->is_virtfn || pdev->physfn->sriov->drivers_autoprobe ||
		pdev->driver_override);
405 406 407 408 409 410 411 412
}
#else
static inline bool pci_device_can_probe(struct pci_dev *pdev)
{
	return true;
}
#endif

R
Ryan Desfosses 已提交
413
static int pci_device_probe(struct device *dev)
L
Linus Torvalds 已提交
414
{
415 416 417 418
	int error;
	struct pci_dev *pci_dev = to_pci_dev(dev);
	struct pci_driver *drv = to_pci_driver(dev->driver);

419 420 421
	if (!pci_device_can_probe(pci_dev))
		return -ENODEV;

422 423
	pci_assign_irq(pci_dev);

424 425 426
	error = pcibios_alloc_irq(pci_dev);
	if (error < 0)
		return error;
L
Linus Torvalds 已提交
427 428

	pci_dev_get(pci_dev);
429 430 431 432
	error = __pci_device_probe(drv, pci_dev);
	if (error) {
		pcibios_free_irq(pci_dev);
		pci_dev_put(pci_dev);
433
	}
L
Linus Torvalds 已提交
434 435 436 437

	return error;
}

R
Ryan Desfosses 已提交
438
static int pci_device_remove(struct device *dev)
L
Linus Torvalds 已提交
439
{
R
Ryan Desfosses 已提交
440 441
	struct pci_dev *pci_dev = to_pci_dev(dev);
	struct pci_driver *drv = pci_dev->driver;
L
Linus Torvalds 已提交
442 443

	if (drv) {
444 445
		if (drv->remove) {
			pm_runtime_get_sync(dev);
L
Linus Torvalds 已提交
446
			drv->remove(pci_dev);
447 448
			pm_runtime_put_noidle(dev);
		}
449
		pcibios_free_irq(pci_dev);
L
Linus Torvalds 已提交
450
		pci_dev->driver = NULL;
451
		pci_iov_remove(pci_dev);
L
Linus Torvalds 已提交
452 453
	}

454
	/* Undo the runtime PM settings in local_pci_probe() */
455
	pm_runtime_put_sync(dev);
456

457 458 459 460 461 462 463
	/*
	 * If the device is still on, set the power state as "unknown",
	 * since it might change by the next time we load the driver.
	 */
	if (pci_dev->current_state == PCI_D0)
		pci_dev->current_state = PCI_UNKNOWN;

L
Linus Torvalds 已提交
464 465 466 467
	/*
	 * We would love to complain here if pci_dev->is_enabled is set, that
	 * the driver should have called pci_disable_device(), but the
	 * unfortunate fact is there are too many odd BIOS and bridge setups
468
	 * that don't like drivers doing that all of the time.
L
Linus Torvalds 已提交
469 470 471 472 473 474 475 476
	 * Oh well, we can dream of sane hardware when we sleep, no matter how
	 * horrible the crap we have to deal with is when we are awake...
	 */

	pci_dev_put(pci_dev);
	return 0;
}

477 478 479 480 481
static void pci_device_shutdown(struct device *dev)
{
	struct pci_dev *pci_dev = to_pci_dev(dev);
	struct pci_driver *drv = pci_dev->driver;

H
Huang Ying 已提交
482 483
	pm_runtime_resume(dev);

484 485
	if (drv && drv->shutdown)
		drv->shutdown(pci_dev);
486

487
	/*
488 489 490 491 492
	 * If this is a kexec reboot, turn off Bus Master bit on the
	 * device to tell it to not continue to do DMA. Don't touch
	 * devices in D3cold or unknown states.
	 * If it is not a kexec reboot, firmware will hit the PCI
	 * devices with big hammer and stop their DMA any way.
493
	 */
494
	if (kexec_in_progress && (pci_dev->current_state <= PCI_D3hot))
495
		pci_clear_master(pci_dev);
496 497
}

R
Rafael J. Wysocki 已提交
498
#ifdef CONFIG_PM
499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515

/* Auxiliary functions used for system resume and run-time resume. */

/**
 * pci_restore_standard_config - restore standard config registers of PCI device
 * @pci_dev: PCI device to handle
 */
static int pci_restore_standard_config(struct pci_dev *pci_dev)
{
	pci_update_current_state(pci_dev, PCI_UNKNOWN);

	if (pci_dev->current_state != PCI_D0) {
		int error = pci_set_power_state(pci_dev, PCI_D0);
		if (error)
			return error;
	}

516
	pci_restore_state(pci_dev);
517
	pci_pme_restore(pci_dev);
518
	return 0;
519 520
}

521 522 523 524 525 526
static void pci_pm_default_resume(struct pci_dev *pci_dev)
{
	pci_fixup_device(pci_fixup_resume, pci_dev);
	pci_enable_wake(pci_dev, PCI_D0, false);
}

527 528 529 530
#endif

#ifdef CONFIG_PM_SLEEP

531 532
static void pci_pm_default_resume_early(struct pci_dev *pci_dev)
{
533 534
	pci_power_up(pci_dev);
	pci_restore_state(pci_dev);
535
	pci_pme_restore(pci_dev);
536 537
}

538 539 540
/*
 * Default "suspend" method for devices that have no driver provided suspend,
 * or not even a driver at all (second part).
541
 */
542
static void pci_pm_set_unknown_state(struct pci_dev *pci_dev)
543 544 545 546 547 548 549 550 551
{
	/*
	 * mark its power state as "unknown", since we don't know if
	 * e.g. the BIOS will change its device state when we suspend.
	 */
	if (pci_dev->current_state == PCI_D0)
		pci_dev->current_state = PCI_UNKNOWN;
}

552 553 554 555
/*
 * Default "resume" method for devices that have no driver provided resume,
 * or not even a driver at all (second part).
 */
556
static int pci_pm_reenable_device(struct pci_dev *pci_dev)
557 558 559
{
	int retval;

560 561 562 563 564 565 566 567 568 569 570 571 572
	/* if the device was enabled before suspend, reenable */
	retval = pci_reenable_device(pci_dev);
	/*
	 * if the device was busmaster before the suspend, make it busmaster
	 * again
	 */
	if (pci_dev->is_busmaster)
		pci_set_master(pci_dev);

	return retval;
}

static int pci_legacy_suspend(struct device *dev, pm_message_t state)
L
Linus Torvalds 已提交
573
{
R
Ryan Desfosses 已提交
574 575
	struct pci_dev *pci_dev = to_pci_dev(dev);
	struct pci_driver *drv = pci_dev->driver;
576

577
	if (drv && drv->suspend) {
578
		pci_power_t prev = pci_dev->current_state;
579
		int error;
580

581 582 583 584
		error = drv->suspend(pci_dev, state);
		suspend_report_result(drv->suspend, error);
		if (error)
			return error;
585

586
		if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
587
		    && pci_dev->current_state != PCI_UNKNOWN) {
588 589 590
			pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev,
				      "PCI PM: Device state not saved by %pS\n",
				      drv->suspend);
591
		}
592
	}
593 594 595

	pci_fixup_device(pci_fixup_suspend, pci_dev);

596
	return 0;
L
Linus Torvalds 已提交
597 598
}

599
static int pci_legacy_suspend_late(struct device *dev, pm_message_t state)
L
Linus Torvalds 已提交
600
{
R
Ryan Desfosses 已提交
601
	struct pci_dev *pci_dev = to_pci_dev(dev);
602 603 604 605 606 607

	if (!pci_dev->state_saved)
		pci_save_state(pci_dev);

	pci_pm_set_unknown_state(pci_dev);

608 609
	pci_fixup_device(pci_fixup_suspend_late, pci_dev);

610
	return 0;
L
Linus Torvalds 已提交
611
}
L
Linus Torvalds 已提交
612

613
static int pci_legacy_resume(struct device *dev)
L
Linus Torvalds 已提交
614
{
R
Ryan Desfosses 已提交
615 616
	struct pci_dev *pci_dev = to_pci_dev(dev);
	struct pci_driver *drv = pci_dev->driver;
L
Linus Torvalds 已提交
617

618 619
	pci_fixup_device(pci_fixup_resume, pci_dev);

620 621
	return drv && drv->resume ?
			drv->resume(pci_dev) : pci_pm_reenable_device(pci_dev);
L
Linus Torvalds 已提交
622 623
}

624 625
/* Auxiliary functions used by the new power management framework */

626
static void pci_pm_default_suspend(struct pci_dev *pci_dev)
627
{
628
	/* Disable non-bridge devices without PM support */
629
	if (!pci_has_subordinate(pci_dev))
630
		pci_disable_enabled_device(pci_dev);
631 632
}

633 634 635
static bool pci_has_legacy_pm_support(struct pci_dev *pci_dev)
{
	struct pci_driver *drv = pci_dev->driver;
636
	bool ret = drv && (drv->suspend || drv->resume);
637 638 639 640 641 642

	/*
	 * Legacy PM support is used by default, so warn if the new framework is
	 * supported as well.  Drivers are supposed to support either the
	 * former, or the latter, but not both at the same time.
	 */
643 644
	pci_WARN(pci_dev, ret && drv->driver.pm, "device %04x:%04x\n",
		 pci_dev->vendor, pci_dev->device);
645 646

	return ret;
647 648
}

649 650
/* New power management framework */

651 652
static int pci_pm_prepare(struct device *dev)
{
653
	struct pci_dev *pci_dev = to_pci_dev(dev);
654
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
655

656 657
	if (pm && pm->prepare) {
		int error = pm->prepare(dev);
658
		if (error < 0)
659
			return error;
660 661 662

		if (!error && dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_PREPARE))
			return 0;
663
	}
664 665 666 667 668 669 670 671 672
	if (pci_dev_need_resume(pci_dev))
		return 0;

	/*
	 * The PME setting needs to be adjusted here in case the direct-complete
	 * optimization is used with respect to this device.
	 */
	pci_dev_adjust_pme(pci_dev);
	return 1;
673 674
}

675 676
static void pci_pm_complete(struct device *dev)
{
677 678 679 680 681 682
	struct pci_dev *pci_dev = to_pci_dev(dev);

	pci_dev_complete_resume(pci_dev);
	pm_generic_complete(dev);

	/* Resume device if platform firmware has put it in reset-power-on */
683
	if (pm_runtime_suspended(dev) && pm_resume_via_firmware()) {
684 685
		pci_power_t pre_sleep_state = pci_dev->current_state;

686 687 688 689 690 691 692 693
		pci_refresh_power_state(pci_dev);
		/*
		 * On platforms with ACPI this check may also trigger for
		 * devices sharing power resources if one of those power
		 * resources has been activated as a result of a change of the
		 * power state of another device sharing it.  However, in that
		 * case it is also better to resume the device, in general.
		 */
694 695 696
		if (pci_dev->current_state < pre_sleep_state)
			pm_request_resume(dev);
	}
697
}
698

699 700 701
#else /* !CONFIG_PM_SLEEP */

#define pci_pm_prepare	NULL
702
#define pci_pm_complete	NULL
703 704 705

#endif /* !CONFIG_PM_SLEEP */

706
#ifdef CONFIG_SUSPEND
707 708 709 710 711 712 713 714
static void pcie_pme_root_status_cleanup(struct pci_dev *pci_dev)
{
	/*
	 * Some BIOSes forget to clear Root PME Status bits after system
	 * wakeup, which breaks ACPI-based runtime wakeup on PCI Express.
	 * Clear those bits now just in case (shouldn't hurt).
	 */
	if (pci_is_pcie(pci_dev) &&
715 716
	    (pci_pcie_type(pci_dev) == PCI_EXP_TYPE_ROOT_PORT ||
	     pci_pcie_type(pci_dev) == PCI_EXP_TYPE_RC_EC))
717 718
		pcie_clear_root_pme_status(pci_dev);
}
719 720 721 722

static int pci_pm_suspend(struct device *dev)
{
	struct pci_dev *pci_dev = to_pci_dev(dev);
723
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
724

725 726
	pci_dev->skip_bus_pm = false;

727 728
	if (pci_has_legacy_pm_support(pci_dev))
		return pci_legacy_suspend(dev, PMSG_SUSPEND);
729

730 731
	if (!pm) {
		pci_pm_default_suspend(pci_dev);
732
		return 0;
733 734
	}

735
	/*
736 737 738 739 740 741 742 743 744 745 746
	 * PCI devices suspended at run time may need to be resumed at this
	 * point, because in general it may be necessary to reconfigure them for
	 * system suspend.  Namely, if the device is expected to wake up the
	 * system from the sleep state, it may have to be reconfigured for this
	 * purpose, or if the device is not expected to wake up the system from
	 * the sleep state, it should be prevented from signaling wakeup events
	 * going forward.
	 *
	 * Also if the driver of the device does not indicate that its system
	 * suspend callbacks can cope with runtime-suspended devices, it is
	 * better to resume the device from runtime suspend here.
747
	 */
748
	if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
749
	    pci_dev_need_resume(pci_dev)) {
750
		pm_runtime_resume(dev);
751
		pci_dev->state_saved = false;
752 753
	} else {
		pci_dev_adjust_pme(pci_dev);
754
	}
755

756 757 758 759
	if (pm->suspend) {
		pci_power_t prev = pci_dev->current_state;
		int error;

760 761
		error = pm->suspend(dev);
		suspend_report_result(pm->suspend, error);
762 763 764
		if (error)
			return error;

765
		if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
766
		    && pci_dev->current_state != PCI_UNKNOWN) {
767 768 769
			pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev,
				      "PCI PM: State of device not saved by %pS\n",
				      pm->suspend);
770
		}
771
	}
772

773
	return 0;
774 775
}

776 777 778 779 780 781 782 783 784 785
static int pci_pm_suspend_late(struct device *dev)
{
	if (dev_pm_smart_suspend_and_suspended(dev))
		return 0;

	pci_fixup_device(pci_fixup_suspend, to_pci_dev(dev));

	return pm_generic_suspend_late(dev);
}

786
static int pci_pm_suspend_noirq(struct device *dev)
G
Greg KH 已提交
787
{
788
	struct pci_dev *pci_dev = to_pci_dev(dev);
789
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
G
Greg KH 已提交
790

791 792
	if (dev_pm_smart_suspend_and_suspended(dev)) {
		dev->power.may_skip_resume = true;
793
		return 0;
794
	}
795

796 797 798
	if (pci_has_legacy_pm_support(pci_dev))
		return pci_legacy_suspend_late(dev, PMSG_SUSPEND);

799 800
	if (!pm) {
		pci_save_state(pci_dev);
801
		goto Fixup;
802
	}
803 804 805 806 807 808 809 810 811 812 813 814

	if (pm->suspend_noirq) {
		pci_power_t prev = pci_dev->current_state;
		int error;

		error = pm->suspend_noirq(dev);
		suspend_report_result(pm->suspend_noirq, error);
		if (error)
			return error;

		if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
		    && pci_dev->current_state != PCI_UNKNOWN) {
815 816 817
			pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev,
				      "PCI PM: State of device not saved by %pS\n",
				      pm->suspend_noirq);
818
			goto Fixup;
819
		}
820 821
	}

822 823
	if (pci_dev->skip_bus_pm) {
		/*
824 825
		 * Either the device is a bridge with a child in D0 below it, or
		 * the function is running for the second time in a row without
826
		 * going through full resume, which is possible only during
827 828 829
		 * suspend-to-idle in a spurious wakeup case.  The device should
		 * be in D0 at this point, but if it is a bridge, it may be
		 * necessary to save its state.
830
		 */
831 832 833
		if (!pci_dev->state_saved)
			pci_save_state(pci_dev);
	} else if (!pci_dev->state_saved) {
834
		pci_save_state(pci_dev);
835
		if (pci_power_manageable(pci_dev))
836 837
			pci_prepare_to_sleep(pci_dev);
	}
838

839
	pci_dbg(pci_dev, "PCI PM: Suspend power state: %s\n",
840 841
		pci_power_name(pci_dev->current_state));

842 843 844 845 846 847 848 849 850 851 852
	if (pci_dev->current_state == PCI_D0) {
		pci_dev->skip_bus_pm = true;
		/*
		 * Per PCI PM r1.2, table 6-1, a bridge must be in D0 if any
		 * downstream device is in D0, so avoid changing the power state
		 * of the parent bridge by setting the skip_bus_pm flag for it.
		 */
		if (pci_dev->bus->self)
			pci_dev->bus->self->skip_bus_pm = true;
	}

853
	if (pci_dev->skip_bus_pm && pm_suspend_no_platform()) {
854
		pci_dbg(pci_dev, "PCI PM: Skipped\n");
855 856 857
		goto Fixup;
	}

858 859
	pci_pm_set_unknown_state(pci_dev);

860 861 862 863 864 865 866 867 868 869 870 871
	/*
	 * Some BIOSes from ASUS have a bug: If a USB EHCI host controller's
	 * PCI COMMAND register isn't 0, the BIOS assumes that the controller
	 * hasn't been quiesced and tries to turn it off.  If the controller
	 * is already in D3, this can hang or cause memory corruption.
	 *
	 * Since the value of the COMMAND register doesn't matter once the
	 * device has been suspended, we can safely set it to 0 here.
	 */
	if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
		pci_write_config_word(pci_dev, PCI_COMMAND, 0);

872 873 874
Fixup:
	pci_fixup_device(pci_fixup_suspend_late, pci_dev);

875 876 877 878 879 880 881 882 883 884
	/*
	 * If the target system sleep state is suspend-to-idle, it is sufficient
	 * to check whether or not the device's wakeup settings are good for
	 * runtime PM.  Otherwise, the pm_resume_via_firmware() check will cause
	 * pci_pm_complete() to take care of fixing up the device's state
	 * anyway, if need be.
	 */
	dev->power.may_skip_resume = device_may_wakeup(dev) ||
					!device_can_wakeup(dev);

885
	return 0;
G
Greg KH 已提交
886
}
L
Linus Torvalds 已提交
887

888
static int pci_pm_resume_noirq(struct device *dev)
889 890
{
	struct pci_dev *pci_dev = to_pci_dev(dev);
891
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
892

893 894 895
	if (dev_pm_may_skip_resume(dev))
		return 0;

896 897 898 899 900 901 902 903
	/*
	 * Devices with DPM_FLAG_SMART_SUSPEND may be left in runtime suspend
	 * during system suspend, so update their runtime PM status to "active"
	 * as they are going to be put into D0 shortly.
	 */
	if (dev_pm_smart_suspend_and_suspended(dev))
		pm_runtime_set_active(dev);

904 905 906
	/*
	 * In the suspend-to-idle case, devices left in D0 during suspend will
	 * stay in D0, so it is not necessary to restore or update their
907 908
	 * configuration here and attempting to put them into D0 again is
	 * pointless, so avoid doing that.
909
	 */
910
	if (!(pci_dev->skip_bus_pm && pm_suspend_no_platform()))
911 912 913
		pci_pm_default_resume_early(pci_dev);

	pci_fixup_device(pci_fixup_resume_early, pci_dev);
914
	pcie_pme_root_status_cleanup(pci_dev);
915

916
	if (pci_has_legacy_pm_support(pci_dev))
917
		return 0;
918

919 920
	if (pm && pm->resume_noirq)
		return pm->resume_noirq(dev);
921

922
	return 0;
923 924
}

925
static int pci_pm_resume(struct device *dev)
926
{
927
	struct pci_dev *pci_dev = to_pci_dev(dev);
928
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
929

930 931 932 933 934 935 936
	/*
	 * This is necessary for the suspend error path in which resume is
	 * called without restoring the standard config registers of the device.
	 */
	if (pci_dev->state_saved)
		pci_restore_standard_config(pci_dev);

937
	if (pci_has_legacy_pm_support(pci_dev))
938
		return pci_legacy_resume(dev);
939

940
	pci_pm_default_resume(pci_dev);
941

942 943
	if (pm) {
		if (pm->resume)
944
			return pm->resume(dev);
945 946 947
	} else {
		pci_pm_reenable_device(pci_dev);
	}
948

949
	return 0;
950 951 952 953 954
}

#else /* !CONFIG_SUSPEND */

#define pci_pm_suspend		NULL
955
#define pci_pm_suspend_late	NULL
956 957 958 959 960 961
#define pci_pm_suspend_noirq	NULL
#define pci_pm_resume		NULL
#define pci_pm_resume_noirq	NULL

#endif /* !CONFIG_SUSPEND */

962
#ifdef CONFIG_HIBERNATE_CALLBACKS
963

964 965 966 967 968 969
/*
 * pcibios_pm_ops - provide arch-specific hooks when a PCI device is doing
 * a hibernate transition
 */
struct dev_pm_ops __weak pcibios_pm_ops;

970 971 972
static int pci_pm_freeze(struct device *dev)
{
	struct pci_dev *pci_dev = to_pci_dev(dev);
973
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
974

975 976
	if (pci_has_legacy_pm_support(pci_dev))
		return pci_legacy_suspend(dev, PMSG_FREEZE);
977

978 979 980
	if (!pm) {
		pci_pm_default_suspend(pci_dev);
		return 0;
981 982
	}

983
	/*
984 985 986 987 988 989
	 * Resume all runtime-suspended devices before creating a snapshot
	 * image of system memory, because the restore kernel generally cannot
	 * be expected to always handle them consistently and they need to be
	 * put into the runtime-active metastate during system resume anyway,
	 * so it is better to ensure that the state saved in the image will be
	 * always consistent with that.
990
	 */
991 992
	pm_runtime_resume(dev);
	pci_dev->state_saved = false;
993

994 995 996 997 998 999 1000 1001 1002 1003
	if (pm->freeze) {
		int error;

		error = pm->freeze(dev);
		suspend_report_result(pm->freeze, error);
		if (error)
			return error;
	}

	return 0;
1004 1005 1006 1007
}

static int pci_pm_freeze_noirq(struct device *dev)
{
1008
	struct pci_dev *pci_dev = to_pci_dev(dev);
1009
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1010

1011 1012 1013
	if (pci_has_legacy_pm_support(pci_dev))
		return pci_legacy_suspend_late(dev, PMSG_FREEZE);

1014
	if (pm && pm->freeze_noirq) {
1015 1016
		int error;

1017 1018
		error = pm->freeze_noirq(dev);
		suspend_report_result(pm->freeze_noirq, error);
1019 1020
		if (error)
			return error;
1021 1022
	}

1023 1024
	if (!pci_dev->state_saved)
		pci_save_state(pci_dev);
1025

1026 1027
	pci_pm_set_unknown_state(pci_dev);

1028 1029 1030
	if (pcibios_pm_ops.freeze_noirq)
		return pcibios_pm_ops.freeze_noirq(dev);

1031
	return 0;
1032 1033
}

1034
static int pci_pm_thaw_noirq(struct device *dev)
1035
{
1036
	struct pci_dev *pci_dev = to_pci_dev(dev);
1037 1038
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
	int error;
1039

1040 1041 1042 1043 1044 1045
	if (pcibios_pm_ops.thaw_noirq) {
		error = pcibios_pm_ops.thaw_noirq(dev);
		if (error)
			return error;
	}

1046
	/*
1047 1048
	 * The pm->thaw_noirq() callback assumes the device has been
	 * returned to D0 and its config state has been restored.
1049 1050 1051 1052 1053
	 *
	 * In addition, pci_restore_state() restores MSI-X state in MMIO
	 * space, which requires the device to be in D0, so return it to D0
	 * in case the driver's "freeze" callbacks put it into a low-power
	 * state.
1054 1055
	 */
	pci_set_power_state(pci_dev, PCI_D0);
1056
	pci_restore_state(pci_dev);
1057

1058
	if (pci_has_legacy_pm_support(pci_dev))
1059
		return 0;
1060

1061 1062
	if (pm && pm->thaw_noirq)
		return pm->thaw_noirq(dev);
1063

1064
	return 0;
1065 1066
}

1067
static int pci_pm_thaw(struct device *dev)
1068
{
1069
	struct pci_dev *pci_dev = to_pci_dev(dev);
1070
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1071 1072
	int error = 0;

1073
	if (pci_has_legacy_pm_support(pci_dev))
1074
		return pci_legacy_resume(dev);
1075

1076 1077 1078 1079 1080 1081
	if (pm) {
		if (pm->thaw)
			error = pm->thaw(dev);
	} else {
		pci_pm_reenable_device(pci_dev);
	}
1082

1083 1084
	pci_dev->state_saved = false;

1085 1086 1087 1088 1089
	return error;
}

static int pci_pm_poweroff(struct device *dev)
{
1090
	struct pci_dev *pci_dev = to_pci_dev(dev);
1091
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1092

1093 1094
	if (pci_has_legacy_pm_support(pci_dev))
		return pci_legacy_suspend(dev, PMSG_HIBERNATE);
1095

1096 1097
	if (!pm) {
		pci_pm_default_suspend(pci_dev);
1098
		return 0;
1099 1100
	}

1101
	/* The reason to do that is the same as in pci_pm_suspend(). */
1102
	if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
1103
	    pci_dev_need_resume(pci_dev)) {
1104
		pm_runtime_resume(dev);
1105 1106 1107 1108
		pci_dev->state_saved = false;
	} else {
		pci_dev_adjust_pme(pci_dev);
	}
1109

1110
	if (pm->poweroff) {
1111 1112
		int error;

1113 1114
		error = pm->poweroff(dev);
		suspend_report_result(pm->poweroff, error);
1115 1116
		if (error)
			return error;
1117 1118
	}

1119
	return 0;
1120
}
1121

1122 1123 1124 1125
static int pci_pm_poweroff_late(struct device *dev)
{
	if (dev_pm_smart_suspend_and_suspended(dev))
		return 0;
1126

1127 1128 1129
	pci_fixup_device(pci_fixup_suspend, to_pci_dev(dev));

	return pm_generic_poweroff_late(dev);
1130 1131 1132 1133
}

static int pci_pm_poweroff_noirq(struct device *dev)
{
1134
	struct pci_dev *pci_dev = to_pci_dev(dev);
1135
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1136

1137 1138 1139
	if (dev_pm_smart_suspend_and_suspended(dev))
		return 0;

1140
	if (pci_has_legacy_pm_support(pci_dev))
1141 1142
		return pci_legacy_suspend_late(dev, PMSG_HIBERNATE);

1143
	if (!pm) {
1144
		pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1145
		return 0;
1146
	}
1147

1148
	if (pm->poweroff_noirq) {
1149 1150
		int error;

1151 1152
		error = pm->poweroff_noirq(dev);
		suspend_report_result(pm->poweroff_noirq, error);
1153 1154
		if (error)
			return error;
1155 1156
	}

1157
	if (!pci_dev->state_saved && !pci_has_subordinate(pci_dev))
1158 1159
		pci_prepare_to_sleep(pci_dev);

1160 1161 1162 1163 1164 1165 1166
	/*
	 * The reason for doing this here is the same as for the analogous code
	 * in pci_pm_suspend_noirq().
	 */
	if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
		pci_write_config_word(pci_dev, PCI_COMMAND, 0);

1167 1168
	pci_fixup_device(pci_fixup_suspend_late, pci_dev);

1169 1170 1171
	if (pcibios_pm_ops.poweroff_noirq)
		return pcibios_pm_ops.poweroff_noirq(dev);

1172
	return 0;
1173 1174
}

1175
static int pci_pm_restore_noirq(struct device *dev)
1176 1177
{
	struct pci_dev *pci_dev = to_pci_dev(dev);
1178 1179
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
	int error;
1180

1181 1182 1183 1184 1185 1186
	if (pcibios_pm_ops.restore_noirq) {
		error = pcibios_pm_ops.restore_noirq(dev);
		if (error)
			return error;
	}

1187
	pci_pm_default_resume_early(pci_dev);
1188
	pci_fixup_device(pci_fixup_resume_early, pci_dev);
1189

1190
	if (pci_has_legacy_pm_support(pci_dev))
1191
		return 0;
1192

1193 1194
	if (pm && pm->restore_noirq)
		return pm->restore_noirq(dev);
1195

1196
	return 0;
1197 1198
}

1199
static int pci_pm_restore(struct device *dev)
1200 1201
{
	struct pci_dev *pci_dev = to_pci_dev(dev);
1202
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1203

1204 1205 1206 1207 1208 1209 1210
	/*
	 * This is necessary for the hibernation error path in which restore is
	 * called without restoring the standard config registers of the device.
	 */
	if (pci_dev->state_saved)
		pci_restore_standard_config(pci_dev);

1211
	if (pci_has_legacy_pm_support(pci_dev))
1212
		return pci_legacy_resume(dev);
1213

1214
	pci_pm_default_resume(pci_dev);
1215

1216 1217
	if (pm) {
		if (pm->restore)
1218
			return pm->restore(dev);
1219 1220 1221
	} else {
		pci_pm_reenable_device(pci_dev);
	}
1222

1223
	return 0;
G
Greg KH 已提交
1224
}
L
Linus Torvalds 已提交
1225

1226
#else /* !CONFIG_HIBERNATE_CALLBACKS */
1227 1228 1229 1230 1231 1232

#define pci_pm_freeze		NULL
#define pci_pm_freeze_noirq	NULL
#define pci_pm_thaw		NULL
#define pci_pm_thaw_noirq	NULL
#define pci_pm_poweroff		NULL
1233
#define pci_pm_poweroff_late	NULL
1234 1235 1236 1237
#define pci_pm_poweroff_noirq	NULL
#define pci_pm_restore		NULL
#define pci_pm_restore_noirq	NULL

1238
#endif /* !CONFIG_HIBERNATE_CALLBACKS */
1239

1240
#ifdef CONFIG_PM
1241 1242 1243 1244 1245 1246 1247 1248

static int pci_pm_runtime_suspend(struct device *dev)
{
	struct pci_dev *pci_dev = to_pci_dev(dev);
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
	pci_power_t prev = pci_dev->current_state;
	int error;

1249
	/*
1250 1251 1252
	 * If pci_dev->driver is not set (unbound), we leave the device in D0,
	 * but it may go to D3cold when the bridge above it runtime suspends.
	 * Save its config space in case that happens.
1253
	 */
1254 1255
	if (!pci_dev->driver) {
		pci_save_state(pci_dev);
1256
		return 0;
1257
	}
1258

1259
	pci_dev->state_saved = false;
1260 1261
	if (pm && pm->runtime_suspend) {
		error = pm->runtime_suspend(dev);
1262 1263 1264 1265 1266
		/*
		 * -EBUSY and -EAGAIN is used to request the runtime PM core
		 * to schedule a new suspend, so log the event only with debug
		 * log level.
		 */
1267
		if (error == -EBUSY || error == -EAGAIN) {
1268
			pci_dbg(pci_dev, "can't suspend now (%ps returned %d)\n",
1269
				pm->runtime_suspend, error);
1270 1271
			return error;
		} else if (error) {
1272
			pci_err(pci_dev, "can't suspend (%ps returned %d)\n",
1273
				pm->runtime_suspend, error);
1274 1275
			return error;
		}
1276
	}
1277 1278 1279

	pci_fixup_device(pci_fixup_suspend, pci_dev);

1280 1281
	if (pm && pm->runtime_suspend
	    && !pci_dev->state_saved && pci_dev->current_state != PCI_D0
1282
	    && pci_dev->current_state != PCI_UNKNOWN) {
1283 1284 1285
		pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev,
			      "PCI PM: State of device not saved by %pS\n",
			      pm->runtime_suspend);
1286 1287 1288
		return 0;
	}

1289
	if (!pci_dev->state_saved) {
1290
		pci_save_state(pci_dev);
1291 1292
		pci_finish_runtime_suspend(pci_dev);
	}
1293 1294 1295 1296 1297 1298 1299 1300

	return 0;
}

static int pci_pm_runtime_resume(struct device *dev)
{
	struct pci_dev *pci_dev = to_pci_dev(dev);
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1301
	int error = 0;
1302

1303
	/*
1304 1305 1306
	 * Restoring config space is necessary even if the device is not bound
	 * to a driver because although we left it in D0, it may have gone to
	 * D3cold when the bridge above it runtime suspended.
1307
	 */
1308 1309
	pci_restore_standard_config(pci_dev);

1310 1311 1312
	if (!pci_dev->driver)
		return 0;

1313
	pci_fixup_device(pci_fixup_resume_early, pci_dev);
1314
	pci_pm_default_resume(pci_dev);
1315

1316
	if (pm && pm->runtime_resume)
1317
		error = pm->runtime_resume(dev);
1318 1319 1320

	pci_dev->runtime_d3cold = false;

1321
	return error;
1322 1323 1324 1325
}

static int pci_pm_runtime_idle(struct device *dev)
{
1326
	struct pci_dev *pci_dev = to_pci_dev(dev);
1327 1328
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;

1329 1330 1331 1332 1333
	/*
	 * If pci_dev->driver is not set (unbound), the device should
	 * always remain in D0 regardless of the runtime PM status
	 */
	if (!pci_dev->driver)
1334
		return 0;
1335

1336 1337 1338
	if (!pm)
		return -ENOSYS;

1339
	if (pm->runtime_idle)
1340
		return pm->runtime_idle(dev);
1341

1342
	return 0;
1343 1344
}

S
Sachin Kamat 已提交
1345
static const struct dev_pm_ops pci_dev_pm_ops = {
1346
	.prepare = pci_pm_prepare,
1347
	.complete = pci_pm_complete,
1348
	.suspend = pci_pm_suspend,
1349
	.suspend_late = pci_pm_suspend_late,
1350 1351 1352 1353
	.resume = pci_pm_resume,
	.freeze = pci_pm_freeze,
	.thaw = pci_pm_thaw,
	.poweroff = pci_pm_poweroff,
1354
	.poweroff_late = pci_pm_poweroff_late,
1355
	.restore = pci_pm_restore,
1356 1357 1358 1359 1360 1361
	.suspend_noirq = pci_pm_suspend_noirq,
	.resume_noirq = pci_pm_resume_noirq,
	.freeze_noirq = pci_pm_freeze_noirq,
	.thaw_noirq = pci_pm_thaw_noirq,
	.poweroff_noirq = pci_pm_poweroff_noirq,
	.restore_noirq = pci_pm_restore_noirq,
1362 1363 1364
	.runtime_suspend = pci_pm_runtime_suspend,
	.runtime_resume = pci_pm_runtime_resume,
	.runtime_idle = pci_pm_runtime_idle,
1365 1366
};

1367
#define PCI_PM_OPS_PTR	(&pci_dev_pm_ops)
1368

1369 1370 1371 1372 1373
#else /* !CONFIG_PM */

#define pci_pm_runtime_suspend	NULL
#define pci_pm_runtime_resume	NULL
#define pci_pm_runtime_idle	NULL
1374 1375 1376

#define PCI_PM_OPS_PTR	NULL

1377
#endif /* !CONFIG_PM */
1378

L
Linus Torvalds 已提交
1379
/**
1380
 * __pci_register_driver - register a new pci driver
L
Linus Torvalds 已提交
1381
 * @drv: the driver structure to register
1382
 * @owner: owner module of drv
1383
 * @mod_name: module name string
1384
 *
L
Linus Torvalds 已提交
1385
 * Adds the driver structure to the list of registered drivers.
1386 1387
 * Returns a negative value on error, otherwise 0.
 * If no error occurred, the driver remains registered even if
L
Linus Torvalds 已提交
1388 1389
 * no device was claimed during registration.
 */
1390 1391
int __pci_register_driver(struct pci_driver *drv, struct module *owner,
			  const char *mod_name)
L
Linus Torvalds 已提交
1392 1393 1394 1395
{
	/* initialize common driver fields */
	drv->driver.name = drv->name;
	drv->driver.bus = &pci_bus_type;
1396
	drv->driver.owner = owner;
1397
	drv->driver.mod_name = mod_name;
1398
	drv->driver.groups = drv->groups;
A
Alan Cox 已提交
1399

1400 1401
	spin_lock_init(&drv->dynids.lock);
	INIT_LIST_HEAD(&drv->dynids.list);
L
Linus Torvalds 已提交
1402 1403

	/* register with core */
1404
	return driver_register(&drv->driver);
L
Linus Torvalds 已提交
1405
}
1406
EXPORT_SYMBOL(__pci_register_driver);
L
Linus Torvalds 已提交
1407 1408 1409 1410

/**
 * pci_unregister_driver - unregister a pci driver
 * @drv: the driver structure to unregister
1411
 *
L
Linus Torvalds 已提交
1412 1413 1414 1415 1416 1417
 * Deletes the driver structure from the list of registered PCI drivers,
 * gives it a chance to clean up by calling its remove() function for
 * each device it was responsible for, and marks those devices as
 * driverless.
 */

R
Ryan Desfosses 已提交
1418
void pci_unregister_driver(struct pci_driver *drv)
L
Linus Torvalds 已提交
1419 1420 1421 1422
{
	driver_unregister(&drv->driver);
	pci_free_dynids(drv);
}
1423
EXPORT_SYMBOL(pci_unregister_driver);
L
Linus Torvalds 已提交
1424 1425 1426 1427 1428 1429 1430 1431 1432

static struct pci_driver pci_compat_driver = {
	.name = "compat"
};

/**
 * pci_dev_driver - get the pci_driver of a device
 * @dev: the device to query
 *
1433
 * Returns the appropriate pci_driver structure or %NULL if there is no
L
Linus Torvalds 已提交
1434 1435
 * registered driver for the device.
 */
R
Ryan Desfosses 已提交
1436
struct pci_driver *pci_dev_driver(const struct pci_dev *dev)
L
Linus Torvalds 已提交
1437 1438 1439 1440 1441
{
	if (dev->driver)
		return dev->driver;
	else {
		int i;
R
Ryan Desfosses 已提交
1442
		for (i = 0; i <= PCI_ROM_RESOURCE; i++)
L
Linus Torvalds 已提交
1443 1444 1445 1446 1447
			if (dev->resource[i].flags & IORESOURCE_BUSY)
				return &pci_compat_driver;
	}
	return NULL;
}
1448
EXPORT_SYMBOL(pci_dev_driver);
L
Linus Torvalds 已提交
1449 1450 1451 1452

/**
 * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure
 * @dev: the PCI device structure to match against
R
Randy Dunlap 已提交
1453
 * @drv: the device driver to search for matching PCI device id structures
1454
 *
L
Linus Torvalds 已提交
1455
 * Used by a driver to check whether a PCI device present in the
R
Randy Dunlap 已提交
1456
 * system is in its list of supported devices. Returns the matching
L
Linus Torvalds 已提交
1457 1458
 * pci_device_id structure or %NULL if there is no match.
 */
1459
static int pci_bus_match(struct device *dev, struct device_driver *drv)
L
Linus Torvalds 已提交
1460
{
1461
	struct pci_dev *pci_dev = to_pci_dev(dev);
1462
	struct pci_driver *pci_drv;
L
Linus Torvalds 已提交
1463 1464
	const struct pci_device_id *found_id;

1465 1466 1467 1468
	if (!pci_dev->match_driver)
		return 0;

	pci_drv = to_pci_driver(drv);
1469
	found_id = pci_match_device(pci_drv, pci_dev);
L
Linus Torvalds 已提交
1470 1471 1472
	if (found_id)
		return 1;

1473
	return 0;
L
Linus Torvalds 已提交
1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493
}

/**
 * pci_dev_get - increments the reference count of the pci device structure
 * @dev: the device being referenced
 *
 * Each live reference to a device should be refcounted.
 *
 * Drivers for PCI devices should normally record such references in
 * their probe() methods, when they bind to a device, and release
 * them by calling pci_dev_put(), in their disconnect() methods.
 *
 * A pointer to the device with the incremented reference counter is returned.
 */
struct pci_dev *pci_dev_get(struct pci_dev *dev)
{
	if (dev)
		get_device(&dev->dev);
	return dev;
}
1494
EXPORT_SYMBOL(pci_dev_get);
L
Linus Torvalds 已提交
1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507

/**
 * pci_dev_put - release a use of the pci device structure
 * @dev: device that's been disconnected
 *
 * Must be called when a user of a device is finished with it.  When the last
 * user of the device calls this function, the memory of the device is freed.
 */
void pci_dev_put(struct pci_dev *dev)
{
	if (dev)
		put_device(&dev->dev);
}
1508
EXPORT_SYMBOL(pci_dev_put);
L
Linus Torvalds 已提交
1509

1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531
static int pci_uevent(struct device *dev, struct kobj_uevent_env *env)
{
	struct pci_dev *pdev;

	if (!dev)
		return -ENODEV;

	pdev = to_pci_dev(dev);

	if (add_uevent_var(env, "PCI_CLASS=%04X", pdev->class))
		return -ENOMEM;

	if (add_uevent_var(env, "PCI_ID=%04X:%04X", pdev->vendor, pdev->device))
		return -ENOMEM;

	if (add_uevent_var(env, "PCI_SUBSYS_ID=%04X:%04X", pdev->subsystem_vendor,
			   pdev->subsystem_device))
		return -ENOMEM;

	if (add_uevent_var(env, "PCI_SLOT_NAME=%s", pci_name(pdev)))
		return -ENOMEM;

1532
	if (add_uevent_var(env, "MODALIAS=pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02X",
1533 1534 1535 1536 1537
			   pdev->vendor, pdev->device,
			   pdev->subsystem_vendor, pdev->subsystem_device,
			   (u8)(pdev->class >> 16), (u8)(pdev->class >> 8),
			   (u8)(pdev->class)))
		return -ENOMEM;
B
Bjorn Helgaas 已提交
1538

1539 1540 1541
	return 0;
}

1542
#if defined(CONFIG_PCIEPORTBUS) || defined(CONFIG_EEH)
1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577
/**
 * pci_uevent_ers - emit a uevent during recovery path of PCI device
 * @pdev: PCI device undergoing error recovery
 * @err_type: type of error event
 */
void pci_uevent_ers(struct pci_dev *pdev, enum pci_ers_result err_type)
{
	int idx = 0;
	char *envp[3];

	switch (err_type) {
	case PCI_ERS_RESULT_NONE:
	case PCI_ERS_RESULT_CAN_RECOVER:
		envp[idx++] = "ERROR_EVENT=BEGIN_RECOVERY";
		envp[idx++] = "DEVICE_ONLINE=0";
		break;
	case PCI_ERS_RESULT_RECOVERED:
		envp[idx++] = "ERROR_EVENT=SUCCESSFUL_RECOVERY";
		envp[idx++] = "DEVICE_ONLINE=1";
		break;
	case PCI_ERS_RESULT_DISCONNECT:
		envp[idx++] = "ERROR_EVENT=FAILED_RECOVERY";
		envp[idx++] = "DEVICE_ONLINE=0";
		break;
	default:
		break;
	}

	if (idx > 0) {
		envp[idx++] = NULL;
		kobject_uevent_env(&pdev->dev.kobj, KOBJ_CHANGE, envp);
	}
}
#endif

1578 1579 1580 1581 1582
static int pci_bus_num_vf(struct device *dev)
{
	return pci_num_vf(to_pci_dev(dev));
}

1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598
/**
 * pci_dma_configure - Setup DMA configuration
 * @dev: ptr to dev structure
 *
 * Function to update PCI devices's DMA configuration using the same
 * info from the OF node or ACPI node of host bridge's parent (if any).
 */
static int pci_dma_configure(struct device *dev)
{
	struct device *bridge;
	int ret = 0;

	bridge = pci_get_host_bridge_device(to_pci_dev(dev));

	if (IS_ENABLED(CONFIG_OF) && bridge->parent &&
	    bridge->parent->of_node) {
1599
		ret = of_dma_configure(dev, bridge->parent->of_node, true);
1600 1601 1602
	} else if (has_acpi_companion(bridge)) {
		struct acpi_device *adev = to_acpi_device_node(bridge->fwnode);

1603
		ret = acpi_dma_configure(dev, acpi_get_dma_attr(adev));
1604 1605 1606 1607 1608 1609
	}

	pci_put_host_bridge_device(bridge);
	return ret;
}

L
Linus Torvalds 已提交
1610 1611 1612
struct bus_type pci_bus_type = {
	.name		= "pci",
	.match		= pci_bus_match,
1613
	.uevent		= pci_uevent,
1614 1615
	.probe		= pci_device_probe,
	.remove		= pci_device_remove,
L
Linus Torvalds 已提交
1616
	.shutdown	= pci_device_shutdown,
1617
	.dev_groups	= pci_dev_groups,
1618
	.bus_groups	= pci_bus_groups,
1619
	.drv_groups	= pci_drv_groups,
1620
	.pm		= PCI_PM_OPS_PTR,
1621
	.num_vf		= pci_bus_num_vf,
1622
	.dma_configure	= pci_dma_configure,
L
Linus Torvalds 已提交
1623
};
1624
EXPORT_SYMBOL(pci_bus_type);
L
Linus Torvalds 已提交
1625

1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654
#ifdef CONFIG_PCIEPORTBUS
static int pcie_port_bus_match(struct device *dev, struct device_driver *drv)
{
	struct pcie_device *pciedev;
	struct pcie_port_service_driver *driver;

	if (drv->bus != &pcie_port_bus_type || dev->bus != &pcie_port_bus_type)
		return 0;

	pciedev = to_pcie_device(dev);
	driver = to_service_driver(drv);

	if (driver->service != pciedev->service)
		return 0;

	if (driver->port_type != PCIE_ANY_PORT &&
	    driver->port_type != pci_pcie_type(pciedev->port))
		return 0;

	return 1;
}

struct bus_type pcie_port_bus_type = {
	.name		= "pci_express",
	.match		= pcie_port_bus_match,
};
EXPORT_SYMBOL_GPL(pcie_port_bus_type);
#endif

L
Linus Torvalds 已提交
1655 1656
static int __init pci_driver_init(void)
{
1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667
	int ret;

	ret = bus_register(&pci_bus_type);
	if (ret)
		return ret;

#ifdef CONFIG_PCIEPORTBUS
	ret = bus_register(&pcie_port_bus_type);
	if (ret)
		return ret;
#endif
1668
	dma_debug_add_bus(&pci_bus_type);
1669
	return 0;
L
Linus Torvalds 已提交
1670 1671
}
postcore_initcall(pci_driver_init);