From patchwork Tue Jun 6 13:27:35 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: tip-bot2 for Thomas Gleixner X-Patchwork-Id: 103839 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:994d:0:b0:3d9:f83d:47d9 with SMTP id k13csp3421015vqr; Tue, 6 Jun 2023 07:07:54 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ7bjYAxFVFQgNLWj4KyOnoa0V4phvHlTqZq6ngol6zOM9yQxU2K8JMvmKZWtBIYY7iGwn/o X-Received: by 2002:a05:620a:4081:b0:75d:535d:528f with SMTP id f1-20020a05620a408100b0075d535d528fmr2669402qko.52.1686060473851; Tue, 06 Jun 2023 07:07:53 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1686060473; cv=none; d=google.com; s=arc-20160816; b=LbbxhtdDQhbyHDqHwjusgCnHhqNe7X5l6allZqaWdrZg3kx5klmnbbZaiH9jC3UaYj msUsxGWRxfpfGL36Dn9e9mRp8Ybm8eec4nC5cge8EvYql5+OOA7LffIkc2tO7Oab08rM 8r7vuogQ0Is2lhungRM+mAh90y97wThr41UsLce5JoB41ybsy0hizv3JWMsGzlvfEunn g4op2oUrOG9uw/6U4w1bNxO2sPrpJjnrBuBHjbPASRldMIIGJwn7YiAyaCWOwOMDp+gY C36Sgn72IxZoYbRgys25NQauDclvLyXcHneyKxgrvLqcU7qONNlJtUQuhnGFiuXLSHqK M4/g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:robot-unsubscribe :robot-id:message-id:mime-version:cc:subject:to:reply-to:sender:from :dkim-signature:dkim-signature:date; bh=obX2WX9h0kIhbFoPF8VBp4LjF5H5wMOuTw92LriOL+8=; b=F7Jm44nlcIgeHHAY88rwHnA+8DC0vvUODkBhDuY5ZEqnL2KpMYWCOHTXd30B/NzHKj 4veY04guX2Ig0LTpjnjz7lWIcD7qutg3lcIoL3lAmsAaS2wVMExS0qG7S6OCHxxmy9Sz XgsR3FDqdFY65oNmHojN3OEiO3ujls/X861Q+bDshEyTRMtNhUlZx/M7vaE9cyqpZx6c 7wrRPM4heum7J+FcxUZX1xouSyXDQDVkjypC5lFSJcfrTHVlpWynnfdA4IPf9RSb/piu ckuVHjmyEceB7rYGhsLIGyQNLnqwxPnlYQwQnGnQdMyvzVBmIJp/6UTB7W8YbGXIVcwt o5SA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linutronix.de header.s=2020 header.b=vGEkZ7bw; dkim=neutral (no key) header.i=@linutronix.de header.s=2020e header.b=CgE+P5Zp; 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; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=linutronix.de Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id p12-20020ae9f30c000000b0075ced4cb9d3si5763618qkg.2.2023.06.06.07.07.28; Tue, 06 Jun 2023 07:07:53 -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=@linutronix.de header.s=2020 header.b=vGEkZ7bw; dkim=neutral (no key) header.i=@linutronix.de header.s=2020e header.b=CgE+P5Zp; 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; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=linutronix.de Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S236710AbjFFN1k (ORCPT + 99 others); Tue, 6 Jun 2023 09:27:40 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:52678 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231431AbjFFN1i (ORCPT ); Tue, 6 Jun 2023 09:27:38 -0400 Received: from galois.linutronix.de (Galois.linutronix.de [193.142.43.55]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id EEDEC10C0; Tue, 6 Jun 2023 06:27:37 -0700 (PDT) Date: Tue, 06 Jun 2023 13:27:35 -0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020; t=1686058056; h=from:from:sender:sender:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=obX2WX9h0kIhbFoPF8VBp4LjF5H5wMOuTw92LriOL+8=; b=vGEkZ7bwfa8F34l4jjXUvwtPHL5TvWBt2G7D81GkvosLt/wXTUJlO6R68k4xlCzOmksE07 kmQEJyQOzbpN9H+dduOqUrrDQLA4gasvBP2kWTHQ9VBA6AwIGkdilGtud5MASFRifsOowO tkBDlZFBPKsUtpZgsEmsD4Mj3QwGakZIu/X7rgJXsTrQS9GgIFUbxApD/2IpNgAWqk7ztB MGgOdgy1cTOPLi2ryHXLqzHgfmoQYUpbBVqUgaj+jXWT9DJqSrO2hIrnE/i4wLrzauMFOi +p7TKxxd26Pd/J1Rs+8slIQHhsZhv6m0haMiWFl7VZNSZ1R1ljYs8HvScUj0dg== DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020e; t=1686058056; h=from:from:sender:sender:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=obX2WX9h0kIhbFoPF8VBp4LjF5H5wMOuTw92LriOL+8=; b=CgE+P5ZpJvCNZpCsdC52cwaGA1KklVSIQHDlMT8JJAoIDWL4Zvyys04ItUAuOuA0KSHvRG eWVaPx+1qswFkEAQ== From: "tip-bot2 for Randy Dunlap" Sender: tip-bot2@linutronix.de Reply-to: linux-kernel@vger.kernel.org To: linux-tip-commits@vger.kernel.org Subject: [tip: x86/cleanups] x86/lib/msr: Clean up kernel-doc notation Cc: kernel test robot , Randy Dunlap , "Borislav Petkov (AMD)" , x86@kernel.org, linux-kernel@vger.kernel.org MIME-Version: 1.0 Message-ID: <168605805581.404.4652362165400702070.tip-bot2@tip-bot2> Robot-ID: Robot-Unsubscribe: Contact to get blacklisted from these emails 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_PASS,T_SCC_BODY_TEXT_LINE,URIBL_BLOCKED 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?1767962546949126293?= X-GMAIL-MSGID: =?utf-8?q?1767962546949126293?= The following commit has been merged into the x86/cleanups branch of tip: Commit-ID: b26d3d054de18f2334e06985e508083b2f32a101 Gitweb: https://git.kernel.org/tip/b26d3d054de18f2334e06985e508083b2f32a101 Author: Randy Dunlap AuthorDate: Tue, 11 Apr 2023 16:45:03 -07:00 Committer: Borislav Petkov (AMD) CommitterDate: Tue, 06 Jun 2023 15:19:50 +02:00 x86/lib/msr: Clean up kernel-doc notation 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 ... Fixes: 22085a66c2fa ("x86: Add another set of MSR accessor functions") Reported-by: kernel test robot Signed-off-by: Randy Dunlap Signed-off-by: Borislav Petkov (AMD) Link: https://lore.kernel.org/oe-kbuild-all/202304120048.v4uqUq9Q-lkp@intel.com/ --- arch/x86/lib/msr.c | 32 +++++++++++++++++++------------- 1 file changed, 19 insertions(+), 13 deletions(-) diff --git a/arch/x86/lib/msr.c b/arch/x86/lib/msr.c index b09cd2a..47fd9bd 100644 --- 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 *m) } /** - * 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 bit, bool set) } /** - * 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) {