Received-SPF: pass (google.com: domain of linux-kernel+bounces-184391-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.48.161 as permitted sender) client-ip=147.75.48.161;
From: Wei Fang <wei.fang@nxp.com>
To: davem@davemloft.net,
	edumazet@google.com,
	kuba@kernel.org,
	pabeni@redhat.com,
	shenwei.wang@nxp.com,
	xiaoning.wang@nxp.com,
	richardcochran@gmail.com,
	andrew@lunn.ch,
	netdev@vger.kernel.org
Cc: linux-kernel@vger.kernel.org,
	imx@lists.linux.dev
Subject: [PATCH v2 net] net: fec: avoid lock evasion when reading pps_enable
Date: Tue, 21 May 2024 10:38:00 +0800
Message-Id: <20240521023800.17102-1-wei.fang@nxp.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?us-ascii?Q?5woukFLKNDy1pBFOYbry7rw8ayA7DrVMV+EkjG3G6vxxU0Dmxje4jhrDF3Ix?=
 =?us-ascii?Q?XbpD+juqePfUJySi0dltcr0mFnYQdsyX8AHg0z6oeJZYmm9Z8gWOW2Vajthu?=
 =?us-ascii?Q?6fydqOdGhsPOHmcvXT4t+Eg3vWBrMt63Qx0qYO0/ZSNFsG+kjJRN3JhXGm3n?=
 =?us-ascii?Q?YU8wYfCD4gu/af1drdYqJrIYZnad/e2HM9+HvE87yJ9+HoK/lBcrmF7iCey+?=
 =?us-ascii?Q?OPZwPNhctcI80yuhLr0+2CMRRPUgfclA+4iN1rWSVw4yjnKYQXrvTyoVU/Ro?=
 =?us-ascii?Q?z5OLlsn5RCivbl/zOArDE40OTFP3e9SFPz2fJY0zxV6FrqUjvndtXjB+KKL4?=
 =?us-ascii?Q?PhiRiFyOJYQGVwdqCUzrIjWEgpOOXx0Oc7vsLKRaJFkukuX1sQ5cuczdyfJF?=
 =?us-ascii?Q?HhG7uAi/jPhh5hUURiE6fmEYiZD7w/rdeUSz28wYlViDc8a5q+BMgp7KxKnv?=
 =?us-ascii?Q?SR9zEW3o+rsigwcK49VoFhd/OPD0BLQ5vwWjzwnxia6WIA90ZYmq8rafBO+M?=
 =?us-ascii?Q?DEolZlngSp0wMsLarmbUTj1BRx96Z38XweZH0IiJ8o5GHPhpSDdH25WqlZHM?=
 =?us-ascii?Q?bVhxJGxXCuQmAdFFqoO1+HMg6cGFqw8qkbinbl3+3oiya3ULlPwkIVurqPH7?=
 =?us-ascii?Q?WEdA5jQ7gH/Z4c0ohDmpsD62BoIkkvnwo93BLbqTu2xXSf3KuxiMYE/kF8Sl?=
 =?us-ascii?Q?LxAw7UyWGspYELw+rJqNNCY1Hvpsoi+SaKO30+q64xYq6zpn3+LfiPyV1wcE?=
 =?us-ascii?Q?ZQ4d4z4OSBs8fBdwxfne15J0t/Mv/eeLuiiwjf9KKpuZ63htsbq0Rd42t8JZ?=
 =?us-ascii?Q?oWOSNlYrXBy6ly3h/vpM9c5LMNNPrDh2KXoFiu4D9ZAHAvF41tq9htFKkQdV?=
 =?us-ascii?Q?DQ8juYXvyxHsbOrBf0wl78LEVrP22XjpuQBHI4Y03qXmBKeXngQbZShAPjK0?=
 =?us-ascii?Q?WyTCYqSjwUTTESZ+BjGg+Wa+dQvLR7wGiqWh1QdcMRidBk2H6PjfwFZTSF8b?=
 =?us-ascii?Q?NFsdPVeMWrs9igVxsgE43rCzSgG9NV4u2iwq0YoVf4OrHnBEI2QTjLhX6dRo?=
 =?us-ascii?Q?UI500JlFHKhri4O5VdJH22w2+UJcmbA+HwbN6SpILzPoMoMcyGHKQPMhgz5V?=
 =?us-ascii?Q?4hrJqSTbBoo03H6VocvCMSrJ+knL0w7Avul+SazQ+5sXvr44h0GuW8xg+nke?=
 =?us-ascii?Q?VHQD6cXzW6DSUeVGZYegCLXHIOnE5TgsZd0rxLDRB7atZta2j4LN25zQLGCI?=
 =?us-ascii?Q?s9s/iHVBvfW3B6zAjguFywrzppUQvhdNBuTZpRVtYXzBaiKRxZqSjkszovG8?=
 =?us-ascii?Q?kbKXyz88x7mRv2bLizn8h6PEE6MAipo0TvII1gA9Iakru5fs2FKNHO+UGH8G?=
 =?us-ascii?Q?Qdas8exWYX57Aua5A17vKEbT6nrEKyngSec+NrCgoRUgzjcE+l/SEgZZNvD6?=
 =?us-ascii?Q?0FXCbBi7fqiygbJTMZoiN9wo3KJQ2b9FtXIxEhdnx1LJ9aNjy1y4GBZMPyIa?=
 =?us-ascii?Q?egCAJXFU7Sl8gR0RmsIt0eVRZjNcA9i4Nv+wL1OBTknCbCrUuQeaIbeFr0oF?=
 =?us-ascii?Q?jG/HkeV13QnEp01PhNflqTFe/UhSJ5V//wEliqsv?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 7fbc2711-412a-468d-ecbb-08dc79409233
X-MS-Exchange-CrossTenant-AuthSource: PAXPR04MB8510.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 21 May 2024 02:49:01.9567
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: 0sFFmJwN7Y+/f573l79f7LkiqO82NRtdLTRPNsmBNpUXw2vCB9437BLibjIsol9THkoaT8PbWfWseGwwNJz2sA==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI0PR04MB10094

The assignment of pps_enable is protected by tmreg_lock, but the read
operation of pps_enable is not. So the Coverity tool reports a lock
evasion warning which may cause data race to occur when running in a
multithread environment. Although this issue is almost impossible to
occur, we'd better fix it, at least it seems more logically reasonable,
and it also prevents Coverity from continuing to issue warnings.

Fixes: 278d24047891 ("net: fec: ptp: Enable PPS output based on ptp clock")
Signed-off-by: Wei Fang <wei.fang@nxp.com>
---
V2 changes:
Moved the assignment positions of pps_channel and reload_period.
---
 drivers/net/ethernet/freescale/fec_ptp.c | 14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)

diff --git a/drivers/net/ethernet/freescale/fec_ptp.c b/drivers/net/ethernet/freescale/fec_ptp.c
index 181d9bfbee22..e32f6724f568 100644
--- a/drivers/net/ethernet/freescale/fec_ptp.c
+++ b/drivers/net/ethernet/freescale/fec_ptp.c
@@ -104,14 +104,13 @@ static int fec_ptp_enable_pps(struct fec_enet_private *fep, uint enable)
 	struct timespec64 ts;
 	u64 ns;
 
-	if (fep->pps_enable == enable)
-		return 0;
-
-	fep->pps_channel = DEFAULT_PPS_CHANNEL;
-	fep->reload_period = PPS_OUPUT_RELOAD_PERIOD;
-
 	spin_lock_irqsave(&fep->tmreg_lock, flags);
 
+	if (fep->pps_enable == enable) {
+		spin_unlock_irqrestore(&fep->tmreg_lock, flags);
+		return 0;
+	}
+
 	if (enable) {
 		/* clear capture or output compare interrupt status if have.
 		 */
@@ -532,6 +531,9 @@ static int fec_ptp_enable(struct ptp_clock_info *ptp,
 	int ret = 0;
 
 	if (rq->type == PTP_CLK_REQ_PPS) {
+		fep->pps_channel = DEFAULT_PPS_CHANNEL;
+		fep->reload_period = PPS_OUPUT_RELOAD_PERIOD;
+
 		ret = fec_ptp_enable_pps(fep, on);
 
 		return ret;
-- 
2.34.1