From patchwork Tue May 22 18:51:09 2012 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Dunn X-Patchwork-Id: 160718 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from merlin.infradead.org (merlin.infradead.org [IPv6:2001:4978:20e::2]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (Client did not present a certificate) by ozlabs.org (Postfix) with ESMTPS id D36DBB6FA3 for ; Wed, 23 May 2012 04:52:35 +1000 (EST) Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.76 #1 (Red Hat Linux)) id 1SWuAr-0000j9-No; Tue, 22 May 2012 18:51:13 +0000 Received: from smtp.newsguy.com ([74.209.136.69]) by merlin.infradead.org with esmtps (Exim 4.76 #1 (Red Hat Linux)) id 1SWuAp-0000iv-5Q for linux-mtd@lists.infradead.org; Tue, 22 May 2012 18:51:11 +0000 Received: from localhost.localdomain (41.sub-166-250-2.myvzw.com [166.250.2.41]) by smtp.newsguy.com (8.14.3/8.14.3) with ESMTP id q4MIp8nl041316 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO); Tue, 22 May 2012 11:51:09 -0700 (PDT) (envelope-from mikedunn@newsguy.com) From: Mike Dunn To: linux-mtd@lists.infradead.org Subject: [PATCH] mtd-www: clarification to -EUCLEAN explanation Date: Tue, 22 May 2012 11:51:09 -0700 Message-Id: <1337712669-11801-1-git-send-email-mikedunn@newsguy.com> X-Mailer: git-send-email 1.7.3.4 X-Spam-Note: CRM114 invocation failed X-Spam-Score: -0.5 (/) X-Spam-Report: SpamAssassin version 3.3.2 on merlin.infradead.org summary: Content analysis details: (-0.5 points) pts rule name description ---- ---------------------- -------------------------------------------------- 1.4 RCVD_IN_BRBL_LASTEXT RBL: RCVD_IN_BRBL_LASTEXT [74.209.136.69 listed in bb.barracudacentral.org] -0.0 T_RP_MATCHES_RCVD Envelope sender domain matches handover relay domain -0.0 SPF_PASS SPF: sender matches SPF record -1.9 BAYES_00 BODY: Bayes spam probability is 0 to 1% [score: 0.0000] Cc: Mike Dunn X-BeenThere: linux-mtd@lists.infradead.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: Linux MTD discussion mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Sender: linux-mtd-bounces@lists.infradead.org Errors-To: linux-mtd-bounces+incoming=patchwork.ozlabs.org@lists.infradead.org The -EUCLEAN return value applies to mtd_read_oob() as well as mtd_read(), but only mtd_read() was mentioned in the explanation of -EUCLEAN. Signed-off-by: Mike Dunn --- Again, trivial change that looks bigger because of reformatting. doc/general.xml | 27 ++++++++++++++------------- 1 files changed, 14 insertions(+), 13 deletions(-) diff --git a/doc/general.xml b/doc/general.xml index ba76c4f..31ea243 100644 --- a/doc/general.xml +++ b/doc/general.xml @@ -89,19 +89,20 @@ use those prototyped in mtd.h outside of struct mtd_info. These methods include mtd_read(), mtd_write(), etc.

-Absent an error, the API methods will return zero, with one notable exception. -mtd_read() may return -EUCLEAN in some circumstances. -This return code is applicable mainly to NAND flash devices, and is used to -indicate that some bit errors were corrected by the device's ECC facility. -Prior to kernel version 3.4, -EUCLEAN was returned if one or more -bit errors were corrected during the read operation. As of kernel 3.4, the -meaning is more nuanced, and can be broadly interpreted to mean "a dangerously -high number of bit errors were corrected". The -EUCLEAN return -code is intended to help higher layers detect degradation of erase blocks. The -conditions by which mtd_read() returns -EUCLEAN can be -tuned using the bitflip_threshold element of the sysfs interface. -Please see the kernel documentation for the MTD sysfs interface (referenced -above) before adjusting this value. +Absent an error, the API methods will return zero, with two notable exceptions. +mtd_read() and mtd_read_oob() may return +-EUCLEAN in some circumstances. This return code is applicable +mainly to NAND flash devices, and is used to indicate that some bit errors were +corrected by the device's ECC facility. Prior to kernel version 3.4, +-EUCLEAN was returned if one or more bit errors were corrected +during the read operation. As of kernel 3.4, the meaning is more nuanced, and +can be broadly interpreted to mean "a dangerously high number of bit errors were +corrected". The -EUCLEAN return code is intended to help higher +layers detect degradation of erase blocks. The conditions by which +mtd_read() and mtd_read_oob() return +-EUCLEAN can be tuned using the bitflip_threshold +element of the sysfs interface. Please see the kernel documentation for the MTD +sysfs interface (referenced above) before adjusting this value.

MTD tests