Skip to contentSkip to conversation

clarify interface

PATCH New Artem Bityutskiy 1 participant 1 message Jan 31, 2007 Memory technology devices (MTD)

lore
Share & tools
lore

Artem Bityutskiy

author
#0 lore raw

PATCH 1/1 clarify interface

Signature · 3 lines
-- 
Best regards,
Artem Bityutskiy (Битюцкий Артём)

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 <[email protected]>
---
 include/linux/mtd/mtd.h |    4 ++++
 1 files changed, 4 insertions(+), 0 deletions(-)
include/linux/mtd/mtd.h +4 -0
index 8a2e8bf..6a8570b 100644
@@ -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;
Signature · 1 line
1.4.4.2