]> Pileus Git - ~andy/linux/blob - Documentation/devicetree/bindings/regulator/regulator.txt
regulator: fix label names used in device tree bindings
[~andy/linux] / 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 - <name>-supply: phandle to the parent supply/regulator node
13
14 Example:
15
16         xyzreg: regulator@0 {
17                 regulator-min-microvolt = <1000000>;
18                 regulator-max-microvolt = <2500000>;
19                 regulator-always-on;
20                 vin-supply = <&vin>;
21         };
22
23 Regulator Consumers:
24 Consumer nodes can reference one or more of its supplies/
25 regulators using the below bindings.
26
27 - <name>-supply: phandle to the regulator node
28
29 These are the same bindings that a regulator in the above
30 example used to reference its own supply, in which case
31 its just seen as a special case of a regulator being a
32 consumer itself.
33
34 Example of a consumer device node (mmc) referencing two
35 regulators (twl_reg1 and twl_reg2),
36
37         twl_reg1: regulator@0 {
38                 ...
39                 ...
40                 ...
41         };
42
43         twl_reg2: regulator@1 {
44                 ...
45                 ...
46                 ...
47         };
48
49         mmc: mmc@0x0 {
50                 ...
51                 ...
52                 vmmc-supply = <&twl_reg1>;
53                 vmmcaux-supply = <&twl_reg2>;
54         };