linux-kernel.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 02/13] ACPI: CPPC: Fix doxygen comments
Date: Thu,  8 Jul 2021 19:08:40 +0100	[thread overview]
Message-ID: <20210708180851.2311192-3-sudeep.holla@arm.com> (raw)
In-Reply-To: <20210708180851.2311192-1-sudeep.holla@arm.com>

Clang complains about doxygen comments too with W=1 in the build.

  | drivers/acpi/cppc_acpi.c:560: warning: Function parameter or member
  |	'pcc_ss_id' not described in 'pcc_data_alloc'
  | drivers/acpi/cppc_acpi.c:1343: warning: Function parameter or member
  |	'cpu_num' not described in 'cppc_get_transition_latency'

Fix it.

Signed-off-by: Sudeep Holla <sudeep.holla@arm.com>
---
 drivers/acpi/cppc_acpi.c | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/drivers/acpi/cppc_acpi.c b/drivers/acpi/cppc_acpi.c
index a4d4eebba1da..eb5685167d19 100644
--- a/drivers/acpi/cppc_acpi.c
+++ b/drivers/acpi/cppc_acpi.c
@@ -562,6 +562,8 @@ bool __weak cpc_ffh_supported(void)
 /**
  * pcc_data_alloc() - Allocate the pcc_data memory for pcc subspace
  *
+ * @pcc_ss_id: PCC Subspace channel identifier
+ *
  * Check and allocate the cppc_pcc_data memory.
  * In some processor configurations it is possible that same subspace
  * is shared between multiple CPUs. This is seen especially in CPUs
@@ -1347,10 +1349,15 @@ EXPORT_SYMBOL_GPL(cppc_set_perf);
 /**
  * cppc_get_transition_latency - returns frequency transition latency in ns
  *
+ * @cpu_num: Logical index of the CPU for which latencty is requested
+ *
  * ACPI CPPC does not explicitly specify how a platform can specify the
  * transition latency for performance change requests. The closest we have
  * is the timing information from the PCCT tables which provides the info
  * on the number and frequency of PCC commands the platform can handle.
+ *
+ * Returns: frequency transition latency on success or CPUFREQ_ETERNAL on
+ * failure
  */
 unsigned int cppc_get_transition_latency(int cpu_num)
 {
-- 
2.25.1


  parent reply	other threads:[~2021-07-08 18:09 UTC|newest]

Thread overview: 32+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-07-08 18:08 [PATCH 00/13] mailbox: pcc: Add support for PCCT extended PCC subspaces Sudeep Holla
2021-07-08 18:08 ` [PATCH 01/13] mailbox: pcc: Fix doxygen comments Sudeep Holla
2021-07-08 18:51   ` Joe Perches
2021-07-08 21:03     ` Sudeep Holla
2021-07-08 18:08 ` Sudeep Holla [this message]
2021-07-14 12:20   ` [PATCH 02/13] ACPI: CPPC: " Rafael J. Wysocki
2021-07-14 15:12     ` Sudeep Holla
2021-07-14 16:07       ` Cristian Marussi
2021-07-14 16:14         ` Sudeep Holla
2021-07-08 18:08 ` [PATCH 03/13] mailbox: pcc: Refactor all PCC channel information into a structure Sudeep Holla
2021-07-14 16:54   ` Cristian Marussi
2021-07-15 11:27     ` Sudeep Holla
2021-07-15 12:50       ` Cristian Marussi
2021-07-15 13:24         ` Sudeep Holla
2021-07-08 18:08 ` [PATCH 04/13] mailbox: pcc: Consolidate subspace interrupt information parsing Sudeep Holla
2021-07-14 17:44   ` Cristian Marussi
2021-07-08 18:08 ` [PATCH 05/13] mailbox: pcc: Consolidate subspace doorbell register parsing Sudeep Holla
2021-07-14 18:09   ` Cristian Marussi
2021-07-08 18:08 ` [PATCH 06/13] mailbox: pcc: Add pcc_mbox_chan structure to hold shared memory region info Sudeep Holla
2021-07-14 18:18   ` Cristian Marussi
2021-07-15 11:22     ` Sudeep Holla
2021-07-08 18:08 ` [PATCH 07/13] mailbox: pcc: Use PCC mailbox channel pointer instead of standard Sudeep Holla
2021-07-08 18:08 ` [PATCH 08/13] mailbox: pcc: Rename doorbell ack to platform interrupt ack register Sudeep Holla
2021-07-08 18:08 ` [PATCH 09/13] mailbox: pcc: Add PCC register bundle and associated accessor functions Sudeep Holla
2021-07-08 18:08 ` [PATCH 10/13] mailbox: pcc: Avoid accessing PCCT table in pcc_send_data and pcc_mbox_irq Sudeep Holla
2021-07-14 18:37   ` Cristian Marussi
2021-07-15 13:38   ` Cristian Marussi
2021-07-08 18:08 ` [PATCH 11/13] mailbox: pcc: Drop handling invalid bit-width in {read,write}_register Sudeep Holla
2021-07-08 18:08 ` [PATCH 12/13] mailbox: pcc: Add support for PCCT extended PCC subspaces(type 3/4) Sudeep Holla
2021-07-14 18:52   ` Cristian Marussi
2021-07-15 11:31     ` Sudeep Holla
2021-07-08 18:08 ` [PATCH 13/13] mailbox: pcc: Move bulk of PCCT parsing into pcc_mbox_probe 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=20210708180851.2311192-3-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 \
    --subject='Re: [PATCH 02/13] ACPI: CPPC: Fix doxygen comments' \
    /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

This is a public inbox, see mirroring instructions
on how to clone and mirror all data and code used for this inbox