From patchwork Wed Oct 18 14:36:22 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Miquel Raynal X-Patchwork-Id: 10014849 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id B5B5460211 for ; Wed, 18 Oct 2017 14:40:33 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id A669129230 for ; Wed, 18 Oct 2017 14:40:33 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 73721291E6; Wed, 18 Oct 2017 14:40:31 +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=-4.2 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,RCVD_IN_DNSWL_MED autolearn=ham version=3.3.1 Received: from bombadil.infradead.org (bombadil.infradead.org [65.50.211.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 D65F129415 for ; Wed, 18 Oct 2017 14:39:57 +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:References:In-Reply-To: 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: List-Owner; bh=PAf8QO3TPys2WBh3xsGOjG7c1LfoyhU9cNHuFccNYlE=; b=Zuo5Sh+2H9wrJZ ex4/2Agrs7XobRbGD1n87W9cwCmRCKT9UWYOwBYfEXs43dbrI9abUP7kV3y1mhjWJcl8fnGX1xkS1 2AmJFXs8gzKIN+5CPIkNEFyRu/7cUxPG2bf1s4G2E7JLybE787sHG5zCeL5WBOsPQNrQuIoBAEr/j bffgychyzrQNAqHowHw5qMbh5cdXu2OWZFlT6vZw6PNBdmfgeau88EeVaaNqFlblnveSBG/NnCGph XrIpVucUhpNgJnPRo1ymvtJa6N9INKJzprNLIRwWfxKKYVdS2r13WmnRyXCSMk06DE/OtcJQbyLqB zErtsGy9Cz7noBeY+0JA==; Received: from localhost ([127.0.0.1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.87 #1 (Red Hat Linux)) id 1e4pVk-0001br-H1; Wed, 18 Oct 2017 14:39:56 +0000 Received: from mail.free-electrons.com ([62.4.15.54]) by bombadil.infradead.org with esmtp (Exim 4.87 #1 (Red Hat Linux)) id 1e4pTI-0007hn-Nd; Wed, 18 Oct 2017 14:37:40 +0000 Received: by mail.free-electrons.com (Postfix, from userid 110) id 4F4B3208AF; Wed, 18 Oct 2017 16:36:42 +0200 (CEST) Received: from localhost.localdomain (LStLambert-657-1-97-87.w90-63.abo.wanadoo.fr [90.63.216.87]) by mail.free-electrons.com (Postfix) with ESMTPSA id 5F0F8208A8; Wed, 18 Oct 2017 16:36:41 +0200 (CEST) From: Miquel Raynal To: Andrew Lunn , bcm-kernel-feedback-list@broadcom.com, Boris Brezillon , Brian Norris , Catalin Marinas , Chen-Yu Tsai , Cyrille Pitchen , Daniel Mack , David Woodhouse , devel@driverdev.osuosl.org, devicetree@vger.kernel.org, Ezequiel Garcia , Greg Kroah-Hartman , Gregory Clement , Han Xu , Haojian Zhuang , Jason Cooper , Josh Wu , Kamal Dasu , linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org, linux-mediatek@lists.infradead.org, linux-mtd@lists.infradead.org, Marc Gonzalez , Marek Vasut , Mark Rutland , Masahiro Yamada , Matthias Brugger , Maxime Ripard , Maxim Levitsky , Richard Weinberger , Robert Jarzmik , Rob Herring , Russell King , Sebastian Hesselbarth , Stefan Agner , Sylvain Lemieux , Vladimir Zapolskiy , Wenyou Yang , Will Deacon Subject: [RFC 05/12] dt-bindings: mtd: add Marvell NAND controller documentation Date: Wed, 18 Oct 2017 16:36:22 +0200 Message-Id: <20171018143629.29302-6-miquel.raynal@free-electrons.com> X-Mailer: git-send-email 2.11.0 In-Reply-To: <20171018143629.29302-1-miquel.raynal@free-electrons.com> References: <20171018143629.29302-1-miquel.raynal@free-electrons.com> MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20171018_073725_401501_018E8477 X-CRM114-Status: GOOD ( 16.96 ) X-BeenThere: linux-mediatek@lists.infradead.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Thomas Petazzoni , Hanna Hawa , Antoine Tenart , Nadav Haklai , Neta Zur Hershkovits , Igor Grinberg , Miquel Raynal , Ofer Heifetz Sender: "Linux-mediatek" Errors-To: linux-mediatek-bounces+patchwork-linux-mediatek=patchwork.kernel.org@lists.infradead.org X-Virus-Scanned: ClamAV using ClamSMTP Document the bindings for the legacy and the new bindings relative to Marvell NAND controller driver rework. Signed-off-by: Miquel Raynal --- .../devicetree/bindings/mtd/marvell-nand.txt | 95 ++++++++++++++++++++++ 1 file changed, 95 insertions(+) create mode 100644 Documentation/devicetree/bindings/mtd/marvell-nand.txt diff --git a/Documentation/devicetree/bindings/mtd/marvell-nand.txt b/Documentation/devicetree/bindings/mtd/marvell-nand.txt new file mode 100644 index 000000000000..ea99f426c03f --- /dev/null +++ b/Documentation/devicetree/bindings/mtd/marvell-nand.txt @@ -0,0 +1,95 @@ +Marvell NAND Flash Controller (NFC) + +Required properties: +C'est faux, t'en a rajouté un y a pas longtps :). +Je conseille de mettre ça sous forme de liste, genre + +- compatible: can be one of the following: + * "marvell,armada-8k-nand-controller" + * "marvell,armada370-nand-controller" + * "marvell,pxa3xx-nand-controller" + * "marvell,armada-8k-nand" (deprecated) + * "marvell,armada370-nand" (deprecated) + * "marvell,pxa3xx-nand" (deprecated) +- reg: shall contain registers location and length for data and reg. +- #address-cells: shall be set to 1. Encode the nand CS. +- #size-cells: shall be set to 0. +- interrupts: shall define the nand controller interrupt. +- clocks: shall reference nand controller clocks. +- marvell,system-controller: Set to retrieve the syscon node that handles + NAND controller related registers (only required with the + "marvell,armada-8k-nand[-controller]" compatibles). + +Optional properties: +- dmas: shall reference DMA channel associated to the NAND controller. +- dma-names: shall be "rxtx". + +Optional children nodes: +Children nodes represent the available NAND chips. + +Required properties: +- reg: shall contain the native Chip Select ids (0-3) +- marvell,rb: shall contain the native Ready/Busy ids (0-1) + +Optional properties: +- marvell,nand-keep-config: orders the driver not to take the timings + from the core and leaving them completely untouched. Bootloader + timings will then be used. +- marvell,nand-enable-arbiter: only useful for PXA platforms, will + enable bus arbiter between NFC and DFI bus (must be enabled for + NFC operation) +- nand-on-flash-bbt: speed up the boot process by not discovering all + the bad blocks at each boot and reading directly an on flash table. +- nand-ecc-mode: one of the supported ECC modes ("none", "soft", + "hw"). If not specified, hardware ECC will be used. +- nand-ecc-algo: algorithm to use if previous choice was "soft" + ("hamming" or "bch). This property may be added for hardware ECC for + clarification but will be ignored by the driver because ECC mode is + chosen depending on the page size and the strength required by the + NAND chip. This value may be overwritten with the nand-ecc-strength + property. +- nand-ecc-strength: desired ECC strength. +- nand-ecc-step-size: indication on the ECC step size. This has no + effect and will be ignored by the driver when using hardware + ECC. Because Marvell's NAND flash controller does use fixed strength + (1-bit for Hamming, 16-bit for BCH), the step size will shrink or + grown in order to fit the required strength and the value + updated. Step sizes are not completely random for all and follow + certain patterns described in AN-379, "Marvell SoC NFC ECC". + +See Documentation/devicetree/bindings/mtd/nand.txt for more details on +generic bindings. + + +Example: +nand_controller: nand-controller@d0000 { + compatible = "marvell,armada370-nand-controller"; + reg = <0xd0000 0x54>; + #address-cells = <1>; + #size-cells = <0>; + interrupts = ; + clocks = <&coredivclk 0>; + status = "okay"; + + nand@0 { + reg = <0>; + marvell,rb = <0>; + nand-ecc-mode = "hw"; + marvell,nand-keep-config; + marvell,nand-enable-arbiter; + nand-on-flash-bbt; + nand-ecc-strength = <4>; + nand-ecc-step-size = <512>; + + partitions { + compatible = "fixed-partitions"; + #address-cells = <1>; + #size-cells = <1>; + + partition@0 { + label = "Rootfs"; + reg = <0x00000000 0x40000000>; + }; + }; + }; +};