[PATCH v4 0/2] mtd: nand: fix writing incorrect ECC parity data in OOB region

[PATCH v4 0/2] mtd: nand: fix writing incorrect ECC parity data in OOB region

[RogerCC Lin]

From: RogerCC Lin <rogercc.lin@mediatek.com>

This series fix chances to write incorrect ECC data which may cause uncorrectable ECC error when reading.

changes since v3:
- use macro for function arguments.

changes since v2:
- use macro for shift operation.

changes since v1:
- separate patches into 2.
- use shift operator with byte access to avoid endianness conversion problems.
- follow linux coding style.

The patch passed the test of UBIFS file-system read/write on Mediatek's RFB. The tested driver is checked-out from LEDE OpenWRT project's upstream driver, which is pretty much same as nand/next branch upstream driver(git clone https://git.lede-project.org/source.git).

RogerCC Lin (2):
  mtd: nand: fix generating over-boundary ECC data when writing
  mtd: nand: fix chances to create incomplete ECC data when writing

 drivers/mtd/nand/mtk_ecc.c  |   12 ++++++++----
 drivers/mtd/nand/mtk_nand.c |    7 +++++--
 2 files changed, 13 insertions(+), 6 deletions(-)

[PATCH v4 1/2] mtd: nand: fix generating over-boundary ECC data when writing

[RogerCC Lin]

From: RogerCC Lin <rogercc.lin@mediatek.com>

When mtk_ecc_encode() is writing the ECC parity data to the OOB
region,because each register is 4 bytes in length,but the len's unit is
in bytes,the operation in the for loop will cross the ECC's boundary.

Signed-off-by: RogerCC Lin <rogercc.lin@mediatek.com>
---
 drivers/mtd/nand/mtk_ecc.c |   12 ++++++++----
 1 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/drivers/mtd/nand/mtk_ecc.c b/drivers/mtd/nand/mtk_ecc.c
index 25a4fbd..495538e 100644
--- a/drivers/mtd/nand/mtk_ecc.c
+++ b/drivers/mtd/nand/mtk_ecc.c
@@ -366,7 +366,8 @@ int mtk_ecc_encode(struct mtk_ecc *ecc, struct mtk_ecc_config *config,
 		   u8 *data, u32 bytes)
 {
 	dma_addr_t addr;
-	u32 *p, len, i;
+	u8 *p;
+	u32 len, i, val;
 	int ret = 0;
 
 	addr = dma_map_single(ecc->dev, data, bytes, DMA_TO_DEVICE);
@@ -392,11 +393,14 @@ int mtk_ecc_encode(struct mtk_ecc *ecc, struct mtk_ecc_config *config,
 
 	/* Program ECC bytes to OOB: per sector oob = FDM + ECC + SPARE */
 	len = (config->strength * ECC_PARITY_BITS + 7) >> 3;
-	p = (u32 *)(data + bytes);
+	p = data + bytes;
 
 	/* write the parity bytes generated by the ECC back to the OOB region */
-	for (i = 0; i < len; i++)
-		p[i] = readl(ecc->regs + ECC_ENCPAR(i));
+	for (i = 0; i < len; i++) {
+		if ((i % 4) == 0)
+			val = readl(ecc->regs + ECC_ENCPAR(i >> 2));
+		p[i] = (val >> ((i % 4) * 8)) & 0xff;
+	}
 timeout:
 
 	dma_unmap_single(ecc->dev, addr, bytes, DMA_TO_DEVICE);
-- 
1.7.0.4

Re: [PATCH v4 1/2] mtd: nand: fix generating over-boundary ECC data when writing

[Boris Brezillon]

On Tue, 30 Aug 2016 20:35:47 +0800
RogerCC Lin <rogercc.lin@mediatek.com> wrote:

> From: RogerCC Lin <rogercc.lin@mediatek.com>
> 
> When mtk_ecc_encode() is writing the ECC parity data to the OOB
> region,because each register is 4 bytes in length,but the len's unit is
> in bytes,the operation in the for loop will cross the ECC's boundary.
> 
> Signed-off-by: RogerCC Lin <rogercc.lin@mediatek.com>
> ---
>  drivers/mtd/nand/mtk_ecc.c |   12 ++++++++----
>  1 files changed, 8 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/mtd/nand/mtk_ecc.c b/drivers/mtd/nand/mtk_ecc.c
> index 25a4fbd..495538e 100644
> --- a/drivers/mtd/nand/mtk_ecc.c
> +++ b/drivers/mtd/nand/mtk_ecc.c
> @@ -366,7 +366,8 @@ int mtk_ecc_encode(struct mtk_ecc *ecc, struct mtk_ecc_config *config,
>  		   u8 *data, u32 bytes)
>  {
>  	dma_addr_t addr;
> -	u32 *p, len, i;
> +	u8 *p;
> +	u32 len, i, val;
>  	int ret = 0;
>  
>  	addr = dma_map_single(ecc->dev, data, bytes, DMA_TO_DEVICE);
> @@ -392,11 +393,14 @@ int mtk_ecc_encode(struct mtk_ecc *ecc, struct mtk_ecc_config *config,
>  
>  	/* Program ECC bytes to OOB: per sector oob = FDM + ECC + SPARE */
>  	len = (config->strength * ECC_PARITY_BITS + 7) >> 3;
> -	p = (u32 *)(data + bytes);
> +	p = data + bytes;
>  
>  	/* write the parity bytes generated by the ECC back to the OOB region */
> -	for (i = 0; i < len; i++)
> -		p[i] = readl(ecc->regs + ECC_ENCPAR(i));
> +	for (i = 0; i < len; i++) {
> +		if ((i % 4) == 0)
> +			val = readl(ecc->regs + ECC_ENCPAR(i >> 2));

I'm nitpicking, but I'd prefer to have 'i / 4' instead of 'i >> 2' to
be consistent with the 'i % 4' operation, and I also find it clearer.

If you agree, I can do this change while applying the patch, no need to
resend.

> +		p[i] = (val >> ((i % 4) * 8)) & 0xff;
> +	}
>  timeout:
>  
>  	dma_unmap_single(ecc->dev, addr, bytes, DMA_TO_DEVICE);

Re: [PATCH v4 1/2] mtd: nand: fix generating over-boundary ECC data when writing

[RogerCC.Lin]

On Wed, 2016-08-31 at 10:09 +0200, Boris Brezillon wrote:
> On Tue, 30 Aug 2016 20:35:47 +0800
> RogerCC Lin <rogercc.lin@mediatek.com> wrote:
> 
> > From: RogerCC Lin <rogercc.lin@mediatek.com>
> > 
> > When mtk_ecc_encode() is writing the ECC parity data to the OOB
> > region,because each register is 4 bytes in length,but the len's unit is
> > in bytes,the operation in the for loop will cross the ECC's boundary.
> > 
> > Signed-off-by: RogerCC Lin <rogercc.lin@mediatek.com>
> > ---
> >  drivers/mtd/nand/mtk_ecc.c |   12 ++++++++----
> >  1 files changed, 8 insertions(+), 4 deletions(-)
> > 
> > diff --git a/drivers/mtd/nand/mtk_ecc.c b/drivers/mtd/nand/mtk_ecc.c
> > index 25a4fbd..495538e 100644
> > --- a/drivers/mtd/nand/mtk_ecc.c
> > +++ b/drivers/mtd/nand/mtk_ecc.c
> > @@ -366,7 +366,8 @@ int mtk_ecc_encode(struct mtk_ecc *ecc, struct mtk_ecc_config *config,
> >  		   u8 *data, u32 bytes)
> >  {
> >  	dma_addr_t addr;
> > -	u32 *p, len, i;
> > +	u8 *p;
> > +	u32 len, i, val;
> >  	int ret = 0;
> >  
> >  	addr = dma_map_single(ecc->dev, data, bytes, DMA_TO_DEVICE);
> > @@ -392,11 +393,14 @@ int mtk_ecc_encode(struct mtk_ecc *ecc, struct mtk_ecc_config *config,
> >  
> >  	/* Program ECC bytes to OOB: per sector oob = FDM + ECC + SPARE */
> >  	len = (config->strength * ECC_PARITY_BITS + 7) >> 3;
> > -	p = (u32 *)(data + bytes);
> > +	p = data + bytes;
> >  
> >  	/* write the parity bytes generated by the ECC back to the OOB region */
> > -	for (i = 0; i < len; i++)
> > -		p[i] = readl(ecc->regs + ECC_ENCPAR(i));
> > +	for (i = 0; i < len; i++) {
> > +		if ((i % 4) == 0)
> > +			val = readl(ecc->regs + ECC_ENCPAR(i >> 2));
> 
> I'm nitpicking, but I'd prefer to have 'i / 4' instead of 'i >> 2' to
> be consistent with the 'i % 4' operation, and I also find it clearer.
> 
> If you agree, I can do this change while applying the patch, no need to
> resend.

Of course, please apply the patch with 'i / 4', 
thank you.

> > +		p[i] = (val >> ((i % 4) * 8)) & 0xff;
> > +	}
> >  timeout:
> >  
> >  	dma_unmap_single(ecc->dev, addr, bytes, DMA_TO_DEVICE);
> 

Re: [PATCH v4 1/2] mtd: nand: fix generating over-boundary ECC data when writing

[Boris Brezillon]

On Wed, 31 Aug 2016 16:19:09 +0800
RogerCC.Lin <rogercc.lin@mediatek.com> wrote:

> On Wed, 2016-08-31 at 10:09 +0200, Boris Brezillon wrote:
> > On Tue, 30 Aug 2016 20:35:47 +0800
> > RogerCC Lin <rogercc.lin@mediatek.com> wrote:
> >   
> > > From: RogerCC Lin <rogercc.lin@mediatek.com>
> > > 
> > > When mtk_ecc_encode() is writing the ECC parity data to the OOB
> > > region,because each register is 4 bytes in length,but the len's unit is
> > > in bytes,the operation in the for loop will cross the ECC's boundary.
> > > 
> > > Signed-off-by: RogerCC Lin <rogercc.lin@mediatek.com>
> > > ---
> > >  drivers/mtd/nand/mtk_ecc.c |   12 ++++++++----
> > >  1 files changed, 8 insertions(+), 4 deletions(-)
> > > 
> > > diff --git a/drivers/mtd/nand/mtk_ecc.c b/drivers/mtd/nand/mtk_ecc.c
> > > index 25a4fbd..495538e 100644
> > > --- a/drivers/mtd/nand/mtk_ecc.c
> > > +++ b/drivers/mtd/nand/mtk_ecc.c
> > > @@ -366,7 +366,8 @@ int mtk_ecc_encode(struct mtk_ecc *ecc, struct mtk_ecc_config *config,
> > >  		   u8 *data, u32 bytes)
> > >  {
> > >  	dma_addr_t addr;
> > > -	u32 *p, len, i;
> > > +	u8 *p;
> > > +	u32 len, i, val;
> > >  	int ret = 0;
> > >  
> > >  	addr = dma_map_single(ecc->dev, data, bytes, DMA_TO_DEVICE);
> > > @@ -392,11 +393,14 @@ int mtk_ecc_encode(struct mtk_ecc *ecc, struct mtk_ecc_config *config,
> > >  
> > >  	/* Program ECC bytes to OOB: per sector oob = FDM + ECC + SPARE */
> > >  	len = (config->strength * ECC_PARITY_BITS + 7) >> 3;
> > > -	p = (u32 *)(data + bytes);
> > > +	p = data + bytes;
> > >  
> > >  	/* write the parity bytes generated by the ECC back to the OOB region */
> > > -	for (i = 0; i < len; i++)
> > > -		p[i] = readl(ecc->regs + ECC_ENCPAR(i));
> > > +	for (i = 0; i < len; i++) {
> > > +		if ((i % 4) == 0)
> > > +			val = readl(ecc->regs + ECC_ENCPAR(i >> 2));  
> > 
> > I'm nitpicking, but I'd prefer to have 'i / 4' instead of 'i >> 2' to
> > be consistent with the 'i % 4' operation, and I also find it clearer.
> > 
> > If you agree, I can do this change while applying the patch, no need to
> > resend.  
> 
> Of course, please apply the patch with 'i / 4', 
> thank you.

Sorry, but I'd prefer to have this patch in -rc7 or -rc8, and I'm not
taking the fixes in my tree (it goes through the MTD tree).

Can you resend a version?

You can add

Acked-by: Boris Brezillon <boris.brezillon@free-electrons.com>

> 
> > > +		p[i] = (val >> ((i % 4) * 8)) & 0xff;
> > > +	}
> > >  timeout:
> > >  
> > >  	dma_unmap_single(ecc->dev, addr, bytes, DMA_TO_DEVICE);  
> >   
> 
> 

[PATCH v4 2/2] mtd: nand: fix chances to create incomplete ECC data when writing

[RogerCC Lin]

From: RogerCC Lin <rogercc.lin@mediatek.com>

When mtk_nfc_do_write_page() comparing the sector number,because the
sector number field is at the 12th-bit position of NFI_BYTELEN
register,the masked register should be shifted 12 bits before being
compared.The result of this bug may cause the second subpage has
incomplete ECC parity bytes.

Signed-off-by: RogerCC Lin <rogercc.lin@mediatek.com>
---
 drivers/mtd/nand/mtk_nand.c |    7 +++++--
 1 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/drivers/mtd/nand/mtk_nand.c b/drivers/mtd/nand/mtk_nand.c
index ddaa2ac..5223a21 100644
--- a/drivers/mtd/nand/mtk_nand.c
+++ b/drivers/mtd/nand/mtk_nand.c
@@ -93,6 +93,9 @@
 #define		NFI_FSM_MASK		(0xf << 16)
 #define NFI_ADDRCNTR		(0x70)
 #define		CNTR_MASK		GENMASK(16, 12)
+#define		ADDRCNTR_SEC_SHIFT	(12)
+#define		ADDRCNTR_SEC(val) \
+		(((val) & CNTR_MASK) >> ADDRCNTR_SEC_SHIFT)
 #define NFI_STRADDR		(0x80)
 #define NFI_BYTELEN		(0x84)
 #define NFI_CSEL		(0x90)
@@ -699,7 +702,7 @@ static int mtk_nfc_do_write_page(struct mtd_info *mtd, struct nand_chip *chip,
 	}
 
 	ret = readl_poll_timeout_atomic(nfc->regs + NFI_ADDRCNTR, reg,
-					(reg & CNTR_MASK) >= chip->ecc.steps,
+					ADDRCNTR_SEC(reg) >= chip->ecc.steps,
 					10, MTK_TIMEOUT);
 	if (ret)
 		dev_err(dev, "hwecc write timeout\n");
@@ -902,7 +905,7 @@ static int mtk_nfc_read_subpage(struct mtd_info *mtd, struct nand_chip *chip,
 		dev_warn(nfc->dev, "read ahb/dma done timeout\n");
 
 	rc = readl_poll_timeout_atomic(nfc->regs + NFI_BYTELEN, reg,
-				       (reg & CNTR_MASK) >= sectors, 10,
+				       ADDRCNTR_SEC(reg) >= sectors, 10,
 				       MTK_TIMEOUT);
 	if (rc < 0) {
 		dev_err(nfc->dev, "subpage done timeout\n");
-- 
1.7.0.4

Re: [PATCH v4 2/2] mtd: nand: fix chances to create incomplete ECC data when writing

[Boris Brezillon]

On Tue, 30 Aug 2016 20:35:48 +0800
RogerCC Lin <rogercc.lin@mediatek.com> wrote:

> From: RogerCC Lin <rogercc.lin@mediatek.com>
> 
> When mtk_nfc_do_write_page() comparing the sector number,because the
> sector number field is at the 12th-bit position of NFI_BYTELEN
> register,the masked register should be shifted 12 bits before being
> compared.The result of this bug may cause the second subpage has
> incomplete ECC parity bytes.
> 
> Signed-off-by: RogerCC Lin <rogercc.lin@mediatek.com>

Acked-by: Boris Brezillon <boris.brezillon@free-electrons.com>

> ---
>  drivers/mtd/nand/mtk_nand.c |    7 +++++--
>  1 files changed, 5 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/mtd/nand/mtk_nand.c b/drivers/mtd/nand/mtk_nand.c
> index ddaa2ac..5223a21 100644
> --- a/drivers/mtd/nand/mtk_nand.c
> +++ b/drivers/mtd/nand/mtk_nand.c
> @@ -93,6 +93,9 @@
>  #define		NFI_FSM_MASK		(0xf << 16)
>  #define NFI_ADDRCNTR		(0x70)
>  #define		CNTR_MASK		GENMASK(16, 12)
> +#define		ADDRCNTR_SEC_SHIFT	(12)
> +#define		ADDRCNTR_SEC(val) \
> +		(((val) & CNTR_MASK) >> ADDRCNTR_SEC_SHIFT)
>  #define NFI_STRADDR		(0x80)
>  #define NFI_BYTELEN		(0x84)
>  #define NFI_CSEL		(0x90)
> @@ -699,7 +702,7 @@ static int mtk_nfc_do_write_page(struct mtd_info *mtd, struct nand_chip *chip,
>  	}
>  
>  	ret = readl_poll_timeout_atomic(nfc->regs + NFI_ADDRCNTR, reg,
> -					(reg & CNTR_MASK) >= chip->ecc.steps,
> +					ADDRCNTR_SEC(reg) >= chip->ecc.steps,
>  					10, MTK_TIMEOUT);
>  	if (ret)
>  		dev_err(dev, "hwecc write timeout\n");
> @@ -902,7 +905,7 @@ static int mtk_nfc_read_subpage(struct mtd_info *mtd, struct nand_chip *chip,
>  		dev_warn(nfc->dev, "read ahb/dma done timeout\n");
>  
>  	rc = readl_poll_timeout_atomic(nfc->regs + NFI_BYTELEN, reg,
> -				       (reg & CNTR_MASK) >= sectors, 10,
> +				       ADDRCNTR_SEC(reg) >= sectors, 10,
>  				       MTK_TIMEOUT);
>  	if (rc < 0) {
>  		dev_err(nfc->dev, "subpage done timeout\n");