diff mbox series

[09/18] dt-bindings: spi: mxic: Document the nand-ecc-engine property

Message ID 20211020142809.349347-10-miquel.raynal@bootlin.com (mailing list archive)
State Superseded
Headers show
Series External ECC engines & Macronix support | expand

Commit Message

Miquel Raynal Oct. 20, 2021, 2:28 p.m. UTC
This SPI controller supports interacting with an external ECC
engine. The nand-ecc-engine property already exist in the NAND world but
also applies to SPI controller nodes which have external correction
capabilities like Macronix's.

Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
---
 .../devicetree/bindings/spi/mxicy,mx25f0a-spi.yaml          | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Rob Herring Oct. 28, 2021, 9:38 p.m. UTC | #1
On Wed, Oct 20, 2021 at 04:28:00PM +0200, Miquel Raynal wrote:
> This SPI controller supports interacting with an external ECC
> engine. The nand-ecc-engine property already exist in the NAND world but
> also applies to SPI controller nodes which have external correction
> capabilities like Macronix's.
> 
> Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
> ---
>  .../devicetree/bindings/spi/mxicy,mx25f0a-spi.yaml          | 6 ++++++
>  1 file changed, 6 insertions(+)

This should come before patch 8. The example would fail if 
'unevaluatedProperties' did anything.

Reviewed-by: Rob Herring <robh@kernel.org>

> 
> diff --git a/Documentation/devicetree/bindings/spi/mxicy,mx25f0a-spi.yaml b/Documentation/devicetree/bindings/spi/mxicy,mx25f0a-spi.yaml
> index 4036c14fc533..01618a77627d 100644
> --- a/Documentation/devicetree/bindings/spi/mxicy,mx25f0a-spi.yaml
> +++ b/Documentation/devicetree/bindings/spi/mxicy,mx25f0a-spi.yaml
> @@ -43,6 +43,12 @@ properties:
>    "#size-cells":
>      const: 0
>  
> +  nand-ecc-engine:
> +    allOf:
> +      - $ref: /schemas/types.yaml#/definitions/phandle
> +    description: NAND ECC engine used by the SPI controller in order to perform
> +      on-the-fly correction when using a SPI-NAND memory.
> +
>  required:
>    - compatible
>    - reg
> -- 
> 2.27.0
> 
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/spi/mxicy,mx25f0a-spi.yaml b/Documentation/devicetree/bindings/spi/mxicy,mx25f0a-spi.yaml
index 4036c14fc533..01618a77627d 100644
--- a/Documentation/devicetree/bindings/spi/mxicy,mx25f0a-spi.yaml
+++ b/Documentation/devicetree/bindings/spi/mxicy,mx25f0a-spi.yaml
@@ -43,6 +43,12 @@  properties:
   "#size-cells":
     const: 0
 
+  nand-ecc-engine:
+    allOf:
+      - $ref: /schemas/types.yaml#/definitions/phandle
+    description: NAND ECC engine used by the SPI controller in order to perform
+      on-the-fly correction when using a SPI-NAND memory.
+
 required:
   - compatible
   - reg