Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:7 as permitted sender) client-ip=2620:137:e000::3:7;
From:   Jan Bottorff <janb@os.amperecomputing.com>
To:     Jan Bottorff <janb@os.amperecomputing.com>,
        Jarkko Nikula <jarkko.nikula@linux.intel.com>,
        Andy Shevchenko <andriy.shevchenko@linux.intel.com>,
        Mika Westerberg <mika.westerberg@linux.intel.com>,
        Jan Dabros <jsd@semihalf.com>,
        Andi Shyti <andi.shyti@kernel.org>,
        Philipp Zabel <p.zabel@pengutronix.de>
Cc:     linux-i2c@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH] i2c: designware: Fix corrupted memory seen in the ISR
Date:   Tue, 12 Sep 2023 18:03:13 -0700
Message-ID: <20230913010313.418159-1-janb@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?VHFtI5jgxgxlcx4KKbQs8mFjJNlxFQS1GQBOoyO8v8ziTAdCn+W9ypWnc7GD?=
 =?us-ascii?Q?DkjWRO2fjXkSEH5lnXAJ4iMen5AIJ7GZYKhWJct7Xx7tHkdk3W7lkOuxaOSE?=
 =?us-ascii?Q?BRuwtQRdqiXPM3bbDEowgjfhyhNrsGmLcLtOg3NjCOAtC5ihtuu7BFRFBuhd?=
 =?us-ascii?Q?U6kMx+SnYFFLCBQoX/i5RwXxWf0SZWIXltzQV8hKz3AA3zm96prQtdSjjbQo?=
 =?us-ascii?Q?MOTktz/54Ey08UlPtJHIWkSi8NVU65+wdL8wWJDOsxVvv6/rGGcEVQo+jaWm?=
 =?us-ascii?Q?EnhhPgyRvwvobiXNGHgCPyAhzTTiFQHRWKkccbSvTUDZVGxFfnpHTnzYgrS+?=
 =?us-ascii?Q?aNphpT7dyTHzhGWvuapWV0LtXt1RlzRIqZ7CiAhFGdGOpYxvy2A1FCsmNPpk?=
 =?us-ascii?Q?IEDQ+gZwJloioowmq021KC8yV3c+VxyuhAksBlfSvppwNuWeoJ2LWof/hMz3?=
 =?us-ascii?Q?9HJyZ105A08XNOQ61sh9T29XCK2ag5vQ8UsYguBksWgfGGIyu3cznXgm6deZ?=
 =?us-ascii?Q?t3Z5IUgsV4YeQiZ50A+/NbrdZzFqjPCOgb1pStz0htDsf5wPZUXrU9EoBVs8?=
 =?us-ascii?Q?741hrRcWmNF6dObs+LE9q2glmjDrLqkgpmVEWUIen+j/9f2oPvRBNwzwm7bv?=
 =?us-ascii?Q?LPjtRcJvLB7H4NELglgJrSe6FYu25jWNy27h3THBJufy9iUtROKlxHkmezNT?=
 =?us-ascii?Q?8Wxre4OhRo13QzKBD8YlckoVcgBXcW7mJLpNpjrBDxclmWpJk53MBFQWlwus?=
 =?us-ascii?Q?8Pi7pnaAq3h1dvs9dQj5tb6JmUk+7YhuHegN9PiskKjmKxoP8ezBI6AzLbss?=
 =?us-ascii?Q?HytZZJzwXKtYgu7YT69mPpxI7mHfxxZ8qauEIn/xhEbrz1kqNwyIB5DzNSXR?=
 =?us-ascii?Q?2TGmij0iAin+n1m4sdDVPY2dqPoYJYpWtEYagk8syPtwTQSz9LRlwfYr6C+k?=
 =?us-ascii?Q?1nD7e1pnAgQhQMNUEuvB1ja35wDoW+6mijsd+7fP1ORj2UD0R7bX2EsbmMga?=
 =?us-ascii?Q?iRE9OoHTa1gFUJ2Pjs0NWJURXO+g1QyUhYhZApMQwCPFVLNl90ozJuaNs1hF?=
 =?us-ascii?Q?N9V99U4hhAgwUXGMntKDwWQvkQMyAd7Br00ehxZrXtn2m7C2aux7iwM85iXH?=
 =?us-ascii?Q?082KYOn6lZGCdJifVOeFHKl7UND7YpFvn+eamGGRsvRup5FxAF0hDd+DkSlT?=
 =?us-ascii?Q?HzxVvPvVnl/qXXD413yAm1d+08gYMMPh0ugbv6Z1CGb/7C/F5g95G4sP0q0P?=
 =?us-ascii?Q?08Qfr0L/0BMrd0EbVjvksgNWRnzOExAC8bAsNRl68fEB10FK6ev39nPIA+n1?=
 =?us-ascii?Q?dwVXyQLop4yALuxurJ0cYyGnDylQ39f+CilRdqXm1aVKBm41NDT2PjS5kO3+?=
 =?us-ascii?Q?iw0yTv8VaXR4GS8BSF3xkaqVF2HvwdvDMzweLZHowz+VdHCZJBSaE+5smtAz?=
 =?us-ascii?Q?FX+nKZ2lKuzte7vePedzC48ul9chmPre2YbPqDClguH5UjmGYlwYr5zgsA3e?=
 =?us-ascii?Q?rpR0ssEpfS7lSL6Tnfsnv0x4iG478gFHEvfA026PHOCo5NYbp2AWE+OnB+1o?=
 =?us-ascii?Q?/ubFH+kxTm5XRURH6pZJ6KtVuTiE5tbsn+OB3voQzEYO7ualli8syQbdM7Uf?=
 =?us-ascii?Q?IgNPHoNnYQ54hEaxukeHfzo=3D?=
X-OriginatorOrg: os.amperecomputing.com
X-MS-Exchange-CrossTenant-Network-Message-Id: d7dbe1c4-1972-40e0-bc92-08dbb3f54900
X-MS-Exchange-CrossTenant-AuthSource: DM6PR01MB4044.prod.exchangelabs.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 13 Sep 2023 01:03:47.7663
 (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: oYVCK5eZUHF9ji0UZX4cgvzA1Nkfk2Eko9kOqO8D7pXAUyGpPy0qAF786LXPb76ttWU8zJCiSRN1QqskvTSNSvXpmE02CNP+3AbGYEgXA9s=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: CH3PR01MB8575
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]); Tue, 12 Sep 2023 18:03:56 -0700 (PDT)

Errors were happening in the ISR that looked like corrupted
memory. This was because writes from the core enabling interrupts
where not yet visible to the core running the ISR. A write barrier
assures writes to driver data structures are visible to all cores
before interrupts are enabled.

The ARM Barrier Litmus Tests and Cookbook has an example under
Sending Interrupts and Barriers that matches the usage in this
driver. That document says a DSB barrier is required.

Signed-off-by: Jan Bottorff <janb@os.amperecomputing.com>
---
 drivers/i2c/busses/i2c-designware-master.c | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/drivers/i2c/busses/i2c-designware-master.c b/drivers/i2c/busses/i2c-designware-master.c
index ca1035e010c7..1694ac6bb592 100644
--- a/drivers/i2c/busses/i2c-designware-master.c
+++ b/drivers/i2c/busses/i2c-designware-master.c
@@ -248,6 +248,14 @@ static void i2c_dw_xfer_init(struct dw_i2c_dev *dev)
 	/* Dummy read to avoid the register getting stuck on Bay Trail */
 	regmap_read(dev->map, DW_IC_ENABLE_STATUS, &dummy);
 
+	/*
+	 * To guarantee data written by the current core is visible to
+	 * all cores, a write barrier is required. This needs to be
+	 * before an interrupt causes execution on another core.
+	 * For ARM processors, this needs to be a DSB barrier.
+	 */
+	wmb();
+
 	/* Clear and enable interrupts */
 	regmap_read(dev->map, DW_IC_CLR_INTR, &dummy);
 	regmap_write(dev->map, DW_IC_INTR_MASK, DW_IC_INTR_MASTER_MASK);
-- 
2.41.0