Skip to content

Commit 79daec8

Browse files
rddunlapJassiBrar
authored andcommitted
mailbox: hi3660: convert struct comments to kernel-doc notation
Convert hi3660 struct comments to kernel-doc notation and fix other kernel-doc warnings: drivers/mailbox/hi3660-mailbox.c:47: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * Hi3660 mailbox channel information drivers/mailbox/hi3660-mailbox.c:62: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * Hi3660 mailbox controller data hi3660-mailbox.c:53: warning: contents before sections hi3660-mailbox.c:67: warning: contents before sections Fixes: 41c0e93 ("mailbox: Add support for Hi3660 mailbox") Signed-off-by: Randy Dunlap <[email protected]> Reported-by: kernel test robot <[email protected]> Cc: Ruyi Wang <[email protected]> Cc: Kaihua Zhong <[email protected]> Reviewed-by: Leo Yan <[email protected]> Signed-off-by: Jassi Brar <[email protected]>
1 parent 9388501 commit 79daec8

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

drivers/mailbox/hi3660-mailbox.c

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -44,31 +44,29 @@
4444
#define MBOX_MSG_LEN 8
4545

4646
/**
47-
* Hi3660 mailbox channel information
47+
* struct hi3660_chan_info - Hi3660 mailbox channel information
48+
* @dst_irq: Interrupt vector for remote processor
49+
* @ack_irq: Interrupt vector for local processor
4850
*
4951
* A channel can be used for TX or RX, it can trigger remote
5052
* processor interrupt to notify remote processor and can receive
51-
* interrupt if has incoming message.
52-
*
53-
* @dst_irq: Interrupt vector for remote processor
54-
* @ack_irq: Interrupt vector for local processor
53+
* interrupt if it has an incoming message.
5554
*/
5655
struct hi3660_chan_info {
5756
unsigned int dst_irq;
5857
unsigned int ack_irq;
5958
};
6059

6160
/**
62-
* Hi3660 mailbox controller data
63-
*
64-
* Mailbox controller includes 32 channels and can allocate
65-
* channel for message transferring.
66-
*
61+
* struct hi3660_mbox - Hi3660 mailbox controller data
6762
* @dev: Device to which it is attached
6863
* @base: Base address of the register mapping region
6964
* @chan: Representation of channels in mailbox controller
7065
* @mchan: Representation of channel info
7166
* @controller: Representation of a communication channel controller
67+
*
68+
* Mailbox controller includes 32 channels and can allocate
69+
* channel for message transferring.
7270
*/
7371
struct hi3660_mbox {
7472
struct device *dev;

0 commit comments

Comments
 (0)