Doug / smarc-fsl-linux-kernel

Download as
Browse Code ยป

Commit 021796b892dcad45743f3196e3eef7222870dd55

Authored by Mike Dunn
Committed by David Woodhouse
1 parent 6023813a2d
Exists in smarc-l5.0.0_1.0.0-ga and in 5 other branches imx_3.10.17_1.0.1_ga, imx_3.10.53_1.1.0_ga, imx_3.14.28_1.0.0_ga, smarc-imx_3.10.53_1.1.0_ga, smarc-imx_3.14.28_1.0.0_ga

mtd: ABI documentation: clarification of bitflip_threshold 

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>

Showing 1 changed file with 9 additions and 8 deletions Side-by-side Diff

Documentation/ABI/testing/sysfs-class-mtd
Diff comments   View file @ 021796b
... ... @@ -142,13 +142,14 @@
142 142 Contact: linux-mtd@lists.infradead.org
143 143 Description:
144 144 This allows the user to examine and adjust the criteria by which
145   - mtd returns -EUCLEAN from mtd_read(). If the maximum number of
146   - bit errors that were corrected on any single region comprising
147   - an ecc step (as reported by the driver) equals or exceeds this
148   - value, -EUCLEAN is returned. Otherwise, absent an error, 0 is
149   - returned. Higher layers (e.g., UBI) use this return code as an
150   - indication that an erase block may be degrading and should be
151   - scrutinized as a candidate for being marked as bad.
  145 + mtd returns -EUCLEAN from mtd_read() and mtd_read_oob(). If the
  146 + maximum number of bit errors that were corrected on any single
  147 + region comprising an ecc step (as reported by the driver) equals
  148 + or exceeds this value, -EUCLEAN is returned. Otherwise, absent
  149 + an error, 0 is returned. Higher layers (e.g., UBI) use this
  150 + return code as an indication that an erase block may be
  151 + degrading and should be scrutinized as a candidate for being
  152 + marked as bad.
152 153  
153 154 The initial value may be specified by the flash device driver.
154 155 If not, then the default value is ecc_strength.
... ... @@ -167,7 +168,7 @@
167 168 block degradation, but high enough to avoid the consequences of
168 169 a persistent return value of -EUCLEAN on devices where sticky
169 170 bitflips occur. Note that if bitflip_threshold exceeds
170   - ecc_strength, -EUCLEAN is never returned by mtd_read().
  171 + ecc_strength, -EUCLEAN is never returned by the read operations.
171 172 Conversely, if bitflip_threshold is zero, -EUCLEAN is always
172 173 returned, absent a hard error.
173 174