From patchwork Fri Mar 19 15:00:08 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Manivannan Sadhasivam X-Patchwork-Id: 404797 Delivered-To: patch@linaro.org Received: by 2002:a02:8562:0:0:0:0:0 with SMTP id g89csp1450479jai; Fri, 19 Mar 2021 08:01:17 -0700 (PDT) X-Google-Smtp-Source: ABdhPJyPXCwOikdWLhBZi918DmgKNxwARwQFHYzj4K8K4Jjp+4V5OMGYwuCaiA49Gu+4+b7uZlz9 X-Received: by 2002:a5d:6290:: with SMTP id k16mr4782413wru.177.1616166077255; Fri, 19 Mar 2021 08:01:17 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1616166077; cv=none; d=google.com; s=arc-20160816; b=oQsuD/8q68PwIJLHUpsei6l5KD2tq92AASysxWZcLKgfUZqJKh5MQ2SyKYr6eoGORq P3apaAXTFaoXfdI6dtzlmuCwAz8/8lejKCsJJPMmjo/o4YhavJcHQBKPxIQJ7iGrBREC h8pXiS3hzYus8Gp3ynV6yRbE2OdUwnwoaybzi4eoLTjjGmSjvYQ78QLJFVJ1iP/fR7SC FJdqqc11A5wtHg9RcuOxoIbgo55ZcALbFX7SeLlJk0+vrpGhtw3Omx/XMqnLcQiLwQiS OrCcILGC19rcgrt7Ce0eQMR/QHeDb1VhRTFcGR3xgJuC23bPy0bBX2MGwV18E34rm3d0 u7HA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=M2CEXbNlNorHIt0/KQNWcmF9T/2OkYKo0K/LHRqivCU=; b=09M6SbY/kpuHl+iS4oLEk3r1rd6Sou9WRx8ufk5/osq/pQAXZhdvlgc++3xooa2Yiy obZ1BbzzP34r5ORxjymz7RaETWqt6rcJGI3xhALQWta34B6lQRkHJ/0G1ZSEgTJTEeIg UmsSCsHU87OHrlrwWbtT2SdR3kH5uHd6WaUYUSn1nIaq/w2YEznPIBwtCEzF8PHiuF0q qJtuqusyoph2NjoAcQ6XMbbANmVrfcucyxybjXDtlHIC98EqZFuBeBw37bi79lHr8M+T GloJzK9ZiWOrt4wEBI1P4IcrPWf2imbdI/NMcWStt2KjOc4c8ZmWsc3Pq1RQJmlllehA eTdw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=VTqvkqwL; spf=pass (google.com: domain of linux-arm-msm-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-arm-msm-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id jz18si4126546ejc.575.2021.03.19.08.01.16; Fri, 19 Mar 2021 08:01:17 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-arm-msm-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=VTqvkqwL; spf=pass (google.com: domain of linux-arm-msm-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-arm-msm-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230486AbhCSPAl (ORCPT + 16 others); Fri, 19 Mar 2021 11:00:41 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:33688 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230163AbhCSPAa (ORCPT ); Fri, 19 Mar 2021 11:00:30 -0400 Received: from mail-pl1-x630.google.com (mail-pl1-x630.google.com [IPv6:2607:f8b0:4864:20::630]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id CD25CC06174A for ; Fri, 19 Mar 2021 08:00:30 -0700 (PDT) Received: by mail-pl1-x630.google.com with SMTP id v23so3072549ple.9 for ; Fri, 19 Mar 2021 08:00:30 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=M2CEXbNlNorHIt0/KQNWcmF9T/2OkYKo0K/LHRqivCU=; b=VTqvkqwLDc/DmNjMO8wqzkrDF0kqAyb/cidWIrgPBZTgDUf3uNqRQzT7y9UhIOj/3b g4dQ2Yo8rW9yinJq4dqvTjZZ5MCyQ+S9qDLWCVN8qfUjUtzVlNAyJy0afN5+rqqgGMH4 PmNHXEKV9fXUfJ+al2LGBYfz/TRl8CTCeLe+wnnMcn5KIy+MY5GnK0X+iKs9w4v0XdvC J3JNuT8Vnt4lDU0Pw4zhsiKsvOHNVNY51eEwHN4XAtpiTs7E6Ld2Ycb7LNUoni9lTzQg 2joTusAdJ5oK/60gSVcOGFiB1qNYciVP3bD06aMOGnfOFC7kkVFNNLm4Jn7r7zrFLidR Yo4g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=M2CEXbNlNorHIt0/KQNWcmF9T/2OkYKo0K/LHRqivCU=; b=YwTxnXx7uAKwDKJ/Tmu3QOzH6mF/NDqcfvRf+QlO0UUOEtEWbJZi3XVMI5/RZo2mnm MlJXhd/psYgf7MeL/7AYt54JRWIxpZhD0TXILlEZNrqJoCfZaQbj/3if8F9pI9rc7Cji E7zTCVaogJSSqpehwABD4T8LT2xNILjQXgLa+Zqgy1md2XJOXeIYZYE/8dOofxGGeALp 0FJGotzIl/QXQqJZjbNBPqXVndxN6Jp47f0itfTzbRaYOH7GhvkomYbcW5bUt6IwSUjF v4HAXjDk9cDapYZUzoQdUQ1bOm+Os2Qyy7HITglfG9yEeEEvibt0j4tNJEEHTZenkpc3 zscg== X-Gm-Message-State: AOAM533V5KZ4tLCvTrvd9q0DIUhYoftTtAfgT/GKw2gAf8Vl5X4gGRhf G8+aHHAXgffMyc2joqSys+tj X-Received: by 2002:a17:902:9304:b029:e6:8d24:b5ce with SMTP id bc4-20020a1709029304b02900e68d24b5cemr14412625plb.27.1616166030280; Fri, 19 Mar 2021 08:00:30 -0700 (PDT) Received: from localhost.localdomain ([2409:4072:387:dba9:92f4:36c7:1aec:59de]) by smtp.gmail.com with ESMTPSA id h19sm6092345pfc.172.2021.03.19.08.00.24 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 19 Mar 2021 08:00:29 -0700 (PDT) From: Manivannan Sadhasivam To: miquel.raynal@bootlin.com, richard@nod.at, vigneshr@ti.com, robh+dt@kernel.org Cc: linux-arm-msm@vger.kernel.org, devicetree@vger.kernel.org, linux-mtd@lists.infradead.org, linux-kernel@vger.kernel.org, boris.brezillon@collabora.com, Daniele.Palmas@telit.com, bjorn.andersson@linaro.org, Manivannan Sadhasivam , Rob Herring Subject: [PATCH v7 1/3] dt-bindings: mtd: Convert Qcom NANDc binding to YAML Date: Fri, 19 Mar 2021 20:30:08 +0530 Message-Id: <20210319150010.32122-2-manivannan.sadhasivam@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20210319150010.32122-1-manivannan.sadhasivam@linaro.org> References: <20210319150010.32122-1-manivannan.sadhasivam@linaro.org> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-arm-msm@vger.kernel.org Convert Qcom NANDc devicetree binding to YAML. Signed-off-by: Manivannan Sadhasivam Reviewed-by: Rob Herring --- .../devicetree/bindings/mtd/qcom,nandc.yaml | 196 ++++++++++++++++++ .../devicetree/bindings/mtd/qcom_nandc.txt | 142 ------------- 2 files changed, 196 insertions(+), 142 deletions(-) create mode 100644 Documentation/devicetree/bindings/mtd/qcom,nandc.yaml delete mode 100644 Documentation/devicetree/bindings/mtd/qcom_nandc.txt -- 2.25.1 diff --git a/Documentation/devicetree/bindings/mtd/qcom,nandc.yaml b/Documentation/devicetree/bindings/mtd/qcom,nandc.yaml new file mode 100644 index 000000000000..84ad7ff30121 --- /dev/null +++ b/Documentation/devicetree/bindings/mtd/qcom,nandc.yaml @@ -0,0 +1,196 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/mtd/qcom,nandc.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Qualcomm NAND controller + +maintainers: + - Manivannan Sadhasivam + +properties: + compatible: + enum: + - qcom,ipq806x-nand + - qcom,ipq4019-nand + - qcom,ipq6018-nand + - qcom,ipq8074-nand + - qcom,sdx55-nand + + reg: + maxItems: 1 + + clocks: + items: + - description: Core Clock + - description: Always ON Clock + + clock-names: + items: + - const: core + - const: aon + + "#address-cells": true + "#size-cells": true + +patternProperties: + "^nand@[a-f0-9]$": + type: object + properties: + nand-bus-width: + const: 8 + + nand-ecc-strength: + enum: [1, 4, 8] + + nand-ecc-step-size: + enum: + - 512 + +allOf: + - $ref: "nand-controller.yaml#" + + - if: + properties: + compatible: + contains: + const: qcom,ipq806x-nand + then: + properties: + dmas: + items: + - description: rxtx DMA channel + + dma-names: + items: + - const: rxtx + + qcom,cmd-crci: + $ref: /schemas/types.yaml#/definitions/uint32 + description: + Must contain the ADM command type CRCI block instance number + specified for the NAND controller on the given platform + + qcom,data-crci: + $ref: /schemas/types.yaml#/definitions/uint32 + description: + Must contain the ADM data type CRCI block instance number + specified for the NAND controller on the given platform + + - if: + properties: + compatible: + contains: + enum: + - qcom,ipq4019-nand + - qcom,ipq6018-nand + - qcom,ipq8074-nand + - qcom,sdx55-nand + + then: + properties: + dmas: + items: + - description: tx DMA channel + - description: rx DMA channel + - description: cmd DMA channel + + dma-names: + items: + - const: tx + - const: rx + - const: cmd + +required: + - compatible + - reg + - clocks + - clock-names + +unevaluatedProperties: false + +examples: + - | + #include + nand-controller@1ac00000 { + compatible = "qcom,ipq806x-nand"; + reg = <0x1ac00000 0x800>; + + clocks = <&gcc EBI2_CLK>, + <&gcc EBI2_AON_CLK>; + clock-names = "core", "aon"; + + dmas = <&adm_dma 3>; + dma-names = "rxtx"; + qcom,cmd-crci = <15>; + qcom,data-crci = <3>; + + #address-cells = <1>; + #size-cells = <0>; + + nand@0 { + reg = <0>; + + nand-ecc-strength = <4>; + nand-bus-width = <8>; + + partitions { + compatible = "fixed-partitions"; + #address-cells = <1>; + #size-cells = <1>; + + partition@0 { + label = "boot-nand"; + reg = <0 0x58a0000>; + }; + + partition@58a0000 { + label = "fs-nand"; + reg = <0x58a0000 0x4000000>; + }; + }; + }; + }; + + #include + nand-controller@79b0000 { + compatible = "qcom,ipq4019-nand"; + reg = <0x79b0000 0x1000>; + + clocks = <&gcc GCC_QPIC_CLK>, + <&gcc GCC_QPIC_AHB_CLK>; + clock-names = "core", "aon"; + + dmas = <&qpicbam 0>, + <&qpicbam 1>, + <&qpicbam 2>; + dma-names = "tx", "rx", "cmd"; + + #address-cells = <1>; + #size-cells = <0>; + + nand@0 { + reg = <0>; + nand-ecc-strength = <4>; + nand-bus-width = <8>; + + partitions { + compatible = "fixed-partitions"; + #address-cells = <1>; + #size-cells = <1>; + + partition@0 { + label = "boot-nand"; + reg = <0 0x58a0000>; + }; + + partition@58a0000 { + label = "fs-nand"; + reg = <0x58a0000 0x4000000>; + }; + }; + }; + }; + +... diff --git a/Documentation/devicetree/bindings/mtd/qcom_nandc.txt b/Documentation/devicetree/bindings/mtd/qcom_nandc.txt deleted file mode 100644 index 5647913d8837..000000000000 --- a/Documentation/devicetree/bindings/mtd/qcom_nandc.txt +++ /dev/null @@ -1,142 +0,0 @@ -* Qualcomm NAND controller - -Required properties: -- compatible: must be one of the following: - * "qcom,ipq806x-nand" - for EBI2 NAND controller being used in IPQ806x - SoC and it uses ADM DMA - * "qcom,ipq4019-nand" - for QPIC NAND controller v1.4.0 being used in - IPQ4019 SoC and it uses BAM DMA - * "qcom,ipq6018-nand" - for QPIC NAND controller v1.5.0 being used in - IPQ6018 SoC and it uses BAM DMA - * "qcom,ipq8074-nand" - for QPIC NAND controller v1.5.0 being used in - IPQ8074 SoC and it uses BAM DMA - * "qcom,sdx55-nand" - for QPIC NAND controller v2.0.0 being used in - SDX55 SoC and it uses BAM DMA - -- reg: MMIO address range -- clocks: must contain core clock and always on clock -- clock-names: must contain "core" for the core clock and "aon" for the - always on clock - -EBI2 specific properties: -- dmas: DMA specifier, consisting of a phandle to the ADM DMA - controller node and the channel number to be used for - NAND. Refer to dma.txt and qcom_adm.txt for more details -- dma-names: must be "rxtx" -- qcom,cmd-crci: must contain the ADM command type CRCI block instance - number specified for the NAND controller on the given - platform -- qcom,data-crci: must contain the ADM data type CRCI block instance - number specified for the NAND controller on the given - platform - -QPIC specific properties: -- dmas: DMA specifier, consisting of a phandle to the BAM DMA - and the channel number to be used for NAND. Refer to - dma.txt, qcom_bam_dma.txt for more details -- dma-names: must contain all 3 channel names : "tx", "rx", "cmd" -- #address-cells: <1> - subnodes give the chip-select number -- #size-cells: <0> - -* NAND chip-select - -Each controller may contain one or more subnodes to represent enabled -chip-selects which (may) contain NAND flash chips. Their properties are as -follows. - -Required properties: -- reg: a single integer representing the chip-select - number (e.g., 0, 1, 2, etc.) -- #address-cells: see partition.txt -- #size-cells: see partition.txt - -Optional properties: -- nand-bus-width: see nand-controller.yaml -- nand-ecc-strength: see nand-controller.yaml. If not specified, then ECC strength will - be used according to chip requirement and available - OOB size. - -Each nandcs device node may optionally contain a 'partitions' sub-node, which -further contains sub-nodes describing the flash partition mapping. See -partition.txt for more detail. - -Example: - -nand-controller@1ac00000 { - compatible = "qcom,ipq806x-nand"; - reg = <0x1ac00000 0x800>; - - clocks = <&gcc EBI2_CLK>, - <&gcc EBI2_AON_CLK>; - clock-names = "core", "aon"; - - dmas = <&adm_dma 3>; - dma-names = "rxtx"; - qcom,cmd-crci = <15>; - qcom,data-crci = <3>; - - #address-cells = <1>; - #size-cells = <0>; - - nand@0 { - reg = <0>; - - nand-ecc-strength = <4>; - nand-bus-width = <8>; - - partitions { - compatible = "fixed-partitions"; - #address-cells = <1>; - #size-cells = <1>; - - partition@0 { - label = "boot-nand"; - reg = <0 0x58a0000>; - }; - - partition@58a0000 { - label = "fs-nand"; - reg = <0x58a0000 0x4000000>; - }; - }; - }; -}; - -nand-controller@79b0000 { - compatible = "qcom,ipq4019-nand"; - reg = <0x79b0000 0x1000>; - - clocks = <&gcc GCC_QPIC_CLK>, - <&gcc GCC_QPIC_AHB_CLK>; - clock-names = "core", "aon"; - - dmas = <&qpicbam 0>, - <&qpicbam 1>, - <&qpicbam 2>; - dma-names = "tx", "rx", "cmd"; - - #address-cells = <1>; - #size-cells = <0>; - - nand@0 { - reg = <0>; - nand-ecc-strength = <4>; - nand-bus-width = <8>; - - partitions { - compatible = "fixed-partitions"; - #address-cells = <1>; - #size-cells = <1>; - - partition@0 { - label = "boot-nand"; - reg = <0 0x58a0000>; - }; - - partition@58a0000 { - label = "fs-nand"; - reg = <0x58a0000 0x4000000>; - }; - }; - }; -}; From patchwork Fri Mar 19 15:00:09 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Manivannan Sadhasivam X-Patchwork-Id: 404796 Delivered-To: patch@linaro.org Received: by 2002:a02:8562:0:0:0:0:0 with SMTP id g89csp1450463jai; Fri, 19 Mar 2021 08:01:16 -0700 (PDT) X-Google-Smtp-Source: ABdhPJyIohhyudb3RIB39LTz8lyQm8vcr7ZUFACIr+8hvm2dUnwQSo9J0QkTrgUZGx3uD5sEjUX8 X-Received: by 2002:a17:906:c9c2:: with SMTP id hk2mr4907060ejb.244.1616166076328; Fri, 19 Mar 2021 08:01:16 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1616166076; cv=none; d=google.com; s=arc-20160816; b=0+i+3z1o//VhXq25HQmETwuBA6xi+8l3N58DZeaXYvjnhGhN1yNkFCd9Dey48DcqYT bDk40BO6tAwIAjCMjRkHa/cTjjivNuVrdmUglp18AQtfm6uZNJivalE8c3A2kYwsj4gi c/AzaJflsTHdxGTW5coV47NnfefUI8H2NZPV/BBmLtNkgA5OVyTbmnDU3loJwu3S9vCu jKcrj60K34VSxIU7dPrZPzveqMEnnwAfhxKodnfzBsQtPu6z8w1S5jbiiWZufQOXgjF/ +pRO+wE48Y5YDIL2AFzEtBmTI8YYYZM4MlF0VzCdFujqn+QrduMhU2IzDZdZY5SpjFG5 21Lg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=cGzmTTjWe1AbEuSBzNDXhCdxGNlI9I7Ym5rhNfsOEPE=; b=MUIjnBPCm8nN8bySETBe2IPqHoJ94covX+v5Dsuko7wE91UG+yc9YUmrCCLz3+ibjk E/tXw3Fnb/BEvbDtaqKduUyEpNMm745SPidgqpFlvpgdt9/w2TQzmdHKWf7+XFWRIdWs lxoMItdZRqB7CBQKoPqHdglsucPl/5/z2lWmWiY0QujmKp3x9OY2uKtXVuQPVRT70AOX +zbnbW+Mex+ES0/30uHqUdWcRappGARIn8Sp+mHD095OESnjRShR1KFFfpxKo4MEfkGE H/euh9VOTLo1zjizWL1VVJScadTZUpaFyHYBN0JikVtWcyE6YvHH/Fau3dMjct9qc+I9 S4yA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=ohvrJt68; spf=pass (google.com: domain of linux-arm-msm-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-arm-msm-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id jz18si4126546ejc.575.2021.03.19.08.01.15; Fri, 19 Mar 2021 08:01:16 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-arm-msm-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=ohvrJt68; spf=pass (google.com: domain of linux-arm-msm-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-arm-msm-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230308AbhCSPAm (ORCPT + 16 others); Fri, 19 Mar 2021 11:00:42 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:33722 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230477AbhCSPAh (ORCPT ); Fri, 19 Mar 2021 11:00:37 -0400 Received: from mail-pj1-x102a.google.com (mail-pj1-x102a.google.com [IPv6:2607:f8b0:4864:20::102a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 6C71AC06175F for ; Fri, 19 Mar 2021 08:00:37 -0700 (PDT) Received: by mail-pj1-x102a.google.com with SMTP id mz6-20020a17090b3786b02900c16cb41d63so5002254pjb.2 for ; Fri, 19 Mar 2021 08:00:37 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=cGzmTTjWe1AbEuSBzNDXhCdxGNlI9I7Ym5rhNfsOEPE=; b=ohvrJt68oUBNkBpQAKJcjO2bUbdF7woTHDFm5MbJb0YRsHlluRF1P47NUZjK+Mfriy vhedOAaoRdsWWXEABh7ctC4jxo2q3MnFOaAkNIJi6F3NtpowIbuKZMSdqOggmXSx0HHI XlIL8nsLCd7MDB7nn7FBrEmwrBngUdYX3sTf/OpEoREMSV2Ab+Lqn1OxuzoNeGp3RxWx 9sovfJ6xzlKoWFvFITeYW9RlMIxWvH8SE40OOpNmicQ5z5WnPljHnGDNyumQjcMhK2Va BqDk37lGlQsvlCEd0ZHcg/opa5w1PXo+q0jaxyd0FTxg4/ah4wi8OCBsm2N5obrZrOE8 uohw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=cGzmTTjWe1AbEuSBzNDXhCdxGNlI9I7Ym5rhNfsOEPE=; b=rQ66Rb6ukEWepujaYoPxosay7e6GA76sNvnxGhKPXbmILh38q6LQW4zOfl94/BfJeD 9xTwEqDt5HUdW+7Mjdd0llg6ndWbK1o/PwtyqeBm6O5+ut8keR9AF1dTl+X4qivyJk1D P6NIKwKMejzGYMLBp2KYVV2gFy3QZ2kz0TX0s1WAofR3fF6pzobhRcEAtuCXd46cNO22 Pm76des6YBOQiYQEjy1qrX7TZvZI4CtS9d+E66vyxdk9P72qCGd+5y4jL2nzhWwMsVBT iXpufqM5rgAkoDlkRKiF8iyo9J9mLuRGkRlibxqoHQhEAdWaa+Q5a+UIAj9ozp80SJxQ RSKQ== X-Gm-Message-State: AOAM530WED9BdNvM5D/HRs329yApMkq36foT9Qhn9kskWZqp99OnLDxo d1Crd5t5uxx2v/+MPZIJVTzS X-Received: by 2002:a17:902:f1c2:b029:e4:6c23:489f with SMTP id e2-20020a170902f1c2b02900e46c23489fmr15169667plc.62.1616166036933; Fri, 19 Mar 2021 08:00:36 -0700 (PDT) Received: from localhost.localdomain ([2409:4072:387:dba9:92f4:36c7:1aec:59de]) by smtp.gmail.com with ESMTPSA id h19sm6092345pfc.172.2021.03.19.08.00.30 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 19 Mar 2021 08:00:36 -0700 (PDT) From: Manivannan Sadhasivam To: miquel.raynal@bootlin.com, richard@nod.at, vigneshr@ti.com, robh+dt@kernel.org Cc: linux-arm-msm@vger.kernel.org, devicetree@vger.kernel.org, linux-mtd@lists.infradead.org, linux-kernel@vger.kernel.org, boris.brezillon@collabora.com, Daniele.Palmas@telit.com, bjorn.andersson@linaro.org, Manivannan Sadhasivam Subject: [PATCH v7 2/3] dt-bindings: mtd: Add a property to declare secure regions in NAND chips Date: Fri, 19 Mar 2021 20:30:09 +0530 Message-Id: <20210319150010.32122-3-manivannan.sadhasivam@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20210319150010.32122-1-manivannan.sadhasivam@linaro.org> References: <20210319150010.32122-1-manivannan.sadhasivam@linaro.org> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-arm-msm@vger.kernel.org On a typical end product, a vendor may choose to secure some regions in the NAND memory which are supposed to stay intact between FW upgrades. The access to those regions will be blocked by a secure element like Trustzone. So the normal world software like Linux kernel should not touch these regions (including reading). So let's add a property for declaring such secure regions so that the drivers can skip touching them. Signed-off-by: Manivannan Sadhasivam --- Documentation/devicetree/bindings/mtd/nand-controller.yaml | 7 +++++++ 1 file changed, 7 insertions(+) -- 2.25.1 diff --git a/Documentation/devicetree/bindings/mtd/nand-controller.yaml b/Documentation/devicetree/bindings/mtd/nand-controller.yaml index d0e422f4b3e0..678b39952502 100644 --- a/Documentation/devicetree/bindings/mtd/nand-controller.yaml +++ b/Documentation/devicetree/bindings/mtd/nand-controller.yaml @@ -143,6 +143,13 @@ patternProperties: Ready/Busy pins. Active state refers to the NAND ready state and should be set to GPIOD_ACTIVE_HIGH unless the signal is inverted. + secure-regions: + $ref: /schemas/types.yaml#/definitions/uint64-matrix + description: + Regions in the NAND chip which are protected using a secure element + like Trustzone. This property contains the start address and size of + the secure regions present. + required: - reg From patchwork Fri Mar 19 15:00:10 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Manivannan Sadhasivam X-Patchwork-Id: 404798 Delivered-To: patch@linaro.org Received: by 2002:a02:8562:0:0:0:0:0 with SMTP id g89csp1451114jai; Fri, 19 Mar 2021 08:01:46 -0700 (PDT) X-Google-Smtp-Source: ABdhPJwiwd3KwDe42lZ88SXWnTK8lNB8SXtaLgvDV0QE3Ab3JZ6TOl6wwTVU7vsqOXR/V5JbOcE9 X-Received: by 2002:a17:907:7799:: with SMTP id ky25mr4806597ejc.217.1616166106068; Fri, 19 Mar 2021 08:01:46 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1616166106; cv=none; d=google.com; s=arc-20160816; b=hJtoSpWHoebDrCkuxCndGdE4VcgZZkBX7nUoyvCh1coyCrLPKe6mryTsC5LXFjOsBb zIQCG437JHaLCHxEc5Aq33+a1UaExjl1C5c7/BxN0e5eNp/flmyc45qkTKeuB77ax85M CzXw0rvTodAJ+FlU/GaLIdyJMgstJlp1owjrV1/tOjfT0t2s4oss74QLcYyIy/SwvvMd F092TYqQEiy3sBNDa2kVKBAb6dGNaF+c+uEx2OJPzjWvg/37WcHIltngVn2TdKJO+CwF +ymh2PZfz27cMJV4EB3eECGCwo2Utor9VOE42d3CKwEe7zY2VWTordgHpvIEcE+Knw9r NzSA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=fmtK1MM67niOw8YSNL7HrH7t8pie08ljvyp28iFoaR4=; b=mcSX4wHMG+zwCaLlG8jQFQp7JG1OxOLvcfVOBmY2QwfklNDHOQOmylWygoUZYK58Un m0HOym+G9h2dHuL+MHpeDPr+nIbW4RNNHtlU1VdCT4I86LBJk5gggzxeJlaP9Jduzxnn qAJc/vP4UukZblbuk8oZSGXr0QnXWt2c5nFiemxN0x9EbndJ7bJxTjkeAstzsQSnIB/M Rg9673IesZ7wINzwwQYvLfxK5dROUCZNYvnn8vLLuDdaZfjx3Bfs4W5ZdPcdYL0Naht3 iXJLbkEqgwUHGsJj+nLTi214K+ShwhAmn/2MNBtwDcKcIpuKc0kt+hn2bpACkIM2bYUe YLxw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=wIFxEL3S; spf=pass (google.com: domain of linux-arm-msm-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-arm-msm-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id jz18si4126546ejc.575.2021.03.19.08.01.45; Fri, 19 Mar 2021 08:01:46 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-arm-msm-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=wIFxEL3S; spf=pass (google.com: domain of linux-arm-msm-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-arm-msm-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230205AbhCSPBO (ORCPT + 16 others); Fri, 19 Mar 2021 11:01:14 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:33750 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230492AbhCSPAn (ORCPT ); Fri, 19 Mar 2021 11:00:43 -0400 Received: from mail-pg1-x531.google.com (mail-pg1-x531.google.com [IPv6:2607:f8b0:4864:20::531]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 0F150C061760 for ; Fri, 19 Mar 2021 08:00:43 -0700 (PDT) Received: by mail-pg1-x531.google.com with SMTP id m3so3849946pga.1 for ; Fri, 19 Mar 2021 08:00:43 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=fmtK1MM67niOw8YSNL7HrH7t8pie08ljvyp28iFoaR4=; b=wIFxEL3S1U4oGGMe68lLz3PrqemfiHQfCvYTE/d9e7Tg5uGaeoOwC4TFhgfzXzfRSh D1FKPesmsULz9lgj27hrDdxKUSvXkg1vVZjH+3N00U1E+RQ7iom0gbWiGRlhdyxHvMIb mlMrVf7CaPZ39gjTl7LGwGVgJkOJZyV25myI33XlH3cxmdY4ClO8wm/vFRrbPrT77wpc j7o3BWjtDG+I7sqAgKU5zP7hUYCEq81GWg8LGX2Wtx8TAF/zTN3f5QySxi+/B/lYVKXY RYwUwPQJJTkP7SfATvz7trRDCm4psH0eMI/qubc5UHrOwZZ0y4rTHQDdhL12DvqlWsXa gxsg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=fmtK1MM67niOw8YSNL7HrH7t8pie08ljvyp28iFoaR4=; b=omJSc3xonE8FhPGud0gttWLCUIJ2fbgWjoOkb4rAoCWhbODWF3t+QabZVhaHo648AX pRpsAtuGtyVg6EW5s5/YJMj65KSmIx1OcMAJZqABkAoDnb3bCIue3h+Lu/hizXAB1kqZ iHc0iYkirT05M0xHOnEqCn7HjJo1dYE1PViv2xnBVPPW4YxHpkLiGxWYpYnxlupy7XM6 lc/0vvrnLjFwsmQwlIlOeY+IrP2fHZkIsho+TC13lijzKfmx4E++x+ZYy9/GazGmZJBC LQA0B4D2znmv00gQn4wrfFWsv6qQzwaIZeCEzUs0OrMVBVKGeSVVZClZrkieF4imeqLI AqAQ== X-Gm-Message-State: AOAM531OkAA4edfHFIo/853Q2fWzppWYlRSIqxm4j9yFAAUKDxvTA0PE Ix0RaWVEhnIuvHe8ceIN2Jln X-Received: by 2002:a63:e715:: with SMTP id b21mr11629664pgi.300.1616166042502; Fri, 19 Mar 2021 08:00:42 -0700 (PDT) Received: from localhost.localdomain ([2409:4072:387:dba9:92f4:36c7:1aec:59de]) by smtp.gmail.com with ESMTPSA id h19sm6092345pfc.172.2021.03.19.08.00.37 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 19 Mar 2021 08:00:42 -0700 (PDT) From: Manivannan Sadhasivam To: miquel.raynal@bootlin.com, richard@nod.at, vigneshr@ti.com, robh+dt@kernel.org Cc: linux-arm-msm@vger.kernel.org, devicetree@vger.kernel.org, linux-mtd@lists.infradead.org, linux-kernel@vger.kernel.org, boris.brezillon@collabora.com, Daniele.Palmas@telit.com, bjorn.andersson@linaro.org, Manivannan Sadhasivam Subject: [PATCH v7 3/3] mtd: rawnand: Add support for secure regions in NAND memory Date: Fri, 19 Mar 2021 20:30:10 +0530 Message-Id: <20210319150010.32122-4-manivannan.sadhasivam@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20210319150010.32122-1-manivannan.sadhasivam@linaro.org> References: <20210319150010.32122-1-manivannan.sadhasivam@linaro.org> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-arm-msm@vger.kernel.org On a typical end product, a vendor may choose to secure some regions in the NAND memory which are supposed to stay intact between FW upgrades. The access to those regions will be blocked by a secure element like Trustzone. So the normal world software like Linux kernel should not touch these regions (including reading). The regions are declared using a NAND chip DT property, "secure-regions". So let's make use of this property in the raw NAND core and skip access to the secure regions present in a system. Signed-off-by: Manivannan Sadhasivam --- drivers/mtd/nand/raw/nand_base.c | 111 +++++++++++++++++++++++++++++++ include/linux/mtd/rawnand.h | 4 ++ 2 files changed, 115 insertions(+) -- 2.25.1 diff --git a/drivers/mtd/nand/raw/nand_base.c b/drivers/mtd/nand/raw/nand_base.c index c33fa1b1847f..479a79e682cd 100644 --- a/drivers/mtd/nand/raw/nand_base.c +++ b/drivers/mtd/nand/raw/nand_base.c @@ -278,11 +278,47 @@ static int nand_block_bad(struct nand_chip *chip, loff_t ofs) return 0; } +/** + * nand_check_secure_region() - Check if the region is secured + * @chip: NAND chip object + * @offset: Offset of the region to check + * @size: Size of the region to check + * + * Checks if the region is secured by comparing the offset and size with the + * list of secure regions obtained from DT. Returns -EIO if the region is + * secured else 0. + */ +static int nand_check_secure_region(struct nand_chip *chip, loff_t offset, u64 size) +{ + int i, j; + + /* Skip touching the secure regions if present */ + for (i = 0, j = 0; i < chip->nr_secure_regions; i++, j += 2) { + /* First compare the start offset */ + if (offset >= chip->secure_regions[j] && + (offset < chip->secure_regions[j] + chip->secure_regions[j + 1])) + return -EIO; + /* ...then offset + size */ + else if (offset < chip->secure_regions[i] && + (offset + size) >= chip->secure_regions[i]) + return -EIO; + } + + return 0; +} + static int nand_isbad_bbm(struct nand_chip *chip, loff_t ofs) { + int ret; + if (chip->options & NAND_NO_BBM_QUIRK) return 0; + /* Check if the region is secured */ + ret = nand_check_secure_region(chip, ofs, 0); + if (ret) + return ret; + if (chip->legacy.block_bad) return chip->legacy.block_bad(chip, ofs); @@ -397,6 +433,11 @@ static int nand_do_write_oob(struct nand_chip *chip, loff_t to, return -EINVAL; } + /* Check if the region is secured */ + ret = nand_check_secure_region(chip, to, ops->ooblen); + if (ret) + return ret; + chipnr = (int)(to >> chip->chip_shift); /* @@ -565,6 +606,11 @@ static int nand_block_isreserved(struct mtd_info *mtd, loff_t ofs) if (!chip->bbt) return 0; + + /* Check if the region is secured */ + if (nand_check_secure_region(chip, ofs, 0)) + return -EIO; + /* Return info from the table */ return nand_isreserved_bbt(chip, ofs); } @@ -2737,6 +2783,11 @@ static int nand_read_page_swecc(struct nand_chip *chip, uint8_t *buf, uint8_t *ecc_code = chip->ecc.code_buf; unsigned int max_bitflips = 0; + /* Check if the region is secured */ + ret = nand_check_secure_region(chip, ((loff_t)page << chip->page_shift), 0); + if (ret) + return ret; + chip->ecc.read_page_raw(chip, buf, 1, page); for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) @@ -3127,6 +3178,11 @@ static int nand_do_read_ops(struct nand_chip *chip, loff_t from, int retry_mode = 0; bool ecc_fail = false; + /* Check if the region is secured */ + ret = nand_check_secure_region(chip, from, readlen); + if (ret) + return ret; + chipnr = (int)(from >> chip->chip_shift); nand_select_target(chip, chipnr); @@ -3458,6 +3514,11 @@ static int nand_do_read_oob(struct nand_chip *chip, loff_t from, pr_debug("%s: from = 0x%08Lx, len = %i\n", __func__, (unsigned long long)from, readlen); + /* Check if the region is secured */ + ret = nand_check_secure_region(chip, from, readlen); + if (ret) + return ret; + stats = mtd->ecc_stats; len = mtd_oobavail(mtd, ops); @@ -3709,6 +3770,11 @@ static int nand_write_page_swecc(struct nand_chip *chip, const uint8_t *buf, uint8_t *ecc_calc = chip->ecc.calc_buf; const uint8_t *p = buf; + /* Check if the region is secured */ + ret = nand_check_secure_region(chip, ((loff_t)page << chip->page_shift), 0); + if (ret) + return ret; + /* Software ECC calculation */ for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) chip->ecc.calculate(chip, p, &ecc_calc[i]); @@ -3979,6 +4045,11 @@ static int nand_do_write_ops(struct nand_chip *chip, loff_t to, return -EINVAL; } + /* Check if the region is secured */ + ret = nand_check_secure_region(chip, to, writelen); + if (ret) + return ret; + column = to & (mtd->writesize - 1); chipnr = (int)(to >> chip->chip_shift); @@ -4180,6 +4251,11 @@ int nand_erase_nand(struct nand_chip *chip, struct erase_info *instr, if (check_offs_len(chip, instr->addr, instr->len)) return -EINVAL; + /* Check if the region is secured */ + ret = nand_check_secure_region(chip, instr->addr, instr->len); + if (ret) + return ret; + /* Grab the lock and see if the device is available */ ret = nand_get_device(chip); if (ret) @@ -4995,10 +5071,32 @@ static bool of_get_nand_on_flash_bbt(struct device_node *np) return of_property_read_bool(np, "nand-on-flash-bbt"); } +static int of_get_nand_secure_regions(struct nand_chip *chip) +{ + struct device_node *dn = nand_get_flash_node(chip); + struct property *prop; + int length, nr_elem; + + prop = of_find_property(dn, "secure-regions", &length); + if (prop) { + nr_elem = length / sizeof(u64); + chip->nr_secure_regions = nr_elem / 2; + + chip->secure_regions = kcalloc(nr_elem, sizeof(*chip->secure_regions), GFP_KERNEL); + if (!chip->secure_regions) + return -ENOMEM; + + of_property_read_u64_array(dn, "secure-regions", chip->secure_regions, nr_elem); + } + + return 0; +} + static int rawnand_dt_init(struct nand_chip *chip) { struct nand_device *nand = mtd_to_nanddev(nand_to_mtd(chip)); struct device_node *dn = nand_get_flash_node(chip); + int ret; if (!dn) return 0; @@ -5015,6 +5113,16 @@ static int rawnand_dt_init(struct nand_chip *chip) of_get_nand_ecc_user_config(nand); of_get_nand_ecc_legacy_user_config(chip); + /* + * Look for secure regions in the NAND chip. These regions are supposed + * to be protected by a secure element like Trustzone. So the read/write + * accesses to these regions will be blocked in the runtime by this + * driver. + */ + ret = of_get_nand_secure_regions(chip); + if (!ret) + return ret; + /* * If neither the user nor the NAND controller have requested a specific * ECC engine type, we will default to NAND_ECC_ENGINE_TYPE_ON_HOST. @@ -6068,6 +6176,9 @@ void nand_cleanup(struct nand_chip *chip) /* Free manufacturer priv data. */ nand_manufacturer_cleanup(chip); + /* Free secure regions data */ + kfree(chip->secure_regions); + /* Free controller specific allocations after chip identification */ nand_detach(chip); diff --git a/include/linux/mtd/rawnand.h b/include/linux/mtd/rawnand.h index 6b3240e44310..d385c4fe8b0f 100644 --- a/include/linux/mtd/rawnand.h +++ b/include/linux/mtd/rawnand.h @@ -1086,6 +1086,8 @@ struct nand_manufacturer { * NAND Controller drivers should not modify this value, but they're * allowed to read it. * @read_retries: The number of read retry modes supported + * @secure_regions: Array representing the secure regions + * @nr_secure_regions: Number of secure regions * @controller: The hardware controller structure which is shared among multiple * independent devices * @ecc: The ECC controller structure @@ -1135,6 +1137,8 @@ struct nand_chip { unsigned int suspended : 1; int cur_cs; int read_retries; + u64 *secure_regions; + u8 nr_secure_regions; /* Externals */ struct nand_controller *controller;