diff mbox series

[4/5] dt-bindings: opp: Convert ti-omap5-opp-supply.txt to yaml binding

Message ID 20230724153911.1376830-5-nm@ti.com (mailing list archive)
State New, archived
Headers show
Series dt-bindings: opp/cpufreq: Convert ti-cpufreq to | expand

Commit Message

Nishanth Menon July 24, 2023, 3:39 p.m. UTC
Rename ti-omap5-opp-supply to be bit more generic omap-opp-supply and
convert the binding to yaml.

Signed-off-by: Nishanth Menon <nm@ti.com>
---
 .../bindings/opp/ti,omap-opp-supply.yaml      | 108 ++++++++++++++++++
 .../bindings/opp/ti-omap5-opp-supply.txt      |  63 ----------
 2 files changed, 108 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

Comments

Rob Herring (Arm) July 26, 2023, 5:10 p.m. UTC | #1
On Mon, Jul 24, 2023 at 10:39:10AM -0500, Nishanth Menon wrote:
> Rename ti-omap5-opp-supply to be bit more generic omap-opp-supply and
> convert the binding to yaml.
> 
> Signed-off-by: Nishanth Menon <nm@ti.com>
> ---
>  .../bindings/opp/ti,omap-opp-supply.yaml      | 108 ++++++++++++++++++
>  .../bindings/opp/ti-omap5-opp-supply.txt      |  63 ----------
>  2 files changed, 108 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
> 
> diff --git a/Documentation/devicetree/bindings/opp/ti,omap-opp-supply.yaml b/Documentation/devicetree/bindings/opp/ti,omap-opp-supply.yaml
> new file mode 100644
> index 000000000000..ff1b3d8fea31
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/opp/ti,omap-opp-supply.yaml
> @@ -0,0 +1,108 @@
> +# 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

Drop "description"

> +
> +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 <nm@ti.com>
> +
> +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:
> +    description: Address and length of the efuse register set for the device

Drop

> +    maxItems: 1
> +
> +  ti,absolute-max-voltage-uv:
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    description: Absolute maximum voltage for the OPP supply
> +
> +  ti,efuse-settings:
> +    $ref: /schemas/types.yaml#/definitions/uint32-matrix
> +    description: An array of u32 tuple items providing information about
> +      optimized efuse configuration. Each item consists of the following
> +      voltage_in_uV - reference voltage (OPP Voltage)
> +      efuse_offset - efuse offset fromr eg where the optimized voltage is
> +        stored.
> +    items:
> +      minItems: 2
> +      maxItems: 2

Constraints on the values?

> +    minItems: 1
> +
> +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_mpu_iva_hd: opp-supply {

Drop unused labels.

> +        compatible = "ti,omap-opp-supply";
> +        ti,absolute-max-voltage-uv = <1375000>;
> +    };
> +  - |
> +    opp_supply_mpu: 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>;
> +    };
> +  - |
> +    opp_supply_mpu2: opp-supply@4a003b00 {
> +        compatible = "ti,omap5-core-opp-supply";
> +        reg = <0x4a003b00 0x8>;
> +        ti,efuse-settings =
> +            /* uV   offset */
> +            <1060000 0x0>,
> +            <1160000 0x4>,
> +            <1210000 0x8>;
> +        ti,absolute-max-voltage-uv = <1500000>;
> +    };

The 3rd example doesn't add anything. It's just different values.

Rob
Nishanth Menon July 26, 2023, 7:15 p.m. UTC | #2
On 11:10-20230726, Rob Herring wrote:
> On Mon, Jul 24, 2023 at 10:39:10AM -0500, Nishanth Menon wrote:
> > Rename ti-omap5-opp-supply to be bit more generic omap-opp-supply and
> > convert the binding to yaml.
> > 
> > Signed-off-by: Nishanth Menon <nm@ti.com>
> > ---
> >  .../bindings/opp/ti,omap-opp-supply.yaml      | 108 ++++++++++++++++++
> >  .../bindings/opp/ti-omap5-opp-supply.txt      |  63 ----------
> >  2 files changed, 108 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
> > 
> > diff --git a/Documentation/devicetree/bindings/opp/ti,omap-opp-supply.yaml b/Documentation/devicetree/bindings/opp/ti,omap-opp-supply.yaml
> > new file mode 100644
> > index 000000000000..ff1b3d8fea31
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/opp/ti,omap-opp-supply.yaml
> > @@ -0,0 +1,108 @@
> > +# 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
> 
> Drop "description"

OK.

> 
> > +
> > +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 <nm@ti.com>
> > +
> > +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:
> > +    description: Address and length of the efuse register set for the device
> 
> Drop

Ack.

> 
> > +    maxItems: 1
> > +
> > +  ti,absolute-max-voltage-uv:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +    description: Absolute maximum voltage for the OPP supply
> > +
> > +  ti,efuse-settings:
> > +    $ref: /schemas/types.yaml#/definitions/uint32-matrix
> > +    description: An array of u32 tuple items providing information about
> > +      optimized efuse configuration. Each item consists of the following
> > +      voltage_in_uV - reference voltage (OPP Voltage)
> > +      efuse_offset - efuse offset fromr eg where the optimized voltage is
> > +        stored.
> > +    items:
> > +      minItems: 2
> > +      maxItems: 2
> 
> Constraints on the values?

As I recollect (been a while), it was variant per device. Did you have
something in mind or a reference for me to look at?

> 
> > +    minItems: 1
> > +
> > +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_mpu_iva_hd: opp-supply {
> 
> Drop unused labels.

Will do.

> 
> > +        compatible = "ti,omap-opp-supply";
> > +        ti,absolute-max-voltage-uv = <1375000>;
> > +    };
> > +  - |
> > +    opp_supply_mpu: 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>;
> > +    };
> > +  - |
> > +    opp_supply_mpu2: opp-supply@4a003b00 {
> > +        compatible = "ti,omap5-core-opp-supply";
> > +        reg = <0x4a003b00 0x8>;
> > +        ti,efuse-settings =
> > +            /* uV   offset */
> > +            <1060000 0x0>,
> > +            <1160000 0x4>,
> > +            <1210000 0x8>;
> > +        ti,absolute-max-voltage-uv = <1500000>;
> > +    };
> 
> The 3rd example doesn't add anything. It's just different values.

True, Thanks for catching.
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/opp/ti,omap-opp-supply.yaml b/Documentation/devicetree/bindings/opp/ti,omap-opp-supply.yaml
new file mode 100644
index 000000000000..ff1b3d8fea31
--- /dev/null
+++ b/Documentation/devicetree/bindings/opp/ti,omap-opp-supply.yaml
@@ -0,0 +1,108 @@ 
+# 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
+
+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 <nm@ti.com>
+
+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:
+    description: Address and length of the efuse register set for the device
+    maxItems: 1
+
+  ti,absolute-max-voltage-uv:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: Absolute maximum voltage for the OPP supply
+
+  ti,efuse-settings:
+    $ref: /schemas/types.yaml#/definitions/uint32-matrix
+    description: An array of u32 tuple items providing information about
+      optimized efuse configuration. Each item consists of the following
+      voltage_in_uV - reference voltage (OPP Voltage)
+      efuse_offset - efuse offset fromr eg where the optimized voltage is
+        stored.
+    items:
+      minItems: 2
+      maxItems: 2
+    minItems: 1
+
+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_mpu_iva_hd: opp-supply {
+        compatible = "ti,omap-opp-supply";
+        ti,absolute-max-voltage-uv = <1375000>;
+    };
+  - |
+    opp_supply_mpu: 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>;
+    };
+  - |
+    opp_supply_mpu2: opp-supply@4a003b00 {
+        compatible = "ti,omap5-core-opp-supply";
+        reg = <0x4a003b00 0x8>;
+        ti,efuse-settings =
+            /* uV   offset */
+            <1060000 0x0>,
+            <1160000 0x4>,
+            <1210000 0x8>;
+        ti,absolute-max-voltage-uv = <1500000>;
+    };
diff --git a/Documentation/devicetree/bindings/opp/ti-omap5-opp-supply.txt b/Documentation/devicetree/bindings/opp/ti-omap5-opp-supply.txt
deleted file mode 100644
index b70d326117cd..000000000000
--- a/Documentation/devicetree/bindings/opp/ti-omap5-opp-supply.txt
+++ /dev/null
@@ -1,63 +0,0 @@ 
-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 here [1]
-to describe both regulators needed by the platform.
-
-[1] Documentation/devicetree/bindings/opp/opp-v2.yaml
-
-Required Properties for Device Node:
-- vdd-supply: phandle to regulator controlling VDD supply
-- vbb-supply: phandle to regulator controlling Body Bias supply
-	      (Usually Adaptive Body Bias regulator)
-
-Required Properties for opp-supply node:
-- compatible: Should be one of:
-	"ti,omap-opp-supply" - basic OPP supply controlling VDD and VBB
-	"ti,omap5-opp-supply" - OMAP5+ optimized voltages in efuse(class0)VDD
-			    along with VBB
-	"ti,omap5-core-opp-supply" - OMAP5+ optimized voltages in efuse(class0) VDD
-			    but no VBB.
-- reg: Address and length of the efuse register set for the device (mandatory
-	only for "ti,omap5-opp-supply")
-- ti,efuse-settings: An array of u32 tuple items providing information about
-	optimized efuse configuration. Each item consists of the following:
-	volt: voltage in uV - reference voltage (OPP voltage)
-	efuse_offseet: efuse offset from reg where the optimized voltage is stored.
-- ti,absolute-max-voltage-uv: absolute maximum voltage for the OPP supply.
-
-Example:
-
-/* Device Node (CPU)  */
-cpus {
-	cpu0: cpu@0 {
-		device_type = "cpu";
-
-		...
-
-		vdd-supply = <&vcc>;
-		vbb-supply = <&abb_mpu>;
-	};
-};
-
-/* OMAP OPP Supply with Class0 registers */
-opp_supply_mpu: 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>;
-};