Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
IronPort-SDR: XejR/9Mbmw6bTXi00mTdvFcXXvW7H7Iu2Lb/jKLy7d/EEPiEaBUwyU5fT62lkUjjIarNomLzrB
 NetAGuBRXJEg==
IronPort-SDR: JS5WF/ZWWJ6drdqE9KPrrDpGO1nBnyE4kYAX0TQWWs/O+DP5LvoNAnanbch5hAQcdmV4FDKhDy
 /8xYVEACsEgA==
From:   "David E. Box" <david.e.box@linux.intel.com>
To:     bhelgaas@google.com, len.brown@intel.com, rafael@kernel.org
Cc:     "David E. Box" <david.e.box@linux.intel.com>,
        linux-pci@vger.kernel.org, linux-pm@vger.kernel.org,
        linux-kernel@vger.kernel.org
Subject: [PATCH] PCI: Disable PTM during suspend on Intel PCI bridges
Date:   Wed,  7 Oct 2020 09:48:51 -0700
Message-Id: <20201007164851.1218-1-david.e.box@linux.intel.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

On Intel Platform Controller Hubs (PCH) since Cannon Lake, the Precision
Time Measurement (PTM) capability can prevent PCIe root ports from power
gating during suspend-to-idle, causing increased power consumption on
systems that suspend using Low Power S0 Idle [1]. The issue is yet to be
root caused but believed to be coming from a race condition in the suspend
flow as the incidence rate varies for different platforms on Linux but the
issue does not occur at all in other operating systems. For now, disable
the feature on suspend on all Intel root ports and enable again on resume.

Link: https://www.uefi.org/sites/default/files/resources/Intel_ACPI_Low_Power_S0_Idle.pdf
Bug: https://bugzilla.kernel.org/show_bug.cgi?id=209361
Tested-by: Len Brown <len.brown@intel.com>
Signed-off-by: David E. Box <david.e.box@linux.intel.com>
---
 drivers/pci/quirks.c | 57 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)

diff --git a/drivers/pci/quirks.c b/drivers/pci/quirks.c
index bdf9b52567e0..e82b1f60c7a1 100644
--- a/drivers/pci/quirks.c
+++ b/drivers/pci/quirks.c
@@ -5632,3 +5632,60 @@ static void apex_pci_fixup_class(struct pci_dev *pdev)
 }
 DECLARE_PCI_FIXUP_CLASS_HEADER(0x1ac1, 0x089a,
 			       PCI_CLASS_NOT_DEFINED, 8, apex_pci_fixup_class);
+
+#ifdef CONFIG_PCIE_PTM
+/*
+ * On Intel Platform Controller Hubs (PCH) since Cannon Lake, the Precision
+ * Time Measurement (PTM) capability can prevent the PCIe root port from
+ * power gating during suspend-to-idle, causing increased power consumption.
+ * So disable the feature on suspend on all Intel root ports and enable
+ * again on resume.
+ */
+static void quirk_intel_ptm_disable_suspend(struct pci_dev *dev)
+{
+	int pos;
+	u32 ctrl;
+
+	if (!(dev->ptm_enabled && dev->ptm_root))
+		return;
+
+	pos = pci_find_ext_capability(dev, PCI_EXT_CAP_ID_PTM);
+	if (!pos)
+		return;
+
+	pci_dbg(dev, "quirk: disabling PTM\n");
+
+	dev->ptm_enabled = 0;
+	dev->ptm_root = 0;
+
+	pci_read_config_dword(dev, pos + PCI_PTM_CTRL, &ctrl);
+	ctrl &= ~(PCI_PTM_CTRL_ENABLE | PCI_PTM_CTRL_ROOT);
+	pci_write_config_dword(dev, pos + PCI_PTM_CTRL, ctrl);
+}
+
+static void quirk_intel_ptm_enable_resume(struct pci_dev *dev)
+{
+	int pos;
+	u32 ctrl;
+
+	pos = pci_find_ext_capability(dev, PCI_EXT_CAP_ID_PTM);
+	if (!pos)
+		return;
+
+	pci_dbg(dev, "quirk: re-enabling PTM\n");
+
+	pci_read_config_dword(dev, pos + PCI_PTM_CTRL, &ctrl);
+	ctrl |= PCI_PTM_CTRL_ENABLE | PCI_PTM_CTRL_ROOT;
+	pci_write_config_dword(dev, pos + PCI_PTM_CTRL, ctrl);
+
+	dev->ptm_enabled = 1;
+	dev->ptm_root = 1;
+}
+
+DECLARE_PCI_FIXUP_CLASS_SUSPEND(PCI_VENDOR_ID_INTEL, PCI_ANY_ID,
+				PCI_CLASS_BRIDGE_PCI, 8,
+				quirk_intel_ptm_disable_suspend)
+DECLARE_PCI_FIXUP_CLASS_RESUME(PCI_VENDOR_ID_INTEL, PCI_ANY_ID,
+			       PCI_CLASS_BRIDGE_PCI, 8,
+			       quirk_intel_ptm_enable_resume)
+#endif
-- 
2.20.1