GNU Linux-libre 4.19.264-gnu1
[releases.git] / Documentation / devicetree / bindings / regulator / max77686.txt
1 Binding for Maxim MAX77686 regulators
2
3 This is a part of the device tree bindings of MAX77686 multi-function device.
4 More information can be found in ../mfd/max77686.txt file.
5
6 The MAX77686 PMIC has 9 high-efficiency Buck and 26 Low-DropOut (LDO)
7 regulators that can be controlled over I2C.
8
9 Following properties should be present in main device node of the MFD chip.
10
11 Optional node:
12 - voltage-regulators : The regulators of max77686 have to be instantiated
13   under subnode named "voltage-regulators" using the following format.
14
15         regulator_name {
16                 regulator-compatible = LDOn/BUCKn
17                 standard regulator constraints....
18         };
19         refer Documentation/devicetree/bindings/regulator/regulator.txt
20
21   The regulator node's name should be initialized with a string
22 to get matched with their hardware counterparts as follow:
23
24         -LDOn   :       for LDOs, where n can lie in range 1 to 26.
25                         example: LDO1, LDO2, LDO26.
26         -BUCKn  :       for BUCKs, where n can lie in range 1 to 9.
27                         example: BUCK1, BUCK5, BUCK9.
28
29   Regulators which can be turned off during system suspend:
30         -LDOn   :       2, 6-8, 10-12, 14-16,
31         -BUCKn  :       1-4.
32   Use standard regulator bindings for it ('regulator-off-in-suspend').
33
34   LDO20, LDO21, LDO22, BUCK8 and BUCK9 can be configured to GPIO enable
35   control. To turn this feature on this property must be added to the regulator
36   sub-node:
37         - maxim,ena-gpios :     one GPIO specifier enable control (the gpio
38                                 flags are actually ignored and always
39                                 ACTIVE_HIGH is used)
40
41 Example:
42
43         max77686: pmic@9 {
44                 compatible = "maxim,max77686";
45                 interrupt-parent = <&wakeup_eint>;
46                 interrupts = <26 IRQ_TYPE_NONE>;
47                 reg = <0x09>;
48
49                 voltage-regulators {
50                         ldo11_reg: LDO11 {
51                                 regulator-name = "vdd_ldo11";
52                                 regulator-min-microvolt = <1900000>;
53                                 regulator-max-microvolt = <1900000>;
54                                 regulator-always-on;
55                         };
56
57                         buck1_reg: BUCK1 {
58                                 regulator-name = "vdd_mif";
59                                 regulator-min-microvolt = <950000>;
60                                 regulator-max-microvolt = <1300000>;
61                                 regulator-always-on;
62                                 regulator-boot-on;
63                         };
64
65                         buck9_reg: BUCK9 {
66                                 regulator-name = "CAM_ISP_CORE_1.2V";
67                                 regulator-min-microvolt = <1000000>;
68                                 regulator-max-microvolt = <1200000>;
69                                 maxim,ena-gpios = <&gpm0 3 GPIO_ACTIVE_HIGH>;
70                         };
71         };