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 <[email protected]>
Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=5850
Signed-off-by: Yang Li <[email protected]>
---
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
*/
--
2.20.1.7.g153144c
On 7/12/23 00:58, Yang Li wrote:
> 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 <[email protected]>
> Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=5850
> Signed-off-by: Yang Li <[email protected]>
Reviewed-by: Randy Dunlap <[email protected]>
Thanks.
> ---
> 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
> */
--
~Randy
On 7/12/23 00:58, Yang Li wrote:
> Use colons to separate parameter names from their specific meanings.
Reviewed-by: Bart Van Assche <[email protected]>
Yang,
> Use colons to separate parameter names from their specific meanings.
> silencethe warnings:
Applied to 6.6/scsi-staging, thanks!
--
Martin K. Petersen Oracle Linux Engineering