cpufreq: Clarify the comment in cpufreq_set_policy()
authorViresh Kumar <viresh.kumar@linaro.org>
Tue, 22 Oct 2019 10:17:57 +0000 (15:47 +0530)
committerRafael J. Wysocki <rafael.j.wysocki@intel.com>
Mon, 4 Nov 2019 10:44:26 +0000 (11:44 +0100)
One of the responsibility of the ->verify() callback is to make sure
that the policy's min frequency is <= max frequency as this isn't
guaranteed by the QoS framework which gave us those values.

Update the comment in cpufreq_set_policy() to clarify that.

Suggested-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Signed-off-by: Viresh Kumar <viresh.kumar@linaro.org>
[ rjw: Minor changes of the new comment ]
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
drivers/cpufreq/cpufreq.c

index 48a224a6b17815ae789ee8bede83508cc8f077d9..dd16281923100a0aa61d743e52b498b5417f4ba1 100644 (file)
@@ -2385,7 +2385,10 @@ int cpufreq_set_policy(struct cpufreq_policy *policy,
        new_policy->min = freq_qos_read_value(&policy->constraints, FREQ_QOS_MIN);
        new_policy->max = freq_qos_read_value(&policy->constraints, FREQ_QOS_MAX);
 
-       /* verify the cpu speed can be set within this limit */
+       /*
+        * Verify that the CPU speed can be set within these limits and make sure
+        * that min <= max.
+        */
        ret = cpufreq_driver->verify(new_policy);
        if (ret)
                return ret;