Patchwork [v2,append] mtd: update the ABI document about the ecc step

login
register
mail settings
Submitter Huang Shijie
Date May 16, 2013, 4:09 a.m.
Message ID <1368677383-29224-1-git-send-email-b32955@freescale.com>
Download mbox | patch
Permalink /patch/244209/
State New
Headers show

Comments

Huang Shijie - May 16, 2013, 4:09 a.m.
We add a new sys node for ecc step. So update the ABI document about it.

Signed-off-by: Huang Shijie <b32955@freescale.com>
---
 Documentation/ABI/testing/sysfs-class-mtd |   11 +++++++++++
 1 files changed, 11 insertions(+), 0 deletions(-)
Brian Norris - Aug. 10, 2013, 8:20 a.m.
On Thu, May 16, 2013 at 12:09:43PM +0800, Huang Shijie wrote:
> We add a new sys node for ecc step. So update the ABI document about it.
> 
> Signed-off-by: Huang Shijie <b32955@freescale.com>
> ---
>  Documentation/ABI/testing/sysfs-class-mtd |   11 +++++++++++
>  1 files changed, 11 insertions(+), 0 deletions(-)
> 
> diff --git a/Documentation/ABI/testing/sysfs-class-mtd b/Documentation/ABI/testing/sysfs-class-mtd
> index 3105644..62a1cda 100644
> --- a/Documentation/ABI/testing/sysfs-class-mtd
> +++ b/Documentation/ABI/testing/sysfs-class-mtd
> @@ -173,3 +173,14 @@ 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
> +Date:		May 2013
> +KernelVersion:	3.10
> +Contact:	linux-mtd@lists.infradead.org
> +Description:
> +		The size of ecc step which is used for per ecc correction.

Despite the usage of lower-case 'ecc' in some places, I would prefer
consistent usage of upper-case 'ECC'. And "ECC correction" is redundant.

Also, "...which is used for per ecc correction" doesn't make sense to
me. Perhaps you just mean "...which is used for ECC"?

The following note under the current ecc_strength documentation makes
more sense here, actually:

  "Note that some devices will have multiple ecc steps within each
   writesize region."

Maybe just copy-and-paste it here too?

> +		See more in the ecc_strength above. This will always be a
> +		non-negative integer.
> +
> +		In the case of devices lacking any ECC capability, it is 0.

These wording comments aren't highly important. If I have any more
changes, I can just edit before applying when you send v3.

Thanks,
Brian

Patch

diff --git a/Documentation/ABI/testing/sysfs-class-mtd b/Documentation/ABI/testing/sysfs-class-mtd
index 3105644..62a1cda 100644
--- a/Documentation/ABI/testing/sysfs-class-mtd
+++ b/Documentation/ABI/testing/sysfs-class-mtd
@@ -173,3 +173,14 @@  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
+Date:		May 2013
+KernelVersion:	3.10
+Contact:	linux-mtd@lists.infradead.org
+Description:
+		The size of ecc step which is used for per ecc correction.
+		See more in the ecc_strength above. This will always be a
+		non-negative integer.
+
+		In the case of devices lacking any ECC capability, it is 0.