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

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: 9ef4546cbd7e ("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>

authored by

Randy Dunlap and committed by
Jassi Brar
23e6a7ca e22ce8eb

+8 -8
+8 -8
drivers/mailbox/mailbox-sti.c
··· 36 36 #define MBOX_BASE(mdev, inst) ((mdev)->base + ((inst) * 4)) 37 37 38 38 /** 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 45 40 * 46 41 * @dev: Device to which it is attached 47 42 * @mbox: Representation of a communication channel controller ··· 44 49 * @name: Name of the mailbox 45 50 * @enabled: Local copy of enabled channels 46 51 * @lock: Mutex protecting enabled status 52 + * 53 + * An IP Mailbox is currently composed of 4 instances 54 + * Each instance is currently composed of 32 channels 55 + * This means that we have 128 channels per Mailbox 56 + * A channel an be used for TX or RX 47 57 */ 48 58 struct sti_mbox_device { 49 59 struct device *dev; ··· 60 60 }; 61 61 62 62 /** 63 - * STi Mailbox platform specific configuration 63 + * struct sti_mbox_pdata - STi Mailbox platform specific configuration 64 64 * 65 65 * @num_inst: Maximum number of instances in one HW Mailbox 66 66 * @num_chan: Maximum number of channel per instance ··· 71 71 }; 72 72 73 73 /** 74 - * STi Mailbox allocated channel information 74 + * struct sti_channel - STi Mailbox allocated channel information 75 75 * 76 76 * @mdev: Pointer to parent Mailbox device 77 77 * @instance: Instance number channel resides in