Received-SPF: pass (google.com: domain of linux-kernel+bounces-192961-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) client-ip=2604:1380:40f1:3f00::1;
From: Frank Li <Frank.Li@nxp.com>
Date: Tue, 28 May 2024 15:39:19 -0400
Subject: [PATCH v5 06/12] PCI: imx6: Improve comment for workaround
 ERR010728
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 8bit
Message-Id: <20240528-pci2_upstream-v5-6-750aa7edb8e2@nxp.com>
References: <20240528-pci2_upstream-v5-0-750aa7edb8e2@nxp.com>
In-Reply-To: <20240528-pci2_upstream-v5-0-750aa7edb8e2@nxp.com>
To: Richard Zhu <hongxing.zhu@nxp.com>, 
 Lucas Stach <l.stach@pengutronix.de>, 
 Lorenzo Pieralisi <lpieralisi@kernel.org>, 
 =?utf-8?q?Krzysztof_Wilczy=C5=84ski?= <kw@linux.com>, 
 Rob Herring <robh@kernel.org>, Bjorn Helgaas <bhelgaas@google.com>, 
 Shawn Guo <shawnguo@kernel.org>, Sascha Hauer <s.hauer@pengutronix.de>, 
 Pengutronix Kernel Team <kernel@pengutronix.de>, 
 Fabio Estevam <festevam@gmail.com>, NXP Linux Team <linux-imx@nxp.com>, 
 Philipp Zabel <p.zabel@pengutronix.de>, Liam Girdwood <lgirdwood@gmail.com>, 
 Mark Brown <broonie@kernel.org>, 
 Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>, 
 Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>, 
 Conor Dooley <conor+dt@kernel.org>
Cc: linux-pci@vger.kernel.org, imx@lists.linux.dev, 
 linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org, 
 bpf@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?Y3d5T2JRajZrcnJXTUFxd29TbkMvRTZwdHo0VDRGQ0puNTRPS3FlSVFZc2wr?=
 =?utf-8?B?S2lld3BWYk9tOGJDSEtKaE9HbFJwbnBsTUlQOUhKRTB5L0ZuMXlWQ3pxTXkx?=
 =?utf-8?B?YW13QUlNdExaWnZId2dvcTloQk4rcCsxYjdUQTJZcDhFTVpyeWhRakpBanpR?=
 =?utf-8?B?QlpCY0lvcmhxRDdKM3QrMTNIS3BxL1dXMjRmR3FGY28rVWc4M1JFK0lJYkY2?=
 =?utf-8?B?dVhqSE9SYm16UU9YUzlsdWQxVVd3eDBHTEdPR3lGeU5UQ01yOVd1dFF4ck1W?=
 =?utf-8?B?R1dLWTZQMW94QlRPaTlacUtQVG9CSjVheHBJQmJrckVuYVJBMEhFUnVHTldz?=
 =?utf-8?B?SlVDU1BSL3E5L0xQQ0w5MHdoS2hrR244NTNLQlN1eGFlVkdldDJKQUdmL1Er?=
 =?utf-8?B?WXg3c0hjTFNOZGEwWnRyTmMzVWk2Tk1ZV2pOQWx3a2VvbVV5Ykl3Tk50b2Ix?=
 =?utf-8?B?ZGEwUWhBUmhTS3Q1dno4VGh6UHNld1QyelpTM2dkc29PdnVGbWM0UExpNE96?=
 =?utf-8?B?K3Z2MVU0YithbWhiMlc1RHVaL1d4cUtMNkRBc1pJdkpSWGdkL0lreWkwNlZ3?=
 =?utf-8?B?eExkVXhQczZQTHJ6cEZSdG4zNFljODJrRGFjZ1F3ZWJ4c3A1RWtqckcwRU1x?=
 =?utf-8?B?bUVNMmJLSVNBVTcxc1hSRWdHcWJPRHFhbHdja0YybTkzRjdtbGZJZXZ1ZWxL?=
 =?utf-8?B?dWNrUnZkbXMrcU9mK1NQTW43cks3Rit2blRLWmFXd013M1lQYm1yWS9wOWxY?=
 =?utf-8?B?S1F1UG9FeHk4eW5EUFJYclloOStEUWVtU2JCc1lqdFFNOUw0cVBtSFVXRFR4?=
 =?utf-8?B?QmNXZ1F2MXM0ZUVnaEtTNFBiMTAxRWJianVMZXlDSDV1U3UrUWFYMmhzV1hk?=
 =?utf-8?B?eW5OcHg4b0NvbWpEKytWU0dGQk00eFdwOWE4Qk1qNXp2OTlzSjZhR1cwYit1?=
 =?utf-8?B?d3VLK2YwM01WSU1IQWs4WXlCZ2xCZ252YVFGa0ZVc0Y5azRrTXZJbXZzWUsy?=
 =?utf-8?B?UEUvZEUrYmkzd1o0eGREVUMyaDliUEUwcVp4dkRWOXh6UDBSaUMvWldaRkhU?=
 =?utf-8?B?RjFCaTVtVTNEUTljNDRwV2hBQm1GZkV3UzVtZjBXMEJKUmk3UW94TVlYZllD?=
 =?utf-8?B?aHdGanFoU1R2Z3lGRS9QU042a3RUUXZrQTVCYzZlZjYyV1hkZ1hFWmtiOWVJ?=
 =?utf-8?B?TWQ3MzRpK1p0T3RjTit0SEJlMHU5Q1EydTBSQUxORTVDMjJDQmxGUUdJNm56?=
 =?utf-8?B?MitqY3hHVFVsY2Mza0hxOGlmczh0ZmkvZHJGS1JIenc5Ylo3OWlnNkloQ1ZC?=
 =?utf-8?B?YmZxYzN6QmgvcktlQkx5eU5TRG5RNW5tM0xaREhlVnhGUmNVUUZhNEVGRTFR?=
 =?utf-8?B?d1puZ2ZuZVNwN28rTFVpTTllZE10M2JkNVdZaHZxRktESzFJdVkreWVzTldr?=
 =?utf-8?B?V2dEMmVpR280WCtrZTYvN2p5NUJpeTdaa252TExEd1RncmVrYXRiT1NRNk9N?=
 =?utf-8?B?bDk1Q2szN1V5b0xmei9meWF4VG9pR1JCRXJtVzZGeG5haWZ6dGNPM3EzUGJV?=
 =?utf-8?B?aEM1Q2V6SUJZOUlCdWtLb1BaalpTay9BYlJhNTNjanYvWC9Pdk1yZ0RteW1U?=
 =?utf-8?B?ODVWREdJV2hYY3ArS3J3dHR1eDBieDdodWNVSnIrSjRIQXhabkwrMEptT1Br?=
 =?utf-8?B?NGhacGxtdXFuVDdtWjNTQ3hJUWRPYnFCSzZGMEJMazVVeTRPUUJjbjRjRjlN?=
 =?utf-8?B?UDFRdnFoWDY3bUxBbjNRTWZjYmNSWlpDa0d6OUpnbWNYNVYyZERxUFk0QWh5?=
 =?utf-8?B?RGhmSDU2MEdNdDNwQXVuMlFTdE5LT1E1aU1xbWk3NllxYTM2WXhXK3hkNHZU?=
 =?utf-8?B?aGEvcU9Uemh6b3lsVndvSm5USnVkZUtCUmpVWDlyWmd5VzVhbUtzMnBmOFBa?=
 =?utf-8?B?ZUFTQnUrN21wY21RQTFlTVN0VnMrZTRPcHJySUF4YjI4b3ZzUnJmZ0I4UktI?=
 =?utf-8?B?N3NRREZZUXQ2K3huYXhEQ0RLSzBQSElmYkVSOXdVN0EvVVFvV3NtRExKckRH?=
 =?utf-8?B?SjMxeTFLdWF0ZGxwQVMrMGZ1UDhYd294dDZJRldGUXhORXdpVGZuTWVLZVd6?=
 =?utf-8?Q?CAcY=3D?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 67a2e174-b692-4404-ba16-08dc7f4df6f4
X-MS-Exchange-CrossTenant-AuthSource: PAXPR04MB9642.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 28 May 2024 19:40:01.3175
 (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: pbsX5tOYV2pupuol3g1juA6zmN6BU/9PjpSBXRewclZvjc34VTjRbdYDbITmDPRP0/egFmON8148tDQ9e6r3TQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PAXPR04MB8655

Improve comment about workaround ERR010727 by using official errata
document content.

Signed-off-by: Frank Li <Frank.Li@nxp.com>
---
 drivers/pci/controller/dwc/pci-imx6.c | 22 +++++++++++++++++++---
 1 file changed, 19 insertions(+), 3 deletions(-)

diff --git a/drivers/pci/controller/dwc/pci-imx6.c b/drivers/pci/controller/dwc/pci-imx6.c
index 5e21fc942e90e..5533b7ad0f092 100644
--- a/drivers/pci/controller/dwc/pci-imx6.c
+++ b/drivers/pci/controller/dwc/pci-imx6.c
@@ -713,9 +713,25 @@ static int imx7d_pcie_core_reset(struct imx_pcie *imx_pcie, bool assert)
 		return 0;
 
 	/*
-	 * Workaround for ERR010728, failure of PCI-e PLL VCO to
-	 * oscillate, especially when cold. This turns off "Duty-cycle
-	 * Corrector" and other mysterious undocumented things.
+	 * Workaround for ERR010728 (IMX7DS_2N09P, Rev. 1.1, 4/2023):
+	 *
+	 * PCIe: PLL may fail to lock under corner conditions Initial VCO
+	 * oscillation may fail under corner conditions such as cold
+	 * temperature which will cause the PCIe PLL fail to lock in the
+	 * initialization phase.
+	 *
+	 * The Duty-cycle Corrector calibration must be disabled.
+	 *
+	 * 1. De-assert the G_RST signal by clearing
+	 *    SRC_PCIEPHY_RCR[PCIEPHY_G_RST].
+	 * 2. De-assert DCC_FB_EN by writing data “0x29” to the register
+	 *    address 0x306d0014 (PCIE_PHY_CMN_REG4).
+	 * 3. Assert RX_EQS, RX_EQ_SEL by writing data “0x48” to the register
+	 *    address 0x306d0090 (PCIE_PHY_CMN_REG24).
+	 * 4. Assert ATT_MODE by writing data “0xbc” to the register
+	 *    address 0x306d0098 (PCIE_PHY_CMN_REG26).
+	 * 5. De-assert the CMN_RST signal by clearing register bit
+	 *    SRC_PCIEPHY_RCR[PCIEPHY_BTN]
 	 */
 
 	if (likely(imx_pcie->phy_base)) {

-- 
2.34.1