[PATCH V5 5/6] riscv: crash_core: Export kernel vm layout, phys_ram_base

[Conor.Dooley at microchip.com]

On 02/08/2022 13:18, Xianting Tian wrote:
> riscv: crash_core: Export kernel vm layout, phys_ram_base

Can you please just use RISC-V: for the whole series, my OCD
hates the mix haha.

> These infos are needed by the kdump crash tool. Since these values change
> from time to time, it is preferable to export them via vmcoreinfo than to
> change the crash's code frequently.

This commit description doesn't seem to match the patches at all.
I don't see any exporting happening here at all - this is documenting
the export. Maybe I am just misunderstanding, but this commit message
just doesn't seem to match the change. Secondly, should the subject not
be something like "docs: admin-guide: add riscv crash kernel yada yada"?
Maybe the current subject lime that explains the lack of a review from
the docs maintainer?

Thanks,
Conor.

> 
> Signed-off-by: Xianting Tian <xianting.tian at linux.alibaba.com>
> ---
>  .../admin-guide/kdump/vmcoreinfo.rst          | 31 +++++++++++++++++++
>  1 file changed, 31 insertions(+)
> 
> diff --git a/Documentation/admin-guide/kdump/vmcoreinfo.rst b/Documentation/admin-guide/kdump/vmcoreinfo.rst
> index 8419019b6a88..6b76284a503c 100644
> --- a/Documentation/admin-guide/kdump/vmcoreinfo.rst
> +++ b/Documentation/admin-guide/kdump/vmcoreinfo.rst
> @@ -595,3 +595,34 @@ X2TLB
>  -----
>  
>  Indicates whether the crashed kernel enabled SH extended mode.
> +
> +RISCV64
> +=======
> +
> +VA_BITS
> +-------
> +
> +The maximum number of bits for virtual addresses. Used to compute the
> +virtual memory ranges.
> +
> +PAGE_OFFSET
> +-----------
> +
> +Indicates the virtual kernel start address of direct-mapped RAM region.
> +
> +phys_ram_base
> +-------------
> +
> +Indicates the start physical RAM address.
> +
> +MODULES_VADDR|MODULES_END|VMALLOC_START|VMALLOC_END|VMEMMAP_START|VMEMMAP_END
> +-----------------------------------------------------------------------------
> +KASAN_SHADOW_START|KASAN_SHADOW_END|KERNEL_LINK_ADDR|ADDRESS_SPACE_END
> +----------------------------------------------------------------------
> +
> +Used to get the correct ranges:
> +	MODULES_VADDR ~ MODULES_END : Kernel module space.
> +	VMALLOC_START ~ VMALLOC_END : vmalloc() / ioremap() space.
> +	VMEMMAP_START ~ VMEMMAP_END : vmemmap region, used for struct page array.
> +	KASAN_SHADOW_START ~ KASAN_SHADOW_END : kasan shadow space.
> +	KERNEL_LINK_ADDR ~ ADDRESS_SPACE_END : Kernel link and BPF space.