diff mbox series

docs/device-tree: Place the static-heap dt-binding in proper place

Message ID 20220908120728.8290-1-Henry.Wang@arm.com (mailing list archive)
State New, archived
Headers show
Series docs/device-tree: Place the static-heap dt-binding in proper place | expand

Commit Message

Henry Wang Sept. 8, 2022, 12:07 p.m. UTC
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 <Henry.Wang@arm.com>
---
 docs/misc/arm/device-tree/booting.txt | 86 +++++++++++++--------------
 1 file changed, 43 insertions(+), 43 deletions(-)

Comments

Julien Grall Sept. 8, 2022, 1:05 p.m. UTC | #1
Hi Henry,

On 08/09/2022 13:07, Henry Wang wrote:
> 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 <Henry.Wang@arm.com>

Thanks for fixing the mistake I did while committing the patch :).

Acked-by: Julien Grall <jgrall@amazon.com>

Cheers,
Julien Grall Sept. 9, 2022, 9:33 a.m. UTC | #2
On 08/09/2022 14:05, Julien Grall wrote:
> Hi Henry,
> 
> On 08/09/2022 13:07, Henry Wang wrote:
>> 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 <Henry.Wang@arm.com>
> 
> Thanks for fixing the mistake I did while committing the patch :).
> 
> Acked-by: Julien Grall <jgrall@amazon.com>

And committed.

Cheers,
diff mbox series

Patch

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.