Skip to contentSkip to conversation

dt-bindings: regulators: Document Tegra regulator coupling in json-schema

PATCH In review Thierry Reding 3 participants 6 messages Dec 6, 2021 – Dec 7, 2021

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 dt-bindings: regulators: Document Tegra regulator coupling in json-schema

From: Thierry Reding <[email protected]>

Move the NVIDIA Tegra regulator coupling bindings from the free-form text format into the existing json-schema file for regulators.

---
 .../nvidia,tegra-regulators-coupling.txt      | 65 -------------------
 .../bindings/regulator/regulator.yaml         | 22 +++++++
 2 files changed, 22 insertions(+), 65 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/regulator/nvidia,tegra-regulators-coupling.txt
Documentation/devicetree/bindings/regulator/nvidia,tegra-regulators-coupling.txt deleted +0 -65
deleted file mode 100644
index 4bf2dbf7c6cc..000000000000
@@ -1,65 +0,0 @@
-NVIDIA Tegra Regulators Coupling
-================================
-
-NVIDIA Tegra SoC's have a mandatory voltage-coupling between regulators.
-Thus on Tegra20 there are 3 coupled regulators and on NVIDIA Tegra30
-there are 2.
-
-Tegra20 voltage coupling
-------------------------
-
-On Tegra20 SoC's there are 3 coupled regulators: CORE, RTC and CPU.
-The CORE and RTC voltages shall be in a range of 170mV from each other
-and they both shall be higher than the CPU voltage by at least 120mV.
-
-Tegra30 voltage coupling
-------------------------
-
-On Tegra30 SoC's there are 2 coupled regulators: CORE and CPU. The CORE
-and CPU voltages shall be in a range of 300mV from each other and CORE
-voltage shall be higher than the CPU by N mV, where N depends on the CPU
-voltage.
-
-Required properties:
-- nvidia,tegra-core-regulator: Boolean property that designates regulator
-  as the "Core domain" voltage regulator.
-- nvidia,tegra-rtc-regulator: Boolean property that designates regulator
-  as the "RTC domain" voltage regulator.
-- nvidia,tegra-cpu-regulator: Boolean property that designates regulator
-  as the "CPU domain" voltage regulator.
-
-Example:
-
-	pmic {
-		regulators {
-			core_vdd_reg: core {
-				regulator-name = "vdd_core";
-				regulator-min-microvolt = <950000>;
-				regulator-max-microvolt = <1300000>;
-				regulator-coupled-with = <&rtc_vdd_reg &cpu_vdd_reg>;
-				regulator-coupled-max-spread = <170000 550000>;
-
-				nvidia,tegra-core-regulator;
-			};
-
-			rtc_vdd_reg: rtc {
-				regulator-name = "vdd_rtc";
-				regulator-min-microvolt = <950000>;
-				regulator-max-microvolt = <1300000>;
-				regulator-coupled-with = <&core_vdd_reg &cpu_vdd_reg>;
-				regulator-coupled-max-spread = <170000 550000>;
-
-				nvidia,tegra-rtc-regulator;
-			};
-
-			cpu_vdd_reg: cpu {
-				regulator-name = "vdd_cpu";
-				regulator-min-microvolt = <750000>;
-				regulator-max-microvolt = <1125000>;
-				regulator-coupled-with = <&core_vdd_reg &rtc_vdd_reg>;
-				regulator-coupled-max-spread = <550000 550000>;
-
-				nvidia,tegra-cpu-regulator;
-			};
-		};
-	};
Documentation/devicetree/bindings/regulator/regulator.yaml +22 -0
index ed560ee8714e..14f269f1e877 100644
@@ -224,6 +224,28 @@ properties:
     description: Maximum difference between current and target voltages
       that can be changed safely in a single step.
 
+  # NVIDIA Tegra SoC's have a mandatory voltage-coupling between regulators. Thus on Tegra20 there
+  # are 3 coupled regulators and on NVIDIA Tegra30 there are 2.
+  #
+  # The 3 coupled regulators on Tegra20 are: CORE, RTC and CPU. The CORE and RTC voltages shall be
+  # in a range of 170 mV of each other and they both shall be higher than the CPU voltage by at
+  # least 120 mV.
+  #
+  # The 2 coupled regulators on Tegra30 are: CORE and CPU. The CORE and CPU voltages shall be in
+  # a range of 300 mV of each other and CORE voltage shall be higher than the CPU by N mV, where
+  # N depends on the CPU voltage.
+  nvidia,tegra-core-regulator:
+    $ref: "/schemas/types.yaml#/definitions/flag"
+    description: if present, designates the regulator as the "CORE domain" voltage regulator
+
+  nvidia,tegra-rtc-regulator:
+    $ref: "/schemas/types.yaml#/definitions/flag"
+    description: if present, designates the regulator as the "RTC domain" voltage regulator
+
+  nvidia,tegra-cpu-regulator:
+    $ref: "/schemas/types.yaml#/definitions/flag"
+    description: if present, designates the regulator as the "CPU domain" voltage regulator
+
 patternProperties:
   ".*-supply$":
     description: Input supply phandle(s) for this node
Signature · 1 line
2.33.1
#1 lore raw

06.12.2021 18:40, Thierry Reding пишет:

Documentation/devicetree/bindings/regulator/regulator.yaml properties: · line 247

Quoted 11 lines
Documentation/devicetree/bindings/regulator/regulator.yaml +11 -0
+  nvidia,tegra-core-regulator:
+    $ref: "/schemas/types.yaml#/definitions/flag"
+    description: if present, designates the regulator as the "CORE domain" voltage regulator
+
+  nvidia,tegra-rtc-regulator:
+    $ref: "/schemas/types.yaml#/definitions/flag"
+    description: if present, designates the regulator as the "RTC domain" voltage regulator
+
+  nvidia,tegra-cpu-regulator:
+    $ref: "/schemas/types.yaml#/definitions/flag"
+    description: if present, designates the regulator as the "CPU domain" voltage regulator

What is the difference between "boolean" and
"/schemas/types.yaml#/definitions/flag"?

maintainer
#2 lore raw
In reply to Thierry Reding
Quoted 4 lines · Thierry Reding

From: Thierry Reding <[email protected]>

Move the NVIDIA Tegra regulator coupling bindings from the free-form text format into the existing json-schema file for regulators.

Do we need these properties for every single regulator? This should be its own schema file and then referenced where it is needed.

Quoted 7 lines
---
 .../nvidia,tegra-regulators-coupling.txt      | 65 -------------------
 .../bindings/regulator/regulator.yaml         | 22 +++++++
 2 files changed, 22 insertions(+), 65 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/regulator/nvidia,tegra-regulators-coupling.txt
#3 lore raw

06.12.2021 23:40, Rob Herring пишет:

Quoted 8 lines · Thierry Reding
Quoted 4 lines

From: Thierry Reding <[email protected]>

Move the NVIDIA Tegra regulator coupling bindings from the free-form text format into the existing json-schema file for regulators.

Do we need these properties for every single regulator? This should be its own schema file and then referenced where it is needed.

These properties are SoC-specific, they describe how regulators are integrated into SoC's power subsystem. Regulators themselves are SoC-independent, i.e. PMIC's vendor and model don't matter for SoC.

maintainer
#4 lore raw
Quoted 8 lines · Dmitry Osipenko

06.12.2021 23:40, Rob Herring пишет:

Quoted 6 lines · Thierry Reding
Quoted 4 lines

From: Thierry Reding <[email protected]>

Move the NVIDIA Tegra regulator coupling bindings from the free-form text format into the existing json-schema file for regulators.

Quoted 6 lines
Quoted 2 lines

Do we need these properties for every single regulator? This should be its own schema file and then referenced where it is needed.

These properties are SoC-specific, they describe how regulators are integrated into SoC's power subsystem. Regulators themselves are SoC-independent, i.e. PMIC's vendor and model don't matter for SoC.

Yes, but in reality the PMIC and SoC are typically somewhat coupled. How many PMICs do you need these properties for?

Rob

#5 lore raw

07.12.2021 18:25, Rob Herring пишет:

Quoted 12 lines · Dmitry Osipenko
Quoted 11 lines

06.12.2021 23:40, Rob Herring пишет:

Quoted 8 lines · Thierry Reding
Quoted 4 lines

From: Thierry Reding <[email protected]>

Move the NVIDIA Tegra regulator coupling bindings from the free-form text format into the existing json-schema file for regulators.

Do we need these properties for every single regulator? This should be its own schema file and then referenced where it is needed.

Quoted 6 lines
Quoted 3 lines

These properties are SoC-specific, they describe how regulators are integrated into SoC's power subsystem. Regulators themselves are SoC-independent, i.e. PMIC's vendor and model don't matter for SoC.

Yes, but in reality the PMIC and SoC are typically somewhat coupled. How many PMICs do you need these properties for?

Three PMICs. Realistically we shouldn't have more such PMICs in upstream in foreseeable future.