diff mbox series

[V2] dt-bindings: clock: Convert i.MX7D clock to json-schema

Message ID 1589813554-20929-1-git-send-email-Anson.Huang@nxp.com (mailing list archive)
State Awaiting Upstream, archived
Headers show
Series [V2] dt-bindings: clock: Convert i.MX7D clock to json-schema | expand

Commit Message

Anson Huang May 18, 2020, 2:52 p.m. UTC 
Convert the i.MX7D clock binding to DT schema format using json-schema.

Signed-off-by: Anson Huang <Anson.Huang@nxp.com>
---
Changes since V1:
	- Update maintainer's e-mail address.
---
 .../devicetree/bindings/clock/imx7d-clock.txt      | 13 -----
 .../devicetree/bindings/clock/imx7d-clock.yaml     | 64 ++++++++++++++++++++++
 2 files changed, 64 insertions(+), 13 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/clock/imx7d-clock.txt
 create mode 100644 Documentation/devicetree/bindings/clock/imx7d-clock.yaml

Comments

Aisheng Dong May 19, 2020, 2:01 a.m. UTC | #1 
> From: Anson Huang <Anson.Huang@nxp.com>
> Sent: Monday, May 18, 2020 10:53 PM
> 
> Convert the i.MX7D clock binding to DT schema format using json-schema.
> 
> Signed-off-by: Anson Huang <Anson.Huang@nxp.com>
> ---
> Changes since V1:
> 	- Update maintainer's e-mail address.
> ---
>  .../devicetree/bindings/clock/imx7d-clock.txt      | 13 -----
>  .../devicetree/bindings/clock/imx7d-clock.yaml     | 64
> ++++++++++++++++++++++
>  2 files changed, 64 insertions(+), 13 deletions(-)  delete mode 100644
> Documentation/devicetree/bindings/clock/imx7d-clock.txt
>  create mode 100644
> Documentation/devicetree/bindings/clock/imx7d-clock.yaml
> 
> diff --git a/Documentation/devicetree/bindings/clock/imx7d-clock.txt
> b/Documentation/devicetree/bindings/clock/imx7d-clock.txt
> deleted file mode 100644
> index 9d3026d..0000000
> --- a/Documentation/devicetree/bindings/clock/imx7d-clock.txt
> +++ /dev/null
> @@ -1,13 +0,0 @@
> -* Clock bindings for Freescale i.MX7 Dual
> -
> -Required properties:
> -- compatible: Should be "fsl,imx7d-ccm"
> -- reg: Address and length of the register set
> -- #clock-cells: Should be <1>
> -- clocks: list of clock specifiers, must contain an entry for each required
> -  entry in clock-names
> -- clock-names: should include entries "ckil", "osc"
> -
> -The clock consumer should specify the desired clock by having the clock -ID in
> its "clocks" phandle cell.  See include/dt-bindings/clock/imx7d-clock.h
> -for the full list of i.MX7 Dual clock IDs.
> diff --git a/Documentation/devicetree/bindings/clock/imx7d-clock.yaml
> b/Documentation/devicetree/bindings/clock/imx7d-clock.yaml
> new file mode 100644
> index 0000000..8cd0573
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/clock/imx7d-clock.yaml
> @@ -0,0 +1,64 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2
> +---
> +
> +title: Clock bindings for Freescale i.MX7 Dual
> +
> +maintainers:
> +  - Frank Li <Frank.Li@nxp.com>
> +  - Anson Huang <Anson.Huang@nxp.com>
> +
> +description: |
> +  The clock consumer should specify the desired clock by having the
> +clock
> +  ID in its "clocks" phandle cell. See
> +include/dt-bindings/clock/imx7d-clock.h
> +  for the full list of i.MX7 Dual clock IDs.
> +
> +properties:
> +  compatible:
> +    const: fsl,imx7d-ccm
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    items:
> +      - description: CCM interrupt request 1
> +      - description: CCM interrupt request 2

Do we have a more specific description from RM?
Otherwise, I'm fine with this patch.

> +    maxItems: 2
> +
> +  '#clock-cells':
> +    const: 1
> +
> +  clocks:
> +    items:
> +      - description: 32k osc
> +      - description: 24m osc
> +
> +  clock-names:
> +    items:
> +      - const: ckil
> +      - const: osc
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - clocks
> +  - clock-names
> +  - '#clock-cells'
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> +
> +    clock-controller@30380000 {
> +        compatible = "fsl,imx7d-ccm";
> +        reg = <0x30380000 0x10000>;
> +        interrupts = <GIC_SPI 85 IRQ_TYPE_LEVEL_HIGH>,
> +                     <GIC_SPI 86 IRQ_TYPE_LEVEL_HIGH>;
> +        #clock-cells = <1>;
> +        clocks = <&ckil>, <&osc>;
> +        clock-names = "ckil", "osc";
> +    };
> --
> 2.7.4
Anson Huang May 19, 2020, 2:57 a.m. UTC | #2 
> Subject: RE: [PATCH V2] dt-bindings: clock: Convert i.MX7D clock to
> json-schema
> 
> > From: Anson Huang <Anson.Huang@nxp.com>
> > Sent: Monday, May 18, 2020 10:53 PM
> >
> > Convert the i.MX7D clock binding to DT schema format using json-schema.
> >
> > Signed-off-by: Anson Huang <Anson.Huang@nxp.com>
> > ---
> > Changes since V1:
> > 	- Update maintainer's e-mail address.
> > ---
> >  .../devicetree/bindings/clock/imx7d-clock.txt      | 13 -----
> >  .../devicetree/bindings/clock/imx7d-clock.yaml     | 64
> > ++++++++++++++++++++++
> >  2 files changed, 64 insertions(+), 13 deletions(-)  delete mode
> > 100644 Documentation/devicetree/bindings/clock/imx7d-clock.txt
> >  create mode 100644
> > Documentation/devicetree/bindings/clock/imx7d-clock.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/clock/imx7d-clock.txt
> > b/Documentation/devicetree/bindings/clock/imx7d-clock.txt
> > deleted file mode 100644
> > index 9d3026d..0000000
> > --- a/Documentation/devicetree/bindings/clock/imx7d-clock.txt
> > +++ /dev/null
> > @@ -1,13 +0,0 @@
> > -* Clock bindings for Freescale i.MX7 Dual
> > -
> > -Required properties:
> > -- compatible: Should be "fsl,imx7d-ccm"
> > -- reg: Address and length of the register set
> > -- #clock-cells: Should be <1>
> > -- clocks: list of clock specifiers, must contain an entry for each
> > required
> > -  entry in clock-names
> > -- clock-names: should include entries "ckil", "osc"
> > -
> > -The clock consumer should specify the desired clock by having the
> > clock -ID in its "clocks" phandle cell.  See
> > include/dt-bindings/clock/imx7d-clock.h
> > -for the full list of i.MX7 Dual clock IDs.
> > diff --git a/Documentation/devicetree/bindings/clock/imx7d-clock.yaml
> > b/Documentation/devicetree/bindings/clock/imx7d-clock.yaml
> > new file mode 100644
> > index 0000000..8cd0573
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/clock/imx7d-clock.yaml
> > @@ -0,0 +1,64 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2
> > +---
> > +
> > +title: Clock bindings for Freescale i.MX7 Dual
> > +
> > +maintainers:
> > +  - Frank Li <Frank.Li@nxp.com>
> > +  - Anson Huang <Anson.Huang@nxp.com>
> > +
> > +description: |
> > +  The clock consumer should specify the desired clock by having the
> > +clock
> > +  ID in its "clocks" phandle cell. See
> > +include/dt-bindings/clock/imx7d-clock.h
> > +  for the full list of i.MX7 Dual clock IDs.
> > +
> > +properties:
> > +  compatible:
> > +    const: fsl,imx7d-ccm
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  interrupts:
> > +    items:
> > +      - description: CCM interrupt request 1
> > +      - description: CCM interrupt request 2
> 
> Do we have a more specific description from RM?
> Otherwise, I'm fine with this patch.

I checked both RM and design doc before, can NOT find any description about
these 2 interrupts, so I did NOT add detail descriptions for them.

Anson
Rob Herring May 28, 2020, 8:54 p.m. UTC | #3 
On Mon, 18 May 2020 22:52:34 +0800, Anson Huang wrote:
> Convert the i.MX7D clock binding to DT schema format using json-schema.
> 
> Signed-off-by: Anson Huang <Anson.Huang@nxp.com>
> ---
> Changes since V1:
> 	- Update maintainer's e-mail address.
> ---
>  .../devicetree/bindings/clock/imx7d-clock.txt      | 13 -----
>  .../devicetree/bindings/clock/imx7d-clock.yaml     | 64 ++++++++++++++++++++++
>  2 files changed, 64 insertions(+), 13 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/clock/imx7d-clock.txt
>  create mode 100644 Documentation/devicetree/bindings/clock/imx7d-clock.yaml
> 

Applied, thanks!
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/clock/imx7d-clock.txt b/Documentation/devicetree/bindings/clock/imx7d-clock.txt
deleted file mode 100644
index 9d3026d..0000000
--- a/Documentation/devicetree/bindings/clock/imx7d-clock.txt
+++ /dev/null
@@ -1,13 +0,0 @@ 
-* Clock bindings for Freescale i.MX7 Dual
-
-Required properties:
-- compatible: Should be "fsl,imx7d-ccm"
-- reg: Address and length of the register set
-- #clock-cells: Should be <1>
-- clocks: list of clock specifiers, must contain an entry for each required
-  entry in clock-names
-- clock-names: should include entries "ckil", "osc"
-
-The clock consumer should specify the desired clock by having the clock
-ID in its "clocks" phandle cell.  See include/dt-bindings/clock/imx7d-clock.h
-for the full list of i.MX7 Dual clock IDs.
diff --git a/Documentation/devicetree/bindings/clock/imx7d-clock.yaml b/Documentation/devicetree/bindings/clock/imx7d-clock.yaml
new file mode 100644
index 0000000..8cd0573
--- /dev/null
+++ b/Documentation/devicetree/bindings/clock/imx7d-clock.yaml
@@ -0,0 +1,64 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/clock/imx7d-clock.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Clock bindings for Freescale i.MX7 Dual
+
+maintainers:
+  - Frank Li <Frank.Li@nxp.com>
+  - Anson Huang <Anson.Huang@nxp.com>
+
+description: |
+  The clock consumer should specify the desired clock by having the clock
+  ID in its "clocks" phandle cell. See include/dt-bindings/clock/imx7d-clock.h
+  for the full list of i.MX7 Dual clock IDs.
+
+properties:
+  compatible:
+    const: fsl,imx7d-ccm
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    items:
+      - description: CCM interrupt request 1
+      - description: CCM interrupt request 2
+    maxItems: 2
+
+  '#clock-cells':
+    const: 1
+
+  clocks:
+    items:
+      - description: 32k osc
+      - description: 24m osc
+
+  clock-names:
+    items:
+      - const: ckil
+      - const: osc
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - clocks
+  - clock-names
+  - '#clock-cells'
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+
+    clock-controller@30380000 {
+        compatible = "fsl,imx7d-ccm";
+        reg = <0x30380000 0x10000>;
+        interrupts = <GIC_SPI 85 IRQ_TYPE_LEVEL_HIGH>,
+                     <GIC_SPI 86 IRQ_TYPE_LEVEL_HIGH>;
+        #clock-cells = <1>;
+        clocks = <&ckil>, <&osc>;
+        clock-names = "ckil", "osc";
+    };