Received-SPF: pass (google.com: domain of linux-kernel+bounces-64379-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223;
From: Frank Li <Frank.Li@nxp.com>
Date: Tue, 13 Feb 2024 16:50:26 -0500
Subject: [PATCH v4 5/5] PCI: dwc: Add common send PME_Turn_Off message
 method
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit
Message-Id: <20240213-pme_msg-v4-5-e2acd4d7a292@nxp.com>
References: <20240213-pme_msg-v4-0-e2acd4d7a292@nxp.com>
In-Reply-To: <20240213-pme_msg-v4-0-e2acd4d7a292@nxp.com>
To: Bjorn Helgaas <bhelgaas@google.com>, Jingoo Han <jingoohan1@gmail.com>, 
 Gustavo Pimentel <gustavo.pimentel@synopsys.com>, 
 Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>, 
 Lorenzo Pieralisi <lpieralisi@kernel.org>, 
 =?utf-8?q?Krzysztof_Wilczy=C5=84ski?= <kw@linux.com>, 
 Rob Herring <robh@kernel.org>, 
 Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>, 
 Conor Dooley <conor+dt@kernel.org>, imx@lists.linux.dev
Cc: linux-pci@vger.kernel.org, linux-kernel@vger.kernel.org, 
 devicetree@vger.kernel.org, Frank Li <Frank.Li@nxp.com>
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?utf-8?B?QlRnQmNSUGRnOWc3STdMY3lpNXoxY204Z3BORFM4ZStURDlQZEd1YUZ3WGt0?=
 =?utf-8?B?cTFLWnYzTDFLaTJuVFIvK2dNdGNqWnRQbk5vcGcwVTR3bnlFeWhKd1JaSkZS?=
 =?utf-8?B?R0dNKzVYMnVIMUwzSzNiTzdLZWNyUXQxbXJtckpGL1dubDkxWTlFM3J5Uzhr?=
 =?utf-8?B?b3NGSWY0RDlNT0p1ZElBaGdZTXB6eUZSaTFSbzFvaHdhaFN4Ymh5eDNVR3Y2?=
 =?utf-8?B?MWV6a1JWOE11ZXZrMGRqaEU1bWF3L0dzNTNHN2xnZW0vV0VWZmFpQ0tVckRt?=
 =?utf-8?B?V2VIN0Z1ZjVxcjNNcnlGNHphUHJlSjZ4V1kwc3V1RTFPenN2VGpaTTc0ZTVT?=
 =?utf-8?B?M3NqT05XaTMwb3l6TFhlTTVrU3l2REE1aTluYTBzUXdzbVIwR1BJSWxOVTlE?=
 =?utf-8?B?RlJCLzI2TjJURUlLMERzY0czZ2ZVeWJEajhyQ3puUldmTGhHNkNRakZNSXV1?=
 =?utf-8?B?RVp4UnNVQUh1TU0wRXdmTWlDQVhNTmFJdFRWcHhOaHh2SVU3SXl0TEFWSHhu?=
 =?utf-8?B?VllPdFZ5QitaQnhqelJqbGIvTUplR3JTYUg3d3I4OXFZaFhocjZ0Mld6a0Z0?=
 =?utf-8?B?T3orRy90VXUveHJab09wMDNuNFlsR3d5N1dCY0FCRjJWOUd6VDhDOGp1Z3Qx?=
 =?utf-8?B?L3l3K0hzODJOSXp1M0RIaDNTT0o4Vk85b0VmVXh1TE1QU2JzUzRoczFIbnE1?=
 =?utf-8?B?YXdQOXJpN1hyK2d1ZFhUdjZHSTNNUTdCTE0wSVdFZUlOandaNW91ZGFVUzJH?=
 =?utf-8?B?RkJ0Ti8zN2JiMnpvd2JUVjJtN0tDUVFxcWs5UzA1QlZMUUJQZGpJYnc4aTYx?=
 =?utf-8?B?eHdrVlNrMHlDOTZNWWUzY2l6QytzSlVBbDNOQjBNd3RTaTFTNGVmWXVJNm8v?=
 =?utf-8?B?MzJJbHBENXBPMTJjOHpPeXhvRDQzZU1yMUF4bElINXlNZ21EbFVVUC9aT2hP?=
 =?utf-8?B?U1IxQWpETng4bi9LN2U2WENReVE1ekRmbEo3RWVTK2ZkVUkzWEZjRmNYbXpU?=
 =?utf-8?B?eWxmem16enlWeFZMQVNoK29oelZPSWoyNXp6eTJmQ0llc1VqU0dHTDFUbzho?=
 =?utf-8?B?TFVweHJRNFlVclZ2dFNmQVh4QUhsS0NXN3VEN2dhcUJQUXFhZ0VMbzZCMFZr?=
 =?utf-8?B?OG9SOERSaFBObUxEc0pHcFN1azJFWHdDUTRXR1M2WUdoeVpQSldxejFHcmdr?=
 =?utf-8?B?RFNCS05OdlduTVExUHVLaXRtNnlZeGFFeHM3U2FrQUY0N1pGRGtGTWRmMGVP?=
 =?utf-8?B?SjJ5VGFPR24xbWVtNzhXak5TSjFUb2VNSk1sYXVaVzJPemJMSE4zRjZyS1dw?=
 =?utf-8?B?dzZTdDNpWnZKOVU0U2svS3d3Ym9xWkxON3BHaHpNMXJIeXN5Z1ZqMnpTYlBj?=
 =?utf-8?B?SkJQNUJmWFlNY3ZnL3V5OGRkR2RuQXBIM1VtZ0wwcndPcDlTSGpMSlYvS3hz?=
 =?utf-8?B?c2JoVG5OcTJKOG8yUGEwZklGVzhVc2c1L1NMRFBub0Q1LzdHT20zNldZWHNV?=
 =?utf-8?B?WTJ3S3VIVktoakdDTzBQVDVmMEhvZlYvQm9DZmt1YVgyTGVwL0Mxd3QwekRF?=
 =?utf-8?B?V25uWE5PdHRIQjlMVUZjUXZkdzFLLytwRytzUWpxdkd5azZGbWdvVzNWZmx3?=
 =?utf-8?B?Zkh2ZWljVGxUb2I0TkpHQWNWZ3EwdDRkSVlxT2FRM3VpWWlFZU94ZUpJVmx3?=
 =?utf-8?B?dVB4MXJOc3ErOGxFaUlvKyt4Y3hac2NESXJUdldkSVEydlUyWmJsajYxWllZ?=
 =?utf-8?B?NnM0bnFPb3FmT1Zqd2JsWkNqSW1ETnFTanhWV0l5OG5GN0pwUS85L3dPUE9p?=
 =?utf-8?B?U3lkTlBVZVp2NVYwV3pHVVVuOTIyQXo2OWI1Rm8waHlKU0J6NW5ma3RZK3A3?=
 =?utf-8?B?MFU2UElvbURZdFZ0OEQvZFY2NXlNMHZ0b3FMUkQrREh3Q214WG9TRnp6Nnho?=
 =?utf-8?B?Z3czRFdvZkpJY20xSXRTejU2MlVsNWVWV2FsZ0NpY1NmNmdEckZrYzNBL1dv?=
 =?utf-8?B?WUdJMklMUE5xMVZTNXpSZVBmTXNzTytCZUw1c1RCYytPK2VUb09yRm5mRE1I?=
 =?utf-8?B?bkt0TzFTOC9yVXN5VndoME5CTE5BbGl1K0hxT2xtKzFyd2RmS3U5UDdzSXZG?=
 =?utf-8?Q?6oZN8VPQTDAXZSWS30g/svXX1?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 0f326471-07af-498c-920d-08dc2cddef24
X-MS-Exchange-CrossTenant-AuthSource: PAXPR04MB9642.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 13 Feb 2024 21:51:29.1995
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: JE7xF6XM3252KF+jAZ6/cMGivW5g3CWheg6mrp+yWSFI3MaqiasINvtMWyPnJFTPxu9RHXHMDx18aoUd2diDlw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DU2PR04MB8837

Reserve space at end of first IORESOURCE_MEM window as message TLP MMIO
window. This space's size is 'region_align'.

Set outbound ATU map memory write to send PCI message. So one MMIO write
can trigger a PCI message, such as PME_Turn_Off.

Add common dwc_pme_turn_off() function.

Call dwc_pme_turn_off() to send out PME_Turn_Off message in general
dw_pcie_suspend_noirq() if there are not platform callback pme_turn_off()
exist.

Signed-off-by: Frank Li <Frank.Li@nxp.com>
---
 drivers/pci/controller/dwc/pcie-designware-host.c | 93 ++++++++++++++++++++++-
 drivers/pci/controller/dwc/pcie-designware.h      |  2 +
 2 files changed, 91 insertions(+), 4 deletions(-)

diff --git a/drivers/pci/controller/dwc/pcie-designware-host.c b/drivers/pci/controller/dwc/pcie-designware-host.c
index 267687ab33cbc..5e83756492462 100644
--- a/drivers/pci/controller/dwc/pcie-designware-host.c
+++ b/drivers/pci/controller/dwc/pcie-designware-host.c
@@ -393,6 +393,31 @@ static int dw_pcie_msi_host_init(struct dw_pcie_rp *pp)
 	return 0;
 }
 
+static void dw_pcie_host_request_msg_tlp_res(struct dw_pcie_rp *pp)
+{
+	struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
+	struct resource_entry *win;
+	struct resource *res;
+
+	win = resource_list_first_type(&pp->bridge->windows, IORESOURCE_MEM);
+	if (win) {
+		res = devm_kzalloc(pci->dev, sizeof(*res), GFP_KERNEL);
+		if (!res)
+			return;
+
+		/* Reserve last region_align block as message TLP space */
+		res->start = win->res->end - pci->region_align + 1;
+		res->end = win->res->end;
+		res->name = "msg";
+		res->flags = win->res->flags | IORESOURCE_BUSY;
+
+		if (!request_resource(win->res, res))
+			pp->msg_res = res;
+		else
+			devm_kfree(pci->dev, res);
+	}
+}
+
 int dw_pcie_host_init(struct dw_pcie_rp *pp)
 {
 	struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
@@ -479,6 +504,9 @@ int dw_pcie_host_init(struct dw_pcie_rp *pp)
 
 	dw_pcie_iatu_detect(pci);
 
+	/* Need call after dw_pcie_iatu_detect() before dw_pcie_setup_rc() */
+	dw_pcie_host_request_msg_tlp_res(pp);
+
 	ret = dw_pcie_edma_detect(pci);
 	if (ret)
 		goto err_free_msi;
@@ -536,6 +564,11 @@ void dw_pcie_host_deinit(struct dw_pcie_rp *pp)
 
 	dw_pcie_edma_remove(pci);
 
+	if (pp->msg_res) {
+		release_resource(pp->msg_res);
+		devm_kfree(pci->dev, pp->msg_res);
+	}
+
 	if (pp->has_msi_ctrl)
 		dw_pcie_free_msi(pp);
 
@@ -697,6 +730,10 @@ static int dw_pcie_iatu_setup(struct dw_pcie_rp *pp)
 		atu.pci_addr = entry->res->start - entry->offset;
 		atu.size = resource_size(entry->res);
 
+		/* MSG TLB window resource reserve at one of end of IORESOURCE_MEM resource */
+		if (pp->msg_res && pp->msg_res->parent == entry->res)
+			atu.size -= resource_size(pp->msg_res);
+
 		ret = dw_pcie_prog_outbound_atu(pci, &atu);
 		if (ret) {
 			dev_err(pci->dev, "Failed to set MEM range %pr\n",
@@ -728,6 +765,8 @@ static int dw_pcie_iatu_setup(struct dw_pcie_rp *pp)
 		dev_warn(pci->dev, "Ranges exceed outbound iATU size (%d)\n",
 			 pci->num_ob_windows);
 
+	pp->msg_atu_index = i;
+
 	i = 0;
 	resource_list_for_each_entry(entry, &pp->bridge->dma_ranges) {
 		if (resource_type(entry->res) != IORESOURCE_MEM)
@@ -833,11 +872,54 @@ int dw_pcie_setup_rc(struct dw_pcie_rp *pp)
 }
 EXPORT_SYMBOL_GPL(dw_pcie_setup_rc);
 
+/* Using message outbound ATU to send out PME_Turn_Off message for dwc PCIe controller */
+static int dw_pcie_pme_turn_off(struct dw_pcie *pci)
+{
+	struct dw_pcie_ob_atu_cfg atu = { 0 };
+	void __iomem *m;
+	int ret;
+
+	if (pci->num_ob_windows <= pci->pp.msg_atu_index)
+		return -EINVAL;
+
+	if (!pci->pp.msg_res)
+		return -EINVAL;
+
+	atu.code = PCIE_MSG_CODE_PME_TURN_OFF;
+	atu.routing = PCIE_MSG_TYPE_R_BC;
+	atu.type = PCIE_ATU_TYPE_MSG;
+	atu.size = resource_size(pci->pp.msg_res);
+	atu.index = pci->pp.msg_atu_index;
+
+	if (!atu.size) {
+		dev_dbg(pci->dev,
+			"atu memory map windows is zero, please check 'msg' reg in dts\n");
+		return -ENOMEM;
+	}
+
+	atu.cpu_addr = pci->pp.msg_res->start;
+
+	ret = dw_pcie_prog_outbound_atu(pci, &atu);
+	if (ret)
+		return ret;
+
+	m = ioremap(atu.cpu_addr, pci->region_align);
+	if (!m)
+		return -ENOMEM;
+
+	/* A dummy write is converted to a Msg TLP */
+	writel(0, m);
+
+	iounmap(m);
+
+	return 0;
+}
+
 int dw_pcie_suspend_noirq(struct dw_pcie *pci)
 {
 	u8 offset = dw_pcie_find_capability(pci, PCI_CAP_ID_EXP);
 	u32 val;
-	int ret;
+	int ret = 0;
 
 	/*
 	 * If L1SS is supported, then do not put the link into L2 as some
@@ -849,10 +931,13 @@ int dw_pcie_suspend_noirq(struct dw_pcie *pci)
 	if (dw_pcie_get_ltssm(pci) <= DW_PCIE_LTSSM_DETECT_ACT)
 		return 0;
 
-	if (!pci->pp.ops->pme_turn_off)
-		return 0;
+	if (pci->pp.ops->pme_turn_off)
+		pci->pp.ops->pme_turn_off(&pci->pp);
+	else
+		ret = dw_pcie_pme_turn_off(pci);
 
-	pci->pp.ops->pme_turn_off(&pci->pp);
+	if (ret)
+		return ret;
 
 	ret = read_poll_timeout(dw_pcie_get_ltssm, val, val == DW_PCIE_LTSSM_L2_IDLE,
 				PCIE_PME_TO_L2_TIMEOUT_US/10,
diff --git a/drivers/pci/controller/dwc/pcie-designware.h b/drivers/pci/controller/dwc/pcie-designware.h
index 703b50bc5e0f1..9e6076aa4c850 100644
--- a/drivers/pci/controller/dwc/pcie-designware.h
+++ b/drivers/pci/controller/dwc/pcie-designware.h
@@ -341,6 +341,8 @@ struct dw_pcie_rp {
 	struct pci_host_bridge  *bridge;
 	raw_spinlock_t		lock;
 	DECLARE_BITMAP(msi_irq_in_use, MAX_MSI_IRQS);
+	int			msg_atu_index;
+	struct resource		*msg_res;
 };
 
 struct dw_pcie_ep_ops {

-- 
2.34.1