[PATCH v4 06/18] arm64: stacktrace: Add description of stacktrace/common.h

[Marc Zyngier]

On Fri, 15 Jul 2022 07:10:15 +0100,
Kalesh Singh <kaleshsingh at google.com> wrote:
> 
> Add brief description on how to use stacktrace/common.h to implement
> a stack unwinder.
> 
> Signed-off-by: Kalesh Singh <kaleshsingh at google.com>
> ---
>  arch/arm64/include/asm/stacktrace/common.h | 8 ++++++++
>  1 file changed, 8 insertions(+)
> 
> diff --git a/arch/arm64/include/asm/stacktrace/common.h b/arch/arm64/include/asm/stacktrace/common.h
> index f86efe71479d..b362086f4c70 100644
> --- a/arch/arm64/include/asm/stacktrace/common.h
> +++ b/arch/arm64/include/asm/stacktrace/common.h
> @@ -2,6 +2,14 @@
>  /*
>   * Common arm64 stack unwinder code.
>   *
> + * To implement a new arm64 stack unwinder:
> + *     1) Include this header
> + *
> + *     2) Provide implementations for the following functions:
> + *            - on_overflow_stack()
> + *            - on_accessible_stack()
> + *            - unwind_next()

A short description of what these helpers are supposed to do would
also be helpful.

Thanks,

	M.

-- 
Without deviation from the norm, progress is not possible.