From patchwork Thu Sep 8 12:07:28 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Henry Wang X-Patchwork-Id: 12969998 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id DD16BC54EE9 for ; Thu, 8 Sep 2022 12:07:55 +0000 (UTC) Received: from list by lists.xenproject.org with outflank-mailman.403281.645338 (Exim 4.92) (envelope-from ) id 1oWGJp-0000Ux-AQ; Thu, 08 Sep 2022 12:07:41 +0000 X-Outflank-Mailman: Message body and most headers restored to incoming version Received: by outflank-mailman (output) from mailman id 403281.645338; Thu, 08 Sep 2022 12:07:41 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1oWGJp-0000Uq-7j; Thu, 08 Sep 2022 12:07:41 +0000 Received: by outflank-mailman (input) for mailman id 403281; Thu, 08 Sep 2022 12:07:39 +0000 Received: from se1-gles-sth1-in.inumbo.com ([159.253.27.254] helo=se1-gles-sth1.inumbo.com) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1oWGJn-0000Uk-CT for xen-devel@lists.xenproject.org; Thu, 08 Sep 2022 12:07:39 +0000 Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by se1-gles-sth1.inumbo.com (Halon) with ESMTP id d4a13726-2f6e-11ed-a31c-8f8a9ae3403f; Thu, 08 Sep 2022 14:07:38 +0200 (CEST) Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id AE54214BF; Thu, 8 Sep 2022 05:07:43 -0700 (PDT) Received: from entos-skylake.shanghai.arm.com (entos-skylake.shanghai.arm.com [10.169.212.207]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPA id 53A653F71A; Thu, 8 Sep 2022 05:07:35 -0700 (PDT) X-BeenThere: xen-devel@lists.xenproject.org List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Errors-To: xen-devel-bounces@lists.xenproject.org Precedence: list Sender: "Xen-devel" X-Inumbo-ID: d4a13726-2f6e-11ed-a31c-8f8a9ae3403f From: Henry Wang To: xen-devel@lists.xenproject.org Cc: Henry Wang , Stefano Stabellini , Julien Grall , Bertrand Marquis , Volodymyr Babchuk Subject: [PATCH] docs/device-tree: Place the static-heap dt-binding in proper place Date: Thu, 8 Sep 2022 12:07:28 +0000 Message-Id: <20220908120728.8290-1-Henry.Wang@arm.com> X-Mailer: git-send-email 2.17.1 The static-heap dt-binding should be placed after the last feature, namely static-evtchn. Fixes: 4596329291f5 ("docs, xen/arm: Introduce static heap memory") Signed-off-by: Henry Wang Acked-by: Julien Grall --- docs/misc/arm/device-tree/booting.txt | 86 +++++++++++++-------------- 1 file changed, 43 insertions(+), 43 deletions(-) diff --git a/docs/misc/arm/device-tree/booting.txt b/docs/misc/arm/device-tree/booting.txt index 5395a1077c..93bf6fe577 100644 --- a/docs/misc/arm/device-tree/booting.txt +++ b/docs/misc/arm/device-tree/booting.txt @@ -425,49 +425,6 @@ The static event channel node has the following properties: link-to-foreign-evtchn is a single phandle to a remote evtchn to which local-evtchn will be connected. -Static Heap Memory -================== - -The static heap memory refers to parts of RAM reserved in the beginning of -boot time for heap. The memory is reserved by configuration in the device -tree using physical address ranges. - -The static heap memory declared in the device tree defines the memory areas -that will be reserved to be used exclusively as heap. - -- For Arm32, since there are separated heaps, the static heap will be used -for both domheap and xenheap. The admin should make sure that the static -heap region should contain enough memory below 4GB to cater 32-bit DMA. - -- For Arm64, since there is a single heap, the defined static heap areas -shall always go to the heap allocator. - -The static heap memory is an optional feature and can be enabled by adding -below device tree property. - -- xen,static-heap - - Property under the top-level "chosen" node. It specifies the address - and size of Xen static heap memory. Number of address and size cells - for the "xen,static-heap" property is determined by the root node - "#address-cells" and "#size-cells". Note that at least a 64KB alignment - is required. - -Below is an example on how to specify the static heap in device tree: - - / { - #address-cells = <0x2>; - #size-cells = <0x2>; - ... - chosen { - xen,static-heap = <0x0 0x30000000 0x0 0x40000000>; - ... - }; - }; - -RAM starting from the host physical address 0x30000000 of 1GB size will -be reserved as static heap. - Example ======= @@ -523,3 +480,46 @@ chosen { }; }; }; + +Static Heap Memory +================== + +The static heap memory refers to parts of RAM reserved in the beginning of +boot time for heap. The memory is reserved by configuration in the device +tree using physical address ranges. + +The static heap memory declared in the device tree defines the memory areas +that will be reserved to be used exclusively as heap. + +- For Arm32, since there are separated heaps, the static heap will be used +for both domheap and xenheap. The admin should make sure that the static +heap region should contain enough memory below 4GB to cater 32-bit DMA. + +- For Arm64, since there is a single heap, the defined static heap areas +shall always go to the heap allocator. + +The static heap memory is an optional feature and can be enabled by adding +below device tree property. + +- xen,static-heap + + Property under the top-level "chosen" node. It specifies the address + and size of Xen static heap memory. Number of address and size cells + for the "xen,static-heap" property is determined by the root node + "#address-cells" and "#size-cells". Note that at least a 64KB alignment + is required. + +Below is an example on how to specify the static heap in device tree: + + / { + #address-cells = <0x2>; + #size-cells = <0x2>; + ... + chosen { + xen,static-heap = <0x0 0x30000000 0x0 0x40000000>; + ... + }; + }; + +RAM starting from the host physical address 0x30000000 of 1GB size will +be reserved as static heap.