mtd: nand: omap: add support for BCH16_ECC
Subsystems (2)
v3 cover mtd: nand: omap: add support for BCH16_ECC
This patch series should be picked above
[1] http://lists.denx.de/pipermail/u-boot/2014-April/177231.html
*changes v2 -> v3*
- dropped [PATCH] am33xx: elm: add support for BCH16_ECC - ELM driver updates re-using existing code in omap_elm.c
- rebased and refreshed above [1] and u-boot-2014.04
- Documentation updated in doc/nand.README
*changes v1 -> v2*
- rebased for http://lists.denx.de/pipermail/u-boot/2013-September/162107.html
- minor code cleanup
*original v1*
This patch series add support of BCH16_ECC scheme.
As BCH16_ECC scheme generates 26bytes of ECC syndrome per 512B data, hence this scheme is usable only for NAND devices having 4K or above page-size, as their OOB/spare area has enough space to accomodate ECC.
This patch series is applicable over an above following series:
http://lists.denx.de/pipermail/u-boot/2013-September/161859.html
Pekon Gupta (2):
mtd: nand: omap: add support for BCH16_ECC - NAND driver updates
am335x: update README for BCH16
doc/README.nand | 42 +++++++++++++++++++++++ drivers/mtd/nand/omap_gpmc.c | 78 ++++++++++++++++++++++++++++++++++++++++++- include/linux/mtd/omap_gpmc.h | 8 +++++ 3 files changed, 127 insertions(+), 1 deletion(-)
Signature · 1 line
1.8.5.1.163.gd7aced9
PATCH v3 1/2 mtd: nand: omap: add support for BCH16_ECC - NAND driver updates
This patch add support for BCH16_ECC to omap_gpmc driver.
*need to BCH16 ECC scheme*
With newer SLC Flash technologies and MLC NAND, and large densities, pagesizes Flash devices have become more suspectible to bit-flips. Thus stronger ECC schemes are required for protecting the data.
But stronger ECC schemes have come with larger-sized ECC syndromes which require more space in OOB/Spare. This puts constrains like;
(a) BCH16_ECC can correct 16 bit-flips per 512Bytes of data.
(b) BCH16_ECC generates 26-bytes of ECC syndrome / 512B.
Due to (b) this scheme can only be used with NAND devices which have enough OOB to satisfy following equation:
OOBsize per page >= 26 * (page-size / 512)
--- drivers/mtd/nand/omap_gpmc.c | 78 ++++++++++++++++++++++++++++++++++++++++++- include/linux/mtd/omap_gpmc.h | 8 +++++ 2 files changed, 85 insertions(+), 1 deletion(-)
drivers/mtd/nand/omap_gpmc.c +77 -1
@@ -224,6 +224,19 @@ static void omap_enable_hwecc(struct mtd_info *mtd, int32_t mode) eccsize1 =2 ;/* non-ECC bits in nibbles per sector */ }break ; +case OMAP_ECC_BCH16_CODE_HW : + ecc_algo =0x1 ; + bch_type =0x2 ; +if (mode ==NAND_ECC_WRITE ) { + bch_wrapmode =0x01 ; + eccsize0 =0 ;/* extra bits in nibbles per sector */ + eccsize1 =52 ;/* OOB bits in nibbles per sector */ + }else { + bch_wrapmode =0x01 ; + eccsize0 =52 ;/* ECC bits in nibbles per sector */ + eccsize1 =0 ;/* non-ECC bits in nibbles per sector */ + } +break ;default :return ; }
@@ -290,6 +303,29 @@ static int omap_calculate_ecc(struct mtd_info *mtd, const uint8_t *dat, ptr--; }break ; +case OMAP_ECC_BCH16_CODE_HW : + val =readl (&gpmc_cfg->bch_result_4_6[0 ].bch_result_x[2 ]); + ecc_code[i++] = (val >>8 ) &0xFF ; + ecc_code[i++] = (val >>0 ) &0xFF ; + val =readl (&gpmc_cfg->bch_result_4_6[0 ].bch_result_x[1 ]); + ecc_code[i++] = (val >>24 ) &0xFF ; + ecc_code[i++] = (val >>16 ) &0xFF ; + ecc_code[i++] = (val >>8 ) &0xFF ; + ecc_code[i++] = (val >>0 ) &0xFF ; + val =readl (&gpmc_cfg->bch_result_4_6[0 ].bch_result_x[0 ]); + ecc_code[i++] = (val >>24 ) &0xFF ; + ecc_code[i++] = (val >>16 ) &0xFF ; + ecc_code[i++] = (val >>8 ) &0xFF ; + ecc_code[i++] = (val >>0 ) &0xFF ; +for (j =3 ; j >=0 ; j--) { + val =readl (&gpmc_cfg->bch_result_0_3[0 ].bch_result_x[j] + ); + ecc_code[i++] = (val >>24 ) &0xFF ; + ecc_code[i++] = (val >>16 ) &0xFF ; + ecc_code[i++] = (val >>8 ) &0xFF ; + ecc_code[i++] = (val >>0 ) &0xFF ; + } +break ;default :return -EINVAL ; }
@@ -308,6 +344,8 @@ static int omap_calculate_ecc(struct mtd_info *mtd, const uint8_t *dat,case OMAP_ECC_BCH8_CODE_HW : ecc_code[chip->ecc.bytes -1 ] =0x00 ;break ; +case OMAP_ECC_BCH16_CODE_HW : +break ;default :return -EINVAL ; }
@@ -333,7 +371,7 @@ static int omap_correct_data_bch(struct mtd_info *mtd, uint8_t *dat,struct omap_nand_info *info = chip->priv;struct nand_ecc_ctrl *ecc = &chip->ecc;uint32_t error_count =0 , error_max; -uint32_t error_loc[8 ]; +uint32_t error_loc[ELM_MAX_ERROR_COUNT ];enum bch_level bch_type;uint32_t i, ecc_flag =0 ;uint8_t count, err =0 ;
@@ -365,6 +403,9 @@ static int omap_correct_data_bch(struct mtd_info *mtd, uint8_t *dat, bch_type =BCH_8_BIT ;omap_reverse_list (calc_ecc, ecc->bytes -1 );break ; +case OMAP_ECC_BCH16_CODE_HW : +omap_reverse_list (calc_ecc, ecc->bytes); +break ;default :return -EINVAL ; }
@@ -381,6 +422,9 @@ static int omap_correct_data_bch(struct mtd_info *mtd, uint8_t *dat,/* 14th byte in ECC is reserved to match ROM layout */ error_max =SECTOR_BYTES + (ecc->bytes -1 );break ; +case OMAP_ECC_BCH16_CODE_HW : + error_max =SECTOR_BYTES + ecc->bytes; +break ;default :return -EINVAL ; }
@@ -666,6 +710,38 @@ static int omap_select_ecc_scheme(struct nand_chip *nand,return -EINVAL ;#endif +case OMAP_ECC_BCH16_CODE_HW : +#ifdef CONFIG_NAND_OMAP_ELM +debug ("nand: using OMAP_ECC_BCH16_CODE_HW\n" ); +/* check ecc-scheme requirements before updating ecc info */ +if ((26 * eccsteps) +BADBLOCK_MARKER_LENGTH > oobsize) { +printf ("nand: error: insufficient OOB: require=%d\n" , ( + (26 * eccsteps) +BADBLOCK_MARKER_LENGTH )); +return -EINVAL ; + } +/* intialize ELM for ECC error detection */ +elm_init (); +/* populate ecc specific fields */ + nand->ecc.mode =NAND_ECC_HW ; + nand->ecc.size =SECTOR_BYTES ; + nand->ecc.bytes =26 ; + nand->ecc.strength =16 ; + nand->ecc.hwctl = omap_enable_hwecc; + nand->ecc.correct = omap_correct_data_bch; + nand->ecc.calculate = omap_calculate_ecc; + nand->ecc.read_page = omap_read_page_bch; +/* define ecc-layout */ + ecclayout->eccbytes = nand->ecc.bytes * eccsteps; +for (i =0 ; i < ecclayout->eccbytes; i++) + ecclayout->eccpos[i] = i +BADBLOCK_MARKER_LENGTH ; + ecclayout->oobfree[0 ].offset = i +BADBLOCK_MARKER_LENGTH ; + ecclayout->oobfree[0 ].length = oobsize - nand->ecc.bytes - +BADBLOCK_MARKER_LENGTH ; +break ; +#else +printf ("nand: error: CONFIG_NAND_OMAP_ELM required for ECC\n" ); +return -EINVAL ; +#endif default :debug ("nand: error: ecc scheme not enabled or supported\n" );return -EINVAL ;
include/linux/mtd/omap_gpmc.h +8 -0
@@ -27,6 +27,8 @@ enum omap_ecc {OMAP_ECC_BCH8_CODE_HW_DETECTION_SW ,/* 8-bit ECC calculation by GPMC, Error detection by ELM */ OMAP_ECC_BCH8_CODE_HW , +/* 16-bit ECC calculation by GPMC, Error detection by ELM */ + OMAP_ECC_BCH16_CODE_HW, }; struct gpmc_cs {
@@ -47,6 +49,10 @@ struct bch_res_0_3 {u32 bch_result_x[4 ]; }; +struct bch_res_4_6 { +u32 bch_result_x[3 ]; +}; +struct gpmc {u8 res1[0x10 ];u32 sysconfig;/* 0x10 */
@@ -77,6 +83,8 @@ struct gpmc {u32 testmomde_ctrl;/* 0x230 */ u8 res8[12 ];/* 0x234 */ struct bch_res_0_3 bch_result_0_3[GPMC_MAX_SECTORS ];/* 0x240,0x250, */ +u8 res9[16 *4 ];/* 0x2C0 - 0x2FF */ +struct bch_res_4_6 bch_result_4_6[GPMC_MAX_SECTORS ];/* 0x300,0x310, */ };/* Used for board specific gpmc initialization */
Signature · 1 line
1.8.5.1.163.gd7aced9
PATCH v3 2/2 am335x: update README for BCH16
In reply to Pekon Guptaupdates documentation with explanation on how to select ECC schemes.
--- doc/README.nand | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+)
doc/README.nand +42 -0
@@ -240,6 +240,48 @@ Platform specific options 8-bit BCH code with - ecc calculation using GPMC hardware engine, - error detection using ELM hardware engine. + OMAP_ECC_BCH16_CODE_HW + 16-bit BCH code with + - ecc calculation using GPMC hardware engine, + - error detection using ELM hardware engine. + + How to select ECC scheme on OMAP and AMxx platforms ? + ----------------------------------------------------- + Though higher ECC schemes have more capability to detect and correct + bit-flips, but still selection of ECC scheme is dependent on following + - hardware engines present in SoC. + Some legacy OMAP SoC do not have ELM h/w engine thus such + SoC cannot support BCHx_HW ECC schemes. + - size of OOB/Spare region + With higher ECC schemes, more OOB/Spare area is required to + store ECC. So choice of ECC scheme is limited by NAND oobsize. + + In general following expression can help: + NAND_OOBSIZE >= 2 + (NAND_PAGESIZE / 512) * ECC_BYTES + where + NAND_OOBSIZE = number of bytes available in + OOB/spare area per NAND page. + NAND_PAGESIZE = bytes in main-area of NAND page. + ECC_BYTES = number of ECC bytes generated to + protect 512 bytes of data, which is: + 3 for HAM1_xx ecc schemes + 7 for BCH4_xx ecc schemes + 14 for BCH8_xx ecc schemes + 26 for BCH16_xx ecc schemes + + example to check for BCH16 on 2K page NAND + NAND_PAGESIZE = 2048 + NAND_OOBSIZE = 64 + 2 + (2048 / 512) * 26 = 106 > NAND_OOBSIZE + Thus BCH16 cannot be supported on 2K page NAND. + + However, for 4K pagesize NAND + NAND_PAGESIZE = 4096 + NAND_OOBSIZE = 64 + ECC_BYTES = 26 + 2 + (4096 / 512) * 26 = 210 < NAND_OOBSIZE + Thus BCH16 can be supported on 4K page NAND. + NOTE: =====
Signature · 1 line
1.8.5.1.163.gd7aced9