€•Ÿˆ      Œ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/regulator/consumer”Œ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/regulator/consumer”Œ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/regulator/consumer”Œ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/regulator/consumer”Œ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/regulator/consumer”Œ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/regulator/consumer”Œ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Œ#Regulator Consumer Driver Interface”h]”hŒ#Regulator Consumer Driver Interface”…””}”(hh¨hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hh£hžhhŸŒF/var/lib/git/docbuild/linux/Documentation/power/regulator/consumer.rst”h KubhŒ	paragraph”“”)”}”(hŒ’This text describes the regulator interface for consumer device drivers.
Please see overview.txt for a description of the terms used in this text.”h]”hŒ’This text describes the regulator interface for consumer device drivers.
Please see overview.txt for a description of the terms used in this text.”…””}”(hh¹hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Khh£hžhubh¢)”}”(hhh]”(h§)”}”(hŒ71. Consumer Regulator Access (static & dynamic drivers)”h]”hŒ71. Consumer Regulator Access (static & dynamic drivers)”…””}”(hhÊhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hhÇhžhhŸh¶h K
ubh¸)”}”(hŒFA consumer driver can get access to its supply regulator by calling ::”h]”hŒCA consumer driver can get access to its supply regulator by calling”…””}”(hhØhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KhhÇhžhubhŒliteral_block”“”)”}”(hŒ&regulator = regulator_get(dev, "Vcc");”h]”hŒ&regulator = regulator_get(dev, "Vcc");”…””}”hhèsbah}”(h]”h ]”h"]”h$]”h&]”Œ	xml:space”Œpreserve”uh1hæhŸh¶h KhhÇhžhubh¸)”}”(hX  The consumer passes in its struct device pointer and power supply ID. The core
then finds the correct regulator by consulting a machine specific lookup table.
If the lookup is successful then this call will return a pointer to the struct
regulator that supplies this consumer.”h]”hX  The consumer passes in its struct device pointer and power supply ID. The core
then finds the correct regulator by consulting a machine specific lookup table.
If the lookup is successful then this call will return a pointer to the struct
regulator that supplies this consumer.”…””}”(hhøhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KhhÇhžhubh¸)”}”(hŒ;To release the regulator the consumer driver should call ::”h]”hŒ8To release the regulator the consumer driver should call”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KhhÇhžhubhç)”}”(hŒregulator_put(regulator);”h]”hŒregulator_put(regulator);”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”höh÷uh1hæhŸh¶h KhhÇhžhubh¸)”}”(hŒˆConsumers can be supplied by more than one regulator e.g. codec consumer with
analog and digital supplies by means of bulk operations ::”h]”hŒ…Consumers can be supplied by more than one regulator e.g. codec consumer with
analog and digital supplies by means of bulk operations”…””}”(hj"  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KhhÇhžhubhç)”}”(hX<  struct regulator_bulk_data supplies[2];

supplies[0].supply = "Vcc"; /* digital core */
supplies[1].supply = "Avdd"; /* analog */

ret = regulator_bulk_get(dev, ARRAY_SIZE(supplies), supplies);

// convenience helper to call regulator_put() on multiple regulators
regulator_bulk_free(ARRAY_SIZE(supplies), supplies);”h]”hX<  struct regulator_bulk_data supplies[2];

supplies[0].supply = "Vcc"; /* digital core */
supplies[1].supply = "Avdd"; /* analog */

ret = regulator_bulk_get(dev, ARRAY_SIZE(supplies), supplies);

// convenience helper to call regulator_put() on multiple regulators
regulator_bulk_free(ARRAY_SIZE(supplies), supplies);”…””}”hj0  sbah}”(h]”h ]”h"]”h$]”h&]”höh÷uh1hæhŸh¶h KhhÇhžhubh¸)”}”(hŒ“The regulator access functions regulator_get() and regulator_put() will
usually be called in your device drivers probe() and remove() respectively.”h]”hŒ“The regulator access functions regulator_get() and regulator_put() will
usually be called in your device drivers probe() and remove() respectively.”…””}”(hj>  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K'hhÇhžhubeh}”(h]”Œ0consumer-regulator-access-static-dynamic-drivers”ah ]”h"]”Œ71. consumer regulator access (static & dynamic drivers)”ah$]”h&]”uh1h¡hh£hžhhŸh¶h K
ubh¢)”}”(hhh]”(h§)”}”(hŒ?2. Regulator Output Enable & Disable (static & dynamic drivers)”h]”hŒ?2. Regulator Output Enable & Disable (static & dynamic drivers)”…””}”(hjW  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hjT  hžhhŸh¶h K,ubh¸)”}”(hŒ3A consumer can enable its power supply by calling::”h]”hŒ2A consumer can enable its power supply by calling:”…””}”(hje  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K/hjT  hžhubhç)”}”(hŒ int regulator_enable(regulator);”h]”hŒ int regulator_enable(regulator);”…””}”hjs  sbah}”(h]”h ]”h"]”h$]”h&]”höh÷uh1hæhŸh¶h K1hjT  hžhubhŒdefinition_list”“”)”}”(hhh]”hŒdefinition_list_item”“”)”}”(hŒâNOTE:
The supply may already be enabled before regulator_enable() is called.
This may happen if the consumer shares the regulator or the regulator has been
previously enabled by bootloader or kernel board initialization code.
”h]”(hŒterm”“”)”}”(hŒNOTE:”h]”hŒNOTE:”…””}”(hjŽ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jŒ  hŸh¶h K6hjˆ  ubhŒ
definition”“”)”}”(hhh]”h¸)”}”(hŒÛThe supply may already be enabled before regulator_enable() is called.
This may happen if the consumer shares the regulator or the regulator has been
previously enabled by bootloader or kernel board initialization code.”h]”hŒÛThe supply may already be enabled before regulator_enable() is called.
This may happen if the consumer shares the regulator or the regulator has been
previously enabled by bootloader or kernel board initialization code.”…””}”(hj¡  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K4hjž  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jœ  hjˆ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j†  hŸh¶h K6hjƒ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j  hjT  hžhhŸh¶h Nubh¸)”}”(hŒ?A consumer can determine if a regulator is enabled by calling::”h]”hŒ>A consumer can determine if a regulator is enabled by calling:”…””}”(hjÁ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K8hjT  hžhubhç)”}”(hŒ$int regulator_is_enabled(regulator);”h]”hŒ$int regulator_is_enabled(regulator);”…””}”hjÏ  sbah}”(h]”h ]”h"]”h$]”h&]”höh÷uh1hæhŸh¶h K:hjT  hžhubh¸)”}”(hŒ6This will return > zero when the regulator is enabled.”h]”hŒ6This will return > zero when the regulator is enabled.”…””}”(hjÝ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K<hjT  hžhubh¸)”}”(hŒBA set of regulators can be enabled with a single bulk operation ::”h]”hŒ?A set of regulators can be enabled with a single bulk operation”…””}”(hjë  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K>hjT  hžhubhç)”}”(hŒnint regulator_bulk_enable(int num_consumers,
                          struct regulator_bulk_data *consumers);”h]”hŒnint regulator_bulk_enable(int num_consumers,
                          struct regulator_bulk_data *consumers);”…””}”hjù  sbah}”(h]”h ]”h"]”h$]”h&]”höh÷uh1hæhŸh¶h K@hjT  hžhubh¸)”}”(hŒDA consumer can disable its supply when no longer needed by calling::”h]”hŒCA consumer can disable its supply when no longer needed by calling:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KDhjT  hžhubhç)”}”(hŒ!int regulator_disable(regulator);”h]”hŒ!int regulator_disable(regulator);”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”höh÷uh1hæhŸh¶h KFhjT  hžhubh¸)”}”(hŒOr a number of them ::”h]”hŒOr a number of them”…””}”(hj#  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KHhjT  hžhubhç)”}”(hŒpint regulator_bulk_disable(int num_consumers,
                           struct regulator_bulk_data *consumers);”h]”hŒpint regulator_bulk_disable(int num_consumers,
                           struct regulator_bulk_data *consumers);”…””}”hj1  sbah}”(h]”h ]”h"]”h$]”h&]”höh÷uh1hæhŸh¶h KJhjT  hžhubj‚  )”}”(hhh]”j‡  )”}”(hŒ™NOTE:
This may not disable the supply if it's shared with other consumers. The
regulator will only be disabled when the enabled reference count is zero.
”h]”(j  )”}”(hŒNOTE:”h]”hŒNOTE:”…””}”(hjF  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jŒ  hŸh¶h KOhjB  ubj  )”}”(hhh]”h¸)”}”(hŒ’This may not disable the supply if it's shared with other consumers. The
regulator will only be disabled when the enabled reference count is zero.”h]”hŒ”This may not disable the supply if itâ€™s shared with other consumers. The
regulator will only be disabled when the enabled reference count is zero.”…””}”(hjW  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KNhjT  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jœ  hjB  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j†  hŸh¶h KOhj?  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j  hjT  hžhhŸh¶h Nubh¸)”}”(hŒMFinally, a regulator can be forcefully disabled in the case of an emergency::”h]”hŒLFinally, a regulator can be forcefully disabled in the case of an emergency:”…””}”(hjw  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KQhjT  hžhubhç)”}”(hŒ'int regulator_force_disable(regulator);”h]”hŒ'int regulator_force_disable(regulator);”…””}”hj…  sbah}”(h]”h ]”h"]”h$]”h&]”höh÷uh1hæhŸh¶h KShjT  hžhubh¸)”}”(hŒ;This operation is also supported for multiple regulators ::”h]”hŒ8This operation is also supported for multiple regulators”…””}”(hj“  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KUhjT  hžhubhç)”}”(hŒ|int regulator_bulk_force_disable(int num_consumers,
                                 struct regulator_bulk_data *consumers);”h]”hŒ|int regulator_bulk_force_disable(int num_consumers,
                                 struct regulator_bulk_data *consumers);”…””}”hj¡  sbah}”(h]”h ]”h"]”h$]”h&]”höh÷uh1hæhŸh¶h KWhjT  hžhubj‚  )”}”(hhh]”j‡  )”}”(hŒmNOTE:
this will immediately and forcefully shutdown the regulator output. All
consumers will be powered off.
”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Œfthis will immediately and forcefully shutdown the regulator output. All
consumers will be powered off.”h]”hŒfthis will immediately and forcefully shutdown the regulator output. All
consumers will be powered off.”…””}”(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jT  hžhhŸh¶h Nubeh}”(h]”Œ6regulator-output-enable-disable-static-dynamic-drivers”ah ]”h"]”Œ?2. regulator output enable & disable (static & dynamic drivers)”ah$]”h&]”uh1h¡hh£hžhhŸh¶h K,ubh¢)”}”(hhh]”(h§)”}”(hŒ73. Regulator Voltage Control & Status (dynamic drivers)”h]”hŒ73. Regulator Voltage Control & Status (dynamic drivers)”…””}”(hjò  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hjï  hžhhŸh¶h K_ubh¸)”}”(hŒúSome consumer drivers need to be able to dynamically change their supply
voltage to match system operating points. e.g. CPUfreq drivers can scale
voltage along with frequency to save power, SD drivers may need to select the
correct card voltage, etc.”h]”hŒúSome consumer drivers need to be able to dynamically change their supply
voltage to match system operating points. e.g. CPUfreq drivers can scale
voltage along with frequency to save power, SD drivers may need to select the
correct card voltage, etc.”…””}”(hj   hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kahjï  hžhubh¸)”}”(hŒ7Consumers can control their supply voltage by calling::”h]”hŒ6Consumers can control their supply voltage by calling:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kfhjï  hžhubhç)”}”(hŒ5int regulator_set_voltage(regulator, min_uV, max_uV);”h]”hŒ5int regulator_set_voltage(regulator, min_uV, max_uV);”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”höh÷uh1hæhŸh¶h Khhjï  hžhubh¸)”}”(hŒVWhere min_uV and max_uV are the minimum and maximum acceptable voltages in
microvolts.”h]”hŒVWhere min_uV and max_uV are the minimum and maximum acceptable voltages in
microvolts.”…””}”(hj*  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kjhjï  hžhubh¸)”}”(hŒñNOTE: this can be called when the regulator is enabled or disabled. If called
when enabled, then the voltage changes instantly, otherwise the voltage
configuration changes and the voltage is physically set when the regulator is
next enabled.”h]”hŒñNOTE: this can be called when the regulator is enabled or disabled. If called
when enabled, then the voltage changes instantly, otherwise the voltage
configuration changes and the voltage is physically set when the regulator is
next enabled.”…””}”(hj8  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kmhjï  hžhubh¸)”}”(hŒBThe regulators configured voltage output can be found by calling::”h]”hŒAThe regulators configured voltage output can be found by calling:”…””}”(hjF  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Krhjï  hžhubhç)”}”(hŒ%int regulator_get_voltage(regulator);”h]”hŒ%int regulator_get_voltage(regulator);”…””}”hjT  sbah}”(h]”h ]”h"]”h$]”h&]”höh÷uh1hæhŸh¶h Kthjï  hžhubj‚  )”}”(hhh]”j‡  )”}”(hX  NOTE:
get_voltage() will return the configured output voltage whether the
regulator is enabled or disabled and should NOT be used to determine regulator
output state. However this can be used in conjunction with is_enabled() to
determine the regulator physical output voltage.

”h]”(j  )”}”(hŒNOTE:”h]”hŒNOTE:”…””}”(hji  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jŒ  hŸh¶h K{hje  ubj  )”}”(hhh]”h¸)”}”(hX  get_voltage() will return the configured output voltage whether the
regulator is enabled or disabled and should NOT be used to determine regulator
output state. However this can be used in conjunction with is_enabled() to
determine the regulator physical output voltage.”h]”hX  get_voltage() will return the configured output voltage whether the
regulator is enabled or disabled and should NOT be used to determine regulator
output state. However this can be used in conjunction with is_enabled() to
determine the regulator physical output voltage.”…””}”(hjz  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kwhjw  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jœ  hje  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j†  hŸh¶h K{hjb  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j  hjï  hžhhŸh¶h Nubeh}”(h]”Œ0regulator-voltage-control-status-dynamic-drivers”ah ]”h"]”Œ73. regulator voltage control & status (dynamic drivers)”ah$]”h&]”uh1h¡hh£hžhhŸh¶h K_ubh¢)”}”(hhh]”(h§)”}”(hŒ=4. Regulator Current Limit Control & Status (dynamic drivers)”h]”hŒ=4. Regulator Current Limit Control & Status (dynamic drivers)”…””}”(hj¥  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj¢  hžhhŸh¶h K~ubh¸)”}”(hX  Some consumer drivers need to be able to dynamically change their supply
current limit to match system operating points. e.g. LCD backlight driver can
change the current limit to vary the backlight brightness, USB drivers may want
to set the limit to 500mA when supplying power.”h]”hX  Some consumer drivers need to be able to dynamically change their supply
current limit to match system operating points. e.g. LCD backlight driver can
change the current limit to vary the backlight brightness, USB drivers may want
to set the limit to 500mA when supplying power.”…””}”(hj³  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K€hj¢  hžhubh¸)”}”(hŒ=Consumers can control their supply current limit by calling::”h]”hŒ<Consumers can control their supply current limit by calling:”…””}”(hjÁ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K…hj¢  hžhubhç)”}”(hŒ;int regulator_set_current_limit(regulator, min_uA, max_uA);”h]”hŒ;int regulator_set_current_limit(regulator, min_uA, max_uA);”…””}”hjÏ  sbah}”(h]”h ]”h"]”h$]”h&]”höh÷uh1hæhŸh¶h K‡hj¢  hžhubh¸)”}”(hŒZWhere min_uA and max_uA are the minimum and maximum acceptable current limit in
microamps.”h]”hŒZWhere min_uA and max_uA are the minimum and maximum acceptable current limit in
microamps.”…””}”(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X  NOTE:
this can be called when the regulator is enabled or disabled. If called
when enabled, then the current limit changes instantly, otherwise the current
limit configuration changes and the current limit is physically set when the
regulator is next enabled.
”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Œýthis can be called when the regulator is enabled or disabled. If called
when enabled, then the current limit changes instantly, otherwise the current
limit configuration changes and the current limit is physically set when the
regulator is next enabled.”h]”hŒýthis can be called when the regulator is enabled or disabled. If called
when enabled, then the current limit changes instantly, otherwise the current
limit configuration changes and the current limit is physically set when the
regulator is next enabled.”…””}”(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¢  hžhhŸh¶h Nubh¸)”}”(hŒ4A regulators current limit can be found by calling::”h]”hŒ3A regulators current limit can be found by calling:”…””}”(hj#  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K’hj¢  hžhubhç)”}”(hŒ+int regulator_get_current_limit(regulator);”h]”hŒ+int regulator_get_current_limit(regulator);”…””}”hj1  sbah}”(h]”h ]”h"]”h$]”h&]”höh÷uh1hæhŸh¶h K”hj¢  hžhubj‚  )”}”(hhh]”j‡  )”}”(hŒ¢NOTE:
get_current_limit() will return the current limit whether the regulator
is enabled or disabled and should not be used to determine regulator current
load.

”h]”(j  )”}”(hŒNOTE:”h]”hŒNOTE:”…””}”(hjF  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jŒ  hŸh¶h KšhjB  ubj  )”}”(hhh]”h¸)”}”(hŒšget_current_limit() will return the current limit whether the regulator
is enabled or disabled and should not be used to determine regulator current
load.”h]”hŒšget_current_limit() will return the current limit whether the regulator
is enabled or disabled and should not be used to determine regulator current
load.”…””}”(hjW  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K—hjT  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jœ  hjB  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]”Œ6regulator-current-limit-control-status-dynamic-drivers”ah ]”h"]”Œ=4. regulator current limit control & status (dynamic drivers)”ah$]”h&]”uh1h¡hh£hžhhŸh¶h K~ubh¢)”}”(hhh]”(h§)”}”(hŒ>5. Regulator Operating Mode Control & Status (dynamic drivers)”h]”hŒ>5. Regulator Operating Mode Control & Status (dynamic drivers)”…””}”(hj‚  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj  hžhhŸh¶h Kubh¸)”}”(hŒçSome consumers can further save system power by changing the operating mode of
their supply regulator to be more efficient when the consumers operating state
changes. e.g. consumer driver is idle and subsequently draws less current”h]”hŒçSome consumers can further save system power by changing the operating mode of
their supply regulator to be more efficient when the consumers operating state
changes. e.g. consumer driver is idle and subsequently draws less current”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KŸhj  hžhubh¸)”}”(hŒ?Regulator operating mode can be changed indirectly or directly.”h]”hŒ?Regulator operating mode can be changed indirectly or directly.”…””}”(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Œ Indirect operating mode control.”h]”hŒ Indirect operating mode control.”…””}”(hj¯  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj¬  hžhhŸh¶h K¦ubh¸)”}”(hŒ[Consumer drivers can request a change in their supply regulator operating mode
by calling::”h]”hŒZConsumer drivers can request a change in their supply regulator operating mode
by calling:”…””}”(hj½  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K§hj¬  hžhubhç)”}”(hŒAint regulator_set_load(struct regulator *regulator, int load_uA);”h]”hŒAint regulator_set_load(struct regulator *regulator, int load_uA);”…””}”hjË  sbah}”(h]”h ]”h"]”h$]”h&]”höh÷uh1hæhŸh¶h Kªhj¬  hžhubh¸)”}”(hŒÅThis will cause the core to recalculate the total load on the regulator (based
on all its consumers) and change operating mode (if necessary and permitted)
to best match the current operating load.”h]”hŒÅThis will cause the core to recalculate the total load on the regulator (based
on all its consumers) and change operating mode (if necessary and permitted)
to best match the current operating load.”…””}”(hjÙ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K¬hj¬  hžhubh¸)”}”(hŒŸThe load_uA value can be determined from the consumer's datasheet. e.g. most
datasheets have tables showing the maximum current consumed in certain
situations.”h]”hŒ¡The load_uA value can be determined from the consumerâ€™s datasheet. e.g. most
datasheets have tables showing the maximum current consumed in certain
situations.”…””}”(hjç  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K°hj¬  hžhubh¸)”}”(hŒžMost consumers will use indirect operating mode control since they have no
knowledge of the regulator or whether the regulator is shared with other
consumers.”h]”hŒžMost consumers will use indirect operating mode control since they have no
knowledge of the regulator or whether the regulator is shared with other
consumers.”…””}”(hjõ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K´hj¬  hžhubeh}”(h]”Œindirect-operating-mode-control”ah ]”h"]”Œ indirect operating mode control.”ah$]”h&]”uh1h¡hj  hžhhŸh¶h K¦ubh¢)”}”(hhh]”(h§)”}”(hŒDirect operating mode control.”h]”hŒDirect operating mode control.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj  hžhhŸh¶h K¹ubh¸)”}”(hŒžBespoke or tightly coupled drivers may want to directly control regulator
operating mode depending on their operating point. This can be achieved by
calling::”h]”hŒBespoke or tightly coupled drivers may want to directly control regulator
operating mode depending on their operating point. This can be achieved by
calling:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K»hj  hžhubhç)”}”(hŒ…int regulator_set_mode(struct regulator *regulator, unsigned int mode);
unsigned int regulator_get_mode(struct regulator *regulator);”h]”hŒ…int regulator_set_mode(struct regulator *regulator, unsigned int mode);
unsigned int regulator_get_mode(struct regulator *regulator);”…””}”hj*  sbah}”(h]”h ]”h"]”h$]”h&]”höh÷uh1hæhŸh¶h K¿hj  hžhubh¸)”}”(hŒ‚Direct mode will only be used by consumers that *know* about the regulator and
are not sharing the regulator with other consumers.”h]”(hŒ0Direct mode will only be used by consumers that ”…””}”(hj8  hžhhŸNh NubhŒemphasis”“”)”}”(hŒ*know*”h]”hŒknow”…””}”(hjB  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j@  hj8  ubhŒL about the regulator and
are not sharing the regulator with other consumers.”…””}”(hj8  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KÂhj  hžhubeh}”(h]”Œdirect-operating-mode-control”ah ]”h"]”Œdirect operating mode control.”ah$]”h&]”uh1h¡hj  hžhhŸh¶h K¹ubeh}”(h]”Œ7regulator-operating-mode-control-status-dynamic-drivers”ah ]”h"]”Œ>5. regulator operating mode control & status (dynamic drivers)”ah$]”h&]”uh1h¡hh£hžhhŸh¶h Kubh¢)”}”(hhh]”(h§)”}”(hŒ6. Regulator Events”h]”hŒ6. Regulator Events”…””}”(hjm  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hjj  hžhhŸh¶h KÇubh¸)”}”(hŒ‡Regulators can notify consumers of external events. Events could be received by
consumers under regulator stress or failure conditions.”h]”hŒ‡Regulators can notify consumers of external events. Events could be received by
consumers under regulator stress or failure conditions.”…””}”(hj{  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KÉhjj  hžhubh¸)”}”(hŒ@Consumers can register interest in regulator events by calling::”h]”hŒ?Consumers can register interest in regulator events by calling:”…””}”(hj‰  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KÌhjj  hžhubhç)”}”(hŒxint regulator_register_notifier(struct regulator *regulator,
                                struct notifier_block *nb);”h]”hŒxint regulator_register_notifier(struct regulator *regulator,
                                struct notifier_block *nb);”…””}”hj—  sbah}”(h]”h ]”h"]”h$]”h&]”höh÷uh1hæhŸh¶h KÎhjj  hžhubh¸)”}”(hŒ.Consumers can unregister interest by calling::”h]”hŒ-Consumers can unregister interest by calling:”…””}”(hj¥  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KÑhjj  hžhubhç)”}”(hŒ|int regulator_unregister_notifier(struct regulator *regulator,
                                  struct notifier_block *nb);”h]”hŒ|int regulator_unregister_notifier(struct regulator *regulator,
                                  struct notifier_block *nb);”…””}”hj³  sbah}”(h]”h ]”h"]”h$]”h&]”höh÷uh1hæhŸh¶h KÓhjj  hžhubh¸)”}”(hŒYRegulators use the kernel notifier framework to send event to their interested
consumers.”h]”hŒYRegulators use the kernel notifier framework to send event to their interested
consumers.”…””}”(hjÁ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KÖhjj  hžhubeh}”(h]”Œregulator-events”ah ]”h"]”Œ6. regulator events”ah$]”h&]”uh1h¡hh£hžhhŸh¶h KÇubh¢)”}”(hhh]”(h§)”}”(hŒ#7. Regulator Direct Register Access”h]”hŒ#7. Regulator Direct Register Access”…””}”(hjÚ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj×  hžhhŸh¶h KÚubh¸)”}”(hŒÆSome kinds of power management hardware or firmware are designed such that
they need to do low-level hardware access to regulators, with no involvement
from the kernel. Examples of such devices are:”h]”hŒÆSome kinds of power management hardware or firmware are designed such that
they need to do low-level hardware access to regulators, with no involvement
from the kernel. Examples of such devices are:”…””}”(hjè  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KÜhj×  hžhubhŒbullet_list”“”)”}”(hhh]”(hŒ	list_item”“”)”}”(hŒclocksource with a voltage-controlled oscillator and control logic to change
the supply voltage over I2C to achieve a desired output clock rate”h]”h¸)”}”(hŒclocksource with a voltage-controlled oscillator and control logic to change
the supply voltage over I2C to achieve a desired output clock rate”h]”hŒclocksource with a voltage-controlled oscillator and control logic to change
the supply voltage over I2C to achieve a desired output clock rate”…””}”(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ø  hžhhŸh¶h Nubjü  )”}”(hŒ…thermal management firmware that can issue an arbitrary I2C transaction to
perform system poweroff during overtemperature conditions
”h]”h¸)”}”(hŒ„thermal management firmware that can issue an arbitrary I2C transaction to
perform system poweroff during overtemperature conditions”h]”hŒ„thermal management firmware that can issue an arbitrary I2C transaction to
perform system poweroff during overtemperature conditions”…””}”(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ø  hžhhŸh¶h Nubeh}”(h]”h ]”h"]”h$]”h&]”Œbullet”Œ-”uh1jö  hŸh¶h Kàhj×  hžhubh¸)”}”(hŒõTo set up such a device/firmware, various parameters like I2C address of the
regulator, addresses of various regulator registers etc. need to be configured
to it. The regulator framework provides the following helpers for querying
these details.”h]”hŒõTo set up such a device/firmware, various parameters like I2C address of the
regulator, addresses of various regulator registers etc. need to be configured
to it. The regulator framework provides the following helpers for querying
these details.”…””}”(hj5  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kåhj×  hžhubh¸)”}”(hŒ“Bus-specific details, like I2C addresses or transfer rates are handled by the
regmap framework. To get the regulator's regmap (if supported), use::”h]”hŒ”Bus-specific details, like I2C addresses or transfer rates are handled by the
regmap framework. To get the regulatorâ€™s regmap (if supported), use:”…””}”(hjC  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kêhj×  hžhubhç)”}”(hŒAstruct regmap *regulator_get_regmap(struct regulator *regulator);”h]”hŒAstruct regmap *regulator_get_regmap(struct regulator *regulator);”…””}”hjQ  sbah}”(h]”h ]”h"]”h$]”h&]”höh÷uh1hæhŸh¶h Kíhj×  hžhubh¸)”}”(hŒgTo obtain the hardware register offset and bitmask for the regulator's voltage
selector register, use::”h]”hŒhTo obtain the hardware register offset and bitmask for the regulatorâ€™s voltage
selector register, use:”…””}”(hj_  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kïhj×  hžhubhç)”}”(hŒÁint regulator_get_hardware_vsel_register(struct regulator *regulator,
                                         unsigned *vsel_reg,
                                         unsigned *vsel_mask);”h]”hŒÁint regulator_get_hardware_vsel_register(struct regulator *regulator,
                                         unsigned *vsel_reg,
                                         unsigned *vsel_mask);”…””}”hjm  sbah}”(h]”h ]”h"]”h$]”h&]”höh÷uh1hæhŸh¶h Kòhj×  hžhubh¸)”}”(hŒÄTo convert a regulator framework voltage selector code (used by
regulator_list_voltage) to a hardware-specific voltage selector that can be
directly written to the voltage selector register, use::”h]”hŒÃTo convert a regulator framework voltage selector code (used by
regulator_list_voltage) to a hardware-specific voltage selector that can be
directly written to the voltage selector register, use:”…””}”(hj{  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Köhj×  hžhubhç)”}”(hŒrint regulator_list_hardware_vsel(struct regulator *regulator,
                                 unsigned selector);”h]”hŒrint regulator_list_hardware_vsel(struct regulator *regulator,
                                 unsigned selector);”…””}”hj‰  sbah}”(h]”h ]”h"]”h$]”h&]”höh÷uh1hæhŸh¶h Kúhj×  hžhubh¸)”}”(hŒÀTo access the hardware for enabling/disabling the regulator, consumers must
use regulator_get_exclusive(), as it can't work if there's more than one
consumer. To enable/disable regulator use::”h]”hŒÃTo access the hardware for enabling/disabling the regulator, consumers must
use regulator_get_exclusive(), as it canâ€™t work if thereâ€™s more than one
consumer. To enable/disable regulator use:”…””}”(hj—  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kýhj×  hžhubhç)”}”(hŒHint regulator_hardware_enable(struct regulator *regulator, bool enable);”h]”hŒHint regulator_hardware_enable(struct regulator *regulator, bool enable);”…””}”hj¥  sbah}”(h]”h ]”h"]”h$]”h&]”höh÷uh1hæhŸh¶h Mhj×  hžhubeh}”(h]”Œ regulator-direct-register-access”ah ]”h"]”Œ#7. regulator direct register access”ah$]”h&]”uh1h¡hh£hžhhŸh¶h KÚubeh}”(h]”Œ#regulator-consumer-driver-interface”ah ]”h"]”Œ#regulator consumer driver interface”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½  jQ  jN  jì  jé  jŸ  jœ  j|  jy  jg  jd  j  j  j_  j\  jÔ  jÑ  j¸  jµ  uŒ	nametypes”}”(jÀ  ‰jQ  ‰jì  ‰jŸ  ‰j|  ‰jg  ‰j  ‰j_  ‰jÔ  ‰j¸  ‰uh}”(j½  h£jN  hÇjé  jT  jœ  jï  jy  j¢  jd  j  j  j¬  j\  j  jÑ  jj  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”]”Œtransform_messages”]”Œtransformer”NŒinclude_log”]”Œ
decoration”Nhžhub.