lk/linux-kernel-test
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

mtd: ABI documentation: clarification of bitflip_threshold

Browse Source 
The -EUCLEAN return value applies to mtd_read_oob() as well as mtd_read(), but
only mtd_read() was mentioned in the blurd on bitflip_threshold in the ABI
documentation.

Signed-off-by: Mike Dunn <mikedunn@newsguy.com>
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@linux.intel.com>
Signed-off-by: David Woodhouse <David.Woodhouse@intel.com>
This commit is contained in:
Mike Dunn
2012-05-22 11:03:42 -07:00
committed by David Woodhouse
parent 6023813a2d
commit 021796b892
1 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
Documentation/ABI/testing/sysfs-class-mtd
View File

@@ -142,13 +142,14 @@ KernelVersion: 3.4
Contact: linux-mtd@lists.infradead.org Contact: linux-mtd@lists.infradead.org
Description: Description:
This allows the user to examine and adjust the criteria by which This allows the user to examine and adjust the criteria by which
mtd returns -EUCLEAN from mtd_read(). If the maximum number of mtd returns -EUCLEAN from mtd_read() and mtd_read_oob(). If the
bit errors that were corrected on any single region comprising maximum number of bit errors that were corrected on any single
an ecc step (as reported by the driver) equals or exceeds this region comprising an ecc step (as reported by the driver) equals
value, -EUCLEAN is returned. Otherwise, absent an error, 0 is or exceeds this value, -EUCLEAN is returned. Otherwise, absent
returned. Higher layers (e.g., UBI) use this return code as an an error, 0 is returned. Higher layers (e.g., UBI) use this
indication that an erase block may be degrading and should be return code as an indication that an erase block may be
scrutinized as a candidate for being marked as bad. degrading and should be scrutinized as a candidate for being
marked as bad.
The initial value may be specified by the flash device driver. The initial value may be specified by the flash device driver.
If not, then the default value is ecc_strength. If not, then the default value is ecc_strength.
@@ -167,7 +168,7 @@ Description:
block degradation, but high enough to avoid the consequences of block degradation, but high enough to avoid the consequences of
a persistent return value of -EUCLEAN on devices where sticky a persistent return value of -EUCLEAN on devices where sticky
bitflips occur. Note that if bitflip_threshold exceeds bitflips occur. Note that if bitflip_threshold exceeds
ecc_strength, -EUCLEAN is never returned by mtd_read(). ecc_strength, -EUCLEAN is never returned by the read operations.
Conversely, if bitflip_threshold is zero, -EUCLEAN is always Conversely, if bitflip_threshold is zero, -EUCLEAN is always
returned, absent a hard error. returned, absent a hard error.