Commit b440915a authored by Miquel Raynal's avatar Miquel Raynal
Browse files

dt-bindings: mtd: Document boolean NAND ECC properties 



Document nand-use-soft-ecc-engine and nand-no-ecc-engine properties.
The former is here to force software correction, the latter prevents
any correction to happen.

These properties (along with nand-ecc-engine) are supposed to be more
accurate than the current nand-ecc-modes wich is very misleading and
very often people think it is mandatory while the core should be
relied upon to decide which correction to handle.

nand-ecc-mode was already inacurate, but it becomes totally
problematic with setups where there are several hardware engines.

Signed-off-by: default avatarMiquel Raynal <miquel.raynal@bootlin.com>
Reviewed-by: default avatarRob Herring <robh@kernel.org>
Link: https://lore.kernel.org/linux-mtd/20200827085208.16276-8-miquel.raynal@bootlin.com
parent 45770064

Documentation/devicetree/bindings/mtd/nand-controller.yaml

+8 −0
Original line number Diff line number Diff line
@@ -68,6 +68,14 @@ patternProperties: 
          3/ The ECC engine is external, in this case the phandle should

          reference the specific ECC engine node.



      nand-use-soft-ecc-engine:

        type: boolean

        description: Use a software ECC engine.



      nand-no-ecc-engine:

        type: boolean

        description: Do not use any ECC correction.



      nand-ecc-placement:

        allOf:

          - $ref: /schemas/types.yaml#/definitions/string