Skip to content

Commit 9987607

Browse files
James MorseAKASHI Takahiro
authored andcommitted
Documentation: dt: chosen properties for arm64 kdump
Add documentation for DT properties: linux,usable-memory-range linux,elfcorehdr used by arm64 kdump. Those are, respectively, a usable memory range allocated to crash dump kernel and the elfcorehdr's location within it. Signed-off-by: James Morse <james.morse@arm.com> [takahiro.akashi@linaro.org: update the text due to recent changes ] Signed-off-by: AKASHI Takahiro <takahiro.akashi@linaro.org> Acked-by: Mark Rutland <mark.rutland@arm.com> Cc: devicetree@vger.kernel.org Cc: Rob Herring <robh+dt@kernel.org> Signed-off-by: Catalin Marinas <catalin.marinas@arm.com>
1 parent b07152e commit 9987607

1 file changed

Lines changed: 45 additions & 0 deletions

File tree

Documentation/devicetree/bindings/chosen.txt

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,48 @@ This property is set (currently only on PowerPC, and only needed on
5252
book3e) by some versions of kexec-tools to tell the new kernel that it
5353
is being booted by kexec, as the booting environment may differ (e.g.
5454
a different secondary CPU release mechanism)
55+
56+
linux,usable-memory-range
57+
-------------------------
58+
59+
This property (arm64 only) holds a base address and size, describing a
60+
limited region in which memory may be considered available for use by
61+
the kernel. Memory outside of this range is not available for use.
62+
63+
This property describes a limitation: memory within this range is only
64+
valid when also described through another mechanism that the kernel
65+
would otherwise use to determine available memory (e.g. memory nodes
66+
or the EFI memory map). Valid memory may be sparse within the range.
67+
e.g.
68+
69+
/ {
70+
chosen {
71+
linux,usable-memory-range = <0x9 0xf0000000 0x0 0x10000000>;
72+
};
73+
};
74+
75+
The main usage is for crash dump kernel to identify its own usable
76+
memory and exclude, at its boot time, any other memory areas that are
77+
part of the panicked kernel's memory.
78+
79+
While this property does not represent a real hardware, the address
80+
and the size are expressed in #address-cells and #size-cells,
81+
respectively, of the root node.
82+
83+
linux,elfcorehdr
84+
----------------
85+
86+
This property (currently used only on arm64) holds the memory range,
87+
the address and the size, of the elf core header which mainly describes
88+
the panicked kernel's memory layout as PT_LOAD segments of elf format.
89+
e.g.
90+
91+
/ {
92+
chosen {
93+
linux,elfcorehdr = <0x9 0xfffff000 0x0 0x800>;
94+
};
95+
};
96+
97+
While this property does not represent a real hardware, the address
98+
and the size are expressed in #address-cells and #size-cells,
99+
respectively, of the root node.

0 commit comments

Comments
 (0)