Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

regulator: dt-bindings: vctrl-regulator: convert to YAML

Convert the vctrl-regulator bindings to DT schema.
This resolves a dtbs check warning for the rk3399-gru devices.

Signed-off-by: Heiko Stuebner <heiko@sntech.de>
Reviewed-by: Conor Dooley <conor.dooley@microchip.com>
Link: https://patch.msgid.link/20240930210424.1994047-1-heiko@sntech.de
Signed-off-by: Mark Brown <broonie@kernel.org>

authored by

Heiko Stuebner and committed by
Mark Brown
4e9a2c91 85eadae6

+80 -49
+80
Documentation/devicetree/bindings/regulator/vctrl-regulator.yaml
··· 1 + # SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause 2 + %YAML 1.2 3 + --- 4 + $id: http://devicetree.org/schemas/regulator/vctrl-regulator.yaml# 5 + $schema: http://devicetree.org/meta-schemas/core.yaml# 6 + 7 + title: Voltage controlled regulators 8 + 9 + maintainers: 10 + - Heiko Stuebner <heiko@sntech.de> 11 + 12 + allOf: 13 + - $ref: regulator.yaml# 14 + 15 + properties: 16 + compatible: 17 + const: vctrl-regulator 18 + 19 + ctrl-supply: 20 + description: Regulator supplying the control voltage 21 + 22 + ctrl-voltage-range: 23 + description: 24 + Array of two integer values describing the range (min/max) of the 25 + control voltage. The values specify the control voltage needed to 26 + generate the corresponding regulator-min/max-microvolt output 27 + voltage. 28 + minItems: 2 29 + maxItems: 2 30 + $ref: /schemas/types.yaml#/definitions/uint32-array 31 + 32 + min-slew-down-rate: 33 + description: 34 + Describes how slowly the regulator voltage will decay down in the 35 + worst case (lightest expected load). Specified in uV / us (like 36 + main regulator ramp rate). This value is required when 37 + ovp-threshold-percent is specified. 38 + $ref: /schemas/types.yaml#/definitions/uint32 39 + 40 + ovp-threshold-percent: 41 + description: 42 + Overvoltage protection (OVP) threshold of the regulator in percent. 43 + Some regulators have an OVP circuitry which shuts down the regulator 44 + when the actual output voltage deviates beyond a certain margin from 45 + the expected value for a given control voltage. On larger voltage 46 + decreases this can occur undesiredly since the output voltage does 47 + not adjust immediately to changes in the control voltage. To avoid 48 + this situation the vctrl driver breaks down larger voltage decreases 49 + into multiple steps, where each step is within the OVP threshold. 50 + minimum: 0 51 + maximum: 100 52 + 53 + unevaluatedProperties: false 54 + 55 + dependencies: 56 + ovp-threshold-percent: [ min-slew-down-rate ] 57 + 58 + required: 59 + - compatible 60 + - ctrl-supply 61 + - ctrl-voltage-range 62 + - regulator-min-microvolt 63 + - regulator-max-microvolt 64 + 65 + examples: 66 + - | 67 + vctrl-reg { 68 + compatible = "vctrl-regulator"; 69 + regulator-name = "vctrl_reg"; 70 + 71 + ctrl-supply = <&ctrl_reg>; 72 + ctrl-voltage-range = <200000 500000>; 73 + 74 + min-slew-down-rate = <225>; 75 + ovp-threshold-percent = <16>; 76 + 77 + regulator-min-microvolt = <800000>; 78 + regulator-max-microvolt = <1500000>; 79 + }; 80 + ...
-49
Documentation/devicetree/bindings/regulator/vctrl.txt
··· 1 - Bindings for Voltage controlled regulators 2 - ========================================== 3 - 4 - Required 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 - 15 - Optional 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 - immediately 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 - 34 - Example: 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 - };