Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:8 as permitted sender) client-ip=2620:137:e000::3:8;
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 v4 3/6] i3c: master: svc: fix ibi may not return mandatory data byte
Date:   Mon, 23 Oct 2023 12:16:55 -0400
Message-Id: <20231023161658.3890811-4-Frank.Li@nxp.com>
In-Reply-To: <20231023161658.3890811-1-Frank.Li@nxp.com>
References: <20231023161658.3890811-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?/0axMwlIomY2+G1KJdkFqix9Mo4htMPR0YywEiu0RJCLrzMF9VLRYPKZFF+b?=
 =?us-ascii?Q?gtZRtqtKmt4q66NeaCd4/shde5MAoosJL3alQsh9PtATadobez5Vei8ACij4?=
 =?us-ascii?Q?pjf0s8QlUs7jfw7P7Av0AUMqMEFLEPmxIzZuhrQP6tI0/gPgDdVa+rNslDSd?=
 =?us-ascii?Q?XYn0iZoPDoOXEHioHC7DBzEH9WB30TdmHTHt6oO2zYYqqKmpJ5P3BVdNOQ4Y?=
 =?us-ascii?Q?URLwFYGtrOwNYkNZbZ2cYbms881ozHw8iFXCbbHLT8Q3ujTkxjSGxdw5zhvc?=
 =?us-ascii?Q?kttD9ul/Ag+CBzvppy7SntXX2xhVMFEtfFft7+lNfh0q1cFReggpA2z52UJw?=
 =?us-ascii?Q?jHBVXH2f9gtGx7JfIz9UZw0YLAn49yek1Dx8YSwzHqHExLLvlADoy2dL5eWj?=
 =?us-ascii?Q?2Q53bkldqcGchvmBkS5N6u6dz4QvQobdQaj0zKu64YZSCYIsj92CvdALuV+M?=
 =?us-ascii?Q?pHFuHMxoAtsyUuNkWNh2GpSlT8Bb6gXHFIRm02MQBuceuQeYVTrWVwjUW9sm?=
 =?us-ascii?Q?dU+ng9qqSyIOdnJkO4KQZ/zwLoPEbNuVypi98EGSX3z+Pwp+01aka1JreUxn?=
 =?us-ascii?Q?wX4aS369y9ixVcnpK5vTDf4BQlkIDKNelgOjkIWt0nIQtFraCxDqdORpWBIX?=
 =?us-ascii?Q?BQP7bdIuhv5Cu8ZWUBGnVjrVwkXdxSlmPDvGIA7D5TlpwnikShA0VcSVyTZM?=
 =?us-ascii?Q?R1/JD+q0GRsfZDUHijMy7OddhqOdWS0D/Z2ovosivGDI7PSssseSQ3rW5s5z?=
 =?us-ascii?Q?LKVzGNRcWuJlPu5+kPPUaQrxG554+sgP9Q/3irzAp4+OIbmQz36Q4VUlFXvh?=
 =?us-ascii?Q?X6rM1rnf8dEXduNqmExn0nzJSKSL2/TEmsOGRUvkDqh59zfvLbVVLkfqNfNC?=
 =?us-ascii?Q?37D7QjNQKzIMPwlm1WNTBddI4FfYKstlT0ujuM5DyekhRFu8pZO8aYzRo/uR?=
 =?us-ascii?Q?FWuuSm6SbmXWVevRo1lNwPB9TZC1xtjqRGzvwugdYLJB8qpU0fqceypW8jd1?=
 =?us-ascii?Q?1pYqTX976gyY4GaEfhXioTqbOknbyKx5CWdb/H75vp5eEzRHD/pt2pJF9s/J?=
 =?us-ascii?Q?nuWWS05kjt9ixzeBTuDY9rH1pD4wjJymnh3RuHvcUzR39buxLW+dKi9oOagA?=
 =?us-ascii?Q?QpKjc8JQwXww+TIe6jAQV7c4ZubXgDTcxDcqDbidSSDv9HCUb0QZPoepXqRW?=
 =?us-ascii?Q?SIekJRMaAYY8OBInYLwuLV5azlcnMxCTgnNOvZFK90Hgvn0muWmpyXuu6Dcw?=
 =?us-ascii?Q?xZXCOItnFx0ntilVL4LY0pn1XV0/W5H4V4Yu15zB1Omhqo9H2M/LYyOgKucH?=
 =?us-ascii?Q?cjMAAcaOEDstNhEoXxsGy8AGjSesZmjwe1PQMhkz+FAkDgAqlpCgSlUQdL7Z?=
 =?us-ascii?Q?7bqgUviDdbadNnIJzXCnPpuWCv3OxfEqBuul6EqrAYcoFBJJF05vkqPCo8iV?=
 =?us-ascii?Q?nKxDrbfG4Y+INNf4wFLFThmUSGMxaRR3Oir5uTlUMgWy7e81nUu4ecYBdi9N?=
 =?us-ascii?Q?jwA4Xm7yGLByegqU7jpcafl5U8VpoqQ5Dx2KqnbK9hyH+A9ldlY9UMkH9tB3?=
 =?us-ascii?Q?Y28UwFHmuV9nQpnmDrhSXhH3vEUh2sdU+o0qlsiR?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 1090b22c-74d4-4639-68b4-08dbd3e38793
X-MS-Exchange-CrossTenant-AuthSource: AM6PR04MB4838.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 23 Oct 2023 16:17:19.0411
 (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: Z1Heo6JT1FJKSp5sPlkvWlKQNiOIn6xOHdZiLUs+DaLbYp+vVXd74xOEU1UWGCeSHiikmVH49LbfR7YkpbucgQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PAXPR04MB8655
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 fry.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 (fry.vger.email [0.0.0.0]); Mon, 23 Oct 2023 09:18:13 -0700 (PDT)

MSTATUS[RXPEND] is only updated after the data transfer cycle started. This
creates an issue when the I3C clock is slow, and the CPU is running fast
enough that MSTATUS[RXPEND] may not be updated when the code reaches
checking point. As a result, mandatory data can be missed.

Add a wait for MSTATUS[COMPLETE] to ensure that all mandatory data is
already in FIFO. It also works without mandatory data.

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 v3 to v4
    - add review tag Miquel
    
    Change from v2 to v3
    - update commit message and add no mandatory data in commits message
    
    Change from v1 to v2
    - update commit message
      it also works without mandatory bytes
    
    Change from v1 to v2
    - update commit message
      it also works without mandatory bytes
    
    Change from v2 to v3
    - update commit message and add no mandatory data in commits message
    
    Change from v1 to v2
    - update commit message
      it also works without mandatory bytes
    
    Change from v1 to v2
    - update commit message
      it also works without mandatory bytes

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

diff --git a/drivers/i3c/master/svc-i3c-master.c b/drivers/i3c/master/svc-i3c-master.c
index abebef666b2bb..dd06b7c9333f1 100644
--- a/drivers/i3c/master/svc-i3c-master.c
+++ b/drivers/i3c/master/svc-i3c-master.c
@@ -332,6 +332,7 @@ static int svc_i3c_master_handle_ibi(struct svc_i3c_master *master,
 	struct i3c_ibi_slot *slot;
 	unsigned int count;
 	u32 mdatactrl;
+	int ret, val;
 	u8 *buf;
 
 	slot = i3c_generic_ibi_get_free_slot(data->ibi_pool);
@@ -341,6 +342,13 @@ static int svc_i3c_master_handle_ibi(struct svc_i3c_master *master,
 	slot->len = 0;
 	buf = slot->data;
 
+	ret = readl_relaxed_poll_timeout(master->regs + SVC_I3C_MSTATUS, val,
+						SVC_I3C_MSTATUS_COMPLETE(val), 0, 1000);
+	if (ret) {
+		dev_err(master->dev, "Timeout when polling for COMPLETE\n");
+		return ret;
+	}
+
 	while (SVC_I3C_MSTATUS_RXPEND(readl(master->regs + SVC_I3C_MSTATUS))  &&
 	       slot->len < SVC_I3C_FIFO_SIZE) {
 		mdatactrl = readl(master->regs + SVC_I3C_MDATACTRL);
-- 
2.34.1