Received-SPF: pass (google.com: domain of linux-kernel+bounces-170185-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>
To: miquel.raynal@bootlin.com
Cc: Frank.Li@nxp.com,
	alexandre.belloni@bootlin.com,
	conor.culhane@silvaco.com,
	imx@lists.linux.dev,
	linux-i3c@lists.infradead.org,
	linux-kernel@vger.kernel.org
Subject: [PATCH v2 3/3] i3c: master: svc: fix invalidate IBI type and miss call client IBI handler
Date: Mon,  6 May 2024 12:40:09 -0400
Message-Id: <20240506164009.21375-3-Frank.Li@nxp.com>
In-Reply-To: <20240506164009.21375-1-Frank.Li@nxp.com>
References: <20240506164009.21375-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?kqzO3sLF9Ga6mbYlSA96/3EfqPyW4taSin6j7wnUDiWgje8XrTlnW3qLLJKl?=
 =?us-ascii?Q?Jtj3AedJACBo0e8S13V864Brhqrv1McPMCNjvP8h81e8IHXW2MAs3FwTv3pJ?=
 =?us-ascii?Q?NrhX54IZXfxM/9O8pS8FUxMUQvGbwIBO+ewXAJnrh7EDq6NLHnnjqTQfXvA8?=
 =?us-ascii?Q?rtTQT4Pa/xImQYDjjGycFWiebEZ4BaiM3cRaFSM0GdU8yJadsUXikadpe5Py?=
 =?us-ascii?Q?dSRw6tdsNw0AI2pIcDILgu4jhot0XOf53K3cWVnJAMyw/CWMkqIqsbxLu87R?=
 =?us-ascii?Q?k1wQ4uJdM9vUWQxXen06TPcU0wGyVqyDvUDX13rHxcoqcKsmvFke5BIqOCkT?=
 =?us-ascii?Q?yn++rrD3HYRoU5yyt9oKfKhi6XjcTJkNf1/QGWbucZ6hGC+x1Q7A6Gg14usd?=
 =?us-ascii?Q?jzHxEj+I69ZXHCfIsAWLJzOi/RwtcsOj4HpyJvVemNh63Mq+ilIJrPUMAGxY?=
 =?us-ascii?Q?j5eMxl6Kk8bcBIIvv62E15ZbIy61UsW6AvUrWnMy6d3a4fYAXzY8L6RD0Acn?=
 =?us-ascii?Q?GRBR7ou4QSR3xDZ6rAk9ZpX/6N/Evu6kR2WlAfpjmTHY3lr6i1vtCxsPjnh+?=
 =?us-ascii?Q?th58916bXM+gRwm94UbfuJsMC4Y6FA8PCM5FxT6UTwXnd7mk7BrpcyZLa/jD?=
 =?us-ascii?Q?NmLhXHUBeN7vUFV0RMnY6QXXa3zv46Vcl0rZmErBacH0p73CVgoMXMmF8yJj?=
 =?us-ascii?Q?I37mP86MJ5Nnu8FoRALJOdhuOJk7OEjRGHN9NhliVejGA1BRq7mTX/1DFsyJ?=
 =?us-ascii?Q?CL0NSGJ4KpLkxN99DqJpMyB8lvNaINGZzcz5cmH0uEMWHY24cY/jFsLCJXvh?=
 =?us-ascii?Q?UbIIZe6AHd7GNQiokWVBcyB0cGzx6uVF5tPw+5PYESdbC8zcMRum7aNb9Jk0?=
 =?us-ascii?Q?2KYle0adciGGxZ+5LEESlFxQ95HnTp8EA+jL+gRz7DIGydlchusoO1Y/uG06?=
 =?us-ascii?Q?HJeH7xNSuIO0GTPgXf11p0cBpnxl1qd0twJgEJxStVjaLSRkcDhnFzvEzoPO?=
 =?us-ascii?Q?Y7+hySOopf3kQS/Z1bSUMkbRXb6t4I7pbkHcqxAuXffoL2N/iC5Y8ei4fSdV?=
 =?us-ascii?Q?jTeVxkKfbf4bVJxrk7UZ4AWkU5X4UjRw2Pml649Jv5FgFEabGd5yp+XsxnuI?=
 =?us-ascii?Q?m04085x7XR9oYC8v71MFHtSXJzhpj9dwDoyHDL/sNfwq4dayVYJMuODH1QHF?=
 =?us-ascii?Q?drWTHFq6OwMmMeIQieGvgSNQLpB1sz3BTtyyCyYkJz09g4Hm47UqOKQoIELB?=
 =?us-ascii?Q?A6oc/u1MIFP1EYuO2M6D8XUCtX+MFpDDNyFp5wDZW6mvEISzirspgM85SkWd?=
 =?us-ascii?Q?CK1Zo+cnjJSPNKZd7tJikRA2JehyILfHcbtmA1t04IZcKI5h5iqD3mB4MuV7?=
 =?us-ascii?Q?1i1v8ehGYTmPWrjz3Zgh8kkNJCDqsOEfIEBrpBuKc8LXUCMM3l61XVjRKsuV?=
 =?us-ascii?Q?ZhG32tzWG0qjHSLHi6bRdsp60hWkXzHeLsd+h41yyXtjJ65eajZpe+sBBcCG?=
 =?us-ascii?Q?jjtgBa47tBxGFSYCWTl56NE8u3fhu7cujfi9TpUY0uoSYQ5LLg5mG1987dg6?=
 =?us-ascii?Q?gnr+FyzqGZGlmY877K4=3D?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 8dcc8de6-610e-4adf-8555-08dc6deb3e24
X-MS-Exchange-CrossTenant-AuthSource: PAXPR04MB9642.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 06 May 2024 16:40:30.8384
 (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: U23bqU1BIpZ0WIQDYK5bwhEH++OLpwlLD045WtK4EgkOcqU5vqVvPb0W0scYClNdPttYGKBkCI83BXNTu6tMWA==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DU2PR04MB9049

In an In-Band Interrupt (IBI) handle, the code logic is as follows:

1: writel(SVC_I3C_MCTRL_REQUEST_AUTO_IBI | SVC_I3C_MCTRL_IBIRESP_AUTO,
	  master->regs + SVC_I3C_MCTRL);

2: ret = readl_relaxed_poll_timeout(master->regs + SVC_I3C_MSTATUS, val,
                                    SVC_I3C_MSTATUS_IBIWON(val), 0, 1000);
	...
3: ibitype = SVC_I3C_MSTATUS_IBITYPE(status);
   ibiaddr = SVC_I3C_MSTATUS_IBIADDR(status);

SVC_I3C_MSTATUS_IBIWON may be set before step 1. Thus, step 2 will return
immediately, and the I3C controller has not sent out the 9th SCL yet.
Consequently, ibitype and ibiaddr are 0, resulting in an unknown IBI type
occurrence and missing call I3C client driver's IBI handler.

A typical case is that SVC_I3C_MSTATUS_IBIWON is set when an IBI occurs
during the controller send start frame in svc_i3c_master_xfer().

Clear SVC_I3C_MSTATUS_IBIWON before issue SVC_I3C_MCTRL_REQUEST_AUTO_IBI
to fix this issue.

Cc: stable@vger.kernel.org
Fixes: 5e5e3c92e748 ("i3c: master: svc: fix wrong data return when IBI happen during start frame")
Signed-off-by: Frank Li <Frank.Li@nxp.com>
---

Notes:
    Change from v1 to v2
    - improve comments.

 drivers/i3c/master/svc-i3c-master.c | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

diff --git a/drivers/i3c/master/svc-i3c-master.c b/drivers/i3c/master/svc-i3c-master.c
index 94e4954509558..032fe032ec433 100644
--- a/drivers/i3c/master/svc-i3c-master.c
+++ b/drivers/i3c/master/svc-i3c-master.c
@@ -415,6 +415,19 @@ static void svc_i3c_master_ibi_work(struct work_struct *work)
 	int ret;
 
 	mutex_lock(&master->lock);
+	/*
+	 * IBIWON may be set before SVC_I3C_MCTRL_REQUEST_AUTO_IBI, causing
+	 * readl_relaxed_poll_timeout() to return immediately. Consequently,
+	 * ibitype will be 0 since it was last updated only after the 8th SCL
+	 * cycle, leading to missed client IBI handlers.
+	 *
+	 * A typical scenario is when IBIWON occurs and bus arbitration is lost
+	 * at svc_i3c_master_priv_xfers().
+	 *
+	 * Clear SVC_I3C_MINT_IBIWON before sending SVC_I3C_MCTRL_REQUEST_AUTO_IBI.
+	 */
+	writel(SVC_I3C_MINT_IBIWON, master->regs + SVC_I3C_MSTATUS);
+
 	/* Acknowledge the incoming interrupt with the AUTOIBI mechanism */
 	writel(SVC_I3C_MCTRL_REQUEST_AUTO_IBI |
 	       SVC_I3C_MCTRL_IBIRESP_AUTO,
@@ -429,9 +442,6 @@ static void svc_i3c_master_ibi_work(struct work_struct *work)
 		goto reenable_ibis;
 	}
 
-	/* Clear the interrupt status */
-	writel(SVC_I3C_MINT_IBIWON, master->regs + SVC_I3C_MSTATUS);
-
 	status = readl(master->regs + SVC_I3C_MSTATUS);
 	ibitype = SVC_I3C_MSTATUS_IBITYPE(status);
 	ibiaddr = SVC_I3C_MSTATUS_IBIADDR(status);
-- 
2.34.1