Re: [PATCH v4 2/9] dt-bindings: mtd: ingenic: Change 'BCH' to 'ECC' in documentation

[Paul Cercueil]

On Mon, Mar 4, 2019 at 10:50 AM, Miquel Raynal 
<miquel.raynal@xxxxxxxxxxx> wrote:
> Hi Paul,
>
> Paul Cercueil <paul@xxxxxxxxxxxxxxx <mailto:paul@xxxxxxxxxxxxxxx>> 
> wrote on Sat,  9 Feb 2019 16:22:58
> -0300:
>
> >  The JZ4740 ECC hardware is not BCH but Reed-Solomon, so it makes 
> > more
> >  sense to use the more generic ECC term.
> >
> >  Signed-off-by: Paul Cercueil <paul@xxxxxxxxxxxxxxx 
> > <mailto:paul@xxxxxxxxxxxxxxx>>
> >  ---
> >
> >  Changes:
> >
> >  v3: New patch
> >
> >  v4: No change
> >
> >   .../devicetree/bindings/mtd/ingenic,jz4780-nand.txt    | 18 
> > +++++++++---------
> >   1 file changed, 9 insertions(+), 9 deletions(-)
> >
> >  diff --git 
> > a/Documentation/devicetree/bindings/mtd/ingenic,jz4780-nand.txt 
> > b/Documentation/devicetree/bindings/mtd/ingenic,jz4780-nand.txt
> >  index a5b940f18bf6..5a45cc54f46d 100644
> >  --- a/Documentation/devicetree/bindings/mtd/ingenic,jz4780-nand.txt
> >  +++ b/Documentation/devicetree/bindings/mtd/ingenic,jz4780-nand.txt
> >  @@ -1,4 +1,4 @@
> >  -* Ingenic JZ4780 NAND/BCH
> >  +* Ingenic JZ4780 NAND/ECC
> >
> >   This file documents the device tree bindings for NAND flash 
> > devices on the
> >   JZ4780. NAND devices are connected to the NEMC controller 
> > (described in
> >  @@ -14,10 +14,10 @@ Required NAND controller device properties:
> >     an offset of 0 and a size of 0x1000000 (i.e. the whole NEMC 
> > bank).
> >
> >   Optional NAND controller device properties:
> >  -- ingenic,bch-controller: To make use of the hardware BCH 
> > controller, this
> >  -  property must contain a phandle for the BCH controller node. The 
> > required
> >  +- ingenic,bch-controller: To make use of the hardware ECC 
> > controller, this
> >  +  property must contain a phandle for the ECC controller node. The 
> > required
>
> I think there is already a 'ecc-engine' property used by MTK and Atmel
> NAND controllers to point to the ECC engine block. Please use this
> property instead of the ingenic specific one.

ingenic,bch-controller is already in the devicetree ABI. I can't change 
it now...

> >     properties for this node are described below. If this is not 
> > specified,
> >  -  software BCH will be used instead.
> >  +  software ECC will be used instead.
> >
> >   Optional children nodes:
> >   - Individual NAND chips are children of the NAND controller node.
> >  @@ -70,17 +70,17 @@ nemc: nemc@13410000 {
> >   	};
> >   };
> >
> >  -The BCH controller is a separate SoC component used for error 
> > correction on
> >  +The ECC controller is a separate SoC component used for error 
> > correction on
> >   NAND devices. The following is a description of the device 
> > properties for a
> >  -BCH controller.
> >  +ECC controller.
> >
> >  -Required BCH properties:
> >  +Required ECC properties:
> >   - compatible: Should be one of:
> >     * ingenic,jz4740-ecc
> >     * ingenic,jz4725b-bch
> >     * ingenic,jz4780-bch
> >  -- reg: Should specify the BCH controller registers location and 
> > length.
> >  -- clocks: Clock for the BCH controller.
> >  +- reg: Should specify the ECC controller registers location and 
> > length.
> >  +- clocks: Clock for the ECC controller.
> >
> >   Example:
>
> Thanks,
> Miquèl