mirror of
https://github.com/tbsdtv/linux_media.git
synced 2025-07-23 12:43:29 +02:00
Documentation: power: Update outdated contents in opp.rst
Three problems have been revised: 1. CONFIG_PM_OPP no longer depends on CONFIG_PM. 2. opp_find_freq_{ceil, floor} is renamed as dev_pm_opp_find_freq_{ceil, floor}. 3. Make it clear that the 'opp' struct is actually dev_pm_opp. Signed-off-by: Tang Yizhou <tangyizhou@huawei.com> Signed-off-by: Viresh Kumar <viresh.kumar@linaro.org>
This commit is contained in:
committed by
Viresh Kumar
parent
fa55b7dcdc
commit
489a00ef46
@@ -48,9 +48,9 @@ We can represent these as three OPPs as the following {Hz, uV} tuples:
|
|||||||
OPP library provides a set of helper functions to organize and query the OPP
|
OPP library provides a set of helper functions to organize and query the OPP
|
||||||
information. The library is located in drivers/opp/ directory and the header
|
information. The library is located in drivers/opp/ directory and the header
|
||||||
is located in include/linux/pm_opp.h. OPP library can be enabled by enabling
|
is located in include/linux/pm_opp.h. OPP library can be enabled by enabling
|
||||||
CONFIG_PM_OPP from power management menuconfig menu. OPP library depends on
|
CONFIG_PM_OPP from power management menuconfig menu. Certain SoCs such as Texas
|
||||||
CONFIG_PM as certain SoCs such as Texas Instrument's OMAP framework allows to
|
Instrument's OMAP framework allows to optionally boot at a certain OPP without
|
||||||
optionally boot at a certain OPP without needing cpufreq.
|
needing cpufreq.
|
||||||
|
|
||||||
Typical usage of the OPP library is as follows::
|
Typical usage of the OPP library is as follows::
|
||||||
|
|
||||||
@@ -75,8 +75,8 @@ operations until that OPP could be re-enabled if possible.
|
|||||||
|
|
||||||
OPP library facilitates this concept in its implementation. The following
|
OPP library facilitates this concept in its implementation. The following
|
||||||
operational functions operate only on available opps:
|
operational functions operate only on available opps:
|
||||||
opp_find_freq_{ceil, floor}, dev_pm_opp_get_voltage, dev_pm_opp_get_freq,
|
dev_pm_opp_find_freq_{ceil, floor}, dev_pm_opp_get_voltage, dev_pm_opp_get_freq,
|
||||||
dev_pm_opp_get_opp_count
|
dev_pm_opp_get_opp_count.
|
||||||
|
|
||||||
dev_pm_opp_find_freq_exact is meant to be used to find the opp pointer
|
dev_pm_opp_find_freq_exact is meant to be used to find the opp pointer
|
||||||
which can then be used for dev_pm_opp_enable/disable functions to make an
|
which can then be used for dev_pm_opp_enable/disable functions to make an
|
||||||
@@ -103,7 +103,7 @@ dev_pm_opp_add
|
|||||||
The OPP is defined using the frequency and voltage. Once added, the OPP
|
The OPP is defined using the frequency and voltage. Once added, the OPP
|
||||||
is assumed to be available and control of its availability can be done
|
is assumed to be available and control of its availability can be done
|
||||||
with the dev_pm_opp_enable/disable functions. OPP library
|
with the dev_pm_opp_enable/disable functions. OPP library
|
||||||
internally stores and manages this information in the opp struct.
|
internally stores and manages this information in the dev_pm_opp struct.
|
||||||
This function may be used by SoC framework to define a optimal list
|
This function may be used by SoC framework to define a optimal list
|
||||||
as per the demands of SoC usage environment.
|
as per the demands of SoC usage environment.
|
||||||
|
|
||||||
@@ -247,7 +247,7 @@ dev_pm_opp_disable
|
|||||||
5. OPP Data Retrieval Functions
|
5. OPP Data Retrieval Functions
|
||||||
===============================
|
===============================
|
||||||
Since OPP library abstracts away the OPP information, a set of functions to pull
|
Since OPP library abstracts away the OPP information, a set of functions to pull
|
||||||
information from the OPP structure is necessary. Once an OPP pointer is
|
information from the dev_pm_opp structure is necessary. Once an OPP pointer is
|
||||||
retrieved using the search functions, the following functions can be used by SoC
|
retrieved using the search functions, the following functions can be used by SoC
|
||||||
framework to retrieve the information represented inside the OPP layer.
|
framework to retrieve the information represented inside the OPP layer.
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user