diff mbox

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

Message ID 1347379143-3607-1-git-send-email-mikedunn@newsguy.com
State New, archived
Headers show

Commit Message

Mike Dunn Sept. 11, 2012, 3:59 p.m. UTC 
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@newsguy.com>
---
 include/linux/mtd/nand.h |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)

1.7.3.4

Comments

Artem Bityutskiy Sept. 24, 2012, 2:54 p.m. UTC | #1 
On Tue, 2012-09-11 at 08:59 -0700, Mike Dunn wrote:
> 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@newsguy.com>

Pushed to l2-mtd.git, thanks!
diff mbox

Patch

diff --git a/include/linux/mtd/nand.h b/include/linux/mtd/nand.h
index 8f99d36..8d18313 100644
--- a/include/linux/mtd/nand.h
+++ b/include/linux/mtd/nand.h
@@ -326,9 +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.
+ *		requirements.  Returns maximum number of bitflips corrected in
+ *		any single ecc step, 0 if bitflips uncorrectible, -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
--