xref: /linux/Documentation/devicetree/bindings/regulator/regulator.txt (revision 0d456bad36d42d16022be045c8a53ddbb59ee478)
1Voltage/Current Regulators
2
3Optional 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- regulator-ramp-delay: ramp delay for regulator(in uV/uS)
14
15Deprecated properties:
16- regulator-compatible: If a regulator chip contains multiple
17  regulators, and if the chip's binding contains a child node that
18  describes each regulator, then this property indicates which regulator
19  this child node is intended to configure. If this property is missing,
20  the node's name will be used instead.
21
22Example:
23
24	xyzreg: regulator@0 {
25		regulator-min-microvolt = <1000000>;
26		regulator-max-microvolt = <2500000>;
27		regulator-always-on;
28		vin-supply = <&vin>;
29	};
30
31Regulator Consumers:
32Consumer nodes can reference one or more of its supplies/
33regulators using the below bindings.
34
35- <name>-supply: phandle to the regulator node
36
37These are the same bindings that a regulator in the above
38example used to reference its own supply, in which case
39its just seen as a special case of a regulator being a
40consumer itself.
41
42Example of a consumer device node (mmc) referencing two
43regulators (twl_reg1 and twl_reg2),
44
45	twl_reg1: regulator@0 {
46		...
47		...
48		...
49	};
50
51	twl_reg2: regulator@1 {
52		...
53		...
54		...
55	};
56
57	mmc: mmc@0x0 {
58		...
59		...
60		vmmc-supply = <&twl_reg1>;
61		vmmcaux-supply = <&twl_reg2>;
62	};
63