mtd: map: fix .set_vpp() documentation

[Linux-MTD Mailing List]

Gitweb:     http://git.infradead.org/?p=mtd-2.6.git;a=commit;h=95a001f22b1c5717eafd500a43832249ddd93662
Commit:     95a001f22b1c5717eafd500a43832249ddd93662
Parent:     4110fdd295e1219f4e4c4e35e2eba7b605b74ed7
Author:     Linus Walleij <linus.walleij at linaro.org>
AuthorDate: Mon Feb 1 23:02:48 2016 +0100
Committer:  Brian Norris <computersforpeace at gmail.com>
CommitDate: Fri Feb 12 11:09:32 2016 -0800

    mtd: map: fix .set_vpp() documentation
    
    As of commit 876fe76d793d03077eb61ba3afab4a383f46c554
    "mtd: maps: physmap: Add reference counter to set_vpp()"
    the comment in the header file is incorrect and misleading.
    Fix it up.
    
    Cc: Russell King <linux at arm.linux.org.uk>
    Cc: Paul Parsons <lost.distance at yahoo.com>
    Fixes: 876fe76d793d ("mtd: maps: physmap: Add reference counter to set_vpp()")
    Signed-off-by: Linus Walleij <linus.walleij at linaro.org>
    Signed-off-by: Brian Norris <computersforpeace at gmail.com>
---
 include/linux/mtd/map.h | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/include/linux/mtd/map.h b/include/linux/mtd/map.h
index 58f3ba7..5e0eb7c 100644
--- a/include/linux/mtd/map.h
+++ b/include/linux/mtd/map.h
@@ -240,8 +240,11 @@ struct map_info {
 	   If there is no cache to care about this can be set to NULL. */
 	void (*inval_cache)(struct map_info *, unsigned long, ssize_t);
 
-	/* set_vpp() must handle being reentered -- enable, enable, disable
-	   must leave it enabled. */
+	/* This will be called with 1 as parameter when the first map user
+	 * needs VPP, and called with 0 when the last user exits. The map
+	 * core maintains a reference counter, and assumes that VPP is a
+	 * global resource applying to all mapped flash chips on the system.
+	 */
 	void (*set_vpp)(struct map_info *, int);
 
 	unsigned long pfow_base;