2021-12-22 09:36:34

by Paulo Miguel Almeida

Subject: [PATCH] staging: pi433: add comment to rx_lock mutex definition

Checkpatch reports: CHECK: struct mutex definition without comment.
Fix this by documenting what rx_mutex struct is used for in pi433 driver.

Signed-off-by: Paulo Miguel Almeida <[email protected]>
---
drivers/staging/pi433/pi433_if.c | 1 +
1 file changed, 1 insertion(+)

diff --git a/drivers/staging/pi433/pi433_if.c b/drivers/staging/pi433/pi433_if.c
index 29bd37669059..aa0ecb3788c6 100644
--- a/drivers/staging/pi433/pi433_if.c
+++ b/drivers/staging/pi433/pi433_if.c
@@ -92,6 +92,7 @@ struct pi433_device {
u32 rx_bytes_to_drop;
u32 rx_bytes_dropped;
unsigned int rx_position;
+ /* rx read and config operations can only be served one at the time */
struct mutex rx_lock;
wait_queue_head_t rx_wait_queue;

--
2.25.4

2021-12-22 09:41:39

by Greg Kroah-Hartman

Subject: Re: [PATCH] staging: pi433: add comment to rx_lock mutex definition

On Wed, Dec 22, 2021 at 10:36:26PM +1300, Paulo Miguel Almeida wrote:
> Checkpatch reports: CHECK: struct mutex definition without comment.
> Fix this by documenting what rx_mutex struct is used for in pi433 driver.
>
> Signed-off-by: Paulo Miguel Almeida <[email protected]>
> ---
> drivers/staging/pi433/pi433_if.c | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/drivers/staging/pi433/pi433_if.c b/drivers/staging/pi433/pi433_if.c
> index 29bd37669059..aa0ecb3788c6 100644
> --- a/drivers/staging/pi433/pi433_if.c
> +++ b/drivers/staging/pi433/pi433_if.c
> @@ -92,6 +92,7 @@ struct pi433_device {
> u32 rx_bytes_to_drop;
> u32 rx_bytes_dropped;
> unsigned int rx_position;
> + /* rx read and config operations can only be served one at the time */

What exactly does this mean? What is this protecting? This comment
doesn't seem to be explaining much :(

thanks,

greg k-h