Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:2 as permitted sender) client-ip=2620:137:e000::3:2;
From:   Quan Nguyen <quan@os.amperecomputing.com>
To:     Brendan Higgins <brendan.higgins@linux.dev>,
        Benjamin Herrenschmidt <benh@kernel.crashing.org>,
        Joel Stanley <joel@jms.id.au>,
        Andi Shyti <andi.shyti@kernel.org>,
        Andrew Jeffery <andrew@codeconstruct.com.au>,
        Wolfram Sang <wsa@kernel.org>,
        Jae Hyun Yoo <jae.hyun.yoo@linux.intel.com>,
        Guenter Roeck <linux@roeck-us.net>, linux-i2c@vger.kernel.org,
        openbmc@lists.ozlabs.org, linux-arm-kernel@lists.infradead.org,
        linux-aspeed@lists.ozlabs.org, linux-kernel@vger.kernel.org
Cc:     Cosmo Chou <chou.cosmo@gmail.com>,
        Open Source Submission <patches@amperecomputing.com>,
        Phong Vo <phong@os.amperecomputing.com>,
        "Thang Q . Nguyen" <thang@os.amperecomputing.com>
Subject: [PATCH v2 RESEND 2/2] i2c: aspeed: Acknowledge Tx done with and without ACK irq late
Date:   Tue, 28 Nov 2023 14:52:36 +0700
Message-Id: <20231128075236.2724038-3-quan@os.amperecomputing.com>
In-Reply-To: <20231128075236.2724038-1-quan@os.amperecomputing.com>
References: <20231128075236.2724038-1-quan@os.amperecomputing.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?P/6TwgBolVNVVBEIJfsfm7kmfNHVZzbaSPmgq7NWjaeTo19fJqjwpfjAONqN?=
 =?us-ascii?Q?orTJEL4psbyoD4cq87dDba+aQlM2gpd2gkOxZzBLjjJOEwMJmT4KsvwWZvAF?=
 =?us-ascii?Q?bnyswp3jIupQ4v/+PW76DPodTEN80sV/BmHo1YzxPj4yRiYLNJ3lQ8cCkElA?=
 =?us-ascii?Q?HXV+tbfS9Ue0neR73hWaIpYdJXKnPZF6rZLk7Ehm44sbtjnvyTLWNSavbOl5?=
 =?us-ascii?Q?fXfJnpOqjjANrXesnVrLRHDFrfCwtyO7q8arC1CB84Qy7TUJus+j3PLj57lW?=
 =?us-ascii?Q?bq3cJWJ+LWCNNnW9/x0NLgqFuNQYms8G2Xs3RLM05lAD7UITr5VJoX+yn5PB?=
 =?us-ascii?Q?27Jh/XN5mb/sZiNoXFmJQbAaCo3ZZf3Us4qnl3IcIW2xMPooRX0k5PfUsFu0?=
 =?us-ascii?Q?m6bpcY0IZuyuT2KwD41zMr+HKDVkhi+tqFqzuhx14k/IOikMaJe90aPGZHAS?=
 =?us-ascii?Q?8uAs71hI7WIYEQ9YblGkMFJoS0/RHqWGe6ujqfaoVLh+AtvPLB0d8w87FjGe?=
 =?us-ascii?Q?6VjiFqyTobb6LIE330Ut0NYQuN+yMXk0dqPvMl6l/vQzmIL0A/ZJTywvGTh/?=
 =?us-ascii?Q?866NvhqMu6eOVxapGUe9dJHUwEUOftQ93fxisUcsJX9vALsRCAAb9SlmBGuI?=
 =?us-ascii?Q?rsY1RJqI3IxfoQQNducO0XpCsCY5dSOdBzIK5eY/HRNRvGL6cirzTS9jMSuW?=
 =?us-ascii?Q?m6W1WGMlg4tTvDYyJFz9v2cgj+nlYhhnLACRGloQO8dr7AhwHySHA6d+3V9w?=
 =?us-ascii?Q?BNS4sbx+2awa9NGfAgBIKA1iSXu9tZaaZl2UFsNoeNq8dPlte+SYsLS1NmQA?=
 =?us-ascii?Q?LFu2Jinaed6PlDINh5CpZ2RnSQhSNc1DPPB7I+2O6HEzpWf4+C5Jmg+c7F4Z?=
 =?us-ascii?Q?jXDx4UcxtQ567erYMUXMgHqrmBUo2sfkbk1FFmOHsWt381pEvOGAGVajBPLp?=
 =?us-ascii?Q?BjBuNTHvHQwbJLg2bDchIuhtp4aS8g4pJuyMtUuShheoaghuwM7Z3iHeQPm9?=
 =?us-ascii?Q?I10q6ShDE1Ga9YP66QCSeplEvqv6YBBqaAq3SsNAh2Y0/dxIx2JFH6NyKAPi?=
 =?us-ascii?Q?FZc7I8xiD0TWfDLRb9Oiso5L/ExYFXIDPP8s8io3gdUXNBTa0D8JbDd2Mi7J?=
 =?us-ascii?Q?a0jiMtOj68dk8F3AxkXHYdWFGbvohgft9BH8fbZqCDM1ZyRQZoLteKUnTeMj?=
 =?us-ascii?Q?x3cNEOdMhJiRtZXfQ+xRQC5sl/RJKYWJOXDBT463pnJk6JW0hRR43JIMxIYt?=
 =?us-ascii?Q?yutuoMhoPEWCJi7DTn1EiwQFIN/1vxts40xKUjnsgENsT/HJb5c6qWhFg6Zf?=
 =?us-ascii?Q?fjSY9nxkMC+USd2Yj5VR3fslmIm289Mqtkt+txM7dwezVqG+QARJfPzdwTY0?=
 =?us-ascii?Q?weZgtvdZtGpMl1VY+cmDqLP0ZFt9D5wtGKKxiRbRxS9c9FKHF86jitl+eGUF?=
 =?us-ascii?Q?KlkeLk7S+53Hg7xXPWMH3+AIMc/f0H/w0PR549Cipg+j5TxVzSj0Y96N/f7A?=
 =?us-ascii?Q?0l05EFdy/HdcbpbP7rK9W1TiY4hT74DUIcive/+CMfMM9UO8DEf6gSBachVv?=
 =?us-ascii?Q?PGFXpgdqc4b+JV7GHgthah8/BUPF3fuvOn4W13TYqavZw3Qe0deXJbJ0meFF?=
 =?us-ascii?Q?hW+CKT3Kh94+zeiLmC4IEDc=3D?=
X-OriginatorOrg: os.amperecomputing.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 9048d942-9b4a-42da-45ff-08dbefe70ff8
X-MS-Exchange-CrossTenant-AuthSource: SN4PR01MB7455.prod.exchangelabs.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 28 Nov 2023 07:53:08.9241
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 3bc2b170-fd94-476d-b0ce-4229bdc904a7
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: gW+M3wKwjgOURJulrCb61DrhQGGIpIYaxkDpCMe8t2Jt18WmTqntA2bGMo/AZtymN0063TggJGYxQq6HFih7xo8rJY+gsIJsG7BMnwjsKzs=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH0PR01MB7895
X-Spam-Status: No, score=-0.9 required=5.0 tests=DKIM_SIGNED,DKIM_VALID,
	DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,
	SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE autolearn=unavailable
	autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on agentk.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 (agentk.vger.email [0.0.0.0]); Mon, 27 Nov 2023 23:53:35 -0800 (PST)

Commit 2be6b47211e1 ("i2c: aspeed: Acknowledge most interrupts early in
interrupt handler") acknowledges most interrupts early before the slave
irq handler is executed, except for the "Receive Done Interrupt status"
which is acknowledged late in the interrupt.
However, it is observed that the early acknowledgment of "Transmit Done
Interrupt Status" (with ACK or NACK) often causes the interrupt to be
raised in READ REQUEST state, resulting in "Unexpected ACK on read
request." complaint messages.

Assuming that the "Transmit Done" interrupt should only be acknowledged
once it is truly processed, this commit fixes this issue by acknowledging
this interrupt for both ACK and NACK cases late in the interrupt handler
also.

Fixes: 2be6b47211e1 ("i2c: aspeed: Acknowledge most interrupts early in interrupt handler")
Signed-off-by: Quan Nguyen <quan@os.amperecomputing.com>
---
v2:
  + Split to separate series [Joel]
  + Added the Fixes line [Joel]
  + Fixed multiline comment [Joel]
  + Refactor irq clearing code [Joel, Guenter]
  + Revised commit message [Joel]
  + Revised commit message [Quan]
  + About a note to remind why the readl() should immediately follow the
writel() to fix the race condition when clearing irq status from commit
c926c87b8e36 ("i2c: aspeed: Avoid i2c interrupt status clear race
condition"), I think it looks straight forward in this patch and decided
not to add that note. [Joel]

v1:
  + First introduced in
https://lore.kernel.org/all/20210519074934.20712-1-quan@os.amperecomputing.com/
---
 drivers/i2c/busses/i2c-aspeed.c | 17 +++++++++--------
 1 file changed, 9 insertions(+), 8 deletions(-)

diff --git a/drivers/i2c/busses/i2c-aspeed.c b/drivers/i2c/busses/i2c-aspeed.c
index 79476b46285b..3231f430e335 100644
--- a/drivers/i2c/busses/i2c-aspeed.c
+++ b/drivers/i2c/busses/i2c-aspeed.c
@@ -611,8 +611,9 @@ static irqreturn_t aspeed_i2c_bus_irq(int irq, void *dev_id)
 
 	spin_lock(&bus->lock);
 	irq_received = readl(bus->base + ASPEED_I2C_INTR_STS_REG);
-	/* Ack all interrupts except for Rx done */
-	writel(irq_received & ~ASPEED_I2CD_INTR_RX_DONE,
+	/* Ack all interrupts except for Rx done and Tx done with/without ACK */
+	writel(irq_received &
+	       ~(ASPEED_I2CD_INTR_RX_DONE | ASPEED_I2CD_INTR_TX_ACK | ASPEED_I2CD_INTR_TX_NAK),
 	       bus->base + ASPEED_I2C_INTR_STS_REG);
 	readl(bus->base + ASPEED_I2C_INTR_STS_REG);
 	irq_received &= ASPEED_I2CD_INTR_RECV_MASK;
@@ -657,12 +658,12 @@ static irqreturn_t aspeed_i2c_bus_irq(int irq, void *dev_id)
 			"irq handled != irq. expected 0x%08x, but was 0x%08x\n",
 			irq_received, irq_handled);
 
-	/* Ack Rx done */
-	if (irq_received & ASPEED_I2CD_INTR_RX_DONE) {
-		writel(ASPEED_I2CD_INTR_RX_DONE,
-		       bus->base + ASPEED_I2C_INTR_STS_REG);
-		readl(bus->base + ASPEED_I2C_INTR_STS_REG);
-	}
+	/* Ack Rx done and Tx done with/without ACK */
+	writel(irq_received &
+	       (ASPEED_I2CD_INTR_RX_DONE | ASPEED_I2CD_INTR_TX_ACK | ASPEED_I2CD_INTR_TX_NAK),
+	       bus->base + ASPEED_I2C_INTR_STS_REG);
+	readl(bus->base + ASPEED_I2C_INTR_STS_REG);
+
 	spin_unlock(&bus->lock);
 	return irq_remaining ? IRQ_NONE : IRQ_HANDLED;
 }
-- 
2.35.1