[PATCH v2 0/8] media: use 'time_left' instead of 'timeout' with wait_*() functions

[PATCH v2 0/8] media: use 'time_left' instead of 'timeout' with wait_*() functions

[Wolfram Sang]

Changes since v1:
* fixed another occasion in the allegro driver (Thanks, Michael)
* added tags (Thanks Ismael and Thierry)
* rebased to 6.11-rc1

There is a confusing pattern in the kernel to use a variable named 'timeout' to
store the result of wait_*() functions 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
obvious and self explaining. Also correct the type of the variable if
the original code got it wrong.

This is part of a tree-wide series. The rest of the patches can be found here:

git://git.kernel.org/pub/scm/linux/kernel/git/wsa/linux.git i2c/time_left

Because these patches are generated, I audit them before sending. This is why I
will send series step by step. Build bot is happy with these patches, though.
No functional changes intended.


Wolfram Sang (8):
  media: allegro: use 'time_left' variable with
    wait_for_completion_timeout()
  media: atmel-isi: use 'time_left' variable with
    wait_for_completion_timeout()
  media: bdisp: use 'time_left' variable with wait_event_timeout()
  media: fimc-is: use 'time_left' variable with wait_event_timeout()
  media: platform: exynos-gsc: use 'time_left' variable with
    wait_event_timeout()
  media: solo6x10: use 'time_left' variable with
    wait_for_completion_timeout()
  media: tegra-vde: use 'time_left' variable with
    wait_for_completion_interruptible_timeout()
  media: ti: cal: use 'time_left' variable with wait_event_timeout()

 drivers/media/pci/solo6x10/solo6x10-p2m.c     |  8 +++----
 .../media/platform/allegro-dvt/allegro-core.c | 24 +++++++++----------
 drivers/media/platform/atmel/atmel-isi.c      |  8 +++----
 .../media/platform/nvidia/tegra-vde/h264.c    | 10 ++++----
 .../platform/samsung/exynos-gsc/gsc-core.c    | 10 ++++----
 .../platform/samsung/exynos4-is/fimc-core.c   | 10 ++++----
 .../media/platform/st/sti/bdisp/bdisp-v4l2.c  | 10 ++++----
 drivers/media/platform/ti/cal/cal.c           |  8 +++----
 8 files changed, 44 insertions(+), 44 deletions(-)

-- 
2.43.0

[PATCH v2 2/8] media: atmel-isi: use 'time_left' variable with wait_for_completion_timeout()

[Wolfram Sang]

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>
---
 drivers/media/platform/atmel/atmel-isi.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/drivers/media/platform/atmel/atmel-isi.c b/drivers/media/platform/atmel/atmel-isi.c
index c1108df72dd5..5c823d3f9cc0 100644
--- a/drivers/media/platform/atmel/atmel-isi.c
+++ b/drivers/media/platform/atmel/atmel-isi.c
@@ -242,7 +242,7 @@ static irqreturn_t isi_interrupt(int irq, void *dev_id)
 #define	WAIT_ISI_DISABLE	0
 static int atmel_isi_wait_status(struct atmel_isi *isi, int wait_reset)
 {
-	unsigned long timeout;
+	unsigned long time_left;
 	/*
 	 * The reset or disable will only succeed if we have a
 	 * pixel clock from the camera.
@@ -257,9 +257,9 @@ static int atmel_isi_wait_status(struct atmel_isi *isi, int wait_reset)
 		isi_writel(isi, ISI_CTRL, ISI_CTRL_DIS);
 	}
 
-	timeout = wait_for_completion_timeout(&isi->complete,
-			msecs_to_jiffies(500));
-	if (timeout == 0)
+	time_left = wait_for_completion_timeout(&isi->complete,
+						msecs_to_jiffies(500));
+	if (time_left == 0)
 		return -ETIMEDOUT;
 
 	return 0;
-- 
2.43.0

[PATCH v2 4/8] media: fimc-is: use 'time_left' variable with wait_event_timeout()

[Wolfram Sang]

There is a confusing pattern in the kernel to use a variable named
'timeout' to store the result of wait_event_timeout() causing
patterns like:

        timeout = wait_event_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>
---
 drivers/media/platform/samsung/exynos4-is/fimc-core.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/drivers/media/platform/samsung/exynos4-is/fimc-core.c b/drivers/media/platform/samsung/exynos4-is/fimc-core.c
index aae74b501a42..adfc2d73d04b 100644
--- a/drivers/media/platform/samsung/exynos4-is/fimc-core.c
+++ b/drivers/media/platform/samsung/exynos4-is/fimc-core.c
@@ -822,7 +822,7 @@ static int fimc_clk_get(struct fimc_dev *fimc)
 static int fimc_m2m_suspend(struct fimc_dev *fimc)
 {
 	unsigned long flags;
-	int timeout;
+	long time_left;
 
 	spin_lock_irqsave(&fimc->slock, flags);
 	if (!fimc_m2m_pending(fimc)) {
@@ -833,12 +833,12 @@ static int fimc_m2m_suspend(struct fimc_dev *fimc)
 	set_bit(ST_M2M_SUSPENDING, &fimc->state);
 	spin_unlock_irqrestore(&fimc->slock, flags);
 
-	timeout = wait_event_timeout(fimc->irq_queue,
-			     test_bit(ST_M2M_SUSPENDED, &fimc->state),
-			     FIMC_SHUTDOWN_TIMEOUT);
+	time_left = wait_event_timeout(fimc->irq_queue,
+				       test_bit(ST_M2M_SUSPENDED, &fimc->state),
+				       FIMC_SHUTDOWN_TIMEOUT);
 
 	clear_bit(ST_M2M_SUSPENDING, &fimc->state);
-	return timeout == 0 ? -EAGAIN : 0;
+	return time_left == 0 ? -EAGAIN : 0;
 }
 
 static int fimc_m2m_resume(struct fimc_dev *fimc)
-- 
2.43.0

[PATCH v2 5/8] media: platform: exynos-gsc: use 'time_left' variable with wait_event_timeout()

[Wolfram Sang]

There is a confusing pattern in the kernel to use a variable named
'timeout' to store the result of wait_event_timeout() causing
patterns like:

        timeout = wait_event_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>
---
 drivers/media/platform/samsung/exynos-gsc/gsc-core.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/drivers/media/platform/samsung/exynos-gsc/gsc-core.c b/drivers/media/platform/samsung/exynos-gsc/gsc-core.c
index 618ae55fe396..f45f5c8612a6 100644
--- a/drivers/media/platform/samsung/exynos-gsc/gsc-core.c
+++ b/drivers/media/platform/samsung/exynos-gsc/gsc-core.c
@@ -1225,7 +1225,7 @@ static void gsc_remove(struct platform_device *pdev)
 static int gsc_m2m_suspend(struct gsc_dev *gsc)
 {
 	unsigned long flags;
-	int timeout;
+	long time_left;
 
 	spin_lock_irqsave(&gsc->slock, flags);
 	if (!gsc_m2m_pending(gsc)) {
@@ -1236,12 +1236,12 @@ static int gsc_m2m_suspend(struct gsc_dev *gsc)
 	set_bit(ST_M2M_SUSPENDING, &gsc->state);
 	spin_unlock_irqrestore(&gsc->slock, flags);
 
-	timeout = wait_event_timeout(gsc->irq_queue,
-			     test_bit(ST_M2M_SUSPENDED, &gsc->state),
-			     GSC_SHUTDOWN_TIMEOUT);
+	time_left = wait_event_timeout(gsc->irq_queue,
+				       test_bit(ST_M2M_SUSPENDED, &gsc->state),
+				       GSC_SHUTDOWN_TIMEOUT);
 
 	clear_bit(ST_M2M_SUSPENDING, &gsc->state);
-	return timeout == 0 ? -EAGAIN : 0;
+	return time_left == 0 ? -EAGAIN : 0;
 }
 
 static void gsc_m2m_resume(struct gsc_dev *gsc)
-- 
2.43.0

Re: [PATCH v2 0/8] media: use 'time_left' instead of 'timeout' with wait_*() functions

[Hans Verkuil]

Hi Wolfram,

On 05/08/2024 23:51, Wolfram Sang wrote:
> Changes since v1:
> * fixed another occasion in the allegro driver (Thanks, Michael)
> * added tags (Thanks Ismael and Thierry)
> * rebased to 6.11-rc1

Can you resend this series? This patch series wasn't picked up by our patchwork,
probably due to a full filesystem.

Apologies for the inconvenience.

Regards,

	Hans

> 
> There is a confusing pattern in the kernel to use a variable named 'timeout' to
> store the result of wait_*() functions 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
> obvious and self explaining. Also correct the type of the variable if
> the original code got it wrong.
> 
> This is part of a tree-wide series. The rest of the patches can be found here:
> 
> git://git.kernel.org/pub/scm/linux/kernel/git/wsa/linux.git i2c/time_left
> 
> Because these patches are generated, I audit them before sending. This is why I
> will send series step by step. Build bot is happy with these patches, though.
> No functional changes intended.
> 
> 
> Wolfram Sang (8):
>   media: allegro: use 'time_left' variable with
>     wait_for_completion_timeout()
>   media: atmel-isi: use 'time_left' variable with
>     wait_for_completion_timeout()
>   media: bdisp: use 'time_left' variable with wait_event_timeout()
>   media: fimc-is: use 'time_left' variable with wait_event_timeout()
>   media: platform: exynos-gsc: use 'time_left' variable with
>     wait_event_timeout()
>   media: solo6x10: use 'time_left' variable with
>     wait_for_completion_timeout()
>   media: tegra-vde: use 'time_left' variable with
>     wait_for_completion_interruptible_timeout()
>   media: ti: cal: use 'time_left' variable with wait_event_timeout()
> 
>  drivers/media/pci/solo6x10/solo6x10-p2m.c     |  8 +++----
>  .../media/platform/allegro-dvt/allegro-core.c | 24 +++++++++----------
>  drivers/media/platform/atmel/atmel-isi.c      |  8 +++----
>  .../media/platform/nvidia/tegra-vde/h264.c    | 10 ++++----
>  .../platform/samsung/exynos-gsc/gsc-core.c    | 10 ++++----
>  .../platform/samsung/exynos4-is/fimc-core.c   | 10 ++++----
>  .../media/platform/st/sti/bdisp/bdisp-v4l2.c  | 10 ++++----
>  drivers/media/platform/ti/cal/cal.c           |  8 +++----
>  8 files changed, 44 insertions(+), 44 deletions(-)
> 

Re: [PATCH v2 0/8] media: use 'time_left' instead of 'timeout' with wait_*() functions

[Hans Verkuil]

On 07/08/2024 15:08, Hans Verkuil wrote:
> Hi Wolfram,
> 
> On 05/08/2024 23:51, Wolfram Sang wrote:
>> Changes since v1:
>> * fixed another occasion in the allegro driver (Thanks, Michael)
>> * added tags (Thanks Ismael and Thierry)
>> * rebased to 6.11-rc1
> 
> Can you resend this series? This patch series wasn't picked up by our patchwork,
> probably due to a full filesystem.

Actually, it's better to wait a bit: I now see that patchwork hasn't accepted new
patches since August 5th, so until that is fixed, there is no point in resending...

I'll let you know when it is OK again.

> Apologies for the inconvenience.

Even more apologies,

	Hans

> 
> Regards,
> 
> 	Hans
> 
>>
>> There is a confusing pattern in the kernel to use a variable named 'timeout' to
>> store the result of wait_*() functions 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
>> obvious and self explaining. Also correct the type of the variable if
>> the original code got it wrong.
>>
>> This is part of a tree-wide series. The rest of the patches can be found here:
>>
>> git://git.kernel.org/pub/scm/linux/kernel/git/wsa/linux.git i2c/time_left
>>
>> Because these patches are generated, I audit them before sending. This is why I
>> will send series step by step. Build bot is happy with these patches, though.
>> No functional changes intended.
>>
>>
>> Wolfram Sang (8):
>>   media: allegro: use 'time_left' variable with
>>     wait_for_completion_timeout()
>>   media: atmel-isi: use 'time_left' variable with
>>     wait_for_completion_timeout()
>>   media: bdisp: use 'time_left' variable with wait_event_timeout()
>>   media: fimc-is: use 'time_left' variable with wait_event_timeout()
>>   media: platform: exynos-gsc: use 'time_left' variable with
>>     wait_event_timeout()
>>   media: solo6x10: use 'time_left' variable with
>>     wait_for_completion_timeout()
>>   media: tegra-vde: use 'time_left' variable with
>>     wait_for_completion_interruptible_timeout()
>>   media: ti: cal: use 'time_left' variable with wait_event_timeout()
>>
>>  drivers/media/pci/solo6x10/solo6x10-p2m.c     |  8 +++----
>>  .../media/platform/allegro-dvt/allegro-core.c | 24 +++++++++----------
>>  drivers/media/platform/atmel/atmel-isi.c      |  8 +++----
>>  .../media/platform/nvidia/tegra-vde/h264.c    | 10 ++++----
>>  .../platform/samsung/exynos-gsc/gsc-core.c    | 10 ++++----
>>  .../platform/samsung/exynos4-is/fimc-core.c   | 10 ++++----
>>  .../media/platform/st/sti/bdisp/bdisp-v4l2.c  | 10 ++++----
>>  drivers/media/platform/ti/cal/cal.c           |  8 +++----
>>  8 files changed, 44 insertions(+), 44 deletions(-)
>>
> 
> 

Re: [PATCH v2 0/8] media: use 'time_left' instead of 'timeout' with wait_*() functions

[Wolfram Sang]

[-- Attachment #1: Type: text/plain, Size: 527 bytes --]

Hi Hans,

thanks for the fast reply!

> > Can you resend this series? This patch series wasn't picked up by our patchwork,
> > probably due to a full filesystem.

You use the kernel.org one, or? There was an update including a small
downtime but no mail got lost. patchwork only needs to catch up.

> I'll let you know when it is OK again.

Seems to be good now?

https://patchwork.kernel.org/project/linux-media/list/?series=876862

> > Apologies for the inconvenience.

No worries, things happen!

All the best,

   Wolfram


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH v2 0/8] media: use 'time_left' instead of 'timeout' with wait_*() functions

[Hans Verkuil]

On 07/08/2024 16:26, Wolfram Sang wrote:
> Hi Hans,
> 
> thanks for the fast reply!
> 
>>> Can you resend this series? This patch series wasn't picked up by our patchwork,
>>> probably due to a full filesystem.
> 
> You use the kernel.org one, or? There was an update including a small
> downtime but no mail got lost. patchwork only needs to catch up.

No, we use https://patchwork.linuxtv.org/project/linux-media/list/

The server was rebooted and now emails are trickling in again.

I'm optimistic that nothing was lost, but I'll let you know if your
series disappeared after all.

Regards,

	Hans

> 
>> I'll let you know when it is OK again.
> 
> Seems to be good now?
> 
> https://patchwork.kernel.org/project/linux-media/list/?series=876862
> 
>>> Apologies for the inconvenience.
> 
> No worries, things happen!
> 
> All the best,
> 
>    Wolfram
>