mtd: nand: provide detailed description for raw read/write page methods
authorBoris BREZILLON <boris.brezillon@free-electrons.com>
Mon, 20 Oct 2014 08:46:14 +0000 (10:46 +0200)
committerBrian Norris <computersforpeace@gmail.com>
Thu, 20 Nov 2014 08:02:46 +0000 (00:02 -0800)
commit62d956dc3e11138c5ffd4b2c62e4f909c5180a12
treed122faefaed35017d623325e4ffc52321ef2705c
parentafc0ea1b8e1e27b2cb77e7023d917f3aa5971d17
mtd: nand: provide detailed description for raw read/write page methods

read_page_raw and write_page_raw method description is not clear enough.
It clearly specifies that ECC correction should not be involved but does
not talk about specific layout (by layout I mean where in-band and
out-of-band data are stored on the NAND media) used by NAND/ECC
controllers.

Those specific layouts might impact MTD users and thus should be hidden (as
already done in the standard NAND_ECC_HW_SYNDROME implementation).

Clearly state this constraint in the nand_ecc_ctrl struct documentation.

Signed-off-by: Boris Brezillon <boris.brezillon@free-electrons.com>
Signed-off-by: Brian Norris <computersforpeace@gmail.com>
include/linux/mtd/nand.h