u5500 : kernel-doc for Mailbox Logical Driver

Kernle-Doc created for u5500 Mailbox Logical Driver

ST-Ericsson ID: 277198

Change-Id: I6e1298615a3943177fa05342a9ff8215e521fa72
Signed-off-by: Bibek Basu <bibek.basu@stericsson.com>
Reviewed-on: http://gerrit.lud.stericsson.com/gerrit/23718
Reviewed-by: QATEST
Reviewed-by: Srinidhi KASAGAR <srinidhi.kasagar@stericsson.com>

1 files changed, 37 insertions, 36 deletions

diff --git a/arch/arm/mach-ux500/include/mach/mbox_channels-db5500.h b/arch/arm/mach-ux500/include/mach/mbox_channels-db5500.h
index 829b1708bf1..0b2fc604873 100644
--- a/arch/arm/mach-ux500/include/mach/mbox_channels-db5500.h
+++ b/arch/arm/mach-ux500/include/mach/mbox_channels-db5500.h
@@ -12,27 +12,27 @@
 #define MAILBOX_NR_OF_DATAWORDS	3
 
 /**
-  * mbox_channel_cb_t - Definition of the mailbox channel callback.
-  * @data:	Pointer to the data.
-  * @length:	Length of the data.
-  * @priv:	The client's private data.
-  *
-  * This function will be called upon reception of complete mbox channel PDU
-  * or after completion of send operation.
-  */
+ * mbox_channel_cb_t - Definition of the mailbox channel callback.
+ * @data:	Pointer to the data.
+ * @length:	Length of the data.
+ * @priv:	The client's private data.
+ *
+ * This function will be called upon reception of complete mbox channel PDU
+ * or after completion of send operation.
+ */
 typedef void mbox_channel_cb_t (u32 *data, u32 length, void *priv);
 
 /**
-  * mbox_channel_msg - Definition of mbox channel message
-  * @channel:	Channel number.
-  * @data:	Pointer to data to be sent.
-  * @length:	Length of data to be sent.
-  * @cb:	Pointer to the callback function to be called when send
-  *		operation will be finished.
-  * @priv:	The client's private data.
-  *
-  * This structure describes mailbox channel message.
-  */
+ * struct mbox_channel_msg - Definition of mbox channel message
+ * @channel:	Channel number.
+ * @data:	Pointer to data to be sent.
+ * @length:	Length of data to be sent.
+ * @cb:	Pointer to the callback function to be called when send
+ *		operation will be finished.
+ * @priv:	The client's private data.
+ *
+ * This structure describes mailbox channel message.
+ */
 struct mbox_channel_msg {
 	u16			channel;
 	u32			*data;
@@ -41,30 +41,31 @@ struct mbox_channel_msg {
 	void			*priv;
 };
 
-/** mbox_channel_register - Set up a given mailbox channel.
-  * @channel:	Mailbox channel number.
-  * @cb:	Pointer to the callback function to be called when a new message
-  *		is received.
-  * @priv:	Client user data which will be returned in the callback.
-  *
-  * Returns 0 on success or a negative error code on error.
-  */
+/**
+ * mbox_channel_register - Set up a given mailbox channel.
+ * @channel:	Mailbox channel number.
+ * @cb:	Pointer to the callback function to be called when a new message
+ *		is received.
+ * @priv:	Client user data which will be returned in the callback.
+ *
+ * Returns 0 on success or a negative error code on error.
+ */
 int mbox_channel_register(u16 channel, mbox_channel_cb_t *cb, void *priv);
 
 /**
-  * mbox_channel_send - Send data on given mailbox channel.
-  * @msg:	Mailbox channel message to be sent.
-  *
-  * Returns 0 on success or a negative error code on error.
-  */
+ * mbox_channel_send - Send data on given mailbox channel.
+ * @msg:	Mailbox channel message to be sent.
+ *
+ * Returns 0 on success or a negative error code on error.
+ */
 int mbox_channel_send(struct mbox_channel_msg *msg);
 
 /**
-  * mbox_channel_revoke_messages - Revoke messages on given mailbox channel.
-  * @channel:	Mailbox channel number.
-  *
-  * Returns 0 on success or a negative error code on error.
-  */
+ * mbox_channel_revoke_messages - Revoke messages on given mailbox channel.
+ * @channel:	Mailbox channel number.
+ *
+ * Returns 0 on success or a negative error code on error.
+ */
 int mbox_channel_revoke_messages(u16 channel);
 
 #endif /*INC_STE_MBOX_H*/