From patchwork Sat Jul 9 10:07:19 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 12912144 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 5B7A5C433EF for ; Sat, 9 Jul 2022 10:07:42 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229678AbiGIKHl (ORCPT ); Sat, 9 Jul 2022 06:07:41 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:60932 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229469AbiGIKHk (ORCPT ); Sat, 9 Jul 2022 06:07:40 -0400 Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 77CF04AD50; Sat, 9 Jul 2022 03:07:39 -0700 (PDT) Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by dfw.source.kernel.org (Postfix) with ESMTPS id 0427A60DFF; Sat, 9 Jul 2022 10:07:39 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 578BDC341C7; Sat, 9 Jul 2022 10:07:38 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1657361258; bh=A54g7vRsszk0/l1GimW6ZYYbGXwakZHP+vpX+YjS5YU=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=txfkeUHyqV+qQ6KQYrH+fXWNG3C3QN3k0OAtb3RKcZVk6lMKvW0ABrV1yszCa/UIJ FRRTUilsYdnjPl2B8X7TUYojG/LM/xdPyAh96e11W78xKuROGnEiXhFxSMgbY9QFbK gbq+Jr9Dce5Df+H0SBnizRlyR1KOOUopauc+1lLeGOrESWVh8AkZ1a9MKZGq3KodQN zb2tGYZERy3TVuVZUIzWzDjAgG0GaadwiGQ+tuvPngarizdFrN5iwv6xdBmFej0F7q viidYSXkPY7JgyY9Wl966tkwcnMc4PVR8b9KaYUmgluyPfvba/PZAVR08bc51+Ni8p AMwRQbzEYM67A== Received: from mchehab by mail.kernel.org with local (Exim 4.95) (envelope-from ) id 1oA7N9-004EGi-GN; Sat, 09 Jul 2022 11:07:35 +0100 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , "H. Peter Anvin" , "Jonathan Corbet" , "Mauro Carvalho Chehab" , Borislav Petkov , Dave Hansen , Ingo Molnar , Jarkko Sakkinen , Jethro Beekman , Sean Christopherson , Thomas Gleixner , linux-kernel@vger.kernel.org, linux-sgx@vger.kernel.org, x86@kernel.org Subject: [PATCH v3 06/21] x86/sgx: fix kernel-doc markups Date: Sat, 9 Jul 2022 11:07:19 +0100 Message-Id: <9f0f8f41c2544c34371ca003814aadd24b5698c3.1657360984.git.mchehab@kernel.org> X-Mailer: git-send-email 2.36.1 In-Reply-To: References: MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-sgx@vger.kernel.org There are a couple typos there, violating kernel-doc syntax. Also, on a function typedef, the register snapshots aren't documented. This should fix those warnings: arch/x86/include/uapi/asm/sgx.h:19: warning: Enum value 'SGX_PAGE_MEASURE' not described in enum 'sgx_page_flags' arch/x86/include/uapi/asm/sgx.h:97: warning: Function parameter or member 'rdi' not described in 'sgx_enclave_user_handler_t' arch/x86/include/uapi/asm/sgx.h:97: warning: Function parameter or member 'rsi' not described in 'sgx_enclave_user_handler_t' arch/x86/include/uapi/asm/sgx.h:97: warning: Function parameter or member 'rdx' not described in 'sgx_enclave_user_handler_t' arch/x86/include/uapi/asm/sgx.h:97: warning: Function parameter or member 'rsp' not described in 'sgx_enclave_user_handler_t' arch/x86/include/uapi/asm/sgx.h:97: warning: Function parameter or member 'r8' not described in 'sgx_enclave_user_handler_t' arch/x86/include/uapi/asm/sgx.h:97: warning: Function parameter or member 'r9' not described in 'sgx_enclave_user_handler_t' arch/x86/include/uapi/asm/sgx.h:124: warning: Function parameter or member 'reserved' not described in 'sgx_enclave_run' Fixes: 3fa97bf00126 ("Documentation/x86: Document SGX kernel architecture") Reviewed-by: Jarkko Sakkinen Acked-by: Dave Hansen Signed-off-by: Mauro Carvalho Chehab --- To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH v3 00/21] at: https://lore.kernel.org/all/cover.1657360984.git.mchehab@kernel.org/ arch/x86/include/uapi/asm/sgx.h | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/arch/x86/include/uapi/asm/sgx.h b/arch/x86/include/uapi/asm/sgx.h index f4b81587e90b..6306bcaaf67a 100644 --- a/arch/x86/include/uapi/asm/sgx.h +++ b/arch/x86/include/uapi/asm/sgx.h @@ -10,7 +10,7 @@ /** * enum sgx_page_flags - page control flags - * %SGX_PAGE_MEASURE: Measure the page contents with a sequence of + * @SGX_PAGE_MEASURE: Measure the page contents with a sequence of * ENCLS[EEXTEND] operations. */ enum sgx_page_flags { @@ -81,6 +81,12 @@ struct sgx_enclave_run; /** * typedef sgx_enclave_user_handler_t - Exit handler function accepted by * __vdso_sgx_enter_enclave() + * @rdi: snapshot of RDI register at enclave exit + * @rsi: snapshot of RSI register at enclave exit + * @rdx: snapshot of RDX register at enclave exit + * @rsp: snapshot of RSP register at enclave exit + * @r8: snapshot of R8 register at enclave exit + * @r9: snapshot of R9 register at enclave exit * @run: The run instance given by the caller * * The register parameters contain the snapshot of their values at enclave @@ -104,7 +110,7 @@ typedef int (*sgx_enclave_user_handler_t)(long rdi, long rsi, long rdx, * @exception_addr: The address that triggered the exception * @user_handler: User provided callback run on exception * @user_data: Data passed to the user handler - * @reserved Reserved for future extensions + * @reserved: Reserved for future extensions * * If @user_handler is provided, the handler will be invoked on all return paths * of the normal flow. The user handler may transfer control, e.g. via a