Merge tag 'armsoc-late' of git://git.kernel.org/pub/scm/linux/kernel/git/soc/soc
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / regulator / act8865-regulator.txt
1 ACT88xx regulators
2 -------------------
3
4 Required properties:
5 - compatible: "active-semi,act8846" or "active-semi,act8865" or "active-semi,act8600"
6 - reg: I2C slave address
7
8 Optional properties:
9 - system-power-controller: Telling whether or not this pmic is controlling
10   the system power. See Documentation/devicetree/bindings/power/power-controller.txt .
11 - active-semi,vsel-high: Indicates the VSEL pin is high.
12   If this property is missing, assume the VSEL pin is low(0).
13
14 Optional input supply properties:
15 - for act8600:
16   - vp1-supply: The input supply for DCDC_REG1
17   - vp2-supply: The input supply for DCDC_REG2
18   - vp3-supply: The input supply for DCDC_REG3
19   - inl-supply: The input supply for LDO_REG5, LDO_REG6, LDO_REG7 and LDO_REG8
20   SUDCDC_REG4, LDO_REG9 and LDO_REG10 do not have separate supplies.
21 - for act8846:
22   - vp1-supply: The input supply for REG1
23   - vp2-supply: The input supply for REG2
24   - vp3-supply: The input supply for REG3
25   - vp4-supply: The input supply for REG4
26   - inl1-supply: The input supply for REG5, REG6 and REG7
27   - inl2-supply: The input supply for REG8 and LDO_REG9
28   - inl3-supply: The input supply for REG10, REG11 and REG12
29 - for act8865:
30   - vp1-supply: The input supply for DCDC_REG1
31   - vp2-supply: The input supply for DCDC_REG2
32   - vp3-supply: The input supply for DCDC_REG3
33   - inl45-supply: The input supply for LDO_REG1 and LDO_REG2
34   - inl67-supply: The input supply for LDO_REG3 and LDO_REG4
35
36 Any standard regulator properties can be used to configure the single regulator.
37 regulator-initial-mode, regulator-allowed-modes and regulator-mode could be specified
38 for act8865 using mode values from dt-bindings/regulator/active-semi,8865-regulator.h
39 file.
40
41 The valid names for regulators are:
42         - for act8846:
43         REG1, REG2, REG3, REG4, REG5, REG6, REG7, REG8, REG9, REG10, REG11, REG12
44         - for act8865:
45         DCDC_REG1, DCDC_REG2, DCDC_REG3, LDO_REG1, LDO_REG2, LDO_REG3, LDO_REG4.
46         - for act8600:
47         DCDC_REG1, DCDC_REG2, DCDC_REG3, SUDCDC_REG4, LDO_REG5, LDO_REG6, LDO_REG7,
48         LDO_REG8, LDO_REG9, LDO_REG10,
49
50 Example:
51 --------
52
53 #include <dt-bindings/regulator/active-semi,8865-regulator.h>
54
55                 i2c1: i2c@f0018000 {
56                         pmic: act8865@5b {
57                                 compatible = "active-semi,act8865";
58                                 reg = <0x5b>;
59                                 active-semi,vsel-high;
60
61                                 regulators {
62                                         vcc_1v8_reg: DCDC_REG1 {
63                                                 regulator-name = "VCC_1V8";
64                                                 regulator-min-microvolt = <1800000>;
65                                                 regulator-max-microvolt = <1800000>;
66                                                 regulator-always-on;
67                                         };
68
69                                         vcc_1v2_reg: DCDC_REG2 {
70                                                 regulator-name = "VCC_1V2";
71                                                 regulator-min-microvolt = <1100000>;
72                                                 regulator-max-microvolt = <1300000>;
73                                                 regulator-always-on;
74
75                                                 regulator-allowed-modes = <ACT8865_REGULATOR_MODE_FIXED>,
76                                                                           <ACT8865_REGULATOR_MODE_LOWPOWER>;
77                                                 regulator-initial-mode = <ACT8865_REGULATOR_MODE_FIXED>;
78
79                                                 regulator-state-mem {
80                                                         regulator-on-in-suspend;
81                                                         regulator-suspend-min-microvolt = <1150000>;
82                                                         regulator-suspend-max-microvolt = <1150000>;
83                                                         regulator-changeable-in-suspend;
84                                                         regulator-mode = <ACT8865_REGULATOR_MODE_LOWPOWER>;
85                                                 };
86                                         };
87
88                                         vcc_3v3_reg: DCDC_REG3 {
89                                                 regulator-name = "VCC_3V3";
90                                                 regulator-min-microvolt = <3300000>;
91                                                 regulator-max-microvolt = <3300000>;
92                                                 regulator-always-on;
93                                         };
94
95                                         vddana_reg: LDO_REG1 {
96                                                 regulator-name = "VDDANA";
97                                                 regulator-min-microvolt = <3300000>;
98                                                 regulator-max-microvolt = <3300000>;
99                                                 regulator-always-on;
100
101                                                 regulator-allowed-modes = <ACT8865_REGULATOR_MODE_NORMAL>,
102                                                                           <ACT8865_REGULATOR_MODE_LOWPOWER>;
103                                                 regulator-initial-mode = <ACT8865_REGULATOR_MODE_NORMAL>;
104
105                                                 regulator-state-mem {
106                                                         regulator-off-in-suspend;
107                                                 };
108                                         };
109
110                                         vddfuse_reg: LDO_REG2 {
111                                                 regulator-name = "FUSE_2V5";
112                                                 regulator-min-microvolt = <2500000>;
113                                                 regulator-max-microvolt = <2500000>;
114                                         };
115                                 };
116                         };
117                 };