Skip to contentSkip to conversation

dt-bindings: opp/cpufreq: Convert ti-cpufreq to json schema

PATCH Superseded Nishanth Menon 2 participants 7 messages Aug 9, 2023

Subsystems (3)

v3 of 5 Superseded Latest is v5 →

lore
Share & tools
lore

Nishanth Menon

author maintainer
#0 lore raw

v3 cover dt-bindings: opp/cpufreq: Convert ti-cpufreq to json schema

Hi,

Convert the long pending free-form text bindings of ti-cpufreq and omap5-opp-supply bindings to json-schema.

Changes from V2:
* Fixed up minor typo in commit message, picked up Dhruva's review

V2: https://lore.kernel.org/all/[email protected]/
V1: https://lore.kernel.org/all/[email protected]/

Nishanth Menon (2):
dt-bindings: opp: Convert ti-omap5-opp-supply to json schema
dt-bindings: cpufreq: Convert ti-cpufreq to json schema

 .../bindings/cpufreq/ti-cpufreq.txt           | 132 ------------------
 .../opp/operating-points-v2-ti-cpu.yaml       |  88 ++++++++++++
 .../bindings/opp/ti,omap-opp-supply.yaml      | 103 ++++++++++++++
 .../bindings/opp/ti-omap5-opp-supply.txt      |  63 ---------
 4 files changed, 191 insertions(+), 195 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/cpufreq/ti-cpufreq.txt
 create mode 100644 Documentation/devicetree/bindings/opp/operating-points-v2-ti-cpu.yaml
 create mode 100644 Documentation/devicetree/bindings/opp/ti,omap-opp-supply.yaml
 delete mode 100644 Documentation/devicetree/bindings/opp/ti-omap5-opp-supply.txt
Signature · 1 line
2.40.0
author maintainer
#1 lore raw

PATCH v3 1/2 dt-bindings: opp: Convert ti-omap5-opp-supply to json schema

Rename ti-omap5-opp-supply to be bit more generic omap-opp-supply and convert the free text binding to json-schema.

---
Changes since V2:
- None.

V2: https://lore.kernel.org/r/[email protected]
V1: https://lore.kernel.org/all/[email protected]/

 .../bindings/opp/ti,omap-opp-supply.yaml      | 103 ++++++++++++++++++
 .../bindings/opp/ti-omap5-opp-supply.txt      |  63 -----------
 2 files changed, 103 insertions(+), 63 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/opp/ti,omap-opp-supply.yaml
 delete mode 100644 Documentation/devicetree/bindings/opp/ti-omap5-opp-supply.txt
Documentation/devicetree/bindings/opp/ti,omap-opp-supply.yaml new file +103 -0
new file mode 100644
index 000000000000..4db80e418829
@@ -0,0 +1,103 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/opp/ti,omap-opp-supply.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Texas Instruments OMAP compatible OPP supply
+
+description:
+  OMAP5, DRA7, and AM57 family of SoCs have Class0 AVS eFuse registers which
+  contain data that can be used to adjust voltages programmed for some of their
+  supplies for more efficient operation. This binding provides the information
+  needed to read these values and use them to program the main regulator during
+  an OPP transitions.
+
+  Also, some supplies may have an associated vbb-supply which is an Adaptive Body
+  Bias regulator which much be transitioned in a specific sequence with regards
+  to the vdd-supply and clk when making an OPP transition. By supplying two
+  regulators to the device that will undergo OPP transitions we can make use
+  of the multi regulator binding that is part of the OPP core described
+  to describe both regulators needed by the platform.
+
+maintainers:
+  - Nishanth Menon <[email protected]>
+
+properties:
+  $nodename:
+    pattern: '^opp-supply(@[0-9a-f]+)?$'
+
+  compatible:
+    oneOf:
+      - description: Basic OPP supply controlling VDD and VBB
+        items:
+          - const: ti,omap-opp-supply
+      - description: OMAP5+ optimized voltages in efuse(Class 0) VDD along with
+          VBB.
+        items:
+          - const: ti,omap5-opp-supply
+      - description: OMAP5+ optimized voltages in efuse(class0) VDD but no VBB
+        items:
+          - const: ti,omap5-core-opp-supply
+
+  reg:
+    maxItems: 1
+
+  ti,absolute-max-voltage-uv:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: Absolute maximum voltage for the OPP supply in micro-volts.
+    minimum: 750000
+    maximum: 1500000
+
+  ti,efuse-settings:
+    description: An array of u32 tuple items providing information about
+      optimized efuse configuration.
+    minItems: 1
+    $ref: /schemas/types.yaml#/definitions/uint32-matrix
+    items:
+      items:
+        -
+          description: Reference voltage in micro-volts (OPP Voltage)
+          minimum: 750000
+          maximum: 1500000
+          multipleOf: 10000
+        -
+          description: efuse offset where the optimized voltage is located
+          multipleOf: 4
+          maximum: 256
+
+required:
+  - compatible
+  - ti,absolute-max-voltage-uv
+
+allOf:
+  - if:
+      not:
+        properties:
+          compatible:
+            contains:
+              const: ti,omap-opp-supply
+    then:
+      required:
+        - reg
+        - ti,efuse-settings
+
+additionalProperties: false
+
+examples:
+  - |
+    opp-supply {
+        compatible = "ti,omap-opp-supply";
+        ti,absolute-max-voltage-uv = <1375000>;
+    };
+  - |
+    opp-supply@4a003b20 {
+        compatible = "ti,omap5-opp-supply";
+        reg = <0x4a003b20 0x8>;
+        ti,efuse-settings =
+            /* uV   offset */
+            <1060000 0x0>,
+            <1160000 0x4>,
+            <1210000 0x8>;
+        ti,absolute-max-voltage-uv = <1500000>;
+    };
Documentation/devicetree/bindings/opp/ti-omap5-opp-supply.txt deleted +0 -63

63 lines not on this page · raw message

Signature · 1 line
2.40.0
#2 lore raw

Re: [PATCH V3 1/2] dt-bindings: opp: Convert ti-omap5-opp-supply to json schema

Quoted 29 lines · Nishanth Menon

Rename ti-omap5-opp-supply to be bit more generic omap-opp-supply and convert the free text binding to json-schema.

---
Changes since V2:
- None.

V2: https://lore.kernel.org/r/[email protected]
V1: https://lore.kernel.org/all/[email protected]/

 .../bindings/opp/ti,omap-opp-supply.yaml      | 103 ++++++++++++++++++
 .../bindings/opp/ti-omap5-opp-supply.txt      |  63 -----------
 2 files changed, 103 insertions(+), 63 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/opp/ti,omap-opp-supply.yaml
 delete mode 100644 Documentation/devicetree/bindings/opp/ti-omap5-opp-supply.txt
Documentation/devicetree/bindings/opp/ti,omap-opp-supply.yaml new file +7 -0
new file mode 100644
index 000000000000..4db80e418829
@@ -0,0 +1,103 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/opp/ti,omap-opp-supply.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Texas Instruments OMAP compatible OPP supply

Documentation/devicetree/bindings/opp/ti,omap-opp-supply.yaml line 17

Quoted 10 lines
Documentation/devicetree/bindings/opp/ti,omap-opp-supply.yaml new file +10 -0
+
+description:
+  OMAP5, DRA7, and AM57 family of SoCs have Class0 AVS eFuse registers which
+  contain data that can be used to adjust voltages programmed for some of their
+  supplies for more efficient operation. This binding provides the information
+  needed to read these values and use them to program the main regulator during
+  an OPP transitions.
+
+  Also, some supplies may have an associated vbb-supply which is an Adaptive Body
+  Bias regulator which much be transitioned in a specific sequence with regards

s/much/must ?

Documentation/devicetree/bindings/opp/ti,omap-opp-supply.yaml line 20

Quoted 3 lines
Documentation/devicetree/bindings/opp/ti,omap-opp-supply.yaml new file +3 -0
+  to the vdd-supply and clk when making an OPP transition. By supplying two
+  regulators to the device that will undergo OPP transitions we can make use
+  of the multi regulator binding that is part of the OPP core described

Existing txt seems to have:

part of the OPP core described here [1]

Why get rid of the reference "[1]" here?

Going through Documentation/devicetree/bindings/opp/opp-v2.yaml didn't tell me much about this multi regulator binding, I only see 1 example.

Please can you explain a bit more or make this line more clear?

Quoted 8 lines
Documentation/devicetree/bindings/opp/ti,omap-opp-supply.yaml new file +8 -0
+  to describe both regulators needed by the platform.
+
+maintainers:
+  - Nishanth Menon <[email protected]>
+
+properties:
+  $nodename:
+    pattern: '^opp-supply(@[0-9a-f]+)?$'

[...]

Signature · 2 lines
Best regards,
Dhruva Gole <[email protected]>
author maintainer
#3 lore raw

Re: [PATCH V3 1/2] dt-bindings: opp: Convert ti-omap5-opp-supply to json schema

Quoted 34 lines · Dhruva Gole
Quoted 33 lines · Nishanth Menon

Rename ti-omap5-opp-supply to be bit more generic omap-opp-supply and convert the free text binding to json-schema.

---
Changes since V2:
- None.

V2: https://lore.kernel.org/r/[email protected]
V1: https://lore.kernel.org/all/[email protected]/

 .../bindings/opp/ti,omap-opp-supply.yaml      | 103 ++++++++++++++++++
 .../bindings/opp/ti-omap5-opp-supply.txt      |  63 -----------
 2 files changed, 103 insertions(+), 63 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/opp/ti,omap-opp-supply.yaml
 delete mode 100644 Documentation/devicetree/bindings/opp/ti-omap5-opp-supply.txt
Documentation/devicetree/bindings/opp/ti,omap-opp-supply.yaml new file +11 -0
new file mode 100644
index 000000000000..4db80e418829
@@ -0,0 +1,103 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/opp/ti,omap-opp-supply.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Texas Instruments OMAP compatible OPP supply
+
+description:
+  OMAP5, DRA7, and AM57 family of SoCs have Class0 AVS eFuse registers which
+  contain data that can be used to adjust voltages programmed for some of their
Quoted 8 lines

Documentation/devicetree/bindings/opp/ti,omap-opp-supply.yaml line 17

Quoted 6 lines
Documentation/devicetree/bindings/opp/ti,omap-opp-supply.yaml new file +6 -0
+  supplies for more efficient operation. This binding provides the information
+  needed to read these values and use them to program the main regulator during
+  an OPP transitions.
+
+  Also, some supplies may have an associated vbb-supply which is an Adaptive Body
+  Bias regulator which much be transitioned in a specific sequence with regards

s/much/must ?

Thanks.

Quoted 7 lines

Documentation/devicetree/bindings/opp/ti,omap-opp-supply.yaml line 20

Quoted 4 lines
Documentation/devicetree/bindings/opp/ti,omap-opp-supply.yaml new file +3 -0
+  to the vdd-supply and clk when making an OPP transition. By supplying two
+  regulators to the device that will undergo OPP transitions we can make use
+  of the multi regulator binding that is part of the OPP core described

Existing txt seems to have:

Quoted 8 lines

part of the OPP core described here [1]

Why get rid of the reference "[1]" here?

Going through Documentation/devicetree/bindings/opp/opp-v2.yaml didn't tell me much about this multi regulator binding, I only see 1 example.

Please can you explain a bit more or make this line more clear?

Example 4 in the referenced binding does explain that - consumer examples that are already documented does'nt make sense to be replicated here. I will add a reference to opp-v2.yaml binding along with a pointer to example 4.

Quoted 11 lines
Quoted 9 lines
Documentation/devicetree/bindings/opp/ti,omap-opp-supply.yaml new file +8 -0
+  to describe both regulators needed by the platform.
+
+maintainers:
+  - Nishanth Menon <[email protected]>
+
+properties:
+  $nodename:
+    pattern: '^opp-supply(@[0-9a-f]+)?$'

[...]

Thanks for the detailed review. Will repost a new rev in a few days if there are no further review comments.

Signature · 3 lines
Regards,
Nishanth Menon
Key (0xDDB5849D1736249D) / Fingerprint: F8A2 8693 54EB 8232 17A3  1A34 DDB5 849D 1736 249D
author maintainer
#4 lore raw

PATCH v3 2/2 dt-bindings: cpufreq: Convert ti-cpufreq to json schema

In reply to Nishanth Menon

Move the ti-cpufreq binding over to opp and convert the free text binding to json-schema.

---
Changes since V2:
* Just fixup for commit message and picked up Reviewed-by from Dhruva.

V2: https://lore.kernel.org/r/[email protected]
V1: https://lore.kernel.org/all/[email protected]/

Side note: Cleanups in dt is picked up on Tony's tree:
https://lore.kernel.org/all/[email protected]/

 .../bindings/cpufreq/ti-cpufreq.txt           | 132 ------------------
 .../opp/operating-points-v2-ti-cpu.yaml       |  88 ++++++++++++
 2 files changed, 88 insertions(+), 132 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/cpufreq/ti-cpufreq.txt
 create mode 100644 Documentation/devicetree/bindings/opp/operating-points-v2-ti-cpu.yaml
Documentation/devicetree/bindings/cpufreq/ti-cpufreq.txt deleted +0 -132
deleted file mode 100644
index 1758051798fe..000000000000
@@ -1,132 +0,0 @@
-TI CPUFreq and OPP bindings
-================================
-
-Certain TI SoCs, like those in the am335x, am437x, am57xx, and dra7xx
-families support different OPPs depending on the silicon variant in use.
-The ti-cpufreq driver can use revision and an efuse value from the SoC to
-provide the OPP framework with supported hardware information. This is
-used to determine which OPPs from the operating-points-v2 table get enabled
-when it is parsed by the OPP framework.
-
-Required properties:
---------------------
-In 'cpus' nodes:
-- operating-points-v2: Phandle to the operating-points-v2 table to use.
-
-In 'operating-points-v2' table:
-- compatible: Should be
-	- 'operating-points-v2-ti-cpu' for am335x, am43xx, and dra7xx/am57xx,
-	  omap34xx, omap36xx and am3517 SoCs
-- syscon: A phandle pointing to a syscon node representing the control module
-	  register space of the SoC.
-
-Optional properties:
---------------------
-- "vdd-supply", "vbb-supply": to define two regulators for dra7xx
-- "cpu0-supply", "vbb-supply": to define two regulators for omap36xx
-
-For each opp entry in 'operating-points-v2' table:
-- opp-supported-hw: Two bitfields indicating:
-	1. Which revision of the SoC the OPP is supported by
-	2. Which eFuse bits indicate this OPP is available
-
-	A bitwise AND is performed against these values and if any bit
-	matches, the OPP gets enabled.
-
-Example:
---------
-
-/* From arch/arm/boot/dts/am33xx.dtsi */
-cpus {
-	#address-cells = <1>;
-	#size-cells = <0>;
-	cpu@0 {
-		compatible = "arm,cortex-a8";
-		device_type = "cpu";
-		reg = <0>;
-
-		operating-points-v2 = <&cpu0_opp_table>;
-
-		clocks = <&dpll_mpu_ck>;
-		clock-names = "cpu";
-
-		clock-latency = <300000>; /* From omap-cpufreq driver */
-	};
-};
-
-/*
- * cpu0 has different OPPs depending on SoC revision and some on revisions
- * 0x2 and 0x4 have eFuse bits that indicate if they are available or not
- */
-cpu0_opp_table: opp-table {
-	compatible = "operating-points-v2-ti-cpu";
-	syscon = <&scm_conf>;
-
-	/*
-	 * The three following nodes are marked with opp-suspend
-	 * because they can not be enabled simultaneously on a
-	 * single SoC.
-	 */
-	opp50-300000000 {
-		opp-hz = /bits/ 64 <300000000>;
-		opp-microvolt = <950000 931000 969000>;
-		opp-supported-hw = <0x06 0x0010>;
-		opp-suspend;
-	};
-
-	opp100-275000000 {
-		opp-hz = /bits/ 64 <275000000>;
-		opp-microvolt = <1100000 1078000 1122000>;
-		opp-supported-hw = <0x01 0x00FF>;
-		opp-suspend;
-	};
-
-	opp100-300000000 {
-		opp-hz = /bits/ 64 <300000000>;
-		opp-microvolt = <1100000 1078000 1122000>;
-		opp-supported-hw = <0x06 0x0020>;
-		opp-suspend;
-	};
-
-	opp100-500000000 {
-		opp-hz = /bits/ 64 <500000000>;
-		opp-microvolt = <1100000 1078000 1122000>;
-		opp-supported-hw = <0x01 0xFFFF>;
-	};
-
-	opp100-600000000 {
-		opp-hz = /bits/ 64 <600000000>;
-		opp-microvolt = <1100000 1078000 1122000>;
-		opp-supported-hw = <0x06 0x0040>;
-	};
-
-	opp120-600000000 {
-		opp-hz = /bits/ 64 <600000000>;
-		opp-microvolt = <1200000 1176000 1224000>;
-		opp-supported-hw = <0x01 0xFFFF>;
-	};
-
-	opp120-720000000 {
-		opp-hz = /bits/ 64 <720000000>;
-		opp-microvolt = <1200000 1176000 1224000>;
-		opp-supported-hw = <0x06 0x0080>;
-	};
-
-	oppturbo-720000000 {
-		opp-hz = /bits/ 64 <720000000>;
-		opp-microvolt = <1260000 1234800 1285200>;
-		opp-supported-hw = <0x01 0xFFFF>;
-	};
-
-	oppturbo-800000000 {
-		opp-hz = /bits/ 64 <800000000>;
-		opp-microvolt = <1260000 1234800 1285200>;
-		opp-supported-hw = <0x06 0x0100>;
-	};
-
-	oppnitro-1000000000 {
-		opp-hz = /bits/ 64 <1000000000>;
-		opp-microvolt = <1325000 1298500 1351500>;
-		opp-supported-hw = <0x04 0x0200>;
-	};
-};
Documentation/devicetree/bindings/opp/operating-points-v2-ti-cpu.yaml new file +88 -0

88 lines not on this page · raw message

Signature · 1 line
2.40.0
#5 lore raw

Re: [PATCH V3 2/2] dt-bindings: cpufreq: Convert ti-cpufreq to json schema

Quoted 21 lines · Nishanth Menon

Move the ti-cpufreq binding over to opp and convert the free text binding to json-schema.

---
Changes since V2:
* Just fixup for commit message and picked up Reviewed-by from Dhruva.

V2: https://lore.kernel.org/r/[email protected]
V1: https://lore.kernel.org/all/[email protected]/

Side note: Cleanups in dt is picked up on Tony's tree:
https://lore.kernel.org/all/[email protected]/

 .../bindings/cpufreq/ti-cpufreq.txt           | 132 ------------------
 .../opp/operating-points-v2-ti-cpu.yaml       |  88 ++++++++++++
 2 files changed, 88 insertions(+), 132 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/cpufreq/ti-cpufreq.txt
 create mode 100644 Documentation/devicetree/bindings/opp/operating-points-v2-ti-cpu.yaml

[...]

Quoted 7 lines

new file mode 100644
index 000000000000..ada57bfc1da9

Documentation/devicetree/bindings/opp/operating-points-v2-ti-cpu.yaml new file +2 -0
@@ -0,0 +1,88 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2

Documentation/devicetree/bindings/opp/operating-points-v2-ti-cpu.yaml line 12

Quoted 10 lines
Documentation/devicetree/bindings/opp/operating-points-v2-ti-cpu.yaml new file +10 -0
+---
+$id: http://devicetree.org/schemas/opp/operating-points-v2-ti-cpu.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: TI CPU OPP (Operating Performance Points)
+
+description:
+  Certain TI SoCs, like those in the am335x, am437x, am57xx, am62x and dra7xx
+  families support different OPPs depending on the silicon variant in use.
+  The ti-cpufreq driver can use revision and an efuse value from the SoC to

Just learned about this yesterday, hence missed it in my earlier review. Looks like the kernel docs [0] say that we DON'T refer to Linux or "device driver" in bindings.

Bindings should be based on what the hardware has, not what an OS and driver currently support.

Documentation/devicetree/bindings/opp/operating-points-v2-ti-cpu.yaml line 16

Quoted 4 lines
Documentation/devicetree/bindings/opp/operating-points-v2-ti-cpu.yaml new file +4 -0
+  provide the OPP framework with supported hardware information. This is
+  used to determine which OPPs from the operating-points-v2 table get enabled
+  when it is parsed by the OPP framework.
+

[...]

[0] https://docs.kernel.org/devicetree/bindings/writing-bindings.html

Signature · 2 lines
Best regards,
Dhruva Gole <[email protected]>
author maintainer
#6 lore raw

Re: [PATCH V3 2/2] dt-bindings: cpufreq: Convert ti-cpufreq to json schema

On 10:00-20230809, Dhruva Gole wrote:
[..]

Quoted 11 lines

Documentation/devicetree/bindings/opp/operating-points-v2-ti-cpu.yaml line 12

Quoted 4 lines
Documentation/devicetree/bindings/opp/operating-points-v2-ti-cpu.yaml new file +4 -0
+description:
+  Certain TI SoCs, like those in the am335x, am437x, am57xx, am62x and dra7xx
+  families support different OPPs depending on the silicon variant in use.
+  The ti-cpufreq driver can use revision and an efuse value from the SoC to

Just learned about this yesterday, hence missed it in my earlier review. Looks like the kernel docs [0] say that we DON'T refer to Linux or "device driver" in bindings.

Bindings should be based on what the hardware has, not what an OS and driver currently support.

Thanks for catching this. will fix in the next rev.
Regards,
Nishanth Menon
Key (0xDDB5849D1736249D) / Fingerprint: F8A2 8693 54EB 8232 17A3 1A34 DDB5 849D 1736 249D