Commit 9d26d3a8 authored by Mika Westerberg's avatar Mika Westerberg Committed by Bjorn Helgaas
Browse files

PCI: Put PCIe ports into D3 during suspend 



Currently the Linux PCI core does not touch power state of PCI bridges and
PCIe ports when system suspend is entered.  Leaving them in D0 consumes
power unnecessarily and may prevent the CPU from entering deeper C-states.

With recent PCIe hardware we can power down the ports to save power given
that we take into account few restrictions:

  - The PCIe port hardware is recent enough, starting from 2015.

  - Devices connected to PCIe ports are effectively in D3cold once the port
    is transitioned to D3 (the config space is not accessible anymore and
    the link may be powered down).

  - Devices behind the PCIe port need to be allowed to transition to D3cold
    and back.  There is a way both drivers and userspace can forbid this.

  - If the device behind the PCIe port is capable of waking the system it
    needs to be able to do so from D3cold.

This patch adds a new flag to struct pci_device called 'bridge_d3'.  This
flag is set and cleared by the PCI core whenever there is a change in power
management state of any of the devices behind the PCIe port.  When system
later on is suspended we only need to check this flag and if it is true
transition the port to D3 otherwise we leave it in D0.

Also provide override mechanism via command line parameter
"pcie_port_pm=[off|force]" that can be used to disable or enable the
feature regardless of the BIOS manufacturing date.

Tested-by: default avatarLukas Wunner <lukas@wunner.de>
Signed-off-by: default avatarMika Westerberg <mika.westerberg@linux.intel.com>
Signed-off-by: default avatarBjorn Helgaas <bhelgaas@google.com>
Acked-by: default avatarRafael J. Wysocki <rafael.j.wysocki@intel.com>
parent 43f7f88b

Documentation/kernel-parameters.txt

+4 −0
Original line number Diff line number Diff line
@@ -3047,6 +3047,10 @@ bytes respectively. Such letter suffixes can also be entirely omitted. 
		compat	Treat PCIe ports as PCI-to-PCI bridges, disable the PCIe

			ports driver.



	pcie_port_pm=	[PCIE] PCIe port power management handling:

		off	Disable power management of all PCIe ports

		force	Forcibly enable power management of all PCIe ports



	pcie_pme=	[PCIE,PM] Native PCIe PME signaling options:

		nomsi	Do not use MSI for native PCIe PME signaling (this makes

			all PCIe root ports use INTx for all services).

drivers/pci/bus.c

+1 −0
Original line number Diff line number Diff line
@@ -291,6 +291,7 @@ void pci_bus_add_device(struct pci_dev *dev) 
	pci_fixup_device(pci_fixup_final, dev);

	pci_create_sysfs_dev_files(dev);

	pci_proc_attach_device(dev);

	pci_bridge_d3_device_changed(dev);



	dev->match_driver = true;

	retval = device_attach(&dev->dev);

drivers/pci/pci-driver.c

+1 −4
Original line number Diff line number Diff line
@@ -777,7 +777,7 @@ static int pci_pm_suspend_noirq(struct device *dev) 


	if (!pci_dev->state_saved) {

		pci_save_state(pci_dev);

		if (!pci_has_subordinate(pci_dev))

		if (pci_power_manageable(pci_dev))

			pci_prepare_to_sleep(pci_dev);

	}
@@ -1144,7 +1144,6 @@ static int pci_pm_runtime_suspend(struct device *dev) 
		return -ENOSYS;



	pci_dev->state_saved = false;

	pci_dev->no_d3cold = false;

	error = pm->runtime_suspend(dev);

	if (error) {

		/*
@@ -1161,8 +1160,6 @@ static int pci_pm_runtime_suspend(struct device *dev) 


		return error;

	}

	if (!pci_dev->d3cold_allowed)

		pci_dev->no_d3cold = true;



	pci_fixup_device(pci_fixup_suspend, pci_dev);

drivers/pci/pci-sysfs.c

+5 −0
Original line number Diff line number Diff line
@@ -406,6 +406,11 @@ static ssize_t d3cold_allowed_store(struct device *dev, 
		return -EINVAL;



	pdev->d3cold_allowed = !!val;

	if (pdev->d3cold_allowed)

		pci_d3cold_enable(pdev);

	else

		pci_d3cold_disable(pdev);



	pm_runtime_resume(dev);



	return count;

drivers/pci/pci.c

+175 −0
Original line number Diff line number Diff line
@@ -9,6 +9,7 @@ 


#include <linux/kernel.h>

#include <linux/delay.h>

#include <linux/dmi.h>

#include <linux/init.h>

#include <linux/of.h>

#include <linux/of_pci.h>
@@ -101,6 +102,21 @@ unsigned int pcibios_max_latency = 255; 
/* If set, the PCIe ARI capability will not be used. */

static bool pcie_ari_disabled;



/* Disable bridge_d3 for all PCIe ports */

static bool pci_bridge_d3_disable;

/* Force bridge_d3 for all PCIe ports */

static bool pci_bridge_d3_force;



static int __init pcie_port_pm_setup(char *str)

{

	if (!strcmp(str, "off"))

		pci_bridge_d3_disable = true;

	else if (!strcmp(str, "force"))

		pci_bridge_d3_force = true;

	return 1;

}

__setup("pcie_port_pm=", pcie_port_pm_setup);



/**

 * pci_bus_max_busnr - returns maximum PCI bus number of given bus' children

 * @bus: pointer to PCI bus structure to search
@@ -2155,6 +2171,164 @@ void pci_config_pm_runtime_put(struct pci_dev *pdev) 
		pm_runtime_put_sync(parent);

}



/**

 * pci_bridge_d3_possible - Is it possible to put the bridge into D3

 * @bridge: Bridge to check

 *

 * This function checks if it is possible to move the bridge to D3.

 * Currently we only allow D3 for recent enough PCIe ports.

 */

static bool pci_bridge_d3_possible(struct pci_dev *bridge)

{

	unsigned int year;



	if (!pci_is_pcie(bridge))

		return false;



	switch (pci_pcie_type(bridge)) {

	case PCI_EXP_TYPE_ROOT_PORT:

	case PCI_EXP_TYPE_UPSTREAM:

	case PCI_EXP_TYPE_DOWNSTREAM:

		if (pci_bridge_d3_disable)

			return false;

		if (pci_bridge_d3_force)

			return true;



		/*

		 * It should be safe to put PCIe ports from 2015 or newer

		 * to D3.

		 */

		if (dmi_get_date(DMI_BIOS_DATE, &year, NULL, NULL) &&

		    year >= 2015) {

			return true;

		}

		break;

	}



	return false;

}



static int pci_dev_check_d3cold(struct pci_dev *dev, void *data)

{

	bool *d3cold_ok = data;

	bool no_d3cold;



	/*

	 * The device needs to be allowed to go D3cold and if it is wake

	 * capable to do so from D3cold.

	 */

	no_d3cold = dev->no_d3cold || !dev->d3cold_allowed ||

		(device_may_wakeup(&dev->dev) && !pci_pme_capable(dev, PCI_D3cold)) ||

		!pci_power_manageable(dev);



	*d3cold_ok = !no_d3cold;



	return no_d3cold;

}



/*

 * pci_bridge_d3_update - Update bridge D3 capabilities

 * @dev: PCI device which is changed

 * @remove: Is the device being removed

 *

 * Update upstream bridge PM capabilities accordingly depending on if the

 * device PM configuration was changed or the device is being removed.  The

 * change is also propagated upstream.

 */

static void pci_bridge_d3_update(struct pci_dev *dev, bool remove)

{

	struct pci_dev *bridge;

	bool d3cold_ok = true;



	bridge = pci_upstream_bridge(dev);

	if (!bridge || !pci_bridge_d3_possible(bridge))

		return;



	pci_dev_get(bridge);

	/*

	 * If the device is removed we do not care about its D3cold

	 * capabilities.

	 */

	if (!remove)

		pci_dev_check_d3cold(dev, &d3cold_ok);



	if (d3cold_ok) {

		/*

		 * We need to go through all children to find out if all of

		 * them can still go to D3cold.

		 */

		pci_walk_bus(bridge->subordinate, pci_dev_check_d3cold,

			     &d3cold_ok);

	}



	if (bridge->bridge_d3 != d3cold_ok) {

		bridge->bridge_d3 = d3cold_ok;

		/* Propagate change to upstream bridges */

		pci_bridge_d3_update(bridge, false);

	}



	pci_dev_put(bridge);

}



/**

 * pci_bridge_d3_device_changed - Update bridge D3 capabilities on change

 * @dev: PCI device that was changed

 *

 * If a device is added or its PM configuration, such as is it allowed to

 * enter D3cold, is changed this function updates upstream bridge PM

 * capabilities accordingly.

 */

void pci_bridge_d3_device_changed(struct pci_dev *dev)

{

	pci_bridge_d3_update(dev, false);

}



/**

 * pci_bridge_d3_device_removed - Update bridge D3 capabilities on remove

 * @dev: PCI device being removed

 *

 * Function updates upstream bridge PM capabilities based on other devices

 * still left on the bus.

 */

void pci_bridge_d3_device_removed(struct pci_dev *dev)

{

	pci_bridge_d3_update(dev, true);

}



/**

 * pci_d3cold_enable - Enable D3cold for device

 * @dev: PCI device to handle

 *

 * This function can be used in drivers to enable D3cold from the device

 * they handle.  It also updates upstream PCI bridge PM capabilities

 * accordingly.

 */

void pci_d3cold_enable(struct pci_dev *dev)

{

	if (dev->no_d3cold) {

		dev->no_d3cold = false;

		pci_bridge_d3_device_changed(dev);

	}

}

EXPORT_SYMBOL_GPL(pci_d3cold_enable);



/**

 * pci_d3cold_disable - Disable D3cold for device

 * @dev: PCI device to handle

 *

 * This function can be used in drivers to disable D3cold from the device

 * they handle.  It also updates upstream PCI bridge PM capabilities

 * accordingly.

 */

void pci_d3cold_disable(struct pci_dev *dev)

{

	if (!dev->no_d3cold) {

		dev->no_d3cold = true;

		pci_bridge_d3_device_changed(dev);

	}

}

EXPORT_SYMBOL_GPL(pci_d3cold_disable);



/**

 * pci_pm_init - Initialize PM functions of given PCI device

 * @dev: PCI device to handle.
@@ -2189,6 +2363,7 @@ void pci_pm_init(struct pci_dev *dev) 
	dev->pm_cap = pm;

	dev->d3_delay = PCI_PM_D3_WAIT;

	dev->d3cold_delay = PCI_PM_D3COLD_WAIT;

	dev->bridge_d3 = pci_bridge_d3_possible(dev);

	dev->d3cold_allowed = true;



	dev->d1_support = false;

CRA Git | Maintained and supported by SUSTech CRA and CCSE