€•úÎ      Œsphinx.addnodes”Œdocument”“”)”}”(Œ	rawsource”Œ ”Œchildren”]”(Œtranslations”ŒLanguagesNode”“”)”}”(hhh]”(h Œpending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ
attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ	refdomain”Œstd”Œreftype”Œdoc”Œ	reftarget”Œ/translations/zh_CN/power/opp”Œmodname”NŒ	classname”NŒrefexplicit”ˆuŒtagname”hhhubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ/translations/zh_TW/power/opp”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ/translations/it_IT/power/opp”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ/translations/ja_JP/power/opp”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ/translations/ko_KR/power/opp”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒPortuguese (Brazilian)”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ/translations/pt_BR/power/opp”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒSpanish”…””}”hh–sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ/translations/sp_SP/power/opp”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h
hhŒ	_document”hŒsource”NŒline”NubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒ*Operating Performance Points (OPP) Library”h]”hŒ*Operating Performance Points (OPP) Library”…””}”(hh¼h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhh·h²hh³Œ7/var/lib/git/docbuild/linux/Documentation/power/opp.rst”h´KubhŒenumerated_list”“”)”}”(hhh]”hŒ	list_item”“”)”}”(hŒE2009-2010 Nishanth Menon <nm@ti.com>, Texas Instruments Incorporated
”h]”hŒ	paragraph”“”)”}”(hŒD2009-2010 Nishanth Menon <nm@ti.com>, Texas Instruments Incorporated”h]”(hŒ2009-2010 Nishanth Menon <”…””}”(hhØh²hh³Nh´NubhŒ	reference”“”)”}”(hŒ	nm@ti.com”h]”hŒ	nm@ti.com”…””}”(hhâh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”Œmailto:nm@ti.com”uh1hàhhØubhŒ!>, Texas Instruments Incorporated”…””}”(hhØh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´KhhÒubah}”(h]”h ]”h"]”h$]”h&]”uh1hÐhhÍh²hh³hÊh´Nubah}”(h]”h ]”h"]”h$]”h&]”Œenumtype”Œ
upperalpha”Œprefix”Œ(”Œsuffix”Œ)”Œstart”Kuh1hËhh·h²hh³hÊh´KubhŒcomment”“”)”}”(hŒ«Contents

1. Introduction
2. Initial OPP List Registration
3. OPP Search Functions
4. OPP Availability Control Functions
5. OPP Data Retrieval Functions
6. Data Structures”h]”hŒ«Contents

1. Introduction
2. Initial OPP List Registration
3. OPP Search Functions
4. OPP Availability Control Functions
5. OPP Data Retrieval Functions
6. Data Structures”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”Œ	xml:space”Œpreserve”uh1j  hh·h²hh³hÊh´Kubh¶)”}”(hhh]”(h»)”}”(hŒ1. Introduction”h]”hŒ1. Introduction”…””}”(hj$  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj!  h²hh³hÊh´Kubh¶)”}”(hhh]”(h»)”}”(hŒ11.1 What is an Operating Performance Point (OPP)?”h]”hŒ11.1 What is an Operating Performance Point (OPP)?”…””}”(hj5  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj2  h²hh³hÊh´Kubh×)”}”(hX¨  Complex SoCs of today consists of a multiple sub-modules working in conjunction.
In an operational system executing varied use cases, not all modules in the SoC
need to function at their highest performing frequency all the time. To
facilitate this, sub-modules in a SoC are grouped into domains, allowing some
domains to run at lower voltage and frequency while other domains run at
voltage/frequency pairs that are higher.”h]”hX¨  Complex SoCs of today consists of a multiple sub-modules working in conjunction.
In an operational system executing varied use cases, not all modules in the SoC
need to function at their highest performing frequency all the time. To
facilitate this, sub-modules in a SoC are grouped into domains, allowing some
domains to run at lower voltage and frequency while other domains run at
voltage/frequency pairs that are higher.”…””}”(hjC  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´Khj2  h²hubh×)”}”(hŒThe set of discrete tuples consisting of frequency and voltage pairs that
the device will support per domain are called Operating Performance Points or
OPPs.”h]”hŒThe set of discrete tuples consisting of frequency and voltage pairs that
the device will support per domain are called Operating Performance Points or
OPPs.”…””}”(hjQ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´Khj2  h²hubh×)”}”(hŒAs an example:”h]”hŒAs an example:”…””}”(hj_  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´K!hj2  h²hubh×)”}”(hŒ¥Let us consider an MPU device which supports the following:
{300MHz at minimum voltage of 1V}, {800MHz at minimum voltage of 1.2V},
{1GHz at minimum voltage of 1.3V}”h]”hŒ¥Let us consider an MPU device which supports the following:
{300MHz at minimum voltage of 1V}, {800MHz at minimum voltage of 1.2V},
{1GHz at minimum voltage of 1.3V}”…””}”(hjm  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´K#hj2  h²hubh×)”}”(hŒFWe can represent these as three OPPs as the following {Hz, uV} tuples:”h]”hŒFWe can represent these as three OPPs as the following {Hz, uV} tuples:”…””}”(hj{  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´K'hj2  h²hubhŒbullet_list”“”)”}”(hhh]”(hÑ)”}”(hŒ{300000000, 1000000}”h]”h×)”}”(hj  h]”hŒ{300000000, 1000000}”…””}”(hj’  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´K)hjŽ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÐhj‹  h²hh³hÊh´NubhÑ)”}”(hŒ{800000000, 1200000}”h]”h×)”}”(hj§  h]”hŒ{800000000, 1200000}”…””}”(hj©  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´K*hj¥  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÐhj‹  h²hh³hÊh´NubhÑ)”}”(hŒ{1000000000, 1300000}
”h]”h×)”}”(hŒ{1000000000, 1300000}”h]”hŒ{1000000000, 1300000}”…””}”(hjÀ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´K+hj¼  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÐhj‹  h²hh³hÊh´Nubeh}”(h]”h ]”h"]”h$]”h&]”Œbullet”Œ-”uh1j‰  h³hÊh´K)hj2  h²hubeh}”(h]”Œ*what-is-an-operating-performance-point-opp”ah ]”h"]”Œ11.1 what is an operating performance point (opp)?”ah$]”h&]”uh1hµhj!  h²hh³hÊh´Kubh¶)”}”(hhh]”(h»)”}”(hŒ(1.2 Operating Performance Points Library”h]”hŒ(1.2 Operating Performance Points Library”…””}”(hjç  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjä  h²hh³hÊh´K.ubh×)”}”(hX–  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
is located in include/linux/pm_opp.h. OPP library can be enabled by enabling
CONFIG_PM_OPP from power management menuconfig menu. Certain SoCs such as Texas
Instrument's OMAP framework allows to optionally boot at a certain OPP without
needing cpufreq.”h]”hX˜  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
is located in include/linux/pm_opp.h. OPP library can be enabled by enabling
CONFIG_PM_OPP from power management menuconfig menu. Certain SoCs such as Texas
Instrumentâ€™s OMAP framework allows to optionally boot at a certain OPP without
needing cpufreq.”…””}”(hjõ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´K0hjä  h²hubh×)”}”(hŒ0Typical usage of the OPP library is as follows::”h]”hŒ/Typical usage of the OPP library is as follows:”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´K7hjä  h²hubhŒliteral_block”“”)”}”(hŒÙ(users)        -> registers a set of default OPPs              -> (library)
SoC framework  -> modifies on required cases certain OPPs      -> OPP layer
               -> queries to search/retrieve information       ->”h]”hŒÙ(users)        -> registers a set of default OPPs              -> (library)
SoC framework  -> modifies on required cases certain OPPs      -> OPP layer
               -> queries to search/retrieve information       ->”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”j  j   uh1j  h³hÊh´K9hjä  h²hubh×)”}”(hX`  OPP layer expects each domain to be represented by a unique device pointer. SoC
framework registers a set of initial OPPs per device with the OPP layer. This
list is expected to be an optimally small number typically around 5 per device.
This initial list contains a set of OPPs that the framework expects to be safely
enabled by default in the system.”h]”hX`  OPP layer expects each domain to be represented by a unique device pointer. SoC
framework registers a set of initial OPPs per device with the OPP layer. This
list is expected to be an optimally small number typically around 5 per device.
This initial list contains a set of OPPs that the framework expects to be safely
enabled by default in the system.”…””}”(hj!  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´K=hjä  h²hubh¶)”}”(hhh]”(h»)”}”(hŒNote on OPP Availability”h]”hŒNote on OPP Availability”…””}”(hj2  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj/  h²hh³hÊh´KDubh×)”}”(hXp  As the system proceeds to operate, SoC framework may choose to make certain
OPPs available or not available on each device based on various external
factors. Example usage: Thermal management or other exceptional situations where
SoC framework might choose to disable a higher frequency OPP to safely continue
operations until that OPP could be re-enabled if possible.”h]”hXp  As the system proceeds to operate, SoC framework may choose to make certain
OPPs available or not available on each device based on various external
factors. Example usage: Thermal management or other exceptional situations where
SoC framework might choose to disable a higher frequency OPP to safely continue
operations until that OPP could be re-enabled if possible.”…””}”(hj@  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´KFhj/  h²hubh×)”}”(hŒêOPP library facilitates this concept in its implementation. The following
operational functions operate only on available opps:
dev_pm_opp_find_freq_{ceil, floor}, dev_pm_opp_get_voltage, dev_pm_opp_get_freq,
dev_pm_opp_get_opp_count.”h]”hŒêOPP library facilitates this concept in its implementation. The following
operational functions operate only on available opps:
dev_pm_opp_find_freq_{ceil, floor}, dev_pm_opp_get_voltage, dev_pm_opp_get_freq,
dev_pm_opp_get_opp_count.”…””}”(hjN  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´KLhj/  h²hubh×)”}”(hŒ«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
opp available as required.”h]”hŒ«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
opp available as required.”…””}”(hj\  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´KQhj/  h²hubh×)”}”(hX¿  WARNING: Users of OPP library should refresh their availability count using
get_opp_count if dev_pm_opp_enable/disable functions are invoked for a
device, the exact mechanism to trigger these or the notification mechanism
to other dependent subsystems such as cpufreq are left to the discretion of
the SoC specific framework which uses the OPP library. Similar care needs
to be taken care to refresh the cpufreq table in cases of these operations.”h]”hX¿  WARNING: Users of OPP library should refresh their availability count using
get_opp_count if dev_pm_opp_enable/disable functions are invoked for a
device, the exact mechanism to trigger these or the notification mechanism
to other dependent subsystems such as cpufreq are left to the discretion of
the SoC specific framework which uses the OPP library. Similar care needs
to be taken care to refresh the cpufreq table in cases of these operations.”…””}”(hjj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´KUhj/  h²hubeh}”(h]”Œnote-on-opp-availability”ah ]”h"]”Œnote on opp availability”ah$]”h&]”uh1hµhjä  h²hh³hÊh´KDubeh}”(h]”Œ$operating-performance-points-library”ah ]”h"]”Œ(1.2 operating performance points library”ah$]”h&]”uh1hµhj!  h²hh³hÊh´K.ubeh}”(h]”Œintroduction”ah ]”h"]”Œ1. introduction”ah$]”h&]”uh1hµhh·h²hh³hÊh´Kubh¶)”}”(hhh]”(h»)”}”(hŒ 2. Initial OPP List Registration”h]”hŒ 2. Initial OPP List Registration”…””}”(hj“  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj  h²hh³hÊh´K]ubh×)”}”(hX¾  The SoC implementation calls dev_pm_opp_add function iteratively to add OPPs per
device. It is expected that the SoC framework will register the OPP entries
optimally- typical numbers range to be less than 5. The list generated by
registering the OPPs is maintained by OPP library throughout the device
operation. The SoC framework can subsequently control the availability of the
OPPs dynamically using the dev_pm_opp_enable / disable functions.”h]”hX¾  The SoC implementation calls dev_pm_opp_add function iteratively to add OPPs per
device. It is expected that the SoC framework will register the OPP entries
optimally- typical numbers range to be less than 5. The list generated by
registering the OPPs is maintained by OPP library throughout the device
operation. The SoC framework can subsequently control the availability of the
OPPs dynamically using the dev_pm_opp_enable / disable functions.”…””}”(hj¡  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´K^hj  h²hubhŒdefinition_list”“”)”}”(hhh]”hŒdefinition_list_item”“”)”}”(hXX  dev_pm_opp_add
Add a new OPP for a specific domain represented by the device pointer.
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
with the dev_pm_opp_enable/disable functions. OPP library
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
as per the demands of SoC usage environment.

WARNING:
        Do not use this function in interrupt context.

Example::

 soc_pm_init()
 {
        /* Do things */
        r = dev_pm_opp_add(mpu_dev, 1000000, 900000);
        if (!r) {
                pr_err("%s: unable to register mpu opp(%d)\n", r);
                goto no_cpufreq;
        }
        /* Do cpufreq things */
 no_cpufreq:
        /* Do remaining things */
 }
”h]”(hŒterm”“”)”}”(hŒdev_pm_opp_add”h]”hŒdev_pm_opp_add”…””}”(hj¼  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jº  h³hÊh´K~hj¶  ubhŒ
definition”“”)”}”(hhh]”(h×)”}”(hXÉ  Add a new OPP for a specific domain represented by the device pointer.
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
with the dev_pm_opp_enable/disable functions. OPP library
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
as per the demands of SoC usage environment.”h]”hXÉ  Add a new OPP for a specific domain represented by the device pointer.
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
with the dev_pm_opp_enable/disable functions. OPP library
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
as per the demands of SoC usage environment.”…””}”(hjÏ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´KfhjÌ  ubj°  )”}”(hhh]”jµ  )”}”(hŒ8WARNING:
Do not use this function in interrupt context.
”h]”(j»  )”}”(hŒWARNING:”h]”hŒWARNING:”…””}”(hjä  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jº  h³hÊh´Kohjà  ubjË  )”}”(hhh]”h×)”}”(hŒ.Do not use this function in interrupt context.”h]”hŒ.Do not use this function in interrupt context.”…””}”(hjõ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´Kohjò  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÊ  hjà  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j´  h³hÊh´KohjÝ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¯  hjÌ  ubh×)”}”(hŒ	Example::”h]”hŒExample:”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´KqhjÌ  ubj  )”}”(hX%  soc_pm_init()
{
       /* Do things */
       r = dev_pm_opp_add(mpu_dev, 1000000, 900000);
       if (!r) {
               pr_err("%s: unable to register mpu opp(%d)\n", r);
               goto no_cpufreq;
       }
       /* Do cpufreq things */
no_cpufreq:
       /* Do remaining things */
}”h]”hX%  soc_pm_init()
{
       /* Do things */
       r = dev_pm_opp_add(mpu_dev, 1000000, 900000);
       if (!r) {
               pr_err("%s: unable to register mpu opp(%d)\n", r);
               goto no_cpufreq;
       }
       /* Do cpufreq things */
no_cpufreq:
       /* Do remaining things */
}”…””}”hj#  sbah}”(h]”h ]”h"]”h$]”h&]”j  j   uh1j  h³hÊh´KshjÌ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÊ  hj¶  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j´  h³hÊh´K~hj±  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¯  hj  h²hh³hÊh´Nubeh}”(h]”Œinitial-opp-list-registration”ah ]”h"]”Œ 2. initial opp list registration”ah$]”h&]”uh1hµhh·h²hh³hÊh´K]ubh¶)”}”(hhh]”(h»)”}”(hŒ3. OPP Search Functions”h]”hŒ3. OPP Search Functions”…””}”(hjN  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjK  h²hh³hÊh´Kubh×)”}”(hXÂ  High level framework such as cpufreq operates on frequencies. To map the
frequency back to the corresponding OPP, OPP library provides handy functions
to search the OPP list that OPP library internally manages. These search
functions return the matching pointer representing the opp if a match is
found, else returns error. These errors are expected to be handled by standard
error checks such as IS_ERR() and appropriate actions taken by the caller.”h]”hXÂ  High level framework such as cpufreq operates on frequencies. To map the
frequency back to the corresponding OPP, OPP library provides handy functions
to search the OPP list that OPP library internally manages. These search
functions return the matching pointer representing the opp if a match is
found, else returns error. These errors are expected to be handled by standard
error checks such as IS_ERR() and appropriate actions taken by the caller.”…””}”(hj\  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´K‚hjK  h²hubh×)”}”(hŒ¡Callers of these functions shall call dev_pm_opp_put() after they have used the
OPP. Otherwise the memory for the OPP will never get freed and result in
memleak.”h]”hŒ¡Callers of these functions shall call dev_pm_opp_put() after they have used the
OPP. Otherwise the memory for the OPP will never get freed and result in
memleak.”…””}”(hjj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´K‰hjK  h²hubj°  )”}”(hhh]”(jµ  )”}”(hX  dev_pm_opp_find_freq_exact
Search for an OPP based on an *exact* frequency and
availability. This function is especially useful to enable an OPP which
is not available by default.
Example: In a case when SoC framework detects a situation where a
higher frequency could be made available, it can use this function to
find the OPP prior to call the dev_pm_opp_enable to actually make
it available::

 opp = dev_pm_opp_find_freq_exact(dev, 1000000000, false);
 dev_pm_opp_put(opp);
 /* dont operate on the pointer.. just do a sanity check.. */
 if (IS_ERR(opp)) {
        pr_err("frequency not disabled!\n");
        /* trigger appropriate actions.. */
 } else {
        dev_pm_opp_enable(dev,1000000000);
 }

NOTE:
  This is the only search function that operates on OPPs which are
  not available.
”h]”(j»  )”}”(hŒdev_pm_opp_find_freq_exact”h]”hŒdev_pm_opp_find_freq_exact”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jº  h³hÊh´K¢hj{  ubjË  )”}”(hhh]”(h×)”}”(hXq  Search for an OPP based on an *exact* frequency and
availability. This function is especially useful to enable an OPP which
is not available by default.
Example: In a case when SoC framework detects a situation where a
higher frequency could be made available, it can use this function to
find the OPP prior to call the dev_pm_opp_enable to actually make
it available::”h]”(hŒSearch for an OPP based on an ”…””}”(hj  h²hh³Nh´NubhŒemphasis”“”)”}”(hŒ*exact*”h]”hŒexact”…””}”(hjš  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j˜  hj  ubhXK   frequency and
availability. This function is especially useful to enable an OPP which
is not available by default.
Example: In a case when SoC framework detects a situation where a
higher frequency could be made available, it can use this function to
find the OPP prior to call the dev_pm_opp_enable to actually make
it available:”…””}”(hj  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´KŽhj  ubj  )”}”(hX*  opp = dev_pm_opp_find_freq_exact(dev, 1000000000, false);
dev_pm_opp_put(opp);
/* dont operate on the pointer.. just do a sanity check.. */
if (IS_ERR(opp)) {
       pr_err("frequency not disabled!\n");
       /* trigger appropriate actions.. */
} else {
       dev_pm_opp_enable(dev,1000000000);
}”h]”hX*  opp = dev_pm_opp_find_freq_exact(dev, 1000000000, false);
dev_pm_opp_put(opp);
/* dont operate on the pointer.. just do a sanity check.. */
if (IS_ERR(opp)) {
       pr_err("frequency not disabled!\n");
       /* trigger appropriate actions.. */
} else {
       dev_pm_opp_enable(dev,1000000000);
}”…””}”hj²  sbah}”(h]”h ]”h"]”h$]”h&]”j  j   uh1j  h³hÊh´K–hj  ubj°  )”}”(hhh]”jµ  )”}”(hŒVNOTE:
This is the only search function that operates on OPPs which are
not available.
”h]”(j»  )”}”(hŒNOTE:”h]”hŒNOTE:”…””}”(hjÇ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jº  h³hÊh´K¢hjÃ  ubjË  )”}”(hhh]”h×)”}”(hŒOThis is the only search function that operates on OPPs which are
not available.”h]”hŒOThis is the only search function that operates on OPPs which are
not available.”…””}”(hjØ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´K¡hjÕ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÊ  hjÃ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j´  h³hÊh´K¢hjÀ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¯  hj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÊ  hj{  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j´  h³hÊh´K¢hjx  ubjµ  )”}”(hXl  dev_pm_opp_find_freq_floor
Search for an available OPP which is *at most* the
provided frequency. This function is useful while searching for a lesser
match OR operating on OPP information in the order of decreasing
frequency.
Example: To find the highest opp for a device::

 freq = ULONG_MAX;
 opp = dev_pm_opp_find_freq_floor(dev, &freq);
 dev_pm_opp_put(opp);
”h]”(j»  )”}”(hŒdev_pm_opp_find_freq_floor”h]”hŒdev_pm_opp_find_freq_floor”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jº  h³hÊh´K­hj  ubjË  )”}”(hhh]”(h×)”}”(hŒ÷Search for an available OPP which is *at most* the
provided frequency. This function is useful while searching for a lesser
match OR operating on OPP information in the order of decreasing
frequency.
Example: To find the highest opp for a device::”h]”(hŒ%Search for an available OPP which is ”…””}”(hj  h²hh³Nh´Nubj™  )”}”(hŒ	*at most*”h]”hŒat most”…””}”(hj!  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j˜  hj  ubhŒÈ the
provided frequency. This function is useful while searching for a lesser
match OR operating on OPP information in the order of decreasing
frequency.
Example: To find the highest opp for a device:”…””}”(hj  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´K¥hj  ubj  )”}”(hŒTfreq = ULONG_MAX;
opp = dev_pm_opp_find_freq_floor(dev, &freq);
dev_pm_opp_put(opp);”h]”hŒTfreq = ULONG_MAX;
opp = dev_pm_opp_find_freq_floor(dev, &freq);
dev_pm_opp_put(opp);”…””}”hj9  sbah}”(h]”h ]”h"]”h$]”h&]”j  j   uh1j  h³hÊh´K«hj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÊ  hj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j´  h³hÊh´K­hjx  h²hubjµ  )”}”(hX=  dev_pm_opp_find_freq_ceil
Search for an available OPP which is *at least* the
provided frequency. This function is useful while searching for a
higher match OR operating on OPP information in the order of increasing
frequency.
Example 1: To find the lowest opp for a device::

 freq = 0;
 opp = dev_pm_opp_find_freq_ceil(dev, &freq);
 dev_pm_opp_put(opp);

Example 2: A simplified implementation of a SoC cpufreq_driver->target::

 soc_cpufreq_target(..)
 {
        /* Do stuff like policy checks etc. */
        /* Find the best frequency match for the req */
        opp = dev_pm_opp_find_freq_ceil(dev, &freq);
        dev_pm_opp_put(opp);
        if (!IS_ERR(opp))
                soc_switch_to_freq_voltage(freq);
        else
                /* do something when we can't satisfy the req */
        /* do other stuff */
 }
”h]”(j»  )”}”(hŒdev_pm_opp_find_freq_ceil”h]”hŒdev_pm_opp_find_freq_ceil”…””}”(hjW  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jº  h³hÊh´KÇhjS  ubjË  )”}”(hhh]”(h×)”}”(hŒùSearch for an available OPP which is *at least* the
provided frequency. This function is useful while searching for a
higher match OR operating on OPP information in the order of increasing
frequency.
Example 1: To find the lowest opp for a device::”h]”(hŒ%Search for an available OPP which is ”…””}”(hjh  h²hh³Nh´Nubj™  )”}”(hŒ
*at least*”h]”hŒat least”…””}”(hjp  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j˜  hjh  ubhŒÉ the
provided frequency. This function is useful while searching for a
higher match OR operating on OPP information in the order of increasing
frequency.
Example 1: To find the lowest opp for a device:”…””}”(hjh  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´K°hje  ubj  )”}”(hŒKfreq = 0;
opp = dev_pm_opp_find_freq_ceil(dev, &freq);
dev_pm_opp_put(opp);”h]”hŒKfreq = 0;
opp = dev_pm_opp_find_freq_ceil(dev, &freq);
dev_pm_opp_put(opp);”…””}”hjˆ  sbah}”(h]”h ]”h"]”h$]”h&]”j  j   uh1j  h³hÊh´K¶hje  ubh×)”}”(hŒHExample 2: A simplified implementation of a SoC cpufreq_driver->target::”h]”hŒGExample 2: A simplified implementation of a SoC cpufreq_driver->target:”…””}”(hj–  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´Kºhje  ubj  )”}”(hX  soc_cpufreq_target(..)
{
       /* Do stuff like policy checks etc. */
       /* Find the best frequency match for the req */
       opp = dev_pm_opp_find_freq_ceil(dev, &freq);
       dev_pm_opp_put(opp);
       if (!IS_ERR(opp))
               soc_switch_to_freq_voltage(freq);
       else
               /* do something when we can't satisfy the req */
       /* do other stuff */
}”h]”hX  soc_cpufreq_target(..)
{
       /* Do stuff like policy checks etc. */
       /* Find the best frequency match for the req */
       opp = dev_pm_opp_find_freq_ceil(dev, &freq);
       dev_pm_opp_put(opp);
       if (!IS_ERR(opp))
               soc_switch_to_freq_voltage(freq);
       else
               /* do something when we can't satisfy the req */
       /* do other stuff */
}”…””}”hj¤  sbah}”(h]”h ]”h"]”h$]”h&]”j  j   uh1j  h³hÊh´K¼hje  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÊ  hjS  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j´  h³hÊh´KÇhjx  h²hubeh}”(h]”h ]”h"]”h$]”h&]”uh1j¯  hjK  h²hh³Nh´Nubeh}”(h]”Œopp-search-functions”ah ]”h"]”Œ3. opp search functions”ah$]”h&]”uh1hµhh·h²hh³hÊh´Kubh¶)”}”(hhh]”(h»)”}”(hŒ%4. OPP Availability Control Functions”h]”hŒ%4. OPP Availability Control Functions”…””}”(hjÏ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjÌ  h²hh³hÊh´KÊubh×)”}”(hXÏ  A default OPP list registered with the OPP library may not cater to all possible
situation. The OPP library provides a set of functions to modify the
availability of a OPP within the OPP list. This allows SoC frameworks to have
fine grained dynamic control of which sets of OPPs are operationally available.
These functions are intended to *temporarily* remove an OPP in conditions such
as thermal considerations (e.g. don't use OPPx until the temperature drops).”h]”(hXT  A default OPP list registered with the OPP library may not cater to all possible
situation. The OPP library provides a set of functions to modify the
availability of a OPP within the OPP list. This allows SoC frameworks to have
fine grained dynamic control of which sets of OPPs are operationally available.
These functions are intended to ”…””}”(hjÝ  h²hh³Nh´Nubj™  )”}”(hŒ*temporarily*”h]”hŒtemporarily”…””}”(hjå  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j˜  hjÝ  ubhŒp remove an OPP in conditions such
as thermal considerations (e.g. donâ€™t use OPPx until the temperature drops).”…””}”(hjÝ  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´KËhjÌ  h²hubj°  )”}”(hhh]”(jµ  )”}”(hŒ:WARNING:
Do not use these functions in interrupt context.
”h]”(j»  )”}”(hŒWARNING:”h]”hŒWARNING:”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jº  h³hÊh´KÓhj   ubjË  )”}”(hhh]”h×)”}”(hŒ0Do not use these functions in interrupt context.”h]”hŒ0Do not use these functions in interrupt context.”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´KÓhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÊ  hj   ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j´  h³hÊh´KÓhjý  ubjµ  )”}”(hXT  dev_pm_opp_enable
Make a OPP available for operation.
Example: Lets say that 1GHz OPP is to be made available only if the
SoC temperature is lower than a certain threshold. The SoC framework
implementation might choose to do something as follows::

 if (cur_temp < temp_low_thresh) {
        /* Enable 1GHz if it was disabled */
        opp = dev_pm_opp_find_freq_exact(dev, 1000000000, false);
        dev_pm_opp_put(opp);
        /* just error check */
        if (!IS_ERR(opp))
                ret = dev_pm_opp_enable(dev, 1000000000);
        else
                goto try_something_else;
 }
”h]”(j»  )”}”(hŒdev_pm_opp_enable”h]”hŒdev_pm_opp_enable”…””}”(hj3  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jº  h³hÊh´Kähj/  ubjË  )”}”(hhh]”(h×)”}”(hŒåMake a OPP available for operation.
Example: Lets say that 1GHz OPP is to be made available only if the
SoC temperature is lower than a certain threshold. The SoC framework
implementation might choose to do something as follows::”h]”hŒäMake a OPP available for operation.
Example: Lets say that 1GHz OPP is to be made available only if the
SoC temperature is lower than a certain threshold. The SoC framework
implementation might choose to do something as follows:”…””}”(hjD  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´KÖhjA  ubj  )”}”(hXP  if (cur_temp < temp_low_thresh) {
       /* Enable 1GHz if it was disabled */
       opp = dev_pm_opp_find_freq_exact(dev, 1000000000, false);
       dev_pm_opp_put(opp);
       /* just error check */
       if (!IS_ERR(opp))
               ret = dev_pm_opp_enable(dev, 1000000000);
       else
               goto try_something_else;
}”h]”hXP  if (cur_temp < temp_low_thresh) {
       /* Enable 1GHz if it was disabled */
       opp = dev_pm_opp_find_freq_exact(dev, 1000000000, false);
       dev_pm_opp_put(opp);
       /* just error check */
       if (!IS_ERR(opp))
               ret = dev_pm_opp_enable(dev, 1000000000);
       else
               goto try_something_else;
}”…””}”hjR  sbah}”(h]”h ]”h"]”h$]”h&]”j  j   uh1j  h³hÊh´KÛhjA  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÊ  hj/  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j´  h³hÊh´Kähjý  h²hubjµ  )”}”(hXI  dev_pm_opp_disable
Make an OPP to be not available for operation
Example: Lets say that 1GHz OPP is to be disabled if the temperature
exceeds a threshold value. The SoC framework implementation might
choose to do something as follows::

 if (cur_temp > temp_high_thresh) {
        /* Disable 1GHz if it was enabled */
        opp = dev_pm_opp_find_freq_exact(dev, 1000000000, true);
        dev_pm_opp_put(opp);
        /* just error check */
        if (!IS_ERR(opp))
                ret = dev_pm_opp_disable(dev, 1000000000);
        else
                goto try_something_else;
 }
”h]”(j»  )”}”(hŒdev_pm_opp_disable”h]”hŒdev_pm_opp_disable”…””}”(hjp  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jº  h³hÊh´Kõhjl  ubjË  )”}”(hhh]”(h×)”}”(hŒØMake an OPP to be not available for operation
Example: Lets say that 1GHz OPP is to be disabled if the temperature
exceeds a threshold value. The SoC framework implementation might
choose to do something as follows::”h]”hŒ×Make an OPP to be not available for operation
Example: Lets say that 1GHz OPP is to be disabled if the temperature
exceeds a threshold value. The SoC framework implementation might
choose to do something as follows:”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´Kçhj~  ubj  )”}”(hXQ  if (cur_temp > temp_high_thresh) {
       /* Disable 1GHz if it was enabled */
       opp = dev_pm_opp_find_freq_exact(dev, 1000000000, true);
       dev_pm_opp_put(opp);
       /* just error check */
       if (!IS_ERR(opp))
               ret = dev_pm_opp_disable(dev, 1000000000);
       else
               goto try_something_else;
}”h]”hXQ  if (cur_temp > temp_high_thresh) {
       /* Disable 1GHz if it was enabled */
       opp = dev_pm_opp_find_freq_exact(dev, 1000000000, true);
       dev_pm_opp_put(opp);
       /* just error check */
       if (!IS_ERR(opp))
               ret = dev_pm_opp_disable(dev, 1000000000);
       else
               goto try_something_else;
}”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”j  j   uh1j  h³hÊh´Kìhj~  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÊ  hjl  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j´  h³hÊh´Kõhjý  h²hubeh}”(h]”h ]”h"]”h$]”h&]”uh1j¯  hjÌ  h²hh³hÊh´Nubeh}”(h]”Œ"opp-availability-control-functions”ah ]”h"]”Œ%4. opp availability control functions”ah$]”h&]”uh1hµhh·h²hh³hÊh´KÊubh¶)”}”(hhh]”(h»)”}”(hŒ5. OPP Data Retrieval Functions”h]”hŒ5. OPP Data Retrieval Functions”…””}”(hjº  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj·  h²hh³hÊh´Køubh×)”}”(hX8  Since OPP library abstracts away the OPP information, a set of functions to pull
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
framework to retrieve the information represented inside the OPP layer.”h]”hX8  Since OPP library abstracts away the OPP information, a set of functions to pull
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
framework to retrieve the information represented inside the OPP layer.”…””}”(hjÈ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´Kùhj·  h²hubj°  )”}”(hhh]”(jµ  )”}”(hX2  dev_pm_opp_get_voltage
Retrieve the voltage represented by the opp pointer.
Example: At a cpufreq transition to a different frequency, SoC
framework requires to set the voltage represented by the OPP using
the regulator framework to the Power Management chip providing the
voltage::

 soc_switch_to_freq_voltage(freq)
 {
        /* do things */
        opp = dev_pm_opp_find_freq_ceil(dev, &freq);
        v = dev_pm_opp_get_voltage(opp);
        dev_pm_opp_put(opp);
        if (v)
                regulator_set_voltage(.., v);
        /* do other things */
 }
”h]”(j»  )”}”(hŒdev_pm_opp_get_voltage”h]”hŒdev_pm_opp_get_voltage”…””}”(hjÝ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jº  h³hÊh´MhjÙ  ubjË  )”}”(hhh]”(h×)”}”(hX  Retrieve the voltage represented by the opp pointer.
Example: At a cpufreq transition to a different frequency, SoC
framework requires to set the voltage represented by the OPP using
the regulator framework to the Power Management chip providing the
voltage::”h]”hX  Retrieve the voltage represented by the opp pointer.
Example: At a cpufreq transition to a different frequency, SoC
framework requires to set the voltage represented by the OPP using
the regulator framework to the Power Management chip providing the
voltage:”…””}”(hjî  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´Kÿhjë  ubj  )”}”(hX  soc_switch_to_freq_voltage(freq)
{
       /* do things */
       opp = dev_pm_opp_find_freq_ceil(dev, &freq);
       v = dev_pm_opp_get_voltage(opp);
       dev_pm_opp_put(opp);
       if (v)
               regulator_set_voltage(.., v);
       /* do other things */
}”h]”hX  soc_switch_to_freq_voltage(freq)
{
       /* do things */
       opp = dev_pm_opp_find_freq_ceil(dev, &freq);
       v = dev_pm_opp_get_voltage(opp);
       dev_pm_opp_put(opp);
       if (v)
               regulator_set_voltage(.., v);
       /* do other things */
}”…””}”hjü  sbah}”(h]”h ]”h"]”h$]”h&]”j  j   uh1j  h³hÊh´Mhjë  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÊ  hjÙ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j´  h³hÊh´MhjÖ  ubjµ  )”}”(hXË  dev_pm_opp_get_freq
Retrieve the freq represented by the opp pointer.
Example: Lets say the SoC framework uses a couple of helper functions
we could pass opp pointers instead of doing additional parameters to
handle quiet a bit of data parameters::

 soc_cpufreq_target(..)
 {
        /* do things.. */
         max_freq = ULONG_MAX;
         max_opp = dev_pm_opp_find_freq_floor(dev,&max_freq);
         requested_opp = dev_pm_opp_find_freq_ceil(dev,&freq);
         if (!IS_ERR(max_opp) && !IS_ERR(requested_opp))
                r = soc_test_validity(max_opp, requested_opp);
         dev_pm_opp_put(max_opp);
         dev_pm_opp_put(requested_opp);
        /* do other things */
 }
 soc_test_validity(..)
 {
         if(dev_pm_opp_get_voltage(max_opp) < dev_pm_opp_get_voltage(requested_opp))
                 return -EINVAL;
         if(dev_pm_opp_get_freq(max_opp) < dev_pm_opp_get_freq(requested_opp))
                 return -EINVAL;
        /* do things.. */
 }
”h]”(j»  )”}”(hŒdev_pm_opp_get_freq”h]”hŒdev_pm_opp_get_freq”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jº  h³hÊh´M)hj  ubjË  )”}”(hhh]”(h×)”}”(hŒäRetrieve the freq represented by the opp pointer.
Example: Lets say the SoC framework uses a couple of helper functions
we could pass opp pointers instead of doing additional parameters to
handle quiet a bit of data parameters::”h]”hŒãRetrieve the freq represented by the opp pointer.
Example: Lets say the SoC framework uses a couple of helper functions
we could pass opp pointers instead of doing additional parameters to
handle quiet a bit of data parameters:”…””}”(hj+  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´Mhj(  ubj  )”}”(hX¼  soc_cpufreq_target(..)
{
       /* do things.. */
        max_freq = ULONG_MAX;
        max_opp = dev_pm_opp_find_freq_floor(dev,&max_freq);
        requested_opp = dev_pm_opp_find_freq_ceil(dev,&freq);
        if (!IS_ERR(max_opp) && !IS_ERR(requested_opp))
               r = soc_test_validity(max_opp, requested_opp);
        dev_pm_opp_put(max_opp);
        dev_pm_opp_put(requested_opp);
       /* do other things */
}
soc_test_validity(..)
{
        if(dev_pm_opp_get_voltage(max_opp) < dev_pm_opp_get_voltage(requested_opp))
                return -EINVAL;
        if(dev_pm_opp_get_freq(max_opp) < dev_pm_opp_get_freq(requested_opp))
                return -EINVAL;
       /* do things.. */
}”h]”hX¼  soc_cpufreq_target(..)
{
       /* do things.. */
        max_freq = ULONG_MAX;
        max_opp = dev_pm_opp_find_freq_floor(dev,&max_freq);
        requested_opp = dev_pm_opp_find_freq_ceil(dev,&freq);
        if (!IS_ERR(max_opp) && !IS_ERR(requested_opp))
               r = soc_test_validity(max_opp, requested_opp);
        dev_pm_opp_put(max_opp);
        dev_pm_opp_put(requested_opp);
       /* do other things */
}
soc_test_validity(..)
{
        if(dev_pm_opp_get_voltage(max_opp) < dev_pm_opp_get_voltage(requested_opp))
                return -EINVAL;
        if(dev_pm_opp_get_freq(max_opp) < dev_pm_opp_get_freq(requested_opp))
                return -EINVAL;
       /* do things.. */
}”…””}”hj9  sbah}”(h]”h ]”h"]”h$]”h&]”j  j   uh1j  h³hÊh´Mhj(  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÊ  hj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j´  h³hÊh´M)hjÖ  h²hubjµ  )”}”(hX
  dev_pm_opp_get_opp_count
Retrieve the number of available opps for a device
Example: Lets say a co-processor in the SoC needs to know the available
frequencies in a table, the main processor can notify as following::

 soc_notify_coproc_available_frequencies()
 {
        /* Do things */
        num_available = dev_pm_opp_get_opp_count(dev);
        speeds = kcalloc(num_available, sizeof(u32), GFP_KERNEL);
        /* populate the table in increasing order */
        freq = 0;
        while (!IS_ERR(opp = dev_pm_opp_find_freq_ceil(dev, &freq))) {
                speeds[i] = freq;
                freq++;
                i++;
                dev_pm_opp_put(opp);
        }

        soc_notify_coproc(AVAILABLE_FREQs, speeds, num_available);
        /* Do other things */
 }
”h]”(j»  )”}”(hŒdev_pm_opp_get_opp_count”h]”hŒdev_pm_opp_get_opp_count”…””}”(hjW  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jº  h³hÊh´M@hjS  ubjË  )”}”(hhh]”(h×)”}”(hŒ¿Retrieve the number of available opps for a device
Example: Lets say a co-processor in the SoC needs to know the available
frequencies in a table, the main processor can notify as following::”h]”hŒ¾Retrieve the number of available opps for a device
Example: Lets say a co-processor in the SoC needs to know the available
frequencies in a table, the main processor can notify as following:”…””}”(hjh  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´M,hje  ubj  )”}”(hX  soc_notify_coproc_available_frequencies()
{
       /* Do things */
       num_available = dev_pm_opp_get_opp_count(dev);
       speeds = kcalloc(num_available, sizeof(u32), GFP_KERNEL);
       /* populate the table in increasing order */
       freq = 0;
       while (!IS_ERR(opp = dev_pm_opp_find_freq_ceil(dev, &freq))) {
               speeds[i] = freq;
               freq++;
               i++;
               dev_pm_opp_put(opp);
       }

       soc_notify_coproc(AVAILABLE_FREQs, speeds, num_available);
       /* Do other things */
}”h]”hX  soc_notify_coproc_available_frequencies()
{
       /* Do things */
       num_available = dev_pm_opp_get_opp_count(dev);
       speeds = kcalloc(num_available, sizeof(u32), GFP_KERNEL);
       /* populate the table in increasing order */
       freq = 0;
       while (!IS_ERR(opp = dev_pm_opp_find_freq_ceil(dev, &freq))) {
               speeds[i] = freq;
               freq++;
               i++;
               dev_pm_opp_put(opp);
       }

       soc_notify_coproc(AVAILABLE_FREQs, speeds, num_available);
       /* Do other things */
}”…””}”hjv  sbah}”(h]”h ]”h"]”h$]”h&]”j  j   uh1j  h³hÊh´M0hje  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÊ  hjS  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j´  h³hÊh´M@hjÖ  h²hubeh}”(h]”h ]”h"]”h$]”h&]”uh1j¯  hj·  h²hh³hÊh´Nubeh}”(h]”Œopp-data-retrieval-functions”ah ]”h"]”Œ5. opp data retrieval functions”ah$]”h&]”uh1hµhh·h²hh³hÊh´Køubh¶)”}”(hhh]”(h»)”}”(hŒ6. Data Structures”h]”hŒ6. Data Structures”…””}”(hj¡  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjž  h²hh³hÊh´MCubh×)”}”(hŒ®Typically an SoC contains multiple voltage domains which are variable. Each
domain is represented by a device pointer. The relationship to OPP can be
represented as follows::”h]”hŒ­Typically an SoC contains multiple voltage domains which are variable. Each
domain is represented by a device pointer. The relationship to OPP can be
represented as follows:”…””}”(hj¯  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´MDhjž  h²hubj  )”}”(hŒŠSoC
 |- device 1
 |    |- opp 1 (availability, freq, voltage)
 |    |- opp 2 ..
 ...  ...
 |    `- opp n ..
 |- device 2
 ...
 `- device m”h]”hŒŠSoC
 |- device 1
 |    |- opp 1 (availability, freq, voltage)
 |    |- opp 2 ..
 ...  ...
 |    `- opp n ..
 |- device 2
 ...
 `- device m”…””}”hj½  sbah}”(h]”h ]”h"]”h$]”h&]”j  j   uh1j  h³hÊh´MHhjž  h²hubh×)”}”(hX  OPP library maintains a internal list that the SoC framework populates and
accessed by various functions as described above. However, the structures
representing the actual OPPs and domains are internal to the OPP library itself
to allow for suitable abstraction reusable across systems.”h]”hX  OPP library maintains a internal list that the SoC framework populates and
accessed by various functions as described above. However, the structures
representing the actual OPPs and domains are internal to the OPP library itself
to allow for suitable abstraction reusable across systems.”…””}”(hjË  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´MRhjž  h²hubj°  )”}”(hhh]”(jµ  )”}”(hXˆ  struct dev_pm_opp
The internal data structure of OPP library which is used to
represent an OPP. In addition to the freq, voltage, availability
information, it also contains internal book keeping information required
for the OPP library to operate on.  Pointer to this structure is
provided back to the users such as SoC framework to be used as a
identifier for OPP in the interactions with OPP layer.

WARNING:
  The struct dev_pm_opp pointer should not be parsed or modified by the
  users. The defaults of for an instance is populated by
  dev_pm_opp_add, but the availability of the OPP can be modified
  by dev_pm_opp_enable/disable functions.
”h]”(j»  )”}”(hŒstruct dev_pm_opp”h]”hŒstruct dev_pm_opp”…””}”(hjà  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jº  h³hÊh´MchjÜ  ubjË  )”}”(hhh]”(h×)”}”(hX~  The internal data structure of OPP library which is used to
represent an OPP. In addition to the freq, voltage, availability
information, it also contains internal book keeping information required
for the OPP library to operate on.  Pointer to this structure is
provided back to the users such as SoC framework to be used as a
identifier for OPP in the interactions with OPP layer.”h]”hX~  The internal data structure of OPP library which is used to
represent an OPP. In addition to the freq, voltage, availability
information, it also contains internal book keeping information required
for the OPP library to operate on.  Pointer to this structure is
provided back to the users such as SoC framework to be used as a
identifier for OPP in the interactions with OPP layer.”…””}”(hjñ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´MXhjî  ubj°  )”}”(hhh]”jµ  )”}”(hŒîWARNING:
The struct dev_pm_opp pointer should not be parsed or modified by the
users. The defaults of for an instance is populated by
dev_pm_opp_add, but the availability of the OPP can be modified
by dev_pm_opp_enable/disable functions.
”h]”(j»  )”}”(hŒWARNING:”h]”hŒWARNING:”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jº  h³hÊh´Mchj  ubjË  )”}”(hhh]”h×)”}”(hŒäThe struct dev_pm_opp pointer should not be parsed or modified by the
users. The defaults of for an instance is populated by
dev_pm_opp_add, but the availability of the OPP can be modified
by dev_pm_opp_enable/disable functions.”h]”hŒäThe struct dev_pm_opp pointer should not be parsed or modified by the
users. The defaults of for an instance is populated by
dev_pm_opp_add, but the availability of the OPP can be modified
by dev_pm_opp_enable/disable functions.”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´M`hj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÊ  hj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j´  h³hÊh´Mchjÿ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¯  hjî  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÊ  hjÜ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j´  h³hÊh´MchjÙ  ubjµ  )”}”(hŒ°struct device
This is used to identify a domain to the OPP layer. The
nature of the device and its implementation is left to the user of
OPP library such as the SoC framework.
”h]”(j»  )”}”(hŒstruct device”h]”hŒstruct device”…””}”(hjG  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jº  h³hÊh´MhhjC  ubjË  )”}”(hhh]”h×)”}”(hŒ¡This is used to identify a domain to the OPP layer. The
nature of the device and its implementation is left to the user of
OPP library such as the SoC framework.”h]”hŒ¡This is used to identify a domain to the OPP layer. The
nature of the device and its implementation is left to the user of
OPP library such as the SoC framework.”…””}”(hjX  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´MfhjU  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÊ  hjC  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j´  h³hÊh´MhhjÙ  h²hubeh}”(h]”h ]”h"]”h$]”h&]”uh1j¯  hjž  h²hh³Nh´Nubh×)”}”(hŒZOverall, in a simplistic view, the data structure operations is represented as
following::”h]”hŒYOverall, in a simplistic view, the data structure operations is represented as
following:”…””}”(hjx  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖh³hÊh´Mjhjž  h²hubj  )”}”(hX  Initialization / modification:
            +-----+        /- dev_pm_opp_enable
dev_pm_opp_add --> | opp | <-------
  |         +-----+        \- dev_pm_opp_disable
  \-------> domain_info(device)

Search functions:
             /-- dev_pm_opp_find_freq_ceil  ---\   +-----+
domain_info<---- dev_pm_opp_find_freq_exact -----> | opp |
             \-- dev_pm_opp_find_freq_floor ---/   +-----+

Retrieval functions:
+-----+     /- dev_pm_opp_get_voltage
| opp | <---
+-----+     \- dev_pm_opp_get_freq

domain_info <- dev_pm_opp_get_opp_count”h]”hX  Initialization / modification:
            +-----+        /- dev_pm_opp_enable
dev_pm_opp_add --> | opp | <-------
  |         +-----+        \- dev_pm_opp_disable
  \-------> domain_info(device)

Search functions:
             /-- dev_pm_opp_find_freq_ceil  ---\   +-----+
domain_info<---- dev_pm_opp_find_freq_exact -----> | opp |
             \-- dev_pm_opp_find_freq_floor ---/   +-----+

Retrieval functions:
+-----+     /- dev_pm_opp_get_voltage
| opp | <---
+-----+     \- dev_pm_opp_get_freq

domain_info <- dev_pm_opp_get_opp_count”…””}”hj†  sbah}”(h]”h ]”h"]”h$]”h&]”j  j   uh1j  h³hÊh´Mmhjž  h²hubeh}”(h]”Œdata-structures”ah ]”h"]”Œ6. data structures”ah$]”h&]”uh1hµhh·h²hh³hÊh´MCubeh}”(h]”Œ(operating-performance-points-opp-library”ah ]”h"]”Œ*operating performance points (opp) library”ah$]”h&]”uh1hµhhh²hh³hÊh´Kubeh}”(h]”h ]”h"]”h$]”h&]”Œsource”hÊuh1hŒcurrent_source”NŒcurrent_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(hºNŒ	generator”NŒ	datestamp”NŒsource_link”NŒ
source_url”NŒtoc_backlinks”Œentry”Œfootnote_backlinks”KŒsectnum_xform”KŒstrip_comments”NŒstrip_elements_with_classes”NŒstrip_classes”NŒreport_level”KŒ
halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ	traceback”ˆŒinput_encoding”Œ	utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”jÇ  Œerror_encoding”Œutf-8”Œerror_encoding_error_handler”Œbackslashreplace”Œlanguage_code”Œen”Œrecord_dependencies”NŒconfig”NŒ	id_prefix”hŒauto_id_prefix”Œid”Œdump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”hÊŒ_destination”NŒ_config_files”]”Œ7/var/lib/git/docbuild/linux/Documentation/docutils.conf”aŒfile_insertion_enabled”ˆŒraw_enabled”KŒline_length_limit”M'Œpep_references”NŒpep_base_url”Œhttps://peps.python.org/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒrfc_base_url”Œ&https://datatracker.ietf.org/doc/html/”Œ	tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œsmart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œdocinfo_xform”KŒsectsubtitle_xform”‰Œimage_loading”Œlink”Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒsection_self_link”‰Œenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”Œnameids”}”(j¡  jž  j  jŠ  já  jÞ  j…  j‚  j}  jz  jH  jE  jÉ  jÆ  j´  j±  j›  j˜  j™  j–  uŒ	nametypes”}”(j¡  ‰j  ‰já  ‰j…  ‰j}  ‰jH  ‰jÉ  ‰j´  ‰j›  ‰j™  ‰uh}”(jž  h·jŠ  j!  jÞ  j2  j‚  jä  jz  j/  jE  j  jÆ  jK  j±  jÌ  j˜  j·  j–  jž  uŒfootnote_refs”}”Œcitation_refs”}”Œautofootnotes”]”Œautofootnote_refs”]”Œsymbol_footnotes”]”Œsymbol_footnote_refs”]”Œ	footnotes”]”Œ	citations”]”Œautofootnote_start”KŒsymbol_footnote_start”K Œ
id_counter”Œcollections”ŒCounter”“”}”…”R”Œparse_messages”]”hŒsystem_message”“”)”}”(hhh]”h×)”}”(hŒ:Enumerated list start value not ordinal-1: "C" (ordinal 3)”h]”hŒ>Enumerated list start value not ordinal-1: â€œCâ€ (ordinal 3)”…””}”(hj.  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÖhj+  ubah}”(h]”h ]”h"]”h$]”h&]”Œlevel”KŒtype”ŒINFO”Œsource”hÊŒline”Kuh1j)  hh·h²hh³hÊh´KubaŒtransform_messages”]”Œtransformer”NŒinclude_log”]”Œ
decoration”Nh²hub.