From patchwork Sun May 21 22:58:19 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 96940 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:b0ea:0:b0:3b6:4342:cba0 with SMTP id b10csp1091808vqo; Sun, 21 May 2023 16:03:59 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ5hYM50/HbXfoUKkdvMyw+7PlH79OoY3om2+PPaVzC2GVmDPw1neG/ayNWzGJw2UATc33Oy X-Received: by 2002:a17:902:c3c4:b0:1ad:eb16:35e2 with SMTP id j4-20020a170902c3c400b001adeb1635e2mr9201284plj.66.1684710238898; Sun, 21 May 2023 16:03:58 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1684710238; cv=none; d=google.com; s=arc-20160816; b=lIOXEOa9KKc6IUg3Ys+PLzwT/UKZehbXJPKA2YSXO4lKDLUBEZmju3aCIN+mW8YBbc K9MVoA4ijX/x+Tzy8ulAoCmBZPSIUCZb/7lD1KrnITR/SOPsGdq3sqgGfqtVG5oB3mlb PgmRTTJDo+fQMVtQwxcA/krTVnse9bdiT4rlPFsCr3cuqXqgtz06DCRd6ZDYX45eHXRa Nz86oVMyj8XeOg3r9GbbVyFEg0LkkTMESPzb+nt/Aeb9AxB10QdpiPOJO5IA2DngJZE/ 4JtaLmQCtQIu9wStXx8umdT6Lc4zez5VgECk01YnzVAxKzPhtCoIrws7/pudW16hcIG2 yp+A== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from:dkim-signature; bh=BXUO1wgjEjTKJJJ0W0k6Aejv/+QwkUlBVT276pYvRHE=; b=RDhAsxPCEqhvquT5YaN3UiR4Un3AokrCrDNfj+mH5fX0X4SXIqpDFcc58/pwgwfpTj sfm6RSY0MntEn3q4koCkKbRSEOWT/esH3tXJ20ewborZlCwiMojshRQV+ijqBhr0wlC+ Ys72lxmiOwIDJE8FmKR4AbUVqB8xOZO2MQcMKfTaAwzSVEVAWAhTjyPZs0V6o3g0tex0 eCBmm2R6fnQQtDtH0jztSkAi8IuyeMnWCN8imJ6HUoOjG/Sto4f/F0TpOXYqJ8effvWK kbh44rx0jDMLWZAvisoor6Izy+EcNnckAfNIznrUKTZMg2wWn7pNmnEXlhcekGKk8f6/ LpNA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=Fj9xeJAJ; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id p9-20020a170902e74900b001a64e7b7026si3790102plf.438.2023.05.21.16.03.46; Sun, 21 May 2023 16:03:58 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=Fj9xeJAJ; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231231AbjEUW6X (ORCPT + 99 others); Sun, 21 May 2023 18:58:23 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:49788 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229481AbjEUW6W (ORCPT ); Sun, 21 May 2023 18:58:22 -0400 Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:3::133]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 14658BE for ; Sun, 21 May 2023 15:58:21 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:Message-Id:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type: Content-ID:Content-Description:In-Reply-To:References; bh=BXUO1wgjEjTKJJJ0W0k6Aejv/+QwkUlBVT276pYvRHE=; b=Fj9xeJAJlkOs0Jj6NIZ1QfEjXc 0kRSuhsYHT09Hjin7VlS3XoS9HKE87Xtm3oX+tkGIWNq9OgaaHsKk1iWSweA6QsdjRPE4SQZJMAUJ +oKtsiVOMpm/Jt7+/CxmosIOlMza3x8izRu3SRFwvrhUG8NrqJFodv3CxnE9ajnqMIOB0KaaNS4i0 Rv2oUF1Py0wpAvmaYfbl+fbgTaQWBWoBlPEqbLmhPk37v9XVe/zRS+9EIvjY/jX1zMBQS+AZusuae oMEeHzNBB1OLmHQC7wC5ICywp+jf+ruw99lpim4Er9TA4FVMGPpFQYBDDvP8fEU3VvnxnOsN0yMNf 3W9XlfcA==; Received: from [2601:1c2:980:9ec0::2764] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1q0s0K-004oEt-0C; Sun, 21 May 2023 22:58:20 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , kernel test robot , Thomas Gleixner , Ingo Molnar , Borislav Petkov , Dave Hansen , x86@kernel.org Subject: [PATCH RESEND] x86: msr: clean up kernel-doc notation Date: Sun, 21 May 2023 15:58:19 -0700 Message-Id: <20230521225819.4737-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.40.1 MIME-Version: 1.0 X-Spam-Status: No, score=-4.4 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_MED,SPF_HELO_NONE, SPF_NONE,T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1766546723795007080?= X-GMAIL-MSGID: =?utf-8?q?1766546723795007080?= Convert x86/lib/msr.c comments to kernel-doc notation to eliminate kernel-doc warnings: msr.c:30: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * Read an MSR with error handling msr.c:52: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * Write an MSR with error handling msr.c:91: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * Set @bit in a MSR @msr. msr.c:104: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * Clear @bit in a MSR @msr. Fixes: 22085a66c2fa ("x86: Add another set of MSR accessor functions") Signed-off-by: Randy Dunlap Reported-by: kernel test robot Link: https://lore.kernel.org/oe-kbuild-all/202304120048.v4uqUq9Q-lkp@intel.com/ Cc: Thomas Gleixner Cc: Ingo Molnar Cc: Borislav Petkov Cc: Dave Hansen Cc: x86@kernel.org --- arch/x86/lib/msr.c | 32 +++++++++++++++++++------------- 1 file changed, 19 insertions(+), 13 deletions(-) diff -- a/arch/x86/lib/msr.c b/arch/x86/lib/msr.c --- a/arch/x86/lib/msr.c +++ b/arch/x86/lib/msr.c @@ -27,14 +27,14 @@ void msrs_free(struct msr *msrs) EXPORT_SYMBOL(msrs_free); /** - * Read an MSR with error handling - * + * msr_read - Read an MSR with error handling * @msr: MSR to read * @m: value to read into * * It returns read data only on success, otherwise it doesn't change the output * argument @m. * + * Return: %0 for success, otherwise an error code */ static int msr_read(u32 msr, struct msr *m) { @@ -49,10 +49,12 @@ static int msr_read(u32 msr, struct msr } /** - * Write an MSR with error handling + * msr_write - Write an MSR with error handling * * @msr: MSR to write * @m: value to write + * + * Return: %0 for success, otherwise an error code */ static int msr_write(u32 msr, struct msr *m) { @@ -88,12 +90,14 @@ static inline int __flip_bit(u32 msr, u8 } /** - * Set @bit in a MSR @msr. + * msr_set_bit - Set @bit in a MSR @msr. + * @msr: MSR to write + * @bit: bit number to set * - * Retval: - * < 0: An error was encountered. - * = 0: Bit was already set. - * > 0: Hardware accepted the MSR write. + * Return: + * * < 0: An error was encountered. + * * = 0: Bit was already set. + * * > 0: Hardware accepted the MSR write. */ int msr_set_bit(u32 msr, u8 bit) { @@ -101,12 +105,14 @@ int msr_set_bit(u32 msr, u8 bit) } /** - * Clear @bit in a MSR @msr. + * msr_clear_bit - Clear @bit in a MSR @msr. + * @msr: MSR to write + * @bit: bit number to clear * - * Retval: - * < 0: An error was encountered. - * = 0: Bit was already cleared. - * > 0: Hardware accepted the MSR write. + * Return: + * * < 0: An error was encountered. + * * = 0: Bit was already cleared. + * * > 0: Hardware accepted the MSR write. */ int msr_clear_bit(u32 msr, u8 bit) {