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-power-budget-milliwatt:
38     description: power budget of the regulator
40   regulator-always-on:
41     description: boolean, regulator should never be disabled
44   regulator-boot-on:
45     description: bootloader/firmware enabled regulator.
46       It's expected that this regulator was left on by the bootloader.
50       software cannot read the state of the regulator.
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:
62     description: ramp delay for regulator(in uV/us) For hardware which supports
63       disabling ramp rate, it should be explicitly initialised to zero (regulator-ramp-delay
67   regulator-enable-ramp-delay:
70       design requires. This property describes the total system ramp time
71       required due to the combination of internal ramping of the regulator
72       itself, and board design issues such as trace capacitance and load
76   regulator-settling-time-us:
77     description: Settling time, in microseconds, for voltage change if regulator
79       when regulator have exponential voltage change.
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:
100       documentation explains which values the regulator supports.
103   regulator-allowed-modes:
105       for the regulator at run-time.  Elements may be specified in any order.
108       the regulator supports.
109     $ref: /schemas/types.yaml#/definitions/uint32-array
111   regulator-system-load:
112     description: Load in uA present on regulator that is not captured by
116   regulator-pull-down:
117     description: Enable pull down resistor when the regulator is disabled.
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:
135   regulator-oc-error-microamp:
141   regulator-oc-warn-microamp:
148   regulator-ov-protection-microvolt:
153       voltage set to regulator.
155   regulator-ov-error-microvolt:
160       is given as microvolt offset from voltage set to regulator.
162   regulator-ov-warn-microvolt:
168       offset from voltage set to regulator.
170   regulator-uv-protection-microvolt:
175       voltage set to regulator.
177   regulator-uv-error-microvolt:
182       is given as microvolt offset from voltage set to regulator.
184   regulator-uv-warn-microvolt:
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
197       under-voltage event is needed, allowing for certain non-urgent actions to
200   regulator-temp-protection-kelvin:
206   regulator-temp-error-kelvin:
212   regulator-temp-warn-kelvin:
219   regulator-active-discharge:
228   regulator-coupled-with:
229     description: Regulators with which the regulator is coupled. The linkage
230       is 2-way - all coupled regulators should be linked with each other.
231       A regulator should not be coupled with its supplier.
232     $ref: /schemas/types.yaml#/definitions/phandle-array
236   regulator-coupled-max-spread:
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:
269       regulator-suspend-max-microvolt:
272       regulator-suspend-microvolt:
273         description: the default voltage which regulator would be set in
275           for suspend mode via the API which regulator driver provides is
278       regulator-changeable-in-suspend:
279         description: whether the default voltage and the regulator on/off
283       regulator-mode:
286           hardware so the valid modes are documented on each regulator device
295   - |
296     xyzreg: regulator {
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;