2024-06-03 09:30:38

by Wolfram Sang

Subject: [PATCH 6/8] media: solo6x10: use 'time_left' variable with wait_for_completion_timeout()

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 <[email protected]>
---
drivers/media/pci/solo6x10/solo6x10-p2m.c | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/drivers/media/pci/solo6x10/solo6x10-p2m.c b/drivers/media/pci/solo6x10/solo6x10-p2m.c
index ca70a864a3ef..5f100e5e03d9 100644
--- a/drivers/media/pci/solo6x10/solo6x10-p2m.c
+++ b/drivers/media/pci/solo6x10/solo6x10-p2m.c
@@ -57,7 +57,7 @@ int solo_p2m_dma_desc(struct solo_dev *solo_dev,
int desc_cnt)
{
struct solo_p2m_dev *p2m_dev;
- unsigned int timeout;
+ unsigned long time_left;
unsigned int config = 0;
int ret = 0;
unsigned int p2m_id = 0;
@@ -99,12 +99,12 @@ int solo_p2m_dma_desc(struct solo_dev *solo_dev,
desc[1].ctrl);
}

- timeout = wait_for_completion_timeout(&p2m_dev->completion,
- solo_dev->p2m_jiffies);
+ time_left = wait_for_completion_timeout(&p2m_dev->completion,
+ solo_dev->p2m_jiffies);

if (WARN_ON_ONCE(p2m_dev->error))
ret = -EIO;
- else if (timeout == 0) {
+ else if (time_left == 0) {
solo_dev->p2m_timeouts++;
ret = -EAGAIN;
}
--
2.43.0

2024-06-03 16:29:47

by Ismael Luceno

Subject: Re: [PATCH 6/8] media: solo6x10: use 'time_left' variable with wait_for_completion_timeout()

On 03/Jun/2024 18:25, Ismael Luceno wrote:
> On 03/Jun/2024 11:28, 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.
> >
> > Fix to the proper variable type 'unsigned long' while here.
> >
> > Signed-off-by: Wolfram Sang <[email protected]>
> > ---
> > drivers/media/pci/solo6x10/solo6x10-p2m.c | 8 ++++----
> > 1 file changed, 4 insertions(+), 4 deletions(-)
> >
> > diff --git a/drivers/media/pci/solo6x10/solo6x10-p2m.c b/drivers/media/pci/solo6x10/solo6x10-p2m.c
> > index ca70a864a3ef..5f100e5e03d9 100644
> > --- a/drivers/media/pci/solo6x10/solo6x10-p2m.c
> > +++ b/drivers/media/pci/solo6x10/solo6x10-p2m.c
> > @@ -57,7 +57,7 @@ int solo_p2m_dma_desc(struct solo_dev *solo_dev,
> > int desc_cnt)
> > {
> > struct solo_p2m_dev *p2m_dev;
> > - unsigned int timeout;
> > + unsigned long time_left;
> > unsigned int config = 0;
> > int ret = 0;
> > unsigned int p2m_id = 0;
> > @@ -99,12 +99,12 @@ int solo_p2m_dma_desc(struct solo_dev *solo_dev,
> > desc[1].ctrl);
> > }
> >
> > - timeout = wait_for_completion_timeout(&p2m_dev->completion,
> > - solo_dev->p2m_jiffies);
> > + time_left = wait_for_completion_timeout(&p2m_dev->completion,
> > + solo_dev->p2m_jiffies);
> >
> > if (WARN_ON_ONCE(p2m_dev->error))
> > ret = -EIO;
> > - else if (timeout == 0) {
> > + else if (time_left == 0) {
> > solo_dev->p2m_timeouts++;
> > ret = -EAGAIN;
> > }
>
> Signed-off-by: Ismael Luceno <[email protected]>

Sorry, I meant Acked-by.

2024-06-03 16:32:18

by Ismael Luceno

Subject: Re: [PATCH 6/8] media: solo6x10: use 'time_left' variable with wait_for_completion_timeout()

On 03/Jun/2024 11:28, 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.
>
> Fix to the proper variable type 'unsigned long' while here.
>
> Signed-off-by: Wolfram Sang <[email protected]>
> ---
> drivers/media/pci/solo6x10/solo6x10-p2m.c | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/media/pci/solo6x10/solo6x10-p2m.c b/drivers/media/pci/solo6x10/solo6x10-p2m.c
> index ca70a864a3ef..5f100e5e03d9 100644
> --- a/drivers/media/pci/solo6x10/solo6x10-p2m.c
> +++ b/drivers/media/pci/solo6x10/solo6x10-p2m.c
> @@ -57,7 +57,7 @@ int solo_p2m_dma_desc(struct solo_dev *solo_dev,
> int desc_cnt)
> {
> struct solo_p2m_dev *p2m_dev;
> - unsigned int timeout;
> + unsigned long time_left;
> unsigned int config = 0;
> int ret = 0;
> unsigned int p2m_id = 0;
> @@ -99,12 +99,12 @@ int solo_p2m_dma_desc(struct solo_dev *solo_dev,
> desc[1].ctrl);
> }
>
> - timeout = wait_for_completion_timeout(&p2m_dev->completion,
> - solo_dev->p2m_jiffies);
> + time_left = wait_for_completion_timeout(&p2m_dev->completion,
> + solo_dev->p2m_jiffies);
>
> if (WARN_ON_ONCE(p2m_dev->error))
> ret = -EIO;
> - else if (timeout == 0) {
> + else if (time_left == 0) {
> solo_dev->p2m_timeouts++;
> ret = -EAGAIN;
> }

Signed-off-by: Ismael Luceno <[email protected]>