Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

regulator: add documentation for regulator modes and suspend states

Add documentation for regulator modes and suspend states.

Signed-off-by: Claudiu Beznea <claudiu.beznea@microchip.com>
Signed-off-by: Mark Brown <broonie@kernel.org>

authored by

Claudiu Beznea and committed by
Mark Brown
8a582fa9 b5ebba46

+34
+34
Documentation/devicetree/bindings/regulator/act8945a-regulator.txt
··· 15 15 - inl67-supply: The input supply for REG_LDO3 and REG_LDO4 16 16 17 17 Any standard regulator properties can be used to configure the single regulator. 18 + regulator-initial-mode, regulator-allowed-modes and regulator-mode could be 19 + specified using mode values from dt-bindings/regulator/active-semi,8945a-regulator.h 20 + file. 18 21 19 22 The valid names for regulators are: 20 23 REG_DCDC1, REG_DCDC2, REG_DCDC3, REG_LDO1, REG_LDO2, REG_LDO3, REG_LDO4. 21 24 22 25 Example: 26 + 27 + #include <dt-bindings/regulator/active-semi,8945a-regulator.h> 28 + 23 29 pmic@5b { 24 30 compatible = "active-semi,act8945a"; 25 31 reg = <0x5b>; ··· 38 32 regulator-min-microvolt = <1350000>; 39 33 regulator-max-microvolt = <1350000>; 40 34 regulator-always-on; 35 + 36 + regulator-allowed-modes = <ACT8945A_REGULATOR_MODE_FIXED>, 37 + <ACT8945A_REGULATOR_MODE_LOWPOWER>; 38 + regulator-initial-mode = <ACT8945A_REGULATOR_MODE_FIXED>; 39 + 40 + regulator-state-mem { 41 + regulator-on-in-suspend; 42 + regulator-suspend-min-microvolt=<1400000>; 43 + regulator-suspend-max-microvolt=<1400000>; 44 + regulator-changeable-in-suspend; 45 + regulator-mode=<ACT8945A_REGULATOR_MODE_LOWPOWER>; 46 + }; 41 47 }; 42 48 43 49 vdd_1v2_reg: REG_DCDC2 { ··· 57 39 regulator-min-microvolt = <1100000>; 58 40 regulator-max-microvolt = <1300000>; 59 41 regulator-always-on; 42 + 43 + regulator-allowed-modes = <ACT8945A_REGULATOR_MODE_FIXED>, 44 + <ACT8945A_REGULATOR_MODE_LOWPOWER>; 45 + regulator-initial-mode = <ACT8945A_REGULATOR_MODE_FIXED>; 46 + 47 + regulator-state-mem { 48 + regulator-off-in-suspend; 49 + }; 60 50 }; 61 51 62 52 vdd_3v3_reg: REG_DCDC3 { ··· 79 53 regulator-min-microvolt = <2500000>; 80 54 regulator-max-microvolt = <2500000>; 81 55 regulator-always-on; 56 + 57 + regulator-allowed-modes = <ACT8945A_REGULATOR_MODE_NORMAL>, 58 + <ACT8945A_REGULATOR_MODE_LOWPOWER>; 59 + regulator-initial-mode = <ACT8945A_REGULATOR_MODE_NORMAL>; 60 + 61 + regulator-state-mem { 62 + regulator-off-in-suspend; 63 + }; 82 64 }; 83 65 84 66 vdd_3v3_lp_reg: REG_LDO2 {