mtd: nand: expand description of read_page method in comment header

[Linux-MTD Mailing List]

Gitweb:     http://git.infradead.org/?p=mtd-2.6.git;a=commit;h=5ca7f41528922c90da3ae3b917dc904047513be2
Commit:     5ca7f41528922c90da3ae3b917dc904047513be2
Parent:     ea73fe7f0d562154975a77fe77ae3da6ab4d3e77
Author:     Mike Dunn <mikedunn at newsguy.com>
AuthorDate: Tue Sep 11 08:59:03 2012 -0700
Committer:  David Woodhouse <David.Woodhouse at intel.com>
CommitDate: Sat Sep 29 15:53:15 2012 +0100

    mtd: nand: expand description of read_page method in comment header
    
    In the absence of any formal documentation of the nand interface, I thought this
    patch to the header file might be helpful.
    
    Signed-off-by: Mike Dunn <mikedunn at newsguy.com>
    Signed-off-by: Artem Bityutskiy <artem.bityutskiy at linux.intel.com>
    Signed-off-by: David Woodhouse <David.Woodhouse at intel.com>
---
 include/linux/mtd/nand.h |    6 ++++--
 1 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/include/linux/mtd/nand.h b/include/linux/mtd/nand.h
index 8f99d36..d245199 100644
--- a/include/linux/mtd/nand.h
+++ b/include/linux/mtd/nand.h
@@ -326,8 +326,10 @@ struct nand_hw_control {
  * @read_page_raw:	function to read a raw page without ECC
  * @write_page_raw:	function to write a raw page without ECC
  * @read_page:	function to read a page according to the ECC generator
- *		requirements.
- * @read_subpage:	function to read parts of the page covered by ECC.
+ *		requirements; returns maximum number of bitflips corrected in
+ *		any single ECC step, 0 if bitflips uncorrectable, -EIO hw error
+ * @read_subpage:	function to read parts of the page covered by ECC;
+ *			returns same as read_page()
  * @write_page:	function to write a page according to the ECC generator
  *		requirements.
  * @write_oob_raw:	function to write chip OOB data without ECC