From: Jörn Engel <joern@logfs.org>
Date: Fri, 21 Sep 2007 13:41:44 +0000 (+0200)
Subject: [MTD] Document erase interface.
X-Git-Tag: v2.6.24-rc1~1364^2~22
X-Git-Url: https://openfabrics.org/gitweb/?a=commitdiff_plain;h=b38178ee712e8608f20c8e741adf97f75f1aea39;p=~shefty%2Frdma-dev.git

[MTD] Document erase interface.

Document mtd erase interface.

Signed-off-by: Jörn Engel <joern@logfs.org>
Signed-off-by: David Woodhouse <dwmw2@infradead.org>
---

diff --git a/include/linux/mtd/mtd.h b/include/linux/mtd/mtd.h
index fd64ccfbce0..783fc983417 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 */