From patchwork Thu Feb 20 10:52:44 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Marek Szyprowski X-Patchwork-Id: 25006 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-ob0-f198.google.com (mail-ob0-f198.google.com [209.85.214.198]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 631ED2066E for ; Thu, 20 Feb 2014 10:53:42 +0000 (UTC) Received: by mail-ob0-f198.google.com with SMTP id vb8sf5084479obc.5 for ; Thu, 20 Feb 2014 02:53:41 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:delivered-to:from:to:date:message-id:in-reply-to :references:cc:subject:precedence:list-id:list-unsubscribe :list-archive:list-post:list-help:list-subscribe:mime-version :errors-to:sender:x-original-sender :x-original-authentication-results:mailing-list:content-type :content-transfer-encoding; bh=+h3a9wY6tD7bmmJvetUDaoTkl0agHQrzjHC23oMm4Qc=; b=Spg5eDcKE4NFvtsYlyyviJKdzFxW0vFdw7S+6uyESZuZQ8zGII5+NQSLN8tCt70IKU imO4fCMEkXxkJGZ9V8Y/ag+3MPrTsEhVPQwBYrjrQpf/BbPScvAic/z9FEGVi53k8Gbf OFH1xeTJ24P+niq3cCA55wlxYxXtrC8Up1zpxLivM/sQl9dpjPJ9djISQjPWu5/KDegR EJq7zyqBCkfQJIyL5YPeFSRtAY3OHieLhXeQLAzrY08g97d0q1xcsedgEc3rs0ErEnzq YFADuATvebSmvED8VwoD35aZXsEDDEdwfeUbvpwHVOZyiHfl8YU6NPmR8FBE+w2GGaWa PXhg== X-Gm-Message-State: ALoCoQmehBZLw/Y+0AvyvwrhobfVG/HEdLzIqZSbNgYLwo2Z5ThIENlVm2Tfr5V7ryfzOWR3dcSa X-Received: by 10.182.87.2 with SMTP id t2mr487190obz.2.1392893621843; Thu, 20 Feb 2014 02:53:41 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.140.21.136 with SMTP id 8ls434963qgl.27.gmail; Thu, 20 Feb 2014 02:53:41 -0800 (PST) X-Received: by 10.52.65.207 with SMTP id z15mr481714vds.61.1392893621699; Thu, 20 Feb 2014 02:53:41 -0800 (PST) Received: from mail-vc0-f178.google.com (mail-vc0-f178.google.com [209.85.220.178]) by mx.google.com with ESMTPS id gq1si1318195vec.23.2014.02.20.02.53.41 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Thu, 20 Feb 2014 02:53:41 -0800 (PST) Received-SPF: neutral (google.com: 209.85.220.178 is neither permitted nor denied by best guess record for domain of patch+caf_=patchwork-forward=linaro.org@linaro.org) client-ip=209.85.220.178; Received: by mail-vc0-f178.google.com with SMTP id ik5so1689404vcb.37 for ; Thu, 20 Feb 2014 02:53:41 -0800 (PST) X-Received: by 10.221.26.10 with SMTP id rk10mr668803vcb.0.1392893621590; Thu, 20 Feb 2014 02:53:41 -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.220.174.196 with SMTP id u4csp48391vcz; Thu, 20 Feb 2014 02:53:41 -0800 (PST) X-Received: by 10.181.13.40 with SMTP id ev8mr1910995wid.16.1392893620362; Thu, 20 Feb 2014 02:53:40 -0800 (PST) Received: from ip-10-141-164-156.ec2.internal (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTPS id gn3si2877435wib.77.2014.02.20.02.53.39 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Thu, 20 Feb 2014 02:53:40 -0800 (PST) Received-SPF: pass (google.com: best guess record for domain of linaro-mm-sig-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) client-ip=54.225.227.206; Received: from localhost ([127.0.0.1] helo=ip-10-141-164-156.ec2.internal) by ip-10-141-164-156.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1WGREn-0007W9-UJ; Thu, 20 Feb 2014 10:52:17 +0000 Received: from mailout4.w1.samsung.com ([210.118.77.14]) by ip-10-141-164-156.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1WGREM-0007TQ-J1 for linaro-mm-sig@lists.linaro.org; Thu, 20 Feb 2014 10:51:50 +0000 Received: from eucpsbgm2.samsung.com (unknown [203.254.199.245]) by mailout4.w1.samsung.com (Oracle Communications Messaging Server 7u4-24.01(7.0.4.24.0) 64bit (built Nov 17 2011)) with ESMTP id <0N1A00E7AJKC6800@mailout4.w1.samsung.com> for linaro-mm-sig@lists.linaro.org; Thu, 20 Feb 2014 10:53:01 +0000 (GMT) X-AuditID: cbfec7f5-b7fc96d000004885-2a-5305de8b54d6 Received: from eusync2.samsung.com ( [203.254.199.212]) by eucpsbgm2.samsung.com (EUCPMTA) with SMTP id EA.C1.18565.B8ED5035; Thu, 20 Feb 2014 10:52:59 +0000 (GMT) Received: from amdc1339.mshome.net ([106.116.147.30]) by eusync2.samsung.com (Oracle Communications Messaging Server 7u4-23.01 (7.0.4.23.0) 64bit (built Aug 10 2011)) with ESMTPA id <0N1A005WSJK1HXB0@eusync2.samsung.com>; Thu, 20 Feb 2014 10:52:59 +0000 (GMT) From: Marek Szyprowski To: linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org, linaro-mm-sig@lists.linaro.org, devicetree@vger.kernel.org, linux-doc@vger.kernel.org Date: Thu, 20 Feb 2014 11:52:44 +0100 Message-id: <1392893567-31623-5-git-send-email-m.szyprowski@samsung.com> X-Mailer: git-send-email 1.7.9.5 In-reply-to: <1392893567-31623-1-git-send-email-m.szyprowski@samsung.com> References: <1392893567-31623-1-git-send-email-m.szyprowski@samsung.com> X-Brightmail-Tracker: H4sIAAAAAAAAAyXRW0iTYRwG8N5v3/ftczT4XFZvIhKDKAoPCy/ewg434SthBV4kQdTU4YzN w+ZEhcg8ofO0FuHwvHRBwxPLPIxKnVNHWrg2HKVOSi/STZvMYOgmsbz7wfN/eC7+DEfwgoxm cvOKJIo8sUxI88j5wzlnXL2bSk/8NHQahbSzXOSrqOagP28aAOqyfqVQs1dPocngGEDexloS jQ/sAPSlwstFo3U6Ltpz/iSQaX2JQvqaXhI5zO006reuctHQ5hSBDC47gbrnqigUbIlFn11+ GvVZe7hI09JPouqPVi4KjZpItDVVQ6JBnYdERnMQoM1dG3kzBvd19gF8sK8F2PNSA7CjqZHA 462rXNzgraKwyVhH45WlDzR+1/sMLx+uc7DTVkHhgeAWgZtDibjD3ARw07ARYL8p9l7kA15y tkSWWyxRJFx/zJNOTlQSBTZRiX3nOVkOps+rQQQD2SQYch5QRz4FF92DtBrwGAFrANC9u0+E AwFbT8DQ6+iwaVYE1dtqOuwoVg+gv5MMFzjsGg1r7Q3/CyfYFKgOuThhk+w5+CswA9SAYfgs hj2OS2FC9ixs1yaHLyLYVFjpXqWOpjA0tzooDeB3g2NGcFKiyipQZubIL8crxXKlKi8nPitf bgJHb/w7BgyzVy2AZYDwOD/DRaYLKHGxslRuAZDhCKP4I9+pdAE/W1xaJlHkP1KoZBKlBRBM RHQ5MLA21XDl2PIPQfOGLjCtOwzMq6893Hu1J89smxENZkvhSvsd7e2EEbLN9vZb143CpNSR Ao8VpUi3cxe4he83fFe2Mpzi8l1fispyq6wo7UlatEXsU60pFi9EPr37+0xMFMVL6Nhc0gb2 Qzl2o6zFc79E8yiusU4/seAO+YWkUioWXeQolOJ/YIYPQ6QCAAA= Cc: Mark Rutland , Benjamin Herrenschmidt , Tomasz Figa , Will Deacon , Tomasz Figa , Paul Mackerras , Arnd Bergmann , Josh Cartwright , Catalin Marinas , Grant Likely , Ian Campbell , Pawel Moll , Stephen Warren , Sascha Hauer , Michal Nazarewicz , Rob Herring , Kumar Gala , Olof Johansson Subject: [Linaro-mm-sig] [PATCH v4 4/7] of: document bindings for reserved-memory nodes X-BeenThere: linaro-mm-sig@lists.linaro.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: , List-Help: , List-Subscribe: , MIME-Version: 1.0 Errors-To: linaro-mm-sig-bounces@lists.linaro.org Sender: linaro-mm-sig-bounces@lists.linaro.org X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: m.szyprowski@samsung.com X-Original-Authentication-Results: mx.google.com; spf=neutral (google.com: 209.85.220.178 is neither permitted nor denied by best guess record for domain of patch+caf_=patchwork-forward=linaro.org@linaro.org) 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 From: Grant Likely Reserved memory nodes allow for the reservation of static (fixed address) regions, or dynamically allocated regions for a specific purpose. Signed-off-by: Grant Likely [joshc: Based on binding document proposed (in non-patch form) here: http://lkml.kernel.org/g/20131030134702.19B57C402A0@trevor.secretlab.ca adapted to support #memory-region-cells] Signed-off-by: Josh Cartwright Signed-off-by: Marek Szyprowski --- .../bindings/reserved-memory/reserved-memory.txt | 138 ++++++++++++++++++++ 1 file changed, 138 insertions(+) create mode 100644 Documentation/devicetree/bindings/reserved-memory/reserved-memory.txt diff --git a/Documentation/devicetree/bindings/reserved-memory/reserved-memory.txt b/Documentation/devicetree/bindings/reserved-memory/reserved-memory.txt new file mode 100644 index 000000000000..a606ce90c9c4 --- /dev/null +++ b/Documentation/devicetree/bindings/reserved-memory/reserved-memory.txt @@ -0,0 +1,138 @@ +*** Reserved memory regions *** + +Reserved memory is specified as a node under the /reserved-memory node. +The operating system shall exclude reserved memory from normal usage +one can create child nodes describing particular reserved (excluded from +normal use) memory regions. Such memory regions are usually designed for +the special usage by various device drivers. + +Parameters for each memory region can be encoded into the device tree +with the following nodes: + +/reserved-memory node +--------------------- +#address-cells, #size-cells (required) - standard definition + - Should use the same values as the root node +#memory-region-cells (required) - dictates number of cells used in the child + nodes memory-region specifier +ranges (required) - standard definition + - Should be empty + +/reserved-memory/ child nodes +----------------------------- +Each child of the reserved-memory node specifies one or more regions of +reserved memory. Each child node may either use a 'reg' property to +specify a specific range of reserved memory, or a 'size' property with +optional constraints to request a dynamically allocated block of memory. + +Following the generic-names recommended practice, node names should +reflect the purpose of the node (ie. "framebuffer" or "dma-pool"). Unit +address (@
) should be appended to the name if the node is a +static allocation. + +Properties: +Requires either a) or b) below. +a) static allocation + reg (required) - standard definition +b) dynamic allocation + size (required) - length based on parent's #size-cells + - Size in bytes of memory to reserve. + alignment (optional) - length based on parent's #size-cells + - Address boundary for alignment of allocation. + alloc-ranges (optional) - prop-encoded-array (address, length pairs). + - Specifies regions of memory that are + acceptable to allocate from. + +If both reg and size are present, then the reg property takes precedence +and size is ignored. + +Additional properties: +compatible (optional) - standard definition + - may contain the following strings: + - shared-dma-pool: This indicates a region of memory meant to be + used as a shared pool of DMA buffers for a set of devices. It can + be used by an operating system to instanciate the necessary pool + management subsystem if necessary. + - vendor specific string in the form ,[-] +no-map (optional) - empty property + - Indicates the operating system must not create a virtual mapping + of the region as part of its standard mapping of system memory, + nor permit speculative access to it under any circumstances other + than under the control of the device driver using the region. +reusable (optional) - empty property + - The operating system can use the memory in this region with the + limitation that the device driver(s) owning the region need to be + able to reclaim it back. Typically that means that the operating + system can use that region to store volatile or cached data that + can be otherwise regenerated or migrated elsewhere. + +Linux implementation note: +- If a "linux,cma-default" property is present, then Linux will use the + region for the default pool of the contiguous memory allocator. + +Device node references to reserved memory +----------------------------------------- +Regions in the /reserved-memory node may be referenced by other device +nodes by adding a memory-region property to the device node. + +memory-region (optional) - phandle, specifier pairs to children of /reserved-memory + +Example +------- +This example defines 3 contiguous regions are defined for Linux kernel: +one default of all device drivers (named linux,cma@72000000 and 64MiB in size), +one dedicated to the framebuffer device (named framebuffer@78000000, 8MiB), and +one for multimedia processing (named multimedia-memory@77000000, 64MiB). + +/ { + #address-cells = <1>; + #size-cells = <1>; + + memory { + reg = <0x40000000 0x40000000>; + }; + + reserved-memory { + #address-cells = <1>; + #size-cells = <1>; + ranges; + + /* global autoconfigured region for contiguous allocations */ + linux,cma { + compatible = "shared-dma-pool"; + reusable; + #memory-region-cells = <0>; + size = <0x4000000>; + alignment = <0x2000>; + linux,cma-default; + }; + + display_reserved: framebuffer@78000000 { + #memory-region-cells = <0>; + reg = <0x78000000 0x800000>; + }; + + multimedia_reserved: multimedia@77000000 { + compatible = "acme,multimedia-memory"; + #memory-region-cells = <1>; + reg = <0x77000000 0x4000000>; + }; + }; + + /* ... */ + + fb0: video@12300000 { + memory-region = <&display_reserved>; + /* ... */ + }; + + scaler: scaler@12500000 { + memory-region = <&multimedia_reserved 0xdeadbeef>; + /* ... */ + }; + + codec: codec@12600000 { + memory-region = <&multimedia_reserved 0xfeebdaed>; + /* ... */ + }; +};