[MTD] Clarify OOB-operation interface comments
authorArtem Bityutskiy <Artem.Bityutskiy@nokia.com>
Wed, 31 Jan 2007 09:43:13 +0000 (11:43 +0200)
committerDavid Woodhouse <dwmw2@infradead.org>
Fri, 9 Feb 2007 15:27:50 +0000 (15:27 +0000)
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>
include/linux/mtd/mtd.h

index 8a2e8bfc1e5663106ddab53b64573b7daec0e3ad..6a8570be331bbdb3deb587983953485427901ef5 100644 (file)
@@ -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;