Skip to contentSkip to conversation

iio: proximity: Fix return value check of wait_for_completion_timeout

PATCH Superseded Miaoqian Lin 3 participants 5 messages Apr 12, 2022 – Apr 16, 2022

Subsystems (2)

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 iio: proximity: 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 3cef2e31b54b ("iio: proximity: vl53l0x: Add IRQ support")
---
 drivers/iio/proximity/vl53l0x-i2c.c | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)
drivers/iio/proximity/vl53l0x-i2c.c +3 -4
index 661a79ea200d..a284b20529fb 100644
@@ -104,6 +104,7 @@ static int vl53l0x_read_proximity(struct vl53l0x_data *data,
 	u16 tries = 20;
 	u8 buffer[12];
 	int ret;
+	unsigned long time_left;
 
 	ret = i2c_smbus_write_byte_data(client, VL_REG_SYSRANGE_START, 1);
 	if (ret < 0)
@@ -112,10 +113,8 @@ static int vl53l0x_read_proximity(struct vl53l0x_data *data,
 	if (data->client->irq) {
 		reinit_completion(&data->completion);
 
-		ret = wait_for_completion_timeout(&data->completion, HZ/10);
-		if (ret < 0)
-			return ret;
-		else if (ret == 0)
+		time_left = wait_for_completion_timeout(&data->completion, HZ/10);
+		if (time_left == 0)
 			return -ETIMEDOUT;
 
 		vl53l0x_clear_irq(data);
Signature · 1 line
2.17.1
reviewer Reviewed-by on v1 1/1
#1 lore raw
Quoted 15 lines

-----Original Message-----
From: Miaoqian Lin <[email protected]>
Sent: Tuesday, April 12, 2022 5:00 AM
To: Song Qiang <[email protected]>; Jonathan Cameron <[email protected]>; Lars-Peter Clausen <[email protected]>; Ivan Drobyshevskyi <[email protected]>; linux- [email protected]; [email protected]
Cc: [email protected]
Subject: [PATCH] iio: proximity: Fix return value check of wait_for_completion_timeout

[External]

Quoted 8 lines

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 3cef2e31b54b ("iio: proximity: vl53l0x: Add IRQ support")

---

Quoted 36 lines
 drivers/iio/proximity/vl53l0x-i2c.c | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)
drivers/iio/proximity/vl53l0x-i2c.c +1 -0
index 661a79ea200d..a284b20529fb 100644
@@ -104,6 +104,7 @@ static int vl53l0x_read_proximity(struct
 vl53l0x_data *data,
 	u16 tries = 20;
 	u8 buffer[12];
 	int ret;
+	unsigned long time_left;
 
 	ret = i2c_smbus_write_byte_data(client,

VL_REG_SYSRANGE_START, 1);

drivers/iio/proximity/vl53l0x-i2c.c +2 -4
 	if (ret < 0)
@@ -112,10 +113,8 @@ static int vl53l0x_read_proximity(struct
 vl53l0x_data *data,
 	if (data->client->irq) {
 		reinit_completion(&data->completion);
 
-		ret = wait_for_completion_timeout(&data-
 >completion, HZ/10);
-		if (ret < 0)
-			return ret;
-		else if (ret == 0)
+		time_left = wait_for_completion_timeout(&data-
 >completion, HZ/10);
+		if (time_left == 0)
drivers/iio/proximity/vl53l0x-i2c.c +0 -1
 			return -ETIMEDOUT;
 
 		vl53l0x_clear_irq(data);
--

2.17.1

reviewer
#2 lore raw
Quoted 30 lines

From: Sa, Nuno
Sent: Tuesday, April 12, 2022 8:21 AM
To: Miaoqian Lin <[email protected]>; Song Qiang <[email protected]>; Jonathan Cameron <[email protected]>; Lars-Peter Clausen <[email protected]>; Ivan Drobyshevskyi <[email protected]>; linux- [email protected]; [email protected]
Subject: RE: [PATCH] iio: proximity: Fix return value check of wait_for_completion_timeout

Quoted 18 lines

-----Original Message-----
From: Miaoqian Lin <[email protected]>
Sent: Tuesday, April 12, 2022 5:00 AM
To: Song Qiang <[email protected]>; Jonathan Cameron <[email protected]>; Lars-Peter Clausen <[email protected]>; Ivan Drobyshevskyi <[email protected]>; linux- [email protected]; [email protected]
Cc: [email protected]
Subject: [PATCH] iio: proximity: Fix return value check of wait_for_completion_timeout

[External]

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.

Quoted 5 lines
Quoted 3 lines
Fixes 3cef2e31b54b ("iio: proximity: vl53l0x: Add IRQ support")

---

Hi Lin,

Just one note regarding the patch subject. You should indicate to which driver this patch applies "iio: proximity: vl53l0x: ..."

- Nuno Sá

#3 lore raw

PATCH v2 1/1 iio: proximity: vl53l0x: 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 3cef2e31b54b ("iio: proximity: vl53l0x: Add IRQ support")

---
Changes in v2:
- add driver name in patch subject.

---
 drivers/iio/proximity/vl53l0x-i2c.c | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)
drivers/iio/proximity/vl53l0x-i2c.c +3 -4
index 661a79ea200d..a284b20529fb 100644
@@ -104,6 +104,7 @@ static int vl53l0x_read_proximity(struct vl53l0x_data *data,
 	u16 tries = 20;
 	u8 buffer[12];
 	int ret;
+	unsigned long time_left;
 
 	ret = i2c_smbus_write_byte_data(client, VL_REG_SYSRANGE_START, 1);
 	if (ret < 0)
@@ -112,10 +113,8 @@ static int vl53l0x_read_proximity(struct vl53l0x_data *data,
 	if (data->client->irq) {
 		reinit_completion(&data->completion);
 
-		ret = wait_for_completion_timeout(&data->completion, HZ/10);
-		if (ret < 0)
-			return ret;
-		else if (ret == 0)
+		time_left = wait_for_completion_timeout(&data->completion, HZ/10);
+		if (time_left == 0)
 			return -ETIMEDOUT;
 
 		vl53l0x_clear_irq(data);
Signature · 1 line
2.17.1
maintainer Applied
#4 lore raw

Re: [PATCH v2] iio: proximity: vl53l0x: Fix return value check of wait_for_completion_timeout

Quoted 7 lines · On Tue, 12 Apr 2022 06:42:09 +0000 Miaoqian Lin <[email protected]> wrote:

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 3cef2e31b54b ("iio: proximity: vl53l0x: Add IRQ support")

Hi,

Applied to the togreg branch of iio.git ready for the next merge window. I'm not rushing this in because it's removing pointless and misleading code rather than fixing a bug as such.

Thanks,

Jonathan

Quoted 32 lines

---
Changes in v2:
- add driver name in patch subject.

---
 drivers/iio/proximity/vl53l0x-i2c.c | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)
drivers/iio/proximity/vl53l0x-i2c.c +3 -4
index 661a79ea200d..a284b20529fb 100644
@@ -104,6 +104,7 @@ static int vl53l0x_read_proximity(struct vl53l0x_data *data,
 	u16 tries = 20;
 	u8 buffer[12];
 	int ret;
+	unsigned long time_left;
 
 	ret = i2c_smbus_write_byte_data(client, VL_REG_SYSRANGE_START, 1);
 	if (ret < 0)
@@ -112,10 +113,8 @@ static int vl53l0x_read_proximity(struct vl53l0x_data *data,
 	if (data->client->irq) {
 		reinit_completion(&data->completion);
 
-		ret = wait_for_completion_timeout(&data->completion, HZ/10);
-		if (ret < 0)
-			return ret;
-		else if (ret == 0)
+		time_left = wait_for_completion_timeout(&data->completion, HZ/10);
+		if (time_left == 0)
 			return -ETIMEDOUT;
 
 		vl53l0x_clear_irq(data);