Patchwork [v4,6/6] mtd: update the ABI document about the ecc step size

login
register
mail settings
Submitter Huang Shijie
Date Aug. 16, 2013, 2:10 a.m.
Message ID <1376619009-8622-7-git-send-email-b32955@freescale.com>
Download mbox | patch
Permalink /patch/267538/
State New
Headers show

Comments

Huang Shijie - Aug. 16, 2013, 2:10 a.m.
We add a new sys node for ecc step size. So update the ABI document about it.

Signed-off-by: Huang Shijie <b32955@freescale.com>
---
 Documentation/ABI/testing/sysfs-class-mtd |   10 ++++++++++
 1 files changed, 10 insertions(+), 0 deletions(-)
Artem Bityutskiy - Aug. 16, 2013, 1:45 p.m.
On Fri, 2013-08-16 at 10:10 +0800, Huang Shijie wrote:
> +
> +What:          /sys/class/mtd/mtdX/ecc_step_size
> +Date:          May 2013
> +KernelVersion: 3.10
> +Contact:       linux-mtd@lists.infradead.org
> +Description:
> +               The size of each ECC step which is used for ECC.
> +               Note that some devices will have multiple ecc steps within each
> +               writesize region.

Actually this phrase is a bit confusing because it may be interpreted as
that one write-size may have ECC steps of multiple sizes. Would you
re-phrase, may be?

Otherwise the patch-set looks good, thanks, but I am not merging the
patches to let Brian review.

Signed-off-by: Artem Bityutskiy <artem.bityutskiy@linux.intel.com>
Huang Shijie - Aug. 17, 2013, 3:26 a.m.
On Fri, Aug 16, 2013 at 04:45:59PM +0300, Artem Bityutskiy wrote:
> On Fri, 2013-08-16 at 10:10 +0800, Huang Shijie wrote:
> > +
> > +What:          /sys/class/mtd/mtdX/ecc_step_size
> > +Date:          May 2013
> > +KernelVersion: 3.10
> > +Contact:       linux-mtd@lists.infradead.org
> > +Description:
> > +               The size of each ECC step which is used for ECC.
> > +               Note that some devices will have multiple ecc steps within each
> > +               writesize region.
> 
> Actually this phrase is a bit confusing because it may be interpreted as
> that one write-size may have ECC steps of multiple sizes. Would you
> re-phrase, may be?
What's about the following:
 -----------------------------------------------------------------
   The size of each ECC step which is used for ECC.
   Note that some devices will have multiple ecc steps within each
   writesize region, and the ecc steps share the same size.
 -----------------------------------------------------------------

thanks
Huang Shijie

Patch

diff --git a/Documentation/ABI/testing/sysfs-class-mtd b/Documentation/ABI/testing/sysfs-class-mtd
index 3105644..da112ab 100644
--- a/Documentation/ABI/testing/sysfs-class-mtd
+++ b/Documentation/ABI/testing/sysfs-class-mtd
@@ -173,3 +173,13 @@  Description:
 		This is generally applicable only to NAND flash devices with ECC
 		capability.  It is ignored on devices lacking ECC capability;
 		i.e., devices for which ecc_strength is zero.
+
+What:		/sys/class/mtd/mtdX/ecc_step_size
+Date:		May 2013
+KernelVersion:	3.10
+Contact:	linux-mtd@lists.infradead.org
+Description:
+		The size of each ECC step which is used for ECC.
+		Note that some devices will have multiple ecc steps within each
+		writesize region. See more in the ecc_strength above. This will
+		always be a non-negative integer.