Skip to content

Commit 23e6a7c

Browse files
rddunlapJassiBrar
authored andcommitted
mailbox: sti: quieten kernel-doc warnings
Use kernel-doc struct notation for the mailbox structs to prevent these kernel-doc warnings: drivers/mailbox/mailbox-sti.c:39: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * STi Mailbox device data drivers/mailbox/mailbox-sti.c:63: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * STi Mailbox platform specific configuration drivers/mailbox/mailbox-sti.c:74: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * STi Mailbox allocated channel information Also move the field descriptions ahead of the function description as is expected in kernel-doc. This prevents another kernel-doc warning. Fixes: 9ef4546 ("mailbox: Add support for ST's Mailbox IP") Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Reported-by: kernel test robot <lkp@intel.com> Cc: Aditya Srivastava <yashsri421@gmail.com> Cc: Lee Jones <lee.jones@linaro.org> Signed-off-by: Jassi Brar <jaswinder.singh@linaro.org>
1 parent e22ce8e commit 23e6a7c

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

drivers/mailbox/mailbox-sti.c

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,19 +36,19 @@
3636
#define MBOX_BASE(mdev, inst) ((mdev)->base + ((inst) * 4))
3737

3838
/**
39-
* STi Mailbox device data
40-
*
41-
* An IP Mailbox is currently composed of 4 instances
42-
* Each instance is currently composed of 32 channels
43-
* This means that we have 128 channels per Mailbox
44-
* A channel an be used for TX or RX
39+
* struct sti_mbox_device - STi Mailbox device data
4540
*
4641
* @dev: Device to which it is attached
4742
* @mbox: Representation of a communication channel controller
4843
* @base: Base address of the register mapping region
4944
* @name: Name of the mailbox
5045
* @enabled: Local copy of enabled channels
5146
* @lock: Mutex protecting enabled status
47+
*
48+
* An IP Mailbox is currently composed of 4 instances
49+
* Each instance is currently composed of 32 channels
50+
* This means that we have 128 channels per Mailbox
51+
* A channel an be used for TX or RX
5252
*/
5353
struct sti_mbox_device {
5454
struct device *dev;
@@ -60,7 +60,7 @@ struct sti_mbox_device {
6060
};
6161

6262
/**
63-
* STi Mailbox platform specific configuration
63+
* struct sti_mbox_pdata - STi Mailbox platform specific configuration
6464
*
6565
* @num_inst: Maximum number of instances in one HW Mailbox
6666
* @num_chan: Maximum number of channel per instance
@@ -71,7 +71,7 @@ struct sti_mbox_pdata {
7171
};
7272

7373
/**
74-
* STi Mailbox allocated channel information
74+
* struct sti_channel - STi Mailbox allocated channel information
7575
*
7676
* @mdev: Pointer to parent Mailbox device
7777
* @instance: Instance number channel resides in

0 commit comments

Comments
 (0)