From patchwork Wed Jul 12 07:58:36 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Yang Li X-Patchwork-Id: 118913 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:a6b2:0:b0:3e4:2afc:c1 with SMTP id c18csp990419vqm; Wed, 12 Jul 2023 01:15:44 -0700 (PDT) X-Google-Smtp-Source: APBJJlGXFXbIGdaWBiJyuMTsUpZYaddMAbKXtd0e6CgMa2MCUG3VkZmUaIUSpe6GSVJuiShww7no X-Received: by 2002:a05:6a20:1456:b0:125:f3d8:e65b with SMTP id a22-20020a056a20145600b00125f3d8e65bmr17310087pzi.18.1689149744310; Wed, 12 Jul 2023 01:15:44 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1689149744; cv=none; d=google.com; s=arc-20160816; b=LQcTe2bSrhU5CanCV4p6sttVFv9mUndMYQ23PpGhDeOaR7aLfVLsrOTgTliXgY8yLQ GypOz7v5VK6ipfAXQHujC5MMxqFgCzhyopWREdpe0HfUXwOR2zUNHe29CEKdJpNKExjl 39WUPz5QVkpmZY4Rgl5NJcxN9dSvF5Jg0RXxSfn1qQ93mXe5Y9ub7OLgsAS5zuA0Uy3s /rG/B3LOCoGX1THU+nlbl6kluTKdk0/Nbc8B9BazDeoNomJ/uyri2wV6ZnsKBWnWsuVN DrRUYbzU7hRo8VL1tArrzEvcrsa+L53u7L+R4ZoVF+3KLvabPxqBI8RXS96spzFXiBHX qffg== 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; bh=D2VAqBfKb6Jr1ARrZVaNy/lmZNRPxFb953/tAGkJ+Ro=; fh=X/UQg7l60E/y+mUIHpR+nq027OI2gTpXdgXM8YRVAUE=; b=Hkxc7tmSD6yek6lDrGVxitOwLPN23iIEB5Pi9WzAeqhD68+YpdnwZTmaQS7vggz3xL th12htn4mLg8epFNyDpDTp3VLnX/5SQ9AFVMDZgUnxJnrlm//SXQrm9JLiuYSlTXXm9Q qfp5JVuLWe5TKAdQK9JdOIkE1Tq4KIg8rffUQjzCM8L5ZdieYEPouvEuCLLHB8hU207D qgjKtmlOUjJD71VQVBSTlCMMTPc0FMVorPG0TUdfD0Itp0L0SSLyKfcGDPtBioHJorWK JNNX5D3jsanC1l63udPfFAx/w/y+wrOdrg8kfsERIQG6+GT7vjwhEzBpEqAjlehlC4mh 44Sg== ARC-Authentication-Results: i=1; mx.google.com; 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=fail (p=NONE sp=NONE dis=NONE) header.from=alibaba.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id o3-20020a634e43000000b0054fe43caa81si2715827pgl.782.2023.07.12.01.15.31; Wed, 12 Jul 2023 01:15:44 -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; 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=fail (p=NONE sp=NONE dis=NONE) header.from=alibaba.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231573AbjGLH6q (ORCPT + 99 others); Wed, 12 Jul 2023 03:58:46 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39102 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229659AbjGLH6p (ORCPT ); Wed, 12 Jul 2023 03:58:45 -0400 Received: from out30-118.freemail.mail.aliyun.com (out30-118.freemail.mail.aliyun.com [115.124.30.118]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 358CD10F7; Wed, 12 Jul 2023 00:58:42 -0700 (PDT) X-Alimail-AntiSpam: AC=PASS;BC=-1|-1;BR=01201311R201e4;CH=green;DM=||false|;DS=||;FP=0|-1|-1|-1|0|-1|-1|-1;HT=ay29a033018046056;MF=yang.lee@linux.alibaba.com;NM=1;PH=DS;RN=9;SR=0;TI=SMTPD_---0VnC3MN3_1689148717; Received: from localhost(mailfrom:yang.lee@linux.alibaba.com fp:SMTPD_---0VnC3MN3_1689148717) by smtp.aliyun-inc.com; Wed, 12 Jul 2023 15:58:38 +0800 From: Yang Li To: jejb@linux.ibm.com Cc: martin.petersen@oracle.com, alim.akhtar@samsung.com, avri.altman@wdc.com, bvanassche@acm.org, linux-scsi@vger.kernel.org, linux-kernel@vger.kernel.org, Yang Li , Abaci Robot Subject: [PATCH -next] scsi: ufs: core: Fix some kernel-doc comments Date: Wed, 12 Jul 2023 15:58:36 +0800 Message-Id: <20230712075836.15375-1-yang.lee@linux.alibaba.com> X-Mailer: git-send-email 2.20.1.7.g153144c MIME-Version: 1.0 X-Spam-Status: No, score=-9.9 required=5.0 tests=BAYES_00, ENV_AND_HDR_SPF_MATCH,RCVD_IN_DNSWL_BLOCKED,RCVD_IN_MSPIKE_H2, SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE,UNPARSEABLE_RELAY, URIBL_BLOCKED,USER_IN_DEF_SPF_WL 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: INBOX X-GMAIL-THRID: 1771201882395285712 X-GMAIL-MSGID: 1771201882395285712 Use colons to separate parameter names from their specific meanings. silencethe warnings: drivers/ufs/core/ufs-mcq.c:499: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_sq_cleanup' drivers/ufs/core/ufs-mcq.c:499: warning: Function parameter or member 'task_tag' not described in 'ufshcd_mcq_sq_cleanup' drivers/ufs/core/ufs-mcq.c:560: warning: Function parameter or member 'utrd' not described in 'ufshcd_mcq_nullify_sqe' drivers/ufs/core/ufs-mcq.c:583: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_sqe_search' drivers/ufs/core/ufs-mcq.c:583: warning: Function parameter or member 'hwq' not described in 'ufshcd_mcq_sqe_search' drivers/ufs/core/ufs-mcq.c:583: warning: Function parameter or member 'task_tag' not described in 'ufshcd_mcq_sqe_search' drivers/ufs/core/ufs-mcq.c:630: warning: Function parameter or member 'cmd' not described in 'ufshcd_mcq_abort' Reported-by: Abaci Robot Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=5850 Signed-off-by: Yang Li Reviewed-by: Randy Dunlap Reviewed-by: Bart Van Assche --- drivers/ufs/core/ufs-mcq.c | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/drivers/ufs/core/ufs-mcq.c b/drivers/ufs/core/ufs-mcq.c index e8bad5e9518e..1e23ba3e2bdf 100644 --- a/drivers/ufs/core/ufs-mcq.c +++ b/drivers/ufs/core/ufs-mcq.c @@ -490,8 +490,8 @@ static int ufshcd_mcq_sq_start(struct ufs_hba *hba, struct ufs_hw_queue *hwq) /** * ufshcd_mcq_sq_cleanup - Clean up submission queue resources * associated with the pending command. - * @hba - per adapter instance. - * @task_tag - The command's task tag. + * @hba: per adapter instance. + * @task_tag: The command's task tag. * * Returns 0 for success; error code otherwise. */ @@ -554,7 +554,7 @@ int ufshcd_mcq_sq_cleanup(struct ufs_hba *hba, int task_tag) * Write the sqe's Command Type to 0xF. The host controller will not * fetch any sqe with Command Type = 0xF. * - * @utrd - UTP Transfer Request Descriptor to be nullified. + * @utrd: UTP Transfer Request Descriptor to be nullified. */ static void ufshcd_mcq_nullify_sqe(struct utp_transfer_req_desc *utrd) { @@ -571,9 +571,9 @@ static void ufshcd_mcq_nullify_sqe(struct utp_transfer_req_desc *utrd) * If the command is in the submission queue and not issued to the device yet, * nullify the sqe so the host controller will skip fetching the sqe. * - * @hba - per adapter instance. - * @hwq - Hardware Queue to be searched. - * @task_tag - The command's task tag. + * @hba: per adapter instance. + * @hwq: Hardware Queue to be searched. + * @task_tag: The command's task tag. * * Returns true if the SQE containing the command is present in the SQ * (not fetched by the controller); returns false if the SQE is not in the SQ. @@ -622,7 +622,7 @@ static bool ufshcd_mcq_sqe_search(struct ufs_hba *hba, /** * ufshcd_mcq_abort - Abort the command in MCQ. - * @cmd - The command to be aborted. + * @cmd: The command to be aborted. * * Returns SUCCESS or FAILED error codes */