Add the description of @req and @boost_supported in struct amd_cpudata
kernel-doc comment to remove warnings found by running scripts/kernel-doc,
which is caused by using 'make W=1'.
drivers/cpufreq/amd-pstate.c:104: warning: Function parameter or member
'req' not described in 'amd_cpudata'
drivers/cpufreq/amd-pstate.c:104: warning: Function parameter or member
'boost_supported' not described in 'amd_cpudata'
Reported-by: Abaci Robot <[email protected]>
Signed-off-by: Yang Li <[email protected]>
---
drivers/cpufreq/amd-pstate.c | 2 ++
1 file changed, 2 insertions(+)
diff --git a/drivers/cpufreq/amd-pstate.c b/drivers/cpufreq/amd-pstate.c
index 40ceb031abf5..9ce75ed11f8e 100644
--- a/drivers/cpufreq/amd-pstate.c
+++ b/drivers/cpufreq/amd-pstate.c
@@ -68,6 +68,7 @@ static struct cpufreq_driver amd_pstate_driver;
/**
* struct amd_cpudata - private CPU data for AMD P-State
* @cpu: CPU number
+ * @req: constraint request to apply
* @cppc_req_cached: cached performance request hints
* @highest_perf: the maximum performance an individual processor may reach,
* assuming ideal conditions
@@ -80,6 +81,7 @@ static struct cpufreq_driver amd_pstate_driver;
* @min_freq: the frequency that mapped to lowest_perf
* @nominal_freq: the frequency that mapped to nominal_perf
* @lowest_nonlinear_freq: the frequency that mapped to lowest_nonlinear_perf
+ * @boost_supported: check whether the Processor or SBIOS supports boost mode
*
* The amd_cpudata is key private data for each CPU thread in AMD P-State, and
* represents all the attributes and goals that AMD P-State requests at runtime.
--
2.20.1.7.g153144c
On Thu, Jan 06, 2022 at 10:16:05AM +0800, Yang Li wrote:
> Add the description of @req and @boost_supported in struct amd_cpudata
> kernel-doc comment to remove warnings found by running scripts/kernel-doc,
> which is caused by using 'make W=1'.
>
> drivers/cpufreq/amd-pstate.c:104: warning: Function parameter or member
> 'req' not described in 'amd_cpudata'
> drivers/cpufreq/amd-pstate.c:104: warning: Function parameter or member
> 'boost_supported' not described in 'amd_cpudata'
>
> Reported-by: Abaci Robot <[email protected]>
> Signed-off-by: Yang Li <[email protected]>
Acked-by: Huang Rui <[email protected]>
> ---
> drivers/cpufreq/amd-pstate.c | 2 ++
> 1 file changed, 2 insertions(+)
>
> diff --git a/drivers/cpufreq/amd-pstate.c b/drivers/cpufreq/amd-pstate.c
> index 40ceb031abf5..9ce75ed11f8e 100644
> --- a/drivers/cpufreq/amd-pstate.c
> +++ b/drivers/cpufreq/amd-pstate.c
> @@ -68,6 +68,7 @@ static struct cpufreq_driver amd_pstate_driver;
> /**
> * struct amd_cpudata - private CPU data for AMD P-State
> * @cpu: CPU number
> + * @req: constraint request to apply
> * @cppc_req_cached: cached performance request hints
> * @highest_perf: the maximum performance an individual processor may reach,
> * assuming ideal conditions
> @@ -80,6 +81,7 @@ static struct cpufreq_driver amd_pstate_driver;
> * @min_freq: the frequency that mapped to lowest_perf
> * @nominal_freq: the frequency that mapped to nominal_perf
> * @lowest_nonlinear_freq: the frequency that mapped to lowest_nonlinear_perf
> + * @boost_supported: check whether the Processor or SBIOS supports boost mode
> *
> * The amd_cpudata is key private data for each CPU thread in AMD P-State, and
> * represents all the attributes and goals that AMD P-State requests at runtime.
> --
> 2.20.1.7.g153144c
>
On Thu, Jan 6, 2022 at 7:20 AM Huang Rui <[email protected]> wrote:
>
> On Thu, Jan 06, 2022 at 10:16:05AM +0800, Yang Li wrote:
> > Add the description of @req and @boost_supported in struct amd_cpudata
> > kernel-doc comment to remove warnings found by running scripts/kernel-doc,
> > which is caused by using 'make W=1'.
> >
> > drivers/cpufreq/amd-pstate.c:104: warning: Function parameter or member
> > 'req' not described in 'amd_cpudata'
> > drivers/cpufreq/amd-pstate.c:104: warning: Function parameter or member
> > 'boost_supported' not described in 'amd_cpudata'
> >
> > Reported-by: Abaci Robot <[email protected]>
> > Signed-off-by: Yang Li <[email protected]>
>
> Acked-by: Huang Rui <[email protected]>
Applied, thanks!