]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
mailbox: correct kerneldoc
authorKrzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Sun, 1 May 2022 10:34:27 +0000 (12:34 +0200)
committerJassi Brar <jaswinder.singh@linaro.org>
Sat, 21 May 2022 16:41:30 +0000 (11:41 -0500)
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 <krzysztof.kozlowski@linaro.org>
Acked-by: Viresh Kumar <viresh.kumar@linaro.org>
Acked-by: Sudeep Holla <sudeep.holla@arm.com>
Signed-off-by: Jassi Brar <jaswinder.singh@linaro.org>
drivers/mailbox/arm_mhu_db.c
drivers/mailbox/arm_mhuv2.c
drivers/mailbox/qcom-ipcc.c

index 8674153cc893b66a67e0025b09336b7839b1cac8..aa0a4d83880fc1759e86de2ee9cd17d589129f3c 100644 (file)
@@ -44,7 +44,7 @@ struct arm_mhu {
 };
 
 /**
- * ARM MHU Mailbox allocated channel information
+ * struct mhu_db_channel - ARM MHU Mailbox allocated channel information
  *
  * @mhu: Pointer to parent mailbox device
  * @pchan: Physical channel within which this doorbell resides in
index d997f8ebfa98ca934391459ef348e2a8e83363b0..a47aef8df52fd6f3125987f98a47bc3afcd38944 100644 (file)
@@ -160,7 +160,8 @@ enum mhuv2_frame {
  * struct mhuv2 - MHUv2 mailbox controller data
  *
  * @mbox:      Mailbox controller belonging to the MHU frame.
- * @send/recv: Base address of the register mapping region.
+ * @send:      Base address of the register mapping region.
+ * @recv:      Base address of the register mapping region.
  * @frame:     Frame type: RECEIVER_FRAME or SENDER_FRAME.
  * @irq:       Interrupt.
  * @windows:   Channel windows implemented by the platform.
index c5d9632220146058689a78d89270e9244c6d9036..881706da59c0f304ba8fa52d654aa21b6dd5d08b 100644 (file)
@@ -41,9 +41,10 @@ struct qcom_ipcc_chan_info {
  * @dev:               Device associated with this instance
  * @base:              Base address of the IPCC frame associated to APSS
  * @irq_domain:                The irq_domain associated with this instance
- * @chan             The mailbox channels array
+ * @chans:             The mailbox channels array
  * @mchan:             The per-mailbox channel info array
  * @mbox:              The mailbox controller
+ * @num_chans:         Number of @chans elements
  * @irq:               Summary irq
  */
 struct qcom_ipcc {