| Message ID | 20240620115022.24409-2-wsa+renesas@sang-engineering.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | fpga: use 'time_left' instead of 'timeout' with wait_*() functions | expand |
On Thu, Jun 20, 2024 at 01:50:21PM +0200, Wolfram Sang wrote: Still for the shortlog, How about: Rename the 'timeout' variable as 'time_left' Thanks, Yilun > There is a confusing pattern in the kernel to use a variable named > 'timeout' to store the result of > wait_for_completion_interruptible_timeout() causing patterns like: > > timeout = wait_for_completion_interruptible_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 'long' while here. > > Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com> > --- > > Change since v1: > * use reverse-xmas-tree for variable init > * keep chars/line limits in commit message > > drivers/fpga/socfpga.c | 7 ++++--- > 1 file changed, 4 insertions(+), 3 deletions(-) > > diff --git a/drivers/fpga/socfpga.c b/drivers/fpga/socfpga.c > index 723ea0ad3f09..f772b754aa76 100644 > --- a/drivers/fpga/socfpga.c > +++ b/drivers/fpga/socfpga.c > @@ -301,16 +301,17 @@ static irqreturn_t socfpga_fpga_isr(int irq, void *dev_id) > > static int socfpga_fpga_wait_for_config_done(struct socfpga_fpga_priv *priv) > { > - int timeout, ret = 0; > + long time_left; > + int ret = 0; > > socfpga_fpga_disable_irqs(priv); > init_completion(&priv->status_complete); > socfpga_fpga_enable_irqs(priv, SOCFPGA_FPGMGR_MON_CONF_DONE); > > - timeout = wait_for_completion_interruptible_timeout( > + time_left = wait_for_completion_interruptible_timeout( > &priv->status_complete, > msecs_to_jiffies(10)); > - if (timeout == 0) > + if (time_left == 0) > ret = -ETIMEDOUT; > > socfpga_fpga_disable_irqs(priv); > -- > 2.43.0 > >
diff --git a/drivers/fpga/socfpga.c b/drivers/fpga/socfpga.c index 723ea0ad3f09..f772b754aa76 100644 --- a/drivers/fpga/socfpga.c +++ b/drivers/fpga/socfpga.c @@ -301,16 +301,17 @@ static irqreturn_t socfpga_fpga_isr(int irq, void *dev_id) static int socfpga_fpga_wait_for_config_done(struct socfpga_fpga_priv *priv) { - int timeout, ret = 0; + long time_left; + int ret = 0; socfpga_fpga_disable_irqs(priv); init_completion(&priv->status_complete); socfpga_fpga_enable_irqs(priv, SOCFPGA_FPGMGR_MON_CONF_DONE); - timeout = wait_for_completion_interruptible_timeout( + time_left = wait_for_completion_interruptible_timeout( &priv->status_complete, msecs_to_jiffies(10)); - if (timeout == 0) + if (time_left == 0) ret = -ETIMEDOUT; socfpga_fpga_disable_irqs(priv);
There is a confusing pattern in the kernel to use a variable named 'timeout' to store the result of wait_for_completion_interruptible_timeout() causing patterns like: timeout = wait_for_completion_interruptible_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 'long' while here. Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com> --- Change since v1: * use reverse-xmas-tree for variable init * keep chars/line limits in commit message drivers/fpga/socfpga.c | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-)