GNU Linux-libre 4.14.266-gnu1
[releases.git] / Documentation / devicetree / bindings / regulator / gpio-regulator.txt
1 GPIO controlled regulators
2
3 Required properties:
4 - compatible            : Must be "regulator-gpio".
5 - states                : Selection of available voltages and GPIO configs.
6                           if there are no states, then use a fixed regulator
7
8 Optional properties:
9 - enable-gpio           : GPIO to use to enable/disable the regulator.
10 - gpios                 : GPIO group used to control voltage.
11 - gpios-states          : gpios pin's initial states array. 0: LOW, 1: HIGH.
12                           defualt is LOW if nothing is specified.
13 - startup-delay-us      : Startup time in microseconds.
14 - enable-active-high    : Polarity of GPIO is active high (default is low).
15 - regulator-type        : Specifies what is being regulated, must be either
16                           "voltage" or "current", defaults to voltage.
17
18 Any property defined as part of the core regulator binding defined in
19 regulator.txt can also be used.
20
21 Example:
22
23         mmciv: gpio-regulator {
24                 compatible = "regulator-gpio";
25
26                 regulator-name = "mmci-gpio-supply";
27                 regulator-min-microvolt = <1800000>;
28                 regulator-max-microvolt = <2600000>;
29                 regulator-boot-on;
30
31                 enable-gpio = <&gpio0 23 0x4>;
32                 gpios = <&gpio0 24 0x4
33                          &gpio0 25 0x4>;
34                 states = <1800000 0x3
35                           2200000 0x2
36                           2600000 0x1
37                           2900000 0x0>;
38
39                 startup-delay-us = <100000>;
40                 enable-active-high;
41         };