diff mbox series

[01/13] mailbox: pcc: Fix doxygen comments

Message ID 20210708180851.2311192-2-sudeep.holla@arm.com (mailing list archive)
State Not Applicable, archived
Headers show
Series mailbox: pcc: Add support for PCCT extended PCC subspaces | expand

Commit Message

Sudeep Holla July 8, 2021, 6:08 p.m. UTC
Clang complains about doxygen comments too with W=1 in the build.

  |  drivers/mailbox/pcc.c:179: warning: Function parameter or member 'irq'
  |	not described in 'pcc_mbox_irq'
  |  drivers/mailbox/pcc.c:179: warning: Function parameter or member 'p'
  |	not described in 'pcc_mbox_irq'
  |  drivers/mailbox/pcc.c:378: warning: expecting prototype for
  |	parse_pcc_subspaces(). Prototype was for parse_pcc_subspace() instead

Fix it.

Signed-off-by: Sudeep Holla <sudeep.holla@arm.com>
---
 drivers/mailbox/pcc.c | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

Comments

Joe Perches July 8, 2021, 6:51 p.m. UTC | #1
On Thu, 2021-07-08 at 19:08 +0100, Sudeep Holla wrote:
> Clang complains about doxygen comments too with W=1 in the build.

just fyi: it's not a clang message, it's kernel-doc that complains.

./scripts/kernel-doc -none drivers/mailbox/pcc.c
Sudeep Holla July 8, 2021, 9:03 p.m. UTC | #2
On Thu, Jul 08, 2021 at 11:51:45AM -0700, Joe Perches wrote:
> On Thu, 2021-07-08 at 19:08 +0100, Sudeep Holla wrote:
> > Clang complains about doxygen comments too with W=1 in the build.
> 
> just fyi: it's not a clang message, it's kernel-doc that complains.
> 
> ./scripts/kernel-doc -none drivers/mailbox/pcc.c
>

Ah OK. Thanks for the info. I may have missed to observe this with gcc or
the kernel-doc is not built by default with gcc unlike clang.
diff mbox series

Patch

diff --git a/drivers/mailbox/pcc.c b/drivers/mailbox/pcc.c
index 0296558f9e22..23391e224a68 100644
--- a/drivers/mailbox/pcc.c
+++ b/drivers/mailbox/pcc.c
@@ -174,6 +174,10 @@  static int pcc_map_interrupt(u32 interrupt, u32 flags)
 
 /**
  * pcc_mbox_irq - PCC mailbox interrupt handler
+ * @irq:	interrupt number
+ * @p: data/cookie passed from the caller to identify the channel
+ *
+ * Returns: IRQ_HANDLED if interrupt is handled or IRQ_NONE if not
  */
 static irqreturn_t pcc_mbox_irq(int irq, void *p)
 {
@@ -364,7 +368,7 @@  static const struct mbox_chan_ops pcc_chan_ops = {
 };
 
 /**
- * parse_pcc_subspaces -- Count PCC subspaces defined
+ * parse_pcc_subspace - Count PCC subspaces defined
  * @header: Pointer to the ACPI subtable header under the PCCT.
  * @end: End of subtable entry.
  *