diff mbox series

dt-bindings: thermal: Convert qoriq to json-schema

Message ID 1590737338-7318-1-git-send-email-Anson.Huang@nxp.com
State Changes Requested
Headers show
Series dt-bindings: thermal: Convert qoriq to json-schema | expand

Checks

Context Check Description
robh/dt-meta-schema success
robh/checkpatch warning total: 0 errors, 2 warnings, 111 lines checked

Commit Message

Anson Huang May 29, 2020, 7:28 a.m. UTC
Convert the qoriq thermal binding to DT schema format using json-schema

Signed-off-by: Anson Huang <Anson.Huang@nxp.com>
---
 .../devicetree/bindings/thermal/qoriq-thermal.txt  |  71 -------------
 .../devicetree/bindings/thermal/qoriq-thermal.yaml | 111 +++++++++++++++++++++
 2 files changed, 111 insertions(+), 71 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/thermal/qoriq-thermal.txt
 create mode 100644 Documentation/devicetree/bindings/thermal/qoriq-thermal.yaml

Comments

Rob Herring May 29, 2020, 9:16 p.m. UTC | #1
On Fri, May 29, 2020 at 03:28:58PM +0800, Anson Huang wrote:
> Convert the qoriq thermal binding to DT schema format using json-schema
> 
> Signed-off-by: Anson Huang <Anson.Huang@nxp.com>
> ---
>  .../devicetree/bindings/thermal/qoriq-thermal.txt  |  71 -------------
>  .../devicetree/bindings/thermal/qoriq-thermal.yaml | 111 +++++++++++++++++++++
>  2 files changed, 111 insertions(+), 71 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/thermal/qoriq-thermal.txt
>  create mode 100644 Documentation/devicetree/bindings/thermal/qoriq-thermal.yaml


> diff --git a/Documentation/devicetree/bindings/thermal/qoriq-thermal.yaml b/Documentation/devicetree/bindings/thermal/qoriq-thermal.yaml
> new file mode 100644
> index 0000000..bfbfa04
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/thermal/qoriq-thermal.yaml
> @@ -0,0 +1,111 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/thermal/qoriq-thermal.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Thermal Monitoring Unit (TMU) on Freescale QorIQ SoCs
> +
> +maintainers:
> +  - Hongtao Jia <hongtao.jia@freescale.com>
> +
> +properties:
> +  compatible:
> +    description: |
> +      The version of the device is determined by the TMU IP Block Revision
> +      Register (IPBRR0) at offset 0x0BF8.
> +      Table of correspondences between IPBRR0 values and example chips:
> +            Value           Device
> +            ----------      -----
> +            0x01900102      T1040
> +    enum:
> +      - fsl,qoriq-tmu
> +      - fsl,imx8mq-tmu
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  fsl,tmu-range:
> +    $ref: '/schemas/types.yaml#/definitions/uint32-array'
> +    description: |
> +      The values to be programmed into TTRnCR, as specified by the SoC
> +      reference manual. The first cell is TTR0CR, the second is TTR1CR, etc.

Is there a maximum number?

> +
> +  fsl,tmu-calibration:
> +    $ref: '/schemas/types.yaml#/definitions/uint32-array'
> +    description: |
> +      A list of cell pairs containing temperature calibration data, as
> +      specified by the SoC reference manual. The first cell of each pair
> +      is the value to be written to TTCFGR, and the second is the value
> +      to be written to TSCFGR.

That's a uint32-matrix, not an array:

minItmes: ??
maxItems: ??
items:
  items:
    - description: value for TTCFGR
    - description: value for TSCFGR

> +
> +  little-endian:
> +    description: |
> +      boolean, if present, the TMU registers are little endian. If absent,
> +      the default is big endian.
> +    type: boolean
> +
> +  clocks:
> +    maxItems: 1
> +
> +  "#thermal-sensor-cells":
> +    const: 1
> +    description: |
> +      Number of cells required to uniquely identify the thermal sensors. This
> +      is set to 1 for multiple sensors.

No need to redefine common properties.

> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - fsl,tmu-range
> +  - fsl,tmu-calibration
> +  - '#thermal-sensor-cells'
> +
> +examples:
> +  - |
> +    tmu@f0000 {
> +        compatible = "fsl,qoriq-tmu";
> +        reg = <0xf0000 0x1000>;
> +        interrupts = <18 2 0 0>;
> +        fsl,tmu-range = <0x000a0000 0x00090026 0x0008004a 0x0001006a>;
> +        fsl,tmu-calibration = <0x00000000 0x00000025
> +                               0x00000001 0x00000028
> +                               0x00000002 0x0000002d
> +                               0x00000003 0x00000031
> +                               0x00000004 0x00000036
> +                               0x00000005 0x0000003a
> +                               0x00000006 0x00000040
> +                               0x00000007 0x00000044
> +                               0x00000008 0x0000004a
> +                               0x00000009 0x0000004f
> +                               0x0000000a 0x00000054
> +
> +                               0x00010000 0x0000000d
> +                               0x00010001 0x00000013
> +                               0x00010002 0x00000019
> +                               0x00010003 0x0000001f
> +                               0x00010004 0x00000025
> +                               0x00010005 0x0000002d
> +                               0x00010006 0x00000033
> +                               0x00010007 0x00000043
> +                               0x00010008 0x0000004b
> +                               0x00010009 0x00000053
> +
> +                               0x00020000 0x00000010
> +                               0x00020001 0x00000017
> +                               0x00020002 0x0000001f
> +                               0x00020003 0x00000029
> +                               0x00020004 0x00000031
> +                               0x00020005 0x0000003c
> +                               0x00020006 0x00000042
> +                               0x00020007 0x0000004d
> +                               0x00020008 0x00000056
> +
> +                               0x00030000 0x00000012
> +                               0x00030001 0x0000001d>;
> +        #thermal-sensor-cells = <1>;
> +    };
> -- 
> 2.7.4
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/thermal/qoriq-thermal.txt b/Documentation/devicetree/bindings/thermal/qoriq-thermal.txt
deleted file mode 100644
index 28f2cba..0000000
--- a/Documentation/devicetree/bindings/thermal/qoriq-thermal.txt
+++ /dev/null
@@ -1,71 +0,0 @@ 
-* Thermal Monitoring Unit (TMU) on Freescale QorIQ SoCs
-
-Required properties:
-- compatible : Must include "fsl,qoriq-tmu" or "fsl,imx8mq-tmu". The
-	version of the device is determined by the TMU IP Block Revision
-	Register (IPBRR0) at offset 0x0BF8.
-	Table of correspondences between IPBRR0 values and example  chips:
-		Value           Device
-		----------      -----
-		0x01900102      T1040
-- reg : Address range of TMU registers.
-- interrupts : Contains the interrupt for TMU.
-- fsl,tmu-range : The values to be programmed into TTRnCR, as specified by
-	the SoC reference manual. The first cell is TTR0CR, the second is
-	TTR1CR, etc.
-- fsl,tmu-calibration : A list of cell pairs containing temperature
-	calibration data, as specified by the SoC reference manual.
-	The first cell of each pair is the value to be written to TTCFGR,
-	and the second is the value to be written to TSCFGR.
-- #thermal-sensor-cells : Must be 1. The sensor specifier is the monitoring
-	site ID, and represents the "n" in TRITSRn and TRATSRn.
-
-Optional property:
-- little-endian : If present, the TMU registers are little endian. If absent,
-	the default is big endian.
-- clocks : the clock for clocking the TMU silicon.
-
-Example:
-
-tmu@f0000 {
-	compatible = "fsl,qoriq-tmu";
-	reg = <0xf0000 0x1000>;
-	interrupts = <18 2 0 0>;
-	fsl,tmu-range = <0x000a0000 0x00090026 0x0008004a 0x0001006a>;
-	fsl,tmu-calibration = <0x00000000 0x00000025
-			       0x00000001 0x00000028
-			       0x00000002 0x0000002d
-			       0x00000003 0x00000031
-			       0x00000004 0x00000036
-			       0x00000005 0x0000003a
-			       0x00000006 0x00000040
-			       0x00000007 0x00000044
-			       0x00000008 0x0000004a
-			       0x00000009 0x0000004f
-			       0x0000000a 0x00000054
-
-			       0x00010000 0x0000000d
-			       0x00010001 0x00000013
-			       0x00010002 0x00000019
-			       0x00010003 0x0000001f
-			       0x00010004 0x00000025
-			       0x00010005 0x0000002d
-			       0x00010006 0x00000033
-			       0x00010007 0x00000043
-			       0x00010008 0x0000004b
-			       0x00010009 0x00000053
-
-			       0x00020000 0x00000010
-			       0x00020001 0x00000017
-			       0x00020002 0x0000001f
-			       0x00020003 0x00000029
-			       0x00020004 0x00000031
-			       0x00020005 0x0000003c
-			       0x00020006 0x00000042
-			       0x00020007 0x0000004d
-			       0x00020008 0x00000056
-
-			       0x00030000 0x00000012
-			       0x00030001 0x0000001d>;
-	#thermal-sensor-cells = <1>;
-};
diff --git a/Documentation/devicetree/bindings/thermal/qoriq-thermal.yaml b/Documentation/devicetree/bindings/thermal/qoriq-thermal.yaml
new file mode 100644
index 0000000..bfbfa04
--- /dev/null
+++ b/Documentation/devicetree/bindings/thermal/qoriq-thermal.yaml
@@ -0,0 +1,111 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/thermal/qoriq-thermal.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Thermal Monitoring Unit (TMU) on Freescale QorIQ SoCs
+
+maintainers:
+  - Hongtao Jia <hongtao.jia@freescale.com>
+
+properties:
+  compatible:
+    description: |
+      The version of the device is determined by the TMU IP Block Revision
+      Register (IPBRR0) at offset 0x0BF8.
+      Table of correspondences between IPBRR0 values and example chips:
+            Value           Device
+            ----------      -----
+            0x01900102      T1040
+    enum:
+      - fsl,qoriq-tmu
+      - fsl,imx8mq-tmu
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  fsl,tmu-range:
+    $ref: '/schemas/types.yaml#/definitions/uint32-array'
+    description: |
+      The values to be programmed into TTRnCR, as specified by the SoC
+      reference manual. The first cell is TTR0CR, the second is TTR1CR, etc.
+
+  fsl,tmu-calibration:
+    $ref: '/schemas/types.yaml#/definitions/uint32-array'
+    description: |
+      A list of cell pairs containing temperature calibration data, as
+      specified by the SoC reference manual. The first cell of each pair
+      is the value to be written to TTCFGR, and the second is the value
+      to be written to TSCFGR.
+
+  little-endian:
+    description: |
+      boolean, if present, the TMU registers are little endian. If absent,
+      the default is big endian.
+    type: boolean
+
+  clocks:
+    maxItems: 1
+
+  "#thermal-sensor-cells":
+    const: 1
+    description: |
+      Number of cells required to uniquely identify the thermal sensors. This
+      is set to 1 for multiple sensors.
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - fsl,tmu-range
+  - fsl,tmu-calibration
+  - '#thermal-sensor-cells'
+
+examples:
+  - |
+    tmu@f0000 {
+        compatible = "fsl,qoriq-tmu";
+        reg = <0xf0000 0x1000>;
+        interrupts = <18 2 0 0>;
+        fsl,tmu-range = <0x000a0000 0x00090026 0x0008004a 0x0001006a>;
+        fsl,tmu-calibration = <0x00000000 0x00000025
+                               0x00000001 0x00000028
+                               0x00000002 0x0000002d
+                               0x00000003 0x00000031
+                               0x00000004 0x00000036
+                               0x00000005 0x0000003a
+                               0x00000006 0x00000040
+                               0x00000007 0x00000044
+                               0x00000008 0x0000004a
+                               0x00000009 0x0000004f
+                               0x0000000a 0x00000054
+
+                               0x00010000 0x0000000d
+                               0x00010001 0x00000013
+                               0x00010002 0x00000019
+                               0x00010003 0x0000001f
+                               0x00010004 0x00000025
+                               0x00010005 0x0000002d
+                               0x00010006 0x00000033
+                               0x00010007 0x00000043
+                               0x00010008 0x0000004b
+                               0x00010009 0x00000053
+
+                               0x00020000 0x00000010
+                               0x00020001 0x00000017
+                               0x00020002 0x0000001f
+                               0x00020003 0x00000029
+                               0x00020004 0x00000031
+                               0x00020005 0x0000003c
+                               0x00020006 0x00000042
+                               0x00020007 0x0000004d
+                               0x00020008 0x00000056
+
+                               0x00030000 0x00000012
+                               0x00030001 0x0000001d>;
+        #thermal-sensor-cells = <1>;
+    };