2022-04-12 14:43:42

by Nuno Sa

[permalink] [raw]
Subject: RE: [PATCH] iio: proximity: Fix return value check of wait_for_completion_timeout



> -----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.
>
> Fixes: 3cef2e31b54b ("iio: proximity: vl53l0x: Add IRQ support")
> Signed-off-by: Miaoqian Lin <[email protected]>
> ---

Reviewed-by: Nuno S? <[email protected]>

> drivers/iio/proximity/vl53l0x-i2c.c | 7 +++----
> 1 file changed, 3 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/iio/proximity/vl53l0x-i2c.c
> b/drivers/iio/proximity/vl53l0x-i2c.c
> index 661a79ea200d..a284b20529fb 100644
> --- a/drivers/iio/proximity/vl53l0x-i2c.c
> +++ b/drivers/iio/proximity/vl53l0x-i2c.c
> @@ -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);
> --
> 2.17.1


2022-04-12 22:00:27

by Nuno Sa

[permalink] [raw]
Subject: RE: [PATCH] iio: proximity: Fix return value check of wait_for_completion_timeout

> 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
>
>
>
> > -----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.
> >
> > Fixes: 3cef2e31b54b ("iio: proximity: vl53l0x: Add IRQ support")
> > Signed-off-by: Miaoqian Lin <[email protected]>
> > ---
>
> Reviewed-by: Nuno S? <[email protected]>

Hi Lin,

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

- Nuno S?

2022-04-12 23:38:43

by Miaoqian Lin

[permalink] [raw]
Subject: [PATCH v2] 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")
Signed-off-by: Miaoqian Lin <[email protected]>
---
Changes in v2:
- add driver name in patch subject.
---
drivers/iio/proximity/vl53l0x-i2c.c | 7 +++----
1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/drivers/iio/proximity/vl53l0x-i2c.c b/drivers/iio/proximity/vl53l0x-i2c.c
index 661a79ea200d..a284b20529fb 100644
--- a/drivers/iio/proximity/vl53l0x-i2c.c
+++ b/drivers/iio/proximity/vl53l0x-i2c.c
@@ -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);
--
2.17.1

2022-04-18 03:16:55

by Jonathan Cameron

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

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")
> Signed-off-by: Miaoqian Lin <[email protected]>
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

> ---
> Changes in v2:
> - add driver name in patch subject.
> ---
> drivers/iio/proximity/vl53l0x-i2c.c | 7 +++----
> 1 file changed, 3 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/iio/proximity/vl53l0x-i2c.c b/drivers/iio/proximity/vl53l0x-i2c.c
> index 661a79ea200d..a284b20529fb 100644
> --- a/drivers/iio/proximity/vl53l0x-i2c.c
> +++ b/drivers/iio/proximity/vl53l0x-i2c.c
> @@ -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);