From patchwork Fri Mar 23 08:12:09 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Oliver O'Halloran X-Patchwork-Id: 10302905 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 E69F7600F6 for ; Fri, 23 Mar 2018 08:12:37 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id D8A5A28ABC for ; Fri, 23 Mar 2018 08:12:37 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id CCFD528AED; Fri, 23 Mar 2018 08:12:37 +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=-1.8 required=2.0 tests=BAYES_00, DKIM_ADSP_CUSTOM_MED, DKIM_SIGNED, FREEMAIL_FROM, RCVD_IN_DNSWL_NONE, T_DKIM_INVALID autolearn=no version=3.3.1 Received: from ml01.01.org (ml01.01.org [198.145.21.10]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id 996FE28ABC for ; Fri, 23 Mar 2018 08:12:37 +0000 (UTC) Received: from [127.0.0.1] (localhost [IPv6:::1]) by ml01.01.org (Postfix) with ESMTP id A430B22551BB5; Fri, 23 Mar 2018 01:06:04 -0700 (PDT) X-Original-To: linux-nvdimm@lists.01.org Delivered-To: linux-nvdimm@lists.01.org Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=2607:f8b0:400e:c00::242; helo=mail-pf0-x242.google.com; envelope-from=oohall@gmail.com; receiver=linux-nvdimm@lists.01.org Received: from mail-pf0-x242.google.com (mail-pf0-x242.google.com [IPv6:2607:f8b0:400e:c00::242]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 1D60E225B02BC for ; Fri, 23 Mar 2018 01:06:03 -0700 (PDT) Received: by mail-pf0-x242.google.com with SMTP id y186so4450526pfb.2 for ; Fri, 23 Mar 2018 01:12:35 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=/EZGlDXJ8j0mcmeud2ubkmNc3x8F7+NFN8VZRaJiACk=; b=Kn5ePw84fckyb5PwdcSSRDPK31zEGfXZGUFkmCB6uVkTh6jxDcOnD6ePmoUdgRq4b/ t6GZhqtt3XtaHcaUiBh6SJrEyv9o4hMUyauOblGFn146IvqgTXSb59Nj0i95LEXvNLWv qd4alMg4ciF0/PARwTYjuIksiHZYKJYmupNU+VCQF532eb79WaPhzdzwNFl2CwIt/fra sdJ8lOIb16wfYrEJncQmSqcza/5fihT1bam0PbkwYKnFX7bPYm7KJ7Hr/RePFGLlUnxJ SoUZ9QwxVCqW3vcWYRj5loAZlObyRqzGx7swlz1jpKZiIEi+4boZH2ZpLZ+L5OWDcVLK NHew== 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; bh=/EZGlDXJ8j0mcmeud2ubkmNc3x8F7+NFN8VZRaJiACk=; b=Mk/U6OjPF5LsNu9tgZPjMjpv3yLYD7sbDzKZOUj/v9hmA4nxvNYFsfMSXTGj6yu9AV zLgjM6F337xetn/5wqv3AolqHw1Sx4gtmhVoIk18z3s3aJjw+oCub93cMxREoAqxmAqH 3L5BP7ENOz9dI+mcyF4W7Tyxtvb4n0zCBejV0W41oCRMNjkhlCRrdg/srxLGEQ86Xwpw ktonP/EjNM7Q8UkkxQglFYXYETeFp0XeuuuwYK/8N+kOr3W/I2MnWtWBfoF62OXZv1Q1 pZf+XNbfXaDTuNMSsACKtx17dJkCzIqxlc3zo7fPA6boh0qsl+i3ym2tBlod/Ueu8mDT 9oVQ== X-Gm-Message-State: AElRT7FX2xJ5r2n5YTtCqbBskqQGLXUM+suHK93ET07cRO2CtU0vIjlr woV9A6kEUKYPQ6MApGCcgT6NNQ== X-Google-Smtp-Source: AG47ELvBoQmhTltykyz4xsICKrIQpY5NxRH93YpOLSc5ce1CAt6GMWleJPipqgmw817LOjmYt8cZoA== X-Received: by 10.99.132.72 with SMTP id k69mr20358464pgd.367.1521792755540; Fri, 23 Mar 2018 01:12:35 -0700 (PDT) Received: from localhost.localdomain ([203.220.205.233]) by smtp.gmail.com with ESMTPSA id q67sm7474808pfg.39.2018.03.23.01.12.33 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Fri, 23 Mar 2018 01:12:35 -0700 (PDT) From: Oliver O'Halloran To: linux-nvdimm@lists.01.org Subject: [PATCH 6/6] doc/devicetree: NVDIMM region documentation Date: Fri, 23 Mar 2018 19:12:09 +1100 Message-Id: <20180323081209.31387-6-oohall@gmail.com> X-Mailer: git-send-email 2.9.5 In-Reply-To: <20180323081209.31387-1-oohall@gmail.com> References: <20180323081209.31387-1-oohall@gmail.com> X-BeenThere: linux-nvdimm@lists.01.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "Linux-nvdimm developer list." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: devicetree@vger.kernel.org, linuxppc-dev@lists.ozlabs.org MIME-Version: 1.0 Errors-To: linux-nvdimm-bounces@lists.01.org Sender: "Linux-nvdimm" X-Virus-Scanned: ClamAV using ClamSMTP Add device-tree binding documentation for the nvdimm region driver. Cc: devicetree@vger.kernel.org Signed-off-by: Oliver O'Halloran --- .../devicetree/bindings/nvdimm/nvdimm-region.txt | 45 ++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 Documentation/devicetree/bindings/nvdimm/nvdimm-region.txt diff --git a/Documentation/devicetree/bindings/nvdimm/nvdimm-region.txt b/Documentation/devicetree/bindings/nvdimm/nvdimm-region.txt new file mode 100644 index 000000000000..02091117ff16 --- /dev/null +++ b/Documentation/devicetree/bindings/nvdimm/nvdimm-region.txt @@ -0,0 +1,45 @@ +Device-tree bindings for NVDIMM memory regions +----------------------------------------------------- + +Non-volatile DIMMs are memory modules used to provide (cacheable) main memory +that retains its contents across power cycles. In more practical terms, they +are kind of storage device where the contents can be accessed by the CPU +directly, rather than indirectly via a storage controller or similar. The an +nvdimm-region specifies a physical address range that is hosted on an NVDIMM +device. + +Bindings for the region nodes: +----------------------------- + +Required properties: + - compatible = "nvdimm-region" + + - reg = ; + The system physical address range of this nvdimm region. + +Optional properties: + - Any relevant NUMA assocativity properties for the target platform. + - A "volatile" property indicating that this region is actually in + normal DRAM and does not require cache flushes after each write. + +A complete example: +-------------------- + +/ { + #size-cells = <2>; + #address-cells = <2>; + + platform { + region@5000 { + compatible = "nvdimm-region; + reg = <0x00000001 0x00000000 0x00000000 0x40000000> + + }; + + region@6000 { + compatible = "nvdimm-region"; + reg = <0x00000001 0x00000000 0x00000000 0x40000000> + volatile; + }; + }; +};