[PATCH v3 0/2] cpufreq: Update function comment and document

[PATCH v3 0/2] cpufreq: Update function comment and document

[Tang Yizhou]

v3:
Take viresh's advice and update the comments in cpufreq.c

v2:
1. Take viresh's advice and update the comments in cpufreq.c
2. Add an Acked-by tag in Patch 2.

Tang Yizhou (2):
  cpufreq: Fix a comment in cpufreq_policy_free
  doc/cpufreq: Update core.rst

 Documentation/cpu-freq/core.rst | 6 +++---
 drivers/cpufreq/cpufreq.c       | 5 +++--
 2 files changed, 6 insertions(+), 5 deletions(-)

-- 
2.17.1

[PATCH v3 1/2] cpufreq: Fix a comment in cpufreq_policy_free

[Tang Yizhou]

Make the comment of blocking_notifier_call_chain() easier to
understand.

Signed-off-by: Tang Yizhou <tangyizhou@huawei.com>
---
 drivers/cpufreq/cpufreq.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/drivers/cpufreq/cpufreq.c b/drivers/cpufreq/cpufreq.c
index e338d2f010fe..db0b4b4258d5 100644
--- a/drivers/cpufreq/cpufreq.c
+++ b/drivers/cpufreq/cpufreq.c
@@ -1296,8 +1296,9 @@ static void cpufreq_policy_free(struct cpufreq_policy *policy)
 
 	if (policy->max_freq_req) {
 		/*
-		 * CPUFREQ_CREATE_POLICY notification is sent only after
-		 * successfully adding max_freq_req request.
+		 * Remove max_freq_req after sending CPUFREQ_REMOVE_POLICY
+		 * notification, since CPUFREQ_CREATE_POLICY notification was
+		 * sent after adding max_freq_req earlier.
 		 */
 		blocking_notifier_call_chain(&cpufreq_policy_notifier_list,
 					     CPUFREQ_REMOVE_POLICY, policy);
-- 
2.17.1

Re: [PATCH v3 1/2] cpufreq: Fix a comment in cpufreq_policy_free

[Viresh Kumar]

On 01-12-21, 15:40, Tang Yizhou wrote:
> Make the comment of blocking_notifier_call_chain() easier to
> understand.
> 
> Signed-off-by: Tang Yizhou <tangyizhou@huawei.com>
> ---
>  drivers/cpufreq/cpufreq.c | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/cpufreq/cpufreq.c b/drivers/cpufreq/cpufreq.c
> index e338d2f010fe..db0b4b4258d5 100644
> --- a/drivers/cpufreq/cpufreq.c
> +++ b/drivers/cpufreq/cpufreq.c
> @@ -1296,8 +1296,9 @@ static void cpufreq_policy_free(struct cpufreq_policy *policy)
>  
>  	if (policy->max_freq_req) {
>  		/*
> -		 * CPUFREQ_CREATE_POLICY notification is sent only after
> -		 * successfully adding max_freq_req request.
> +		 * Remove max_freq_req after sending CPUFREQ_REMOVE_POLICY
> +		 * notification, since CPUFREQ_CREATE_POLICY notification was
> +		 * sent after adding max_freq_req earlier.
>  		 */
>  		blocking_notifier_call_chain(&cpufreq_policy_notifier_list,
>  					     CPUFREQ_REMOVE_POLICY, policy);

Acked-by: Viresh Kumar <viresh.kumar@linaro.org>

-- 
viresh

Re: [PATCH v3 1/2] cpufreq: Fix a comment in cpufreq_policy_free

[Rafael J. Wysocki]

On Wed, Dec 1, 2021 at 8:19 AM Viresh Kumar <viresh.kumar@linaro.org> wrote:
>
> On 01-12-21, 15:40, Tang Yizhou wrote:
> > Make the comment of blocking_notifier_call_chain() easier to
> > understand.
> >
> > Signed-off-by: Tang Yizhou <tangyizhou@huawei.com>
> > ---
> >  drivers/cpufreq/cpufreq.c | 5 +++--
> >  1 file changed, 3 insertions(+), 2 deletions(-)
> >
> > diff --git a/drivers/cpufreq/cpufreq.c b/drivers/cpufreq/cpufreq.c
> > index e338d2f010fe..db0b4b4258d5 100644
> > --- a/drivers/cpufreq/cpufreq.c
> > +++ b/drivers/cpufreq/cpufreq.c
> > @@ -1296,8 +1296,9 @@ static void cpufreq_policy_free(struct cpufreq_policy *policy)
> >
> >       if (policy->max_freq_req) {
> >               /*
> > -              * CPUFREQ_CREATE_POLICY notification is sent only after
> > -              * successfully adding max_freq_req request.
> > +              * Remove max_freq_req after sending CPUFREQ_REMOVE_POLICY
> > +              * notification, since CPUFREQ_CREATE_POLICY notification was
> > +              * sent after adding max_freq_req earlier.
> >                */
> >               blocking_notifier_call_chain(&cpufreq_policy_notifier_list,
> >                                            CPUFREQ_REMOVE_POLICY, policy);
>
> Acked-by: Viresh Kumar <viresh.kumar@linaro.org>

Applied as 5.16-rc material along with the [2/2[, thanks!

[PATCH v3 2/2] doc/cpufreq: Update core.rst

[Tang Yizhou]

As the definition of struct cpufreq_freqs has changed, update core.rst
with the new first member of struct cpufreq_freqs.

Signed-off-by: Tang Yizhou <tangyizhou@huawei.com>
Acked-by: Viresh Kumar <viresh.kumar@linaro.org>
---
 Documentation/cpu-freq/core.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/cpu-freq/core.rst b/Documentation/cpu-freq/core.rst
index 33cb90bd1d8f..4ceef8e7217c 100644
--- a/Documentation/cpu-freq/core.rst
+++ b/Documentation/cpu-freq/core.rst
@@ -73,12 +73,12 @@ CPUFREQ_POSTCHANGE.
 The third argument is a struct cpufreq_freqs with the following
 values:
 
-=====	===========================
-cpu	number of the affected CPU
+======	======================================
+policy	a pointer to the struct cpufreq_policy
 old	old frequency
 new	new frequency
 flags	flags of the cpufreq driver
-=====	===========================
+======	======================================
 
 3. CPUFreq Table Generation with Operating Performance Point (OPP)
 ==================================================================
-- 
2.17.1