Re: [PATCH 6/8] spi: sun4i: use 'time_left' variable with wait_for_completion_timeout()

From: Jernej Škrabec
Date: Mon Apr 29 2024 - 11:33:03 EST


Dne ponedeljek, 29. april 2024 ob 13:28:39 GMT +2 je Wolfram Sang napisal(a):
> 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.
>
> Fix to the proper variable type 'unsigned long' while here.
>
> Signed-off-by: Wolfram Sang <wsa+renesas@xxxxxxxxxxxxxxxxxxxx>

Acked-by: Jernej Skrabec <jernej.skrabec@xxxxxxxxx>

Best regards,
Jernej

> ---
> drivers/spi/spi-sun4i.c | 9 +++++----
> 1 file changed, 5 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/spi/spi-sun4i.c b/drivers/spi/spi-sun4i.c
> index 11d8bd27b3e9..2ee6755b43f5 100644
> --- a/drivers/spi/spi-sun4i.c
> +++ b/drivers/spi/spi-sun4i.c
> @@ -206,7 +206,8 @@ static int sun4i_spi_transfer_one(struct spi_controller *host,
> struct spi_transfer *tfr)
> {
> struct sun4i_spi *sspi = spi_controller_get_devdata(host);
> - unsigned int mclk_rate, div, timeout;
> + unsigned int mclk_rate, div;
> + unsigned long time_left;
> unsigned int start, end, tx_time;
> unsigned int tx_len = 0;
> int ret = 0;
> @@ -327,10 +328,10 @@ static int sun4i_spi_transfer_one(struct spi_controller *host,
>
> tx_time = max(tfr->len * 8 * 2 / (tfr->speed_hz / 1000), 100U);
> start = jiffies;
> - timeout = wait_for_completion_timeout(&sspi->done,
> - msecs_to_jiffies(tx_time));
> + time_left = wait_for_completion_timeout(&sspi->done,
> + msecs_to_jiffies(tx_time));
> end = jiffies;
> - if (!timeout) {
> + if (!time_left) {
> dev_warn(&host->dev,
> "%s: timeout transferring %u bytes@%iHz for %i(%i)ms",
> dev_name(&spi->dev), tfr->len, tfr->speed_hz,
>