[MTD] Document erase interface.

[linux-2.6-omap-h63xx.git] / include / linux / mtd / mtd.h

diff --git a/include/linux/mtd/mtd.h b/include/linux/mtd/mtd.h
index 12a9a18f6e16cac116198bb141e357b0c5354c6f..783fc983417c9786c8d99eecca5dd19a36e4895d 100644 (file)
--- a/include/linux/mtd/mtd.h
+++ b/include/linux/mtd/mtd.h
@@ -133,9 +133,13 @@ struct mtd_info {
        int numeraseregions;
        struct mtd_erase_region_info *eraseregions;
 
-       /* This really shouldn't be here. It can go away in 2.5 */
-       u_int32_t bank_size;
-
+       /*
+        * 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 */