docs: cpu-freq: convert core.txt to ReST
- Add a SPDX header; - Adjust the document title, based on the original contents of cpu-freq/index.txt; - Use lists where needed; - Comment out the existing text-only index; - use ``foo`` to mark a literal expression with asterisk; - Adjust some title marks; - Add table markups; - Add notes markups; - Some whitespace fixes and new line breaks; - Add it to cpu-freq/index.rst. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
This commit is contained in:
parent
12bd112bf8
commit
c460f972d3
|
@ -1,31 +1,23 @@
|
||||||
CPU frequency and voltage scaling code in the Linux(TM) kernel
|
.. SPDX-License-Identifier: GPL-2.0
|
||||||
|
|
||||||
|
=============================================================
|
||||||
|
General description of the CPUFreq core and CPUFreq notifiers
|
||||||
|
=============================================================
|
||||||
|
|
||||||
L i n u x C P U F r e q
|
Authors:
|
||||||
|
- Dominik Brodowski <linux@brodo.de>
|
||||||
|
- David Kimdon <dwhedon@debian.org>
|
||||||
|
- Rafael J. Wysocki <rafael.j.wysocki@intel.com>
|
||||||
|
- Viresh Kumar <viresh.kumar@linaro.org>
|
||||||
|
|
||||||
C P U F r e q C o r e
|
.. Contents:
|
||||||
|
|
||||||
|
1. CPUFreq core and interfaces
|
||||||
Dominik Brodowski <linux@brodo.de>
|
2. CPUFreq notifiers
|
||||||
David Kimdon <dwhedon@debian.org>
|
3. CPUFreq Table Generation with Operating Performance Point (OPP)
|
||||||
Rafael J. Wysocki <rafael.j.wysocki@intel.com>
|
|
||||||
Viresh Kumar <viresh.kumar@linaro.org>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Clock scaling allows you to change the clock speed of the CPUs on the
|
|
||||||
fly. This is a nice method to save battery power, because the lower
|
|
||||||
the clock speed, the less power the CPU consumes.
|
|
||||||
|
|
||||||
|
|
||||||
Contents:
|
|
||||||
---------
|
|
||||||
1. CPUFreq core and interfaces
|
|
||||||
2. CPUFreq notifiers
|
|
||||||
3. CPUFreq Table Generation with Operating Performance Point (OPP)
|
|
||||||
|
|
||||||
1. General Information
|
1. General Information
|
||||||
=======================
|
======================
|
||||||
|
|
||||||
The CPUFreq core code is located in drivers/cpufreq/cpufreq.c. This
|
The CPUFreq core code is located in drivers/cpufreq/cpufreq.c. This
|
||||||
cpufreq code offers a standardized interface for the CPUFreq
|
cpufreq code offers a standardized interface for the CPUFreq
|
||||||
|
@ -63,7 +55,7 @@ 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_CREATE_POLICY when the policy is first created and it is
|
||||||
CPUFREQ_REMOVE_POLICY when the policy is removed.
|
CPUFREQ_REMOVE_POLICY when the policy is removed.
|
||||||
|
|
||||||
The third argument, a void *pointer, points to a struct cpufreq_policy
|
The third argument, a ``void *pointer``, points to a struct cpufreq_policy
|
||||||
consisting of several values, including min, max (the lower and upper
|
consisting of several values, including min, max (the lower and upper
|
||||||
frequencies (in kHz) of the new policy).
|
frequencies (in kHz) of the new policy).
|
||||||
|
|
||||||
|
@ -80,10 +72,13 @@ CPUFREQ_POSTCHANGE.
|
||||||
|
|
||||||
The third argument is a struct cpufreq_freqs with the following
|
The third argument is a struct cpufreq_freqs with the following
|
||||||
values:
|
values:
|
||||||
cpu - number of the affected CPU
|
|
||||||
old - old frequency
|
===== ===========================
|
||||||
new - new frequency
|
cpu number of the affected CPU
|
||||||
flags - flags of the cpufreq driver
|
old old frequency
|
||||||
|
new new frequency
|
||||||
|
flags flags of the cpufreq driver
|
||||||
|
===== ===========================
|
||||||
|
|
||||||
3. CPUFreq Table Generation with Operating Performance Point (OPP)
|
3. CPUFreq Table Generation with Operating Performance Point (OPP)
|
||||||
==================================================================
|
==================================================================
|
||||||
|
@ -94,9 +89,12 @@ dev_pm_opp_init_cpufreq_table -
|
||||||
the OPP layer's internal information about the available frequencies
|
the OPP layer's internal information about the available frequencies
|
||||||
into a format readily providable to cpufreq.
|
into a format readily providable to cpufreq.
|
||||||
|
|
||||||
WARNING: Do not use this function in interrupt context.
|
.. Warning::
|
||||||
|
|
||||||
|
Do not use this function in interrupt context.
|
||||||
|
|
||||||
|
Example::
|
||||||
|
|
||||||
Example:
|
|
||||||
soc_pm_init()
|
soc_pm_init()
|
||||||
{
|
{
|
||||||
/* Do things */
|
/* Do things */
|
||||||
|
@ -106,7 +104,10 @@ dev_pm_opp_init_cpufreq_table -
|
||||||
/* Do other things */
|
/* Do other things */
|
||||||
}
|
}
|
||||||
|
|
||||||
NOTE: This function is available only if CONFIG_CPU_FREQ is enabled in
|
.. note::
|
||||||
addition to CONFIG_PM_OPP.
|
|
||||||
|
|
||||||
dev_pm_opp_free_cpufreq_table - Free up the table allocated by dev_pm_opp_init_cpufreq_table
|
This function is available only if CONFIG_CPU_FREQ is enabled in
|
||||||
|
addition to CONFIG_PM_OPP.
|
||||||
|
|
||||||
|
dev_pm_opp_free_cpufreq_table
|
||||||
|
Free up the table allocated by dev_pm_opp_init_cpufreq_table
|
|
@ -14,6 +14,8 @@ Author: Dominik Brodowski <linux@brodo.de>
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
|
core
|
||||||
|
|
||||||
Mailing List
|
Mailing List
|
||||||
------------
|
------------
|
||||||
There is a CPU frequency changing CVS commit and general list where
|
There is a CPU frequency changing CVS commit and general list where
|
||||||
|
|
Loading…
Reference in New Issue