* [PATCH v3 1/2] fpga: mgr: Rename 'timeout' variable as 'time_left'
@ 2024-07-29 10:42 Wolfram Sang
2024-07-29 10:42 ` [PATCH v3 2/2] fpga: zynq-fpga: " Wolfram Sang
2024-08-15 2:59 ` [PATCH v3 1/2] fpga: mgr: " Xu Yilun
0 siblings, 2 replies; 4+ messages in thread
From: Wolfram Sang @ 2024-07-29 10:42 UTC (permalink / raw)
To: linux-fpga; +Cc: Wolfram Sang, Moritz Fischer, Wu Hao, Xu Yilun, Tom Rix
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 v2: reworded shortlog
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..b08b4bb8f650 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;
+ int ret = 0;
+ long time_left;
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
^ permalink raw reply related [flat|nested] 4+ messages in thread* [PATCH v3 2/2] fpga: zynq-fpga: Rename 'timeout' variable as 'time_left'
2024-07-29 10:42 [PATCH v3 1/2] fpga: mgr: Rename 'timeout' variable as 'time_left' Wolfram Sang
@ 2024-07-29 10:42 ` Wolfram Sang
2024-07-29 10:47 ` Michal Simek
2024-08-15 2:59 ` [PATCH v3 1/2] fpga: mgr: " Xu Yilun
1 sibling, 1 reply; 4+ messages in thread
From: Wolfram Sang @ 2024-07-29 10:42 UTC (permalink / raw)
To: linux-fpga
Cc: Wolfram Sang, Moritz Fischer, Wu Hao, Xu Yilun, Tom Rix,
Michal Simek, linux-arm-kernel
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>
---
Change since v2: reworded shortlog
drivers/fpga/zynq-fpga.c | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/drivers/fpga/zynq-fpga.c b/drivers/fpga/zynq-fpga.c
index 0ac93183d201..4db3d80e10b0 100644
--- a/drivers/fpga/zynq-fpga.c
+++ b/drivers/fpga/zynq-fpga.c
@@ -387,7 +387,7 @@ static int zynq_fpga_ops_write(struct fpga_manager *mgr, struct sg_table *sgt)
const char *why;
int err;
u32 intr_status;
- unsigned long timeout;
+ unsigned long time_left;
unsigned long flags;
struct scatterlist *sg;
int i;
@@ -427,8 +427,8 @@ static int zynq_fpga_ops_write(struct fpga_manager *mgr, struct sg_table *sgt)
zynq_step_dma(priv);
spin_unlock_irqrestore(&priv->dma_lock, flags);
- timeout = wait_for_completion_timeout(&priv->dma_done,
- msecs_to_jiffies(DMA_TIMEOUT_MS));
+ time_left = wait_for_completion_timeout(&priv->dma_done,
+ msecs_to_jiffies(DMA_TIMEOUT_MS));
spin_lock_irqsave(&priv->dma_lock, flags);
zynq_fpga_set_irq(priv, 0);
@@ -452,7 +452,7 @@ static int zynq_fpga_ops_write(struct fpga_manager *mgr, struct sg_table *sgt)
if (priv->cur_sg ||
!((intr_status & IXR_D_P_DONE_MASK) == IXR_D_P_DONE_MASK)) {
- if (timeout == 0)
+ if (time_left == 0)
why = "DMA timed out";
else
why = "DMA did not complete";
--
2.43.0
^ permalink raw reply related [flat|nested] 4+ messages in thread* Re: [PATCH v3 2/2] fpga: zynq-fpga: Rename 'timeout' variable as 'time_left'
2024-07-29 10:42 ` [PATCH v3 2/2] fpga: zynq-fpga: " Wolfram Sang
@ 2024-07-29 10:47 ` Michal Simek
0 siblings, 0 replies; 4+ messages in thread
From: Michal Simek @ 2024-07-29 10:47 UTC (permalink / raw)
To: Wolfram Sang, linux-fpga
Cc: Moritz Fischer, Wu Hao, Xu Yilun, Tom Rix, linux-arm-kernel
On 7/29/24 12:42, 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>
> ---
>
> Change since v2: reworded shortlog
>
> drivers/fpga/zynq-fpga.c | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/fpga/zynq-fpga.c b/drivers/fpga/zynq-fpga.c
> index 0ac93183d201..4db3d80e10b0 100644
> --- a/drivers/fpga/zynq-fpga.c
> +++ b/drivers/fpga/zynq-fpga.c
> @@ -387,7 +387,7 @@ static int zynq_fpga_ops_write(struct fpga_manager *mgr, struct sg_table *sgt)
> const char *why;
> int err;
> u32 intr_status;
> - unsigned long timeout;
> + unsigned long time_left;
> unsigned long flags;
> struct scatterlist *sg;
> int i;
> @@ -427,8 +427,8 @@ static int zynq_fpga_ops_write(struct fpga_manager *mgr, struct sg_table *sgt)
> zynq_step_dma(priv);
> spin_unlock_irqrestore(&priv->dma_lock, flags);
>
> - timeout = wait_for_completion_timeout(&priv->dma_done,
> - msecs_to_jiffies(DMA_TIMEOUT_MS));
> + time_left = wait_for_completion_timeout(&priv->dma_done,
> + msecs_to_jiffies(DMA_TIMEOUT_MS));
>
> spin_lock_irqsave(&priv->dma_lock, flags);
> zynq_fpga_set_irq(priv, 0);
> @@ -452,7 +452,7 @@ static int zynq_fpga_ops_write(struct fpga_manager *mgr, struct sg_table *sgt)
>
> if (priv->cur_sg ||
> !((intr_status & IXR_D_P_DONE_MASK) == IXR_D_P_DONE_MASK)) {
> - if (timeout == 0)
> + if (time_left == 0)
> why = "DMA timed out";
> else
> why = "DMA did not complete";
Acked-by: Michal Simek <michal.simek@amd.com>
Thanks,
Michal
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH v3 1/2] fpga: mgr: Rename 'timeout' variable as 'time_left'
2024-07-29 10:42 [PATCH v3 1/2] fpga: mgr: Rename 'timeout' variable as 'time_left' Wolfram Sang
2024-07-29 10:42 ` [PATCH v3 2/2] fpga: zynq-fpga: " Wolfram Sang
@ 2024-08-15 2:59 ` Xu Yilun
1 sibling, 0 replies; 4+ messages in thread
From: Xu Yilun @ 2024-08-15 2:59 UTC (permalink / raw)
To: Wolfram Sang; +Cc: linux-fpga, Moritz Fischer, Wu Hao, Xu Yilun, Tom Rix
On Mon, Jul 29, 2024 at 12:42:22PM +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_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>
The prefix in shortlog "fpga: mgr: " is confusing, I changed it to "fpga:
socfpga: "
Others look good to me.
Acked-by: Xu Yilun <yilun.xu@intel.com>
Applied the series to for-next.
> ---
>
> Change since v2: reworded shortlog
>
> 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..b08b4bb8f650 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;
> + int ret = 0;
> + long time_left;
>
> 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
>
>
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2024-08-15 3:02 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-07-29 10:42 [PATCH v3 1/2] fpga: mgr: Rename 'timeout' variable as 'time_left' Wolfram Sang
2024-07-29 10:42 ` [PATCH v3 2/2] fpga: zynq-fpga: " Wolfram Sang
2024-07-29 10:47 ` Michal Simek
2024-08-15 2:59 ` [PATCH v3 1/2] fpga: mgr: " Xu Yilun
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).