From patchwork Thu Sep 19 19:31:00 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Miquel Raynal X-Patchwork-Id: 11153091 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 2060B1747 for ; Thu, 19 Sep 2019 19:31:54 +0000 (UTC) Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id DFF6320717 for ; Thu, 19 Sep 2019 19:31:53 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="qIkq4pQ1" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org DFF6320717 Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=bootlin.com Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+patchwork-linux-arm=patchwork.kernel.org@lists.infradead.org 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=dV+AZHIMY0vzuODe1xIvyHz4JjjkeGq8yR2xGwD0PuM=; b=qIkq4pQ1xOl9W0 QC4LFNU3xkZuyAnHKPdeu4bjxmmAvqHl9wnz5K7SWakkIxLYK3qF/ml7Ume5kFpv9NuQFQ7iX5Mxd poxy/pCVohmhCsxGqorWuLre0wD54LO85KrAKoh/8emWS1HIn4GXSZx4bTThFT/tiYZSQqqInG72m luw2OUKtKsr4+AQadmTLTT+7e6XMG+bksDUuQ2C8TG6OkMWH2q29gI767gHSlJDFtWdUBTs1+tHuV kW32tHA+46AGzKcdeIHQqDW+gSn52yqhVp7tyaWarJjovf2cmVEDPyX0XNl/VJhGegYmYjfXB2cAK h9uXCaGcn4SQ5rod4LLw==; Received: from localhost ([127.0.0.1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.92.2 #3 (Red Hat Linux)) id 1iB29h-0001p7-II; Thu, 19 Sep 2019 19:31:53 +0000 Received: from relay1-d.mail.gandi.net ([217.70.183.193]) by bombadil.infradead.org with esmtps (Exim 4.92.2 #3 (Red Hat Linux)) id 1iB29e-0001oE-BW; Thu, 19 Sep 2019 19:31:52 +0000 X-Originating-IP: 91.224.148.103 Received: from localhost.localdomain (unknown [91.224.148.103]) (Authenticated sender: miquel.raynal@bootlin.com) by relay1-d.mail.gandi.net (Postfix) with ESMTPSA id 98F8A240002; Thu, 19 Sep 2019 19:31:43 +0000 (UTC) From: Miquel Raynal To: Richard Weinberger , David Woodhouse , Brian Norris , Marek Vasut , Tudor Ambarus , Vignesh Raghavendra Subject: [PATCH v3 00/40] Introduce the generic ECC engine abstraction Date: Thu, 19 Sep 2019 21:31:00 +0200 Message-Id: <20190919193141.7865-1-miquel.raynal@bootlin.com> X-Mailer: git-send-email 2.20.1 MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20190919_123150_703459_CB5FDC55 X-CRM114-Status: GOOD ( 24.23 ) X-Spam-Score: -0.7 (/) X-Spam-Report: SpamAssassin version 3.4.2 on bombadil.infradead.org summary: Content analysis details: (-0.7 points) pts rule name description ---- ---------------------- -------------------------------------------------- -0.7 RCVD_IN_DNSWL_LOW RBL: Sender listed at https://www.dnswl.org/, low trust [217.70.183.193 listed in list.dnswl.org] 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record -0.0 SPF_PASS SPF: sender matches SPF record X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Tudor Ambarus , Julien Su , Schrempf Frieder , Paul Cercueil , Boris Brezillon , 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 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 devices: 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 hardware ECC engine, otherwise software correction can also be used). 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.c 3/ Move code in driver/mtd/nand/ecc.c 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). 7/ Extend the logic to hardware external engines. A proposal of a driver for Macronix external ECC engine will follow in another series. This work is now almost ready, 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). Thanks, Miquèl Changes in v3 ============= * Added Boris' Reviewed-by tags. * Added a kernel doc header on the nand_page_io_req enumeration. * Added support for HW engines. * Droped the patch clarifying the value of the first entry in enumerations (which is always 0). * Rename the nand_ecc_conf structure as nand_ecc_props because the _conf suffix implies that it is possible to edit it, while in some cases (eg. on-die ECC) there is nothing to tweak. * Smoother introduction of the ECC engine abstraction. * Renamed the ECC engine module nand_ecc_engine.ko. * Moved all the ECC files into drivers/mtd/nand/. Forgot the ecc/ subdirectory. * Added a new series to drop the ECC mode enumeration wich mixes the provider (none, hw, sw, on-die) and the OOB placement (first, syndrome). * Various typos fixed. * Added a few patches to fix bugs found in SPI-NAND/mtdchar.c. * Introduced the external hardware ECC engine boilerplate. Changes in v2 ============= * SPDX license identifiers for soft BCH and Hamming: the license macro was right, "GPL" means "GPLv2 or higher", so do not change this portion. Also update the commit messages to fit the actual change. * Do not compile-in the NAND core by default, do it only for raw NAND. Remove the dependencies on CONFIG_MTD in a different patch. Also, keep an extra level of hierarchy in Kconfig for the NAND bits by adding a menu instead of a config. * Moved the standard OOB layouts in the ecc/engine.c driver instead of in the NAND core. * Used the nand_ecc_ prefix in most of the engines functions instead of just ecc_, which is now reserved for bare helpers. Get rid of the __ecc prefix. * In the sunxi NAND controller driver: moved the ECC structure from sunxi_nfc to sunxi_nand_chip as the ECC engine is per-chip and not per controller. * Software Hamming ECC engine is only enabled by default if raw NAND is also enabled. NDFC now selects the software Hamming ECC engine (instead of depending on it). * Mention in software BCH and Hamming Kconfig entries that booting from NAND is very likely to fail if the user selects these symbols as modules. * Added Boris Reviewed-by tag on the SPI-NAND typo fixing patch. * Renamed the "mode" into a "provider" entry in the ECC configuration structures. * Moved the "total" entry of the ECC configuration directly in the context structure (should probably not be public but let's keep it as is for now). * Split the generic ECC engine introduction into smaller patches to do some renaming aside. * Drop the "maximize" entry in the ECC engine configuration structure, keep using a flag like before. * Canceled the move of the SPI-NAND specific ECC engine out of the core file. * Amended the root ECC structures to have three nand_ecc_conf structures: one for the defaults, one for the chip requirements, one for the user desires. * Created a *ondie_engine pointer in the nand_ecc structure to save the on-die ECC engine, if any. For instance, saving a reference to this engine is done by the SPI-NAND core. * Dropped the SPI-NAND flag that was used to distinguish between NAND flavors from the NAND core, it should not be needed anymore. * Added an helper in the NAND core to put a reference on an ECC engine. This will be used by the hardware engines only. * Renamed the files ecc/sw-{bch,hamming}.c and their headers include/linux/mtd/nand-ecc-sw-{bch,hamming}-engine.h. * Created a MTD_NAND_ECC invisible Kconfig symbol. * Added plenty of missing EXPORT_SYMBOL{,_GPL}(). * Minor modifications so that everything still compiles even when modules and built-in drivers are mixed in Kconfig in the whole NAND directory. Miquel Raynal (40): mtd: rawnand: Avoid a typedef mtd: rawnand: Add an invalid ECC mode to discriminate with valid ones mtd: rawnand: Create a new enumeration to describe OOB placement mtd: rawnand: Separate the ECC engine type and the OOB placement mtd: rawnand: Create a new enumeration to describe properly ECC types mtd: rawnand: Use the new ECC engine type enumeration mtd: rawnand: Drop the legacy ECC type enumeration mtd: nand: Move nand_device forward declaration to the top mtd: nand: Add an extra level in the Kconfig hierarchy mtd: nand: Drop useless 'depends on' in Kconfig mtd: nand: Add a NAND page I/O request type mtd: nand: Rename a core structure mtd: nand: Add more parameters to the nand_ecc_props structure mtd: nand: Introduce the ECC engine abstraction mtd: nand: Convert the generic NAND layer to the generic ECC framework mtd: Fix typo in mtd_ooblayout_set_databytes() description mtd: nand: Move standard OOB layouts to the generic ECC core mtd: nand: Move ECC specific functions to the ECC core mtd: nand: ecc: Turn the software BCH implementation generic mtd: rawnand: Get rid of chip->ecc.priv mtd: nand: ecc: Move Hamming code to the generic NAND layer 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 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: Move ECC related definitions earlier in the driver mtd: spinand: Instantiate a SPI-NAND on-die ECC engine mtd: nand: Let on-die ECC engines be retrieved from the NAND core mtd: rawnand: Fill a default ECC provider/algorithm mtd: spinand: Fill a default ECC provider/algorithm 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 mtd: spinand: Allow the case where there is no ECC engine mtd: spinand: Fix OOB read mtd: nand: ecc: Add infrastructure to support hardware engines arch/arm/mach-davinci/board-da830-evm.c | 2 +- arch/arm/mach-davinci/board-da850-evm.c | 2 +- arch/arm/mach-davinci/board-dm355-evm.c | 2 +- arch/arm/mach-davinci/board-dm355-leopard.c | 3 +- arch/arm/mach-davinci/board-dm365-evm.c | 2 +- arch/arm/mach-davinci/board-dm644x-evm.c | 2 +- arch/arm/mach-davinci/board-dm646x-evm.c | 2 +- arch/arm/mach-davinci/board-mityomapl138.c | 2 +- arch/arm/mach-davinci/board-neuros-osd2.c | 2 +- arch/arm/mach-davinci/board-omapl138-hawk.c | 2 +- arch/arm/mach-s3c24xx/common-smdk.c | 3 +- arch/arm/mach-s3c24xx/mach-anubis.c | 3 +- arch/arm/mach-s3c24xx/mach-at2440evb.c | 3 +- arch/arm/mach-s3c24xx/mach-bast.c | 3 +- arch/arm/mach-s3c24xx/mach-gta02.c | 3 +- arch/arm/mach-s3c24xx/mach-jive.c | 3 +- arch/arm/mach-s3c24xx/mach-mini2440.c | 3 +- arch/arm/mach-s3c24xx/mach-osiris.c | 3 +- arch/arm/mach-s3c24xx/mach-qt2410.c | 3 +- arch/arm/mach-s3c24xx/mach-rx1950.c | 2 +- arch/arm/mach-s3c24xx/mach-rx3715.c | 3 +- arch/arm/mach-s3c24xx/mach-vstms.c | 3 +- arch/arm/mach-s3c64xx/mach-hmt.c | 2 +- arch/arm/mach-s3c64xx/mach-mini6410.c | 2 +- arch/arm/mach-s3c64xx/mach-real6410.c | 2 +- drivers/mtd/mtdcore.c | 2 +- drivers/mtd/nand/Kconfig | 43 ++ drivers/mtd/nand/Makefile | 4 + drivers/mtd/nand/core.c | 128 ++++ drivers/mtd/nand/ecc-sw-bch.c | 423 +++++++++++ .../nand/{raw/nand_ecc.c => ecc-sw-hamming.c} | 331 +++++++-- drivers/mtd/nand/ecc.c | 614 ++++++++++++++++ drivers/mtd/nand/onenand/Kconfig | 1 - drivers/mtd/nand/raw/Kconfig | 25 +- drivers/mtd/nand/raw/Makefile | 2 - drivers/mtd/nand/raw/ams-delta.c | 2 +- drivers/mtd/nand/raw/atmel/nand-controller.c | 22 +- drivers/mtd/nand/raw/au1550nd.c | 2 +- .../mtd/nand/raw/bcm47xxnflash/ops_bcm4706.c | 2 +- drivers/mtd/nand/raw/brcmnand/brcmnand.c | 4 +- drivers/mtd/nand/raw/cafe_nand.c | 3 +- drivers/mtd/nand/raw/cmx270_nand.c | 2 +- drivers/mtd/nand/raw/cs553x_nand.c | 5 +- drivers/mtd/nand/raw/davinci_nand.c | 22 +- drivers/mtd/nand/raw/denali.c | 6 +- drivers/mtd/nand/raw/diskonchip.c | 3 +- drivers/mtd/nand/raw/fsl_elbc_nand.c | 13 +- drivers/mtd/nand/raw/fsl_ifc_nand.c | 7 +- drivers/mtd/nand/raw/fsl_upm.c | 3 +- drivers/mtd/nand/raw/fsmc_nand.c | 13 +- drivers/mtd/nand/raw/gpio.c | 2 +- drivers/mtd/nand/raw/gpmi-nand/gpmi-nand.c | 14 +- drivers/mtd/nand/raw/hisi504_nand.c | 6 +- .../mtd/nand/raw/ingenic/ingenic_nand_drv.c | 10 +- drivers/mtd/nand/raw/ingenic/jz4740_nand.c | 3 +- drivers/mtd/nand/raw/lpc32xx_mlc.c | 3 +- drivers/mtd/nand/raw/lpc32xx_slc.c | 6 +- drivers/mtd/nand/raw/marvell_nand.c | 21 +- drivers/mtd/nand/raw/meson_nand.c | 2 +- drivers/mtd/nand/raw/mpc5121_nfc.c | 2 +- drivers/mtd/nand/raw/mtk_nand.c | 8 +- drivers/mtd/nand/raw/mxc_nand.c | 20 +- drivers/mtd/nand/raw/nand_base.c | 687 +++++++----------- drivers/mtd/nand/raw/nand_bch.c | 218 ------ 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 | 18 +- drivers/mtd/nand/raw/nand_onfi.c | 8 +- drivers/mtd/nand/raw/nand_samsung.c | 19 +- drivers/mtd/nand/raw/nand_toshiba.c | 15 +- drivers/mtd/nand/raw/nandsim.c | 7 +- drivers/mtd/nand/raw/ndfc.c | 5 +- drivers/mtd/nand/raw/nuc900_nand.c | 2 +- drivers/mtd/nand/raw/omap2.c | 50 +- drivers/mtd/nand/raw/orion_nand.c | 2 +- drivers/mtd/nand/raw/pasemi_nand.c | 3 +- drivers/mtd/nand/raw/plat_nand.c | 2 +- drivers/mtd/nand/raw/qcom_nandc.c | 2 +- drivers/mtd/nand/raw/r852.c | 3 +- drivers/mtd/nand/raw/s3c2410.c | 9 +- drivers/mtd/nand/raw/sh_flctl.c | 4 +- drivers/mtd/nand/raw/sharpsl.c | 5 +- drivers/mtd/nand/raw/socrates_nand.c | 2 +- drivers/mtd/nand/raw/stm32_fmc2_nand.c | 8 +- drivers/mtd/nand/raw/sunxi_nand.c | 53 +- drivers/mtd/nand/raw/tango_nand.c | 2 +- drivers/mtd/nand/raw/tegra_nand.c | 14 +- drivers/mtd/nand/raw/tmio_nand.c | 9 +- drivers/mtd/nand/raw/txx9ndfmc.c | 7 +- drivers/mtd/nand/raw/vf610_nfc.c | 4 +- drivers/mtd/nand/raw/xway_nand.c | 2 +- drivers/mtd/nand/spi/Kconfig | 1 + drivers/mtd/nand/spi/core.c | 300 +++++--- drivers/mtd/nand/spi/macronix.c | 6 +- drivers/mtd/nand/spi/on-die-ecc-engine.c | 0 drivers/mtd/nand/spi/toshiba.c | 6 +- drivers/mtd/sm_ftl.c | 30 +- drivers/mtd/tests/mtd_nandecctest.c | 31 +- include/linux/mtd/nand-ecc-sw-bch.h | 80 ++ include/linux/mtd/nand-ecc-sw-hamming.h | 99 +++ include/linux/mtd/nand.h | 188 ++++- include/linux/mtd/nand_bch.h | 66 -- include/linux/mtd/nand_ecc.h | 39 - include/linux/mtd/rawnand.h | 48 +- include/linux/mtd/sharpsl.h | 1 - include/linux/mtd/spinand.h | 13 +- include/linux/platform_data/mtd-davinci.h | 9 +- .../linux/platform_data/mtd-nand-s3c2410.h | 2 +- 109 files changed, 2650 insertions(+), 1326 deletions(-) create mode 100644 drivers/mtd/nand/ecc-sw-bch.c rename drivers/mtd/nand/{raw/nand_ecc.c => ecc-sw-hamming.c} (60%) create mode 100644 drivers/mtd/nand/ecc.c 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-ecc-sw-bch.h create mode 100644 include/linux/mtd/nand-ecc-sw-hamming.h delete mode 100644 include/linux/mtd/nand_bch.h delete mode 100644 include/linux/mtd/nand_ecc.h