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:
19     description: smallest voltage consumers may set
21   regulator-max-microvolt:
22     description: largest voltage consumers may set
24   regulator-microvolt-offset:
28   regulator-min-microamp:
29     description: smallest current consumers may set
31   regulator-max-microamp:
32     description: largest current consumers may set
34   regulator-input-current-limit-microamp:
37   regulator-power-budget-milliwatt:
40   regulator-always-on:
44   regulator-boot-on:
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
70       design requires. This property describes the total system ramp time
76   regulator-settling-time-us:
77     description: Settling time, in microseconds, for voltage change if regulator
78       have the constant time for any level voltage change. This is useful
81   regulator-settling-time-up-us:
82     description: Settling time, in microseconds, for voltage increase if
83       the regulator needs a constant time to settle after voltage increases
87   regulator-settling-time-down-us:
88     description: Settling time, in microseconds, for voltage decrease if
89       the regulator needs a constant time to settle after voltage decreases
93   regulator-soft-start:
97   regulator-initial-mode:
98     description: initial operating mode. The set of possible operating modes
103   regulator-allowed-modes:
105       for the regulator at run-time.  Elements may be specified in any order.
106       The set of possible operating modes depends on the capabilities of
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:
130     description: Set over current protection limit. This is a limit where
135   regulator-oc-error-microamp:
136     description: Set over current error limit. This is a limit where part of
141   regulator-oc-warn-microamp:
142     description: Set over current warning limit. This is a limit where hardware
148   regulator-ov-protection-microvolt:
149     description: Set over voltage protection limit. This is a limit where
153       voltage set to regulator.
155   regulator-ov-error-microvolt:
156     description: Set over voltage error limit. This is a limit where part of
160       is given as microvolt offset from voltage set to regulator.
162   regulator-ov-warn-microvolt:
163     description: Set over voltage warning limit. This is a limit where hardware
168       offset from voltage set to regulator.
170   regulator-uv-protection-microvolt:
171     description: Set over under voltage protection limit. This is a limit where
175       voltage set to regulator.
177   regulator-uv-error-microvolt:
178     description: Set under voltage error limit. This is a limit where part of
182       is given as microvolt offset from voltage set to regulator.
184   regulator-uv-warn-microvolt:
185     description: Set over under voltage warning limit. This is a limit where
190       offset from voltage set to regulator.
192   regulator-uv-less-critical-window-ms:
193     description: Specifies the time window (in milliseconds) following a
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:
201     description: Set over temperature protection limit. This is a limit where
206   regulator-temp-error-kelvin:
207     description: Set over temperature error limit. This is a limit where part of
212   regulator-temp-warn-kelvin:
213     description: Set over temperature warning limit. This is a limit where
219   regulator-active-discharge:
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:
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:
262       regulator-off-in-suspend:
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:
273         description: the default voltage which regulator would be set in
278       regulator-changeable-in-suspend:
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;