Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.37 as permitted sender) client-ip=23.128.96.37;
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>,
        Quan Nguyen <quan@os.amperecomputing.com>
Subject: [PATCH v4 2/2] i2c: aspeed: Acknowledge Tx done with and without ACK irq late
Date:   Mon, 11 Dec 2023 17:22:17 +0700
Message-Id: <20231211102217.2436294-3-quan@os.amperecomputing.com>
In-Reply-To: <20231211102217.2436294-1-quan@os.amperecomputing.com>
References: <20231211102217.2436294-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?lHduaNS8DVTh9rEkMjoGrFTJdjb3/AG2NOLmhLfENOAT/NMI4E0Be5DpsA3O?=
 =?us-ascii?Q?KoLVzlQyMs9IQGzEvOrZ3qz3ukLTcOnaxvmVYzTJte9aO5Std4Fga4UIDmET?=
 =?us-ascii?Q?RYypn+7lvkLTRZIE6d8BNvyA+UBuLNvcQ0JP+D5ntL7mcFwTfnMmdRjvmy4V?=
 =?us-ascii?Q?9x7qQ3bvV8qyPkCMD9GTHbZpJDvuskAMzeB1l06260QX9SOkso6AyxfTFa0D?=
 =?us-ascii?Q?amAajX/+vVDNZNZdb1euUHay8q6Ckx49grcfgTkq57oD0Z0wQLwYkab6aZwZ?=
 =?us-ascii?Q?jgZ/+/ZjGfbUXthXYqiD6GtcReOLpH1TjOxzFxsP2ZdSeks12E6ib/bpiI3E?=
 =?us-ascii?Q?qIWgAdZ75AcVhpwI4nsbu4X2Ojh3HFAxIGHMB6xyKj3gh9Y5QjtWaTDQZsZM?=
 =?us-ascii?Q?dKAANbL5fOlS6ZKTEQFrjYvHCoJta7vh5JQ2U9OzZJlQPiMP079LOVTlxNl4?=
 =?us-ascii?Q?xj6BqBnpLc1t7FNHZEkqN4DQIFUjyQ9/NQ29UylTTVd/FeO8FIHP1DMkWnIe?=
 =?us-ascii?Q?Z2XoB/cBG6uRF4J4Jq2rqImwaURLo0QPPsdyqXMhYflv3+GqcmRNJR8n459f?=
 =?us-ascii?Q?W5e7VUM/cWugCQTHVt3SHYgBtPUw8mTemXd5kNP3/z5oLAAhSnAK3esCXk0w?=
 =?us-ascii?Q?eu9tuikIatKFlCOYl0LkMsUm2KKMqJZTIt/d9ukzOf1shW7U7H9pqpbGa1rH?=
 =?us-ascii?Q?q2Jq2uz16qRicuqOd20sA+VrIeXrdAgAZqQE5Q0k8kptmJ/lM10PDWcRK86s?=
 =?us-ascii?Q?AJfZxvWiWrnaHhDSNaCROWWK3OaNScD1I11DuRG9lzaiolnU2LTpuOZTGHo9?=
 =?us-ascii?Q?U+5pwg/bPFZiYhuG6Z70M2K8mQYNBmb+xs9Rdv3irRBJh2+hzqRhDCyjFlYF?=
 =?us-ascii?Q?pmITgi+fJt5siORHX6v4iEno/XINZENB55S3WFt48t129DHzlkH46o0BlrAk?=
 =?us-ascii?Q?1k+1Gjirq1NSgvCqi8BUjepP/pQbfpxS+DKV35bCW4v43XBp/hB7t5Ox+Hkt?=
 =?us-ascii?Q?wrp3+MuUouVs0NRFn/GcARXGTN6xSTG5a4MHND5cORLoHnA2Pmn2IzLA8ugD?=
 =?us-ascii?Q?v/7vWGbWHpa7dFjkTsHTDELFliOYAbnGdpuh3rLvvoJG06bGd+7EofLpk91u?=
 =?us-ascii?Q?EBgIdBVsphStGbsJputrMdvjWSUgwiePRvDGfWvKNIpr9sOFLjSs7ecIaKq8?=
 =?us-ascii?Q?6H7pfBahPyaSckhXoBLa+kgp44hScV91kNjpX9kd4264wRFjdZghArsqvCwu?=
 =?us-ascii?Q?LR70OXRIwU+EIZHasM/AgveGeUztzI1x1EffXAIqaGoHgT5nMsXkbkGkqaQD?=
 =?us-ascii?Q?z/xyeRNVM5WzQ57RKRV/OON/ovPqQKVKWN0pUvPkLUquJecmjOsaEqIfeAhc?=
 =?us-ascii?Q?oRHIj5tdfzf6hvezt/NwisMCWAmoe+bFBv806f4i/9s1kirhlxfY3iuRz4vv?=
 =?us-ascii?Q?KZ3PUptRBuoHRunZPxD2sdtCdo8TSMGDTPrY+K4XhOL/MByV30bGnKAhowol?=
 =?us-ascii?Q?zJBiFrCBVeotRLkKkUkItn+7eO/bEXg5BHYNZXsRr/lEKh69X9CQLfLXkow8?=
 =?us-ascii?Q?N/G4TPd7Jt6x7UA2M6NVGEs7/hTvr+jbWsUBXG2cfJTtC2OttmH2tiBLO8+i?=
 =?us-ascii?Q?+fE5kvhlyyDJ8dwk2sQmUDE=3D?=
X-OriginatorOrg: os.amperecomputing.com
X-MS-Exchange-CrossTenant-Network-Message-Id: a303e0ec-eb89-417a-744d-08dbfa331fd5
X-MS-Exchange-CrossTenant-AuthSource: SN4PR01MB7455.prod.exchangelabs.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 11 Dec 2023 10:22:49.1549
 (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: PItBE7hQJPUk1izhwECgYdVAJft+7UDK0p7N2wmh4omF1x975WbDKas1MPK9DhOef3sW9bJsTMWYQG6MVpLVByfIORcLa6ukgJqjVLG2GmE=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: CO1PR01MB6568
X-Spam-Status: No, score=-2.0 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,
        SPF_HELO_PASS,SPF_PASS,T_SCC_BODY_TEXT_LINE autolearn=ham
        autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
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 (snail.vger.email [0.0.0.0]); Mon, 11 Dec 2023 02:23:03 -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 has been 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, that shows the
"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 that issue by acknowledging
interrupts for both ACK and NACK cases late in the interrupt handler.

Fixes: 2be6b47211e1 ("i2c: aspeed: Acknowledge most interrupts early in interrupt handler")
Signed-off-by: Quan Nguyen <quan@os.amperecomputing.com>
---
v4:
  + Switch to use define macro instead of variable             [Andrew]
  + Make the early ack conditionally to avoid unnecessary
writel()/readl()                                                 [Quan]

v3:
  + Fix the unconditinal write when ack the irqs               [Andrew]
  + Refactor the code to enhance code readability                [Quan]
  + Fix grammar in commit message                                [Quan]

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 | 27 ++++++++++++++++++++-------
 1 file changed, 20 insertions(+), 7 deletions(-)

diff --git a/drivers/i2c/busses/i2c-aspeed.c b/drivers/i2c/busses/i2c-aspeed.c
index 5511fd46a65e..0f67218cf04a 100644
--- a/drivers/i2c/busses/i2c-aspeed.c
+++ b/drivers/i2c/busses/i2c-aspeed.c
@@ -93,6 +93,10 @@
 		 ASPEED_I2CD_INTR_RX_DONE |				       \
 		 ASPEED_I2CD_INTR_TX_NAK |				       \
 		 ASPEED_I2CD_INTR_TX_ACK)
+#define ASPEED_I2CD_INTR_ACK_RX_TX					       \
+		(ASPEED_I2CD_INTR_RX_DONE |				       \
+		 ASPEED_I2CD_INTR_TX_ACK |				       \
+		 ASPEED_I2CD_INTR_TX_NAK)
 
 /* 0x14 : I2CD Command/Status Register   */
 #define ASPEED_I2CD_SCL_LINE_STS			BIT(18)
@@ -622,10 +626,19 @@ 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,
-	       bus->base + ASPEED_I2C_INTR_STS_REG);
-	readl(bus->base + ASPEED_I2C_INTR_STS_REG);
+
+	/*
+	 * Early acking of INTR_RX_DONE and INTR_TX_[ACK|NAK] would indicate HW to
+	 * start receiving or sending new data, and this may cause a race condition
+	 * as the irq handler has not yet handled these irqs but is being acked.
+	 * Let's ack them late at the end of the irq handler when those are truly processed.
+	 */
+	if (irq_received & ~ASPEED_I2CD_INTR_ACK_RX_TX) {
+		writel(irq_received & ~ASPEED_I2CD_INTR_ACK_RX_TX,
+		       bus->base + ASPEED_I2C_INTR_STS_REG);
+		readl(bus->base + ASPEED_I2C_INTR_STS_REG);
+	}
+
 	irq_received &= ASPEED_I2CD_INTR_RECV_MASK;
 	irq_remaining = irq_received;
 
@@ -668,12 +681,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,
+	if (irq_received & ASPEED_I2CD_INTR_ACK_RX_TX) {
+		writel(irq_received & ASPEED_I2CD_INTR_ACK_RX_TX,
 		       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