pci-driver.c 42.6 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 318 319
	/*
	 * Probe function should return < 0 for failure, 0 for success
	 * Treat values > 0 as success, but warn.
	 */
	dev_warn(dev, "Driver probe function unexpectedly returned %d\n", rc);
	return 0;
320 321
}

322 323 324 325 326 327 328 329 330
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
}

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

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

	cpu_hotplug_disable();
346 347

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

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

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

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

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

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

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

void __weak pcibios_free_irq(struct pci_dev *dev)
{
}

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

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

417 418
	pci_assign_irq(pci_dev);

419 420 421
	error = pcibios_alloc_irq(pci_dev);
	if (error < 0)
		return error;
L
Linus Torvalds 已提交
422 423

	pci_dev_get(pci_dev);
424 425 426 427 428 429
	if (pci_device_can_probe(pci_dev)) {
		error = __pci_device_probe(drv, pci_dev);
		if (error) {
			pcibios_free_irq(pci_dev);
			pci_dev_put(pci_dev);
		}
430
	}
L
Linus Torvalds 已提交
431 432 433 434

	return error;
}

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

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

451
	/* Undo the runtime PM settings in local_pci_probe() */
452
	pm_runtime_put_sync(dev);
453

454 455 456 457 458 459 460
	/*
	 * 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 已提交
461 462 463 464
	/*
	 * 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
465
	 * that don't like drivers doing that all of the time.
L
Linus Torvalds 已提交
466 467 468 469 470 471 472 473
	 * 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;
}

474 475 476 477 478
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 已提交
479 480
	pm_runtime_resume(dev);

481 482
	if (drv && drv->shutdown)
		drv->shutdown(pci_dev);
483

484
	/*
485 486 487 488 489
	 * 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.
490
	 */
491
	if (kexec_in_progress && (pci_dev->current_state <= PCI_D3hot))
492
		pci_clear_master(pci_dev);
493 494
}

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

/* 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;
	}

513
	pci_restore_state(pci_dev);
514
	pci_pme_restore(pci_dev);
515
	return 0;
516 517
}

518 519 520 521
#endif

#ifdef CONFIG_PM_SLEEP

522 523
static void pci_pm_default_resume_early(struct pci_dev *pci_dev)
{
524 525
	pci_power_up(pci_dev);
	pci_restore_state(pci_dev);
526
	pci_pme_restore(pci_dev);
527 528
}

529 530 531
/*
 * Default "suspend" method for devices that have no driver provided suspend,
 * or not even a driver at all (second part).
532
 */
533
static void pci_pm_set_unknown_state(struct pci_dev *pci_dev)
534 535 536 537 538 539 540 541 542
{
	/*
	 * 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;
}

543 544 545 546
/*
 * Default "resume" method for devices that have no driver provided resume,
 * or not even a driver at all (second part).
 */
547
static int pci_pm_reenable_device(struct pci_dev *pci_dev)
548 549 550
{
	int retval;

551 552 553 554 555 556 557 558 559 560 561 562 563
	/* 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 已提交
564
{
R
Ryan Desfosses 已提交
565 566
	struct pci_dev *pci_dev = to_pci_dev(dev);
	struct pci_driver *drv = pci_dev->driver;
567

568
	if (drv && drv->suspend) {
569
		pci_power_t prev = pci_dev->current_state;
570
		int error;
571

572 573 574 575
		error = drv->suspend(pci_dev, state);
		suspend_report_result(drv->suspend, error);
		if (error)
			return error;
576

577
		if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
578 579
		    && pci_dev->current_state != PCI_UNKNOWN) {
			WARN_ONCE(pci_dev->current_state != prev,
580
				"PCI PM: Device state not saved by %pS\n",
581 582
				drv->suspend);
		}
583
	}
584 585 586

	pci_fixup_device(pci_fixup_suspend, pci_dev);

587
	return 0;
L
Linus Torvalds 已提交
588 589
}

590
static int pci_legacy_suspend_late(struct device *dev, pm_message_t state)
L
Linus Torvalds 已提交
591
{
R
Ryan Desfosses 已提交
592 593
	struct pci_dev *pci_dev = to_pci_dev(dev);
	struct pci_driver *drv = pci_dev->driver;
L
Linus Torvalds 已提交
594 595

	if (drv && drv->suspend_late) {
596 597 598
		pci_power_t prev = pci_dev->current_state;
		int error;

599 600
		error = drv->suspend_late(pci_dev, state);
		suspend_report_result(drv->suspend_late, error);
601 602 603 604 605 606
		if (error)
			return error;

		if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
		    && pci_dev->current_state != PCI_UNKNOWN) {
			WARN_ONCE(pci_dev->current_state != prev,
607
				"PCI PM: Device state not saved by %pS\n",
608
				drv->suspend_late);
609
			goto Fixup;
610
		}
L
Linus Torvalds 已提交
611
	}
612 613 614 615 616 617

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

	pci_pm_set_unknown_state(pci_dev);

618 619 620
Fixup:
	pci_fixup_device(pci_fixup_suspend_late, pci_dev);

621
	return 0;
L
Linus Torvalds 已提交
622
}
L
Linus Torvalds 已提交
623

624 625
static int pci_legacy_resume_early(struct device *dev)
{
R
Ryan Desfosses 已提交
626 627
	struct pci_dev *pci_dev = to_pci_dev(dev);
	struct pci_driver *drv = pci_dev->driver;
628

629 630
	return drv && drv->resume_early ?
			drv->resume_early(pci_dev) : 0;
631 632
}

633
static int pci_legacy_resume(struct device *dev)
L
Linus Torvalds 已提交
634
{
R
Ryan Desfosses 已提交
635 636
	struct pci_dev *pci_dev = to_pci_dev(dev);
	struct pci_driver *drv = pci_dev->driver;
L
Linus Torvalds 已提交
637

638 639
	pci_fixup_device(pci_fixup_resume, pci_dev);

640 641
	return drv && drv->resume ?
			drv->resume(pci_dev) : pci_pm_reenable_device(pci_dev);
L
Linus Torvalds 已提交
642 643
}

644 645
/* Auxiliary functions used by the new power management framework */

646
static void pci_pm_default_resume(struct pci_dev *pci_dev)
647
{
648
	pci_fixup_device(pci_fixup_resume, pci_dev);
649
	pci_enable_wake(pci_dev, PCI_D0, false);
650 651
}

652
static void pci_pm_default_suspend(struct pci_dev *pci_dev)
653
{
654
	/* Disable non-bridge devices without PM support */
655
	if (!pci_has_subordinate(pci_dev))
656
		pci_disable_enabled_device(pci_dev);
657 658
}

659 660 661
static bool pci_has_legacy_pm_support(struct pci_dev *pci_dev)
{
	struct pci_driver *drv = pci_dev->driver;
662
	bool ret = drv && (drv->suspend || drv->suspend_late || drv->resume
663
		|| drv->resume_early);
664 665 666 667 668 669

	/*
	 * 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.
	 */
670 671
	WARN(ret && drv->driver.pm, "driver %s device %04x:%04x\n",
		drv->name, pci_dev->vendor, pci_dev->device);
672 673

	return ret;
674 675
}

676 677
/* New power management framework */

678 679 680 681
static int pci_pm_prepare(struct device *dev)
{
	struct device_driver *drv = dev->driver;

682 683
	if (drv && drv->pm && drv->pm->prepare) {
		int error = drv->pm->prepare(dev);
684
		if (error < 0)
685
			return error;
686 687 688

		if (!error && dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_PREPARE))
			return 0;
689 690
	}
	return pci_dev_keep_suspended(to_pci_dev(dev));
691 692
}

693 694
static void pci_pm_complete(struct device *dev)
{
695 696 697 698 699 700
	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 */
701
	if (pm_runtime_suspended(dev) && pm_resume_via_firmware()) {
702 703 704 705 706 707
		pci_power_t pre_sleep_state = pci_dev->current_state;

		pci_update_current_state(pci_dev, pci_dev->current_state);
		if (pci_dev->current_state < pre_sleep_state)
			pm_request_resume(dev);
	}
708
}
709

710 711 712
#else /* !CONFIG_PM_SLEEP */

#define pci_pm_prepare	NULL
713
#define pci_pm_complete	NULL
714 715 716

#endif /* !CONFIG_PM_SLEEP */

717
#ifdef CONFIG_SUSPEND
718 719 720 721 722 723 724 725
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) &&
726 727
	    (pci_pcie_type(pci_dev) == PCI_EXP_TYPE_ROOT_PORT ||
	     pci_pcie_type(pci_dev) == PCI_EXP_TYPE_RC_EC))
728 729
		pcie_clear_root_pme_status(pci_dev);
}
730 731 732 733

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

736 737
	pci_dev->skip_bus_pm = false;

738 739
	if (pci_has_legacy_pm_support(pci_dev))
		return pci_legacy_suspend(dev, PMSG_SUSPEND);
740

741 742
	if (!pm) {
		pci_pm_default_suspend(pci_dev);
743
		return 0;
744 745
	}

746
	/*
747 748 749 750 751 752 753 754 755 756 757
	 * 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.
758
	 */
759
	if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
760
	    !pci_dev_keep_suspended(pci_dev)) {
761
		pm_runtime_resume(dev);
762 763
		pci_dev->state_saved = false;
	}
764

765 766 767 768
	if (pm->suspend) {
		pci_power_t prev = pci_dev->current_state;
		int error;

769 770
		error = pm->suspend(dev);
		suspend_report_result(pm->suspend, error);
771 772 773
		if (error)
			return error;

774
		if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
775 776
		    && pci_dev->current_state != PCI_UNKNOWN) {
			WARN_ONCE(pci_dev->current_state != prev,
777
				"PCI PM: State of device not saved by %pS\n",
778 779
				pm->suspend);
		}
780
	}
781

782
	return 0;
783 784
}

785 786 787 788 789 790 791 792 793 794
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);
}

795
static int pci_pm_suspend_noirq(struct device *dev)
G
Greg KH 已提交
796
{
797
	struct pci_dev *pci_dev = to_pci_dev(dev);
798
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
G
Greg KH 已提交
799

800 801
	if (dev_pm_smart_suspend_and_suspended(dev)) {
		dev->power.may_skip_resume = true;
802
		return 0;
803
	}
804

805 806 807
	if (pci_has_legacy_pm_support(pci_dev))
		return pci_legacy_suspend_late(dev, PMSG_SUSPEND);

808 809
	if (!pm) {
		pci_save_state(pci_dev);
810
		goto Fixup;
811
	}
812 813 814 815 816 817 818 819 820 821 822 823 824

	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) {
			WARN_ONCE(pci_dev->current_state != prev,
825
				"PCI PM: State of device not saved by %pS\n",
826
				pm->suspend_noirq);
827
			goto Fixup;
828
		}
829 830
	}

831 832
	if (pci_dev->skip_bus_pm) {
		/*
833 834
		 * 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
835
		 * going through full resume, which is possible only during
836 837 838
		 * 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.
839
		 */
840 841 842
		if (!pci_dev->state_saved)
			pci_save_state(pci_dev);
	} else if (!pci_dev->state_saved) {
843
		pci_save_state(pci_dev);
844
		if (pci_power_manageable(pci_dev))
845 846
			pci_prepare_to_sleep(pci_dev);
	}
847

848 849 850
	dev_dbg(dev, "PCI PM: Suspend power state: %s\n",
		pci_power_name(pci_dev->current_state));

851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866
	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;
	}

	if (pci_dev->skip_bus_pm && !pm_suspend_via_firmware()) {
		dev_dbg(dev, "PCI PM: Skipped\n");
		goto Fixup;
	}

867 868
	pci_pm_set_unknown_state(pci_dev);

869 870 871 872 873 874 875 876 877 878 879 880
	/*
	 * 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);

881 882 883
Fixup:
	pci_fixup_device(pci_fixup_suspend_late, pci_dev);

884 885 886 887 888 889 890 891 892 893
	/*
	 * 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);

894
	return 0;
G
Greg KH 已提交
895
}
L
Linus Torvalds 已提交
896

897
static int pci_pm_resume_noirq(struct device *dev)
898 899 900
{
	struct pci_dev *pci_dev = to_pci_dev(dev);
	struct device_driver *drv = dev->driver;
901
	int error = 0;
902

903 904 905
	if (dev_pm_may_skip_resume(dev))
		return 0;

906 907 908 909 910 911 912 913
	/*
	 * 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);

914 915 916 917 918 919 920 921 922 923
	/*
	 * 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
	 * configuration here and attempting to put them into D0 again may
	 * confuse some firmware, so avoid doing that.
	 */
	if (!pci_dev->skip_bus_pm || pm_suspend_via_firmware())
		pci_pm_default_resume_early(pci_dev);

	pci_fixup_device(pci_fixup_resume_early, pci_dev);
924

925
	if (pci_has_legacy_pm_support(pci_dev))
926
		return pci_legacy_resume_early(dev);
927

928 929
	pcie_pme_root_status_cleanup(pci_dev);

930 931
	if (drv && drv->pm && drv->pm->resume_noirq)
		error = drv->pm->resume_noirq(dev);
932 933 934 935

	return error;
}

936
static int pci_pm_resume(struct device *dev)
937
{
938
	struct pci_dev *pci_dev = to_pci_dev(dev);
939
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
940 941
	int error = 0;

942 943 944 945 946 947 948
	/*
	 * 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);

949
	if (pci_has_legacy_pm_support(pci_dev))
950
		return pci_legacy_resume(dev);
951

952
	pci_pm_default_resume(pci_dev);
953

954 955 956 957 958 959
	if (pm) {
		if (pm->resume)
			error = pm->resume(dev);
	} else {
		pci_pm_reenable_device(pci_dev);
	}
960

961
	return error;
962 963 964 965 966
}

#else /* !CONFIG_SUSPEND */

#define pci_pm_suspend		NULL
967
#define pci_pm_suspend_late	NULL
968 969 970 971 972 973
#define pci_pm_suspend_noirq	NULL
#define pci_pm_resume		NULL
#define pci_pm_resume_noirq	NULL

#endif /* !CONFIG_SUSPEND */

974
#ifdef CONFIG_HIBERNATE_CALLBACKS
975

976 977 978 979 980 981 982

/*
 * pcibios_pm_ops - provide arch-specific hooks when a PCI device is doing
 * a hibernate transition
 */
struct dev_pm_ops __weak pcibios_pm_ops;

983 984 985
static int pci_pm_freeze(struct device *dev)
{
	struct pci_dev *pci_dev = to_pci_dev(dev);
986
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
987

988 989
	if (pci_has_legacy_pm_support(pci_dev))
		return pci_legacy_suspend(dev, PMSG_FREEZE);
990

991 992 993
	if (!pm) {
		pci_pm_default_suspend(pci_dev);
		return 0;
994 995
	}

996 997 998 999 1000 1001
	/*
	 * This used to be done in pci_pm_prepare() for all devices and some
	 * drivers may depend on it, so do it here.  Ideally, runtime-suspended
	 * devices should not be touched during freeze/thaw transitions,
	 * however.
	 */
1002
	if (!dev_pm_smart_suspend_and_suspended(dev)) {
1003
		pm_runtime_resume(dev);
1004 1005
		pci_dev->state_saved = false;
	}
1006

1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
	if (pm->freeze) {
		int error;

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

	return 0;
1017 1018
}

1019 1020 1021 1022 1023
static int pci_pm_freeze_late(struct device *dev)
{
	if (dev_pm_smart_suspend_and_suspended(dev))
		return 0;

1024
	return pm_generic_freeze_late(dev);
1025 1026
}

1027 1028
static int pci_pm_freeze_noirq(struct device *dev)
{
1029
	struct pci_dev *pci_dev = to_pci_dev(dev);
1030
	struct device_driver *drv = dev->driver;
1031

1032 1033 1034
	if (dev_pm_smart_suspend_and_suspended(dev))
		return 0;

1035 1036 1037
	if (pci_has_legacy_pm_support(pci_dev))
		return pci_legacy_suspend_late(dev, PMSG_FREEZE);

1038
	if (drv && drv->pm && drv->pm->freeze_noirq) {
1039 1040
		int error;

1041 1042
		error = drv->pm->freeze_noirq(dev);
		suspend_report_result(drv->pm->freeze_noirq, error);
1043 1044
		if (error)
			return error;
1045 1046
	}

1047 1048
	if (!pci_dev->state_saved)
		pci_save_state(pci_dev);
1049

1050 1051
	pci_pm_set_unknown_state(pci_dev);

1052 1053 1054
	if (pcibios_pm_ops.freeze_noirq)
		return pcibios_pm_ops.freeze_noirq(dev);

1055
	return 0;
1056 1057
}

1058
static int pci_pm_thaw_noirq(struct device *dev)
1059
{
1060
	struct pci_dev *pci_dev = to_pci_dev(dev);
1061 1062 1063
	struct device_driver *drv = dev->driver;
	int error = 0;

1064 1065 1066 1067 1068 1069
	/*
	 * If the device is in runtime suspend, the code below may not work
	 * correctly with it, so skip that code and make the PM core skip all of
	 * the subsequent "thaw" callbacks for the device.
	 */
	if (dev_pm_smart_suspend_and_suspended(dev)) {
1070
		dev_pm_skip_next_resume_phases(dev);
1071 1072 1073
		return 0;
	}

1074 1075 1076 1077 1078 1079
	if (pcibios_pm_ops.thaw_noirq) {
		error = pcibios_pm_ops.thaw_noirq(dev);
		if (error)
			return error;
	}

1080
	if (pci_has_legacy_pm_support(pci_dev))
1081
		return pci_legacy_resume_early(dev);
1082

1083 1084 1085 1086 1087 1088
	/*
	 * pci_restore_state() requires the device to be in D0 (because of MSI
	 * restoration among other things), so force it into D0 in case the
	 * driver's "freeze" callbacks put it into a low-power state directly.
	 */
	pci_set_power_state(pci_dev, PCI_D0);
1089
	pci_restore_state(pci_dev);
1090

1091 1092
	if (drv && drv->pm && drv->pm->thaw_noirq)
		error = drv->pm->thaw_noirq(dev);
1093 1094 1095 1096

	return error;
}

1097
static int pci_pm_thaw(struct device *dev)
1098
{
1099
	struct pci_dev *pci_dev = to_pci_dev(dev);
1100
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1101 1102
	int error = 0;

1103
	if (pci_has_legacy_pm_support(pci_dev))
1104
		return pci_legacy_resume(dev);
1105

1106 1107 1108 1109 1110 1111
	if (pm) {
		if (pm->thaw)
			error = pm->thaw(dev);
	} else {
		pci_pm_reenable_device(pci_dev);
	}
1112

1113 1114
	pci_dev->state_saved = false;

1115 1116 1117 1118 1119
	return error;
}

static int pci_pm_poweroff(struct device *dev)
{
1120
	struct pci_dev *pci_dev = to_pci_dev(dev);
1121
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1122

1123 1124
	if (pci_has_legacy_pm_support(pci_dev))
		return pci_legacy_suspend(dev, PMSG_HIBERNATE);
1125

1126 1127
	if (!pm) {
		pci_pm_default_suspend(pci_dev);
1128
		return 0;
1129 1130
	}

1131
	/* The reason to do that is the same as in pci_pm_suspend(). */
1132 1133 1134
	if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
	    !pci_dev_keep_suspended(pci_dev))
		pm_runtime_resume(dev);
1135

1136
	pci_dev->state_saved = false;
1137
	if (pm->poweroff) {
1138 1139
		int error;

1140 1141
		error = pm->poweroff(dev);
		suspend_report_result(pm->poweroff, error);
1142 1143
		if (error)
			return error;
1144 1145
	}

1146
	return 0;
1147
}
1148

1149 1150 1151 1152
static int pci_pm_poweroff_late(struct device *dev)
{
	if (dev_pm_smart_suspend_and_suspended(dev))
		return 0;
1153

1154 1155 1156
	pci_fixup_device(pci_fixup_suspend, to_pci_dev(dev));

	return pm_generic_poweroff_late(dev);
1157 1158 1159 1160
}

static int pci_pm_poweroff_noirq(struct device *dev)
{
1161
	struct pci_dev *pci_dev = to_pci_dev(dev);
1162
	struct device_driver *drv = dev->driver;
1163

1164 1165 1166
	if (dev_pm_smart_suspend_and_suspended(dev))
		return 0;

1167 1168 1169
	if (pci_has_legacy_pm_support(to_pci_dev(dev)))
		return pci_legacy_suspend_late(dev, PMSG_HIBERNATE);

1170 1171
	if (!drv || !drv->pm) {
		pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1172
		return 0;
1173
	}
1174 1175 1176 1177

	if (drv->pm->poweroff_noirq) {
		int error;

1178 1179
		error = drv->pm->poweroff_noirq(dev);
		suspend_report_result(drv->pm->poweroff_noirq, error);
1180 1181
		if (error)
			return error;
1182 1183
	}

1184
	if (!pci_dev->state_saved && !pci_has_subordinate(pci_dev))
1185 1186
		pci_prepare_to_sleep(pci_dev);

1187 1188 1189 1190 1191 1192 1193
	/*
	 * 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);

1194 1195
	pci_fixup_device(pci_fixup_suspend_late, pci_dev);

1196 1197 1198
	if (pcibios_pm_ops.poweroff_noirq)
		return pcibios_pm_ops.poweroff_noirq(dev);

1199
	return 0;
1200 1201
}

1202
static int pci_pm_restore_noirq(struct device *dev)
1203 1204 1205
{
	struct pci_dev *pci_dev = to_pci_dev(dev);
	struct device_driver *drv = dev->driver;
1206
	int error = 0;
1207

1208 1209 1210 1211
	/* This is analogous to the pci_pm_resume_noirq() case. */
	if (dev_pm_smart_suspend_and_suspended(dev))
		pm_runtime_set_active(dev);

1212 1213 1214 1215 1216 1217
	if (pcibios_pm_ops.restore_noirq) {
		error = pcibios_pm_ops.restore_noirq(dev);
		if (error)
			return error;
	}

1218
	pci_pm_default_resume_early(pci_dev);
1219
	pci_fixup_device(pci_fixup_resume_early, pci_dev);
1220

1221
	if (pci_has_legacy_pm_support(pci_dev))
1222
		return pci_legacy_resume_early(dev);
1223

1224 1225
	if (drv && drv->pm && drv->pm->restore_noirq)
		error = drv->pm->restore_noirq(dev);
1226 1227 1228 1229

	return error;
}

1230
static int pci_pm_restore(struct device *dev)
1231 1232
{
	struct pci_dev *pci_dev = to_pci_dev(dev);
1233
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1234 1235
	int error = 0;

1236 1237 1238 1239 1240 1241 1242
	/*
	 * 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);

1243
	if (pci_has_legacy_pm_support(pci_dev))
1244
		return pci_legacy_resume(dev);
1245

1246
	pci_pm_default_resume(pci_dev);
1247

1248 1249 1250 1251 1252 1253
	if (pm) {
		if (pm->restore)
			error = pm->restore(dev);
	} else {
		pci_pm_reenable_device(pci_dev);
	}
1254 1255

	return error;
G
Greg KH 已提交
1256
}
L
Linus Torvalds 已提交
1257

1258
#else /* !CONFIG_HIBERNATE_CALLBACKS */
1259 1260

#define pci_pm_freeze		NULL
1261
#define pci_pm_freeze_late	NULL
1262 1263 1264 1265
#define pci_pm_freeze_noirq	NULL
#define pci_pm_thaw		NULL
#define pci_pm_thaw_noirq	NULL
#define pci_pm_poweroff		NULL
1266
#define pci_pm_poweroff_late	NULL
1267 1268 1269 1270
#define pci_pm_poweroff_noirq	NULL
#define pci_pm_restore		NULL
#define pci_pm_restore_noirq	NULL

1271
#endif /* !CONFIG_HIBERNATE_CALLBACKS */
1272

1273
#ifdef CONFIG_PM
1274 1275 1276 1277 1278 1279 1280 1281

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;

1282
	/*
1283 1284 1285
	 * 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.
1286
	 */
1287 1288
	if (!pci_dev->driver) {
		pci_save_state(pci_dev);
1289
		return 0;
1290
	}
1291

1292
	pci_dev->state_saved = false;
1293 1294
	if (pm && pm->runtime_suspend) {
		error = pm->runtime_suspend(dev);
1295 1296 1297 1298 1299
		/*
		 * -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.
		 */
1300
		if (error == -EBUSY || error == -EAGAIN) {
1301
			dev_dbg(dev, "can't suspend now (%ps returned %d)\n",
1302
				pm->runtime_suspend, error);
1303 1304
			return error;
		} else if (error) {
1305
			dev_err(dev, "can't suspend (%ps returned %d)\n",
1306
				pm->runtime_suspend, error);
1307 1308
			return error;
		}
1309
	}
1310 1311 1312

	pci_fixup_device(pci_fixup_suspend, pci_dev);

1313 1314
	if (pm && pm->runtime_suspend
	    && !pci_dev->state_saved && pci_dev->current_state != PCI_D0
1315 1316
	    && pci_dev->current_state != PCI_UNKNOWN) {
		WARN_ONCE(pci_dev->current_state != prev,
1317
			"PCI PM: State of device not saved by %pS\n",
1318 1319 1320 1321
			pm->runtime_suspend);
		return 0;
	}

1322
	if (!pci_dev->state_saved) {
1323
		pci_save_state(pci_dev);
1324 1325
		pci_finish_runtime_suspend(pci_dev);
	}
1326 1327 1328 1329 1330 1331

	return 0;
}

static int pci_pm_runtime_resume(struct device *dev)
{
1332
	int rc = 0;
1333 1334 1335
	struct pci_dev *pci_dev = to_pci_dev(dev);
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;

1336
	/*
1337 1338 1339
	 * 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.
1340
	 */
1341 1342
	pci_restore_standard_config(pci_dev);

1343 1344 1345
	if (!pci_dev->driver)
		return 0;

1346
	pci_fixup_device(pci_fixup_resume_early, pci_dev);
1347
	pci_enable_wake(pci_dev, PCI_D0, false);
1348 1349
	pci_fixup_device(pci_fixup_resume, pci_dev);

1350 1351
	if (pm && pm->runtime_resume)
		rc = pm->runtime_resume(dev);
1352 1353 1354 1355

	pci_dev->runtime_d3cold = false;

	return rc;
1356 1357 1358 1359
}

static int pci_pm_runtime_idle(struct device *dev)
{
1360
	struct pci_dev *pci_dev = to_pci_dev(dev);
1361
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1362
	int ret = 0;
1363

1364 1365 1366 1367 1368
	/*
	 * 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)
1369
		return 0;
1370

1371 1372 1373
	if (!pm)
		return -ENOSYS;

1374 1375
	if (pm->runtime_idle)
		ret = pm->runtime_idle(dev);
1376

1377
	return ret;
1378 1379
}

S
Sachin Kamat 已提交
1380
static const struct dev_pm_ops pci_dev_pm_ops = {
1381
	.prepare = pci_pm_prepare,
1382
	.complete = pci_pm_complete,
1383
	.suspend = pci_pm_suspend,
1384
	.suspend_late = pci_pm_suspend_late,
1385 1386
	.resume = pci_pm_resume,
	.freeze = pci_pm_freeze,
1387
	.freeze_late = pci_pm_freeze_late,
1388 1389
	.thaw = pci_pm_thaw,
	.poweroff = pci_pm_poweroff,
1390
	.poweroff_late = pci_pm_poweroff_late,
1391
	.restore = pci_pm_restore,
1392 1393 1394 1395 1396 1397
	.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,
1398 1399 1400
	.runtime_suspend = pci_pm_runtime_suspend,
	.runtime_resume = pci_pm_runtime_resume,
	.runtime_idle = pci_pm_runtime_idle,
1401 1402
};

1403
#define PCI_PM_OPS_PTR	(&pci_dev_pm_ops)
1404

1405 1406 1407 1408 1409
#else /* !CONFIG_PM */

#define pci_pm_runtime_suspend	NULL
#define pci_pm_runtime_resume	NULL
#define pci_pm_runtime_idle	NULL
1410 1411 1412

#define PCI_PM_OPS_PTR	NULL

1413
#endif /* !CONFIG_PM */
1414

L
Linus Torvalds 已提交
1415
/**
1416
 * __pci_register_driver - register a new pci driver
L
Linus Torvalds 已提交
1417
 * @drv: the driver structure to register
1418
 * @owner: owner module of drv
1419
 * @mod_name: module name string
1420
 *
L
Linus Torvalds 已提交
1421
 * Adds the driver structure to the list of registered drivers.
1422 1423
 * Returns a negative value on error, otherwise 0.
 * If no error occurred, the driver remains registered even if
L
Linus Torvalds 已提交
1424 1425
 * no device was claimed during registration.
 */
1426 1427
int __pci_register_driver(struct pci_driver *drv, struct module *owner,
			  const char *mod_name)
L
Linus Torvalds 已提交
1428 1429 1430 1431
{
	/* initialize common driver fields */
	drv->driver.name = drv->name;
	drv->driver.bus = &pci_bus_type;
1432
	drv->driver.owner = owner;
1433
	drv->driver.mod_name = mod_name;
1434
	drv->driver.groups = drv->groups;
A
Alan Cox 已提交
1435

1436 1437
	spin_lock_init(&drv->dynids.lock);
	INIT_LIST_HEAD(&drv->dynids.list);
L
Linus Torvalds 已提交
1438 1439

	/* register with core */
1440
	return driver_register(&drv->driver);
L
Linus Torvalds 已提交
1441
}
1442
EXPORT_SYMBOL(__pci_register_driver);
L
Linus Torvalds 已提交
1443 1444 1445 1446

/**
 * pci_unregister_driver - unregister a pci driver
 * @drv: the driver structure to unregister
1447
 *
L
Linus Torvalds 已提交
1448 1449 1450 1451 1452 1453
 * 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 已提交
1454
void pci_unregister_driver(struct pci_driver *drv)
L
Linus Torvalds 已提交
1455 1456 1457 1458
{
	driver_unregister(&drv->driver);
	pci_free_dynids(drv);
}
1459
EXPORT_SYMBOL(pci_unregister_driver);
L
Linus Torvalds 已提交
1460 1461 1462 1463 1464 1465 1466 1467 1468

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

/**
 * pci_dev_driver - get the pci_driver of a device
 * @dev: the device to query
 *
1469
 * Returns the appropriate pci_driver structure or %NULL if there is no
L
Linus Torvalds 已提交
1470 1471
 * registered driver for the device.
 */
R
Ryan Desfosses 已提交
1472
struct pci_driver *pci_dev_driver(const struct pci_dev *dev)
L
Linus Torvalds 已提交
1473 1474 1475 1476 1477
{
	if (dev->driver)
		return dev->driver;
	else {
		int i;
R
Ryan Desfosses 已提交
1478
		for (i = 0; i <= PCI_ROM_RESOURCE; i++)
L
Linus Torvalds 已提交
1479 1480 1481 1482 1483
			if (dev->resource[i].flags & IORESOURCE_BUSY)
				return &pci_compat_driver;
	}
	return NULL;
}
1484
EXPORT_SYMBOL(pci_dev_driver);
L
Linus Torvalds 已提交
1485 1486 1487 1488

/**
 * 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 已提交
1489
 * @drv: the device driver to search for matching PCI device id structures
1490
 *
L
Linus Torvalds 已提交
1491
 * Used by a driver to check whether a PCI device present in the
R
Randy Dunlap 已提交
1492
 * system is in its list of supported devices. Returns the matching
L
Linus Torvalds 已提交
1493 1494
 * pci_device_id structure or %NULL if there is no match.
 */
1495
static int pci_bus_match(struct device *dev, struct device_driver *drv)
L
Linus Torvalds 已提交
1496
{
1497
	struct pci_dev *pci_dev = to_pci_dev(dev);
1498
	struct pci_driver *pci_drv;
L
Linus Torvalds 已提交
1499 1500
	const struct pci_device_id *found_id;

1501 1502 1503 1504
	if (!pci_dev->match_driver)
		return 0;

	pci_drv = to_pci_driver(drv);
1505
	found_id = pci_match_device(pci_drv, pci_dev);
L
Linus Torvalds 已提交
1506 1507 1508
	if (found_id)
		return 1;

1509
	return 0;
L
Linus Torvalds 已提交
1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529
}

/**
 * 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;
}
1530
EXPORT_SYMBOL(pci_dev_get);
L
Linus Torvalds 已提交
1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543

/**
 * 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);
}
1544
EXPORT_SYMBOL(pci_dev_put);
L
Linus Torvalds 已提交
1545

1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567
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;

1568
	if (add_uevent_var(env, "MODALIAS=pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02X",
1569 1570 1571 1572 1573
			   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 已提交
1574

1575 1576 1577
	return 0;
}

1578
#if defined(CONFIG_PCIEPORTBUS) || defined(CONFIG_EEH)
1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613
/**
 * 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

1614 1615 1616 1617 1618
static int pci_bus_num_vf(struct device *dev)
{
	return pci_num_vf(to_pci_dev(dev));
}

1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634
/**
 * 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) {
1635
		ret = of_dma_configure(dev, bridge->parent->of_node, true);
1636 1637 1638
	} else if (has_acpi_companion(bridge)) {
		struct acpi_device *adev = to_acpi_device_node(bridge->fwnode);

1639
		ret = acpi_dma_configure(dev, acpi_get_dma_attr(adev));
1640 1641 1642 1643 1644 1645
	}

	pci_put_host_bridge_device(bridge);
	return ret;
}

L
Linus Torvalds 已提交
1646 1647 1648
struct bus_type pci_bus_type = {
	.name		= "pci",
	.match		= pci_bus_match,
1649
	.uevent		= pci_uevent,
1650 1651
	.probe		= pci_device_probe,
	.remove		= pci_device_remove,
L
Linus Torvalds 已提交
1652
	.shutdown	= pci_device_shutdown,
1653
	.dev_groups	= pci_dev_groups,
1654
	.bus_groups	= pci_bus_groups,
1655
	.drv_groups	= pci_drv_groups,
1656
	.pm		= PCI_PM_OPS_PTR,
1657
	.num_vf		= pci_bus_num_vf,
1658
	.dma_configure	= pci_dma_configure,
L
Linus Torvalds 已提交
1659
};
1660
EXPORT_SYMBOL(pci_bus_type);
L
Linus Torvalds 已提交
1661

1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690
#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 已提交
1691 1692
static int __init pci_driver_init(void)
{
1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703
	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
1704
	dma_debug_add_bus(&pci_bus_type);
1705
	return 0;
L
Linus Torvalds 已提交
1706 1707
}
postcore_initcall(pci_driver_init);