ASoC: codecs: wm8993: use 'time_left' variable with wait_for_completion_timeout()
authorWolfram Sang <wsa+renesas@sang-engineering.com>
Tue, 30 Apr 2024 11:54:35 +0000 (13:54 +0200)
committerMark Brown <broonie@kernel.org>
Mon, 6 May 2024 15:00:15 +0000 (00:00 +0900)
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@sang-engineering.com>
Link: https://lore.kernel.org/r/20240430115438.29134-3-wsa+renesas@sang-engineering.com
Reviewed-by: Charles Keepax <ckeepax@opensource.cirrus.com>
Signed-off-by: Mark Brown <broonie@kernel.org>
sound/soc/codecs/wm8993.c

index 98a83f51ab263956f046bd2165e314bfabf77004..f257980f9b56e290dacff3064b1495cc2a392911 100644 (file)
@@ -470,7 +470,7 @@ static int _wm8993_set_fll(struct snd_soc_component *component, int fll_id, int
        struct i2c_client *i2c = to_i2c_client(component->dev);
        u16 reg1, reg4, reg5;
        struct _fll_div fll_div;
-       unsigned int timeout;
+       unsigned long time_left;
        int ret;
 
        /* Any change? */
@@ -543,19 +543,19 @@ static int _wm8993_set_fll(struct snd_soc_component *component, int fll_id, int
 
        /* If we've got an interrupt wired up make sure we get it */
        if (i2c->irq)
-               timeout = msecs_to_jiffies(20);
+               time_left = msecs_to_jiffies(20);
        else if (Fref < 1000000)
-               timeout = msecs_to_jiffies(3);
+               time_left = msecs_to_jiffies(3);
        else
-               timeout = msecs_to_jiffies(1);
+               time_left = msecs_to_jiffies(1);
 
        try_wait_for_completion(&wm8993->fll_lock);
 
        /* Enable the FLL */
        snd_soc_component_write(component, WM8993_FLL_CONTROL_1, reg1 | WM8993_FLL_ENA);
 
-       timeout = wait_for_completion_timeout(&wm8993->fll_lock, timeout);
-       if (i2c->irq && !timeout)
+       time_left = wait_for_completion_timeout(&wm8993->fll_lock, time_left);
+       if (i2c->irq && !time_left)
                dev_warn(component->dev, "Timed out waiting for FLL\n");
 
        dev_dbg(component->dev, "FLL enabled at %dHz->%dHz\n", Fref, Fout);