From patchwork Wed Nov 5 16:59:49 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 40212 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-lb0-f197.google.com (mail-lb0-f197.google.com [209.85.217.197]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id D2634240A6 for ; Wed, 5 Nov 2014 17:02:59 +0000 (UTC) Received: by mail-lb0-f197.google.com with SMTP id w7sf737258lbi.0 for ; Wed, 05 Nov 2014 09:02:56 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:mime-version:delivered-to:from:to:cc:subject :date:message-id:in-reply-to:references:sender:precedence:list-id :x-original-sender:x-original-authentication-results:mailing-list :list-post:list-help:list-archive:list-unsubscribe; bh=xyIVTrEYJGwQxCX4R6R/rFxZ1TSkKd8ttMhNSJi+y/M=; b=ktaUb+/xuqs3R780NKD027kbLrbCfhWf5Dk6s57EgOE43lMNFJdi2iwohrQbd0iiQW mePXPe8Ej5AAgkthB6NmQBnl1GvqMPKs3QBa0r1XdFEhxI5v17wa7U84Rk+RKAS75ioF z7IPagiQBYumMvMfF1Jf0L+W+/98XW28mlFyfzReiimmn2xZvU7PI3q84CgY5EAnM5Ds qFMeRY4h3Qsg2fjedtfSsuKtwKzA3TWOuv4C7x8x0FXdYLcO5UsZzJFdxrMLXtSbtZJd jjvdCoiK6i9dFITUm9eixsm4ax6fz7OS024Ffz1IWUQwmaVfb936DG/a2oHb+3VNAc35 F+wA== X-Gm-Message-State: ALoCoQmP9txktbdlE/PWiuKISwoinlyaC3wVocBEOxTO4dCIH4AjGLvLIXzjZTNHguTnl0aAVDV4 X-Received: by 10.181.8.194 with SMTP id dm2mr5614369wid.2.1415206976677; Wed, 05 Nov 2014 09:02:56 -0800 (PST) MIME-Version: 1.0 X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.37.103 with SMTP id x7ls915559laj.37.gmail; Wed, 05 Nov 2014 09:02:56 -0800 (PST) X-Received: by 10.152.29.8 with SMTP id f8mr69342868lah.56.1415206976492; Wed, 05 Nov 2014 09:02:56 -0800 (PST) Received: from mail-lb0-f172.google.com (mail-lb0-f172.google.com. [209.85.217.172]) by mx.google.com with ESMTPS id 9si7259394lai.28.2014.11.05.09.02.56 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Wed, 05 Nov 2014 09:02:56 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.172 as permitted sender) client-ip=209.85.217.172; Received: by mail-lb0-f172.google.com with SMTP id w7so1044056lbi.3 for ; Wed, 05 Nov 2014 09:02:56 -0800 (PST) X-Received: by 10.112.52.37 with SMTP id q5mr33416599lbo.32.1415206976407; Wed, 05 Nov 2014 09:02:56 -0800 (PST) X-Forwarded-To: patchwork-forward@linaro.org X-Forwarded-For: patch@linaro.org patchwork-forward@linaro.org Delivered-To: patch@linaro.org Received: by 10.112.184.201 with SMTP id ew9csp316376lbc; Wed, 5 Nov 2014 09:02:55 -0800 (PST) X-Received: by 10.66.221.198 with SMTP id qg6mr19241333pac.106.1415206974646; Wed, 05 Nov 2014 09:02:54 -0800 (PST) Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id db6si3592312pdb.40.2014.11.05.09.02.53 for ; Wed, 05 Nov 2014 09:02:54 -0800 (PST) Received-SPF: none (google.com: linux-kernel-owner@vger.kernel.org does not designate permitted sender hosts) client-ip=209.132.180.67; Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S932333AbaKERCt (ORCPT + 25 others); Wed, 5 Nov 2014 12:02:49 -0500 Received: from mail-ig0-f169.google.com ([209.85.213.169]:43892 "EHLO mail-ig0-f169.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1755535AbaKERAh (ORCPT ); Wed, 5 Nov 2014 12:00:37 -0500 Received: by mail-ig0-f169.google.com with SMTP id hn18so8653339igb.0 for ; Wed, 05 Nov 2014 09:00:37 -0800 (PST) X-Received: by 10.51.16.36 with SMTP id ft4mr32936124igd.19.1415206837013; Wed, 05 Nov 2014 09:00:37 -0800 (PST) Received: from localhost.localdomain (host86-129-140-59.range86-129.btcentralplus.com. [86.129.140.59]) by mx.google.com with ESMTPSA id rj6sm6663489igc.0.2014.11.05.09.00.34 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 05 Nov 2014 09:00:36 -0800 (PST) From: Lee Jones To: linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org Cc: lee.jones@linaro.org, kernel@stlinux.com, computersforpeace@gmail.com, pekon@pek-sem.com, linux-mtd@lists.infradead.org, devicetree@vger.kernel.org Subject: [PATCH v4 07/11] mtd: nand: stm_nand_bch: provide Device Tree documentation Date: Wed, 5 Nov 2014 16:59:49 +0000 Message-Id: <1415206793-25670-8-git-send-email-lee.jones@linaro.org> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1415206793-25670-1-git-send-email-lee.jones@linaro.org> References: <1415206793-25670-1-git-send-email-lee.jones@linaro.org> Sender: linux-kernel-owner@vger.kernel.org Precedence: list List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: lee.jones@linaro.org X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.172 as permitted sender) smtp.mail=patch+caf_=patchwork-forward=linaro.org@linaro.org Mailing-list: list patchwork-forward@linaro.org; contact patchwork-forward+owners@linaro.org X-Google-Group-Id: 836684582541 List-Post: , List-Help: , List-Archive: List-Unsubscribe: , This is where we describe the different new and generic options used by the ST BCH driver. Cc: devicetree@vger.kernel.org Reviewed-by: Pekon Gupta Signed-off-by: Lee Jones --- Documentation/devicetree/bindings/mtd/stm-nand.txt | 74 ++++++++++++++++++++++ 1 file changed, 74 insertions(+) create mode 100644 Documentation/devicetree/bindings/mtd/stm-nand.txt diff --git a/Documentation/devicetree/bindings/mtd/stm-nand.txt b/Documentation/devicetree/bindings/mtd/stm-nand.txt new file mode 100644 index 0000000..9b87cde --- /dev/null +++ b/Documentation/devicetree/bindings/mtd/stm-nand.txt @@ -0,0 +1,74 @@ +STM BCH NAND Support +-------------------- + +Required properties: + +- compatible : Should be "st,nand-bch" +- reg : Should contain register's location and length +- reg-names : "emi_nand" - NAND Controller register map + "emiss" - External Memory Interface Subsystem base +- interrupts : Interrupt number +- interrupt-names : "nand_irq" - NAND Controller IRQ + +Optional properties: + +- nand-ecc-strength : Generic NAND property (See mtd/nand.txt) + Options are; 0, 18 or 30. If not present, the driver + will choose the strongest scheme compatible if the + OOB size. + +Required sub-node: + +- bank : Subnode representing one of NAND Flash, connected + to an STM NAND Controller (see description below). + There should be one of these per connect bank. + +Optional sub-node properies: + +- nand-chip-select : Generic NAND property (See mtd/nand.txt) +- st,nand-timing-relax : Number of IP clock cycles by which to "relax" timing + configuration. Required on some boards to accommodate + board-level limitations. Applies to ONFI timing mode + configuration. +- nand-on-flash-bbt : Generic NAND property (See mtd/nand.txt) + +Note, during initialisation, the NAND Controller timing registers are configured +according to one of the following methods, in order of precedence: + + 1. Configuration based on ONFI timing mode, as advertised by the + device during ONFI-probing (ONFI-compliant NAND only). + + 2. Use reset/safe timing values + +Example: + + nand@fe901000 { + compatible = "st,nand-bch"; + reg = <0xfe901000 0x1000>, <0xfef00800 0x0800>; + reg-names = "emi_nand", "emiss"; + interrupts = <0 139 0x0>; + interrupt-names = "nand_irq"; + nand-ecc-strength = <30>; + + status = "okay"; + + bank { + nand-on-flash-bbt; + st,nand-csn = <0>; + + partitions { + #address-cells = <1>; + #size-cells = <1>; + + partition@0{ + label = "NANDFlash1"; + reg = <0x00000000 0x00800000>; + }; + + partition@800000{ + label = "NANDFlash2"; + reg = <0x00800000 0x0f800000>; + }; + }; + }; + };