bindings/regulator/regulator.yaml

1 # SPDX-License-Identifier: GPL-2.0
3 ---
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
7 title: Voltage/Current Regulators
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:
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:
35     description: maximum input current regulator allows
37   regulator-always-on:
41   regulator-boot-on:
50   regulator-allow-bypass:
54   regulator-allow-set-load:
58   regulator-ramp-delay:
60       disabling ramp rate, it should be explicitly initialised to zero (regulator-ramp-delay
64   regulator-enable-ramp-delay:
73   regulator-settling-time-us:
78   regulator-settling-time-up-us:
84   regulator-settling-time-down-us:
90   regulator-soft-start:
94   regulator-initial-mode:
100   regulator-allowed-modes:
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   regulator-over-current-protection:
118     description: Enable over current protection.
121   regulator-oc-protection-microamp:
122     description: Set over current protection limit. This is a limit where
125       limit setting can be omitted.
127   regulator-oc-error-microamp:
128     description: Set over current error limit. This is a limit where part of
131       that detection should be enabled but limit setting can be omitted.
133   regulator-oc-warn-microamp:
134     description: Set over current warning limit. This is a limit where hardware
135       is assumed still to be functional but approaching limit where it gets
138       be enabled but limit setting can be omitted.
140   regulator-ov-protection-microvolt:
141     description: Set over voltage protection limit. This is a limit where
144       limit setting can be omitted. Limit is given as microvolt offset from
147   regulator-ov-error-microvolt:
148     description: Set over voltage error limit. This is a limit where part of
151       that detection should be enabled but limit setting can be omitted. Limit
154   regulator-ov-warn-microvolt:
155     description: Set over voltage warning limit. This is a limit where hardware
156       is assumed still to be functional but approaching limit where it gets
159       be enabled but limit setting can be omitted. Limit is given as microvolt
162   regulator-uv-protection-microvolt:
163     description: Set over under voltage protection limit. This is a limit where
166       limit setting can be omitted. Limit is given as microvolt offset from
169   regulator-uv-error-microvolt:
170     description: Set under voltage error limit. This is a limit where part of
173       that detection should be enabled but limit setting can be omitted. Limit
176   regulator-uv-warn-microvolt:
177     description: Set over under voltage warning limit. This is a limit where
178       hardware is assumed still to be functional but approaching limit where
181       be enabled but limit setting can be omitted. Limit is given as microvolt
184   regulator-temp-protection-kelvin:
185     description: Set over temperature protection limit. This is a limit where
188       limit setting can be omitted.
190   regulator-temp-error-kelvin:
191     description: Set over temperature error limit. This is a limit where part of
194       that detection should be enabled but limit setting can be omitted.
196   regulator-temp-warn-kelvin:
197     description: Set over temperature warning limit. This is a limit where
198       hardware is assumed still to be functional but approaching limit where it
201       be enabled but limit setting can be omitted.
203   regulator-active-discharge:
212   regulator-coupled-with:
214       is 2-way - all coupled regulators should be linked with each other.
216     $ref: /schemas/types.yaml#/definitions/phandle-array
220   regulator-coupled-max-spread:
223       couple specified by the regulator-coupled-with property.
224     $ref: /schemas/types.yaml#/definitions/uint32-array
226   regulator-max-step-microvolt:
227     description: Maximum difference between current and target voltages
231   ".*-supply$":
234   "^regulator-state-(standby|mem|disk)$":
237       sub-nodes for regulator state in Standby, Suspend-to-RAM, and
238       Suspend-to-DISK modes. Equivalent with standby, mem, and disk Linux
242       regulator-on-in-suspend:
246       regulator-off-in-suspend:
250       regulator-suspend-min-microvolt:
253       regulator-suspend-max-microvolt:
256       regulator-suspend-microvolt:
262       regulator-changeable-in-suspend:
267       regulator-mode:
279   - |
281       regulator-min-microvolt = <1000000>;
282       regulator-max-microvolt = <2500000>;
283       regulator-always-on;
284       vin-supply = <&vin>;
286       regulator-state-mem {
287         regulator-on-in-suspend;