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-always-on:
41   regulator-boot-on:
46       This property is intended to only be used for regulators where
50   regulator-allow-bypass:
51     description: allow the regulator to go into bypass mode
54   regulator-allow-set-load:
55     description: allow the regulator performance level to be configured
58   regulator-ramp-delay:
60       disabling ramp rate, it should be explicitly initialised to zero (regulator-ramp-delay
64   regulator-enable-ramp-delay:
65     description: The time taken, in microseconds, for the supply rail to
68       required due to the combination of internal ramping of the regulator
73   regulator-settling-time-us:
78   regulator-settling-time-up-us:
80       the regulator needs a constant time to settle after voltage increases
84   regulator-settling-time-down-us:
86       the regulator needs a constant time to settle after voltage decreases
90   regulator-soft-start:
94   regulator-initial-mode:
100   regulator-allowed-modes:
101     description: list of operating modes that software is allowed to configure
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:
118     description: Set if the regulator is critical to system stability or
122   regulator-over-current-protection:
126   regulator-oc-protection-microamp:
128       hardware performs emergency shutdown. Zero can be passed to disable
132   regulator-oc-error-microamp:
135       Zero can be passed to disable error detection and value '1' indicates
138   regulator-oc-warn-microamp:
140       is assumed still to be functional but approaching limit where it gets
141       damaged. Recovery actions should be initiated. Zero can be passed to
145   regulator-ov-protection-microvolt:
147       hardware performs emergency shutdown. Zero can be passed to disable
150       voltage set to regulator.
152   regulator-ov-error-microvolt:
155       Zero can be passed to disable error detection and value '1' indicates
157       is given as microvolt offset from voltage set to regulator.
159   regulator-ov-warn-microvolt:
161       is assumed still to be functional but approaching limit where it gets
162       damaged. Recovery actions should be initiated. Zero can be passed to
165       offset from voltage set to regulator.
167   regulator-uv-protection-microvolt:
169       hardware performs emergency shutdown. Zero can be passed to disable
172       voltage set to regulator.
174   regulator-uv-error-microvolt:
177       Zero can be passed to disable error detection and value '1' indicates
179       is given as microvolt offset from voltage set to regulator.
181   regulator-uv-warn-microvolt:
183       hardware is assumed still to be functional but approaching limit where
185       to disable detection and value '1' indicates that detection should
187       offset from voltage set to regulator.
189   regulator-uv-less-critical-window-ms:
191       critical under-voltage event during which the system can continue to
193       provides a defined duration before a more severe reaction to the
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
203   regulator-temp-error-kelvin:
206       Zero can be passed to disable error detection and value '1' indicates
209   regulator-temp-warn-kelvin:
211       hardware is assumed still to be functional but approaching limit where it
212       gets damaged. Recovery actions should be initiated. Zero can be passed to
216   regulator-active-discharge:
221       Absence of this property will leave configuration to default.
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:
235       in microvolts, each value in the array relates to the corresponding
236       couple specified by the regulator-coupled-with property.
237     $ref: /schemas/types.yaml#/definitions/uint32-array
239   regulator-max-step-microvolt:
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:
256         description: regulator should be on in suspend state.
259       regulator-off-in-suspend:
260         description: regulator should be off in suspend state.
263       regulator-suspend-min-microvolt:
264         description: minimum voltage may be set in suspend state.
266       regulator-suspend-max-microvolt:
267         description: maximum voltage may be set in suspend state.
269       regulator-suspend-microvolt:
271           suspend. This property is now deprecated, instead setting voltage
272           for suspend mode via the API which regulator driver provides is
275       regulator-changeable-in-suspend:
277           in suspend can be changed in runtime.
280       regulator-mode:
281         description: operating mode in the given suspend state. The set
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;