blob: 86074334e342cc38ec4da009fa019b69a27ce031 [file] [log] [blame]
Rajendra Nayak8f446e62011-11-18 16:47:17 +05301Voltage/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
Kishon Vijay Abraham I93134c72013-06-20 14:07:37 +053012- regulator-allow-bypass: allow the regulator to go into bypass mode
Rajendra Nayak8f446e62011-11-18 16:47:17 +053013- <name>-supply: phandle to the parent supply/regulator node
Axel Linea38d132012-06-18 14:03:16 +080014- regulator-ramp-delay: ramp delay for regulator(in uV/uS)
Carlos Garciac98be0c2014-04-04 22:31:00 -040015 For hardware which supports disabling ramp rate, it should be explicitly
Yadwinder Singh Brar1653ccf2013-06-29 18:21:15 +053016 intialised to zero (regulator-ramp-delay = <0>) for disabling ramp delay.
Laxman Dewangan00c877c2013-09-18 18:18:02 +053017- regulator-enable-ramp-delay: The time taken, in microseconds, for the supply
18 rail to reach the target voltage, plus/minus whatever tolerance the board
19 design requires. This property describes the total system ramp time
20 required due to the combination of internal ramping of the regulator itself,
21 and board design issues such as trace capacitance and load on the supply.
Stephen Warren13511de2012-09-24 13:25:00 -060022
23Deprecated properties:
Laxman Dewangan8c5e4612012-07-05 12:53:04 +053024- regulator-compatible: If a regulator chip contains multiple
25 regulators, and if the chip's binding contains a child node that
26 describes each regulator, then this property indicates which regulator
Stephen Warren13511de2012-09-24 13:25:00 -060027 this child node is intended to configure. If this property is missing,
28 the node's name will be used instead.
Rajendra Nayak8f446e62011-11-18 16:47:17 +053029
30Example:
31
32 xyzreg: regulator@0 {
33 regulator-min-microvolt = <1000000>;
34 regulator-max-microvolt = <2500000>;
35 regulator-always-on;
36 vin-supply = <&vin>;
37 };
38
39Regulator Consumers:
40Consumer nodes can reference one or more of its supplies/
41regulators using the below bindings.
42
43- <name>-supply: phandle to the regulator node
44
45These are the same bindings that a regulator in the above
46example used to reference its own supply, in which case
47its just seen as a special case of a regulator being a
48consumer itself.
49
50Example of a consumer device node (mmc) referencing two
Shawn Guo7728c142011-11-28 21:37:16 +080051regulators (twl_reg1 and twl_reg2),
Rajendra Nayak8f446e62011-11-18 16:47:17 +053052
Shawn Guo7728c142011-11-28 21:37:16 +080053 twl_reg1: regulator@0 {
Rajendra Nayak8f446e62011-11-18 16:47:17 +053054 ...
55 ...
56 ...
57 };
58
Shawn Guo7728c142011-11-28 21:37:16 +080059 twl_reg2: regulator@1 {
Rajendra Nayak8f446e62011-11-18 16:47:17 +053060 ...
61 ...
62 ...
63 };
64
65 mmc: mmc@0x0 {
66 ...
67 ...
Shawn Guo7728c142011-11-28 21:37:16 +080068 vmmc-supply = <&twl_reg1>;
69 vmmcaux-supply = <&twl_reg2>;
Rajendra Nayak8f446e62011-11-18 16:47:17 +053070 };