bindings/regulator/regulator.yaml

1 # SPDX-License-Identifier: GPL-2.0
3 ---
4 $id: http://devicetree.org/schemas/regulator/regulator.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
10   - Liam Girdwood <lgirdwood@gmail.com>
11   - Mark Brown <broonie@kernel.org>
14   regulator-name:
15     description: A string used as a descriptive name for regulator outputs
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:
35     description: maximum input current regulator allows
37   regulator-always-on:
38     description: boolean, regulator should never be disabled
41   regulator-boot-on:
42     description: bootloader/firmware enabled regulator.
43       It's expected that this regulator was left on by the bootloader.
47       software cannot read the state of the regulator.
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:
59     description: ramp delay for regulator(in uV/us) For hardware which supports
60       disabling ramp rate, it should be explicitly initialised to zero (regulator-ramp-delay
64   regulator-enable-ramp-delay:
68       required due to the combination of internal ramping of the regulator
73   regulator-settling-time-us:
74     description: Settling time, in microseconds, for voltage change if regulator
76       when regulator have exponential voltage change.
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:
97       documentation explains which values the regulator supports.
100   regulator-allowed-modes:
102       for the regulator at run-time.  Elements may be specified in any order.
105       the regulator supports.
106     $ref: /schemas/types.yaml#/definitions/uint32-array
108   regulator-system-load:
109     description: Load in uA present on regulator that is not captured by
113   regulator-pull-down:
114     description: Enable pull down resistor when the regulator is disabled.
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:
132   regulator-oc-error-microamp:
138   regulator-oc-warn-microamp:
145   regulator-ov-protection-microvolt:
150       voltage set to regulator.
152   regulator-ov-error-microvolt:
157       is given as microvolt offset from voltage set to regulator.
159   regulator-ov-warn-microvolt:
165       offset from voltage set to regulator.
167   regulator-uv-protection-microvolt:
172       voltage set to regulator.
174   regulator-uv-error-microvolt:
179       is given as microvolt offset from voltage set to regulator.
181   regulator-uv-warn-microvolt:
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
194       under-voltage event is needed, allowing for certain non-urgent actions to
197   regulator-temp-protection-kelvin:
203   regulator-temp-error-kelvin:
209   regulator-temp-warn-kelvin:
216   regulator-active-discharge:
225   regulator-coupled-with:
226     description: Regulators with which the regulator is coupled. The linkage
227       is 2-way - all coupled regulators should be linked with each other.
228       A regulator should not be coupled with its supplier.
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:
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:
266       regulator-suspend-max-microvolt:
269       regulator-suspend-microvolt:
270         description: the default voltage which regulator would be set in
272           for suspend mode via the API which regulator driver provides is
275       regulator-changeable-in-suspend:
276         description: whether the default voltage and the regulator on/off
280       regulator-mode:
283           hardware so the valid modes are documented on each regulator device
292   - |
293     xyzreg: regulator {
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;