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
130       limit setting can be omitted.
132   regulator-oc-error-microamp:
133     description: Set over current error limit. This is a limit where part of
136       that detection should be enabled but limit setting can be omitted.
138   regulator-oc-warn-microamp:
139     description: Set over current warning limit. This is a limit where hardware
140       is assumed still to be functional but approaching limit where it gets
143       be enabled but limit setting can be omitted.
145   regulator-ov-protection-microvolt:
146     description: Set over voltage protection limit. This is a limit where
149       limit setting can be omitted. Limit is given as microvolt offset from
152   regulator-ov-error-microvolt:
153     description: Set over voltage error limit. This is a limit where part of
156       that detection should be enabled but limit setting can be omitted. Limit
159   regulator-ov-warn-microvolt:
160     description: Set over voltage warning limit. This is a limit where hardware
161       is assumed still to be functional but approaching limit where it gets
164       be enabled but limit setting can be omitted. Limit is given as microvolt
167   regulator-uv-protection-microvolt:
168     description: Set over under voltage protection limit. This is a limit where
171       limit setting can be omitted. Limit is given as microvolt offset from
174   regulator-uv-error-microvolt:
175     description: Set under voltage error limit. This is a limit where part of
178       that detection should be enabled but limit setting can be omitted. Limit
181   regulator-uv-warn-microvolt:
182     description: Set over under voltage warning limit. This is a limit where
183       hardware is assumed still to be functional but approaching limit where
186       be enabled but limit setting can be omitted. Limit is given as microvolt
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
201       limit setting can be omitted.
203   regulator-temp-error-kelvin:
204     description: Set over temperature error limit. This is a limit where part of
207       that detection should be enabled but limit setting can be omitted.
209   regulator-temp-warn-kelvin:
210     description: Set over temperature warning limit. This is a limit where
211       hardware is assumed still to be functional but approaching limit where it
214       be enabled but limit setting can be omitted.
216   regulator-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;