diff mbox series

[v1,2/6] dt-bindings: spi: Convert cadence-quadspi.txt to cadence-quadspi.yaml

Message ID 20201016093138.28871-3-vadivel.muruganx.ramuthevar@linux.intel.com
State New
Headers show
Series None | expand

Commit Message

Ramuthevar,Vadivel MuruganX Oct. 16, 2020, 9:31 a.m. UTC
From: Ramuthevar Vadivel Murugan <vadivel.muruganx.ramuthevar@linux.intel.com>

Convert the cadence-quadspi.txt documentation to cadence-quadspi.yaml
remove the cadence-quadspi.txt from Documentation/devicetree/bindings/spi/

Signed-off-by: Ramuthevar Vadivel Murugan <vadivel.muruganx.ramuthevar@linux.intel.com>
---
 .../devicetree/bindings/spi/cadence-quadspi.txt    |  67 ----------
 .../devicetree/bindings/spi/cadence-quadspi.yaml   | 148 +++++++++++++++++++++
 2 files changed, 148 insertions(+), 67 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/spi/cadence-quadspi.txt
 create mode 100644 Documentation/devicetree/bindings/spi/cadence-quadspi.yaml

Comments

Mark Brown Oct. 16, 2020, 4:18 p.m. UTC | #1
On Fri, Oct 16, 2020 at 05:31:34PM +0800, Ramuthevar,Vadivel MuruganX wrote:
> From: Ramuthevar Vadivel Murugan <vadivel.muruganx.ramuthevar@linux.intel.com>

> 

> Convert the cadence-quadspi.txt documentation to cadence-quadspi.yaml

> remove the cadence-quadspi.txt from Documentation/devicetree/bindings/spi/


Please make YAML conversions the last thing in any patch series -
there's sometimes a backlog on reviews as the DT maintainers are very
busy so this means that delays with them don't hold the rest of the
series up.
Ramuthevar,Vadivel MuruganX Oct. 19, 2020, 6:22 a.m. UTC | #2
Hi Mark,

On 17/10/2020 12:18 am, Mark Brown wrote:
> On Fri, Oct 16, 2020 at 05:31:34PM +0800, Ramuthevar,Vadivel MuruganX wrote:
>> From: Ramuthevar Vadivel Murugan <vadivel.muruganx.ramuthevar@linux.intel.com>
>>
>> Convert the cadence-quadspi.txt documentation to cadence-quadspi.yaml
>> remove the cadence-quadspi.txt from Documentation/devicetree/bindings/spi/
> 
> Please make YAML conversions the last thing in any patch series -
> there's sometimes a backlog on reviews as the DT maintainers are very
> busy so this means that delays with them don't hold the rest of the
> series up.
Thank you for the comment and suggestions...
Sure, will do that accordingly.

Regards
Vadivel
>
Rob Herring (Arm) Oct. 19, 2020, 9:35 p.m. UTC | #3
On Fri, Oct 16, 2020 at 05:31:34PM +0800, Ramuthevar,Vadivel MuruganX wrote:
> From: Ramuthevar Vadivel Murugan <vadivel.muruganx.ramuthevar@linux.intel.com>

> 

> Convert the cadence-quadspi.txt documentation to cadence-quadspi.yaml

> remove the cadence-quadspi.txt from Documentation/devicetree/bindings/spi/

> 

> Signed-off-by: Ramuthevar Vadivel Murugan <vadivel.muruganx.ramuthevar@linux.intel.com>

> ---

>  .../devicetree/bindings/spi/cadence-quadspi.txt    |  67 ----------

>  .../devicetree/bindings/spi/cadence-quadspi.yaml   | 148 +++++++++++++++++++++

>  2 files changed, 148 insertions(+), 67 deletions(-)

>  delete mode 100644 Documentation/devicetree/bindings/spi/cadence-quadspi.txt

>  create mode 100644 Documentation/devicetree/bindings/spi/cadence-quadspi.yaml

> 

> diff --git a/Documentation/devicetree/bindings/spi/cadence-quadspi.txt b/Documentation/devicetree/bindings/spi/cadence-quadspi.txt

> deleted file mode 100644

> index 945be7d5b236..000000000000

> --- a/Documentation/devicetree/bindings/spi/cadence-quadspi.txt

> +++ /dev/null

> @@ -1,67 +0,0 @@

> -* Cadence Quad SPI controller

> -

> -Required properties:

> -- compatible : should be one of the following:

> -	Generic default - "cdns,qspi-nor".

> -	For TI 66AK2G SoC - "ti,k2g-qspi", "cdns,qspi-nor".

> -	For TI AM654 SoC  - "ti,am654-ospi", "cdns,qspi-nor".

> -- reg : Contains two entries, each of which is a tuple consisting of a

> -	physical address and length. The first entry is the address and

> -	length of the controller register set. The second entry is the

> -	address and length of the QSPI Controller data area.

> -- interrupts : Unit interrupt specifier for the controller interrupt.

> -- clocks : phandle to the Quad SPI clock.

> -- cdns,fifo-depth : Size of the data FIFO in words.

> -- cdns,fifo-width : Bus width of the data FIFO in bytes.

> -- cdns,trigger-address : 32-bit indirect AHB trigger address.

> -

> -Optional properties:

> -- cdns,is-decoded-cs : Flag to indicate whether decoder is used or not.

> -- cdns,rclk-en : Flag to indicate that QSPI return clock is used to latch

> -  the read data rather than the QSPI clock. Make sure that QSPI return

> -  clock is populated on the board before using this property.

> -

> -Optional subnodes:

> -Subnodes of the Cadence Quad SPI controller are spi slave nodes with additional

> -custom properties:

> -- cdns,read-delay : Delay for read capture logic, in clock cycles

> -- cdns,tshsl-ns : Delay in nanoseconds for the length that the master

> -                  mode chip select outputs are de-asserted between

> -		  transactions.

> -- cdns,tsd2d-ns : Delay in nanoseconds between one chip select being

> -                  de-activated and the activation of another.

> -- cdns,tchsh-ns : Delay in nanoseconds between last bit of current

> -                  transaction and deasserting the device chip select

> -		  (qspi_n_ss_out).

> -- cdns,tslch-ns : Delay in nanoseconds between setting qspi_n_ss_out low

> -                  and first bit transfer.

> -- resets	: Must contain an entry for each entry in reset-names.

> -		  See ../reset/reset.txt for details.

> -- reset-names	: Must include either "qspi" and/or "qspi-ocp".

> -

> -Example:

> -

> -	qspi: spi@ff705000 {

> -		compatible = "cdns,qspi-nor";

> -		#address-cells = <1>;

> -		#size-cells = <0>;

> -		reg = <0xff705000 0x1000>,

> -		      <0xffa00000 0x1000>;

> -		interrupts = <0 151 4>;

> -		clocks = <&qspi_clk>;

> -		cdns,is-decoded-cs;

> -		cdns,fifo-depth = <128>;

> -		cdns,fifo-width = <4>;

> -		cdns,trigger-address = <0x00000000>;

> -		resets = <&rst QSPI_RESET>, <&rst QSPI_OCP_RESET>;

> -		reset-names = "qspi", "qspi-ocp";

> -

> -		flash0: n25q00@0 {

> -			...

> -			cdns,read-delay = <4>;

> -			cdns,tshsl-ns = <50>;

> -			cdns,tsd2d-ns = <50>;

> -			cdns,tchsh-ns = <4>;

> -			cdns,tslch-ns = <4>;

> -		};

> -	};

> diff --git a/Documentation/devicetree/bindings/spi/cadence-quadspi.yaml b/Documentation/devicetree/bindings/spi/cadence-quadspi.yaml

> new file mode 100644

> index 000000000000..6ed8122a1326

> --- /dev/null

> +++ b/Documentation/devicetree/bindings/spi/cadence-quadspi.yaml

> @@ -0,0 +1,148 @@

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

> +%YAML 1.2

> +---

> +$id: http://devicetree.org/schemas/spi/cadence-quadspi.yaml#

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

> +

> +title: Cadence Quad SPI controller

> +

> +maintainers:

> +  - Vadivel Murugan <vadivel.muruganx.ramuthevar@intel.com>

> +

> +allOf:

> +  - $ref: "spi-controller.yaml#"

> +

> +properties:

> +  compatible:

> +    items:

> +      - const: cdns,qspi-nor

> +      - const: ti,k2g-qspi, cdns,qspi-nor

> +      - const: ti,am654-ospi, cdns,qspi-nor


This says that compatible must be:

compatible = "cdns,qspi-nor", "ti,k2g-qspi, cdns,qspi-nor", "ti,am654-ospi, cdns,qspi-nor";

You need 'oneOf' here.

> +

> +    description:

> +      Should be one of the above supported compatible strings.


Drop.

> +      optional properties

> +      "cdns,is-decoded-cs" - Flag to indicate whether decoder is used or not.

> +      "cdns,rclk-en" - Flag to indicate that QSPI return clock is used to latch

> +      the read data rather than the QSPI clock. Make sure that QSPI return

> +      clock is populated on the board before using this property.


Needs to be actual schema properties.

> +

> +  reg:

> +    maxItems: 2

> +

> +    description:

> +      Contains two entries, each of which is a tuple consisting of a

> +      physical address and length. The first entry is the address and

> +      length of the controller register set. The second entry is the

> +      address and length of the QSPI Controller data area.


reg:
  items:
    - description: the controller register set
    - description: the controller data area

> +

> +  interrupts:

> +    maxItems: 1

> +    description:

> +      Unit interrupt specifier for the controller interrupt.


Drop description.

> +

> +  clocks:

> +    maxItems: 1

> +    description:

> +      phandle to the Quad SPI clock.


Drop description.

> +

> +  cdns,fifo-depth:

> +    description:

> +      Size of the data FIFO in words.

> +    allOf:


Don't need allOf here now.

> +      - $ref: "/schemas/types.yaml#/definitions/uint32"

> +      - enum: [ 128, 256 ]

> +      - default: 128

> +

> +  cdns,fifo-width:

> +    $ref: /schemas/types.yaml#/definitions/uint32

> +    description:

> +      Bus width of the data FIFO in bytes.

> +    multipleOf: 4


minimum/maximum?

> +

> +  cdns,trigger-address:

> +    $ref: /schemas/types.yaml#/definitions/uint32

> +    description:

> +      32-bit indirect AHB trigger address.

> +

> +  resets:


How many (maxItems)?

> +     description:

> +       Must contain an entry for each entry in reset-names.

> +       See ../reset/reset.txt for details.


Drop.

> +

> +  reset-names:

> +    description:

> +      Must include either "qspi" and/or "qspi-ocp".


Needs to be schema constraints.

> +

> +# subnode's properties

> +patternProperties:

> +  "@[0-9a-f]+$":

> +    type: object

> +    description:

> +      flash device uses the subnodes below defined properties.

> +

> +  cdns,read-delay:

> +    $ref: /schemas/types.yaml#/definitions/uint32

> +    description:

> +      Delay for read capture logic, in clock cycles.

> +

> +  cdns,tshsl-ns:

> +    description: |

> +      Delay in nanoseconds for the length that the master mode chip select

> +      outputs are de-asserted between transactions.

> +

> +  cdns,tsd2d-ns:

> +    description: |

> +      Delay in nanoseconds between one chip select being de-activated

> +      and the activation of another.

> +

> +  cdns,tchsh-ns:

> +    description: |

> +      Delay in nanoseconds between last bit of current transaction and

> +      deasserting the device chip select (qspi_n_ss_out).

> +

> +  cdns,tslch-ns:

> +    description: |

> +      Delay in nanoseconds between setting qspi_n_ss_out low and

> +      first bit transfer.

> +

> +required:

> +  - compatible

> +  - reg

> +  - interrupts

> +  - clocks

> +  - cdns,fifo-depth

> +  - cdns,fifo-width

> +  - cdns,trigger-address

> +  - resets

> +  - reset-names


additionalProperties: false

> +

> +examples:

> +  - |

> +    qspi: spi@ff705000 {

> +      compatible = "cadence,qspi";

> +      #address-cells = <1>;

> +      #size-cells = <0>;

> +      reg = <0xff705000 0x1000>,

> +            <0xffa00000 0x1000>;

> +      interrupts = <0 151 4>;

> +      clocks = <&qspi_clk>;

> +      cdns,fifo-depth = <128>;

> +      cdns,fifo-width = <4>;

> +      cdns,trigger-address = <0x00000000>;

> +      resets = <&rst 0x1>, <&rst 0x2>;

> +      reset-names = "qspi", "qspi-ocp";

> +

> +      flash@0 {

> +              compatible = "jedec,spi-nor";

> +              reg = <0x0>;

> +              cdns,read-delay = <4>;

> +              cdns,tshsl-ns = <50>;

> +              cdns,tsd2d-ns = <50>;

> +              cdns,tchsh-ns = <4>;

> +              cdns,tslch-ns = <4>;

> +     };

> +

> +    };

> +

> +...

> -- 

> 2.11.0

>
Ramuthevar,Vadivel MuruganX Oct. 20, 2020, 7:05 a.m. UTC | #4
Hi Rob,

Thank you for review comments...

On 20/10/2020 5:35 am, Rob Herring wrote:
> On Fri, Oct 16, 2020 at 05:31:34PM +0800, Ramuthevar,Vadivel MuruganX wrote:
>> From: Ramuthevar Vadivel Murugan <vadivel.muruganx.ramuthevar@linux.intel.com>
>>
>> Convert the cadence-quadspi.txt documentation to cadence-quadspi.yaml
>> remove the cadence-quadspi.txt from Documentation/devicetree/bindings/spi/
>>
>> Signed-off-by: Ramuthevar Vadivel Murugan <vadivel.muruganx.ramuthevar@linux.intel.com>
>> ---
>>   .../devicetree/bindings/spi/cadence-quadspi.txt    |  67 ----------
>>   .../devicetree/bindings/spi/cadence-quadspi.yaml   | 148 +++++++++++++++++++++
>>   2 files changed, 148 insertions(+), 67 deletions(-)
>>   delete mode 100644 Documentation/devicetree/bindings/spi/cadence-quadspi.txt
>>   create mode 100644 Documentation/devicetree/bindings/spi/cadence-quadspi.yaml
>>
>> diff --git a/Documentation/devicetree/bindings/spi/cadence-quadspi.txt b/Documentation/devicetree/bindings/spi/cadence-quadspi.txt
>> deleted file mode 100644
>> index 945be7d5b236..000000000000
>> --- a/Documentation/devicetree/bindings/spi/cadence-quadspi.txt
>> +++ /dev/null
>> @@ -1,67 +0,0 @@
>> -* Cadence Quad SPI controller
>> -
>> -Required properties:
>> -- compatible : should be one of the following:
>> -	Generic default - "cdns,qspi-nor".
>> -	For TI 66AK2G SoC - "ti,k2g-qspi", "cdns,qspi-nor".
>> -	For TI AM654 SoC  - "ti,am654-ospi", "cdns,qspi-nor".
>> -- reg : Contains two entries, each of which is a tuple consisting of a
>> -	physical address and length. The first entry is the address and
>> -	length of the controller register set. The second entry is the
>> -	address and length of the QSPI Controller data area.
>> -- interrupts : Unit interrupt specifier for the controller interrupt.
>> -- clocks : phandle to the Quad SPI clock.
>> -- cdns,fifo-depth : Size of the data FIFO in words.
>> -- cdns,fifo-width : Bus width of the data FIFO in bytes.
>> -- cdns,trigger-address : 32-bit indirect AHB trigger address.
>> -
>> -Optional properties:
>> -- cdns,is-decoded-cs : Flag to indicate whether decoder is used or not.
>> -- cdns,rclk-en : Flag to indicate that QSPI return clock is used to latch
>> -  the read data rather than the QSPI clock. Make sure that QSPI return
>> -  clock is populated on the board before using this property.
>> -
>> -Optional subnodes:
>> -Subnodes of the Cadence Quad SPI controller are spi slave nodes with additional
>> -custom properties:
>> -- cdns,read-delay : Delay for read capture logic, in clock cycles
>> -- cdns,tshsl-ns : Delay in nanoseconds for the length that the master
>> -                  mode chip select outputs are de-asserted between
>> -		  transactions.
>> -- cdns,tsd2d-ns : Delay in nanoseconds between one chip select being
>> -                  de-activated and the activation of another.
>> -- cdns,tchsh-ns : Delay in nanoseconds between last bit of current
>> -                  transaction and deasserting the device chip select
>> -		  (qspi_n_ss_out).
>> -- cdns,tslch-ns : Delay in nanoseconds between setting qspi_n_ss_out low
>> -                  and first bit transfer.
>> -- resets	: Must contain an entry for each entry in reset-names.
>> -		  See ../reset/reset.txt for details.
>> -- reset-names	: Must include either "qspi" and/or "qspi-ocp".
>> -
>> -Example:
>> -
>> -	qspi: spi@ff705000 {
>> -		compatible = "cdns,qspi-nor";
>> -		#address-cells = <1>;
>> -		#size-cells = <0>;
>> -		reg = <0xff705000 0x1000>,
>> -		      <0xffa00000 0x1000>;
>> -		interrupts = <0 151 4>;
>> -		clocks = <&qspi_clk>;
>> -		cdns,is-decoded-cs;
>> -		cdns,fifo-depth = <128>;
>> -		cdns,fifo-width = <4>;
>> -		cdns,trigger-address = <0x00000000>;
>> -		resets = <&rst QSPI_RESET>, <&rst QSPI_OCP_RESET>;
>> -		reset-names = "qspi", "qspi-ocp";
>> -
>> -		flash0: n25q00@0 {
>> -			...
>> -			cdns,read-delay = <4>;
>> -			cdns,tshsl-ns = <50>;
>> -			cdns,tsd2d-ns = <50>;
>> -			cdns,tchsh-ns = <4>;
>> -			cdns,tslch-ns = <4>;
>> -		};
>> -	};
>> diff --git a/Documentation/devicetree/bindings/spi/cadence-quadspi.yaml b/Documentation/devicetree/bindings/spi/cadence-quadspi.yaml
>> new file mode 100644
>> index 000000000000..6ed8122a1326
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/spi/cadence-quadspi.yaml
>> @@ -0,0 +1,148 @@
>> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/spi/cadence-quadspi.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Cadence Quad SPI controller
>> +
>> +maintainers:
>> +  - Vadivel Murugan <vadivel.muruganx.ramuthevar@intel.com>
>> +
>> +allOf:
>> +  - $ref: "spi-controller.yaml#"
>> +
>> +properties:
>> +  compatible:
>> +    items:
>> +      - const: cdns,qspi-nor
>> +      - const: ti,k2g-qspi, cdns,qspi-nor
>> +      - const: ti,am654-ospi, cdns,qspi-nor
> 
> This says that compatible must be:
> 
> compatible = "cdns,qspi-nor", "ti,k2g-qspi, cdns,qspi-nor", "ti,am654-ospi, cdns,qspi-nor";
> 
> You need 'oneOf' here.
Noted, will update.
> 
>> +
>> +    description:
>> +      Should be one of the above supported compatible strings.
> 
> Drop.
okay
> 
>> +      optional properties
>> +      "cdns,is-decoded-cs" - Flag to indicate whether decoder is used or not.
>> +      "cdns,rclk-en" - Flag to indicate that QSPI return clock is used to latch
>> +      the read data rather than the QSPI clock. Make sure that QSPI return
>> +      clock is populated on the board before using this property.
> 
> Needs to be actual schema properties.
Noted.
> 
>> +
>> +  reg:
>> +    maxItems: 2
>> +
>> +    description:
>> +      Contains two entries, each of which is a tuple consisting of a
>> +      physical address and length. The first entry is the address and
>> +      length of the controller register set. The second entry is the
>> +      address and length of the QSPI Controller data area.
> 
> reg:
>    items:
>      - description: the controller register set
>      - description: the controller data area
Noted, Thank you for the pointer.
> 
>> +
>> +  interrupts:
>> +    maxItems: 1
>> +    description:
>> +      Unit interrupt specifier for the controller interrupt.
> 
> Drop description.
will drop.
> 
>> +
>> +  clocks:
>> +    maxItems: 1
>> +    description:
>> +      phandle to the Quad SPI clock.
> 
> Drop description.
will drop.
> 
>> +
>> +  cdns,fifo-depth:
>> +    description:
>> +      Size of the data FIFO in words.
>> +    allOf:
> 
> Don't need allOf here now.
will remove , noted
> 
>> +      - $ref: "/schemas/types.yaml#/definitions/uint32"
>> +      - enum: [ 128, 256 ]
>> +      - default: 128
>> +
>> +  cdns,fifo-width:
>> +    $ref: /schemas/types.yaml#/definitions/uint32
>> +    description:
>> +      Bus width of the data FIFO in bytes.
>> +    multipleOf: 4
> 
> minimum/maximum?
it's fixed width, so will add default instead of minimum/maximum.
> 
>> +
>> +  cdns,trigger-address:
>> +    $ref: /schemas/types.yaml#/definitions/uint32
>> +    description:
>> +      32-bit indirect AHB trigger address.
>> +
>> +  resets:
> 
> How many (maxItems)?
maxItems : 2
> 
>> +     description:
>> +       Must contain an entry for each entry in reset-names.
>> +       See ../reset/reset.txt for details.
> 
> Drop.
Noted, will drop.
> 
>> +
>> +  reset-names:
>> +    description:
>> +      Must include either "qspi" and/or "qspi-ocp".
> 
> Needs to be schema constraints.
Okay, noted.
> 
>> +
>> +# subnode's properties
>> +patternProperties:
>> +  "@[0-9a-f]+$":
>> +    type: object
>> +    description:
>> +      flash device uses the subnodes below defined properties.
>> +
>> +  cdns,read-delay:
>> +    $ref: /schemas/types.yaml#/definitions/uint32
>> +    description:
>> +      Delay for read capture logic, in clock cycles.
>> +
>> +  cdns,tshsl-ns:
>> +    description: |
>> +      Delay in nanoseconds for the length that the master mode chip select
>> +      outputs are de-asserted between transactions.
>> +
>> +  cdns,tsd2d-ns:
>> +    description: |
>> +      Delay in nanoseconds between one chip select being de-activated
>> +      and the activation of another.
>> +
>> +  cdns,tchsh-ns:
>> +    description: |
>> +      Delay in nanoseconds between last bit of current transaction and
>> +      deasserting the device chip select (qspi_n_ss_out).
>> +
>> +  cdns,tslch-ns:
>> +    description: |
>> +      Delay in nanoseconds between setting qspi_n_ss_out low and
>> +      first bit transfer.
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +  - interrupts
>> +  - clocks
>> +  - cdns,fifo-depth
>> +  - cdns,fifo-width
>> +  - cdns,trigger-address
>> +  - resets
>> +  - reset-names
> 
> additionalProperties: false
Noted, thanks!

Regards
Vadivel
> 
>> +
>> +examples:
>> +  - |
>> +    qspi: spi@ff705000 {
>> +      compatible = "cadence,qspi";
>> +      #address-cells = <1>;
>> +      #size-cells = <0>;
>> +      reg = <0xff705000 0x1000>,
>> +            <0xffa00000 0x1000>;
>> +      interrupts = <0 151 4>;
>> +      clocks = <&qspi_clk>;
>> +      cdns,fifo-depth = <128>;
>> +      cdns,fifo-width = <4>;
>> +      cdns,trigger-address = <0x00000000>;
>> +      resets = <&rst 0x1>, <&rst 0x2>;
>> +      reset-names = "qspi", "qspi-ocp";
>> +
>> +      flash@0 {
>> +              compatible = "jedec,spi-nor";
>> +              reg = <0x0>;
>> +              cdns,read-delay = <4>;
>> +              cdns,tshsl-ns = <50>;
>> +              cdns,tsd2d-ns = <50>;
>> +              cdns,tchsh-ns = <4>;
>> +              cdns,tslch-ns = <4>;
>> +     };
>> +
>> +    };
>> +
>> +...
>> -- 
>> 2.11.0
>>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/spi/cadence-quadspi.txt b/Documentation/devicetree/bindings/spi/cadence-quadspi.txt
deleted file mode 100644
index 945be7d5b236..000000000000
--- a/Documentation/devicetree/bindings/spi/cadence-quadspi.txt
+++ /dev/null
@@ -1,67 +0,0 @@ 
-* Cadence Quad SPI controller
-
-Required properties:
-- compatible : should be one of the following:
-	Generic default - "cdns,qspi-nor".
-	For TI 66AK2G SoC - "ti,k2g-qspi", "cdns,qspi-nor".
-	For TI AM654 SoC  - "ti,am654-ospi", "cdns,qspi-nor".
-- reg : Contains two entries, each of which is a tuple consisting of a
-	physical address and length. The first entry is the address and
-	length of the controller register set. The second entry is the
-	address and length of the QSPI Controller data area.
-- interrupts : Unit interrupt specifier for the controller interrupt.
-- clocks : phandle to the Quad SPI clock.
-- cdns,fifo-depth : Size of the data FIFO in words.
-- cdns,fifo-width : Bus width of the data FIFO in bytes.
-- cdns,trigger-address : 32-bit indirect AHB trigger address.
-
-Optional properties:
-- cdns,is-decoded-cs : Flag to indicate whether decoder is used or not.
-- cdns,rclk-en : Flag to indicate that QSPI return clock is used to latch
-  the read data rather than the QSPI clock. Make sure that QSPI return
-  clock is populated on the board before using this property.
-
-Optional subnodes:
-Subnodes of the Cadence Quad SPI controller are spi slave nodes with additional
-custom properties:
-- cdns,read-delay : Delay for read capture logic, in clock cycles
-- cdns,tshsl-ns : Delay in nanoseconds for the length that the master
-                  mode chip select outputs are de-asserted between
-		  transactions.
-- cdns,tsd2d-ns : Delay in nanoseconds between one chip select being
-                  de-activated and the activation of another.
-- cdns,tchsh-ns : Delay in nanoseconds between last bit of current
-                  transaction and deasserting the device chip select
-		  (qspi_n_ss_out).
-- cdns,tslch-ns : Delay in nanoseconds between setting qspi_n_ss_out low
-                  and first bit transfer.
-- resets	: Must contain an entry for each entry in reset-names.
-		  See ../reset/reset.txt for details.
-- reset-names	: Must include either "qspi" and/or "qspi-ocp".
-
-Example:
-
-	qspi: spi@ff705000 {
-		compatible = "cdns,qspi-nor";
-		#address-cells = <1>;
-		#size-cells = <0>;
-		reg = <0xff705000 0x1000>,
-		      <0xffa00000 0x1000>;
-		interrupts = <0 151 4>;
-		clocks = <&qspi_clk>;
-		cdns,is-decoded-cs;
-		cdns,fifo-depth = <128>;
-		cdns,fifo-width = <4>;
-		cdns,trigger-address = <0x00000000>;
-		resets = <&rst QSPI_RESET>, <&rst QSPI_OCP_RESET>;
-		reset-names = "qspi", "qspi-ocp";
-
-		flash0: n25q00@0 {
-			...
-			cdns,read-delay = <4>;
-			cdns,tshsl-ns = <50>;
-			cdns,tsd2d-ns = <50>;
-			cdns,tchsh-ns = <4>;
-			cdns,tslch-ns = <4>;
-		};
-	};
diff --git a/Documentation/devicetree/bindings/spi/cadence-quadspi.yaml b/Documentation/devicetree/bindings/spi/cadence-quadspi.yaml
new file mode 100644
index 000000000000..6ed8122a1326
--- /dev/null
+++ b/Documentation/devicetree/bindings/spi/cadence-quadspi.yaml
@@ -0,0 +1,148 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/spi/cadence-quadspi.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Cadence Quad SPI controller
+
+maintainers:
+  - Vadivel Murugan <vadivel.muruganx.ramuthevar@intel.com>
+
+allOf:
+  - $ref: "spi-controller.yaml#"
+
+properties:
+  compatible:
+    items:
+      - const: cdns,qspi-nor
+      - const: ti,k2g-qspi, cdns,qspi-nor
+      - const: ti,am654-ospi, cdns,qspi-nor
+
+    description:
+      Should be one of the above supported compatible strings.
+      optional properties
+      "cdns,is-decoded-cs" - Flag to indicate whether decoder is used or not.
+      "cdns,rclk-en" - Flag to indicate that QSPI return clock is used to latch
+      the read data rather than the QSPI clock. Make sure that QSPI return
+      clock is populated on the board before using this property.
+
+  reg:
+    maxItems: 2
+
+    description:
+      Contains two entries, each of which is a tuple consisting of a
+      physical address and length. The first entry is the address and
+      length of the controller register set. The second entry is the
+      address and length of the QSPI Controller data area.
+
+  interrupts:
+    maxItems: 1
+    description:
+      Unit interrupt specifier for the controller interrupt.
+
+  clocks:
+    maxItems: 1
+    description:
+      phandle to the Quad SPI clock.
+
+  cdns,fifo-depth:
+    description:
+      Size of the data FIFO in words.
+    allOf:
+      - $ref: "/schemas/types.yaml#/definitions/uint32"
+      - enum: [ 128, 256 ]
+      - default: 128
+
+  cdns,fifo-width:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description:
+      Bus width of the data FIFO in bytes.
+    multipleOf: 4
+
+  cdns,trigger-address:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description:
+      32-bit indirect AHB trigger address.
+
+  resets:
+     description:
+       Must contain an entry for each entry in reset-names.
+       See ../reset/reset.txt for details.
+
+  reset-names:
+    description:
+      Must include either "qspi" and/or "qspi-ocp".
+
+# subnode's properties
+patternProperties:
+  "@[0-9a-f]+$":
+    type: object
+    description:
+      flash device uses the subnodes below defined properties.
+
+  cdns,read-delay:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description:
+      Delay for read capture logic, in clock cycles.
+
+  cdns,tshsl-ns:
+    description: |
+      Delay in nanoseconds for the length that the master mode chip select
+      outputs are de-asserted between transactions.
+
+  cdns,tsd2d-ns:
+    description: |
+      Delay in nanoseconds between one chip select being de-activated
+      and the activation of another.
+
+  cdns,tchsh-ns:
+    description: |
+      Delay in nanoseconds between last bit of current transaction and
+      deasserting the device chip select (qspi_n_ss_out).
+
+  cdns,tslch-ns:
+    description: |
+      Delay in nanoseconds between setting qspi_n_ss_out low and
+      first bit transfer.
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - clocks
+  - cdns,fifo-depth
+  - cdns,fifo-width
+  - cdns,trigger-address
+  - resets
+  - reset-names
+
+examples:
+  - |
+    qspi: spi@ff705000 {
+      compatible = "cadence,qspi";
+      #address-cells = <1>;
+      #size-cells = <0>;
+      reg = <0xff705000 0x1000>,
+            <0xffa00000 0x1000>;
+      interrupts = <0 151 4>;
+      clocks = <&qspi_clk>;
+      cdns,fifo-depth = <128>;
+      cdns,fifo-width = <4>;
+      cdns,trigger-address = <0x00000000>;
+      resets = <&rst 0x1>, <&rst 0x2>;
+      reset-names = "qspi", "qspi-ocp";
+
+      flash@0 {
+              compatible = "jedec,spi-nor";
+              reg = <0x0>;
+              cdns,read-delay = <4>;
+              cdns,tshsl-ns = <50>;
+              cdns,tsd2d-ns = <50>;
+              cdns,tchsh-ns = <4>;
+              cdns,tslch-ns = <4>;
+     };
+
+    };
+
+...