Skip to contentSkip to conversation

net: dsa: Fix return value check of wait_for_completion_timeout

PATCH In review Miaoqian Lin 2 participants 2 messages Apr 12, 2022

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 net: dsa: Fix return value check of wait_for_completion_timeout

wait_for_completion_timeout() returns unsigned long not int. It returns 0 if timed out, and positive if completed. The check for <= 0 is ambiguous and should be == 0 here indicating timeout which is the only error case.

Fixes 2cd548566384 ("net: dsa: qca8k: add support for phy read/write with mgmt Ethernet")
Fixes 5950c7c0a68c ("net: dsa: qca8k: add support for mgmt read/write in Ethernet packet")
---
 drivers/net/dsa/qca8k.c | 25 +++++++++++++------------
 1 file changed, 13 insertions(+), 12 deletions(-)
drivers/net/dsa/qca8k.c +13 -12
index d3ed0a7f8077..bd8c238955a8 100644
@@ -300,7 +300,7 @@ static int qca8k_read_eth(struct qca8k_priv *priv, u32 reg, u32 *val, int len)
 	struct qca8k_mgmt_eth_data *mgmt_eth_data = &priv->mgmt_eth_data;
 	struct sk_buff *skb;
 	bool ack;
-	int ret;
+	unsigned long ret;
 
 	skb = qca8k_alloc_mdio_header(MDIO_READ, reg, NULL,
 				      QCA8K_ETHERNET_MDIO_PRIORITY, len);
@@ -338,7 +338,7 @@ static int qca8k_read_eth(struct qca8k_priv *priv, u32 reg, u32 *val, int len)
 
 	mutex_unlock(&mgmt_eth_data->mutex);
 
-	if (ret <= 0)
+	if (ret == 0)
 		return -ETIMEDOUT;
 
 	if (!ack)
@@ -352,7 +352,7 @@ static int qca8k_write_eth(struct qca8k_priv *priv, u32 reg, u32 *val, int len)
 	struct qca8k_mgmt_eth_data *mgmt_eth_data = &priv->mgmt_eth_data;
 	struct sk_buff *skb;
 	bool ack;
-	int ret;
+	unsigned long ret;
 
 	skb = qca8k_alloc_mdio_header(MDIO_WRITE, reg, val,
 				      QCA8K_ETHERNET_MDIO_PRIORITY, len);
@@ -386,7 +386,7 @@ static int qca8k_write_eth(struct qca8k_priv *priv, u32 reg, u32 *val, int len)
 
 	mutex_unlock(&mgmt_eth_data->mutex);
 
-	if (ret <= 0)
+	if (ret == 0)
 		return -ETIMEDOUT;
 
 	if (!ack)
@@ -956,7 +956,7 @@ qca8k_phy_eth_busy_wait(struct qca8k_mgmt_eth_data *mgmt_eth_data,
 {
 	struct sk_buff *skb = skb_copy(read_skb, GFP_KERNEL);
 	bool ack;
-	int ret;
+	unsigned long ret;
 
 	reinit_completion(&mgmt_eth_data->rw_done);
 
@@ -972,7 +972,7 @@ qca8k_phy_eth_busy_wait(struct qca8k_mgmt_eth_data *mgmt_eth_data,
 
 	ack = mgmt_eth_data->ack;
 
-	if (ret <= 0)
+	if (ret == 0)
 		return -ETIMEDOUT;
 
 	if (!ack)
@@ -993,6 +993,7 @@ qca8k_phy_eth_command(struct qca8k_priv *priv, bool read, int phy,
 	struct net_device *mgmt_master;
 	int ret, ret1;
 	bool ack;
+	unsigned long time_left;
 
 	if (regnum >= QCA8K_MDIO_MASTER_MAX_REG)
 		return -EINVAL;
@@ -1059,12 +1060,12 @@ qca8k_phy_eth_command(struct qca8k_priv *priv, bool read, int phy,
 
 	dev_queue_xmit(write_skb);
 
-	ret = wait_for_completion_timeout(&mgmt_eth_data->rw_done,
-					  QCA8K_ETHERNET_TIMEOUT);
+	time_left = wait_for_completion_timeout(&mgmt_eth_data->rw_done,
+						QCA8K_ETHERNET_TIMEOUT);
 
 	ack = mgmt_eth_data->ack;
 
-	if (ret <= 0) {
+	if (time_left == 0) {
 		ret = -ETIMEDOUT;
 		kfree_skb(read_skb);
 		goto exit;
@@ -1096,12 +1097,12 @@ qca8k_phy_eth_command(struct qca8k_priv *priv, bool read, int phy,
 
 		dev_queue_xmit(read_skb);
 
-		ret = wait_for_completion_timeout(&mgmt_eth_data->rw_done,
-						  QCA8K_ETHERNET_TIMEOUT);
+		time_left = wait_for_completion_timeout(&mgmt_eth_data->rw_done,
+							QCA8K_ETHERNET_TIMEOUT);
 
 		ack = mgmt_eth_data->ack;
 
-		if (ret <= 0) {
+		if (time_left == 0) {
 			ret = -ETIMEDOUT;
 			goto exit;
 		}
Signature · 1 line
2.17.1
maintainer
#1 lore raw
Quoted 4 lines · Miaoqian Lin

wait_for_completion_timeout() returns unsigned long not int. It returns 0 if timed out, and positive if completed. The check for <= 0 is ambiguous and should be == 0 here indicating timeout which is the only error case.

Please fix your subject line to indicate which driver you are patching.

Please also read the netdev FAQ which will point out a few other process issues.

Quoted 13 lines
Fixes 2cd548566384 ("net: dsa: qca8k: add support for phy read/write with mgmt Ethernet")
Fixes 5950c7c0a68c ("net: dsa: qca8k: add support for mgmt read/write in Ethernet packet")
---
 drivers/net/dsa/qca8k.c | 25 +++++++++++++------------
 1 file changed, 13 insertions(+), 12 deletions(-)
drivers/net/dsa/qca8k.c +0 -0
index d3ed0a7f8077..bd8c238955a8 100644

drivers/net/dsa/qca8k.c static int qca8k_read_eth(struct qca8k_priv *priv, u32 reg, u32 *val, int len) · line 303

Quoted 5 lines
drivers/net/dsa/qca8k.c +1 -1
@@ -300,7 +300,7 @@ static int qca8k_read_eth(struct qca8k_priv *priv, u32 reg, u32 *val, int len)
 	struct qca8k_mgmt_eth_data *mgmt_eth_data = &priv->mgmt_eth_data;
 	struct sk_buff *skb;
 	bool ack;
-	int ret;
+	unsigned long ret;

Please sort variables longest to shortest, reverse christmass tree.

drivers/net/dsa/qca8k.c static int qca8k_read_eth(struct qca8k_priv *priv, u32 reg, u32 *val, int len) · line 342

Quoted 10 lines
drivers/net/dsa/qca8k.c +1 -1
 	skb = qca8k_alloc_mdio_header(MDIO_READ, reg, NULL,
 				      QCA8K_ETHERNET_MDIO_PRIORITY, len);
@@ -338,7 +338,7 @@ static int qca8k_read_eth(struct qca8k_priv *priv, u32 reg, u32 *val, int len)
 
 	mutex_unlock(&mgmt_eth_data->mutex);
 
-	if (ret <= 0)
+	if (ret == 0)
 		return -ETIMEDOUT;

Given this change, what happens if -ERESTARTSYS is returned?

Please consider the same question for all cases you change <= to ==.

Andrew