From patchwork Fri Feb 28 13:42:46 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Marek Szyprowski X-Patchwork-Id: 25550 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-vc0-f199.google.com (mail-vc0-f199.google.com [209.85.220.199]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id CF8FE20543 for ; Fri, 28 Feb 2014 13:43:21 +0000 (UTC) Received: by mail-vc0-f199.google.com with SMTP id hu8sf1533767vcb.6 for ; Fri, 28 Feb 2014 05:43:21 -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=8gRcBL0yFJFL5jSRvSWxG12IB1Nsc8gVgvfwH7OxRK8=; b=H74tvyp3I56JYFVqYJ49MSgBfQgQJWJjQRFygWDdjsZumxjpDNCLYSVqA0OLx+5Up+ jA5r5Uh0FPQtgwtPmbUVxk/Fbx4LvL4ituXp71bkOi5B3CdaqhDosq8G69C2NegvnU1+ ngc+KipGJ+UaOhxQPzIJP1cUPKAJ7rqbsSow3E58XnkGPnUzKBykX0CEfjv1Bx3A4smu yLmS1xNTFVpCB8AO4yjvVxBck8S7aR8kfgdUBg/gxA5c4jcnwohdq/A/NUWTi9+SvR+O WKvrWuF0p0bR98rnaVyniXgzmbQW7HZHfCq9unPLUDId9PLgcVQFVmjSci6K5XCT9E6t +30w== X-Gm-Message-State: ALoCoQmgn9LUC6xxvhPW8zEHOEJLrpSHhgRKkAd4OUodVZV+UVSPYpop+VKDUQ149fFdtzqqcReo X-Received: by 10.236.16.78 with SMTP id g54mr1093041yhg.33.1393595001573; Fri, 28 Feb 2014 05:43:21 -0800 (PST) MIME-Version: 1.0 X-BeenThere: patchwork-forward@linaro.org Received: by 10.140.41.85 with SMTP id y79ls1013033qgy.92.gmail; Fri, 28 Feb 2014 05:43:21 -0800 (PST) X-Received: by 10.58.190.99 with SMTP id gp3mr2594517vec.32.1393595001425; Fri, 28 Feb 2014 05:43:21 -0800 (PST) Received: from mail-vc0-f172.google.com (mail-vc0-f172.google.com [209.85.220.172]) by mx.google.com with ESMTPS id ov9si1778036vcb.121.2014.02.28.05.43.21 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Fri, 28 Feb 2014 05:43:21 -0800 (PST) Received-SPF: neutral (google.com: 209.85.220.172 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.172; Received: by mail-vc0-f172.google.com with SMTP id lf12so733877vcb.3 for ; Fri, 28 Feb 2014 05:43:21 -0800 (PST) X-Received: by 10.58.172.132 with SMTP id bc4mr175001vec.45.1393595001314; Fri, 28 Feb 2014 05:43:21 -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.130.193 with SMTP id u1csp54563vcs; Fri, 28 Feb 2014 05:43:20 -0800 (PST) X-Received: by 10.69.2.2 with SMTP id bk2mr3462262pbd.75.1393594999672; Fri, 28 Feb 2014 05:43:19 -0800 (PST) Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id n8si2070425pab.319.2014.02.28.05.43.18; Fri, 28 Feb 2014 05:43:19 -0800 (PST) Received-SPF: pass (google.com: best guess record for domain of devicetree-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752392AbaB1NnQ (ORCPT + 9 others); Fri, 28 Feb 2014 08:43:16 -0500 Received: from mailout2.w1.samsung.com ([210.118.77.12]:18776 "EHLO mailout2.w1.samsung.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752200AbaB1NnM (ORCPT ); Fri, 28 Feb 2014 08:43:12 -0500 Received: from eucpsbgm1.samsung.com (unknown [203.254.199.244]) by mailout2.w1.samsung.com (Oracle Communications Messaging Server 7u4-24.01(7.0.4.24.0) 64bit (built Nov 17 2011)) with ESMTP id <0N1P00HZWKRSYH70@mailout2.w1.samsung.com>; Fri, 28 Feb 2014 13:43:04 +0000 (GMT) X-AuditID: cbfec7f4-b7f796d000005a13-f9-5310926cb61e Received: from eusync3.samsung.com ( [203.254.199.213]) by eucpsbgm1.samsung.com (EUCPMTA) with SMTP id DB.45.23059.C6290135; Fri, 28 Feb 2014 13:43:08 +0000 (GMT) Received: from amdc1339.mshome.net ([106.116.147.30]) by eusync3.samsung.com (Oracle Communications Messaging Server 7u4-23.01 (7.0.4.23.0) 64bit (built Aug 10 2011)) with ESMTPA id <0N1P002ZJKROU750@eusync3.samsung.com>; Fri, 28 Feb 2014 13:43:08 +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 Cc: Marek Szyprowski , Benjamin Herrenschmidt , Arnd Bergmann , Michal Nazarewicz , Grant Likely , Tomasz Figa , Sascha Hauer , Laura Abbott , Rob Herring , Olof Johansson , Pawel Moll , Mark Rutland , Stephen Warren , Ian Campbell , Tomasz Figa , Kumar Gala , Nishanth Peethambaran , Marc , Josh Cartwright , Catalin Marinas , Will Deacon , Paul Mackerras Subject: [PATCH v6 01/11] of: document bindings for reserved-memory nodes Date: Fri, 28 Feb 2014 14:42:46 +0100 Message-id: <1393594976-16728-2-git-send-email-m.szyprowski@samsung.com> X-Mailer: git-send-email 1.7.9.5 In-reply-to: <1393594976-16728-1-git-send-email-m.szyprowski@samsung.com> References: <1393594976-16728-1-git-send-email-m.szyprowski@samsung.com> X-Brightmail-Tracker: H4sIAAAAAAAAAyWRa0hTYRzGfc/ObcPRcS05SYxaRBFoM6LeyiKD8LUviUZgSbp0qLGp7TTR QhpLTedtzEJTmxM1YaiLFXiPlOWsUSheFti0vEC6pZmiXabl8NuP//P783x4aJ6oAg+h0zPu KtQZcqWUFODOLcd4qNLIxMnezZ2Gm8ZBCv7QFfDg8vNSAOvtHwlY4W0g4BtfJ4DesiIcdrUv AfhB56VgR3E1BdfGvmLQNjtBwIbCJhyOdteRsM3upuCLhX4MNrtGMGh25BPQVyWB712rJGy1 N1LQUNWGw4I+OwU3O2w4XOwvxKG12oNDS7cPwIWVIfzCPtRqagXo7x8jQJ5KA0Cj5WUY6qpx U6jUm08gm6WYRJ8nekn0sukBmtya5aGxIR2B2n2LGKrYlKFn3eUAlb+yALRqk8QEXRdEpCiU 6dkK9bHzSYI0c009nrUoy5mxeigtMB7WAz7NMidYz5dJfIeD2eEpK6kHAlrENAPWbfEBfyBi SjDWYcrzM8mEs/rvetLPYqYBsKsm3P/AY6ZJtmikFPMHu5lodqOwZZtpGmcOsbNL8XpA0UIG sWUH/UeW2c/WGSP8Ln/b1VZNEztFiJ385QIGIDSDAAvYo9AkZ3G3UlXhYZxcxWkyUsOSM1U2 sDPiWidoHDwzABgaSAOFhuhdcSJCns3lqgYAS/OkYuGcjokTCVPkufcU6sxEtUap4AYARvND tOByXnxCkrn4aex6rMRpNiVeiolUUp86JVemAmTyhJPHN7QHWiKrY0OXvwWuzztub2hnrr6e P4LzbzjlvVuPuCDT2X8aX/BNUnjuYl9UkbPHMe4er4wqsIrravfmzPBrt0UJ7brzOPXJ25Ws ten1nw/F90t+Xxseiusxn6rUp0txLk0efpSn5uT/AW3hekqiAgAA Sender: devicetree-owner@vger.kernel.org Precedence: list List-ID: X-Mailing-List: devicetree@vger.kernel.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.172 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 List-Post: , List-Help: , List-Archive: List-Unsubscribe: , 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 [mszyprow: removed #memory-region-cells property] Signed-off-by: Marek Szyprowski --- .../bindings/reserved-memory/reserved-memory.txt | 136 ++++++++++++++++++++ 1 file changed, 136 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..8b0d747a38e7 --- /dev/null +++ b/Documentation/devicetree/bindings/reserved-memory/reserved-memory.txt @@ -0,0 +1,136 @@ +*** 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 +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>; + /* ... */ + }; +};