Skip to contentSkip to conversation

MTD: at91: atmel_nand: return bit flips for the PMECC read_page()

PATCH New Josh Wu 3 participants 6 messages Nov 21, 2012 – Nov 27, 2012

Subsystems (3)
lore
Share & tools
lore

Josh Wu

author
#0 lore raw

PATCH 1/1 MTD: at91: atmel_nand: return bit flips for the PMECC read_page()

---
 drivers/mtd/nand/atmel_nand.c |   13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)
drivers/mtd/nand/atmel_nand.c +9 -4
index 9144557..860dd36 100644
@@ -723,6 +723,7 @@ static int pmecc_correction(struct mtd_info *mtd, u32 pmecc_stat, uint8_t *buf,
 	struct atmel_nand_host *host = nand_chip->priv;
 	int i, err_nbr, eccbytes;
 	uint8_t *buf_pos;
+	int total_err = 0;
 
 	eccbytes = nand_chip->ecc.bytes;
 	for (i = 0; i < eccbytes; i++)
@@ -750,12 +751,13 @@ normal_check:
 				pmecc_correct_data(mtd, buf_pos, ecc, i,
 					host->pmecc_bytes_per_sector, err_nbr);
 				mtd->ecc_stats.corrected += err_nbr;
+				total_err += err_nbr;
 			}
 		}
 		pmecc_stat >>= 1;
 	}
 
-	return 0;
+	return total_err;
 }
 
 static int atmel_nand_pmecc_read_page(struct mtd_info *mtd,
@@ -767,6 +769,7 @@ static int atmel_nand_pmecc_read_page(struct mtd_info *mtd,
 	uint32_t *eccpos = chip->ecc.layout->eccpos;
 	uint32_t stat;
 	unsigned long end_time;
+	int bitflips = 0;
 
 	pmecc_writel(host->ecc, CTRL, PMECC_CTRL_RST);
 	pmecc_writel(host->ecc, CTRL, PMECC_CTRL_DISABLE);
@@ -789,11 +792,13 @@ static int atmel_nand_pmecc_read_page(struct mtd_info *mtd,
 	}
 
 	stat = pmecc_readl_relaxed(host->ecc, ISR);
-	if (stat != 0)
-		if (pmecc_correction(mtd, stat, buf, &oob[eccpos[0]]) != 0)
+	if (stat != 0) {
+		bitflips = pmecc_correction(mtd, stat, buf, &oob[eccpos[0]]);
+		if (bitflips < 0)
 			return -EIO;
+	}
 
-	return 0;
+	return bitflips;
 }
 
 static int atmel_nand_pmecc_write_page(struct mtd_info *mtd,
Signature · 1 line
1.7.9.5
#1 lore raw

PATCH 1/1 MTD: at91: atmel_nand: return bit flips for the PMECC read_page()

On 11/21/2012 06:14 AM, Josh Wu :

Quoted 2 lines

Can we have more comment to figure out why it is needed please?

Best regards,

Quoted 58 lines
---
 drivers/mtd/nand/atmel_nand.c |   13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)
drivers/mtd/nand/atmel_nand.c +9 -4
index 9144557..860dd36 100644
@@ -723,6 +723,7 @@ static int pmecc_correction(struct mtd_info *mtd, u32 pmecc_stat, uint8_t *buf,
 	struct atmel_nand_host *host = nand_chip->priv;
 	int i, err_nbr, eccbytes;
 	uint8_t *buf_pos;
+	int total_err = 0;
 
 	eccbytes = nand_chip->ecc.bytes;
 	for (i = 0; i < eccbytes; i++)
@@ -750,12 +751,13 @@ normal_check:
 				pmecc_correct_data(mtd, buf_pos, ecc, i,
 					host->pmecc_bytes_per_sector, err_nbr);
 				mtd->ecc_stats.corrected += err_nbr;
+				total_err += err_nbr;
 			}
 		}
 		pmecc_stat >>= 1;
 	}
 
-	return 0;
+	return total_err;
 }
 
 static int atmel_nand_pmecc_read_page(struct mtd_info *mtd,
@@ -767,6 +769,7 @@ static int atmel_nand_pmecc_read_page(struct mtd_info *mtd,
 	uint32_t *eccpos = chip->ecc.layout->eccpos;
 	uint32_t stat;
 	unsigned long end_time;
+	int bitflips = 0;
 
 	pmecc_writel(host->ecc, CTRL, PMECC_CTRL_RST);
 	pmecc_writel(host->ecc, CTRL, PMECC_CTRL_DISABLE);
@@ -789,11 +792,13 @@ static int atmel_nand_pmecc_read_page(struct mtd_info *mtd,
 	}
 
 	stat = pmecc_readl_relaxed(host->ecc, ISR);
-	if (stat != 0)
-		if (pmecc_correction(mtd, stat, buf, &oob[eccpos[0]]) != 0)
+	if (stat != 0) {
+		bitflips = pmecc_correction(mtd, stat, buf, &oob[eccpos[0]]);
+		if (bitflips < 0)
 			return -EIO;
+	}
 
-	return 0;
+	return bitflips;
 }
 
 static int atmel_nand_pmecc_write_page(struct mtd_info *mtd,
Signature · 1 line
Nicolas Ferre
author
#2 lore raw

PATCH 1/1 MTD: at91: atmel_nand: return bit flips for the PMECC read_page()

Hi, Nicolas

Quoted 3 lines · Nicolas Ferre

On 11/21/2012 06:14 AM, Josh Wu :

Quoted 1 line

Can we have more comment to figure out why it is needed please?

I will add following comment in the commit message in the v2 version.

Since the commit: 3f91e94f7f511de74c0d2abe08672ccdbdd1961c ("mtd: nand:
read_page() returns max_bitflips ()")
The ecc.read_page() method for nand drivers is changed to return the maximum number of bitflips instead of just returning 0.

And the nand.h is also explain that. I would like to adapt to it.

Best Regards,
Josh Wu

Quoted 62 lines

Best regards,

Quoted 58 lines
---
  drivers/mtd/nand/atmel_nand.c |   13 +++++++++----
  1 file changed, 9 insertions(+), 4 deletions(-)
drivers/mtd/nand/atmel_nand.c +9 -4
index 9144557..860dd36 100644
@@ -723,6 +723,7 @@ static int pmecc_correction(struct mtd_info *mtd, u32 pmecc_stat, uint8_t *buf,
  	struct atmel_nand_host *host = nand_chip->priv;
  	int i, err_nbr, eccbytes;
  	uint8_t *buf_pos;
+	int total_err = 0;
 
  	eccbytes = nand_chip->ecc.bytes;
  	for (i = 0; i < eccbytes; i++)
@@ -750,12 +751,13 @@ normal_check:
  				pmecc_correct_data(mtd, buf_pos, ecc, i,
  					host->pmecc_bytes_per_sector, err_nbr);
  				mtd->ecc_stats.corrected += err_nbr;
+				total_err += err_nbr;
  			}
  		}
  		pmecc_stat >>= 1;
  	}
 
-	return 0;
+	return total_err;
  }
 
  static int atmel_nand_pmecc_read_page(struct mtd_info *mtd,
@@ -767,6 +769,7 @@ static int atmel_nand_pmecc_read_page(struct mtd_info *mtd,
  	uint32_t *eccpos = chip->ecc.layout->eccpos;
  	uint32_t stat;
  	unsigned long end_time;
+	int bitflips = 0;
 
  	pmecc_writel(host->ecc, CTRL, PMECC_CTRL_RST);
  	pmecc_writel(host->ecc, CTRL, PMECC_CTRL_DISABLE);
@@ -789,11 +792,13 @@ static int atmel_nand_pmecc_read_page(struct mtd_info *mtd,
  	}
 
  	stat = pmecc_readl_relaxed(host->ecc, ISR);
-	if (stat != 0)
-		if (pmecc_correction(mtd, stat, buf, &oob[eccpos[0]]) != 0)
+	if (stat != 0) {
+		bitflips = pmecc_correction(mtd, stat, buf, &oob[eccpos[0]]);
+		if (bitflips < 0)
  			return -EIO;
+	}
 
-	return 0;
+	return bitflips;
  }
 
  static int atmel_nand_pmecc_write_page(struct mtd_info *mtd,
#3 lore raw

PATCH 1/1 MTD: at91: atmel_nand: return bit flips for the PMECC read_page()

Quoted 7 lines · Josh Wu

Hi, Nicolas

Quoted 3 lines · Nicolas Ferre

On 11/21/2012 06:14 AM, Josh Wu :

Quoted 1 line

Can we have more comment to figure out why it is needed please?

Quoted 8 lines

I will add following comment in the commit message in the v2 version.

Since the commit: 3f91e94f7f511de74c0d2abe08672ccdbdd1961c ("mtd: nand:
read_page() returns max_bitflips ()")
The ecc.read_page() method for nand drivers is changed to return the maximum number of bitflips instead of just returning 0.

And the nand.h is also explain that. I would like to adapt to it.

This patch avails the atmel_nand device of a change that was merged to the kernel mtd code several months ago. That change fixed a problem where higher layers that use the -EUCLEAN return code to make judgements on block wear (e.g. ubi) were marking blocks as bad when a normal number of bitflip corrections were made. The problem affected newer nands with greater ecc strength. See the entry on 'bitflip_threshold' in Documentation/ABI/testing/sysfs-class-mtd

Thanks,
Mike

#4 lore raw

PATCH 1/1 MTD: at91: atmel_nand: return bit flips for the PMECC read_page()

In reply to Josh Wu

Hi Josh, sorry for the delay.

I guess maybe I missed this one when I did the bitflips patch? Anyway, please see below...

Quoted 41 lines · Josh Wu
---
 drivers/mtd/nand/atmel_nand.c |   13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)
drivers/mtd/nand/atmel_nand.c +4 -1
index 9144557..860dd36 100644
@@ -723,6 +723,7 @@ static int pmecc_correction(struct mtd_info *mtd, u32 pmecc_stat, uint8_t *buf,
 	struct atmel_nand_host *host = nand_chip->priv;
 	int i, err_nbr, eccbytes;
 	uint8_t *buf_pos;
+	int total_err = 0;
 
 	eccbytes = nand_chip->ecc.bytes;
 	for (i = 0; i < eccbytes; i++)
@@ -750,12 +751,13 @@ normal_check:
 				pmecc_correct_data(mtd, buf_pos, ecc, i,
 					host->pmecc_bytes_per_sector, err_nbr);
 				mtd->ecc_stats.corrected += err_nbr;
+				total_err += err_nbr;
 			}
 		}
 		pmecc_stat >>= 1;
 	}
 
-	return 0;
+	return total_err;
 }
 
 static int atmel_nand_pmecc_read_page(struct mtd_info *mtd,
@@ -767,6 +769,7 @@ static int atmel_nand_pmecc_read_page(struct mtd_info *mtd,
 	uint32_t *eccpos = chip->ecc.layout->eccpos;
 	uint32_t stat;
 	unsigned long end_time;
+	int bitflips = 0;
 
 	pmecc_writel(host->ecc, CTRL, PMECC_CTRL_RST);
 	pmecc_writel(host->ecc, CTRL, PMECC_CTRL_DISABLE);

drivers/mtd/nand/atmel_nand.c static int atmel_nand_pmecc_read_page(struct mtd_info *mtd, · line 798

Quoted 9 lines
drivers/mtd/nand/atmel_nand.c +3 -2
@@ -789,11 +792,13 @@ static int atmel_nand_pmecc_read_page(struct mtd_info *mtd,
 	}
 
 	stat = pmecc_readl_relaxed(host->ecc, ISR);
-	if (stat != 0)
-		if (pmecc_correction(mtd, stat, buf, &oob[eccpos[0]]) != 0)
+	if (stat != 0) {
+		bitflips = pmecc_correction(mtd, stat, buf, &oob[eccpos[0]]);
+		if (bitflips < 0)
 			return -EIO;

This is wrong. In the case of uncorrectible bitflips, read_page() should return
0. The nand infrastructure code is alerted to the uncorrectible bitflips case by the ecc_stats, and returns -EBADMSG. This is the correct return code from the mtd layer (i.e., mtd_read()) for uncorrectible bitflips. (See the bottom of nand_do_read_ops() in nand_base.c.)

Returning 0 when uncorrectible bitflips occur is a bit counter-intuitive and potentially confusing, I know. (Fixing that would involve some rework to nand_base.c.) This prompted me to add this comment in nand.h:

* @read_page: function to read a page according to the ECC generator
* requirements; returns maximum number of bitflips corrected in
* any single ECC step, 0 if bitflips uncorrectable, -EIO hw error

I made a similiar mistake in the docg4 driver, where I returned -EBADMSG on uncorrectible errors. One consequence of that mistake was that mtdchar returned 0 to userspace, which user code interprets as 0 bytes read, and typically re-issues the read. When I ran nanddump, the read of a page containing the uncorrectible errors was repeated over and over. In the case of this patch as currently implemented, -EIO will get propagated up as-is, and the entire read operation will be aborted with an error. -EIO should only be returned in the case of a hardware error.

Hope this makes sense.

Mike

Quoted 7 lines
drivers/mtd/nand/atmel_nand.c +2 -1
+	}
 
-	return 0;
+	return bitflips;
 }
 
 static int atmel_nand_pmecc_write_page(struct mtd_info *mtd,
author
#5 lore raw

PATCH 1/1 MTD: at91: atmel_nand: return bit flips for the PMECC read_page()

Hi, Mike

Quoted 3 lines · Mike Dunn

Hi Josh, sorry for the delay.

I guess maybe I missed this one when I did the bitflips patch?

no, it seems that my patch is merged in mtd git tree after your changes. So when you do the bitflips patch, my patch is not existed in that moment. :)

Quoted 62 lines

Anyway, please
see below...

Quoted 41 lines · Josh Wu
---
  drivers/mtd/nand/atmel_nand.c |   13 +++++++++----
  1 file changed, 9 insertions(+), 4 deletions(-)
drivers/mtd/nand/atmel_nand.c +4 -1
index 9144557..860dd36 100644
@@ -723,6 +723,7 @@ static int pmecc_correction(struct mtd_info *mtd, u32 pmecc_stat, uint8_t *buf,
  	struct atmel_nand_host *host = nand_chip->priv;
  	int i, err_nbr, eccbytes;
  	uint8_t *buf_pos;
+	int total_err = 0;
 
  	eccbytes = nand_chip->ecc.bytes;
  	for (i = 0; i < eccbytes; i++)
@@ -750,12 +751,13 @@ normal_check:
  				pmecc_correct_data(mtd, buf_pos, ecc, i,
  					host->pmecc_bytes_per_sector, err_nbr);
  				mtd->ecc_stats.corrected += err_nbr;
+				total_err += err_nbr;
  			}
  		}
  		pmecc_stat >>= 1;
  	}
 
-	return 0;
+	return total_err;
  }
 
  static int atmel_nand_pmecc_read_page(struct mtd_info *mtd,
@@ -767,6 +769,7 @@ static int atmel_nand_pmecc_read_page(struct mtd_info *mtd,
  	uint32_t *eccpos = chip->ecc.layout->eccpos;
  	uint32_t stat;
  	unsigned long end_time;
+	int bitflips = 0;
 
  	pmecc_writel(host->ecc, CTRL, PMECC_CTRL_RST);
  	pmecc_writel(host->ecc, CTRL, PMECC_CTRL_DISABLE);

drivers/mtd/nand/atmel_nand.c static int atmel_nand_pmecc_read_page(struct mtd_info *mtd, · line 798

Quoted 9 lines
drivers/mtd/nand/atmel_nand.c +3 -2
@@ -789,11 +792,13 @@ static int atmel_nand_pmecc_read_page(struct mtd_info *mtd,
  	}
 
  	stat = pmecc_readl_relaxed(host->ecc, ISR);
-	if (stat != 0)
-		if (pmecc_correction(mtd, stat, buf, &oob[eccpos[0]]) != 0)
+	if (stat != 0) {
+		bitflips = pmecc_correction(mtd, stat, buf, &oob[eccpos[0]]);
+		if (bitflips < 0)
  			return -EIO;

This is wrong. In the case of uncorrectible bitflips, read_page() should return
0. The nand infrastructure code is alerted to the uncorrectible bitflips case by the ecc_stats, and returns -EBADMSG. This is the correct return code from the mtd layer (i.e., mtd_read()) for uncorrectible bitflips. (See the bottom of nand_do_read_ops() in nand_base.c.)

Quoted 7 lines

Returning 0 when uncorrectible bitflips occur is a bit counter-intuitive and potentially confusing, I know. (Fixing that would involve some rework to nand_base.c.) This prompted me to add this comment in nand.h:

* @read_page: function to read a page according to the ECC generator
* requirements; returns maximum number of bitflips corrected in
* any single ECC step, 0 if bitflips uncorrectable, -EIO hw error

yes, I just noticed this. I think in the v2 patch, I included this fix too.

Quoted 9 lines

I made a similiar mistake in the docg4 driver, where I returned -EBADMSG on uncorrectible errors. One consequence of that mistake was that mtdchar returned 0 to userspace, which user code interprets as 0 bytes read, and typically re-issues the read. When I ran nanddump, the read of a page containing the uncorrectible errors was repeated over and over. In the case of this patch as currently implemented, -EIO will get propagated up as-is, and the entire read operation will be aborted with an error. -EIO should only be returned in the case of a hardware error.

Thanks for all the detail information, that is very clear to me. I will send out v2 patch soon.

Best Regards,
Josh Wu

Quoted 13 lines

Hope this makes sense.

Mike

Quoted 7 lines
drivers/mtd/nand/atmel_nand.c +2 -1
+	}
 
-	return 0;
+	return bitflips;
  }
 
  static int atmel_nand_pmecc_write_page(struct mtd_info *mtd,