GNU Linux-libre 4.14.266-gnu1
[releases.git] / Documentation / devicetree / bindings / regulator / samsung,s2mpa01.txt
1 Binding for Samsung S2MPA01 regulator block
2 ===========================================
3
4 This is a part of device tree bindings for S2M family multi-function devices.
5 More information can be found in bindings/mfd/sec-core.txt file.
6
7 The S2MPA01 device provide buck and LDO regulators.
8
9 To register these with regulator framework instantiate under main device node
10 a sub-node named "regulators" with more sub-nodes for each regulator using the
11 common regulator binding documented in:
12  - Documentation/devicetree/bindings/regulator/regulator.txt
13
14
15 Names of regulators supported by S2MPA01 device:
16         - LDOn
17                   - valid values for n are 1 to 26
18                   - Example: LDO1, LD02, LDO26
19         - BUCKn
20                   - valid values for n are 1 to 10.
21                   - Example: BUCK1, BUCK2, BUCK9
22 Note: The 'n' in LDOn and BUCKn represents the LDO or BUCK number
23 as per the datasheet of device.
24
25
26 Optional properties of buck regulator nodes under "regulators" sub-node:
27  - regulator-ramp-delay: ramp delay in uV/us. May be 6250, 12500
28    (default), 25000, or 50000. May be 0 for disabling the ramp delay on
29    BUCK{1,2,3,4}.
30
31    In the absence of the regulator-ramp-delay property, the default ramp
32    delay will be used.
33
34    Note: Some bucks share the ramp rate setting i.e. same ramp value
35    will be set for a particular group of bucks so provide the same
36    regulator-ramp-delay value for them.
37    Groups sharing ramp rate:
38     - buck{1,6},
39     - buck{2,4},
40     - buck{8,9,10}.
41
42 Example:
43
44         s2mpa01_pmic@66 {
45                 compatible = "samsung,s2mpa01-pmic";
46                 reg = <0x66>;
47
48                 regulators {
49                         ldo1_reg: LDO1 {
50                                 regulator-name = "VDD_ALIVE";
51                                 regulator-min-microvolt = <1000000>;
52                                 regulator-max-microvolt = <1000000>;
53                         };
54
55                         ldo2_reg: LDO2 {
56                                 regulator-name = "VDDQ_MMC2";
57                                 regulator-min-microvolt = <2800000>;
58                                 regulator-max-microvolt = <2800000>;
59                                 regulator-always-on;
60                         };
61
62                         buck1_reg: BUCK1 {
63                                 regulator-name = "vdd_mif";
64                                 regulator-min-microvolt = <950000>;
65                                 regulator-max-microvolt = <1350000>;
66                                 regulator-always-on;
67                                 regulator-boot-on;
68                         };
69
70                         buck2_reg: BUCK2 {
71                                 regulator-name = "vdd_arm";
72                                 regulator-min-microvolt = <950000>;
73                                 regulator-max-microvolt = <1350000>;
74                                 regulator-always-on;
75                                 regulator-boot-on;
76                                 regulator-ramp-delay = <50000>;
77                         };
78                 };
79         };