pci-driver.c 40.4 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>
L
Linus Torvalds 已提交
19
#include "pci.h"
20
#include "pcie/portdrv.h"
L
Linus Torvalds 已提交
21

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

T
Tejun Heo 已提交
27 28 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
/**
 * 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;
67

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

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

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

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

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

113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
	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;
	}

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

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

C
Chris Wright 已提交
156 157 158 159 160 161 162 163
/**
 * 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.
 */
164
static ssize_t remove_id_store(struct device_driver *driver, const char *buf,
R
Ryan Desfosses 已提交
165
			       size_t count)
C
Chris Wright 已提交
166 167 168 169 170 171
{
	struct pci_dynid *dynid, *n;
	struct pci_driver *pdrv = to_pci_driver(driver);
	__u32 vendor, device, subvendor = PCI_ANY_ID,
		subdevice = PCI_ANY_ID, class = 0, class_mask = 0;
	int fields = 0;
172
	size_t retval = -ENODEV;
C
Chris Wright 已提交
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189

	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);
190
			retval = count;
C
Chris Wright 已提交
191 192 193 194 195
			break;
		}
	}
	spin_unlock(&pdrv->dynids.lock);

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

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

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

233 234 235 236 237 238 239
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 已提交
240
/**
R
Randy Dunlap 已提交
241
 * pci_match_device - Tell if a PCI device structure has a matching PCI device id structure
242
 * @drv: the PCI driver to match against
243
 * @dev: the PCI device structure to match against
244 245 246 247
 *
 * 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 已提交
248
 */
A
Adrian Bunk 已提交
249 250
static const struct pci_device_id *pci_match_device(struct pci_driver *drv,
						    struct pci_dev *dev)
251 252
{
	struct pci_dynid *dynid;
253 254 255 256 257
	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 已提交
258

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

269 270 271 272 273 274 275 276
	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 已提交
277 278
}

279 280 281 282 283 284 285 286 287
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;
288 289 290
	struct pci_dev *pci_dev = ddi->dev;
	struct pci_driver *pci_drv = ddi->drv;
	struct device *dev = &pci_dev->dev;
291 292
	int rc;

293 294 295 296
	/*
	 * 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
297 298 299 300
	 * 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.
301
	 */
302 303 304
	pm_runtime_get_sync(dev);
	pci_dev->driver = pci_drv;
	rc = pci_drv->probe(pci_dev, ddi->id);
305 306 307
	if (!rc)
		return rc;
	if (rc < 0) {
308 309
		pci_dev->driver = NULL;
		pm_runtime_put_sync(dev);
310
		return rc;
311
	}
312 313 314 315 316 317
	/*
	 * 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;
318 319
}

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

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

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

	cpu_hotplug_disable();
344 345

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

	if (cpu < nr_cpu_ids)
		error = work_on_cpu(cpu, local_pci_probe, &ddi);
	else
358
		error = local_pci_probe(&ddi);
359

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

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

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

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

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

void __weak pcibios_free_irq(struct pci_dev *dev)
{
}

397 398 399 400 401 402 403 404 405 406 407 408
#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 已提交
409
static int pci_device_probe(struct device *dev)
L
Linus Torvalds 已提交
410
{
411 412 413 414
	int error;
	struct pci_dev *pci_dev = to_pci_dev(dev);
	struct pci_driver *drv = to_pci_driver(dev->driver);

415 416
	pci_assign_irq(pci_dev);

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

	pci_dev_get(pci_dev);
422 423 424 425 426 427
	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);
		}
428
	}
L
Linus Torvalds 已提交
429 430 431 432

	return error;
}

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

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

448
	/* Undo the runtime PM settings in local_pci_probe() */
449
	pm_runtime_put_sync(dev);
450

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

471 472 473 474 475
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 已提交
476 477
	pm_runtime_resume(dev);

478 479
	if (drv && drv->shutdown)
		drv->shutdown(pci_dev);
480

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

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

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

510
	pci_restore_state(pci_dev);
511
	pci_pme_restore(pci_dev);
512
	return 0;
513 514
}

515 516 517 518
#endif

#ifdef CONFIG_PM_SLEEP

519 520
static void pci_pm_default_resume_early(struct pci_dev *pci_dev)
{
521 522
	pci_power_up(pci_dev);
	pci_restore_state(pci_dev);
523
	pci_pme_restore(pci_dev);
524 525 526
	pci_fixup_device(pci_fixup_resume_early, pci_dev);
}

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

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

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

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

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

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

	pci_fixup_device(pci_fixup_suspend, pci_dev);

585
	return 0;
L
Linus Torvalds 已提交
586 587
}

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

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

597 598
		error = drv->suspend_late(pci_dev, state);
		suspend_report_result(drv->suspend_late, error);
599 600 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,
				"PCI PM: Device state not saved by %pF\n",
				drv->suspend_late);
607
			goto Fixup;
608
		}
L
Linus Torvalds 已提交
609
	}
610 611 612 613 614 615

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

	pci_pm_set_unknown_state(pci_dev);

616 617 618
Fixup:
	pci_fixup_device(pci_fixup_suspend_late, pci_dev);

619
	return 0;
L
Linus Torvalds 已提交
620
}
L
Linus Torvalds 已提交
621

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

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

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

636 637
	pci_fixup_device(pci_fixup_resume, pci_dev);

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

642 643
/* Auxiliary functions used by the new power management framework */

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

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

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

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

	return ret;
672 673
}

674 675
/* New power management framework */

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

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

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

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

708 709 710
#else /* !CONFIG_PM_SLEEP */

#define pci_pm_prepare	NULL
711
#define pci_pm_complete	NULL
712 713 714

#endif /* !CONFIG_PM_SLEEP */

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

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

734 735
	if (pci_has_legacy_pm_support(pci_dev))
		return pci_legacy_suspend(dev, PMSG_SUSPEND);
736

737 738
	if (!pm) {
		pci_pm_default_suspend(pci_dev);
739
		return 0;
740 741
	}

742
	/*
743 744 745 746 747 748 749 750 751 752 753
	 * 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.
754
	 */
755 756 757
	if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
	    !pci_dev_keep_suspended(pci_dev))
		pm_runtime_resume(dev);
758

759
	pci_dev->state_saved = false;
760 761 762 763
	if (pm->suspend) {
		pci_power_t prev = pci_dev->current_state;
		int error;

764 765
		error = pm->suspend(dev);
		suspend_report_result(pm->suspend, error);
766 767 768
		if (error)
			return error;

769
		if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
770 771 772 773 774
		    && pci_dev->current_state != PCI_UNKNOWN) {
			WARN_ONCE(pci_dev->current_state != prev,
				"PCI PM: State of device not saved by %pF\n",
				pm->suspend);
		}
775
	}
776

777
	return 0;
778 779
}

780 781 782 783 784 785 786 787 788 789
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);
}

790
static int pci_pm_suspend_noirq(struct device *dev)
G
Greg KH 已提交
791
{
792
	struct pci_dev *pci_dev = to_pci_dev(dev);
793
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
G
Greg KH 已提交
794

795 796
	if (dev_pm_smart_suspend_and_suspended(dev)) {
		dev->power.may_skip_resume = true;
797
		return 0;
798
	}
799

800 801 802
	if (pci_has_legacy_pm_support(pci_dev))
		return pci_legacy_suspend_late(dev, PMSG_SUSPEND);

803 804
	if (!pm) {
		pci_save_state(pci_dev);
805
		goto Fixup;
806
	}
807 808 809 810 811 812 813 814 815 816 817 818 819 820 821

	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,
				"PCI PM: State of device not saved by %pF\n",
				pm->suspend_noirq);
822
			goto Fixup;
823
		}
824 825
	}

826 827
	if (!pci_dev->state_saved) {
		pci_save_state(pci_dev);
828
		if (pci_power_manageable(pci_dev))
829 830
			pci_prepare_to_sleep(pci_dev);
	}
831

832 833 834
	dev_dbg(dev, "PCI PM: Suspend power state: %s\n",
		pci_power_name(pci_dev->current_state));

835 836
	pci_pm_set_unknown_state(pci_dev);

837 838 839 840 841 842 843 844 845 846 847 848
	/*
	 * 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);

849 850 851
Fixup:
	pci_fixup_device(pci_fixup_suspend_late, pci_dev);

852 853 854 855 856 857 858 859 860 861
	/*
	 * 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);

862
	return 0;
G
Greg KH 已提交
863
}
L
Linus Torvalds 已提交
864

865
static int pci_pm_resume_noirq(struct device *dev)
866 867 868
{
	struct pci_dev *pci_dev = to_pci_dev(dev);
	struct device_driver *drv = dev->driver;
869
	int error = 0;
870

871 872 873
	if (dev_pm_may_skip_resume(dev))
		return 0;

874 875 876 877 878 879 880 881
	/*
	 * 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);

882
	pci_pm_default_resume_early(pci_dev);
883

884
	if (pci_has_legacy_pm_support(pci_dev))
885
		return pci_legacy_resume_early(dev);
886

887 888
	pcie_pme_root_status_cleanup(pci_dev);

889 890
	if (drv && drv->pm && drv->pm->resume_noirq)
		error = drv->pm->resume_noirq(dev);
891 892 893 894

	return error;
}

895
static int pci_pm_resume(struct device *dev)
896
{
897
	struct pci_dev *pci_dev = to_pci_dev(dev);
898
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
899 900
	int error = 0;

901 902 903 904 905 906 907
	/*
	 * 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);

908
	if (pci_has_legacy_pm_support(pci_dev))
909
		return pci_legacy_resume(dev);
910

911
	pci_pm_default_resume(pci_dev);
912

913 914 915 916 917 918
	if (pm) {
		if (pm->resume)
			error = pm->resume(dev);
	} else {
		pci_pm_reenable_device(pci_dev);
	}
919

920
	return error;
921 922 923 924 925
}

#else /* !CONFIG_SUSPEND */

#define pci_pm_suspend		NULL
926
#define pci_pm_suspend_late	NULL
927 928 929 930 931 932
#define pci_pm_suspend_noirq	NULL
#define pci_pm_resume		NULL
#define pci_pm_resume_noirq	NULL

#endif /* !CONFIG_SUSPEND */

933
#ifdef CONFIG_HIBERNATE_CALLBACKS
934

935 936 937 938 939 940 941

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

942 943 944
static int pci_pm_freeze(struct device *dev)
{
	struct pci_dev *pci_dev = to_pci_dev(dev);
945
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
946

947 948
	if (pci_has_legacy_pm_support(pci_dev))
		return pci_legacy_suspend(dev, PMSG_FREEZE);
949

950 951 952
	if (!pm) {
		pci_pm_default_suspend(pci_dev);
		return 0;
953 954
	}

955 956 957 958 959 960
	/*
	 * 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.
	 */
961
	if (!dev_pm_smart_suspend_and_suspended(dev)) {
962
		pm_runtime_resume(dev);
963 964
		pci_dev->state_saved = false;
	}
965

966 967 968 969 970 971 972 973 974 975
	if (pm->freeze) {
		int error;

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

	return 0;
976 977
}

978 979 980 981 982
static int pci_pm_freeze_late(struct device *dev)
{
	if (dev_pm_smart_suspend_and_suspended(dev))
		return 0;

983
	return pm_generic_freeze_late(dev);
984 985
}

986 987
static int pci_pm_freeze_noirq(struct device *dev)
{
988
	struct pci_dev *pci_dev = to_pci_dev(dev);
989
	struct device_driver *drv = dev->driver;
990

991 992 993
	if (dev_pm_smart_suspend_and_suspended(dev))
		return 0;

994 995 996
	if (pci_has_legacy_pm_support(pci_dev))
		return pci_legacy_suspend_late(dev, PMSG_FREEZE);

997
	if (drv && drv->pm && drv->pm->freeze_noirq) {
998 999
		int error;

1000 1001
		error = drv->pm->freeze_noirq(dev);
		suspend_report_result(drv->pm->freeze_noirq, error);
1002 1003
		if (error)
			return error;
1004 1005
	}

1006 1007
	if (!pci_dev->state_saved)
		pci_save_state(pci_dev);
1008

1009 1010
	pci_pm_set_unknown_state(pci_dev);

1011 1012 1013
	if (pcibios_pm_ops.freeze_noirq)
		return pcibios_pm_ops.freeze_noirq(dev);

1014
	return 0;
1015 1016
}

1017
static int pci_pm_thaw_noirq(struct device *dev)
1018
{
1019
	struct pci_dev *pci_dev = to_pci_dev(dev);
1020 1021 1022
	struct device_driver *drv = dev->driver;
	int error = 0;

1023 1024 1025 1026 1027 1028
	/*
	 * 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)) {
1029
		dev_pm_skip_next_resume_phases(dev);
1030 1031 1032
		return 0;
	}

1033 1034 1035 1036 1037 1038
	if (pcibios_pm_ops.thaw_noirq) {
		error = pcibios_pm_ops.thaw_noirq(dev);
		if (error)
			return error;
	}

1039
	if (pci_has_legacy_pm_support(pci_dev))
1040
		return pci_legacy_resume_early(dev);
1041

1042 1043 1044 1045 1046 1047
	/*
	 * 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);
1048
	pci_restore_state(pci_dev);
1049

1050 1051
	if (drv && drv->pm && drv->pm->thaw_noirq)
		error = drv->pm->thaw_noirq(dev);
1052 1053 1054 1055

	return error;
}

1056
static int pci_pm_thaw(struct device *dev)
1057
{
1058
	struct pci_dev *pci_dev = to_pci_dev(dev);
1059
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1060 1061
	int error = 0;

1062
	if (pci_has_legacy_pm_support(pci_dev))
1063
		return pci_legacy_resume(dev);
1064

1065 1066 1067 1068 1069 1070
	if (pm) {
		if (pm->thaw)
			error = pm->thaw(dev);
	} else {
		pci_pm_reenable_device(pci_dev);
	}
1071

1072 1073
	pci_dev->state_saved = false;

1074 1075 1076 1077 1078
	return error;
}

static int pci_pm_poweroff(struct device *dev)
{
1079
	struct pci_dev *pci_dev = to_pci_dev(dev);
1080
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1081

1082 1083
	if (pci_has_legacy_pm_support(pci_dev))
		return pci_legacy_suspend(dev, PMSG_HIBERNATE);
1084

1085 1086
	if (!pm) {
		pci_pm_default_suspend(pci_dev);
1087
		return 0;
1088 1089
	}

1090
	/* The reason to do that is the same as in pci_pm_suspend(). */
1091 1092 1093
	if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
	    !pci_dev_keep_suspended(pci_dev))
		pm_runtime_resume(dev);
1094

1095
	pci_dev->state_saved = false;
1096
	if (pm->poweroff) {
1097 1098
		int error;

1099 1100
		error = pm->poweroff(dev);
		suspend_report_result(pm->poweroff, error);
1101 1102
		if (error)
			return error;
1103 1104
	}

1105
	return 0;
1106
}
1107

1108 1109 1110 1111
static int pci_pm_poweroff_late(struct device *dev)
{
	if (dev_pm_smart_suspend_and_suspended(dev))
		return 0;
1112

1113 1114 1115
	pci_fixup_device(pci_fixup_suspend, to_pci_dev(dev));

	return pm_generic_poweroff_late(dev);
1116 1117 1118 1119
}

static int pci_pm_poweroff_noirq(struct device *dev)
{
1120
	struct pci_dev *pci_dev = to_pci_dev(dev);
1121
	struct device_driver *drv = dev->driver;
1122

1123 1124 1125
	if (dev_pm_smart_suspend_and_suspended(dev))
		return 0;

1126 1127 1128
	if (pci_has_legacy_pm_support(to_pci_dev(dev)))
		return pci_legacy_suspend_late(dev, PMSG_HIBERNATE);

1129 1130
	if (!drv || !drv->pm) {
		pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1131
		return 0;
1132
	}
1133 1134 1135 1136

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

1137 1138
		error = drv->pm->poweroff_noirq(dev);
		suspend_report_result(drv->pm->poweroff_noirq, error);
1139 1140
		if (error)
			return error;
1141 1142
	}

1143
	if (!pci_dev->state_saved && !pci_has_subordinate(pci_dev))
1144 1145
		pci_prepare_to_sleep(pci_dev);

1146 1147 1148 1149 1150 1151 1152
	/*
	 * 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);

1153 1154
	pci_fixup_device(pci_fixup_suspend_late, pci_dev);

1155 1156 1157
	if (pcibios_pm_ops.poweroff_noirq)
		return pcibios_pm_ops.poweroff_noirq(dev);

1158
	return 0;
1159 1160
}

1161
static int pci_pm_restore_noirq(struct device *dev)
1162 1163 1164
{
	struct pci_dev *pci_dev = to_pci_dev(dev);
	struct device_driver *drv = dev->driver;
1165
	int error = 0;
1166

1167 1168 1169 1170
	/* This is analogous to the pci_pm_resume_noirq() case. */
	if (dev_pm_smart_suspend_and_suspended(dev))
		pm_runtime_set_active(dev);

1171 1172 1173 1174 1175 1176
	if (pcibios_pm_ops.restore_noirq) {
		error = pcibios_pm_ops.restore_noirq(dev);
		if (error)
			return error;
	}

1177
	pci_pm_default_resume_early(pci_dev);
1178

1179
	if (pci_has_legacy_pm_support(pci_dev))
1180
		return pci_legacy_resume_early(dev);
1181

1182 1183
	if (drv && drv->pm && drv->pm->restore_noirq)
		error = drv->pm->restore_noirq(dev);
1184 1185 1186 1187

	return error;
}

1188
static int pci_pm_restore(struct device *dev)
1189 1190
{
	struct pci_dev *pci_dev = to_pci_dev(dev);
1191
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1192 1193
	int error = 0;

1194 1195 1196 1197 1198 1199 1200
	/*
	 * 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);

1201
	if (pci_has_legacy_pm_support(pci_dev))
1202
		return pci_legacy_resume(dev);
1203

1204
	pci_pm_default_resume(pci_dev);
1205

1206 1207 1208 1209 1210 1211
	if (pm) {
		if (pm->restore)
			error = pm->restore(dev);
	} else {
		pci_pm_reenable_device(pci_dev);
	}
1212 1213

	return error;
G
Greg KH 已提交
1214
}
L
Linus Torvalds 已提交
1215

1216
#else /* !CONFIG_HIBERNATE_CALLBACKS */
1217 1218

#define pci_pm_freeze		NULL
1219
#define pci_pm_freeze_late	NULL
1220 1221 1222 1223
#define pci_pm_freeze_noirq	NULL
#define pci_pm_thaw		NULL
#define pci_pm_thaw_noirq	NULL
#define pci_pm_poweroff		NULL
1224
#define pci_pm_poweroff_late	NULL
1225 1226 1227 1228
#define pci_pm_poweroff_noirq	NULL
#define pci_pm_restore		NULL
#define pci_pm_restore_noirq	NULL

1229
#endif /* !CONFIG_HIBERNATE_CALLBACKS */
1230

1231
#ifdef CONFIG_PM
1232 1233 1234 1235 1236 1237 1238 1239

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;

1240
	/*
1241 1242 1243
	 * 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.
1244
	 */
1245 1246
	if (!pci_dev->driver) {
		pci_save_state(pci_dev);
1247
		return 0;
1248
	}
1249

1250 1251 1252
	if (!pm || !pm->runtime_suspend)
		return -ENOSYS;

1253
	pci_dev->state_saved = false;
1254
	error = pm->runtime_suspend(dev);
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267
	if (error) {
		/*
		 * -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.
		 */
		if (error == -EBUSY || error == -EAGAIN)
			dev_dbg(dev, "can't suspend now (%pf returned %d)\n",
				pm->runtime_suspend, error);
		else
			dev_err(dev, "can't suspend (%pf returned %d)\n",
				pm->runtime_suspend, error);

1268
		return error;
1269
	}
1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280

	pci_fixup_device(pci_fixup_suspend, pci_dev);

	if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
	    && pci_dev->current_state != PCI_UNKNOWN) {
		WARN_ONCE(pci_dev->current_state != prev,
			"PCI PM: State of device not saved by %pF\n",
			pm->runtime_suspend);
		return 0;
	}

1281
	if (!pci_dev->state_saved) {
1282
		pci_save_state(pci_dev);
1283 1284
		pci_finish_runtime_suspend(pci_dev);
	}
1285 1286 1287 1288 1289 1290

	return 0;
}

static int pci_pm_runtime_resume(struct device *dev)
{
1291
	int rc;
1292 1293 1294
	struct pci_dev *pci_dev = to_pci_dev(dev);
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;

1295
	/*
1296 1297 1298
	 * 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.
1299
	 */
1300 1301
	pci_restore_standard_config(pci_dev);

1302 1303 1304
	if (!pci_dev->driver)
		return 0;

1305 1306 1307
	if (!pm || !pm->runtime_resume)
		return -ENOSYS;

1308
	pci_fixup_device(pci_fixup_resume_early, pci_dev);
1309
	pci_enable_wake(pci_dev, PCI_D0, false);
1310 1311
	pci_fixup_device(pci_fixup_resume, pci_dev);

1312 1313 1314 1315 1316
	rc = pm->runtime_resume(dev);

	pci_dev->runtime_d3cold = false;

	return rc;
1317 1318 1319 1320
}

static int pci_pm_runtime_idle(struct device *dev)
{
1321
	struct pci_dev *pci_dev = to_pci_dev(dev);
1322
	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1323
	int ret = 0;
1324

1325 1326 1327 1328 1329
	/*
	 * 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)
1330
		return 0;
1331

1332 1333 1334
	if (!pm)
		return -ENOSYS;

1335 1336
	if (pm->runtime_idle)
		ret = pm->runtime_idle(dev);
1337

1338
	return ret;
1339 1340
}

S
Sachin Kamat 已提交
1341
static const struct dev_pm_ops pci_dev_pm_ops = {
1342
	.prepare = pci_pm_prepare,
1343
	.complete = pci_pm_complete,
1344
	.suspend = pci_pm_suspend,
1345
	.suspend_late = pci_pm_suspend_late,
1346 1347
	.resume = pci_pm_resume,
	.freeze = pci_pm_freeze,
1348
	.freeze_late = pci_pm_freeze_late,
1349 1350
	.thaw = pci_pm_thaw,
	.poweroff = pci_pm_poweroff,
1351
	.poweroff_late = pci_pm_poweroff_late,
1352
	.restore = pci_pm_restore,
1353 1354 1355 1356 1357 1358
	.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,
1359 1360 1361
	.runtime_suspend = pci_pm_runtime_suspend,
	.runtime_resume = pci_pm_runtime_resume,
	.runtime_idle = pci_pm_runtime_idle,
1362 1363
};

1364
#define PCI_PM_OPS_PTR	(&pci_dev_pm_ops)
1365

1366 1367 1368 1369 1370
#else /* !CONFIG_PM */

#define pci_pm_runtime_suspend	NULL
#define pci_pm_runtime_resume	NULL
#define pci_pm_runtime_idle	NULL
1371 1372 1373

#define PCI_PM_OPS_PTR	NULL

1374
#endif /* !CONFIG_PM */
1375

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

1397 1398
	spin_lock_init(&drv->dynids.lock);
	INIT_LIST_HEAD(&drv->dynids.list);
L
Linus Torvalds 已提交
1399 1400

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

/**
 * pci_unregister_driver - unregister a pci driver
 * @drv: the driver structure to unregister
1408
 *
L
Linus Torvalds 已提交
1409 1410 1411 1412 1413 1414
 * 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 已提交
1415
void pci_unregister_driver(struct pci_driver *drv)
L
Linus Torvalds 已提交
1416 1417 1418 1419
{
	driver_unregister(&drv->driver);
	pci_free_dynids(drv);
}
1420
EXPORT_SYMBOL(pci_unregister_driver);
L
Linus Torvalds 已提交
1421 1422 1423 1424 1425 1426 1427 1428 1429

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

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

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

1462 1463 1464 1465
	if (!pci_dev->match_driver)
		return 0;

	pci_drv = to_pci_driver(drv);
1466
	found_id = pci_match_device(pci_drv, pci_dev);
L
Linus Torvalds 已提交
1467 1468 1469
	if (found_id)
		return 1;

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

/**
 * 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;
}
1491
EXPORT_SYMBOL(pci_dev_get);
L
Linus Torvalds 已提交
1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504

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

1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528
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;

1529
	if (add_uevent_var(env, "MODALIAS=pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02X",
1530 1531 1532 1533 1534
			   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 已提交
1535

1536 1537 1538
	return 0;
}

1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574
#if defined(CONFIG_PCIEAER) || defined(CONFIG_EEH)
/**
 * 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

1575 1576 1577 1578 1579
static int pci_bus_num_vf(struct device *dev)
{
	return pci_num_vf(to_pci_dev(dev));
}

L
Linus Torvalds 已提交
1580 1581 1582
struct bus_type pci_bus_type = {
	.name		= "pci",
	.match		= pci_bus_match,
1583
	.uevent		= pci_uevent,
1584 1585
	.probe		= pci_device_probe,
	.remove		= pci_device_remove,
L
Linus Torvalds 已提交
1586
	.shutdown	= pci_device_shutdown,
1587
	.dev_groups	= pci_dev_groups,
1588
	.bus_groups	= pci_bus_groups,
1589
	.drv_groups	= pci_drv_groups,
1590
	.pm		= PCI_PM_OPS_PTR,
1591
	.num_vf		= pci_bus_num_vf,
1592
	.force_dma	= true,
L
Linus Torvalds 已提交
1593
};
1594
EXPORT_SYMBOL(pci_bus_type);
L
Linus Torvalds 已提交
1595

1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624
#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 已提交
1625 1626
static int __init pci_driver_init(void)
{
1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639
	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

	return 0;
L
Linus Torvalds 已提交
1640 1641
}
postcore_initcall(pci_driver_init);