From patchwork Tue Apr 11 23:45:03 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 82215 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:b0ea:0:b0:3b6:4342:cba0 with SMTP id b10csp2941234vqo; Tue, 11 Apr 2023 17:12:55 -0700 (PDT) X-Google-Smtp-Source: AKy350ZjC+WBgpLsjmqHu5gJ4YU0ZTTu7uLh1kyGh7fiKN+zOBUH3YJFHv93Vxqo55BsytGLjwUo X-Received: by 2002:a05:6a00:d68:b0:594:1f1c:3d3b with SMTP id n40-20020a056a000d6800b005941f1c3d3bmr778689pfv.16.1681258375353; Tue, 11 Apr 2023 17:12:55 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1681258375; cv=none; d=google.com; s=arc-20160816; b=uTMMQ5wxHu92audW+RklmsocehN2SNUYNkb5qRIzXAllFJ4yiz0LCPguIvplyKEj5S knR7Ra1Ag3UyFU6hdWwgy4YfmPI3iaJq41oXERTueRlxtcSfoL3ZGmHPfZkJCqHFhs9S AWkx+aGDF/YG6sPoZxCOutCcuECqH5KiRVP6NHqOvTJtk+mCxzuru3uo3Iont/eoIrCm lk5Fii2bP00Jqs9pd502MVVyLMBdLkLguyHDWB6Zme1UNHo1Ep99LtqtupFIMTTc41hX MSACyiYDiPISaVEfmWK2Amd2F9S8PqPZz46TrAwZZhhWwwIGEfiOUYY/VASZrEkPqXUK 7h7g== 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=Bi8inonQAYav2ArM4dfnMmLdhyhNFwkiN4K6vL3+l9FLx4G8tlLloAvwbUOvKchcOa p1dCri99acv6Q/xOgr9hgbDASBLClC7Ac3joDhtS0R47/vYVwrAazFxMzSQvgiaC+FAJ KAP/stDCvbWDRTIzVZjPpRg7YrUWsVlEdb1epQiI+EGKKfXn9jeXKhA/zyNsr5V/wglf oC6RXh/G+eEArmLBZVYbTtf9SbklPVNjJMSMfr14cvhfaXTDL28+QWWX/qTHVkOn7Yv0 e9Q+OYT62JbPf2ID1Z/DQlfO8wj9FAdZveKU3LlmkD2FwzlWyBhTswgoGwsCwbx+sKqe GJ7w== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=Os7VThiw; 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 l71-20020a63884a000000b00519a3fb282esi7477035pgd.864.2023.04.11.17.12.42; Tue, 11 Apr 2023 17:12:55 -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=Os7VThiw; 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 S229728AbjDKXpM (ORCPT + 99 others); Tue, 11 Apr 2023 19:45:12 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:40978 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229694AbjDKXpJ (ORCPT ); Tue, 11 Apr 2023 19:45:09 -0400 Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:3::133]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 11D03E59 for ; Tue, 11 Apr 2023 16:45:06 -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=Os7VThiw3qPJgX1B/yMfaABecu g9dhF67m7oU5DFfCS6InT4untnYdY5FTAPG+UyX2H/te/1Ffzj/PUKDo5LPmDrddQ2W9hS62DlScp Or5MA7eAzrifxSU6CqqglgyHYY9L27zKe53oqFEguxVji9k3nsip2e1iBcaIAVo9J45pkPg9Vbmb0 zNvmlWT+WatkWty06+jLKaWduQYGH+kCyDPi2g9/JCe6ciFzyXkglUrcfCwskE4mZUX0GTUr5EuK6 9RYeuUVEPEv6ZnTsD5SJA3roSF3BN+Zva45DPvg/DnuNe06vSN6eNX9w6jNigzghgoLeIe4X581tw V3WMUjaA==; 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 1pmNfd-001NeS-2B; Tue, 11 Apr 2023 23:45:05 +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] x86: msr: clean up kernel-doc notation Date: Tue, 11 Apr 2023 16:45:03 -0700 Message-Id: <20230411234503.18614-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.40.0 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 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?1762927182081888942?= X-GMAIL-MSGID: =?utf-8?q?1762927182081888942?= 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) {