linux-acpi.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Sudeep Holla <sudeep.holla@arm.com>
To: linux-acpi@vger.kernel.org, linux-kernel@vger.kernel.org
Cc: Sudeep Holla <sudeep.holla@arm.com>,
	Cristian Marussi <cristian.marussi@arm.com>,
	"Rafael J . Wysocki" <rjw@rjwysocki.net>,
	Jassi Brar <jassisinghbrar@gmail.com>
Subject: [PATCH v2 01/14] mailbox: pcc: Fix kernel doc warnings
Date: Fri, 17 Sep 2021 14:33:44 +0100	[thread overview]
Message-ID: <20210917133357.1911092-2-sudeep.holla@arm.com> (raw)
In-Reply-To: <20210917133357.1911092-1-sudeep.holla@arm.com>

Kernel doc validation script is unhappy and complains with the below set
of warnings.

  |  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(-)

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.
  *
-- 
2.25.1


  reply	other threads:[~2021-09-17 13:34 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-17 13:33 [PATCH v2 00/14] mailbox: pcc: Add support for PCCT extended PCC subspaces Sudeep Holla
2021-09-17 13:33 ` Sudeep Holla [this message]
2021-09-17 13:33 ` [PATCH v2 02/14] ACPI: CPPC: Fix kernel doc warnings Sudeep Holla
2021-09-17 13:33 ` [PATCH v2 03/14] mailbox: pcc: Refactor all PCC channel information into a structure Sudeep Holla
2021-09-17 13:33 ` [PATCH v2 04/14] mailbox: pcc: Consolidate subspace interrupt information parsing Sudeep Holla
2021-09-17 13:33 ` [PATCH v2 05/14] mailbox: pcc: Consolidate subspace doorbell register parsing Sudeep Holla
2021-09-17 13:33 ` [PATCH v2 06/14] mailbox: pcc: Add pcc_mbox_chan structure to hold shared memory region info Sudeep Holla
2021-09-17 13:33 ` [PATCH v2 07/14] mailbox: pcc: Use PCC mailbox channel pointer instead of standard Sudeep Holla
2021-10-04 20:05   ` Wolfram Sang
2021-10-11 10:07   ` Sudeep Holla
2021-10-11 14:08   ` Guenter Roeck
2021-09-17 13:33 ` [PATCH v2 08/14] mailbox: pcc: Rename doorbell ack to platform interrupt ack register Sudeep Holla
2021-09-17 13:33 ` [PATCH v2 09/14] mailbox: pcc: Add PCC register bundle and associated accessor functions Sudeep Holla
2021-09-17 13:33 ` [PATCH v2 10/14] mailbox: pcc: Avoid accessing PCCT table in pcc_send_data and pcc_mbox_irq Sudeep Holla
2021-09-17 13:33 ` [PATCH v2 11/14] mailbox: pcc: Drop handling invalid bit-width in {read,write}_register Sudeep Holla
2021-09-17 13:33 ` [PATCH v2 12/14] mailbox: pcc: Add support for PCCT extended PCC subspaces(type 3/4) Sudeep Holla
2021-09-17 13:33 ` [PATCH v2 13/14] mailbox: pcc: Move bulk of PCCT parsing into pcc_mbox_probe Sudeep Holla
2021-09-17 13:33 ` [PATCH v2 14/14] ACPI/PCC: Add myself as maintainer for PCC mailbox driver Sudeep Holla
2021-09-17 15:10   ` Rafael J. Wysocki
2021-10-11 10:09 ` [PATCH v2 00/14] mailbox: pcc: Add support for PCCT extended PCC subspaces Sudeep Holla
2021-10-21 16:54   ` Sudeep Holla
2021-10-22 15:05     ` Jassi Brar
2021-10-22 17:09       ` Sudeep Holla

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210917133357.1911092-2-sudeep.holla@arm.com \
    --to=sudeep.holla@arm.com \
    --cc=cristian.marussi@arm.com \
    --cc=jassisinghbrar@gmail.com \
    --cc=linux-acpi@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rjw@rjwysocki.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).