mbox series

[0/8] iio: use 'time_left' instead of 'timeout' with wait_for_*() functions

Message ID 20240429113313.68359-1-wsa+renesas@sang-engineering.com (mailing list archive)
Headers show
Series iio: use 'time_left' instead of 'timeout' with wait_for_*() functions | expand

Message

Wolfram Sang April 29, 2024, 11:33 a.m. UTC
There is a confusing pattern in the kernel to use a variable named 'timeout' to
store the result of wait_for_*() functions causing patterns like:

        timeout = wait_for_completion_timeout(...)
        if (!timeout) return -ETIMEDOUT;

with all kinds of permutations. Use 'time_left' as a variable to make the code
obvious and self explaining.

This is part of a tree-wide series. The rest of the patches can be found here
(some parts may still be WIP):

git://git.kernel.org/pub/scm/linux/kernel/git/wsa/linux.git i2c/time_left

Because these patches are generated, I audit them before sending. This is why I
will send series step by step. Build bot is happy with these patches, though.
No functional changes intended.

Wolfram Sang (8):
  iio: adc: ad_sigma_delta: use 'time_left' variable with
    wait_for_completion_timeout()
  iio: adc: exynos_adc: use 'time_left' variable with
    wait_for_completion_timeout()
  iio: adc: fsl-imx25-gcq: use 'time_left' variable with
    wait_for_completion_interruptible_timeout()
  iio: adc: intel_mrfld_adc: use 'time_left' variable with
    wait_for_completion_interruptible_timeout()
  iio: adc: stm32-adc: use 'time_left' variable with
    wait_for_completion_interruptible_timeout()
  iio: adc: stm32-dfsdm-adc: use 'time_left' variable with
    wait_for_completion_interruptible_timeout()
  iio: adc: twl6030-gpadc: use 'time_left' variable with
    wait_for_completion_interruptible_timeout()
  iio: pressure: zpa2326: use 'time_left' variable with
    wait_for_completion_interruptible_timeout()

 drivers/iio/adc/ad_sigma_delta.c  |  6 +++---
 drivers/iio/adc/exynos_adc.c      | 16 ++++++++--------
 drivers/iio/adc/fsl-imx25-gcq.c   | 10 +++++-----
 drivers/iio/adc/intel_mrfld_adc.c | 12 ++++++------
 drivers/iio/adc/stm32-adc.c       | 10 +++++-----
 drivers/iio/adc/stm32-dfsdm-adc.c | 12 ++++++------
 drivers/iio/adc/twl6030-gpadc.c   |  8 ++++----
 drivers/iio/pressure/zpa2326.c    | 10 +++++-----
 8 files changed, 42 insertions(+), 42 deletions(-)

Comments

Jonathan Cameron April 29, 2024, 8:06 p.m. UTC | #1
On Mon, 29 Apr 2024 13:33:03 +0200
Wolfram Sang <wsa+renesas@sang-engineering.com> wrote:

> There is a confusing pattern in the kernel to use a variable named 'timeout' to
> store the result of wait_for_*() functions causing patterns like:
> 
>         timeout = wait_for_completion_timeout(...)
>         if (!timeout) return -ETIMEDOUT;
> 
> with all kinds of permutations. Use 'time_left' as a variable to make the code
> obvious and self explaining.
> 
> This is part of a tree-wide series. The rest of the patches can be found here
> (some parts may still be WIP):
> 
> git://git.kernel.org/pub/scm/linux/kernel/git/wsa/linux.git i2c/time_left
> 
> Because these patches are generated, I audit them before sending. This is why I
> will send series step by step. Build bot is happy with these patches, though.
> No functional changes intended.

Nice improvement.  Applied

> 
> Wolfram Sang (8):
>   iio: adc: ad_sigma_delta: use 'time_left' variable with
>     wait_for_completion_timeout()
>   iio: adc: exynos_adc: use 'time_left' variable with
>     wait_for_completion_timeout()
>   iio: adc: fsl-imx25-gcq: use 'time_left' variable with
>     wait_for_completion_interruptible_timeout()
>   iio: adc: intel_mrfld_adc: use 'time_left' variable with
>     wait_for_completion_interruptible_timeout()
>   iio: adc: stm32-adc: use 'time_left' variable with
>     wait_for_completion_interruptible_timeout()
>   iio: adc: stm32-dfsdm-adc: use 'time_left' variable with
>     wait_for_completion_interruptible_timeout()
>   iio: adc: twl6030-gpadc: use 'time_left' variable with
>     wait_for_completion_interruptible_timeout()
>   iio: pressure: zpa2326: use 'time_left' variable with
>     wait_for_completion_interruptible_timeout()
> 
>  drivers/iio/adc/ad_sigma_delta.c  |  6 +++---
>  drivers/iio/adc/exynos_adc.c      | 16 ++++++++--------
>  drivers/iio/adc/fsl-imx25-gcq.c   | 10 +++++-----
>  drivers/iio/adc/intel_mrfld_adc.c | 12 ++++++------
>  drivers/iio/adc/stm32-adc.c       | 10 +++++-----
>  drivers/iio/adc/stm32-dfsdm-adc.c | 12 ++++++------
>  drivers/iio/adc/twl6030-gpadc.c   |  8 ++++----
>  drivers/iio/pressure/zpa2326.c    | 10 +++++-----
>  8 files changed, 42 insertions(+), 42 deletions(-)
>