2021-05-31 05:23:10

by Nobuhiro Iwamatsu

Subject: [PATCH] dt-bindings: spi: xilinx: convert to yaml

Convert SPI for Xilinx bindings documentation to YAML schemas.

Signed-off-by: Nobuhiro Iwamatsu <[email protected]>
---
.../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 <[email protected]>
+
+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>;
+ };
+...
--
2.30.0

2021-06-04 21:37:01

by Rob Herring (Arm)

Subject: Re: [PATCH] dt-bindings: spi: xilinx: convert to yaml

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 <[email protected]>
> ---
> .../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 <[email protected]>
> +
> +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

2021-06-05 00:23:30

by Nobuhiro Iwamatsu

Subject: Re: [PATCH] dt-bindings: spi: xilinx: convert to yaml

Hi,

Thanks for your review.

2021年6月5日(土) 6:33 Rob Herring <[email protected]>:
>
> 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 <[email protected]>
> > ---
> > .../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 <[email protected]>
> > +
> > +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

--
Nobuhiro Iwamatsu
iwamatsu at {nigauri.org / debian.org}
GPG ID: 40AD1FA6