Received-SPF: pass (google.com: domain of linux-kernel+bounces-31579-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3;
From: Frank Li <Frank.Li@nxp.com>
To: ran.wang_1@nxp.com,
	Thinh Nguyen <Thinh.Nguyen@synopsys.com>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	linux-usb@vger.kernel.org (open list:DESIGNWARE USB3 DRD IP DRIVER),
	linux-kernel@vger.kernel.org (open list)
Cc: balbi@kernel.org,
	devicetree@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	linux-usb@vger.kernel.org,
	mark.rutland@arm.com,
	pku.leo@gmail.com,
	robh+dt@kernel.org,
	sergei.shtylyov@cogentembedded.com
Subject: [PATCH 2/2] usb: dwc3: Add workaround for host mode VBUS glitch when boot
Date: Fri, 19 Jan 2024 16:31:29 -0500
Message-Id: <20240119213130.3147517-2-Frank.Li@nxp.com>
In-Reply-To: <20240119213130.3147517-1-Frank.Li@nxp.com>
References: <20240119213130.3147517-1-Frank.Li@nxp.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?us-ascii?Q?BH3DqpHaVc0e4N8LclasmiHmnDyKzbFs0Wn7ro0xrUly/+lX9ZREsvE5oErx?=
 =?us-ascii?Q?IbOPaPEpsx0sG6IzfIBRPEbEcjdkS6bwtw1OiGHYmglGr3Q5xQrjRdkjhNEr?=
 =?us-ascii?Q?ayf5aNIkIaSe/EHNfeOccDfy3Fh/mg/++bj9eqcJ/ZCpDJzYnbuTRXwMYbJe?=
 =?us-ascii?Q?X7RXqemzE2RmOBxFv0UdhXNhFu46P9yWSsd18DZQyFB/TtaQNq3E86yLgaTL?=
 =?us-ascii?Q?UnfHLphiat+PT3VNz4XzvWkhluG9UJ0jkSDl6tC9XdjG4dvXvryyODH3U4lI?=
 =?us-ascii?Q?pXQMuvFROc7yLx0LIjqjAL+1NE/WNT5uXGKItaQfJIth4e9TJUSpei4sIRgW?=
 =?us-ascii?Q?+8KBKk3tgl747cK0SvMGi0iz1quxXkDqIPinhjODjFgOgjlFA+wFXdEKo4q1?=
 =?us-ascii?Q?OW8QBAO+cOfkW6X7Y8Doyifu9o1W9imz7yc6jiNEoAvOMoYOt5bSrxnPt6Ad?=
 =?us-ascii?Q?WSObGQvRy+zRY0s2z4X/G2bY5TDNCTkkPb0Ln+yIaj5dUC8z2j2XnGEkGHw9?=
 =?us-ascii?Q?Ldafk0N2g04n/SjfYaGa3wp+obmrBboRPj2MxyvCKP+m//QYem33nAs2t/o4?=
 =?us-ascii?Q?tNlw0XRCUKCwelMby03AyWLQI8hxhnXmlIGK59BKzS+5x6R46eeebkoWaCFX?=
 =?us-ascii?Q?X6sdr2T9FdRxAn+Ha978R5fLHkIOM55zGfUHEulhyFPL1JAZcA64m5K92iTm?=
 =?us-ascii?Q?TawIf8WSHxJjqTB3wSR0dPZI808Xi4wsszLnLCy2+EbpJqrTo2C6p4pusX7e?=
 =?us-ascii?Q?x6komWVda1GKlSRLkpTph0G4Y2X6ffMTMOva8oogNM0oajIKGvEjY1ih+Ulw?=
 =?us-ascii?Q?TAI+5mdQn31q9Jg4ucYCpCrAf5Ebwd74sKDRHzct+D50V3LI+vbUG9jzG8FP?=
 =?us-ascii?Q?dOCLXmzEWK1C9ZIbEOFh/elS+MPtHvYn4hSaqjswNoE2HUsd0+FQxseYM86g?=
 =?us-ascii?Q?IuENq6OGCLZKEmt/p6JUBuisA0XOoWiwsDNi1SPgx97U4WQRVZtP0ALFQtXY?=
 =?us-ascii?Q?uuYT1+Ul9BUszZ0YuajYeLOfiC2TFCrwIAp1INQE7BBEk4J5tnBv1cql+sdH?=
 =?us-ascii?Q?UdxVx8k79gQ2DuOV4cI12NOkTEsFrZiKFTxBPqSHTuABX8RXDMe+tQZ25ZIo?=
 =?us-ascii?Q?SVnsvu5IWG7kPUIufXb3pbutK6pJfqrfbbPaUmjHpBgTnhbD9mITXVT5jdgv?=
 =?us-ascii?Q?Jgi9d6Ub9VkA12ZnHTNIXKbeXczJqyGwRQoKpYRaMP1kaXU+huA2N9hhFri7?=
 =?us-ascii?Q?2mIHusDjtYVlojdP+OebduR3e+pD0U1FSGJRFykZpzKLJDrBI4HVeJeU5Hvd?=
 =?us-ascii?Q?WQauPbfhMACFMLnkxXYkFgHtiWujro814JuKhJWa1vdRbdSThoBvTgyg9ewW?=
 =?us-ascii?Q?dlhN5h4S72Y6FlaDo1lBRE5fXaKjWFgAR1bxLm7BsoUex5HQgJSWow2+W72r?=
 =?us-ascii?Q?QhZ4QEqaW6ltZMkz65FcUgopdL2Hyrsl8gez121WBc8xvpdS+kfhNxEJWbSz?=
 =?us-ascii?Q?iCg6I9jS0a4ent/v2cuKalSZDMprbkCUis7DesHmcylqI49340q7dBcN0cN5?=
 =?us-ascii?Q?+J3b0ycIJQ8HogacXPew+e+DeMEdLj9HagLIk0RT?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 8aa251c2-5905-4676-28d5-08dc19360b98
X-MS-Exchange-CrossTenant-AuthSource: PAXPR04MB9642.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 19 Jan 2024 21:31:49.5361
 (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: Hmicvz5S5DZiGHZfM3dYc+urNTMsYiK13r14fXl+DbIN2wCSs4FAwVj08t+q+lyer0b3J0LwRCCe9a3HqPkUTQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM9PR04MB8795

From: Ran Wang <ran.wang_1@nxp.com>

When DWC3 is set to host mode by programming register DWC3_GCTL, VBUS
(or its control signal) will be turned on immediately on related Root Hub
ports. Then, the VBUS is turned off for a little while(15us) when do xhci
reset (conducted by xhci driver) and back to normal finally, we can
observe a negative glitch of related signal happen.

This VBUS glitch might cause some USB devices enumeration fail if kernel
boot with them connected. Such as LS1012AFWRY/LS1043ARDB/LX2160AQDS
/LS1088ARDB with Kingston 16GB USB2.0/Kingston USB3.0/JetFlash Transcend
4GB USB2.0 drives. The fail cases include enumerated as full-speed device
or report wrong device descriptor, etc.

One SW workaround which can fix this is by programing all xhci PORTSC[PP]
to 0 to turn off VBUS immediately after setting host mode in DWC3 driver
(per signal measurement result, it will be too late to do it in
xhci-plat.c or xhci.c). Then, after xhci reset complete in xhci driver,
PORTSC[PP]s' value will back to 1 automatically and VBUS on at that time,
no glitch happen and normal enumeration process has no impact.

Signed-off-by: Ran Wang <ran.wang_1@nxp.com>
Reviewed-by: Peter Chen <peter.chen@nxp.com>
Signed-off-by: Frank Li <Frank.Li@nxp.com>
---

Notes:
    Last review at June 06, 2019. Fixed all review comments and sent again.
    
    https://lore.kernel.org/linux-kernel/AM5PR0402MB2865979E26017BC5937DBBA5F1170@AM5PR0402MB2865.eurprd04.prod.outlook.com/

 drivers/usb/dwc3/core.c |  2 ++
 drivers/usb/dwc3/core.h |  2 ++
 drivers/usb/dwc3/host.c | 46 +++++++++++++++++++++++++++++++++++++++++
 3 files changed, 50 insertions(+)

diff --git a/drivers/usb/dwc3/core.c b/drivers/usb/dwc3/core.c
index 3e55838c00014..a57adf0c11dd1 100644
--- a/drivers/usb/dwc3/core.c
+++ b/drivers/usb/dwc3/core.c
@@ -1626,6 +1626,8 @@ static void dwc3_get_properties(struct dwc3 *dwc)
 	dwc->dis_split_quirk = device_property_read_bool(dev,
 				"snps,dis-split-quirk");
 
+	dwc->host_vbus_glitches = device_property_read_bool(dev, "snps,host-vbus-glitches");
+
 	dwc->lpm_nyet_threshold = lpm_nyet_threshold;
 	dwc->tx_de_emphasis = tx_de_emphasis;
 
diff --git a/drivers/usb/dwc3/core.h b/drivers/usb/dwc3/core.h
index e3eea965e57bf..0269bacbbf6bd 100644
--- a/drivers/usb/dwc3/core.h
+++ b/drivers/usb/dwc3/core.h
@@ -1135,6 +1135,7 @@ struct dwc3_scratchpad_array {
  * @dis_split_quirk: set to disable split boundary.
  * @wakeup_configured: set if the device is configured for remote wakeup.
  * @suspended: set to track suspend event due to U3/L2.
+ * @host_vbus_glitches: set to avoid vbus glitch during xhci reset.
  * @imod_interval: set the interrupt moderation interval in 250ns
  *			increments or 0 to disable.
  * @max_cfg_eps: current max number of IN eps used across all USB configs.
@@ -1353,6 +1354,7 @@ struct dwc3 {
 	unsigned		tx_de_emphasis:2;
 
 	unsigned		dis_metastability_quirk:1;
+	unsigned		host_vbus_glitches:1;
 
 	unsigned		dis_split_quirk:1;
 	unsigned		async_callbacks:1;
diff --git a/drivers/usb/dwc3/host.c b/drivers/usb/dwc3/host.c
index 61f57fe5bb783..af8903ee37c20 100644
--- a/drivers/usb/dwc3/host.c
+++ b/drivers/usb/dwc3/host.c
@@ -11,6 +11,7 @@
 #include <linux/of.h>
 #include <linux/platform_device.h>
 
+#include "../host/xhci.h"
 #include "core.h"
 
 static void dwc3_host_fill_xhci_irq_res(struct dwc3 *dwc,
@@ -28,6 +29,44 @@ static void dwc3_host_fill_xhci_irq_res(struct dwc3 *dwc,
 		dwc->xhci_resources[1].name = name;
 }
 
+#define XHCI_HCSPARAMS1		0x4
+#define XHCI_PORTSC_BASE	0x400
+
+/*
+ * dwc3_power_off_all_roothub_ports - Power off all Root hub ports
+ * @dwc3: Pointer to our controller context structure
+ */
+static void dwc3_power_off_all_roothub_ports(struct dwc3 *dwc)
+{
+	int i, port_num;
+	u32 reg, op_regs_base, offset;
+	void __iomem *xhci_regs;
+
+	/* xhci regs is not mapped yet, do it temperary here */
+	if (dwc->xhci_resources[0].start) {
+		xhci_regs = ioremap(dwc->xhci_resources[0].start,
+				DWC3_XHCI_REGS_END);
+		if (IS_ERR(xhci_regs)) {
+			dev_err(dwc->dev, "Failed to ioremap xhci_regs\n");
+			return;
+		}
+
+		op_regs_base = HC_LENGTH(readl(xhci_regs));
+		reg = readl(xhci_regs + XHCI_HCSPARAMS1);
+		port_num = HCS_MAX_PORTS(reg);
+
+		for (i = 1; i <= port_num; i++) {
+			offset = op_regs_base + XHCI_PORTSC_BASE + 0x10*(i-1);
+			reg = readl(xhci_regs + offset);
+			reg &= ~PORT_POWER;
+			writel(reg, xhci_regs + offset);
+		}
+
+		iounmap(xhci_regs);
+	} else
+		dev_err(dwc->dev, "xhci base reg invalid\n");
+}
+
 static int dwc3_host_get_irq(struct dwc3 *dwc)
 {
 	struct platform_device	*dwc3_pdev = to_platform_device(dwc->dev);
@@ -66,6 +105,13 @@ int dwc3_host_init(struct dwc3 *dwc)
 	int			ret, irq;
 	int			prop_idx = 0;
 
+	/*
+	 * We have to power off all Root hub ports immediately after DWC3 set
+	 * to host mode to avoid VBUS glitch happen when xhci get reset later.
+	 */
+	if (dwc->host_vbus_glitches)
+		dwc3_power_off_all_roothub_ports(dwc);
+
 	irq = dwc3_host_get_irq(dwc);
 	if (irq < 0)
 		return irq;
-- 
2.34.1