Skip to contentSkip to conversation

mailbox: sti: fix struct description warnings

PATCH In review Alain Volmat 2 participants 2 messages Aug 31, 2020 – Sep 8, 2020 Mailbox API

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 mailbox: sti: fix struct description warnings

Fix formating of struct description to avoid warning highlighted by W=1 compilation.

Fixes 9ef4546cbd7e ("mailbox: Add support for ST's Mailbox IP")
---
 drivers/mailbox/mailbox-sti.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
drivers/mailbox/mailbox-sti.c +3 -3
index 2baf69a0b81c..0f2bc09c364d 100644
@@ -36,7 +36,7 @@
 #define MBOX_BASE(mdev, inst)   ((mdev)->base + ((inst) * 4))
 
 /**
- * STi Mailbox device data
+ * struct sti_mbox_device - STi Mailbox device data
  *
  * An IP Mailbox is currently composed of 4 instances
  * Each instance is currently composed of 32 channels
@@ -60,7 +60,7 @@ struct sti_mbox_device {
 };
 
 /**
- * STi Mailbox platform specific configuration
+ * struct sti_mbox_pdata - STi Mailbox platform specific configuration
  *
  * @num_inst:	Maximum number of instances in one HW Mailbox
  * @num_chan:	Maximum number of channel per instance
@@ -71,7 +71,7 @@ struct sti_mbox_pdata {
 };
 
 /**
- * STi Mailbox allocated channel information
+ * struct sti_channel - STi Mailbox allocated channel information
  *
  * @mdev:	Pointer to parent Mailbox device
  * @instance:	Instance number channel resides in
Signature · 1 line
2.17.1
#1 lore raw
Quoted 4 lines · Alain Volmat

Fix formating of struct description to avoid warning highlighted by W=1 compilation.

Fixes 9ef4546cbd7e ("mailbox: Add support for ST's Mailbox IP")

Please remove this tag.

This patch is not a Stable candidate.

Quoted 36 lines
---
 drivers/mailbox/mailbox-sti.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
drivers/mailbox/mailbox-sti.c +3 -3
index 2baf69a0b81c..0f2bc09c364d 100644
@@ -36,7 +36,7 @@
 #define MBOX_BASE(mdev, inst)   ((mdev)->base + ((inst) * 4))
 
 /**
- * STi Mailbox device data
+ * struct sti_mbox_device - STi Mailbox device data
  *
  * An IP Mailbox is currently composed of 4 instances
  * Each instance is currently composed of 32 channels
@@ -60,7 +60,7 @@ struct sti_mbox_device {
 };
 
 /**
- * STi Mailbox platform specific configuration
+ * struct sti_mbox_pdata - STi Mailbox platform specific configuration
  *
  * @num_inst:	Maximum number of instances in one HW Mailbox
  * @num_chan:	Maximum number of channel per instance
@@ -71,7 +71,7 @@ struct sti_mbox_pdata {
 };
 
 /**
- * STi Mailbox allocated channel information
+ * struct sti_channel - STi Mailbox allocated channel information
  *
  * @mdev:	Pointer to parent Mailbox device
  * @instance:	Instance number channel resides in
Signature · 4 lines
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog