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