diff mbox series

dt-bindings: media: renesas,imr: Convert to json-schema

Message ID 353c2d181ceb6a5dfc553f88a201c6b18ee6914d.1621429265.git.geert+renesas@glider.be
State Superseded
Headers show
Series dt-bindings: media: renesas,imr: Convert to json-schema | expand

Commit Message

Geert Uytterhoeven May 19, 2021, 1:01 p.m. UTC 
Convert the Renesas R-Car Image Renderer Tree binding documentation to
json-schema.

Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
---
I have listed Sergei as the maintainer, as he wrote the original
bindings.  Sergei: Please scream if this is inappropriate ;-)
---
 .../devicetree/bindings/media/renesas,imr.txt | 31 ---------
 .../bindings/media/renesas,imr.yaml           | 66 +++++++++++++++++++
 2 files changed, 66 insertions(+), 31 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/media/renesas,imr.txt
 create mode 100644 Documentation/devicetree/bindings/media/renesas,imr.yaml

Comments

Laurent Pinchart May 19, 2021, 2:36 p.m. UTC | #1 
Hi Geert,

Thank you for the patch.

On Wed, May 19, 2021 at 03:01:43PM +0200, Geert Uytterhoeven wrote:
> Convert the Renesas R-Car Image Renderer Tree binding documentation to
> json-schema.
> 
> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
> ---
> I have listed Sergei as the maintainer, as he wrote the original
> bindings.  Sergei: Please scream if this is inappropriate ;-)
> ---
>  .../devicetree/bindings/media/renesas,imr.txt | 31 ---------
>  .../bindings/media/renesas,imr.yaml           | 66 +++++++++++++++++++
>  2 files changed, 66 insertions(+), 31 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/media/renesas,imr.txt
>  create mode 100644 Documentation/devicetree/bindings/media/renesas,imr.yaml
> 
> diff --git a/Documentation/devicetree/bindings/media/renesas,imr.txt b/Documentation/devicetree/bindings/media/renesas,imr.txt
> deleted file mode 100644
> index b0614153ed3682eb..0000000000000000
> --- a/Documentation/devicetree/bindings/media/renesas,imr.txt
> +++ /dev/null
> @@ -1,31 +0,0 @@
> -Renesas R-Car Image Renderer (Distortion Correction Engine)
> ------------------------------------------------------------
> -
> -The image renderer, or the distortion correction engine, is a drawing processor
> -with a simple instruction system capable of referencing video capture data or
> -data in an external memory as 2D texture data and performing texture mapping
> -and drawing with respect to any shape that is split into triangular objects.
> -
> -Required properties:
> -
> -- compatible: "renesas,<soctype>-imr-lx4", "renesas,imr-lx4" as a fallback for
> -  the image renderer light extended 4 (IMR-LX4) found in the R-Car gen3 SoCs,
> -  where the examples with <soctype> are:
> -  - "renesas,r8a7795-imr-lx4" for R-Car H3,
> -  - "renesas,r8a7796-imr-lx4" for R-Car M3-W.
> -- reg: offset and length of the register block;
> -- interrupts: single interrupt specifier;
> -- clocks: single clock phandle/specifier pair;
> -- power-domains: power domain phandle/specifier pair;
> -- resets: reset phandle/specifier pair.
> -
> -Example:
> -
> -	imr-lx4@fe860000 {
> -		compatible = "renesas,r8a7795-imr-lx4", "renesas,imr-lx4";
> -		reg = <0 0xfe860000 0 0x2000>;
> -		interrupts = <GIC_SPI 192 IRQ_TYPE_LEVEL_HIGH>;
> -		clocks = <&cpg CPG_MOD 823>;
> -		power-domains = <&sysc R8A7795_PD_A3VC>;
> -		resets = <&cpg 823>;
> -	};
> diff --git a/Documentation/devicetree/bindings/media/renesas,imr.yaml b/Documentation/devicetree/bindings/media/renesas,imr.yaml
> new file mode 100644
> index 0000000000000000..ea4579209e81660f
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/media/renesas,imr.yaml
> @@ -0,0 +1,66 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/media/renesas,imr.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Renesas R-Car Image Renderer (Distortion Correction Engine)
> +
> +maintainers:
> +  - Sergei Shtylyov <sergei.shtylyov@gmail.com>
> +
> +description:
> +  The image renderer, or the distortion correction engine, is a drawing
> +  processor with a simple instruction system capable of referencing video
> +  capture data or data in an external memory as 2D texture data and performing
> +  texture mapping and drawing with respect to any shape that is split into
> +  triangular objects.

I'd add a blank line between paragraphs.

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

> +  The image renderer light extended 4 (IMR-LX4) is found in R-Car Gen3 SoCs.
> +
> +properties:
> +  compatible:
> +    items:
> +      - enum:
> +          - renesas,r8a7795-imr-lx4 # R-Car H3
> +          - renesas,r8a7796-imr-lx4 # R-Car M3-W
> +      - const: renesas,imr-lx4      # R-Car Gen3
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  clocks:
> +    maxItems: 1
> +
> +  power-domains:
> +    maxItems: 1
> +
> +  resets:
> +    maxItems: 1
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - clocks
> +  - power-domains
> +  - resets
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/clock/r8a7795-cpg-mssr.h>
> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> +    #include <dt-bindings/power/r8a7795-sysc.h>
> +
> +    imr-lx4@fe860000 {
> +            compatible = "renesas,r8a7795-imr-lx4", "renesas,imr-lx4";
> +            reg = <0xfe860000 0x2000>;
> +            interrupts = <GIC_SPI 192 IRQ_TYPE_LEVEL_HIGH>;
> +            clocks = <&cpg CPG_MOD 823>;
> +            power-domains = <&sysc R8A7795_PD_A3VC>;
> +            resets = <&cpg 823>;
> +    };
Rob Herring (Arm) May 20, 2021, 7:50 p.m. UTC | #2 
On Wed, May 19, 2021 at 05:36:35PM +0300, Laurent Pinchart wrote:
> Hi Geert,

> 

> Thank you for the patch.

> 

> On Wed, May 19, 2021 at 03:01:43PM +0200, Geert Uytterhoeven wrote:

> > Convert the Renesas R-Car Image Renderer Tree binding documentation to

> > json-schema.

> > 

> > Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>

> > ---

> > I have listed Sergei as the maintainer, as he wrote the original

> > bindings.  Sergei: Please scream if this is inappropriate ;-)

> > ---

> >  .../devicetree/bindings/media/renesas,imr.txt | 31 ---------

> >  .../bindings/media/renesas,imr.yaml           | 66 +++++++++++++++++++

> >  2 files changed, 66 insertions(+), 31 deletions(-)

> >  delete mode 100644 Documentation/devicetree/bindings/media/renesas,imr.txt

> >  create mode 100644 Documentation/devicetree/bindings/media/renesas,imr.yaml

> > 

> > diff --git a/Documentation/devicetree/bindings/media/renesas,imr.txt b/Documentation/devicetree/bindings/media/renesas,imr.txt

> > deleted file mode 100644

> > index b0614153ed3682eb..0000000000000000

> > --- a/Documentation/devicetree/bindings/media/renesas,imr.txt

> > +++ /dev/null

> > @@ -1,31 +0,0 @@

> > -Renesas R-Car Image Renderer (Distortion Correction Engine)

> > ------------------------------------------------------------

> > -

> > -The image renderer, or the distortion correction engine, is a drawing processor

> > -with a simple instruction system capable of referencing video capture data or

> > -data in an external memory as 2D texture data and performing texture mapping

> > -and drawing with respect to any shape that is split into triangular objects.

> > -

> > -Required properties:

> > -

> > -- compatible: "renesas,<soctype>-imr-lx4", "renesas,imr-lx4" as a fallback for

> > -  the image renderer light extended 4 (IMR-LX4) found in the R-Car gen3 SoCs,

> > -  where the examples with <soctype> are:

> > -  - "renesas,r8a7795-imr-lx4" for R-Car H3,

> > -  - "renesas,r8a7796-imr-lx4" for R-Car M3-W.

> > -- reg: offset and length of the register block;

> > -- interrupts: single interrupt specifier;

> > -- clocks: single clock phandle/specifier pair;

> > -- power-domains: power domain phandle/specifier pair;

> > -- resets: reset phandle/specifier pair.

> > -

> > -Example:

> > -

> > -	imr-lx4@fe860000 {

> > -		compatible = "renesas,r8a7795-imr-lx4", "renesas,imr-lx4";

> > -		reg = <0 0xfe860000 0 0x2000>;

> > -		interrupts = <GIC_SPI 192 IRQ_TYPE_LEVEL_HIGH>;

> > -		clocks = <&cpg CPG_MOD 823>;

> > -		power-domains = <&sysc R8A7795_PD_A3VC>;

> > -		resets = <&cpg 823>;

> > -	};

> > diff --git a/Documentation/devicetree/bindings/media/renesas,imr.yaml b/Documentation/devicetree/bindings/media/renesas,imr.yaml

> > new file mode 100644

> > index 0000000000000000..ea4579209e81660f

> > --- /dev/null

> > +++ b/Documentation/devicetree/bindings/media/renesas,imr.yaml

> > @@ -0,0 +1,66 @@

> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

> > +%YAML 1.2

> > +---

> > +$id: http://devicetree.org/schemas/media/renesas,imr.yaml#

> > +$schema: http://devicetree.org/meta-schemas/core.yaml#

> > +

> > +title: Renesas R-Car Image Renderer (Distortion Correction Engine)

> > +

> > +maintainers:

> > +  - Sergei Shtylyov <sergei.shtylyov@gmail.com>

> > +

> > +description:

> > +  The image renderer, or the distortion correction engine, is a drawing

> > +  processor with a simple instruction system capable of referencing video

> > +  capture data or data in an external memory as 2D texture data and performing

> > +  texture mapping and drawing with respect to any shape that is split into

> > +  triangular objects.

> 

> I'd add a blank line between paragraphs.


Either way, it needs a '|' if you want to preserve formatting.
Rob Herring (Arm) May 20, 2021, 7:51 p.m. UTC | #3 
On Wed, 19 May 2021 15:01:43 +0200, Geert Uytterhoeven wrote:
> Convert the Renesas R-Car Image Renderer Tree binding documentation to

> json-schema.

> 

> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>

> ---

> I have listed Sergei as the maintainer, as he wrote the original

> bindings.  Sergei: Please scream if this is inappropriate ;-)

> ---

>  .../devicetree/bindings/media/renesas,imr.txt | 31 ---------

>  .../bindings/media/renesas,imr.yaml           | 66 +++++++++++++++++++

>  2 files changed, 66 insertions(+), 31 deletions(-)

>  delete mode 100644 Documentation/devicetree/bindings/media/renesas,imr.txt

>  create mode 100644 Documentation/devicetree/bindings/media/renesas,imr.yaml

> 


Reviewed-by: Rob Herring <robh@kernel.org>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/media/renesas,imr.txt b/Documentation/devicetree/bindings/media/renesas,imr.txt
deleted file mode 100644
index b0614153ed3682eb..0000000000000000
--- a/Documentation/devicetree/bindings/media/renesas,imr.txt
+++ /dev/null
@@ -1,31 +0,0 @@ 
-Renesas R-Car Image Renderer (Distortion Correction Engine)
------------------------------------------------------------
-
-The image renderer, or the distortion correction engine, is a drawing processor
-with a simple instruction system capable of referencing video capture data or
-data in an external memory as 2D texture data and performing texture mapping
-and drawing with respect to any shape that is split into triangular objects.
-
-Required properties:
-
-- compatible: "renesas,<soctype>-imr-lx4", "renesas,imr-lx4" as a fallback for
-  the image renderer light extended 4 (IMR-LX4) found in the R-Car gen3 SoCs,
-  where the examples with <soctype> are:
-  - "renesas,r8a7795-imr-lx4" for R-Car H3,
-  - "renesas,r8a7796-imr-lx4" for R-Car M3-W.
-- reg: offset and length of the register block;
-- interrupts: single interrupt specifier;
-- clocks: single clock phandle/specifier pair;
-- power-domains: power domain phandle/specifier pair;
-- resets: reset phandle/specifier pair.
-
-Example:
-
-	imr-lx4@fe860000 {
-		compatible = "renesas,r8a7795-imr-lx4", "renesas,imr-lx4";
-		reg = <0 0xfe860000 0 0x2000>;
-		interrupts = <GIC_SPI 192 IRQ_TYPE_LEVEL_HIGH>;
-		clocks = <&cpg CPG_MOD 823>;
-		power-domains = <&sysc R8A7795_PD_A3VC>;
-		resets = <&cpg 823>;
-	};
diff --git a/Documentation/devicetree/bindings/media/renesas,imr.yaml b/Documentation/devicetree/bindings/media/renesas,imr.yaml
new file mode 100644
index 0000000000000000..ea4579209e81660f
--- /dev/null
+++ b/Documentation/devicetree/bindings/media/renesas,imr.yaml
@@ -0,0 +1,66 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/media/renesas,imr.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Renesas R-Car Image Renderer (Distortion Correction Engine)
+
+maintainers:
+  - Sergei Shtylyov <sergei.shtylyov@gmail.com>
+
+description:
+  The image renderer, or the distortion correction engine, is a drawing
+  processor with a simple instruction system capable of referencing video
+  capture data or data in an external memory as 2D texture data and performing
+  texture mapping and drawing with respect to any shape that is split into
+  triangular objects.
+  The image renderer light extended 4 (IMR-LX4) is found in R-Car Gen3 SoCs.
+
+properties:
+  compatible:
+    items:
+      - enum:
+          - renesas,r8a7795-imr-lx4 # R-Car H3
+          - renesas,r8a7796-imr-lx4 # R-Car M3-W
+      - const: renesas,imr-lx4      # R-Car Gen3
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  power-domains:
+    maxItems: 1
+
+  resets:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - clocks
+  - power-domains
+  - resets
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/r8a7795-cpg-mssr.h>
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    #include <dt-bindings/power/r8a7795-sysc.h>
+
+    imr-lx4@fe860000 {
+            compatible = "renesas,r8a7795-imr-lx4", "renesas,imr-lx4";
+            reg = <0xfe860000 0x2000>;
+            interrupts = <GIC_SPI 192 IRQ_TYPE_LEVEL_HIGH>;
+            clocks = <&cpg CPG_MOD 823>;
+            power-domains = <&sysc R8A7795_PD_A3VC>;
+            resets = <&cpg 823>;
+    };