[PATCH v2 02/14] ACPI: CPPC: Fix kernel doc warnings

From: Sudeep Holla
Date: Fri Sep 17 2021 - 09:34:21 EST


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

| 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@xxxxxxx>
---
drivers/acpi/cppc_acpi.c | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/drivers/acpi/cppc_acpi.c b/drivers/acpi/cppc_acpi.c
index bd482108310c..e195123e26c0 100644
--- a/drivers/acpi/cppc_acpi.c
+++ b/drivers/acpi/cppc_acpi.c
@@ -561,6 +561,7 @@ 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
@@ -1360,12 +1361,16 @@ int cppc_set_perf(int cpu, struct cppc_perf_ctrls *perf_ctrls)
EXPORT_SYMBOL_GPL(cppc_set_perf);

/**
- * cppc_get_transition_latency - returns frequency transition latency in ns
+ * cppc_get_transition_latency - Provides 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