Commit 0697f844 authored by Paul Cercueil's avatar Paul Cercueil Committed by Miquel Raynal
Browse files

mtd: rawnand: davinci: Rewrite function description 



The original comment that describes the function
nand_davinci_read_page_hwecc_oob_first() is very obscure and it is hard
to understand what it is for.

Cc: <stable@vger.kernel.org> # v5.2
Fixes: a0ac778e ("mtd: rawnand: ingenic: Add support for the JZ4740")
Signed-off-by: default avatarPaul Cercueil <paul@crapouillou.net>
Signed-off-by: default avatarMiquel Raynal <miquel.raynal@bootlin.com>
Link: https://lore.kernel.org/linux-mtd/20211016132228.40254-3-paul@crapouillou.net
parent 9c9d7099

drivers/mtd/nand/raw/davinci_nand.c

+4 −6
Original line number Diff line number Diff line
@@ -372,17 +372,15 @@ static int nand_davinci_correct_4bit(struct nand_chip *chip, u_char *data, 
}



/**

 * nand_read_page_hwecc_oob_first - hw ecc, read oob first

 * nand_davinci_read_page_hwecc_oob_first - Hardware ECC page read with ECC

 *                                          data read from OOB area

 * @chip: nand chip info structure

 * @buf: buffer to store read data

 * @oob_required: caller requires OOB data read to chip->oob_poi

 * @page: page number to read

 *

 * Hardware ECC for large page chips, require OOB to be read first. For this

 * ECC mode, the write_page method is re-used from ECC_HW. These methods

 * read/write ECC from the OOB area, unlike the ECC_HW_SYNDROME support with

 * multiple ECC steps, follows the "infix ECC" scheme and reads/writes ECC from

 * the data area, by overwriting the NAND manufacturer bad block markings.

 * Hardware ECC for large page chips, which requires the ECC data to be

 * extracted from the OOB before the actual data is read.

 */

static int nand_davinci_read_page_hwecc_oob_first(struct nand_chip *chip,

						  uint8_t *buf,