Commit 23e6a7ca authored by Randy Dunlap's avatar Randy Dunlap Committed by Jassi Brar
Browse files

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: 9ef4546c ("mailbox: Add support for ST's Mailbox IP")
Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Reported-by: default avatarkernel test robot <lkp@intel.com>
Cc: Aditya Srivastava <yashsri421@gmail.com>
Cc: Lee Jones <lee.jones@linaro.org>
Signed-off-by: default avatarJassi Brar <jaswinder.singh@linaro.org>
parent e22ce8eb

drivers/mailbox/mailbox-sti.c

+8 −8
Original line number Original line Diff line number Diff line
@@ -36,12 +36,7 @@ 
#define MBOX_BASE(mdev, inst)   ((mdev)->base + ((inst) * 4))

#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

 * This means that we have 128 channels per Mailbox

 * A channel an be used for TX or RX

 *

 *

 * @dev:	Device to which it is attached

 * @dev:	Device to which it is attached

 * @mbox:	Representation of a communication channel controller

 * @mbox:	Representation of a communication channel controller
@@ -49,6 +44,11 @@ 
 * @name:	Name of the mailbox

 * @name:	Name of the mailbox

 * @enabled:	Local copy of enabled channels

 * @enabled:	Local copy of enabled channels

 * @lock:	Mutex protecting enabled status

 * @lock:	Mutex protecting enabled status

 *

 * An IP Mailbox is currently composed of 4 instances

 * Each instance is currently composed of 32 channels

 * This means that we have 128 channels per Mailbox

 * A channel an be used for TX or RX

 */

 */

struct sti_mbox_device {

struct sti_mbox_device {

	struct device		*dev;

	struct device		*dev;
@@ -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_inst:	Maximum number of instances in one HW Mailbox

 * @num_chan:	Maximum number of channel per instance

 * @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

 * @mdev:	Pointer to parent Mailbox device

 * @instance:	Instance number channel resides in

 * @instance:	Instance number channel resides in