mbox series

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

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

Message

Wolfram Sang April 30, 2024, noon 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 (3):
  slimbus: messaging: use 'time_left' variable with
    wait_for_completion_timeout()
  slimbus: qcom-ctrl: use 'time_left' variable with
    wait_for_completion_timeout()
  slimbus: qcom-ngd-ctrl: use 'time_left' variable with
    wait_for_completion_timeout()

 drivers/slimbus/messaging.c     |  9 +++++----
 drivers/slimbus/qcom-ctrl.c     |  7 ++++---
 drivers/slimbus/qcom-ngd-ctrl.c | 29 ++++++++++++++++-------------
 3 files changed, 25 insertions(+), 20 deletions(-)

Comments

Bjorn Andersson April 30, 2024, 1:30 p.m. UTC | #1
On Tue, Apr 30, 2024 at 02:00:58PM +0200, Wolfram Sang 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.
> 

Reviewed-by: Bjorn Andersson <quic_bjorande@quicinc.com>

Regards,
Bjorn

> Wolfram Sang (3):
>   slimbus: messaging: use 'time_left' variable with
>     wait_for_completion_timeout()
>   slimbus: qcom-ctrl: use 'time_left' variable with
>     wait_for_completion_timeout()
>   slimbus: qcom-ngd-ctrl: use 'time_left' variable with
>     wait_for_completion_timeout()
> 
>  drivers/slimbus/messaging.c     |  9 +++++----
>  drivers/slimbus/qcom-ctrl.c     |  7 ++++---
>  drivers/slimbus/qcom-ngd-ctrl.c | 29 ++++++++++++++++-------------
>  3 files changed, 25 insertions(+), 20 deletions(-)
> 
> -- 
> 2.43.0
>
Wolfram Sang July 29, 2024, 10:58 a.m. UTC | #2
On Tue, Apr 30, 2024 at 06:30:00AM -0700, Bjorn Andersson wrote:
> On Tue, Apr 30, 2024 at 02:00:58PM +0200, Wolfram Sang 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.
> > 
> 
> Reviewed-by: Bjorn Andersson <quic_bjorande@quicinc.com>

Thanks, Bjorn. Is Srinivas still pick slimbus patches?
Srinivas Kandagatla Aug. 1, 2024, 1:13 p.m. UTC | #3
On Tue, 30 Apr 2024 14:00:58 +0200, Wolfram Sang 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.
> 
> [...]

Applied, thanks!

[1/3] slimbus: messaging: use 'time_left' variable with wait_for_completion_timeout()
      commit: 0eb9dda9d1db40acbabe923fe22c002e13890d39
[2/3] slimbus: qcom-ctrl: use 'time_left' variable with wait_for_completion_timeout()
      commit: 7d317b95d0334371481ec00ca31f5bf76bae8a82
[3/3] slimbus: qcom-ngd-ctrl: use 'time_left' variable with wait_for_completion_timeout()
      commit: 9f5fd5e2aebf06c37355cacc7f4b4410bc0ea233

Best regards,