linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] dt-bindings: spi: convert Cadence SPI bindings to YAML
@ 2021-05-31 14:15 Nobuhiro Iwamatsu
  2021-06-04 21:46 ` Rob Herring
  0 siblings, 1 reply; 3+ messages in thread
From: Nobuhiro Iwamatsu @ 2021-05-31 14:15 UTC (permalink / raw)
  To: Mark Brown, Rob Herring, Michal Simek
  Cc: linux-spi, devicetree, linux-kernel, Harini Katakam,
	linux-arm-kernel, Nobuhiro Iwamatsu

Convert spi for Cadence SPI bindings documentation to YAML.

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

diff --git a/Documentation/devicetree/bindings/spi/spi-cadence.txt b/Documentation/devicetree/bindings/spi/spi-cadence.txt
deleted file mode 100644
index 05a2ef945664be..00000000000000
--- a/Documentation/devicetree/bindings/spi/spi-cadence.txt
+++ /dev/null
@@ -1,30 +0,0 @@
-Cadence SPI controller Device Tree Bindings
--------------------------------------------
-
-Required properties:
-- compatible		: Should be "cdns,spi-r1p6" or "xlnx,zynq-spi-r1p6".
-- reg			: Physical base address and size of SPI registers map.
-- interrupts		: Property with a value describing the interrupt
-			  number.
-- clock-names		: List of input clock names - "ref_clk", "pclk"
-			  (See clock bindings for details).
-- clocks		: Clock phandles (see clock bindings for details).
-
-Optional properties:
-- num-cs		: Number of chip selects used.
-			  If a decoder is used, this will be the number of
-			  chip selects after the decoder.
-- is-decoded-cs		: Flag to indicate whether decoder is used or not.
-
-Example:
-
-	spi@e0007000 {
-		compatible = "xlnx,zynq-spi-r1p6";
-		clock-names = "ref_clk", "pclk";
-		clocks = <&clkc 26>, <&clkc 35>;
-		interrupt-parent = <&intc>;
-		interrupts = <0 49 4>;
-		num-cs = <4>;
-		is-decoded-cs = <0>;
-		reg = <0xe0007000 0x1000>;
-	} ;
diff --git a/Documentation/devicetree/bindings/spi/spi-cadence.yaml b/Documentation/devicetree/bindings/spi/spi-cadence.yaml
new file mode 100644
index 00000000000000..27a7121ed0f9ae
--- /dev/null
+++ b/Documentation/devicetree/bindings/spi/spi-cadence.yaml
@@ -0,0 +1,63 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/spi/spi-cadence.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Cadence SPI controller Device Tree Bindings
+
+maintainers:
+  - Michal Simek <michal.simek@xilinx.com>
+
+allOf:
+  - $ref: "spi-controller.yaml#"
+
+properties:
+  compatible:
+    enum:
+      - cdns,spi-r1p6
+      - xlnx,zynq-spi-r1p6
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clock-names:
+    items:
+      - const: ref_clk
+      - const: pclk
+
+  clocks:
+    maxItems: 2
+
+  num-cs:
+    description: |
+      Number of chip selects used. If a decoder is used,
+      this will be the number of chip selects after the
+      decoder.
+    minimum: 1
+    maximum: 4
+    default: 4
+
+  is-decoded-cs:
+    description: |
+      Flag to indicate whether decoder is used or not.
+    default: 0
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    spi@e0007000 {
+      compatible = "xlnx,zynq-spi-r1p6";
+      clock-names = "ref_clk", "pclk";
+      clocks = <&clkc 26>, <&clkc 35>;
+      interrupt-parent = <&intc>;
+      interrupts = <0 49 4>;
+      num-cs = <4>;
+      is-decoded-cs = <0>;
+      reg = <0xe0007000 0x1000>;
+    };
+...
-- 
2.30.0


^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [PATCH] dt-bindings: spi: convert Cadence SPI bindings to YAML
  2021-05-31 14:15 [PATCH] dt-bindings: spi: convert Cadence SPI bindings to YAML Nobuhiro Iwamatsu
@ 2021-06-04 21:46 ` Rob Herring
  2021-06-05  0:24   ` Nobuhiro Iwamatsu
  0 siblings, 1 reply; 3+ messages in thread
From: Rob Herring @ 2021-06-04 21:46 UTC (permalink / raw)
  To: Nobuhiro Iwamatsu
  Cc: Mark Brown, Michal Simek, linux-spi, devicetree, linux-kernel,
	Harini Katakam, linux-arm-kernel

On Mon, May 31, 2021 at 11:15:38PM +0900, Nobuhiro Iwamatsu wrote:
> Convert spi for Cadence SPI bindings documentation to YAML.
> 
> Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org>
> ---
>  .../devicetree/bindings/spi/spi-cadence.txt   | 30 ---------
>  .../devicetree/bindings/spi/spi-cadence.yaml  | 63 +++++++++++++++++++
>  2 files changed, 63 insertions(+), 30 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/spi/spi-cadence.txt
>  create mode 100644 Documentation/devicetree/bindings/spi/spi-cadence.yaml
> 
> diff --git a/Documentation/devicetree/bindings/spi/spi-cadence.txt b/Documentation/devicetree/bindings/spi/spi-cadence.txt
> deleted file mode 100644
> index 05a2ef945664be..00000000000000
> --- a/Documentation/devicetree/bindings/spi/spi-cadence.txt
> +++ /dev/null
> @@ -1,30 +0,0 @@
> -Cadence SPI controller Device Tree Bindings
> --------------------------------------------
> -
> -Required properties:
> -- compatible		: Should be "cdns,spi-r1p6" or "xlnx,zynq-spi-r1p6".
> -- reg			: Physical base address and size of SPI registers map.
> -- interrupts		: Property with a value describing the interrupt
> -			  number.
> -- clock-names		: List of input clock names - "ref_clk", "pclk"
> -			  (See clock bindings for details).
> -- clocks		: Clock phandles (see clock bindings for details).
> -
> -Optional properties:
> -- num-cs		: Number of chip selects used.
> -			  If a decoder is used, this will be the number of
> -			  chip selects after the decoder.
> -- is-decoded-cs		: Flag to indicate whether decoder is used or not.
> -
> -Example:
> -
> -	spi@e0007000 {
> -		compatible = "xlnx,zynq-spi-r1p6";
> -		clock-names = "ref_clk", "pclk";
> -		clocks = <&clkc 26>, <&clkc 35>;
> -		interrupt-parent = <&intc>;
> -		interrupts = <0 49 4>;
> -		num-cs = <4>;
> -		is-decoded-cs = <0>;
> -		reg = <0xe0007000 0x1000>;
> -	} ;
> diff --git a/Documentation/devicetree/bindings/spi/spi-cadence.yaml b/Documentation/devicetree/bindings/spi/spi-cadence.yaml
> new file mode 100644
> index 00000000000000..27a7121ed0f9ae
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/spi/spi-cadence.yaml
> @@ -0,0 +1,63 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/spi/spi-cadence.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Cadence SPI controller Device Tree Bindings
> +
> +maintainers:
> +  - Michal Simek <michal.simek@xilinx.com>
> +
> +allOf:
> +  - $ref: "spi-controller.yaml#"
> +
> +properties:
> +  compatible:
> +    enum:
> +      - cdns,spi-r1p6
> +      - xlnx,zynq-spi-r1p6
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  clock-names:
> +    items:
> +      - const: ref_clk
> +      - const: pclk
> +
> +  clocks:
> +    maxItems: 2
> +
> +  num-cs:
> +    description: |
> +      Number of chip selects used. If a decoder is used,
> +      this will be the number of chip selects after the
> +      decoder.
> +    minimum: 1
> +    maximum: 4
> +    default: 4
> +
> +  is-decoded-cs:

Needs a type ref. Despite being called a 'flag' looks like it's an 
uint32. Presumably, it also needs:

enum: [ 0, 1 ]

> +    description: |
> +      Flag to indicate whether decoder is used or not.
> +    default: 0
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    spi@e0007000 {
> +      compatible = "xlnx,zynq-spi-r1p6";
> +      clock-names = "ref_clk", "pclk";
> +      clocks = <&clkc 26>, <&clkc 35>;
> +      interrupt-parent = <&intc>;
> +      interrupts = <0 49 4>;
> +      num-cs = <4>;
> +      is-decoded-cs = <0>;
> +      reg = <0xe0007000 0x1000>;
> +    };
> +...
> -- 
> 2.30.0

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] dt-bindings: spi: convert Cadence SPI bindings to YAML
  2021-06-04 21:46 ` Rob Herring
@ 2021-06-05  0:24   ` Nobuhiro Iwamatsu
  0 siblings, 0 replies; 3+ messages in thread
From: Nobuhiro Iwamatsu @ 2021-06-05  0:24 UTC (permalink / raw)
  To: Rob Herring
  Cc: Mark Brown, Michal Simek, linux-spi, devicetree,
	Linux Kernel Mailing List, Harini Katakam, linux ARM

Hi,

Thanks for your review.

2021年6月5日(土) 6:46 Rob Herring <robh@kernel.org>:
>
> On Mon, May 31, 2021 at 11:15:38PM +0900, Nobuhiro Iwamatsu wrote:
> > Convert spi for Cadence SPI bindings documentation to YAML.
> >
> > Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org>
> > ---
> >  .../devicetree/bindings/spi/spi-cadence.txt   | 30 ---------
> >  .../devicetree/bindings/spi/spi-cadence.yaml  | 63 +++++++++++++++++++
> >  2 files changed, 63 insertions(+), 30 deletions(-)
> >  delete mode 100644 Documentation/devicetree/bindings/spi/spi-cadence.txt
> >  create mode 100644 Documentation/devicetree/bindings/spi/spi-cadence.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/spi/spi-cadence.txt b/Documentation/devicetree/bindings/spi/spi-cadence.txt
> > deleted file mode 100644
> > index 05a2ef945664be..00000000000000
> > --- a/Documentation/devicetree/bindings/spi/spi-cadence.txt
> > +++ /dev/null
> > @@ -1,30 +0,0 @@
> > -Cadence SPI controller Device Tree Bindings
> > --------------------------------------------
> > -
> > -Required properties:
> > -- compatible         : Should be "cdns,spi-r1p6" or "xlnx,zynq-spi-r1p6".
> > -- reg                        : Physical base address and size of SPI registers map.
> > -- interrupts         : Property with a value describing the interrupt
> > -                       number.
> > -- clock-names                : List of input clock names - "ref_clk", "pclk"
> > -                       (See clock bindings for details).
> > -- clocks             : Clock phandles (see clock bindings for details).
> > -
> > -Optional properties:
> > -- num-cs             : Number of chip selects used.
> > -                       If a decoder is used, this will be the number of
> > -                       chip selects after the decoder.
> > -- is-decoded-cs              : Flag to indicate whether decoder is used or not.
> > -
> > -Example:
> > -
> > -     spi@e0007000 {
> > -             compatible = "xlnx,zynq-spi-r1p6";
> > -             clock-names = "ref_clk", "pclk";
> > -             clocks = <&clkc 26>, <&clkc 35>;
> > -             interrupt-parent = <&intc>;
> > -             interrupts = <0 49 4>;
> > -             num-cs = <4>;
> > -             is-decoded-cs = <0>;
> > -             reg = <0xe0007000 0x1000>;
> > -     } ;
> > diff --git a/Documentation/devicetree/bindings/spi/spi-cadence.yaml b/Documentation/devicetree/bindings/spi/spi-cadence.yaml
> > new file mode 100644
> > index 00000000000000..27a7121ed0f9ae
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/spi/spi-cadence.yaml
> > @@ -0,0 +1,63 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/spi/spi-cadence.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Cadence SPI controller Device Tree Bindings
> > +
> > +maintainers:
> > +  - Michal Simek <michal.simek@xilinx.com>
> > +
> > +allOf:
> > +  - $ref: "spi-controller.yaml#"
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - cdns,spi-r1p6
> > +      - xlnx,zynq-spi-r1p6
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  interrupts:
> > +    maxItems: 1
> > +
> > +  clock-names:
> > +    items:
> > +      - const: ref_clk
> > +      - const: pclk
> > +
> > +  clocks:
> > +    maxItems: 2
> > +
> > +  num-cs:
> > +    description: |
> > +      Number of chip selects used. If a decoder is used,
> > +      this will be the number of chip selects after the
> > +      decoder.
> > +    minimum: 1
> > +    maximum: 4
> > +    default: 4
> > +
> > +  is-decoded-cs:
>
> Needs a type ref. Despite being called a 'flag' looks like it's an
> uint32. Presumably, it also needs:
>
> enum: [ 0, 1 ]

Yeah, this is a flag, but the driver source code uses it as u32.
So, I will add ref and enum, thanks.

>
> > +    description: |
> > +      Flag to indicate whether decoder is used or not.
> > +    default: 0

Best regards,
  Nobuhiro

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2021-06-05  0:26 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-05-31 14:15 [PATCH] dt-bindings: spi: convert Cadence SPI bindings to YAML Nobuhiro Iwamatsu
2021-06-04 21:46 ` Rob Herring
2021-06-05  0:24   ` Nobuhiro Iwamatsu

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).