| Message ID | 20240805215123.3528-2-wsa+renesas@sang-engineering.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | media: use 'time_left' instead of 'timeout' with wait_*() functions | expand |
On Mon, 05 Aug 2024 23:51:14 +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_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, also for the code path using 'tmo' as a variable. > > Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com> Reviewed-by: Michael Tretter <m.tretter@pengutronix.de> > --- > > Change since v1: > * fixed the 'tmo' variable as well > > .../media/platform/allegro-dvt/allegro-core.c | 24 +++++++++---------- > 1 file changed, 12 insertions(+), 12 deletions(-) > > diff --git a/drivers/media/platform/allegro-dvt/allegro-core.c b/drivers/media/platform/allegro-dvt/allegro-core.c > index da61f9beb6b4..0142ba175198 100644 > --- a/drivers/media/platform/allegro-dvt/allegro-core.c > +++ b/drivers/media/platform/allegro-dvt/allegro-core.c > @@ -1415,11 +1415,11 @@ static int allegro_mcu_send_encode_frame(struct allegro_dev *dev, > static int allegro_mcu_wait_for_init_timeout(struct allegro_dev *dev, > unsigned long timeout_ms) > { > - unsigned long tmo; > + unsigned long time_left; > > - tmo = wait_for_completion_timeout(&dev->init_complete, > - msecs_to_jiffies(timeout_ms)); > - if (tmo == 0) > + time_left = wait_for_completion_timeout(&dev->init_complete, > + msecs_to_jiffies(timeout_ms)); > + if (time_left == 0) > return -ETIMEDOUT; > > reinit_completion(&dev->init_complete); > @@ -2481,14 +2481,14 @@ static void allegro_mcu_interrupt(struct allegro_dev *dev) > static void allegro_destroy_channel(struct allegro_channel *channel) > { > struct allegro_dev *dev = channel->dev; > - unsigned long timeout; > + unsigned long time_left; > > if (channel_exists(channel)) { > reinit_completion(&channel->completion); > allegro_mcu_send_destroy_channel(dev, channel); > - timeout = wait_for_completion_timeout(&channel->completion, > - msecs_to_jiffies(5000)); > - if (timeout == 0) > + time_left = wait_for_completion_timeout(&channel->completion, > + msecs_to_jiffies(5000)); > + if (time_left == 0) > v4l2_warn(&dev->v4l2_dev, > "channel %d: timeout while destroying\n", > channel->mcu_channel_id); > @@ -2544,7 +2544,7 @@ static void allegro_destroy_channel(struct allegro_channel *channel) > static int allegro_create_channel(struct allegro_channel *channel) > { > struct allegro_dev *dev = channel->dev; > - unsigned long timeout; > + unsigned long time_left; > > if (channel_exists(channel)) { > v4l2_warn(&dev->v4l2_dev, > @@ -2595,9 +2595,9 @@ static int allegro_create_channel(struct allegro_channel *channel) > > reinit_completion(&channel->completion); > allegro_mcu_send_create_channel(dev, channel); > - timeout = wait_for_completion_timeout(&channel->completion, > - msecs_to_jiffies(5000)); > - if (timeout == 0) > + time_left = wait_for_completion_timeout(&channel->completion, > + msecs_to_jiffies(5000)); > + if (time_left == 0) > channel->error = -ETIMEDOUT; > if (channel->error) > goto err; > -- > 2.43.0 > >
diff --git a/drivers/media/platform/allegro-dvt/allegro-core.c b/drivers/media/platform/allegro-dvt/allegro-core.c index da61f9beb6b4..0142ba175198 100644 --- a/drivers/media/platform/allegro-dvt/allegro-core.c +++ b/drivers/media/platform/allegro-dvt/allegro-core.c @@ -1415,11 +1415,11 @@ static int allegro_mcu_send_encode_frame(struct allegro_dev *dev, static int allegro_mcu_wait_for_init_timeout(struct allegro_dev *dev, unsigned long timeout_ms) { - unsigned long tmo; + unsigned long time_left; - tmo = wait_for_completion_timeout(&dev->init_complete, - msecs_to_jiffies(timeout_ms)); - if (tmo == 0) + time_left = wait_for_completion_timeout(&dev->init_complete, + msecs_to_jiffies(timeout_ms)); + if (time_left == 0) return -ETIMEDOUT; reinit_completion(&dev->init_complete); @@ -2481,14 +2481,14 @@ static void allegro_mcu_interrupt(struct allegro_dev *dev) static void allegro_destroy_channel(struct allegro_channel *channel) { struct allegro_dev *dev = channel->dev; - unsigned long timeout; + unsigned long time_left; if (channel_exists(channel)) { reinit_completion(&channel->completion); allegro_mcu_send_destroy_channel(dev, channel); - timeout = wait_for_completion_timeout(&channel->completion, - msecs_to_jiffies(5000)); - if (timeout == 0) + time_left = wait_for_completion_timeout(&channel->completion, + msecs_to_jiffies(5000)); + if (time_left == 0) v4l2_warn(&dev->v4l2_dev, "channel %d: timeout while destroying\n", channel->mcu_channel_id); @@ -2544,7 +2544,7 @@ static void allegro_destroy_channel(struct allegro_channel *channel) static int allegro_create_channel(struct allegro_channel *channel) { struct allegro_dev *dev = channel->dev; - unsigned long timeout; + unsigned long time_left; if (channel_exists(channel)) { v4l2_warn(&dev->v4l2_dev, @@ -2595,9 +2595,9 @@ static int allegro_create_channel(struct allegro_channel *channel) reinit_completion(&channel->completion); allegro_mcu_send_create_channel(dev, channel); - timeout = wait_for_completion_timeout(&channel->completion, - msecs_to_jiffies(5000)); - if (timeout == 0) + time_left = wait_for_completion_timeout(&channel->completion, + msecs_to_jiffies(5000)); + if (time_left == 0) channel->error = -ETIMEDOUT; if (channel->error) goto err;
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, also for the code path using 'tmo' as a variable. Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com> --- Change since v1: * fixed the 'tmo' variable as well .../media/platform/allegro-dvt/allegro-core.c | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-)