Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Robert Hancock <robert.hancock@calian.com>
To:     Michal Simek <michal.simek@amd.com>,
        Andi Shyti <andi.shyti@kernel.org>,
        Shubhrajyoti Datta <shubhraj@xilinx.com>,
        Wolfram Sang <wsa@kernel.org>, Marek Vasut <marex@denx.de>
Cc:     linux-arm-kernel@lists.infradead.org, linux-i2c@vger.kernel.org,
        linux-kernel@vger.kernel.org,
        Robert Hancock <robert.hancock@calian.com>
Subject: [PATCH] i2c: xiic: Don't try to handle more interrupt events after error
Date:   Tue,  6 Jun 2023 12:25:58 -0600
Message-Id: <20230606182558.1301413-1-robert.hancock@calian.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?7hZaYGs/Z9TXQr/GpXaRBGu5ryfdnWuEJMpl/tcmTcT3ZHlZ9LRx+JIeagOI?=
 =?us-ascii?Q?90BCfDAYq0x/QzsVZtrF0DGGkRci2cEkvjIL21XnGxkl6SDePnAIaa4I02dg?=
 =?us-ascii?Q?70BqgY9d8G+/CoORuAXi/1Z3DJZpzDKDjclqeHuu5zWcLzGbHvkq9cTjbqt9?=
 =?us-ascii?Q?jgixdzlhGCJ6cO6V8MkUp5ZS+N0r/Y1LcaYDhD+HAmBQlaktb6vSyvCRhqwh?=
 =?us-ascii?Q?Ji07oCA83X9e67nVFjxB0R+Aw4oQ1k7NgYqoPmXc7ScVPDLM4BEpZ2ir2J9A?=
 =?us-ascii?Q?wXMizS0zyVkn6xOi1mYJavdsrsjJ97Za+v05PJ175+Gpr+dtu5BoT8uMLAlo?=
 =?us-ascii?Q?oBLmikI3FQ0U8kmv4dk25teX0S9x63Nb3eCwAQv1UWPdpSwxfq2sAkw9G1rl?=
 =?us-ascii?Q?IizrLwnLYR8m+6ErOqJR9IbxBjuHJFhJsIigofvzmU8UZDx9mepkg1qjtPzX?=
 =?us-ascii?Q?wn+oY/wddyDcrDrH6MiiyEQMDggTWm+7RTU8o30Zug6YGdY35OGZKuXkKcIp?=
 =?us-ascii?Q?BsPRGi/ppy+SoHhTRTKmG4mutPCOUJkNDNvAjCq3wxm8YubU+Gm5EtRvaAbc?=
 =?us-ascii?Q?jbh35sgOsXWYMLASGoLmJk/lpbG7QbBgP2jh8s08hHvf+LJtMllMZUjS5anJ?=
 =?us-ascii?Q?p5ZOCHCrK80/nBECs+DyG8O0EgOCe76DXKJe41HMxuDn87Rc5dAveKP9SS1l?=
 =?us-ascii?Q?8o8CJpAVb6A8B0M4XzcI1YUxAs0fTe/IRHbAKnHLB01sWv++6xaMrzJXZiUx?=
 =?us-ascii?Q?aP4csxCjoWSvPGdCxrGhZU5th8Bqon7ODIYIZRpZnNKFRvDi0Qezx3x4KHbX?=
 =?us-ascii?Q?Egului5r1K7NWWbDVLWb66zHqm2saHcf4ATvWNMyc1DWyBQWWupi4Q7hl5lb?=
 =?us-ascii?Q?YRqD/wM4djKjsyBO1le+W6JbTLtfgYp6BMmI/V60XrYjR3W0mSsXC8DoSid9?=
 =?us-ascii?Q?+LHW0gjs8VewgOMe6DKBf4Q0FRJlOsWkvuVBTJa2LzHM9L/Tb6jmQeM8c9SU?=
 =?us-ascii?Q?6fWNQCRrxZYu4POxZSiRro3sLZyxd00sSbsik1VMj3oJZmJZCudemDQaRMnj?=
 =?us-ascii?Q?bjckPFZc+BG+G/J2qF3KQxMMq/8nSovgsCCC0RjSCAk0aojP7VKNHC26y5pP?=
 =?us-ascii?Q?zq2+7t6vA5Mo7GGGj4dpG0BR60EAzgeDKt2R8x/8aQQwvubq4KnTZznVZfVr?=
 =?us-ascii?Q?fFU+FjzVVBr8ed9/5TCjpFGik0BjZrJ8JLPRx3PsnbG7/gRQyvi41YyuaUbc?=
 =?us-ascii?Q?UF702A4694zWlIyunZvsllZsY5tHW+dnDSMVJgTb6mfnN/57jMh/Wd5V36r/?=
 =?us-ascii?Q?OYy0XwlilbgFoBiVXaj2TSFMYWib9yQd0vCo7Yh8RsLF3o1y3fZ94guVLRYk?=
 =?us-ascii?Q?fesQ35DNaGRQaCengCZAjwDs+xsn3nV+sgl6rW2cwLpW60ybMczs7nZCwju+?=
 =?us-ascii?Q?8PMb/mHIO1TfqHdziT4PyoRFO2VnPKwE0TN0+WIpflAtKt1iRqPIv4yO1Rwc?=
 =?us-ascii?Q?bv0s1B+OXCje21nS7dNghkK5e7J3+IZygAFfGoiFawTYxqL6qIiI02zutxzr?=
 =?us-ascii?Q?pXZr1gLRN0mJE2TxcDxFfIfsm3F6bijWC3xnYJTDtMgY+d1LjHZ1rwls1Zbg?=
 =?us-ascii?Q?QA=3D=3D?=
X-MS-Exchange-AntiSpam-ExternalHop-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-ExternalHop-MessageData-0: =?us-ascii?Q?VMmoPS7DDm+fIDJ2aCl80kWyBwhz5qSBx9gkvK8hKzKHNbDPlrCB8nCxEamw?=
 =?us-ascii?Q?LdGrEYoRteweNT7zJm0VBhuLPGj11Qvh/Q35AQKqltCVeuoBh+TWT+pmDucV?=
 =?us-ascii?Q?hTRLidRIIri2Yl0y4JT97eAo9FcpgbZTZHl5X3PYWJMkUfwu5kx8nGuYfPfn?=
 =?us-ascii?Q?C3y6RiqMFkS95vui8VNogOTqf/yB95XxfjWVfSUzzWkReIpK6/8sw2F3bC9P?=
 =?us-ascii?Q?pK1pFNuLlUyQCFkdkS9SOBxOpJ5EeE/+QgXvEliSgtc+feswTt4znzQYwrRG?=
 =?us-ascii?Q?gEnvooAlfpe5vrnc8e1ltAjLmZR9KinblpV+Oy4hfIee1ItnPuVwVuqtMrcZ?=
 =?us-ascii?Q?qt/UJ/dA1a/7CjYxn9l726uLXf4q41aAIWTX+w061HiNTQ6QPZDiuAE625uc?=
 =?us-ascii?Q?+XhC4EkSpzkgv73nkjsOq3v2RuakgDlJ4RpE9SDvxk4zoUzNbM6g4LrdoHQe?=
 =?us-ascii?Q?QnH+b7MeCoTD59CO92KeQAP5H0+q03DRkhf9jjOFlHGTWCPlrd4bQcNxO4YG?=
 =?us-ascii?Q?e0pDHlgeL3NnkT0HMruhKypUfUwjLED0WoN65RfMZCk3KReplOub+FACOgvX?=
 =?us-ascii?Q?oUvLuxJm6YbYVVJNLS0AI671o015ZMkT1FC8C+LHQOdTnF9WPvDymajq5YEe?=
 =?us-ascii?Q?UVZDVDlO8syHUkIkFOBfOtKzMy+6NFLYj8kurcd6cuNHTxEocbk0Bi8X5cBZ?=
 =?us-ascii?Q?rL8ntU+3iUaEZz4zNoW5PGg2PoE67vYS1krLWIxe6b3Xq4DyXfVNNfNwRSDc?=
 =?us-ascii?Q?E0h6x9Fv+JLpYREf6kXWRaySMCHmiO22lDjUWG9XJZM1K7r4fAPTy7bX0pA1?=
 =?us-ascii?Q?V4WFv/tH2H5q3MWClp5xL2encz9/jvK4c/aRPHbnW5TklcH+YJ4SgqZQeJ6k?=
 =?us-ascii?Q?vz02lMOzpDfnjQt+qToZ86KpYFlJ8DkiEUSqVfsCDFH7eoNtivSl8pu6sWW0?=
X-OriginatorOrg: calian.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 06065b16-21fe-4408-f248-08db66bb8de1
X-MS-Exchange-CrossTenant-AuthSource: YT2PR01MB8838.CANPRD01.PROD.OUTLOOK.COM
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 06 Jun 2023 18:26:33.0277
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 23b57807-562f-49ad-92c4-3bb0f07a1fdf
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: iLyshUSazuod2vu3/c0rEB3pMwSU1J+ejcvKyfUMbbGq4lRYduGwal8Wnmco2VXpky0Een9sQHUO9lrzQSqRKe+YGxoL7aaeQlc4X0ow15Q=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: YT3PR01MB6677
X-Proofpoint-GUID: EFjiZk9tNSMH3fj7TDcFsFWZ5EQqLBak
X-Proofpoint-ORIG-GUID: EFjiZk9tNSMH3fj7TDcFsFWZ5EQqLBak
X-Proofpoint-Virus-Version: vendor=baseguard
 engine=ICAP:2.0.254,Aquarius:18.0.957,Hydra:6.0.573,FMLib:17.11.176.26
 definitions=2023-06-06_13,2023-06-06_02,2023-05-22_02
X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 impostorscore=0
 priorityscore=1501 suspectscore=0 phishscore=0 clxscore=1011
 mlxlogscore=522 mlxscore=0 bulkscore=0 adultscore=0 lowpriorityscore=0
 malwarescore=0 spamscore=0 classifier=spam adjust=0 reason=mlx scancount=1
 engine=8.12.0-2304280000 definitions=main-2306060157
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,SPF_HELO_NONE,SPF_PASS,
        T_SCC_BODY_TEXT_LINE,URIBL_BLOCKED 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

In xiic_process, it is possible that error events such as arbitration
lost or TX error can be raised in conjunction with other interrupt flags
such as TX FIFO empty or bus not busy. Error events result in the
controller being reset and the error returned to the calling request,
but the function could potentially try to keep handling the other
events, such as by writing more messages into the TX FIFO. Since the
transaction has already failed, this is not helpful and will just cause
issues.

This problem has been present ever since:

commit 7f9906bd7f72 ("i2c: xiic: Service all interrupts in isr")

which allowed non-error events to be handled after errors, but became
more obvious after:

commit 743e227a8959 ("i2c: xiic: Defer xiic_wakeup() and
__xiic_start_xfer() in xiic_process()")

which reworked the code to add a WARN_ON which triggers if both the
xfer_more and wakeup_req flags were set, since this combination is
not supposed to happen, but was occurring in this scenario.

Skip further interrupt handling after error flags are detected to avoid
this problem.

Fixes: 7f9906bd7f72 ("i2c: xiic: Service all interrupts in isr")
Signed-off-by: Robert Hancock <robert.hancock@calian.com>
---
 drivers/i2c/busses/i2c-xiic.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/drivers/i2c/busses/i2c-xiic.c b/drivers/i2c/busses/i2c-xiic.c
index 8a3d9817cb41..ee6edc963dea 100644
--- a/drivers/i2c/busses/i2c-xiic.c
+++ b/drivers/i2c/busses/i2c-xiic.c
@@ -721,6 +721,8 @@ static irqreturn_t xiic_process(int irq, void *dev_id)
 			wakeup_req = 1;
 			wakeup_code = STATE_ERROR;
 		}
+		/* don't try to handle other events */
+		goto out;
 	}
 	if (pend & XIIC_INTR_RX_FULL_MASK) {
 		/* Receive register/FIFO is full */
-- 
2.40.1