Skip to contentSkip to conversation

staging: pi433: add comment to rx_lock mutex definition

PATCH Superseded Paulo Miguel Almeida 2 participants 2 messages Dec 22, 2021 Staging

v1 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 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.

---
 drivers/staging/pi433/pi433_if.c | 1 +
 1 file changed, 1 insertion(+)
drivers/staging/pi433/pi433_if.c +1 -0
index 29bd37669059..aa0ecb3788c6 100644
@@ -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;
 
Signature · 1 line
2.25.4
maintainer
#1 lore raw
Quoted 13 lines · Paulo Miguel Almeida

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

---
 drivers/staging/pi433/pi433_if.c | 1 +
 1 file changed, 1 insertion(+)
drivers/staging/pi433/pi433_if.c +0 -0
index 29bd37669059..aa0ecb3788c6 100644

drivers/staging/pi433/pi433_if.c struct pi433_device { · line 95

Quoted 4 lines
drivers/staging/pi433/pi433_if.c +1 -0
@@ -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