From mboxrd@z Thu Jan 1 00:00:00 1970 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 bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (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 97EEEC25B08 for ; Tue, 23 Aug 2022 05:12:42 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:In-Reply-To:From:References:Cc:To: Subject:MIME-Version:Date:Message-ID:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=HcsCWK/wEtLuONa+/EnhfFOrUk374La1Gf4HvCBbiM0=; b=ELFteGZx9jErLw JRxknGrp7dqqCAI4W23YYYqfG+CaeO5chu582k8P3hNF83uzuIvivMLAeaBVb1SeJTBmn8blvySff dRcqS1fOb7j2me2b0BHIcwTl1wuFBIXlD4uh2Ste+ZW1z7tQ+7HoUYpQAN3U3IkxfDgqlJ+h+ac+K x4EjRUieX6HxCOZUByPY6W4GeqBjhNliFhR0PEuA5mjcAll5DuJsXiANHoMLZNdITREGk6v4Q/Bb4 C1SPjutdGxr1WmAYRPdpI7nNHiRJ8QQQb3/jpla59qwvfHvzZWUPF/fg6FmnAo5SzGgXnrj76rbLU tDwpoiUNbZU3chQWM+Dg==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.94.2 #2 (Red Hat Linux)) id 1oQMC8-002H7d-MS; Tue, 23 Aug 2022 05:11:20 +0000 Received: from linux.microsoft.com ([13.77.154.182]) by bombadil.infradead.org with esmtp (Exim 4.94.2 #2 (Red Hat Linux)) id 1oQMC5-002H42-0m for linux-arm-kernel@lists.infradead.org; Tue, 23 Aug 2022 05:11:18 +0000 Received: from [192.168.254.32] (unknown [47.189.24.195]) by linux.microsoft.com (Postfix) with ESMTPSA id 2E39E213C140; Mon, 22 Aug 2022 22:11:11 -0700 (PDT) DKIM-Filter: OpenDKIM Filter v2.11.0 linux.microsoft.com 2E39E213C140 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linux.microsoft.com; s=default; t=1661231471; bh=JOM+s/0ZA5/BbFZfL+ynCZjYNUhJy03zt28s/xZ/VsI=; h=Date:Subject:To:Cc:References:From:In-Reply-To:From; b=E88dqtWIXEC3QBF1gtQcTyzpd+fpGItOUq1AFgi6wTlLS6Eo0B4HCEeR43yA7Zs9f owA5SHqKdgIAnhB+Ozv2Xpi+9iBv3y/lJR4yEGgp8FHNJ0IZZ/Xopigsv33XEF2yyf Xle7KODFYyWsmB5jWbqUIQ/iNy2OuRNVC2c8/Vi8= Message-ID: Date: Tue, 23 Aug 2022 00:11:10 -0500 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Thunderbird/91.11.0 Subject: Re: [PATCH v3 1/9] arm64: stacktrace: fix kerneldoc comments Content-Language: en-US To: Mark Rutland , linux-arm-kernel@lists.infradead.org Cc: broonie@kernel.org, catalin.marinas@arm.com, james.morse@arm.com, kaleshsingh@google.com, maz@kernel.org, tabba@google.com, will@kernel.org References: <20220815113922.3280255-1-mark.rutland@arm.com> <20220815113922.3280255-2-mark.rutland@arm.com> From: "Madhavan T. Venkataraman" In-Reply-To: <20220815113922.3280255-2-mark.rutland@arm.com> X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20220822_221117_167718_9BA8914D X-CRM114-Status: GOOD ( 22.17 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org Reviewed-by: Madhavan T. Venkataraman On 8/15/22 06:39, Mark Rutland wrote: > Many of the comment blocks in the arm64 stacktrace code are *almost* > kerneldoc, but not quite. > > Convert them to kerneldoc, as was presumably originally intended. > > Signed-off-by: Mark Rutland > Cc: Fuad Tabba > Cc: Kalesh Singh > Cc: Madhavan T. Venkataraman > Cc: Marc Zyngier > Cc: Mark Brown > --- > arch/arm64/include/asm/stacktrace/common.h | 28 +++++++++++++--------- > arch/arm64/include/asm/stacktrace/nvhe.h | 4 ++-- > 2 files changed, 19 insertions(+), 13 deletions(-) > > diff --git a/arch/arm64/include/asm/stacktrace/common.h b/arch/arm64/include/asm/stacktrace/common.h > index f58eb944c46fb..b8b20ef5aa5db 100644 > --- a/arch/arm64/include/asm/stacktrace/common.h > +++ b/arch/arm64/include/asm/stacktrace/common.h > @@ -38,9 +38,8 @@ struct stack_info { > enum stack_type type; > }; > > -/* > - * A snapshot of a frame record or fp/lr register values, along with some > - * accounting information necessary for robust unwinding. > +/** > + * struct unwind_state - state used for robust unwinding. > * > * @fp: The fp value in the frame record (or the real fp) > * @pc: The lr value in the frame record (or the real lr) > @@ -113,27 +112,34 @@ static inline void unwind_init_common(struct unwind_state *state, > state->prev_type = STACK_TYPE_UNKNOWN; > } > > -/* > - * stack_trace_translate_fp_fn() - Translates a non-kernel frame pointer to > - * a kernel address. > +/** > + * typedef stack_trace_translate_fp_fn() - Translates a non-kernel frame > + * pointer to a kernel address. > * > * @fp: the frame pointer to be updated to its kernel address. > * @type: the stack type associated with frame pointer @fp > * > - * Returns true and success and @fp is updated to the corresponding > - * kernel virtual address; otherwise returns false. > + * Return: true if the VA can be translated, false otherwise. > + * > + * Upon success @fp is updated to the corresponding kernel virtual address. > */ > typedef bool (*stack_trace_translate_fp_fn)(unsigned long *fp, > enum stack_type type); > > -/* > - * on_accessible_stack_fn() - Check whether a stack range is on any > - * of the possible stacks. > +/** > + * typedef on_accessible_stack_fn() - Check whether a stack range is on any of > + * the possible stacks. > * > * @tsk: task whose stack is being unwound > * @sp: stack address being checked > * @size: size of the stack range being checked > * @info: stack unwinding context > + * > + * Return: true if the stack range is accessible, false otherwise. > + * > + * Upon success @info is updated with information for the relevant stack. > + * > + * Upon failure @info is updated with the UNKNOWN stack. > */ > typedef bool (*on_accessible_stack_fn)(const struct task_struct *tsk, > unsigned long sp, unsigned long size, > diff --git a/arch/arm64/include/asm/stacktrace/nvhe.h b/arch/arm64/include/asm/stacktrace/nvhe.h > index d5527b6003908..25ab83a315a76 100644 > --- a/arch/arm64/include/asm/stacktrace/nvhe.h > +++ b/arch/arm64/include/asm/stacktrace/nvhe.h > @@ -20,8 +20,8 @@ > > #include > > -/* > - * kvm_nvhe_unwind_init - Start an unwind from the given nVHE HYP fp and pc > +/** > + * kvm_nvhe_unwind_init() - Start an unwind from the given nVHE HYP fp and pc > * > * @state : unwind_state to initialize > * @fp : frame pointer at which to start the unwinding. _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel