Skip to content

Commit a022c7c

Browse files
krzkJassiBrar
authored andcommitted
mailbox: correct kerneldoc
Correct kerneldoc warnings like: drivers/mailbox/arm_mhu_db.c:47: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/mailbox/qcom-ipcc.c:58: warning: Function parameter or member 'num_chans' not described in 'qcom_ipcc' Signed-off-by: Krzysztof Kozlowski <[email protected]> Acked-by: Viresh Kumar <[email protected]> Acked-by: Sudeep Holla <[email protected]> Signed-off-by: Jassi Brar <[email protected]>
1 parent d951269 commit a022c7c

File tree

3 files changed

+5
-3
lines changed

3 files changed

+5
-3
lines changed

drivers/mailbox/arm_mhu_db.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ struct arm_mhu {
4444
};
4545

4646
/**
47-
* ARM MHU Mailbox allocated channel information
47+
* struct mhu_db_channel - ARM MHU Mailbox allocated channel information
4848
*
4949
* @mhu: Pointer to parent mailbox device
5050
* @pchan: Physical channel within which this doorbell resides in

drivers/mailbox/arm_mhuv2.c

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,8 @@ enum mhuv2_frame {
160160
* struct mhuv2 - MHUv2 mailbox controller data
161161
*
162162
* @mbox: Mailbox controller belonging to the MHU frame.
163-
* @send/recv: Base address of the register mapping region.
163+
* @send: Base address of the register mapping region.
164+
* @recv: Base address of the register mapping region.
164165
* @frame: Frame type: RECEIVER_FRAME or SENDER_FRAME.
165166
* @irq: Interrupt.
166167
* @windows: Channel windows implemented by the platform.

drivers/mailbox/qcom-ipcc.c

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,10 @@ struct qcom_ipcc_chan_info {
4141
* @dev: Device associated with this instance
4242
* @base: Base address of the IPCC frame associated to APSS
4343
* @irq_domain: The irq_domain associated with this instance
44-
* @chan: The mailbox channels array
44+
* @chans: The mailbox channels array
4545
* @mchan: The per-mailbox channel info array
4646
* @mbox: The mailbox controller
47+
* @num_chans: Number of @chans elements
4748
* @irq: Summary irq
4849
*/
4950
struct qcom_ipcc {

0 commit comments

Comments
 (0)