From patchwork Fri Aug 11 12:46:23 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Yann Sionneau X-Patchwork-Id: 714219 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id E40DAC001DE for ; Fri, 11 Aug 2023 12:53:15 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234191AbjHKMxO (ORCPT ); Fri, 11 Aug 2023 08:53:14 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:33920 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229449AbjHKMxN (ORCPT ); Fri, 11 Aug 2023 08:53:13 -0400 Received: from mx4.sionneau.net (mx4.sionneau.net [51.15.250.1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 797F9114; Fri, 11 Aug 2023 05:53:12 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sionneau.net; s=selectormx4; t=1691757988; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc; bh=CaLitFg0AQg0SHOtu12KE1t6WKRpx9J2tJDVn0wAGlQ=; b=yOzChHtAdLXsrrGyrh5FOxoWirMt8GAteFEMgiS35YA97tKuLkYXifA0gjKxWbU6Bvu2re elEWPXyHmH0kto3SmrFMss7Io21BOGrp3LNzjGGDkSnawlOMKeKrBgGTEGPj6KllAwNeD7 HzzUaCzbln8aOaFHe1bqqSq7xlzFvUw= Received: from junon.lin.mbt.kalray.eu ( [217.181.231.53]) by mx4.sionneau.net (OpenSMTPD) with ESMTPSA id 62fa6ae0 (TLSv1.3:TLS_AES_256_GCM_SHA384:256:NO); Fri, 11 Aug 2023 12:46:28 +0000 (UTC) From: Yann Sionneau To: Jarkko Nikula , Andy Shevchenko , Mika Westerberg Cc: linux-i2c@vger.kernel.org, linux-kernel@vger.kernel.org, Yann Sionneau , Jonathan Borne Subject: [PATCH 1/2] i2c: designware: fix __i2c_dw_disable in case master is holding SCL low Date: Fri, 11 Aug 2023 14:46:23 +0200 Message-Id: <20230811124624.12792-1-yann@sionneau.net> X-Mailer: git-send-email 2.17.1 Precedence: bulk List-ID: X-Mailing-List: linux-i2c@vger.kernel.org From: Yann Sionneau The designware IP can be synthesized with the IC_EMPTYFIFO_HOLD_MASTER_EN parameter. In which case, if the TX FIFO gets empty and the last command didn't have the STOP bit (IC_DATA_CMD[9]), the dw_apb_i2c will hold SCL low until a new command is pushed into the TX FIFO or the transfer is aborted. When the dw_apb_i2c is holding SCL low, it cannot be disabled. The transfer must first be aborted. Also, the bus recover won't work because SCL is held low by the master. This patch checks if the master is holding SCL low in __i2c_dw_disable before trying to disable the IP. If SCL is held low, an abort is initiated. When the abort is done, the disabling can then proceed. This whole situation can happen for instance during SMBUS read data block if the slave just responds with "byte count == 0". This puts the master in an unrecoverable state, holding SCL low and the current __i2c_dw_disable procedure is not working. In this situation only a Linux reboot can fix the i2c bus. Co-developed-by: Jonathan Borne Signed-off-by: Jonathan Borne Tested-by: Yann Sionneau Signed-off-by: Yann Sionneau --- drivers/i2c/busses/i2c-designware-common.c | 17 +++++++++++++++++ drivers/i2c/busses/i2c-designware-core.h | 3 +++ 2 files changed, 20 insertions(+) diff --git a/drivers/i2c/busses/i2c-designware-common.c b/drivers/i2c/busses/i2c-designware-common.c index 9f8574320eb2..744927b0c5af 100644 --- a/drivers/i2c/busses/i2c-designware-common.c +++ b/drivers/i2c/busses/i2c-designware-common.c @@ -440,8 +440,25 @@ void __i2c_dw_disable(struct dw_i2c_dev *dev) { int timeout = 100; u32 status; + u32 raw_intr_stats; + u32 enable; + bool abort_needed; + bool abort_done = false; + + regmap_read(dev->map, DW_IC_RAW_INTR_STAT, &raw_intr_stats); + regmap_read(dev->map, DW_IC_ENABLE, &enable); + + abort_needed = raw_intr_stats & DW_IC_INTR_MST_ON_HOLD; + if (abort_needed) + regmap_write(dev->map, DW_IC_ENABLE, enable | DW_IC_ENABLE_ABORT); do { + if (abort_needed && !abort_done) { + regmap_read(dev->map, DW_IC_ENABLE, &enable); + abort_done = !(enable & DW_IC_ENABLE_ABORT); + continue; + } + __i2c_dw_disable_nowait(dev); /* * The enable status register may be unimplemented, but diff --git a/drivers/i2c/busses/i2c-designware-core.h b/drivers/i2c/busses/i2c-designware-core.h index 19ae23575945..dcd9bd9ee00f 100644 --- a/drivers/i2c/busses/i2c-designware-core.h +++ b/drivers/i2c/busses/i2c-designware-core.h @@ -98,6 +98,7 @@ #define DW_IC_INTR_START_DET BIT(10) #define DW_IC_INTR_GEN_CALL BIT(11) #define DW_IC_INTR_RESTART_DET BIT(12) +#define DW_IC_INTR_MST_ON_HOLD BIT(13) #define DW_IC_INTR_DEFAULT_MASK (DW_IC_INTR_RX_FULL | \ DW_IC_INTR_TX_ABRT | \ @@ -109,6 +110,8 @@ DW_IC_INTR_RX_UNDER | \ DW_IC_INTR_RD_REQ) +#define DW_IC_ENABLE_ABORT BIT(1) + #define DW_IC_STATUS_ACTIVITY BIT(0) #define DW_IC_STATUS_TFE BIT(2) #define DW_IC_STATUS_MASTER_ACTIVITY BIT(5) From patchwork Fri Aug 11 12:46:24 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Yann Sionneau X-Patchwork-Id: 712980 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id ACB8EC001B0 for ; Fri, 11 Aug 2023 12:53:13 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229479AbjHKMxM (ORCPT ); Fri, 11 Aug 2023 08:53:12 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:33906 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229449AbjHKMxM (ORCPT ); Fri, 11 Aug 2023 08:53:12 -0400 X-Greylist: delayed 400 seconds by postgrey-1.37 at lindbergh.monkeyblade.net; Fri, 11 Aug 2023 05:53:10 PDT Received: from mx4.sionneau.net (mx4.sionneau.net [51.15.250.1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 5CFDE109; Fri, 11 Aug 2023 05:53:10 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sionneau.net; s=selectormx4; t=1691757988; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:in-reply-to:in-reply-to:references:references; bh=AhVnwGJ68D1Er7EJTToc3iXwRxrhSPiDwmkI0Rp62EY=; b=LlpAinAp59spqpc8ohnGESsFJg0xwj+1DyiGslwbKsCiEHN/pFllgeuIZIOIdPOp0Fk63f bqMh129NCs59I6WprKV0m3BdHdXJ/6DbusWqkPddwvA6PNOVgDZZtYRamoc5WPHLLIQ57z yo0SrJbcgVW0umx+h/zYp4VS/UXpNZs= Received: from junon.lin.mbt.kalray.eu ( [217.181.231.53]) by mx4.sionneau.net (OpenSMTPD) with ESMTPSA id 1b942a1f (TLSv1.3:TLS_AES_256_GCM_SHA384:256:NO); Fri, 11 Aug 2023 12:46:28 +0000 (UTC) From: Yann Sionneau To: Jarkko Nikula , Andy Shevchenko , Mika Westerberg Cc: linux-i2c@vger.kernel.org, linux-kernel@vger.kernel.org, Yann Sionneau , Jonathan Borne Subject: [PATCH 2/2] i2c: designware: abort the transfer if receiving byte count of 0 Date: Fri, 11 Aug 2023 14:46:24 +0200 Message-Id: <20230811124624.12792-2-yann@sionneau.net> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20230811124624.12792-1-yann@sionneau.net> References: <20230811124624.12792-1-yann@sionneau.net> Precedence: bulk List-ID: X-Mailing-List: linux-i2c@vger.kernel.org From: Yann Sionneau Context: It's not clear whether Linux SMBus stack supports receiving 0 as byte count for SMBus read data block. Linux supports SMBus v2.0 spec, which says "The byte count may not be 0." Which does not seem very clear to me, as a non-native speaker. (Note that v3.0 of the spec says "The byte count may be 0.") Some drivers explicitly return -EPROTO in case of byte count 0. The issue: Regardless of whether Linux supports byte count of 0, if this happens the i2c-designware driver goes into an unrecoverable state holding SCL low if the IP is synthesized with the IC_EMPTYFIFO_HOLD_MASTER_EN parameter. The fix proposed by this patch: Abort the transfer by sending a STOP condition on the bus. Another approach would be to ignore the issue and let the driver timeout and disable the IP. The IP disabling is fixed by the previous patch in this patch series. The current patch just makes the recovery faster since Abort is sent directly without waiting for the timeout to happen. With this patch, disabling the IP is not necessary anymore. Co-developed-by: Jonathan Borne Signed-off-by: Jonathan Borne Tested-by: Yann Sionneau Signed-off-by: Yann Sionneau --- drivers/i2c/busses/i2c-designware-master.c | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/drivers/i2c/busses/i2c-designware-master.c b/drivers/i2c/busses/i2c-designware-master.c index b55c19b2515a..fa5301566bb1 100644 --- a/drivers/i2c/busses/i2c-designware-master.c +++ b/drivers/i2c/busses/i2c-designware-master.c @@ -499,6 +499,15 @@ i2c_dw_recv_len(struct dw_i2c_dev *dev, u8 len) return len; } +static void +i2c_dw_abort(struct dw_i2c_dev *dev) +{ + u32 enable; + + regmap_read(dev->map, DW_IC_ENABLE, &enable); + regmap_write(dev->map, DW_IC_ENABLE, enable | DW_IC_ENABLE_ABORT); +} + static void i2c_dw_read(struct dw_i2c_dev *dev) { @@ -526,11 +535,16 @@ i2c_dw_read(struct dw_i2c_dev *dev) u32 flags = msgs[dev->msg_read_idx].flags; regmap_read(dev->map, DW_IC_DATA_CMD, &tmp); + tmp &= DW_IC_DATA_CMD_DAT; + /* Ensure length byte is a valid value */ - if (flags & I2C_M_RECV_LEN && - (tmp & DW_IC_DATA_CMD_DAT) <= I2C_SMBUS_BLOCK_MAX && (tmp & DW_IC_DATA_CMD_DAT) > 0) { - len = i2c_dw_recv_len(dev, tmp); + if (flags & I2C_M_RECV_LEN) { + if ((tmp <= I2C_SMBUS_BLOCK_MAX) && (tmp != 0)) + len = i2c_dw_recv_len(dev, tmp); + else + i2c_dw_abort(dev); } + *buf++ = tmp; dev->rx_outstanding--; }