[From nobody Mon Jun 11 07:09:40 2007 From: Artem Bityutskiy <Artem.Bityutskiy@nokia.com> Date: Wed, 31 Jan 2007 11:43:13 +0200 Subject: [PATCH] [MTD] clarify interface Message-Id: <1170236977.3635.4.camel@sauron> Mime-Version: 1.0 Content-Transfer-Encoding: 7bit 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> --- 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; -- 1.4.4.2 ]