2bd8f09787659269bb03847b3517cff2b52cfca9
[firefly-linux-kernel-4.4.55.git] / Documentation / devicetree / bindings / regulator / regulator.txt
1 Voltage/Current Regulators
2
3 Optional properties:
4 - regulator-name: A string used as a descriptive name for regulator outputs
5 - regulator-min-microvolt: smallest voltage consumers may set
6 - regulator-max-microvolt: largest voltage consumers may set
7 - regulator-microvolt-offset: Offset applied to voltages to compensate for voltage drops
8 - regulator-min-microamp: smallest current consumers may set
9 - regulator-max-microamp: largest current consumers may set
10 - regulator-always-on: boolean, regulator should never be disabled
11 - regulator-boot-on: bootloader/firmware enabled regulator
12 - regulator-allow-bypass: allow the regulator to go into bypass mode
13 - <name>-supply: phandle to the parent supply/regulator node
14 - regulator-ramp-delay: ramp delay for regulator(in uV/uS)
15   For hardwares which support disabling ramp rate, it should be explicitly
16   intialised to zero (regulator-ramp-delay = <0>) for disabling ramp delay.
17
18 Deprecated properties:
19 - regulator-compatible: If a regulator chip contains multiple
20   regulators, and if the chip's binding contains a child node that
21   describes each regulator, then this property indicates which regulator
22   this child node is intended to configure. If this property is missing,
23   the node's name will be used instead.
24
25 Example:
26
27         xyzreg: regulator@0 {
28                 regulator-min-microvolt = <1000000>;
29                 regulator-max-microvolt = <2500000>;
30                 regulator-always-on;
31                 vin-supply = <&vin>;
32         };
33
34 Regulator Consumers:
35 Consumer nodes can reference one or more of its supplies/
36 regulators using the below bindings.
37
38 - <name>-supply: phandle to the regulator node
39
40 These are the same bindings that a regulator in the above
41 example used to reference its own supply, in which case
42 its just seen as a special case of a regulator being a
43 consumer itself.
44
45 Example of a consumer device node (mmc) referencing two
46 regulators (twl_reg1 and twl_reg2),
47
48         twl_reg1: regulator@0 {
49                 ...
50                 ...
51                 ...
52         };
53
54         twl_reg2: regulator@1 {
55                 ...
56                 ...
57                 ...
58         };
59
60         mmc: mmc@0x0 {
61                 ...
62                 ...
63                 vmmc-supply = <&twl_reg1>;
64                 vmmcaux-supply = <&twl_reg2>;
65         };