Commit 8c5c2092 authored by Miquel Raynal's avatar Miquel Raynal
Browse files

mtd: nand: ecc-bch: Cleanup and style fixes 



Fix function headers, capitals and reword a little bit the comments
to make this driver more readable.

There is not functional change.

Signed-off-by: default avatarMiquel Raynal <miquel.raynal@bootlin.com>
Link: https://lore.kernel.org/linux-mtd/20200929230124.31491-4-miquel.raynal@bootlin.com
parent cdbe8df5

drivers/mtd/nand/ecc-sw-bch.c

+29 −26
Original line number Diff line number Diff line
@@ -29,10 +29,10 @@ struct nand_bch_control { 
};



/**

 * nand_bch_calculate_ecc - [NAND Interface] Calculate ECC for data block

 * nand_bch_calcuate_ecc - Calculate the ECC corresponding to a data block

 * @chip: NAND chip object

 * @buf:	input buffer with raw data

 * @code:	output buffer with ECC

 * @buf: Input buffer with raw data

 * @code: Output buffer with ECC

 */

int nand_bch_calculate_ecc(struct nand_chip *chip, const unsigned char *buf,

			   unsigned char *code)
@@ -52,13 +52,13 @@ int nand_bch_calculate_ecc(struct nand_chip *chip, const unsigned char *buf, 
EXPORT_SYMBOL(nand_bch_calculate_ecc);



/**

 * nand_bch_correct_data - [NAND Interface] Detect and correct bit error(s)

 * nand_bch_correct_data - Detect, correct and report bit error(s)

 * @chip: NAND chip object

 * @buf:	raw data read from the chip

 * @read_ecc:	ECC from the chip

 * @calc_ecc:	the ECC calculated from raw data

 * @buf: Raw data read from the chip

 * @read_ecc: ECC bytes from the chip

 * @calc_ecc: ECC calculated from the raw data

 *

 * Detect and correct bit errors for a data byte block

 * Detect and correct bit errors for a data block.

 */

int nand_bch_correct_data(struct nand_chip *chip, unsigned char *buf,

			  unsigned char *read_ecc, unsigned char *calc_ecc)
@@ -72,32 +72,34 @@ int nand_bch_correct_data(struct nand_chip *chip, unsigned char *buf, 
	if (count > 0) {

		for (i = 0; i < count; i++) {

			if (errloc[i] < (chip->ecc.size * 8))

				/* error is located in data, correct it */

				/* The error is in the data area: correct it */

				buf[errloc[i] >> 3] ^= (1 << (errloc[i] & 7));

			/* else error in ecc, no action needed */



			/* Otherwise the error is in the ECC area: nothing to do */

			pr_debug("%s: corrected bitflip %u\n", __func__,

				 errloc[i]);

		}

	} else if (count < 0) {

		pr_err("ecc unrecoverable error\n");

		pr_err("ECC unrecoverable error\n");

		count = -EBADMSG;

	}



	return count;

}

EXPORT_SYMBOL(nand_bch_correct_data);



/**

 * nand_bch_init - [NAND Interface] Initialize NAND BCH error correction

 * @mtd:	MTD block structure

 * nand_bch_init - Initialize software BCH ECC engine

 * @mtd: MTD device

 *

 * Returns:

 *  a pointer to a new NAND BCH control structure, or NULL upon failure

 * Returns: a pointer to a new NAND BCH control structure, or NULL upon failure

 *

 * Initialize NAND BCH error correction. Parameters @eccsize and @eccbytes

 * are used to compute BCH parameters m (Galois field order) and t (error

 * correction capability). @eccbytes should be equal to the number of bytes

 * required to store m*t bits, where m is such that 2^m-1 > @eccsize*8.

 * are used to compute the following BCH parameters:

 *     m, the Galois field order

 *     t, the error correction capability

 * @eccbytes should be equal to the number of bytes required to store m * t

 * bits, where m is such that 2^m - 1 > step_size * 8.

 *

 * Example: to configure 4 bit correction per 512 bytes, you should pass

 * @eccsize = 512 (thus, m = 13 is the smallest integer such that 2^m - 1 > 512 * 8)
@@ -175,6 +177,7 @@ struct nand_bch_control *nand_bch_init(struct mtd_info *mtd) 
	nbc->errloc = kmalloc_array(t, sizeof(*nbc->errloc), GFP_KERNEL);

	if (!nbc->eccmask || !nbc->errloc)

		goto fail;



	/*

	 * compute and store the inverted ecc of an erased ecc block

	 */
@@ -200,7 +203,7 @@ struct nand_bch_control *nand_bch_init(struct mtd_info *mtd) 
EXPORT_SYMBOL(nand_bch_init);



/**

 * nand_bch_free - [NAND Interface] Release NAND BCH ECC resources

 * nand_bch_free - Release NAND BCH ECC resources

 * @nbc: NAND BCH control structure

 */

void nand_bch_free(struct nand_bch_control *nbc)