From patchwork Thu Feb 21 10:01:49 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Miquel Raynal X-Patchwork-Id: 10823465 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id BAED56C2 for ; Thu, 21 Feb 2019 10:06:03 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id A8C193053F for ; Thu, 21 Feb 2019 10:06:03 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id A69FF3057D; Thu, 21 Feb 2019 10:06:03 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-5.2 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,MAILING_LIST_MULTI,RCVD_IN_DNSWL_MED autolearn=ham version=3.3.1 Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id E79463053F for ; Thu, 21 Feb 2019 10:06:02 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20170209; h=Sender: Content-Transfer-Encoding:Content-Type:Cc:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:MIME-Version:Message-Id:Date:Subject:To :From:Reply-To:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:In-Reply-To:References: List-Owner; bh=yzR0DDQsXtSq8NV1yGCy9nx7hOo4jJ/P6lEgezMwS2E=; b=tjaWKYfTdsXobo AlB1lJusabQoRpNiMWeoq8BsHe8vSwGr0R1PuwcyrLX/ZFGwE5LR7a6j4BQ2hJtzUW8X7o0l+CfPA Hv5Wolmi38ywzjkZI8S00i/g4Or7c+LvunIvjyrTUd0YGw+4+ZW+9RzQ1if4d5lnMF6OfkZumegGR ONzghWhn+GNttC10jguEv4mbVHtMwzagq5RbI8W7SoZ5npJNkdjoopQa+W3PosUDjLRsvlfL+uBbp RhpZQa3F0xMwyshXvoUQX5j0gepKqfdQDPTk8FR+ctIEpDnLE8l1gF2iv/Gl1dOEvw8bToFCZxaIV +cooeiDtxKwTZBrO3aHw==; Received: from localhost ([127.0.0.1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.90_1 #2 (Red Hat Linux)) id 1gwlEv-0004O0-2W; Thu, 21 Feb 2019 10:06:01 +0000 Received: from relay11.mail.gandi.net ([217.70.178.231]) by bombadil.infradead.org with esmtps (Exim 4.90_1 #2 (Red Hat Linux)) id 1gwlBa-0007Jf-Gj; Thu, 21 Feb 2019 10:02:38 +0000 Received: from localhost.localdomain (aaubervilliers-681-1-81-190.w90-88.abo.wanadoo.fr [90.88.23.190]) (Authenticated sender: miquel.raynal@bootlin.com) by relay11.mail.gandi.net (Postfix) with ESMTPSA id 221AB100017; Thu, 21 Feb 2019 10:02:19 +0000 (UTC) From: Miquel Raynal To: Boris Brezillon , Richard Weinberger , David Woodhouse , Brian Norris , Marek Vasut , Tudor Ambarus Subject: [RFC PATCH 00/27] Introduce the generic ECC engine abstraction Date: Thu, 21 Feb 2019 11:01:49 +0100 Message-Id: <20190221100216.25255-1-miquel.raynal@bootlin.com> X-Mailer: git-send-email 2.19.1 MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20190221_020234_860507_B8A5782F X-CRM114-Status: GOOD ( 16.83 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Vignesh R , Tudor Ambarus , Julien Su , Schrempf Frieder , linux-mtd@lists.infradead.org, Thomas Petazzoni , Miquel Raynal , Mason Yang , linux-arm-kernel@lists.infradead.org Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+patchwork-linux-arm=patchwork.kernel.org@lists.infradead.org X-Virus-Scanned: ClamAV using ClamSMTP As of today, only raw NAND controllers used to feature an integrated ECC engine and so controller drivers always embedded some code to enable/disable the correction. This statement is no longer correct as SPI-NAND devices might not embed an on-die ECC engine and must make use of an external ECC engine. We figured there are three possible situations for (generic) NAND device: either the engine is 'on-die' (most of the SPI-NANDs, a few raw NANDs), or the engine is part of the host controller (most raw NANDs), or the engine may be external (SPI controllers might feature an ECC engine, or there are still the possibility to use software correction). To solve this situation, this is a proposal on how to make things work. We want to create an ECC engine object which has simple callbacks: * init/cleanup its context * prepare an I/O operation * finish an I/O operation Details about what is going to happen in these callbacks is described in drivers/mtd/nand/ecc/engine.c. The logic in this series is: 1/ Use the generic NAND core for all NAND devices (raw and SPI). 2/ Create the ECC engine interface in drivers/mtd/nand/ecc/ 3/ Move code in driver/mtd/nand/ecc. 4/ Make both software engines (Hamming and BCH) generic, move them in the ecc/ directory, clean them a bit and instantiate ECC engines. Write raw NAND helpers to use these two new engines. 5/ Isolate SPI-NAND on-die ECC engine in its own driver. 6/ Make use from the SPI-NAND layer of all the ECC engines listed above (on user request, people can now make use of soft BCH if they don't have an ECC-engine). This work is still WIP, I expect a few 0-day regressions, maybe the naming is not perfect but it gives an idea of what I would like to introduce. The next steps are: 1/ Migrate the raw NAND core to make a proper use of these ECC engines. 2/ Deprecate in the raw NAND subsystem the interfaces used until now (I expect we should get rid of a lot of boilerplate). 3/ Introduce an external hardware ECC engine driver. Thanks, Miquèl Miquel Raynal (27): mtd: nand: Move nand_device forward declaration to the top mtd: nand: Compile in the NAND core by default mtd: nand: Introduce the ECC engine abstraction mtd: Fix typo in mtd_ooblayout_set_databytes() description mtd: nand: Move standard OOB layouts to the NAND core mtd: nand: Move ECC specific functions to ecc/engine.c mtd: nand: ecc: Move BCH code into the ecc/ directory mtd: nand: ecc: Use SPDX license identifier for the software BCH code mtd: nand: ecc: Turn the software BCH implementation generic mtd: rawnand: Get rid of chip->ecc.priv mtd: nand: ecc: Move Hamming code into the ecc/ directory mtd: nand: ecc: Use SPDX license identifier for the software Hamming code mtd: nand: ecc: Clarify the software Hamming introductory line mtd: nand: ecc: Turn the software Hamming implementation generic mtd: nand: Remove useless include about software Hamming ECC mtd: nand: ecc: Let the software BCH ECC engine be a module mtd: nand: ecc: Let the software Hamming ECC engine be unselected mtd: nand: ecc: Create the software BCH engine instance mtd: nand: ecc: Create the software Hamming engine instance mtd: nand: Let software ECC engines be retrieved from the NAND core mtd: spinand: Fix typo in comment mtd: spinand: Let the SPI-NAND core flag a SPI-NAND chip mtd: spinand: Move the ECC helper functions into a separate file mtd: spinand: Instantiate a SPI-NAND on-die ECC engine mtd: nand: Add helpers to manage ECC engines and configurations mtd: spinand: Use the external ECC engine logic mtd: spinand: Propagate ECC information to the MTD structure arch/arm/mach-s3c24xx/common-smdk.c | 1 - arch/arm/mach-s3c24xx/mach-anubis.c | 1 - arch/arm/mach-s3c24xx/mach-at2440evb.c | 1 - arch/arm/mach-s3c24xx/mach-bast.c | 1 - arch/arm/mach-s3c24xx/mach-gta02.c | 1 - arch/arm/mach-s3c24xx/mach-jive.c | 1 - arch/arm/mach-s3c24xx/mach-mini2440.c | 1 - arch/arm/mach-s3c24xx/mach-osiris.c | 1 - arch/arm/mach-s3c24xx/mach-qt2410.c | 1 - arch/arm/mach-s3c24xx/mach-rx3715.c | 1 - arch/arm/mach-s3c24xx/mach-vstms.c | 1 - drivers/mtd/mtdcore.c | 2 +- drivers/mtd/nand/Kconfig | 13 +- drivers/mtd/nand/Makefile | 1 + drivers/mtd/nand/core.c | 270 ++++++++- drivers/mtd/nand/ecc/Kconfig | 32 ++ drivers/mtd/nand/ecc/Makefile | 5 + drivers/mtd/nand/ecc/engine.c | 305 ++++++++++ drivers/mtd/nand/ecc/sw-bch-engine.c | 421 ++++++++++++++ .../nand_ecc.c => ecc/sw-hamming-engine.c} | 343 ++++++++--- drivers/mtd/nand/onenand/Kconfig | 1 - drivers/mtd/nand/raw/Kconfig | 24 +- drivers/mtd/nand/raw/Makefile | 2 - drivers/mtd/nand/raw/atmel/nand-controller.c | 12 +- drivers/mtd/nand/raw/cs553x_nand.c | 3 +- drivers/mtd/nand/raw/denali.c | 3 + drivers/mtd/nand/raw/denali_pci.c | 1 - drivers/mtd/nand/raw/fsl_elbc_nand.c | 1 - drivers/mtd/nand/raw/fsl_ifc_nand.c | 1 - drivers/mtd/nand/raw/fsl_upm.c | 1 - drivers/mtd/nand/raw/fsmc_nand.c | 3 +- drivers/mtd/nand/raw/gpmi-nand/gpmi-nand.c | 12 +- drivers/mtd/nand/raw/lpc32xx_mlc.c | 1 - drivers/mtd/nand/raw/lpc32xx_slc.c | 3 +- drivers/mtd/nand/raw/marvell_nand.c | 7 +- drivers/mtd/nand/raw/mtk_nand.c | 4 +- drivers/mtd/nand/raw/nand_base.c | 536 ++++++------------ drivers/mtd/nand/raw/nand_bch.c | 232 -------- drivers/mtd/nand/raw/nand_esmt.c | 11 +- drivers/mtd/nand/raw/nand_hynix.c | 41 +- drivers/mtd/nand/raw/nand_jedec.c | 4 +- drivers/mtd/nand/raw/nand_micron.c | 14 +- drivers/mtd/nand/raw/nand_onfi.c | 8 +- drivers/mtd/nand/raw/nand_samsung.c | 19 +- drivers/mtd/nand/raw/nand_toshiba.c | 13 +- drivers/mtd/nand/raw/nandsim.c | 3 +- drivers/mtd/nand/raw/ndfc.c | 3 +- drivers/mtd/nand/raw/omap2.c | 32 +- drivers/mtd/nand/raw/pasemi_nand.c | 1 - drivers/mtd/nand/raw/s3c2410.c | 1 - drivers/mtd/nand/raw/sharpsl.c | 3 +- drivers/mtd/nand/raw/sunxi_nand.c | 37 +- drivers/mtd/nand/raw/tegra_nand.c | 12 +- drivers/mtd/nand/raw/tmio_nand.c | 7 +- drivers/mtd/nand/raw/txx9ndfmc.c | 5 +- drivers/mtd/nand/spi/Kconfig | 1 - drivers/mtd/nand/spi/Makefile | 2 +- drivers/mtd/nand/spi/core.c | 174 ++---- drivers/mtd/nand/spi/macronix.c | 6 +- drivers/mtd/nand/spi/on-die-ecc-engine.c | 152 +++++ drivers/mtd/nand/spi/toshiba.c | 6 +- drivers/mtd/sm_ftl.c | 29 +- drivers/mtd/tests/mtd_nandecctest.c | 31 +- include/linux/mtd/mtd.h | 5 + include/linux/mtd/nand-spi-on-die-engine.h | 35 ++ include/linux/mtd/nand-sw-bch-engine.h | 80 +++ include/linux/mtd/nand-sw-hamming-engine.h | 101 ++++ include/linux/mtd/nand.h | 160 +++++- include/linux/mtd/nand_bch.h | 69 --- include/linux/mtd/nand_ecc.h | 42 -- include/linux/mtd/rawnand.h | 40 +- include/linux/mtd/sharpsl.h | 1 - include/linux/mtd/spinand.h | 5 +- include/uapi/mtd/mtd-abi.h | 1 + 74 files changed, 2242 insertions(+), 1162 deletions(-) create mode 100644 drivers/mtd/nand/ecc/Kconfig create mode 100644 drivers/mtd/nand/ecc/Makefile create mode 100644 drivers/mtd/nand/ecc/engine.c create mode 100644 drivers/mtd/nand/ecc/sw-bch-engine.c rename drivers/mtd/nand/{raw/nand_ecc.c => ecc/sw-hamming-engine.c} (61%) delete mode 100644 drivers/mtd/nand/raw/nand_bch.c create mode 100644 drivers/mtd/nand/spi/on-die-ecc-engine.c create mode 100644 include/linux/mtd/nand-spi-on-die-engine.h create mode 100644 include/linux/mtd/nand-sw-bch-engine.h create mode 100644 include/linux/mtd/nand-sw-hamming-engine.h delete mode 100644 include/linux/mtd/nand_bch.h delete mode 100644 include/linux/mtd/nand_ecc.h