[RFC PATCH 04/10] dt-bindings: mtd: Describe Macronix NAND ECC engine

[Miquel Raynal]

Describe Macronix NAND ECC engine. This engine may be used as an
external engine or pipelined, both ways are shown in the examples.

Signed-off-by: Miquel Raynal <miquel.raynal at bootlin.com>
---
 .../bindings/mtd/mxic,nand-ecc-engine.yaml    | 78 +++++++++++++++++++
 1 file changed, 78 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mtd/mxic,nand-ecc-engine.yaml

diff --git a/Documentation/devicetree/bindings/mtd/mxic,nand-ecc-engine.yaml b/Documentation/devicetree/bindings/mtd/mxic,nand-ecc-engine.yaml
new file mode 100644
index 000000000000..2f5cf1a4e826
--- /dev/null
+++ b/Documentation/devicetree/bindings/mtd/mxic,nand-ecc-engine.yaml
@@ -0,0 +1,78 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mtd/mxic,nand-ecc-engine.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Macronix NAND ECC engine device tree bindings
+
+maintainers:
+  - Miquel Raynal <miquel.raynal at bootlin.com>
+
+properties:
+  compatible:
+    items:
+      - const: mxic,nand-ecc-engine-rev3
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    /* External configuration */
+    spi_controller0: spi at 43c30000 {
+        compatible = "mxicy,mx25f0a-spi";
+       	reg = <0x43c30000 0x10000>, <0xa0000000 0x4000000>;
+       	reg-names = "regs", "dirmap";
+       	clocks = <&clkwizard 0>, <&clkwizard 1>, <&clkc 15>;
+       	clock-names = "send_clk", "send_dly_clk", "ps_clk";
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        flash at 0 {
+            compatible = "spi-nand";
+            reg = <0>;
+            nand-ecc-engine = <&ecc_engine0>;
+        };
+    };
+
+    ecc_engine0: ecc at 43c40000 {
+        compatible = "mxic,nand-ecc-engine-rev3";
+        reg = <0x43c40000 0x10000>;
+    };
+
+  - |
+    /* Pipelined configuration */
+    spi_controller1: spi at 43c30000 {
+        compatible = "mxicy,mx25f0a-spi";
+       	reg = <0x43c30000 0x10000>, <0xa0000000 0x4000000>;
+       	reg-names = "regs", "dirmap";
+       	clocks = <&clkwizard 0>, <&clkwizard 1>, <&clkc 15>;
+       	clock-names = "send_clk", "send_dly_clk", "ps_clk";
+        #address-cells = <1>;
+        #size-cells = <0>;
+        nand-ecc-engine = <&ecc_engine1>;
+
+        flash at 0 {
+            compatible = "spi-nand";
+            reg = <0>;
+            nand-ecc-engine = <&spi_controller1>;
+        };
+    };
+
+    ecc_engine1: ecc at 43c40000 {
+        compatible = "mxic,nand-ecc-engine-rev3";
+        reg = <0x43c40000 0x10000>;
+    };
-- 
2.27.0