Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Unverified Commit 8a582fa9 authored by Claudiu Beznea's avatar Claudiu Beznea Committed by Mark Brown
Browse files

regulator: add documentation for regulator modes and suspend states 



Add documentation for regulator modes and suspend states.

Signed-off-by: default avatarClaudiu Beznea <claudiu.beznea@microchip.com>
Signed-off-by: default avatarMark Brown <broonie@kernel.org>
parent b5ebba46

Documentation/devicetree/bindings/regulator/act8945a-regulator.txt

+34 −0
Original line number Diff line number Diff line
@@ -15,11 +15,17 @@ Optional input supply properties: 
  - inl67-supply: The input supply for REG_LDO3 and REG_LDO4



Any standard regulator properties can be used to configure the single regulator.

regulator-initial-mode, regulator-allowed-modes and regulator-mode could be

specified using mode values from dt-bindings/regulator/active-semi,8945a-regulator.h

file.



The valid names for regulators are:

	REG_DCDC1, REG_DCDC2, REG_DCDC3, REG_LDO1, REG_LDO2, REG_LDO3, REG_LDO4.



Example:



#include <dt-bindings/regulator/active-semi,8945a-regulator.h>



	pmic@5b {

		compatible = "active-semi,act8945a";

		reg = <0x5b>;
@@ -32,6 +38,18 @@ Example: 
				regulator-min-microvolt = <1350000>;

				regulator-max-microvolt = <1350000>;

				regulator-always-on;



				regulator-allowed-modes = <ACT8945A_REGULATOR_MODE_FIXED>,

							  <ACT8945A_REGULATOR_MODE_LOWPOWER>;

				regulator-initial-mode = <ACT8945A_REGULATOR_MODE_FIXED>;



				regulator-state-mem {

					regulator-on-in-suspend;

					regulator-suspend-min-microvolt=<1400000>;

					regulator-suspend-max-microvolt=<1400000>;

					regulator-changeable-in-suspend;

					regulator-mode=<ACT8945A_REGULATOR_MODE_LOWPOWER>;

				};

			};



			vdd_1v2_reg: REG_DCDC2 {
@@ -39,6 +57,14 @@ Example: 
				regulator-min-microvolt = <1100000>;

				regulator-max-microvolt = <1300000>;

				regulator-always-on;



				regulator-allowed-modes = <ACT8945A_REGULATOR_MODE_FIXED>,

							  <ACT8945A_REGULATOR_MODE_LOWPOWER>;

				regulator-initial-mode = <ACT8945A_REGULATOR_MODE_FIXED>;



				regulator-state-mem {

					regulator-off-in-suspend;

				};

			};



			vdd_3v3_reg: REG_DCDC3 {
@@ -53,6 +79,14 @@ Example: 
				regulator-min-microvolt = <2500000>;

				regulator-max-microvolt = <2500000>;

				regulator-always-on;



				regulator-allowed-modes = <ACT8945A_REGULATOR_MODE_NORMAL>,

							  <ACT8945A_REGULATOR_MODE_LOWPOWER>;

				regulator-initial-mode = <ACT8945A_REGULATOR_MODE_NORMAL>;



				regulator-state-mem {

					regulator-off-in-suspend;

				};

			};



			vdd_3v3_lp_reg: REG_LDO2 {