diff options
author | Artem Bityutskiy <Artem.Bityutskiy@nokia.com> | 2007-01-31 09:43:13 (GMT) |
---|---|---|
committer | David Woodhouse <dwmw2@infradead.org> | 2007-02-09 15:27:50 (GMT) |
commit | 73a4421c5a0aa77b996891e7616b396c360b3ed8 (patch) | |
tree | 9cf798dffc2e896b7d6a2a6be21314c77f387b7c | |
parent | 64f60710568db5cec1a76c1d1e261b239f9ef809 (diff) | |
download | linux-73a4421c5a0aa77b996891e7616b396c360b3ed8.tar.xz |
[MTD] Clarify OOB-operation interface comments
Add more comment to OOB I/O interface. Read/write are not
symmetric which is confusing and should be documented.
Signed-off-by: Artem Bityutskiy <Artem.Bityutskiy@nokia.com>
Signed-off-by: David Woodhouse <dwmw2@infradead.org>
-rw-r--r-- | include/linux/mtd/mtd.h | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/include/linux/mtd/mtd.h b/include/linux/mtd/mtd.h index 8a2e8bf..6a8570b 100644 --- a/include/linux/mtd/mtd.h +++ b/include/linux/mtd/mtd.h @@ -85,6 +85,10 @@ typedef enum { * mode = MTD_OOB_PLACE) * @datbuf: data buffer - if NULL only oob data are read/written * @oobbuf: oob data buffer + * + * Note, it is allowed to read more then one OOB area at one go, but not write. + * The interface assumes that the OOB write requests program only one page's + * OOB area. */ struct mtd_oob_ops { mtd_oob_mode_t mode; |