[MTD] Document erase interface.

[Linux-MTD Mailing List]

Gitweb:     http://git.infradead.org/?p=mtd-2.6.git;a=commit;h=b38178ee712e8608f20c8e741adf97f75f1aea39
Commit:     b38178ee712e8608f20c8e741adf97f75f1aea39
Parent:     5041f1f1b753031731bc404c906817323a9c280b
Author:     Jörn Engel <joern at logfs.org>
AuthorDate: Fri Sep 21 15:41:44 2007 +0200
Committer:  David Woodhouse <dwmw2 at infradead.org>
CommitDate: Fri Sep 21 14:48:33 2007 +0100

    [MTD] Document erase interface.
    
    Document mtd erase interface.
    
    Signed-off-by: Jörn Engel <joern at logfs.org>
    Signed-off-by: David Woodhouse <dwmw2 at infradead.org>
---
 include/linux/mtd/mtd.h |    7 +++++++
 1 files changed, 7 insertions(+), 0 deletions(-)

diff --git a/include/linux/mtd/mtd.h b/include/linux/mtd/mtd.h
index fd64ccf..783fc98 100644
--- a/include/linux/mtd/mtd.h
+++ b/include/linux/mtd/mtd.h
@@ -133,6 +133,13 @@ struct mtd_info {
 	int numeraseregions;
 	struct mtd_erase_region_info *eraseregions;
 
+	/*
+	 * Erase is an asynchronous operation.  Device drivers are supposed
+	 * to call instr->callback() whenever the operation completes, even
+	 * if it completes with a failure.
+	 * Callers are supposed to pass a callback function and wait for it
+	 * to be called before writing to the block.
+	 */
 	int (*erase) (struct mtd_info *mtd, struct erase_info *instr);
 
 	/* This stuff for eXecute-In-Place */