Merge remote-tracking branch 'mfd/for-mfd-next'
[karo-tx-linux.git] / Documentation / devicetree / bindings / mfd / s2mps11.txt
1
2 * Samsung S2MPS11, S2MPS13, S2MPS14 and S2MPU02 Voltage and Current Regulator
3
4 The Samsung S2MPS11 is a multi-function device which includes voltage and
5 current regulators, RTC, charger controller and other sub-blocks. It is
6 interfaced to the host controller using an I2C interface. Each sub-block is
7 addressed by the host system using different I2C slave addresses.
8
9 Required properties:
10 - compatible: Should be "samsung,s2mps11-pmic" or "samsung,s2mps13-pmic"
11               or "samsung,s2mps14-pmic" or "samsung,s2mpu02-pmic".
12 - reg: Specifies the I2C slave address of the pmic block. It should be 0x66.
13
14 Optional properties:
15 - interrupt-parent: Specifies the phandle of the interrupt controller to which
16   the interrupts from s2mps11 are delivered to.
17 - interrupts: Interrupt specifiers for interrupt sources.
18 - samsung,s2mps11-acokb-ground: Indicates that ACOKB pin of S2MPS11 PMIC is
19   connected to the ground so the PMIC must manually set PWRHOLD bit in CTRL1
20   register to turn off the power. Usually the ACOKB is pulled up to VBATT so
21   when PWRHOLD pin goes low, the rising ACOKB will trigger power off.
22 - samsung,s2mps11-wrstbi-ground: Indicates that WRSTBI pin of PMIC is pulled
23   down. When the system is suspended it will always go down thus triggerring
24   unwanted buck warm reset (setting buck voltages to default values).
25
26 Optional nodes:
27 - clocks: s2mps11, s2mps13 and s5m8767 provide three(AP/CP/BT) buffered 32.768
28   KHz outputs, so to register these as clocks with common clock framework
29   instantiate a sub-node named "clocks". It uses the common clock binding
30   documented in :
31   [Documentation/devicetree/bindings/clock/clock-bindings.txt]
32   The s2mps14 provides two (AP/BT) buffered 32.768 KHz outputs.
33   - #clock-cells: should be 1.
34
35   - The following is the list of clocks generated by the controller. Each clock
36     is assigned an identifier and client nodes use this identifier to specify
37     the clock which they consume.
38     Clock               ID           Devices
39     ----------------------------------------------------------
40     32KhzAP             0            S2MPS11, S2MPS13, S2MPS14, S5M8767
41     32KhzCP             1            S2MPS11, S2MPS13, S5M8767
42     32KhzBT             2            S2MPS11, S2MPS13, S2MPS14, S5M8767
43
44   - compatible: Should be one of: "samsung,s2mps11-clk", "samsung,s2mps13-clk",
45                 "samsung,s2mps14-clk", "samsung,s5m8767-clk"
46
47 - regulators: The regulators of s2mps11 that have to be instantiated should be
48 included in a sub-node named 'regulators'. Regulator nodes included in this
49 sub-node should be of the format as listed below.
50
51         regulator_name {
52                 [standard regulator constraints....];
53         };
54
55  regulator-ramp-delay for BUCKs = [6250/12500/25000(default)/50000] uV/us
56
57  BUCK[2/3/4/6] supports disabling ramp delay on hardware, so explicitly
58  regulator-ramp-delay = <0> can be used for them to disable ramp delay.
59  In the absence of the regulator-ramp-delay property, the default ramp
60  delay will be used.
61
62 NOTE: Some BUCKs share the ramp rate setting i.e. same ramp value will be set
63 for a particular group of BUCKs. So provide same regulator-ramp-delay<value>.
64 Grouping of BUCKs sharing ramp rate setting is as follow : BUCK[1, 6],
65 BUCK[3, 4], and BUCK[7, 8, 10]
66
67 On S2MPS14 the LDO10, LDO11 and LDO12 can be configured to external control
68 over GPIO. To turn this feature on this property must be added to the regulator
69 sub-node:
70         - samsung,ext-control-gpios: GPIO specifier for one GPIO
71                 controlling this regulator (enable/disable);
72 Example:
73         LDO12 {
74                 regulator-name = "V_EMMC_2.8V";
75                 regulator-min-microvolt = <2800000>;
76                 regulator-max-microvolt = <2800000>;
77                 samsung,ext-control-gpios = <&gpk0 2 0>;
78         };
79
80
81 The regulator constraints inside the regulator nodes use the standard regulator
82 bindings which are documented elsewhere.
83
84 The following are the names of the regulators that the s2mps11 pmic block
85 supports. Note: The 'n' in LDOn and BUCKn represents the LDO or BUCK number
86 as per the datasheet of s2mps11.
87
88         - LDOn
89                   - valid values for n are:
90                         - S2MPS11: 1 to 38
91                         - S2MPS13: 1 to 40
92                         - S2MPS14: 1 to 25
93                         - S2MPU02: 1 to 28
94                   - Example: LDO1, LDO2, LDO28
95         - BUCKn
96                   - valid values for n are:
97                         - S2MPS11: 1 to 10
98                         - S2MPS13: 1 to 10
99                         - S2MPS14: 1 to 5
100                         - S2MPU02: 1 to 7
101                   - Example: BUCK1, BUCK2, BUCK9
102
103 Example:
104
105         s2mps11_pmic@66 {
106                 compatible = "samsung,s2mps11-pmic";
107                 reg = <0x66>;
108
109                 s2m_osc: clocks {
110                         compatible = "samsung,s2mps11-clk";
111                         #clock-cells = <1>;
112                         clock-output-names = "xx", "yy", "zz";
113                 };
114
115                 regulators {
116                         ldo1_reg: LDO1 {
117                                 regulator-name = "VDD_ABB_3.3V";
118                                 regulator-min-microvolt = <3300000>;
119                                 regulator-max-microvolt = <3300000>;
120                         };
121
122                         ldo2_reg: LDO2 {
123                                 regulator-name = "VDD_ALIVE_1.1V";
124                                 regulator-min-microvolt = <1100000>;
125                                 regulator-max-microvolt = <1100000>;
126                                 regulator-always-on;
127                         };
128
129                         buck1_reg: BUCK1 {
130                                 regulator-name = "vdd_mif";
131                                 regulator-min-microvolt = <950000>;
132                                 regulator-max-microvolt = <1350000>;
133                                 regulator-always-on;
134                                 regulator-boot-on;
135                         };
136
137                         buck2_reg: BUCK2 {
138                                 regulator-name = "vdd_arm";
139                                 regulator-min-microvolt = <950000>;
140                                 regulator-max-microvolt = <1350000>;
141                                 regulator-always-on;
142                                 regulator-boot-on;
143                                 regulator-ramp-delay = <50000>;
144                         };
145                 };
146         };