Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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: 41c0e939d70d ("mailbox: Add support for Hi3660 mailbox")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reported-by: kernel test robot <lkp@intel.com>
Cc: Ruyi Wang <wangruyi@huawei.com>
Cc: Kaihua Zhong <zhongkaihua@huawei.com>
Reviewed-by: Leo Yan <leo.yan@linaro.org>
Signed-off-by: Jassi Brar <jaswinder.singh@linaro.org>

authored by

Randy Dunlap and committed by
Jassi Brar
79daec8b 9388501f

+8 -10
+8 -10
drivers/mailbox/hi3660-mailbox.c
··· 44 44 #define MBOX_MSG_LEN 8 45 45 46 46 /** 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 48 50 * 49 51 * A channel can be used for TX or RX, it can trigger remote 50 52 * 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. 55 54 */ 56 55 struct hi3660_chan_info { 57 56 unsigned int dst_irq; ··· 58 59 }; 59 60 60 61 /** 61 - * Hi3660 mailbox controller data 62 - * 63 - * Mailbox controller includes 32 channels and can allocate 64 - * channel for message transferring. 65 - * 62 + * struct hi3660_mbox - Hi3660 mailbox controller data 66 63 * @dev: Device to which it is attached 67 64 * @base: Base address of the register mapping region 68 65 * @chan: Representation of channels in mailbox controller 69 66 * @mchan: Representation of channel info 70 67 * @controller: Representation of a communication channel controller 68 + * 69 + * Mailbox controller includes 32 channels and can allocate 70 + * channel for message transferring. 71 71 */ 72 72 struct hi3660_mbox { 73 73 struct device *dev;