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:
25     description: Offset applied to voltages to compensate for voltage drops
28   regulator-min-microamp:
31   regulator-max-microamp:
34   regulator-input-current-limit-microamp:
37   regulator-power-budget-milliwatt:
40   regulator-always-on:
44   regulator-boot-on:
49       This property is intended to only be used for regulators where
53   regulator-allow-bypass:
54     description: allow the regulator to go into bypass mode
57   regulator-allow-set-load:
58     description: allow the regulator performance level to be configured
61   regulator-ramp-delay:
63       disabling ramp rate, it should be explicitly initialised to zero (regulator-ramp-delay
67   regulator-enable-ramp-delay:
68     description: The time taken, in microseconds, for the supply rail to
71       required due to the combination of internal ramping of the regulator
76   regulator-settling-time-us:
81   regulator-settling-time-up-us:
83       the regulator needs a constant time to settle after voltage increases
87   regulator-settling-time-down-us:
89       the regulator needs a constant time to settle after voltage decreases
93   regulator-soft-start:
97   regulator-initial-mode:
103   regulator-allowed-modes:
104     description: list of operating modes that software is allowed to configure
105       for the regulator at run-time.  Elements may be specified in any order.
109     $ref: /schemas/types.yaml#/definitions/uint32-array
111   regulator-system-load:
116   regulator-pull-down:
120   system-critical-regulator:
121     description: Set if the regulator is critical to system stability or
125   regulator-over-current-protection:
129   regulator-oc-protection-microamp:
131       hardware performs emergency shutdown. Zero can be passed to disable
135   regulator-oc-error-microamp:
138       Zero can be passed to disable error detection and value '1' indicates
141   regulator-oc-warn-microamp:
143       is assumed still to be functional but approaching limit where it gets
144       damaged. Recovery actions should be initiated. Zero can be passed to
148   regulator-ov-protection-microvolt:
150       hardware performs emergency shutdown. Zero can be passed to disable
153       voltage set to regulator.
155   regulator-ov-error-microvolt:
158       Zero can be passed to disable error detection and value '1' indicates
160       is given as microvolt offset from voltage set to regulator.
162   regulator-ov-warn-microvolt:
164       is assumed still to be functional but approaching limit where it gets
165       damaged. Recovery actions should be initiated. Zero can be passed to
168       offset from voltage set to regulator.
170   regulator-uv-protection-microvolt:
172       hardware performs emergency shutdown. Zero can be passed to disable
175       voltage set to regulator.
177   regulator-uv-error-microvolt:
180       Zero can be passed to disable error detection and value '1' indicates
182       is given as microvolt offset from voltage set to regulator.
184   regulator-uv-warn-microvolt:
186       hardware is assumed still to be functional but approaching limit where
188       to disable detection and value '1' indicates that detection should
190       offset from voltage set to regulator.
192   regulator-uv-less-critical-window-ms:
194       critical under-voltage event during which the system can continue to
196       provides a defined duration before a more severe reaction to the
197       under-voltage event is needed, allowing for certain non-urgent actions to
200   regulator-temp-protection-kelvin:
202       hardware performs emergency shutdown. Zero can be passed to disable
206   regulator-temp-error-kelvin:
209       Zero can be passed to disable error detection and value '1' indicates
212   regulator-temp-warn-kelvin:
214       hardware is assumed still to be functional but approaching limit where it
215       gets damaged. Recovery actions should be initiated. Zero can be passed to
219   regulator-active-discharge:
224       Absence of this property will leave configuration to default.
228   regulator-coupled-with:
230       is 2-way - all coupled regulators should be linked with each other.
232     $ref: /schemas/types.yaml#/definitions/phandle-array
236   regulator-coupled-max-spread:
238       in microvolts, each value in the array relates to the corresponding
239       couple specified by the regulator-coupled-with property.
240     $ref: /schemas/types.yaml#/definitions/uint32-array
242   regulator-max-step-microvolt:
247   ".*-supply$":
250   "^regulator-state-(standby|mem|disk)$":
253       sub-nodes for regulator state in Standby, Suspend-to-RAM, and
254       Suspend-to-DISK modes. Equivalent with standby, mem, and disk Linux
258       regulator-on-in-suspend:
259         description: regulator should be on in suspend state.
262       regulator-off-in-suspend:
263         description: regulator should be off in suspend state.
266       regulator-suspend-min-microvolt:
267         description: minimum voltage may be set in suspend state.
269       regulator-suspend-max-microvolt:
270         description: maximum voltage may be set in suspend state.
272       regulator-suspend-microvolt:
274           suspend. This property is now deprecated, instead setting voltage
275           for suspend mode via the API which regulator driver provides is
278       regulator-changeable-in-suspend:
280           in suspend can be changed in runtime.
283       regulator-mode:
284         description: operating mode in the given suspend state. The set
295   - |
297       regulator-min-microvolt = <1000000>;
298       regulator-max-microvolt = <2500000>;
299       regulator-always-on;
300       vin-supply = <&vin>;
302       regulator-state-mem {
303         regulator-on-in-suspend;