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

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

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

421 422
	pci_assign_irq(pci_dev);

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

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

	return error;
}

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

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

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

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

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

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

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

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

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

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

520 521 522 523
#endif

#ifdef CONFIG_PM_SLEEP

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

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

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

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

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

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

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

	pci_fixup_device(pci_fixup_suspend, pci_dev);

589
	return 0;
L
Linus Torvalds 已提交
590 591
}

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

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

601 602
		error = drv->suspend_late(pci_dev, state);
		suspend_report_result(drv->suspend_late, error);
603 604 605 606 607 608
		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,
609
				"PCI PM: Device state not saved by %pS\n",
610
				drv->suspend_late);
611
			goto Fixup;
612
		}
L
Linus Torvalds 已提交
613
	}
614 615 616 617 618 619

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

	pci_pm_set_unknown_state(pci_dev);

620 621 622
Fixup:
	pci_fixup_device(pci_fixup_suspend_late, pci_dev);

623
	return 0;
L
Linus Torvalds 已提交
624
}
L
Linus Torvalds 已提交
625

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

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

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

640 641
	pci_fixup_device(pci_fixup_resume, pci_dev);

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

646 647
/* Auxiliary functions used by the new power management framework */

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

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

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

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

	return ret;
676 677
}

678 679
/* New power management framework */

680 681 682
static int pci_pm_prepare(struct device *dev)
{
	struct device_driver *drv = dev->driver;
683
	struct pci_dev *pci_dev = to_pci_dev(dev);
684

685 686
	if (drv && drv->pm && drv->pm->prepare) {
		int error = drv->pm->prepare(dev);
687
		if (error < 0)
688
			return error;
689 690 691

		if (!error && dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_PREPARE))
			return 0;
692
	}
693 694 695 696 697 698 699 700 701
	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;
702 703
}

704 705
static void pci_pm_complete(struct device *dev)
{
706 707 708 709 710 711
	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 */
712
	if (pm_runtime_suspended(dev) && pm_resume_via_firmware()) {
713 714
		pci_power_t pre_sleep_state = pci_dev->current_state;

715 716 717 718 719 720 721 722
		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.
		 */
723 724 725
		if (pci_dev->current_state < pre_sleep_state)
			pm_request_resume(dev);
	}
726
}
727

728 729 730
#else /* !CONFIG_PM_SLEEP */

#define pci_pm_prepare	NULL
731
#define pci_pm_complete	NULL
732 733 734

#endif /* !CONFIG_PM_SLEEP */

735
#ifdef CONFIG_SUSPEND
736 737 738 739 740 741 742 743
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) &&
744 745
	    (pci_pcie_type(pci_dev) == PCI_EXP_TYPE_ROOT_PORT ||
	     pci_pcie_type(pci_dev) == PCI_EXP_TYPE_RC_EC))
746 747
		pcie_clear_root_pme_status(pci_dev);
}
748 749 750 751

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

754 755
	pci_dev->skip_bus_pm = false;

756 757
	if (pci_has_legacy_pm_support(pci_dev))
		return pci_legacy_suspend(dev, PMSG_SUSPEND);
758

759 760
	if (!pm) {
		pci_pm_default_suspend(pci_dev);
761
		return 0;
762 763
	}

764
	/*
765 766 767 768 769 770 771 772 773 774 775
	 * 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.
776
	 */
777
	if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
778
	    pci_dev_need_resume(pci_dev)) {
779
		pm_runtime_resume(dev);
780
		pci_dev->state_saved = false;
781 782
	} else {
		pci_dev_adjust_pme(pci_dev);
783
	}
784

785 786 787 788
	if (pm->suspend) {
		pci_power_t prev = pci_dev->current_state;
		int error;

789 790
		error = pm->suspend(dev);
		suspend_report_result(pm->suspend, error);
791 792 793
		if (error)
			return error;

794
		if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
795 796
		    && pci_dev->current_state != PCI_UNKNOWN) {
			WARN_ONCE(pci_dev->current_state != prev,
797
				"PCI PM: State of device not saved by %pS\n",
798 799
				pm->suspend);
		}
800
	}
801

802
	return 0;
803 804
}

805 806 807 808 809 810 811 812 813 814
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);
}

815
static int pci_pm_suspend_noirq(struct device *dev)
G
Greg KH 已提交
816
{
817
	struct pci_dev *pci_dev = to_pci_dev(dev);
818
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
G
Greg KH 已提交
819

820 821
	if (dev_pm_smart_suspend_and_suspended(dev)) {
		dev->power.may_skip_resume = true;
822
		return 0;
823
	}
824

825 826 827
	if (pci_has_legacy_pm_support(pci_dev))
		return pci_legacy_suspend_late(dev, PMSG_SUSPEND);

828 829
	if (!pm) {
		pci_save_state(pci_dev);
830
		goto Fixup;
831
	}
832 833 834 835 836 837 838 839 840 841 842 843 844

	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,
845
				"PCI PM: State of device not saved by %pS\n",
846
				pm->suspend_noirq);
847
			goto Fixup;
848
		}
849 850
	}

851 852
	if (pci_dev->skip_bus_pm) {
		/*
853 854
		 * 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
855
		 * going through full resume, which is possible only during
856 857 858
		 * 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.
859
		 */
860 861 862
		if (!pci_dev->state_saved)
			pci_save_state(pci_dev);
	} else if (!pci_dev->state_saved) {
863
		pci_save_state(pci_dev);
864
		if (pci_power_manageable(pci_dev))
865 866
			pci_prepare_to_sleep(pci_dev);
	}
867

868 869 870
	dev_dbg(dev, "PCI PM: Suspend power state: %s\n",
		pci_power_name(pci_dev->current_state));

871 872 873 874 875 876 877 878 879 880 881
	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;
	}

882
	if (pci_dev->skip_bus_pm && pm_suspend_no_platform()) {
883 884 885 886
		dev_dbg(dev, "PCI PM: Skipped\n");
		goto Fixup;
	}

887 888
	pci_pm_set_unknown_state(pci_dev);

889 890 891 892 893 894 895 896 897 898 899 900
	/*
	 * 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);

901 902 903
Fixup:
	pci_fixup_device(pci_fixup_suspend_late, pci_dev);

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

914
	return 0;
G
Greg KH 已提交
915
}
L
Linus Torvalds 已提交
916

917
static int pci_pm_resume_noirq(struct device *dev)
918 919 920
{
	struct pci_dev *pci_dev = to_pci_dev(dev);
	struct device_driver *drv = dev->driver;
921
	int error = 0;
922

923 924 925
	if (dev_pm_may_skip_resume(dev))
		return 0;

926 927 928 929 930 931 932 933
	/*
	 * 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);

934 935 936
	/*
	 * 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
937 938
	 * configuration here and attempting to put them into D0 again is
	 * pointless, so avoid doing that.
939
	 */
940
	if (!(pci_dev->skip_bus_pm && pm_suspend_no_platform()))
941 942 943
		pci_pm_default_resume_early(pci_dev);

	pci_fixup_device(pci_fixup_resume_early, pci_dev);
944

945
	if (pci_has_legacy_pm_support(pci_dev))
946
		return pci_legacy_resume_early(dev);
947

948 949
	pcie_pme_root_status_cleanup(pci_dev);

950 951
	if (drv && drv->pm && drv->pm->resume_noirq)
		error = drv->pm->resume_noirq(dev);
952 953 954 955

	return error;
}

956
static int pci_pm_resume(struct device *dev)
957
{
958
	struct pci_dev *pci_dev = to_pci_dev(dev);
959
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
960 961
	int error = 0;

962 963 964 965 966 967 968
	/*
	 * 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);

969
	if (pci_has_legacy_pm_support(pci_dev))
970
		return pci_legacy_resume(dev);
971

972
	pci_pm_default_resume(pci_dev);
973

974 975 976 977 978 979
	if (pm) {
		if (pm->resume)
			error = pm->resume(dev);
	} else {
		pci_pm_reenable_device(pci_dev);
	}
980

981
	return error;
982 983 984 985 986
}

#else /* !CONFIG_SUSPEND */

#define pci_pm_suspend		NULL
987
#define pci_pm_suspend_late	NULL
988 989 990 991 992 993
#define pci_pm_suspend_noirq	NULL
#define pci_pm_resume		NULL
#define pci_pm_resume_noirq	NULL

#endif /* !CONFIG_SUSPEND */

994
#ifdef CONFIG_HIBERNATE_CALLBACKS
995

996 997 998 999 1000 1001 1002

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

1003 1004 1005
static int pci_pm_freeze(struct device *dev)
{
	struct pci_dev *pci_dev = to_pci_dev(dev);
1006
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1007

1008 1009
	if (pci_has_legacy_pm_support(pci_dev))
		return pci_legacy_suspend(dev, PMSG_FREEZE);
1010

1011 1012 1013
	if (!pm) {
		pci_pm_default_suspend(pci_dev);
		return 0;
1014 1015
	}

1016
	/*
1017 1018 1019 1020 1021 1022
	 * 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.
1023
	 */
1024 1025
	pm_runtime_resume(dev);
	pci_dev->state_saved = false;
1026

1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
	if (pm->freeze) {
		int error;

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

	return 0;
1037 1038 1039 1040
}

static int pci_pm_freeze_noirq(struct device *dev)
{
1041
	struct pci_dev *pci_dev = to_pci_dev(dev);
1042
	struct device_driver *drv = dev->driver;
1043

1044 1045 1046
	if (pci_has_legacy_pm_support(pci_dev))
		return pci_legacy_suspend_late(dev, PMSG_FREEZE);

1047
	if (drv && drv->pm && drv->pm->freeze_noirq) {
1048 1049
		int error;

1050 1051
		error = drv->pm->freeze_noirq(dev);
		suspend_report_result(drv->pm->freeze_noirq, error);
1052 1053
		if (error)
			return error;
1054 1055
	}

1056 1057
	if (!pci_dev->state_saved)
		pci_save_state(pci_dev);
1058

1059 1060
	pci_pm_set_unknown_state(pci_dev);

1061 1062 1063
	if (pcibios_pm_ops.freeze_noirq)
		return pcibios_pm_ops.freeze_noirq(dev);

1064
	return 0;
1065 1066
}

1067
static int pci_pm_thaw_noirq(struct device *dev)
1068
{
1069
	struct pci_dev *pci_dev = to_pci_dev(dev);
1070 1071 1072
	struct device_driver *drv = dev->driver;
	int error = 0;

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

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

1082 1083 1084 1085 1086 1087
	/*
	 * 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);
1088
	pci_restore_state(pci_dev);
1089

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

	return error;
}

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

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

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

1112 1113
	pci_dev->state_saved = false;

1114 1115 1116 1117 1118
	return error;
}

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

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

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

1130
	/* The reason to do that is the same as in pci_pm_suspend(). */
1131
	if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
1132
	    pci_dev_need_resume(pci_dev)) {
1133
		pm_runtime_resume(dev);
1134 1135 1136 1137
		pci_dev->state_saved = false;
	} else {
		pci_dev_adjust_pme(pci_dev);
	}
1138

1139
	if (pm->poweroff) {
1140 1141
		int error;

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

1148
	return 0;
1149
}
1150

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

1156 1157 1158
	pci_fixup_device(pci_fixup_suspend, to_pci_dev(dev));

	return pm_generic_poweroff_late(dev);
1159 1160 1161 1162
}

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

1166 1167 1168
	if (dev_pm_smart_suspend_and_suspended(dev))
		return 0;

1169 1170 1171
	if (pci_has_legacy_pm_support(to_pci_dev(dev)))
		return pci_legacy_suspend_late(dev, PMSG_HIBERNATE);

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

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

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

1186
	if (!pci_dev->state_saved && !pci_has_subordinate(pci_dev))
1187 1188
		pci_prepare_to_sleep(pci_dev);

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

1196 1197
	pci_fixup_device(pci_fixup_suspend_late, pci_dev);

1198 1199 1200
	if (pcibios_pm_ops.poweroff_noirq)
		return pcibios_pm_ops.poweroff_noirq(dev);

1201
	return 0;
1202 1203
}

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

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

1216
	pci_pm_default_resume_early(pci_dev);
1217
	pci_fixup_device(pci_fixup_resume_early, pci_dev);
1218

1219
	if (pci_has_legacy_pm_support(pci_dev))
1220
		return pci_legacy_resume_early(dev);
1221

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

	return error;
}

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

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

1241
	if (pci_has_legacy_pm_support(pci_dev))
1242
		return pci_legacy_resume(dev);
1243

1244
	pci_pm_default_resume(pci_dev);
1245

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

	return error;
G
Greg KH 已提交
1254
}
L
Linus Torvalds 已提交
1255

1256
#else /* !CONFIG_HIBERNATE_CALLBACKS */
1257 1258 1259 1260 1261 1262

#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
1263
#define pci_pm_poweroff_late	NULL
1264 1265 1266 1267
#define pci_pm_poweroff_noirq	NULL
#define pci_pm_restore		NULL
#define pci_pm_restore_noirq	NULL

1268
#endif /* !CONFIG_HIBERNATE_CALLBACKS */
1269

1270
#ifdef CONFIG_PM
1271 1272 1273 1274 1275 1276 1277 1278

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;

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

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

	pci_fixup_device(pci_fixup_suspend, pci_dev);

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

1319
	if (!pci_dev->state_saved) {
1320
		pci_save_state(pci_dev);
1321 1322
		pci_finish_runtime_suspend(pci_dev);
	}
1323 1324 1325 1326 1327 1328

	return 0;
}

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

1333
	/*
1334 1335 1336
	 * 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.
1337
	 */
1338 1339
	pci_restore_standard_config(pci_dev);

1340 1341 1342
	if (!pci_dev->driver)
		return 0;

1343
	pci_fixup_device(pci_fixup_resume_early, pci_dev);
1344
	pci_enable_wake(pci_dev, PCI_D0, false);
1345 1346
	pci_fixup_device(pci_fixup_resume, pci_dev);

1347 1348
	if (pm && pm->runtime_resume)
		rc = pm->runtime_resume(dev);
1349 1350 1351 1352

	pci_dev->runtime_d3cold = false;

	return rc;
1353 1354 1355 1356
}

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

1361 1362 1363 1364 1365
	/*
	 * 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)
1366
		return 0;
1367

1368 1369 1370
	if (!pm)
		return -ENOSYS;

1371 1372
	if (pm->runtime_idle)
		ret = pm->runtime_idle(dev);
1373

1374
	return ret;
1375 1376
}

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

1399
#define PCI_PM_OPS_PTR	(&pci_dev_pm_ops)
1400

1401 1402 1403 1404 1405
#else /* !CONFIG_PM */

#define pci_pm_runtime_suspend	NULL
#define pci_pm_runtime_resume	NULL
#define pci_pm_runtime_idle	NULL
1406 1407 1408

#define PCI_PM_OPS_PTR	NULL

1409
#endif /* !CONFIG_PM */
1410

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

1432 1433
	spin_lock_init(&drv->dynids.lock);
	INIT_LIST_HEAD(&drv->dynids.list);
L
Linus Torvalds 已提交
1434 1435

	/* register with core */
1436
	return driver_register(&drv->driver);
L
Linus Torvalds 已提交
1437
}
1438
EXPORT_SYMBOL(__pci_register_driver);
L
Linus Torvalds 已提交
1439 1440 1441 1442

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

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

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

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

1497 1498 1499 1500
	if (!pci_dev->match_driver)
		return 0;

	pci_drv = to_pci_driver(drv);
1501
	found_id = pci_match_device(pci_drv, pci_dev);
L
Linus Torvalds 已提交
1502 1503 1504
	if (found_id)
		return 1;

1505
	return 0;
L
Linus Torvalds 已提交
1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525
}

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

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

1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563
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;

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

1571 1572 1573
	return 0;
}

1574
#if defined(CONFIG_PCIEPORTBUS) || defined(CONFIG_EEH)
1575 1576 1577 1578 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
/**
 * 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

1610 1611 1612 1613 1614
static int pci_bus_num_vf(struct device *dev)
{
	return pci_num_vf(to_pci_dev(dev));
}

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

1635
		ret = acpi_dma_configure(dev, acpi_get_dma_attr(adev));
1636 1637 1638 1639 1640 1641
	}

	pci_put_host_bridge_device(bridge);
	return ret;
}

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

1658 1659 1660 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
#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 已提交
1687 1688
static int __init pci_driver_init(void)
{
1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699
	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
1700
	dma_debug_add_bus(&pci_bus_type);
1701
	return 0;
L
Linus Torvalds 已提交
1702 1703
}
postcore_initcall(pci_driver_init);