Commit | Line | Data |
---|---|---|
8f446e6f RN |
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 | |
36e4f839 | 10 | - regulator-input-current-limit-microamp: maximum input current regulator allows |
8f446e6f RN |
11 | - regulator-always-on: boolean, regulator should never be disabled |
12 | - regulator-boot-on: bootloader/firmware enabled regulator | |
93134c7b | 13 | - regulator-allow-bypass: allow the regulator to go into bypass mode |
b263d203 | 14 | - regulator-allow-set-load: allow the regulator performance level to be configured |
8f446e6f | 15 | - <name>-supply: phandle to the parent supply/regulator node |
ea38d13f | 16 | - regulator-ramp-delay: ramp delay for regulator(in uV/uS) |
c98be0c9 | 17 | For hardware which supports disabling ramp rate, it should be explicitly |
126187da | 18 | initialised to zero (regulator-ramp-delay = <0>) for disabling ramp delay. |
00c877c6 LD |
19 | - regulator-enable-ramp-delay: The time taken, in microseconds, for the supply |
20 | rail to reach the target voltage, plus/minus whatever tolerance the board | |
21 | design requires. This property describes the total system ramp time | |
22 | required due to the combination of internal ramping of the regulator itself, | |
23 | and board design issues such as trace capacitance and load on the supply. | |
57f66b78 | 24 | - regulator-soft-start: Enable soft start so that voltage ramps slowly |
291d761c CC |
25 | - regulator-state-mem sub-root node for Suspend-to-RAM mode |
26 | : suspend to memory, the device goes to sleep, but all data stored in memory, | |
27 | only some external interrupt can wake the device. | |
28 | - regulator-state-disk sub-root node for Suspend-to-DISK mode | |
29 | : suspend to disk, this state operates similarly to Suspend-to-RAM, | |
30 | but includes a final step of writing memory contents to disk. | |
31 | - regulator-state-[mem/disk] node has following common properties: | |
32 | - regulator-on-in-suspend: regulator should be on in suspend state. | |
33 | - regulator-off-in-suspend: regulator should be off in suspend state. | |
c99ade66 DA |
34 | - regulator-suspend-microvolt: regulator should be set to this voltage |
35 | in suspend. | |
218094c9 JMC |
36 | - regulator-mode: operating mode in the given suspend state. |
37 | The set of possible operating modes depends on the capabilities of | |
38 | every hardware so the valid modes are documented on each regulator | |
39 | device tree binding document. | |
40 | - regulator-initial-mode: initial operating mode. The set of possible operating | |
41 | modes depends on the capabilities of every hardware so each device binding | |
42 | documentation explains which values the regulator supports. | |
22a10bca SB |
43 | - regulator-system-load: Load in uA present on regulator that is not captured by |
44 | any consumer request. | |
23c779b9 | 45 | - regulator-pull-down: Enable pull down resistor when the regulator is disabled. |
3a003bae | 46 | - regulator-over-current-protection: Enable over current protection. |
13511def SW |
47 | |
48 | Deprecated properties: | |
8c5e461d LD |
49 | - regulator-compatible: If a regulator chip contains multiple |
50 | regulators, and if the chip's binding contains a child node that | |
51 | describes each regulator, then this property indicates which regulator | |
13511def SW |
52 | this child node is intended to configure. If this property is missing, |
53 | the node's name will be used instead. | |
8f446e6f RN |
54 | |
55 | Example: | |
56 | ||
57 | xyzreg: regulator@0 { | |
58 | regulator-min-microvolt = <1000000>; | |
59 | regulator-max-microvolt = <2500000>; | |
60 | regulator-always-on; | |
61 | vin-supply = <&vin>; | |
291d761c CC |
62 | |
63 | regulator-state-mem { | |
64 | regulator-on-in-suspend; | |
65 | }; | |
8f446e6f RN |
66 | }; |
67 | ||
68 | Regulator Consumers: | |
69 | Consumer nodes can reference one or more of its supplies/ | |
70 | regulators using the below bindings. | |
71 | ||
72 | - <name>-supply: phandle to the regulator node | |
73 | ||
74 | These are the same bindings that a regulator in the above | |
75 | example used to reference its own supply, in which case | |
76 | its just seen as a special case of a regulator being a | |
77 | consumer itself. | |
78 | ||
79 | Example of a consumer device node (mmc) referencing two | |
7728c14a | 80 | regulators (twl_reg1 and twl_reg2), |
8f446e6f | 81 | |
7728c14a | 82 | twl_reg1: regulator@0 { |
8f446e6f RN |
83 | ... |
84 | ... | |
85 | ... | |
86 | }; | |
87 | ||
7728c14a | 88 | twl_reg2: regulator@1 { |
8f446e6f RN |
89 | ... |
90 | ... | |
91 | ... | |
92 | }; | |
93 | ||
94 | mmc: mmc@0x0 { | |
95 | ... | |
96 | ... | |
7728c14a SG |
97 | vmmc-supply = <&twl_reg1>; |
98 | vmmcaux-supply = <&twl_reg2>; | |
8f446e6f | 99 | }; |