Merge branch 'lpc32xx/dts' of git://git.antcom.de/linux-2.6 into next/dt
[platform/adaptation/renesas_rcar/renesas_kernel.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 - <name>-supply: phandle to the parent supply/regulator node
13 - regulator-ramp-delay: ramp delay for regulator(in uV/uS)
14 - regulator-compatible: If a regulator chip contains multiple
15   regulators, and if the chip's binding contains a child node that
16   describes each regulator, then this property indicates which regulator
17   this child node is intended to configure.
18
19 Example:
20
21         xyzreg: regulator@0 {
22                 regulator-min-microvolt = <1000000>;
23                 regulator-max-microvolt = <2500000>;
24                 regulator-always-on;
25                 vin-supply = <&vin>;
26         };
27
28 Regulator Consumers:
29 Consumer nodes can reference one or more of its supplies/
30 regulators using the below bindings.
31
32 - <name>-supply: phandle to the regulator node
33
34 These are the same bindings that a regulator in the above
35 example used to reference its own supply, in which case
36 its just seen as a special case of a regulator being a
37 consumer itself.
38
39 Example of a consumer device node (mmc) referencing two
40 regulators (twl_reg1 and twl_reg2),
41
42         twl_reg1: regulator@0 {
43                 ...
44                 ...
45                 ...
46         };
47
48         twl_reg2: regulator@1 {
49                 ...
50                 ...
51                 ...
52         };
53
54         mmc: mmc@0x0 {
55                 ...
56                 ...
57                 vmmc-supply = <&twl_reg1>;
58                 vmmcaux-supply = <&twl_reg2>;
59         };