xref: /freebsd/sys/contrib/device-tree/Bindings/regulator/vctrl.txt (revision e6bfd18d21b225af6a0ed67ceeaf1293b7b9eba5)
1Bindings for Voltage controlled regulators
2==========================================
3
4Required properties:
5--------------------
6- compatible		  : must be "vctrl-regulator".
7- regulator-min-microvolt : smallest voltage consumers may set
8- regulator-max-microvolt : largest voltage consumers may set
9- ctrl-supply		  : The regulator supplying the control voltage.
10- ctrl-voltage-range	  : an array of two integer values describing the range
11			    (min/max) of the control voltage. The values specify
12			    the control voltage needed to generate the corresponding
13			    regulator-min/max-microvolt output voltage.
14
15Optional properties:
16--------------------
17- ovp-threshold-percent	: overvoltage protection (OVP) threshold of the
18			  regulator in percent. Some regulators have an OVP
19			  circuitry which shuts down the regulator when the
20			  actual output voltage deviates beyond a certain
21			  margin from the expected value for a given control
22			  voltage. On larger voltage decreases this can occur
23			  undesiredly since the output voltage does not adjust
24			  inmediately to changes in the control voltage. To
25			  avoid this situation the vctrl driver breaks down
26			  larger voltage decreases into multiple steps, where
27			  each step is within the OVP threshold.
28- min-slew-down-rate	: Describes how slowly the regulator voltage will decay
29			  down in the worst case (lightest expected load).
30			  Specified in uV / us (like main regulator ramp rate).
31			  This value is required when ovp-threshold-percent is
32			  specified.
33
34Example:
35
36	vctrl-reg {
37		compatible = "vctrl-regulator";
38		regulator-name = "vctrl_reg";
39
40		ctrl-supply = <&ctrl_reg>;
41
42		regulator-min-microvolt = <800000>;
43		regulator-max-microvolt = <1500000>;
44
45		ctrl-voltage-range = <200000 500000>;
46
47		min-slew-down-rate = <225>;
48		ovp-threshold-percent = <16>;
49	};
50