diff mbox series

dt-bindings: spi: xilinx: convert to yaml

Message ID 20210531052142.695430-1-iwamatsu@nigauri.org (mailing list archive)
State New, archived
Headers show
Series dt-bindings: spi: xilinx: convert to yaml | expand

Commit Message

Nobuhiro Iwamatsu May 31, 2021, 5:21 a.m. UTC 
Convert SPI for Xilinx bindings documentation to YAML schemas.

Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org>
---
 .../devicetree/bindings/spi/spi-xilinx.txt    | 23 ---------
 .../devicetree/bindings/spi/spi-xilinx.yaml   | 51 +++++++++++++++++++
 2 files changed, 51 insertions(+), 23 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/spi/spi-xilinx.txt
 create mode 100644 Documentation/devicetree/bindings/spi/spi-xilinx.yaml

Comments

Rob Herring June 4, 2021, 9:33 p.m. UTC | #1 
On Mon, May 31, 2021 at 02:21:42PM +0900, Nobuhiro Iwamatsu wrote:
> Convert SPI for Xilinx bindings documentation to YAML schemas.
> 
> Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org>
> ---
>  .../devicetree/bindings/spi/spi-xilinx.txt    | 23 ---------
>  .../devicetree/bindings/spi/spi-xilinx.yaml   | 51 +++++++++++++++++++
>  2 files changed, 51 insertions(+), 23 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/spi/spi-xilinx.txt
>  create mode 100644 Documentation/devicetree/bindings/spi/spi-xilinx.yaml
> 
> diff --git a/Documentation/devicetree/bindings/spi/spi-xilinx.txt b/Documentation/devicetree/bindings/spi/spi-xilinx.txt
> deleted file mode 100644
> index 5f4ed3e5c9942c..00000000000000
> --- a/Documentation/devicetree/bindings/spi/spi-xilinx.txt
> +++ /dev/null
> @@ -1,23 +0,0 @@
> -Xilinx SPI controller Device Tree Bindings
> --------------------------------------------------
> -
> -Required properties:
> -- compatible		: Should be "xlnx,xps-spi-2.00.a", "xlnx,xps-spi-2.00.b" or "xlnx,axi-quad-spi-1.00.a"
> -- reg			: Physical base address and size of SPI registers map.
> -- interrupts		: Property with a value describing the interrupt
> -			  number.
> -
> -Optional properties:
> -- xlnx,num-ss-bits	 : Number of chip selects used.
> -- xlnx,num-transfer-bits : Number of bits per transfer. This will be 8 if not specified
> -
> -Example:
> -	axi_quad_spi@41e00000 {
> -			compatible = "xlnx,xps-spi-2.00.a";
> -			interrupt-parent = <&intc>;
> -			interrupts = <0 31 1>;
> -			reg = <0x41e00000 0x10000>;
> -			xlnx,num-ss-bits = <0x1>;
> -			xlnx,num-transfer-bits = <32>;
> -	};
> -
> diff --git a/Documentation/devicetree/bindings/spi/spi-xilinx.yaml b/Documentation/devicetree/bindings/spi/spi-xilinx.yaml
> new file mode 100644
> index 00000000000000..17463151b36a02
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/spi/spi-xilinx.yaml
> @@ -0,0 +1,51 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/spi/spi-xilinx.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Xilinx SPI controller Device Tree Bindings
> +
> +maintainers:
> +  - Michal Simek <michal.simek@xilinx.com>
> +
> +allOf:
> +  - $ref: "spi-controller.yaml#"
> +
> +properties:
> +  compatible:
> +    oneOf:
> +      - const: xlnx,xps-spi-2.00.a
> +      - const: xlnx,xps-spi-2.00.b
> +      - const: xlnx,axi-quad-spi-1.00.a

Use enum instead of oneOf+const.

> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  xlnx,num-ss-bits:
> +    description: Number of chip selects used.

Constraints? 0-2^32 is good?

> +
> +  xlnx,num-transfer-bits:
> +    description: Number of bits per transfer. This will be 8 if not specified.

Constraints?

> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    spi0: spi@41e00000 {
> +      compatible = "xlnx,xps-spi-2.00.a";
> +      interrupt-parent = <&intc>;
> +      interrupts = <0 31 1>;
> +      reg = <0x41e00000 0x10000>;
> +      xlnx,num-ss-bits = <0x1>;
> +      xlnx,num-transfer-bits = <32>;
> +    };
> +...
> -- 
> 2.30.0
Nobuhiro Iwamatsu June 5, 2021, 12:18 a.m. UTC | #2 
Hi,

Thanks for your review.

2021年6月5日(土) 6:33 Rob Herring <robh@kernel.org>:
>
> On Mon, May 31, 2021 at 02:21:42PM +0900, Nobuhiro Iwamatsu wrote:
> > Convert SPI for Xilinx bindings documentation to YAML schemas.
> >
> > Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org>
> > ---
> >  .../devicetree/bindings/spi/spi-xilinx.txt    | 23 ---------
> >  .../devicetree/bindings/spi/spi-xilinx.yaml   | 51 +++++++++++++++++++
> >  2 files changed, 51 insertions(+), 23 deletions(-)
> >  delete mode 100644 Documentation/devicetree/bindings/spi/spi-xilinx.txt
> >  create mode 100644 Documentation/devicetree/bindings/spi/spi-xilinx.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/spi/spi-xilinx.txt b/Documentation/devicetree/bindings/spi/spi-xilinx.txt
> > deleted file mode 100644
> > index 5f4ed3e5c9942c..00000000000000
> > --- a/Documentation/devicetree/bindings/spi/spi-xilinx.txt
> > +++ /dev/null
> > @@ -1,23 +0,0 @@
> > -Xilinx SPI controller Device Tree Bindings
> > --------------------------------------------------
> > -
> > -Required properties:
> > -- compatible         : Should be "xlnx,xps-spi-2.00.a", "xlnx,xps-spi-2.00.b" or "xlnx,axi-quad-spi-1.00.a"
> > -- reg                        : Physical base address and size of SPI registers map.
> > -- interrupts         : Property with a value describing the interrupt
> > -                       number.
> > -
> > -Optional properties:
> > -- xlnx,num-ss-bits    : Number of chip selects used.
> > -- xlnx,num-transfer-bits : Number of bits per transfer. This will be 8 if not specified
> > -
> > -Example:
> > -     axi_quad_spi@41e00000 {
> > -                     compatible = "xlnx,xps-spi-2.00.a";
> > -                     interrupt-parent = <&intc>;
> > -                     interrupts = <0 31 1>;
> > -                     reg = <0x41e00000 0x10000>;
> > -                     xlnx,num-ss-bits = <0x1>;
> > -                     xlnx,num-transfer-bits = <32>;
> > -     };
> > -
> > diff --git a/Documentation/devicetree/bindings/spi/spi-xilinx.yaml b/Documentation/devicetree/bindings/spi/spi-xilinx.yaml
> > new file mode 100644
> > index 00000000000000..17463151b36a02
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/spi/spi-xilinx.yaml
> > @@ -0,0 +1,51 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/spi/spi-xilinx.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Xilinx SPI controller Device Tree Bindings
> > +
> > +maintainers:
> > +  - Michal Simek <michal.simek@xilinx.com>
> > +
> > +allOf:
> > +  - $ref: "spi-controller.yaml#"
> > +
> > +properties:
> > +  compatible:
> > +    oneOf:
> > +      - const: xlnx,xps-spi-2.00.a
> > +      - const: xlnx,xps-spi-2.00.b
> > +      - const: xlnx,axi-quad-spi-1.00.a
>
> Use enum instead of oneOf+const.

OK, I will change using enum.

>
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  interrupts:
> > +    maxItems: 1
> > +
> > +  xlnx,num-ss-bits:
> > +    description: Number of chip selects used.
>
> Constraints? 0-2^32 is good?

I will add constraints.

>
> > +
> > +  xlnx,num-transfer-bits:
> > +    description: Number of bits per transfer. This will be 8 if not specified.
>
> Constraints?

Same above.

Best regards,
  Nobuhiro
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/spi/spi-xilinx.txt b/Documentation/devicetree/bindings/spi/spi-xilinx.txt
deleted file mode 100644
index 5f4ed3e5c9942c..00000000000000
--- a/Documentation/devicetree/bindings/spi/spi-xilinx.txt
+++ /dev/null
@@ -1,23 +0,0 @@ 
-Xilinx SPI controller Device Tree Bindings
--------------------------------------------------
-
-Required properties:
-- compatible		: Should be "xlnx,xps-spi-2.00.a", "xlnx,xps-spi-2.00.b" or "xlnx,axi-quad-spi-1.00.a"
-- reg			: Physical base address and size of SPI registers map.
-- interrupts		: Property with a value describing the interrupt
-			  number.
-
-Optional properties:
-- xlnx,num-ss-bits	 : Number of chip selects used.
-- xlnx,num-transfer-bits : Number of bits per transfer. This will be 8 if not specified
-
-Example:
-	axi_quad_spi@41e00000 {
-			compatible = "xlnx,xps-spi-2.00.a";
-			interrupt-parent = <&intc>;
-			interrupts = <0 31 1>;
-			reg = <0x41e00000 0x10000>;
-			xlnx,num-ss-bits = <0x1>;
-			xlnx,num-transfer-bits = <32>;
-	};
-
diff --git a/Documentation/devicetree/bindings/spi/spi-xilinx.yaml b/Documentation/devicetree/bindings/spi/spi-xilinx.yaml
new file mode 100644
index 00000000000000..17463151b36a02
--- /dev/null
+++ b/Documentation/devicetree/bindings/spi/spi-xilinx.yaml
@@ -0,0 +1,51 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/spi/spi-xilinx.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Xilinx SPI controller Device Tree Bindings
+
+maintainers:
+  - Michal Simek <michal.simek@xilinx.com>
+
+allOf:
+  - $ref: "spi-controller.yaml#"
+
+properties:
+  compatible:
+    oneOf:
+      - const: xlnx,xps-spi-2.00.a
+      - const: xlnx,xps-spi-2.00.b
+      - const: xlnx,axi-quad-spi-1.00.a
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  xlnx,num-ss-bits:
+    description: Number of chip selects used.
+
+  xlnx,num-transfer-bits:
+    description: Number of bits per transfer. This will be 8 if not specified.
+
+required:
+  - compatible
+  - reg
+  - interrupts
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    spi0: spi@41e00000 {
+      compatible = "xlnx,xps-spi-2.00.a";
+      interrupt-parent = <&intc>;
+      interrupts = <0 31 1>;
+      reg = <0x41e00000 0x10000>;
+      xlnx,num-ss-bits = <0x1>;
+      xlnx,num-transfer-bits = <32>;
+    };
+...