Re: [PATCH] dt-bindings: spi: convert Cadence SPI bindings to YAML

[Rob Herring]

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@xxxxxxxxxxx>
> ---
>  .../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@xxxxxxxxxx>
> +
> +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