Received-SPF: pass (google.com: domain of linux-kernel+bounces-161252-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) client-ip=2604:1380:40f1:3f00::1;
References: <20240427203611.3750-1-wsa+renesas@sang-engineering.com>
 <20240427203611.3750-3-wsa+renesas@sang-engineering.com>
User-agent: mu4e 1.10.8; emacs 29.2
From: Baruch Siach <baruch@tkos.co.il>
To: Wolfram Sang <wsa+renesas@sang-engineering.com>
Cc: linux-i2c@vger.kernel.org, Andi Shyti <andi.shyti@kernel.org>,
 linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH 02/15] i2c: digicolor: use 'time_left' variable with
 wait_for_completion_timeout()
Date: Sun, 28 Apr 2024 07:38:00 +0300
In-reply-to: <20240427203611.3750-3-wsa+renesas@sang-engineering.com>
Message-ID: <87il02cd9a.fsf@tarshish>
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain

Hi Wolfram,

On Sat, Apr 27 2024, Wolfram Sang wrote:
> There is a confusing pattern in the kernel to use a variable named 'timeout' to
> store the result of wait_for_completion_timeout() 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
> self explaining.
>
> Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>

Acked-by: Baruch Siach <baruch@tkos.co.il>

Thanks,
baruch

> ---
>  drivers/i2c/busses/i2c-digicolor.c | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/drivers/i2c/busses/i2c-digicolor.c b/drivers/i2c/busses/i2c-digicolor.c
> index 3462f2bc0fa8..737604ae11fc 100644
> --- a/drivers/i2c/busses/i2c-digicolor.c
> +++ b/drivers/i2c/busses/i2c-digicolor.c
> @@ -213,7 +213,7 @@ static irqreturn_t dc_i2c_irq(int irq, void *dev_id)
>  static int dc_i2c_xfer_msg(struct dc_i2c *i2c, struct i2c_msg *msg, int first,
>  			   int last)
>  {
> -	unsigned long timeout = msecs_to_jiffies(TIMEOUT_MS);
> +	unsigned long time_left = msecs_to_jiffies(TIMEOUT_MS);
>  	unsigned long flags;
>  
>  	spin_lock_irqsave(&i2c->lock, flags);
> @@ -227,9 +227,9 @@ static int dc_i2c_xfer_msg(struct dc_i2c *i2c, struct i2c_msg *msg, int first,
>  	dc_i2c_start_msg(i2c, first);
>  	spin_unlock_irqrestore(&i2c->lock, flags);
>  
> -	timeout = wait_for_completion_timeout(&i2c->done, timeout);
> +	time_left = wait_for_completion_timeout(&i2c->done, time_left);
>  	dc_i2c_set_irq(i2c, 0);
> -	if (timeout == 0) {
> +	if (time_left == 0) {
>  		i2c->state = STATE_IDLE;
>  		return -ETIMEDOUT;
>  	}


-- 
                                                     ~. .~   Tk Open Systems
=}------------------------------------------------ooO--U--Ooo------------{=
   - baruch@tkos.co.il - tel: +972.52.368.4656, http://www.tkos.co.il -