Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:6 as permitted sender) client-ip=2620:137:e000::3:6;
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, joe@perches.com,
        linux-i3c@lists.infradead.org, linux-kernel@vger.kernel.org
Subject: [PATCH v2 Resent 1/6] i3c: master: svc: fix race condition in ibi work thread
Date:   Wed, 18 Oct 2023 11:59:21 -0400
Message-Id: <20231018155926.3305476-2-Frank.Li@nxp.com>
In-Reply-To: <20231018155926.3305476-1-Frank.Li@nxp.com>
References: <20231018155926.3305476-1-Frank.Li@nxp.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?RdDsDBLkX1y1e/C9zijEOwLjnOlwWObwlyZLzAv1OI0cDKpq0cmFsskZkNuk?=
 =?us-ascii?Q?EY28KdBPw1mc7y2XYw0Rvrjhl/cbZahd/NCnFYDZt6s/dmbaqyda1/HCRqFb?=
 =?us-ascii?Q?h5Xoub4NU+/0ez88kTQFEu2s3UoKxJztFfs7yYRHP745d5Q8r7Cs0he7mAgV?=
 =?us-ascii?Q?98RURsR55XGVuL7Q6lU+1V68X6CBeDuyo89/lVxQg9n3Lj4tqiWHM1NZxlqe?=
 =?us-ascii?Q?ty+nPa2SMmwlMngikZk/Uswr//uFFCWUpvfruABsFUSynKuDstqoe6NBjjzA?=
 =?us-ascii?Q?1v0ycp70SI/nqlM6JuKkleGIeP0JXsRJDLbsuh4JHByRoRMlHdhER7nlxalT?=
 =?us-ascii?Q?BqjMiJ85sXdU66IG+gqLMPwwrZ5g38ZUvm2L8QqR/5iR3tkKIPvv8hQlKbIs?=
 =?us-ascii?Q?3ne2feP8DGm7CCgR5PlWpjZhFWdZs7i30pMgxQZeVyMidcnCYoRIZimC+zln?=
 =?us-ascii?Q?+qClGHSTC6QTC3tsj+OlMoq3ezLMdtZ1ZIJ33/BtUa6mkevaEbqhCqg/7nk6?=
 =?us-ascii?Q?cUoJDhWVfVNPtj7Xmj82Nk63wrVXZzmph/2Sy0Orv1z5tk6UE2c/1Rgue1fO?=
 =?us-ascii?Q?BP+CT6p8588QyCb60IHZyiHFrrz/BoLtFjycPGV7zHWwxZx0VNo6KVLZv+Rv?=
 =?us-ascii?Q?A6XJymEcUd1pNH+LAQvuUdTVd/gPTMxlLZASXyaq0rozAGGQiz7r/hrZJkZX?=
 =?us-ascii?Q?uVj3z3dNx4t6+XWJBAb9nto/LR2eb1K+0mLQ0XJMLKMF8E+s76seovt2wavw?=
 =?us-ascii?Q?6ix+WhZEHKN3Mnh/qBNtWjElb5+XNpQcHV98XYEgbIXj/i1tLVtdIjHEImkb?=
 =?us-ascii?Q?Zat4VWI7BDHnWkcT6/vciMoNd8Vl+srQQyyZMfSFIeIEJEgi1Gq4c4jYqBYB?=
 =?us-ascii?Q?tqlZ8H55bll7a/ASPvSf1BIaiH1GvMaX5y0JNq7kPcMzrPaYwV5pUE9br+K6?=
 =?us-ascii?Q?kTBQBSaoHOfWfw2WRCIFOCGkiim1X334pjHyRLo18SAsowDZ8IOKgapaSYdk?=
 =?us-ascii?Q?ZybGXmNKmpH0Vzr7aqDONYWT9vxzuWQE9Qy2Sjh4GG9+ACTS3Wb3+GjmHhT5?=
 =?us-ascii?Q?CggrXiZE1HaZTlze0/Kp8oSRXHbY9yS5VkFp/xHVWWjYkNtmGV34hvPwfheC?=
 =?us-ascii?Q?WL17YSkdhr0rf64kpmJuHycgYSFkK9S/ojltYczQltPZDhFnCw47c1N/3F40?=
 =?us-ascii?Q?szrjT6wUCYbtqMBxcW9JzcePBnd/lcfHPURVg8iaBYB/Juun8kN5JxbBtgWB?=
 =?us-ascii?Q?hiNDn3khlJ70SjREUhsbd6/bNQ6ovq4g2IG0306GL5H7NsvTmnUGCjvUBAtf?=
 =?us-ascii?Q?rEFElfBuCJlTKwxQiBi1Kisz4AWNR0EX5G2ZuGsECOZtNjTIMx63OCvliY+Y?=
 =?us-ascii?Q?rNQSDZAv14IHyBYzt9CJjBcwDmXpqABbVIBAmPkaFunfNzEHnb6bLoYOB5gU?=
 =?us-ascii?Q?X4gn7uPaLdA6lqifi3C8qCgf55WbTcsBqCVFVyhk3pHSdjiSA88Ip6yVL91h?=
 =?us-ascii?Q?xRZAuSLJOXV+AJXep0KGo+gpZ/bwX+y5vJBASVXud1pTq0sfkduW6An6lbvb?=
 =?us-ascii?Q?unQwuxKfYJlVYe8dCrT/GsJ6qCqVl8O3jD0VeN10?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 8422bf32-b37a-469f-a9c8-08dbcff33f0e
X-MS-Exchange-CrossTenant-AuthSource: AM6PR04MB4838.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 18 Oct 2023 15:59:45.7748
 (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: kWzls0pEUG79HlpujAQZOcIngpvLo87aUC/rGV6GBkaE0M3rw7AayWruHUax48t8QbUXZlW7yIsPnprbuLCINw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PA4PR04MB7694
X-Spam-Status: No, score=-0.8 required=5.0 tests=DKIM_SIGNED,DKIM_VALID,
	DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,
	SPF_HELO_NONE,SPF_PASS autolearn=unavailable autolearn_force=no
	version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on pete.vger.email
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (pete.vger.email [0.0.0.0]); Wed, 18 Oct 2023 09:00:53 -0700 (PDT)

The ibi work thread operates asynchronously with other transfers, such as
svc_i3c_master_priv_xfers(). Introduce mutex protection to ensure the
completion of the entire i3c/i2c transaction.

Fixes: dd3c52846d59 ("i3c: master: svc: Add Silvaco I3C master driver")
Cc: stable@vger.kernel.org
Reviewed-by: Miquel Raynal <miquel.raynal@bootlin.com>
Signed-off-by: Frank Li <Frank.Li@nxp.com>
---

Notes:
    Change from v1 to v2
    - update commit message
    - Add Reviewed-by: Miquel Raynal <miquel.raynal@bootlin.com>

 drivers/i3c/master/svc-i3c-master.c | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/drivers/i3c/master/svc-i3c-master.c b/drivers/i3c/master/svc-i3c-master.c
index d29de5fe533e6..8cd708c965085 100644
--- a/drivers/i3c/master/svc-i3c-master.c
+++ b/drivers/i3c/master/svc-i3c-master.c
@@ -174,6 +174,7 @@ struct svc_i3c_regs_save {
  * @ibi.slots: Available IBI slots
  * @ibi.tbq_slot: To be queued IBI slot
  * @ibi.lock: IBI lock
+ * @lock: Transfer lock, protect between IBI work thread and callbacks from master
  */
 struct svc_i3c_master {
 	struct i3c_master_controller base;
@@ -202,6 +203,7 @@ struct svc_i3c_master {
 		/* Prevent races within IBI handlers */
 		spinlock_t lock;
 	} ibi;
+	struct mutex lock;
 };
 
 /**
@@ -383,6 +385,7 @@ static void svc_i3c_master_ibi_work(struct work_struct *work)
 	u32 status, val;
 	int ret;
 
+	mutex_lock(&master->lock);
 	/* Acknowledge the incoming interrupt with the AUTOIBI mechanism */
 	writel(SVC_I3C_MCTRL_REQUEST_AUTO_IBI |
 	       SVC_I3C_MCTRL_IBIRESP_AUTO,
@@ -459,6 +462,7 @@ static void svc_i3c_master_ibi_work(struct work_struct *work)
 
 reenable_ibis:
 	svc_i3c_master_enable_interrupts(master, SVC_I3C_MINT_SLVSTART);
+	mutex_unlock(&master->lock);
 }
 
 static irqreturn_t svc_i3c_master_irq_handler(int irq, void *dev_id)
@@ -1203,9 +1207,11 @@ static int svc_i3c_master_send_bdcast_ccc_cmd(struct svc_i3c_master *master,
 	cmd->read_len = 0;
 	cmd->continued = false;
 
+	mutex_lock(&master->lock);
 	svc_i3c_master_enqueue_xfer(master, xfer);
 	if (!wait_for_completion_timeout(&xfer->comp, msecs_to_jiffies(1000)))
 		svc_i3c_master_dequeue_xfer(master, xfer);
+	mutex_unlock(&master->lock);
 
 	ret = xfer->ret;
 	kfree(buf);
@@ -1249,9 +1255,11 @@ static int svc_i3c_master_send_direct_ccc_cmd(struct svc_i3c_master *master,
 	cmd->read_len = read_len;
 	cmd->continued = false;
 
+	mutex_lock(&master->lock);
 	svc_i3c_master_enqueue_xfer(master, xfer);
 	if (!wait_for_completion_timeout(&xfer->comp, msecs_to_jiffies(1000)))
 		svc_i3c_master_dequeue_xfer(master, xfer);
+	mutex_unlock(&master->lock);
 
 	if (cmd->read_len != xfer_len)
 		ccc->dests[0].payload.len = cmd->read_len;
@@ -1308,9 +1316,11 @@ static int svc_i3c_master_priv_xfers(struct i3c_dev_desc *dev,
 		cmd->continued = (i + 1) < nxfers;
 	}
 
+	mutex_lock(&master->lock);
 	svc_i3c_master_enqueue_xfer(master, xfer);
 	if (!wait_for_completion_timeout(&xfer->comp, msecs_to_jiffies(1000)))
 		svc_i3c_master_dequeue_xfer(master, xfer);
+	mutex_unlock(&master->lock);
 
 	ret = xfer->ret;
 	svc_i3c_master_free_xfer(xfer);
@@ -1346,9 +1356,11 @@ static int svc_i3c_master_i2c_xfers(struct i2c_dev_desc *dev,
 		cmd->continued = (i + 1 < nxfers);
 	}
 
+	mutex_lock(&master->lock);
 	svc_i3c_master_enqueue_xfer(master, xfer);
 	if (!wait_for_completion_timeout(&xfer->comp, msecs_to_jiffies(1000)))
 		svc_i3c_master_dequeue_xfer(master, xfer);
+	mutex_unlock(&master->lock);
 
 	ret = xfer->ret;
 	svc_i3c_master_free_xfer(xfer);
@@ -1539,6 +1551,8 @@ static int svc_i3c_master_probe(struct platform_device *pdev)
 
 	INIT_WORK(&master->hj_work, svc_i3c_master_hj_work);
 	INIT_WORK(&master->ibi_work, svc_i3c_master_ibi_work);
+	mutex_init(&master->lock);
+
 	ret = devm_request_irq(dev, master->irq, svc_i3c_master_irq_handler,
 			       IRQF_NO_SUSPEND, "svc-i3c-irq", master);
 	if (ret)
-- 
2.34.1