bindings/regulator/regulator.yaml

1 # SPDX-License-Identifier: GPL-2.0
3 ---
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
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:
31   regulator-max-microamp:
34   regulator-input-current-limit-microamp:
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:
126   regulator-oc-protection-microamp:
128       hardware performs emergency shutdown. Zero can be passed to disable
130       limit setting can be omitted.
132   regulator-oc-error-microamp:
135       Zero can be passed to disable error detection and value '1' indicates
136       that detection should be enabled but limit setting can be omitted.
138   regulator-oc-warn-microamp:
141       damaged. Recovery actions should be initiated. Zero can be passed to
142       disable detection and value '1' indicates that detection should
143       be enabled but limit setting can be omitted.
145   regulator-ov-protection-microvolt:
147       hardware performs emergency shutdown. Zero can be passed to disable
149       limit setting can be omitted. Limit is given as microvolt offset from
152   regulator-ov-error-microvolt:
155       Zero can be passed to disable error detection and value '1' indicates
156       that detection should be enabled but limit setting can be omitted. Limit
159   regulator-ov-warn-microvolt:
162       damaged. Recovery actions should be initiated. Zero can be passed to
163       disable detection and value '1' indicates that detection should
164       be enabled but limit setting can be omitted. Limit is given as microvolt
167   regulator-uv-protection-microvolt:
169       hardware performs emergency shutdown. Zero can be passed to disable
171       limit setting can be omitted. Limit is given as microvolt offset from
174   regulator-uv-error-microvolt:
177       Zero can be passed to disable error detection and value '1' indicates
178       that detection should be enabled but limit setting can be omitted. Limit
181   regulator-uv-warn-microvolt:
184       it gets damaged. Recovery actions should be initiated. Zero can be passed
185       to disable detection and value '1' indicates that detection should
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:
199       hardware performs emergency shutdown. Zero can be passed to disable
201       limit setting can be omitted.
203   regulator-temp-error-kelvin:
206       Zero can be passed to disable error detection and value '1' indicates
207       that detection should be enabled but limit setting can be omitted.
209   regulator-temp-warn-kelvin:
212       gets damaged. Recovery actions should be initiated. Zero can be passed to
213       disable detection and value '1' indicates that detection should
214       be enabled but limit setting can be omitted.
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:
241       that can be changed safely in a single step.
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:
277           in suspend can be changed in runtime.
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;