€•­      Œ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/overview”Œ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/overview”Œ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/overview”Œ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/overview”Œ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/overview”Œ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/overview”Œ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Œ-Linux voltage and current regulator framework”h]”hŒ-Linux voltage and current regulator framework”…””}”(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/overview.rst”h Kubh¢)”}”(hhh]”(h§)”}”(hŒAbout”h]”hŒAbout”…””}”(hhºhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hh·hžhhŸh¶h KubhŒ	paragraph”“”)”}”(hŒlThis framework is designed to provide a standard kernel interface to control
voltage and current regulators.”h]”hŒlThis framework is designed to provide a standard kernel interface to control
voltage and current regulators.”…””}”(hhÊhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Khh·hžhubhÉ)”}”(hX  The intention is to allow systems to dynamically control regulator power output
in order to save power and prolong battery life. This applies to both voltage
regulators (where voltage output is controllable) and current sinks (where
current limit is controllable).”h]”hX  The intention is to allow systems to dynamically control regulator power output
in order to save power and prolong battery life. This applies to both voltage
regulators (where voltage output is controllable) and current sinks (where
current limit is controllable).”…””}”(hhØhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Khh·hžhubhŒenumerated_list”“”)”}”(hhh]”hŒ	list_item”“”)”}”(hŒ$2008  Wolfson Microelectronics PLC.
”h]”hÉ)”}”(hŒ#2008  Wolfson Microelectronics PLC.”h]”hŒ#2008  Wolfson Microelectronics PLC.”…””}”(hhñhžhhŸNh Nubah}”(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É)”}”(hŒ+Author: Liam Girdwood <lrg@slimlogic.co.uk>”h]”(hŒAuthor: Liam Girdwood <”…””}”(hj  hžhhŸNh NubhŒ	reference”“”)”}”(hŒlrg@slimlogic.co.uk”h]”hŒlrg@slimlogic.co.uk”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”Œmailto:lrg@slimlogic.co.uk”uh1j  hj  ubhŒ>”…””}”(hj  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Khh·hžhubeh}”(h]”Œabout”ah ]”h"]”Œabout”ah$]”h&]”uh1h¡hh£hžhhŸh¶h Kubh¢)”}”(hhh]”(h§)”}”(hŒNomenclature”h]”hŒNomenclature”…””}”(hjA  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj>  hžhhŸh¶h KubhÉ)”}”(hŒ!Some terms used in this document:”h]”hŒ!Some terms used in this document:”…””}”(hjO  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Khj>  hžhubhŒblock_quote”“”)”}”(hXW  - Regulator
               - Electronic device that supplies power to other devices.
                 Most regulators can enable and disable their output while
                 some can control their output voltage and or current.

                 Input Voltage -> Regulator -> Output Voltage


- PMIC
               - Power Management IC. An IC that contains numerous
                 regulators and often contains other subsystems.


- Consumer
               - Electronic device that is supplied power by a regulator.
                 Consumers can be classified into two types:-

                 Static: consumer does not change its supply voltage or
                 current limit. It only needs to enable or disable its
                 power supply. Its supply voltage is set by the hardware,
                 bootloader, firmware or kernel board initialisation code.

                 Dynamic: consumer needs to change its supply voltage or
                 current limit to meet operation demands.


- Power Domain
               - Electronic circuit that is supplied its input power by the
                 output power of a regulator, switch or by another power
                 domain.

                 The supply regulator may be behind a switch(s). i.e.::

                   Regulator -+-> Switch-1 -+-> Switch-2 --> [Consumer A]
                              |             |
                              |             +-> [Consumer B], [Consumer C]
                              |
                              +-> [Consumer D], [Consumer E]

                 That is one regulator and three power domains:

                 - Domain 1: Switch-1, Consumers D & E.
                 - Domain 2: Switch-2, Consumers B & C.
                 - Domain 3: Consumer A.

                 and this represents a "supplies" relationship:

                 Domain-1 --> Domain-2 --> Domain-3.

                 A power domain may have regulators that are supplied power
                 by other regulators. i.e.::

                   Regulator-1 -+-> Regulator-2 -+-> [Consumer A]
                                |
                                +-> [Consumer B]

                 This gives us two regulators and two power domains:

                 - Domain 1: Regulator-2, Consumer B.
                 - Domain 2: Consumer A.

                 and a "supplies" relationship:

                 Domain-1 --> Domain-2


- Constraints
               - Constraints are used to define power levels for performance
                 and hardware protection. Constraints exist at three levels:

                 Regulator Level: This is defined by the regulator hardware
                 operating parameters and is specified in the regulator
                 datasheet. i.e.

                   - voltage output is in the range 800mV -> 3500mV.
                   - regulator current output limit is 20mA @ 5V but is
                     10mA @ 10V.

                 Power Domain Level: This is defined in software by kernel
                 level board initialisation code. It is used to constrain a
                 power domain to a particular power range. i.e.

                   - Domain-1 voltage is 3300mV
                   - Domain-2 voltage is 1400mV -> 1600mV
                   - Domain-3 current limit is 0mA -> 20mA.

                 Consumer Level: This is defined by consumer drivers
                 dynamically setting voltage or current limit levels.

                 e.g. a consumer backlight driver asks for a current increase
                 from 5mA to 10mA to increase LCD illumination. This passes
                 to through the levels as follows :-

                 Consumer: need to increase LCD brightness. Lookup and
                 request next current mA value in brightness table (the
                 consumer driver could be used on several different
                 personalities based upon the same reference device).

                 Power Domain: is the new current limit within the domain
                 operating limits for this domain and system state (e.g.
                 battery power, USB power)

                 Regulator Domains: is the new current limit within the
                 regulator operating parameters for input/output voltage.

                 If the regulator request passes all the constraint tests
                 then the new regulator value is applied.

”h]”hŒbullet_list”“”)”}”(hhh]”(hì)”}”(hX  Regulator
             - Electronic device that supplies power to other devices.
               Most regulators can enable and disable their output while
               some can control their output voltage and or current.

               Input Voltage -> Regulator -> Output Voltage

”h]”hŒdefinition_list”“”)”}”(hhh]”hŒdefinition_list_item”“”)”}”(hŒéRegulator
- Electronic device that supplies power to other devices.
  Most regulators can enable and disable their output while
  some can control their output voltage and or current.

  Input Voltage -> Regulator -> Output Voltage

”h]”(hŒterm”“”)”}”(hŒ	Regulator”h]”hŒ	Regulator”…””}”(hjy  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jw  hŸh¶h K hjs  ubhŒ
definition”“”)”}”(hhh]”jd  )”}”(hhh]”hì)”}”(hŒ×Electronic device that supplies power to other devices.
Most regulators can enable and disable their output while
some can control their output voltage and or current.

Input Voltage -> Regulator -> Output Voltage

”h]”(hÉ)”}”(hŒ§Electronic device that supplies power to other devices.
Most regulators can enable and disable their output while
some can control their output voltage and or current.”h]”hŒ§Electronic device that supplies power to other devices.
Most regulators can enable and disable their output while
some can control their output voltage and or current.”…””}”(hj“  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Khj  ubhÉ)”}”(hŒ,Input Voltage -> Regulator -> Output Voltage”h]”hŒ,Input Voltage -> Regulator -> Output Voltage”…””}”(hj¡  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Khj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hëhjŒ  ubah}”(h]”h ]”h"]”h$]”h&]”Œbullet”Œ-”uh1jc  hŸh¶h Khj‰  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j‡  hjs  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jq  hŸh¶h K hjn  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jl  hjh  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hëhje  ubhì)”}”(hŒ†PMIC
             - Power Management IC. An IC that contains numerous
               regulators and often contains other subsystems.

”h]”jm  )”}”(hhh]”jr  )”}”(hŒlPMIC
- Power Management IC. An IC that contains numerous
  regulators and often contains other subsystems.

”h]”(jx  )”}”(hŒPMIC”h]”hŒPMIC”…””}”(hjà  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jw  hŸh¶h K%hjÜ  ubjˆ  )”}”(hhh]”jd  )”}”(hhh]”hì)”}”(hŒcPower Management IC. An IC that contains numerous
regulators and often contains other subsystems.

”h]”hÉ)”}”(hŒaPower Management IC. An IC that contains numerous
regulators and often contains other subsystems.”h]”hŒaPower Management IC. An IC that contains numerous
regulators and often contains other subsystems.”…””}”(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ñ  ubah}”(h]”h ]”h"]”h$]”h&]”j»  j¼  uh1jc  hŸh¶h K#hjî  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j‡  hjÜ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jq  hŸh¶h K%hjÙ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jl  hjÕ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hëhje  ubhì)”}”(hX+  Consumer
             - Electronic device that is supplied power by a regulator.
               Consumers can be classified into two types:-

               Static: consumer does not change its supply voltage or
               current limit. It only needs to enable or disable its
               power supply. Its supply voltage is set by the hardware,
               bootloader, firmware or kernel board initialisation code.

               Dynamic: consumer needs to change its supply voltage or
               current limit to meet operation demands.

”h]”jm  )”}”(hhh]”jr  )”}”(hXÃ  Consumer
- Electronic device that is supplied power by a regulator.
  Consumers can be classified into two types:-

  Static: consumer does not change its supply voltage or
  current limit. It only needs to enable or disable its
  power supply. Its supply voltage is set by the hardware,
  bootloader, firmware or kernel board initialisation code.

  Dynamic: consumer needs to change its supply voltage or
  current limit to meet operation demands.

”h]”(jx  )”}”(hŒConsumer”h]”hŒConsumer”…””}”(hj5  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jw  hŸh¶h K2hj1  ubjˆ  )”}”(hhh]”jd  )”}”(hhh]”hì)”}”(hXª  Electronic device that is supplied power by a regulator.
Consumers can be classified into two types:-

Static: consumer does not change its supply voltage or
current limit. It only needs to enable or disable its
power supply. Its supply voltage is set by the hardware,
bootloader, firmware or kernel board initialisation code.

Dynamic: consumer needs to change its supply voltage or
current limit to meet operation demands.

”h]”(hÉ)”}”(hŒeElectronic device that is supplied power by a regulator.
Consumers can be classified into two types:-”h]”hŒeElectronic device that is supplied power by a regulator.
Consumers can be classified into two types:-”…””}”(hjM  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K(hjI  ubhÉ)”}”(hŒßStatic: consumer does not change its supply voltage or
current limit. It only needs to enable or disable its
power supply. Its supply voltage is set by the hardware,
bootloader, firmware or kernel board initialisation code.”h]”hŒßStatic: consumer does not change its supply voltage or
current limit. It only needs to enable or disable its
power supply. Its supply voltage is set by the hardware,
bootloader, firmware or kernel board initialisation code.”…””}”(hj[  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K+hjI  ubhÉ)”}”(hŒ`Dynamic: consumer needs to change its supply voltage or
current limit to meet operation demands.”h]”hŒ`Dynamic: consumer needs to change its supply voltage or
current limit to meet operation demands.”…””}”(hji  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K0hjI  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hëhjF  ubah}”(h]”h ]”h"]”h$]”h&]”j»  j¼  uh1jc  hŸh¶h K(hjC  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j‡  hj1  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jq  hŸh¶h K2hj.  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jl  hj*  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hëhje  ubhì)”}”(hXU  Power Domain
             - Electronic circuit that is supplied its input power by the
               output power of a regulator, switch or by another power
               domain.

               The supply regulator may be behind a switch(s). i.e.::

                 Regulator -+-> Switch-1 -+-> Switch-2 --> [Consumer A]
                            |             |
                            |             +-> [Consumer B], [Consumer C]
                            |
                            +-> [Consumer D], [Consumer E]

               That is one regulator and three power domains:

               - Domain 1: Switch-1, Consumers D & E.
               - Domain 2: Switch-2, Consumers B & C.
               - Domain 3: Consumer A.

               and this represents a "supplies" relationship:

               Domain-1 --> Domain-2 --> Domain-3.

               A power domain may have regulators that are supplied power
               by other regulators. i.e.::

                 Regulator-1 -+-> Regulator-2 -+-> [Consumer A]
                              |
                              +-> [Consumer B]

               This gives us two regulators and two power domains:

               - Domain 1: Regulator-2, Consumer B.
               - Domain 2: Consumer A.

               and a "supplies" relationship:

               Domain-1 --> Domain-2

”h]”jm  )”}”(hhh]”jr  )”}”(hX  Power Domain
- Electronic circuit that is supplied its input power by the
  output power of a regulator, switch or by another power
  domain.

  The supply regulator may be behind a switch(s). i.e.::

    Regulator -+-> Switch-1 -+-> Switch-2 --> [Consumer A]
               |             |
               |             +-> [Consumer B], [Consumer C]
               |
               +-> [Consumer D], [Consumer E]

  That is one regulator and three power domains:

  - Domain 1: Switch-1, Consumers D & E.
  - Domain 2: Switch-2, Consumers B & C.
  - Domain 3: Consumer A.

  and this represents a "supplies" relationship:

  Domain-1 --> Domain-2 --> Domain-3.

  A power domain may have regulators that are supplied power
  by other regulators. i.e.::

    Regulator-1 -+-> Regulator-2 -+-> [Consumer A]
                 |
                 +-> [Consumer B]

  This gives us two regulators and two power domains:

  - Domain 1: Regulator-2, Consumer B.
  - Domain 2: Consumer A.

  and a "supplies" relationship:

  Domain-1 --> Domain-2

”h]”(jx  )”}”(hŒPower Domain”h]”hŒPower Domain”…””}”(hj¦  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jw  hŸh¶h KZhj¢  ubjˆ  )”}”(hhh]”jd  )”}”(hhh]”hì)”}”(hXÑ  Electronic circuit that is supplied its input power by the
output power of a regulator, switch or by another power
domain.

The supply regulator may be behind a switch(s). i.e.::

  Regulator -+-> Switch-1 -+-> Switch-2 --> [Consumer A]
             |             |
             |             +-> [Consumer B], [Consumer C]
             |
             +-> [Consumer D], [Consumer E]

That is one regulator and three power domains:

- Domain 1: Switch-1, Consumers D & E.
- Domain 2: Switch-2, Consumers B & C.
- Domain 3: Consumer A.

and this represents a "supplies" relationship:

Domain-1 --> Domain-2 --> Domain-3.

A power domain may have regulators that are supplied power
by other regulators. i.e.::

  Regulator-1 -+-> Regulator-2 -+-> [Consumer A]
               |
               +-> [Consumer B]

This gives us two regulators and two power domains:

- Domain 1: Regulator-2, Consumer B.
- Domain 2: Consumer A.

and a "supplies" relationship:

Domain-1 --> Domain-2

”h]”(hÉ)”}”(hŒzElectronic circuit that is supplied its input power by the
output power of a regulator, switch or by another power
domain.”h]”hŒzElectronic circuit that is supplied its input power by the
output power of a regulator, switch or by another power
domain.”…””}”(hj¾  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K5hjº  ubhÉ)”}”(hŒ6The supply regulator may be behind a switch(s). i.e.::”h]”hŒ5The supply regulator may be behind a switch(s). i.e.:”…””}”(hjÌ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K9hjº  ubhŒliteral_block”“”)”}”(hŒÀRegulator -+-> Switch-1 -+-> Switch-2 --> [Consumer A]
           |             |
           |             +-> [Consumer B], [Consumer C]
           |
           +-> [Consumer D], [Consumer E]”h]”hŒÀRegulator -+-> Switch-1 -+-> Switch-2 --> [Consumer A]
           |             |
           |             +-> [Consumer B], [Consumer C]
           |
           +-> [Consumer D], [Consumer E]”…””}”hjÜ  sbah}”(h]”h ]”h"]”h$]”h&]”Œ	xml:space”Œpreserve”uh1jÚ  hŸh¶h K;hjº  ubhÉ)”}”(hŒ.That is one regulator and three power domains:”h]”hŒ.That is one regulator and three power domains:”…””}”(hjì  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h KAhjº  ubjd  )”}”(hhh]”(hì)”}”(hŒ$Domain 1: Switch-1, Consumers D & E.”h]”hÉ)”}”(hjÿ  h]”hŒ$Domain 1: Switch-1, Consumers D & E.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h KChjý  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hëhjú  ubhì)”}”(hŒ$Domain 2: Switch-2, Consumers B & C.”h]”hÉ)”}”(hj  h]”hŒ$Domain 2: Switch-2, Consumers B & C.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h KDhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hëhjú  ubhì)”}”(hŒDomain 3: Consumer A.
”h]”hÉ)”}”(hŒDomain 3: Consumer A.”h]”hŒDomain 3: Consumer A.”…””}”(hj/  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h KEhj+  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hëhjú  ubeh}”(h]”h ]”h"]”h$]”h&]”j»  j¼  uh1jc  hŸh¶h KChjº  ubhÉ)”}”(hŒ.and this represents a "supplies" relationship:”h]”hŒ2and this represents a â€œsuppliesâ€ relationship:”…””}”(hjI  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h KGhjº  ubhÉ)”}”(hŒ#Domain-1 --> Domain-2 --> Domain-3.”h]”hŒ#Domain-1 --> Domain-2 --> Domain-3.”…””}”(hjW  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h KIhjº  ubhÉ)”}”(hŒVA power domain may have regulators that are supplied power
by other regulators. i.e.::”h]”hŒUA power domain may have regulators that are supplied power
by other regulators. i.e.:”…””}”(hje  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h KKhjº  ubjÛ  )”}”(hŒ[Regulator-1 -+-> Regulator-2 -+-> [Consumer A]
             |
             +-> [Consumer B]”h]”hŒ[Regulator-1 -+-> Regulator-2 -+-> [Consumer A]
             |
             +-> [Consumer B]”…””}”hjs  sbah}”(h]”h ]”h"]”h$]”h&]”jê  jë  uh1jÚ  hŸh¶h KNhjº  ubhÉ)”}”(hŒ3This gives us two regulators and two power domains:”h]”hŒ3This gives us two regulators and two power domains:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h KRhjº  ubjd  )”}”(hhh]”(hì)”}”(hŒ"Domain 1: Regulator-2, Consumer B.”h]”hÉ)”}”(hj”  h]”hŒ"Domain 1: Regulator-2, Consumer B.”…””}”(hj–  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h KThj’  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hëhj  ubhì)”}”(hŒDomain 2: Consumer A.
”h]”hÉ)”}”(hŒDomain 2: Consumer A.”h]”hŒDomain 2: Consumer A.”…””}”(hj­  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h KUhj©  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hëhj  ubeh}”(h]”h ]”h"]”h$]”h&]”j»  j¼  uh1jc  hŸh¶h KThjº  ubhÉ)”}”(hŒand a "supplies" relationship:”h]”hŒ"and a â€œsuppliesâ€ relationship:”…””}”(hjÇ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h KWhjº  ubhÉ)”}”(hŒDomain-1 --> Domain-2”h]”hŒDomain-1 --> Domain-2”…””}”(hjÕ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h KYhjº  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hëhj·  ubah}”(h]”h ]”h"]”h$]”h&]”j»  j¼  uh1jc  hŸh¶h K5hj´  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j‡  hj¢  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jq  hŸh¶h KZhjŸ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jl  hj›  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hëhje  ubhì)”}”(hXœ  Constraints
             - Constraints are used to define power levels for performance
               and hardware protection. Constraints exist at three levels:

               Regulator Level: This is defined by the regulator hardware
               operating parameters and is specified in the regulator
               datasheet. i.e.

                 - voltage output is in the range 800mV -> 3500mV.
                 - regulator current output limit is 20mA @ 5V but is
                   10mA @ 10V.

               Power Domain Level: This is defined in software by kernel
               level board initialisation code. It is used to constrain a
               power domain to a particular power range. i.e.

                 - Domain-1 voltage is 3300mV
                 - Domain-2 voltage is 1400mV -> 1600mV
                 - Domain-3 current limit is 0mA -> 20mA.

               Consumer Level: This is defined by consumer drivers
               dynamically setting voltage or current limit levels.

               e.g. a consumer backlight driver asks for a current increase
               from 5mA to 10mA to increase LCD illumination. This passes
               to through the levels as follows :-

               Consumer: need to increase LCD brightness. Lookup and
               request next current mA value in brightness table (the
               consumer driver could be used on several different
               personalities based upon the same reference device).

               Power Domain: is the new current limit within the domain
               operating limits for this domain and system state (e.g.
               battery power, USB power)

               Regulator Domains: is the new current limit within the
               regulator operating parameters for input/output voltage.

               If the regulator request passes all the constraint tests
               then the new regulator value is applied.

”h]”jm  )”}”(hhh]”jr  )”}”(hX  Constraints
- Constraints are used to define power levels for performance
  and hardware protection. Constraints exist at three levels:

  Regulator Level: This is defined by the regulator hardware
  operating parameters and is specified in the regulator
  datasheet. i.e.

    - voltage output is in the range 800mV -> 3500mV.
    - regulator current output limit is 20mA @ 5V but is
      10mA @ 10V.

  Power Domain Level: This is defined in software by kernel
  level board initialisation code. It is used to constrain a
  power domain to a particular power range. i.e.

    - Domain-1 voltage is 3300mV
    - Domain-2 voltage is 1400mV -> 1600mV
    - Domain-3 current limit is 0mA -> 20mA.

  Consumer Level: This is defined by consumer drivers
  dynamically setting voltage or current limit levels.

  e.g. a consumer backlight driver asks for a current increase
  from 5mA to 10mA to increase LCD illumination. This passes
  to through the levels as follows :-

  Consumer: need to increase LCD brightness. Lookup and
  request next current mA value in brightness table (the
  consumer driver could be used on several different
  personalities based upon the same reference device).

  Power Domain: is the new current limit within the domain
  operating limits for this domain and system state (e.g.
  battery power, USB power)

  Regulator Domains: is the new current limit within the
  regulator operating parameters for input/output voltage.

  If the regulator request passes all the constraint tests
  then the new regulator value is applied.

”h]”(jx  )”}”(hŒConstraints”h]”hŒConstraints”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jw  hŸh¶h K…hj  ubjˆ  )”}”(hhh]”jd  )”}”(hhh]”hì)”}”(hXÎ  Constraints are used to define power levels for performance
and hardware protection. Constraints exist at three levels:

Regulator Level: This is defined by the regulator hardware
operating parameters and is specified in the regulator
datasheet. i.e.

  - voltage output is in the range 800mV -> 3500mV.
  - regulator current output limit is 20mA @ 5V but is
    10mA @ 10V.

Power Domain Level: This is defined in software by kernel
level board initialisation code. It is used to constrain a
power domain to a particular power range. i.e.

  - Domain-1 voltage is 3300mV
  - Domain-2 voltage is 1400mV -> 1600mV
  - Domain-3 current limit is 0mA -> 20mA.

Consumer Level: This is defined by consumer drivers
dynamically setting voltage or current limit levels.

e.g. a consumer backlight driver asks for a current increase
from 5mA to 10mA to increase LCD illumination. This passes
to through the levels as follows :-

Consumer: need to increase LCD brightness. Lookup and
request next current mA value in brightness table (the
consumer driver could be used on several different
personalities based upon the same reference device).

Power Domain: is the new current limit within the domain
operating limits for this domain and system state (e.g.
battery power, USB power)

Regulator Domains: is the new current limit within the
regulator operating parameters for input/output voltage.

If the regulator request passes all the constraint tests
then the new regulator value is applied.

”h]”(hÉ)”}”(hŒwConstraints are used to define power levels for performance
and hardware protection. Constraints exist at three levels:”h]”hŒwConstraints are used to define power levels for performance
and hardware protection. Constraints exist at three levels:”…””}”(hj*  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K]hj&  ubhÉ)”}”(hŒRegulator Level: This is defined by the regulator hardware
operating parameters and is specified in the regulator
datasheet. i.e.”h]”hŒRegulator Level: This is defined by the regulator hardware
operating parameters and is specified in the regulator
datasheet. i.e.”…””}”(hj8  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K`hj&  ubj^  )”}”(hŒu- voltage output is in the range 800mV -> 3500mV.
- regulator current output limit is 20mA @ 5V but is
  10mA @ 10V.
”h]”jd  )”}”(hhh]”(hì)”}”(hŒ/voltage output is in the range 800mV -> 3500mV.”h]”hÉ)”}”(hjO  h]”hŒ/voltage output is in the range 800mV -> 3500mV.”…””}”(hjQ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h KdhjM  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hëhjJ  ubhì)”}”(hŒ?regulator current output limit is 20mA @ 5V but is
10mA @ 10V.
”h]”hÉ)”}”(hŒ>regulator current output limit is 20mA @ 5V but is
10mA @ 10V.”h]”hŒ>regulator current output limit is 20mA @ 5V but is
10mA @ 10V.”…””}”(hjh  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Kehjd  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hëhjJ  ubeh}”(h]”h ]”h"]”h$]”h&]”j»  j¼  uh1jc  hŸh¶h KdhjF  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j]  hŸh¶h Kdhj&  ubhÉ)”}”(hŒ£Power Domain Level: This is defined in software by kernel
level board initialisation code. It is used to constrain a
power domain to a particular power range. i.e.”h]”hŒ£Power Domain Level: This is defined in software by kernel
level board initialisation code. It is used to constrain a
power domain to a particular power range. i.e.”…””}”(hjˆ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Khhj&  ubj^  )”}”(hŒm- Domain-1 voltage is 3300mV
- Domain-2 voltage is 1400mV -> 1600mV
- Domain-3 current limit is 0mA -> 20mA.
”h]”jd  )”}”(hhh]”(hì)”}”(hŒDomain-1 voltage is 3300mV”h]”hÉ)”}”(hjŸ  h]”hŒDomain-1 voltage is 3300mV”…””}”(hj¡  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Klhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hëhjš  ubhì)”}”(hŒ$Domain-2 voltage is 1400mV -> 1600mV”h]”hÉ)”}”(hj¶  h]”hŒ$Domain-2 voltage is 1400mV -> 1600mV”…””}”(hj¸  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Kmhj´  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hëhjš  ubhì)”}”(hŒ'Domain-3 current limit is 0mA -> 20mA.
”h]”hÉ)”}”(hŒ&Domain-3 current limit is 0mA -> 20mA.”h]”hŒ&Domain-3 current limit is 0mA -> 20mA.”…””}”(hjÏ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h KnhjË  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hëhjš  ubeh}”(h]”h ]”h"]”h$]”h&]”j»  j¼  uh1jc  hŸh¶h Klhj–  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j]  hŸh¶h Klhj&  ubhÉ)”}”(hŒhConsumer Level: This is defined by consumer drivers
dynamically setting voltage or current limit levels.”h]”hŒhConsumer Level: This is defined by consumer drivers
dynamically setting voltage or current limit levels.”…””}”(hjï  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Kphj&  ubhÉ)”}”(hŒ›e.g. a consumer backlight driver asks for a current increase
from 5mA to 10mA to increase LCD illumination. This passes
to through the levels as follows :-”h]”hŒ›e.g. a consumer backlight driver asks for a current increase
from 5mA to 10mA to increase LCD illumination. This passes
to through the levels as follows :-”…””}”(hjý  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Kshj&  ubhÉ)”}”(hŒÔConsumer: need to increase LCD brightness. Lookup and
request next current mA value in brightness table (the
consumer driver could be used on several different
personalities based upon the same reference device).”h]”hŒÔConsumer: need to increase LCD brightness. Lookup and
request next current mA value in brightness table (the
consumer driver could be used on several different
personalities based upon the same reference device).”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Kwhj&  ubhÉ)”}”(hŒŠPower Domain: is the new current limit within the domain
operating limits for this domain and system state (e.g.
battery power, USB power)”h]”hŒŠPower Domain: is the new current limit within the domain
operating limits for this domain and system state (e.g.
battery power, USB power)”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K|hj&  ubhÉ)”}”(hŒoRegulator Domains: is the new current limit within the
regulator operating parameters for input/output voltage.”h]”hŒoRegulator Domains: is the new current limit within the
regulator operating parameters for input/output voltage.”…””}”(hj'  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K€hj&  ubhÉ)”}”(hŒaIf the regulator request passes all the constraint tests
then the new regulator value is applied.”h]”hŒaIf the regulator request passes all the constraint tests
then the new regulator value is applied.”…””}”(hj5  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Kƒhj&  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hëhj#  ubah}”(h]”h ]”h"]”h$]”h&]”j»  j¼  uh1jc  hŸh¶h K]hj   ubah}”(h]”h ]”h"]”h$]”h&]”uh1j‡  hj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jq  hŸh¶h K…hj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jl  hj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hëhje  ubeh}”(h]”h ]”h"]”h$]”h&]”j»  j¼  uh1jc  hŸh¶h Khj_  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j]  hŸh¶h Khj>  hžhubeh}”(h]”Œnomenclature”ah ]”h"]”Œnomenclature”ah$]”h&]”uh1h¡hh£hžhhŸh¶h Kubh¢)”}”(hhh]”(h§)”}”(hŒDesign”h]”hŒDesign”…””}”(hj~  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj{  hžhhŸh¶h KˆubhÉ)”}”(hŒ™The framework is designed and targeted at SoC based devices but may also be
relevant to non SoC devices and is split into the following four interfaces:-”h]”hŒ™The framework is designed and targeted at SoC based devices but may also be
relevant to non SoC devices and is split into the following four interfaces:-”…””}”(hjŒ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h KŠhj{  hžhubj^  )”}”(hXê  1. Consumer driver interface.

   This uses a similar API to the kernel clock interface in that consumer
   drivers can get and put a regulator (like they can with clocks atm) and
   get/set voltage, current limit, mode, enable and disable. This should
   allow consumers complete control over their supply voltage and current
   limit. This also compiles out if not in use so drivers can be reused in
   systems with no regulator based power control.

     See Documentation/power/regulator/consumer.rst

2. Regulator driver interface.

   This allows regulator drivers to register their regulators and provide
   operations to the core. It also has a notifier call chain for propagating
   regulator events to clients.

     See Documentation/power/regulator/regulator.rst

3. Machine interface.

   This interface is for machine specific code and allows the creation of
   voltage/current domains (with constraints) for each regulator. It can
   provide regulator constraints that will prevent device damage through
   overvoltage or overcurrent caused by buggy client drivers. It also
   allows the creation of a regulator tree whereby some regulators are
   supplied by others (similar to a clock tree).

     See Documentation/power/regulator/machine.rst

4. Userspace ABI.

   The framework also exports a lot of useful voltage/current/opmode data to
   userspace via sysfs. This could be used to help monitor device power
   consumption and status.

     See Documentation/ABI/testing/sysfs-class-regulator”h]”hç)”}”(hhh]”(hì)”}”(hXá  Consumer driver interface.

This uses a similar API to the kernel clock interface in that consumer
drivers can get and put a regulator (like they can with clocks atm) and
get/set voltage, current limit, mode, enable and disable. This should
allow consumers complete control over their supply voltage and current
limit. This also compiles out if not in use so drivers can be reused in
systems with no regulator based power control.

  See Documentation/power/regulator/consumer.rst
”h]”(hÉ)”}”(hŒConsumer driver interface.”h]”hŒConsumer driver interface.”…””}”(hj¥  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h KŽhj¡  ubhÉ)”}”(hX’  This uses a similar API to the kernel clock interface in that consumer
drivers can get and put a regulator (like they can with clocks atm) and
get/set voltage, current limit, mode, enable and disable. This should
allow consumers complete control over their supply voltage and current
limit. This also compiles out if not in use so drivers can be reused in
systems with no regulator based power control.”h]”hX’  This uses a similar API to the kernel clock interface in that consumer
drivers can get and put a regulator (like they can with clocks atm) and
get/set voltage, current limit, mode, enable and disable. This should
allow consumers complete control over their supply voltage and current
limit. This also compiles out if not in use so drivers can be reused in
systems with no regulator based power control.”…””}”(hj³  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Khj¡  ubj^  )”}”(hŒ/See Documentation/power/regulator/consumer.rst
”h]”hÉ)”}”(hŒ.See Documentation/power/regulator/consumer.rst”h]”hŒ.See Documentation/power/regulator/consumer.rst”…””}”(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Ÿh¶h K—hj¡  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hëhjž  ubhì)”}”(hŒþRegulator driver interface.

This allows regulator drivers to register their regulators and provide
operations to the core. It also has a notifier call chain for propagating
regulator events to clients.

  See Documentation/power/regulator/regulator.rst
”h]”(hÉ)”}”(hŒRegulator driver interface.”h]”hŒRegulator driver interface.”…””}”(hjã  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K™hjß  ubhÉ)”}”(hŒ­This allows regulator drivers to register their regulators and provide
operations to the core. It also has a notifier call chain for propagating
regulator events to clients.”h]”hŒ­This allows regulator drivers to register their regulators and provide
operations to the core. It also has a notifier call chain for propagating
regulator events to clients.”…””}”(hjñ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K›hjß  ubj^  )”}”(hŒ0See Documentation/power/regulator/regulator.rst
”h]”hÉ)”}”(hŒ/See Documentation/power/regulator/regulator.rst”h]”hŒ/See Documentation/power/regulator/regulator.rst”…””}”(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Ÿh¶h KŸhjß  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hëhjž  ubhì)”}”(hXÍ  Machine interface.

This interface is for machine specific code and allows the creation of
voltage/current domains (with constraints) for each regulator. It can
provide regulator constraints that will prevent device damage through
overvoltage or overcurrent caused by buggy client drivers. It also
allows the creation of a regulator tree whereby some regulators are
supplied by others (similar to a clock tree).

  See Documentation/power/regulator/machine.rst
”h]”(hÉ)”}”(hŒMachine interface.”h]”hŒMachine interface.”…””}”(hj!  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K¡hj  ubhÉ)”}”(hX‡  This interface is for machine specific code and allows the creation of
voltage/current domains (with constraints) for each regulator. It can
provide regulator constraints that will prevent device damage through
overvoltage or overcurrent caused by buggy client drivers. It also
allows the creation of a regulator tree whereby some regulators are
supplied by others (similar to a clock tree).”h]”hX‡  This interface is for machine specific code and allows the creation of
voltage/current domains (with constraints) for each regulator. It can
provide regulator constraints that will prevent device damage through
overvoltage or overcurrent caused by buggy client drivers. It also
allows the creation of a regulator tree whereby some regulators are
supplied by others (similar to a clock tree).”…””}”(hj/  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K£hj  ubj^  )”}”(hŒ.See Documentation/power/regulator/machine.rst
”h]”hÉ)”}”(hŒ-See Documentation/power/regulator/machine.rst”h]”hŒ-See Documentation/power/regulator/machine.rst”…””}”(hjA  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h Kªhj=  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j]  hŸh¶h Kªhj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hëhjž  ubhì)”}”(hŒíUserspace ABI.

The framework also exports a lot of useful voltage/current/opmode data to
userspace via sysfs. This could be used to help monitor device power
consumption and status.

  See Documentation/ABI/testing/sysfs-class-regulator”h]”(hÉ)”}”(hŒUserspace ABI.”h]”hŒUserspace ABI.”…””}”(hj_  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K¬hj[  ubhÉ)”}”(hŒ¦The framework also exports a lot of useful voltage/current/opmode data to
userspace via sysfs. This could be used to help monitor device power
consumption and status.”h]”hŒ¦The framework also exports a lot of useful voltage/current/opmode data to
userspace via sysfs. This could be used to help monitor device power
consumption and status.”…””}”(hjm  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÈhŸh¶h K®hj[  ubj^  )”}”(hŒ3See Documentation/ABI/testing/sysfs-class-regulator”h]”hÉ)”}”(hj}  h]”hŒ3See Documentation/ABI/testing/sysfs-class-regulator”…””}”(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Ÿh¶h K²hj[  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hëhjž  ubeh}”(h]”h ]”h"]”h$]”h&]”j  Œarabic”j  hj  Œ.”uh1hæhjš  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j]  hŸh¶h KŽhj{  hžhubeh}”(h]”Œdesign”ah ]”h"]”Œdesign”ah$]”h&]”uh1h¡hh£hžhhŸh¶h Kˆubeh}”(h]”Œ-linux-voltage-and-current-regulator-framework”ah ]”h"]”Œ-linux voltage and current regulator framework”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;  j8  jx  ju  j«  j¨  uŒ	nametypes”}”(j³  ‰j;  ‰jx  ‰j«  ‰uh}”(j°  h£j8  h·ju  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.