Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.36 as permitted sender) client-ip=23.128.96.36;
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 1/2] i2c: aspeed: Fix unhandled Tx done with NAK
Date:   Tue, 28 Nov 2023 14:52:35 +0700
Message-Id: <20231128075236.2724038-2-quan@os.amperecomputing.com>
In-Reply-To: <20231128075236.2724038-1-quan@os.amperecomputing.com>
References: <20231128075236.2724038-1-quan@os.amperecomputing.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?eWtuSUEvUmVrVmhKRFIzL25zM0F5LzlQUk1lWGtXVit5MDF1K1dScitMam9T?=
 =?utf-8?B?eUk1VWUrdUdoaFdMYXV3SHZaVDJZUkk2TFJPQXRIbmFxZENhY2dJTHdLNk8z?=
 =?utf-8?B?aUZrTkNlZEpmV1czN1BYSlJyRXh5M0x3TUNiVENpS04rYnIxSWJOcHU2R1h5?=
 =?utf-8?B?UmZTY1NIR2g4ZkNpNm5WS3R3eXk2cURPRlVkaFFQVVgyUjc0OGZuQlk0MUh1?=
 =?utf-8?B?Uzg1SkJISDUzM25WRnN0WWFzWFJWa3NsQjJoNGdYNlhBUk85RjViQUJ3bVdO?=
 =?utf-8?B?M2p2Ym5idUY3b2hYWTR0dUtlSzBYNnJlRDQwU2NDQXRZVmpwdEtyLzl2aWho?=
 =?utf-8?B?TTMyTGJXblhlbWE0bnI1WlFhcitQWTJVN0N4aE1jMkEvWm9oL3M1SndEUGRG?=
 =?utf-8?B?RU5LblliNkp6S1dVaXFpK0JXQ2pRcUVlRUc3UjlBUzBWYkthbk1lcGRBYitv?=
 =?utf-8?B?SnlXeE1iMTQxb3dOTFp5WUlCNkV2b1pEQ1hFR3ZhNVhtMldHVy96ZUpMTStL?=
 =?utf-8?B?dTVsSTF2S3oxMGU0UlZkbzBSckxnT2QxMFJRSWwzRmF5RWpubGhqYkZIbUlD?=
 =?utf-8?B?QXhHSTZKcDJDbWVnVHZORXpjSHpxSDZ3bjlnVkFtTis5Wi9sTHpzK0xNcjVk?=
 =?utf-8?B?b212V3FCT0J5bjBDMzh4RjQwTGZhNzU4VkN1VXZidnlsOGx2MnVnSVZ0NC9j?=
 =?utf-8?B?SXpPbSttUVhvK1RCVjdIc0VwRDhLYys2Q291SlFGMjRWMmdHZnJvaSttWXNn?=
 =?utf-8?B?bXhyQ05OR1FITGNRVkhnN3EzeUhPeldVV1lBV1MrOXRMTmVYNlNvQW9OUXBF?=
 =?utf-8?B?K3NLTS80ZStkNW5DdEVjMTYwd2U3TjZIUnZtQ0hzSVI3QzZvQTRia2ZFdkpl?=
 =?utf-8?B?Z3VjMFI4Z09PWWlYb21udGRVZ1E5TG1kUFVrMGx2VU9mQm5Bdk1XYlhCWVd3?=
 =?utf-8?B?Qm83Wlp6dVd3Y0FtMW5EMkRrY29tMnRiTnFkeDlWcXBMRTRXYjh6N0s5M0Ra?=
 =?utf-8?B?bGJ6RVpaVDJKQVFNTWFEQnFYQlZ6S2Y0Nmh2eXpvMlB3RzFWUDZYZzZYRXBV?=
 =?utf-8?B?aXpOd0lqcXIwTEVwelhmbGw2amNvQnNOeG9PUlBLMllyRk11c0pZSDRuRHNT?=
 =?utf-8?B?dHR4cER1TnBQMTZnUDZLWFRybUtpMDN1cjhLSGNyMERVRXFmMnRxcEtKOWdY?=
 =?utf-8?B?WFR2VU92djdFVlNqbExvWFlJQ1p0N21lRnlRcEY4ZFhFbU5uK2ZPN0l0SUw3?=
 =?utf-8?B?YWhENS9JZkpVWTkrVmxJdUhscnRicEdYN3B5SGxxL3VaNmJPZ1RmWS9Zbkd3?=
 =?utf-8?B?T1ltMGIrOVJsZFIwU20zZ2lXQlJRUFRqa1JtdU1wWkJkdXRsTDEvZFlIRnhN?=
 =?utf-8?B?N29UMWlwVWs2cjM5ODZyZTFXZGdFR0NPanBPUW9Sd2ZVOFNYUWowcFNudzkx?=
 =?utf-8?B?bDlkakc5VStQVmtBc1BVdGkwZ1VBcDJMbW5sU2VlMW9uTm04NjJtMVZOWE1J?=
 =?utf-8?B?WjVaT2RsNlhIUUQ0eEFQaVFjWUpDTFFSeDFNNEk1NUdZL0ZpSlI4SEpKMXBp?=
 =?utf-8?B?ZktWVS9PZmJVRytvd2h0T245WmR0T1YwMWdnWk56Y2ZzTUdNRUV4eFBJZ2pI?=
 =?utf-8?B?THRHczducUNuczVHWXJ2RGRtTWhWWkh3TVF2ZFFjNUNKLzVrWUJ5NUJrSk0w?=
 =?utf-8?B?NXphOTY0bERFZ2tXVXJBcGNjV3k1SFZIVHl0WWxXalpFNGJ0c21oTW1mN2xs?=
 =?utf-8?B?cFg5dnQyTlJhaVdXQzkyYjRIQ01RN0oxSHNlWVVydGxwblVHT3RpZVVGeEpR?=
 =?utf-8?B?Z1BkZ0luQ1RSaEx6dTRsVFRHUURITWxzalpBQmtidFJONmw1YVFYa3RLVWsx?=
 =?utf-8?B?eWxjelA0KzRTdGZuQzVuUnAwN242STIvdVNjTXNoYlYyUER2RlMyMVFzd2NS?=
 =?utf-8?B?cmEwbkVmNHBEMG4yZEtuUUpzb2VqamxjT25lMGpFZnpvdnMzQVZlcGJNUHRx?=
 =?utf-8?B?YndBZXdXdkdpZWZLV3JNcXBra0srVjZxNk5jSzlycUVxV1VUZnplSXlhYVRG?=
 =?utf-8?B?bWpMVDRSSGtDTTVJNEJTeHZxWnI1RUZiTlV2dHZpZXNJMGJmbHRhdFA1Q0NF?=
 =?utf-8?B?S3RoclJOQndyUDRkSGVUNFViRWIwcHpJeEVyUmxGUm43c1l1Wkt3Y0UxN3J3?=
 =?utf-8?Q?I8TIMMK3KwbHsQ+WZlMS9EU=3D?=
X-OriginatorOrg: os.amperecomputing.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 1eadd8e9-0c1a-4f35-3126-08dbefe70cad
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:03.5932
 (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: CkUj1KW4UY4MD1YJegZzUY40UghVetA4cYtb5V6sna9uiXItDO1/XREnh5i+YhRfkgAeOL7ilNKIvJlKq17y0N4FJQBldZmugUirGgRLUkE=
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 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]); Mon, 27 Nov 2023 23:53:56 -0800 (PST)

Under normal conditions, after the last byte is sent by the Slave, the
TX_NAK interrupt is raised.  However, it is also observed that
sometimes the Master issues the next transaction too quickly while the
Slave IRQ handler is not yet invoked and the TX_NAK interrupt for the
last byte of the previous READ_PROCESSED state has not been ack’ed.
This TX_NAK interrupt is then raised together with SLAVE_MATCH interrupt
and RX_DONE interrupt of the next coming transaction from Master. The
Slave IRQ handler currently handles the SLAVE_MATCH and RX_DONE, but
ignores the TX_NAK, causing complaints such as
"aspeed-i2c-bus 1e78a040.i2c-bus: irq handled != irq. Expected
0x00000086, but was 0x00000084"

This commit adds code to handle this case by emitting a SLAVE_STOP event
for the TX_NAK before processing the RX_DONE for the coming transaction
from the Master.

Fixes: f9eb91350bb2 ("i2c: aspeed: added slave support for Aspeed I2C driver")
Signed-off-by: Quan Nguyen <quan@os.amperecomputing.com>
---
v2:
  + Split to separate series [Joel]
  + Added the Fixes line [Joel]
  + Revised commit message [Quan]

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

diff --git a/drivers/i2c/busses/i2c-aspeed.c b/drivers/i2c/busses/i2c-aspeed.c
index 28e2a5fc4528..79476b46285b 100644
--- a/drivers/i2c/busses/i2c-aspeed.c
+++ b/drivers/i2c/busses/i2c-aspeed.c
@@ -253,6 +253,11 @@ static u32 aspeed_i2c_slave_irq(struct aspeed_i2c_bus *bus, u32 irq_status)
 
 	/* Slave was requested, restart state machine. */
 	if (irq_status & ASPEED_I2CD_INTR_SLAVE_MATCH) {
+		if (irq_status & ASPEED_I2CD_INTR_TX_NAK &&
+		    bus->slave_state == ASPEED_I2C_SLAVE_READ_PROCESSED) {
+			irq_handled |= ASPEED_I2CD_INTR_TX_NAK;
+			i2c_slave_event(slave, I2C_SLAVE_STOP, &value);
+		}
 		irq_handled |= ASPEED_I2CD_INTR_SLAVE_MATCH;
 		bus->slave_state = ASPEED_I2C_SLAVE_START;
 	}
-- 
2.35.1