Commit c27c38af authored by Viresh Kumar's avatar Viresh Kumar Committed by Rafael J. Wysocki
Browse files

Documentation: cpufreq: Update policy notifier documentation 



Update documentation with the recent policy notifier updates.

Signed-off-by: default avatarViresh Kumar <viresh.kumar@linaro.org>
Signed-off-by: default avatarRafael J. Wysocki <rafael.j.wysocki@intel.com>
parent df0eea44

Documentation/cpu-freq/core.txt

+4 −12
Original line number Diff line number Diff line
@@ -57,19 +57,11 @@ transition notifiers. 
2.1 CPUFreq policy notifiers

----------------------------



These are notified when a new policy is intended to be set. Each

CPUFreq policy notifier is called twice for a policy transition:

These are notified when a new policy is created or removed.



1.) During CPUFREQ_ADJUST all CPUFreq notifiers may change the limit if

    they see a need for this - may it be thermal considerations or

    hardware limitations.



2.) And during CPUFREQ_NOTIFY all notifiers are informed of the new policy

   - if two hardware drivers failed to agree on a new policy before this

   stage, the incompatible hardware shall be shut down, and the user

   informed of this.



The phase is specified in the second argument to the notifier.

The phase is specified in the second argument to the notifier.  The phase is

CPUFREQ_CREATE_POLICY when the policy is first created and it is

CPUFREQ_REMOVE_POLICY when the policy is removed.



The third argument, a void *pointer, points to a struct cpufreq_policy

consisting of several values, including min, max (the lower and upper

CRA Git | Maintained and supported by SUSTech CRA and CCSE