bindings/regulator/regulator.yaml

1 # SPDX-License-Identifier: GPL-2.0
3 ---
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
7 title: Voltage/Current Regulators
10   - Liam Girdwood <lgirdwood@gmail.com>
11   - Mark Brown <broonie@kernel.org>
14   regulator-name:
18   regulator-min-microvolt:
21   regulator-max-microvolt:
24   regulator-microvolt-offset:
28   regulator-min-microamp:
29     description: smallest current consumers may set
31   regulator-max-microamp:
32     description: largest current consumers may set
34   regulator-input-current-limit-microamp:
35     description: maximum input current regulator allows
37   regulator-always-on:
41   regulator-boot-on:
50   regulator-allow-bypass:
54   regulator-allow-set-load:
58   regulator-ramp-delay:
60       disabling ramp rate, it should be explicitly initialised to zero (regulator-ramp-delay
64   regulator-enable-ramp-delay:
73   regulator-settling-time-us:
78   regulator-settling-time-up-us:
84   regulator-settling-time-down-us:
90   regulator-soft-start:
94   regulator-initial-mode:
100   regulator-allowed-modes:
102       for the regulator at run-time.  Elements may be specified in any order.
106     $ref: /schemas/types.yaml#/definitions/uint32-array
108   regulator-system-load:
113   regulator-pull-down:
117   system-critical-regulator:
122   regulator-over-current-protection:
123     description: Enable over current protection.
126   regulator-oc-protection-microamp:
127     description: Set over current protection limit. This is a limit where
128       hardware performs emergency shutdown. Zero can be passed to disable
132   regulator-oc-error-microamp:
133     description: Set over current error limit. This is a limit where part of
135       Zero can be passed to disable error detection and value '1' indicates
138   regulator-oc-warn-microamp:
139     description: Set over current warning limit. This is a limit where hardware
142       disable detection and value '1' indicates that detection should
145   regulator-ov-protection-microvolt:
146     description: Set over voltage protection limit. This is a limit where
147       hardware performs emergency shutdown. Zero can be passed to disable
152   regulator-ov-error-microvolt:
153     description: Set over voltage error limit. This is a limit where part of
155       Zero can be passed to disable error detection and value '1' indicates
159   regulator-ov-warn-microvolt:
160     description: Set over voltage warning limit. This is a limit where hardware
163       disable detection and value '1' indicates that detection should
167   regulator-uv-protection-microvolt:
168     description: Set over under voltage protection limit. This is a limit where
169       hardware performs emergency shutdown. Zero can be passed to disable
174   regulator-uv-error-microvolt:
177       Zero can be passed to disable error detection and value '1' indicates
181   regulator-uv-warn-microvolt:
182     description: Set over under voltage warning limit. This is a limit where
185       to disable detection and value '1' indicates that detection should
189   regulator-uv-less-critical-window-ms:
191       critical under-voltage event during which the system can continue to
194       under-voltage event is needed, allowing for certain non-urgent actions to
197   regulator-temp-protection-kelvin:
198     description: Set over temperature protection limit. This is a limit where
199       hardware performs emergency shutdown. Zero can be passed to disable
203   regulator-temp-error-kelvin:
204     description: Set over temperature error limit. This is a limit where part of
206       Zero can be passed to disable error detection and value '1' indicates
209   regulator-temp-warn-kelvin:
210     description: Set over temperature warning limit. This is a limit where
213       disable detection and value '1' indicates that detection should
216   regulator-active-discharge:
218       tristate, enable/disable active discharge of regulators. The values are:
219       0: Disable active discharge.
225   regulator-coupled-with:
227       is 2-way - all coupled regulators should be linked with each other.
229     $ref: /schemas/types.yaml#/definitions/phandle-array
233   regulator-coupled-max-spread:
236       couple specified by the regulator-coupled-with property.
237     $ref: /schemas/types.yaml#/definitions/uint32-array
239   regulator-max-step-microvolt:
240     description: Maximum difference between current and target voltages
244   ".*-supply$":
247   "^regulator-state-(standby|mem|disk)$":
250       sub-nodes for regulator state in Standby, Suspend-to-RAM, and
251       Suspend-to-DISK modes. Equivalent with standby, mem, and disk Linux
255       regulator-on-in-suspend:
259       regulator-off-in-suspend:
263       regulator-suspend-min-microvolt:
266       regulator-suspend-max-microvolt:
269       regulator-suspend-microvolt:
275       regulator-changeable-in-suspend:
280       regulator-mode:
292   - |
294       regulator-min-microvolt = <1000000>;
295       regulator-max-microvolt = <2500000>;
296       regulator-always-on;
297       vin-supply = <&vin>;
299       regulator-state-mem {
300         regulator-on-in-suspend;