scsi: ufs: Fix kernel-doc syntax
Subsystems (2)
Bart Van Assche
reviewerPATCH 1/1 scsi: ufs: Fix kernel-doc syntax
Fix the following kernel-doc warnings:
drivers/ufs/core/ufs-mcq.c:87: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_config_mac' drivers/ufs/core/ufs-mcq.c:87: warning: Function parameter or member 'max_active_cmds' not described in 'ufshcd_mcq_config_mac' drivers/ufs/core/ufs-mcq.c:107: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_req_to_hwq' drivers/ufs/core/ufs-mcq.c:107: warning: Function parameter or member 'req' not described in 'ufshcd_mcq_req_to_hwq' drivers/ufs/core/ufs-mcq.c:128: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_decide_queue_depth'
--- drivers/ufs/core/ufs-mcq.c | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)
drivers/ufs/core/ufs-mcq.c +5 -5
@@ -77,8 +77,8 @@ MODULE_PARM_DESC(poll_queues,/** * ufshcd_mcq_config_mac - Set the #Max Activ Cmds. -* @hba - per adapter instance -* @max_active_cmds - maximum # of active commands to the device at any time. +* @hba: per adapter instance +* @max_active_cmds: maximum # of active commands to the device at any time. * * The controller won't send more than the max_active_cmds to the device at * any time.
@@ -96,8 +96,8 @@ void ufshcd_mcq_config_mac(struct ufs_hba *hba, u32 max_active_cmds)/** * ufshcd_mcq_req_to_hwq - find the hardware queue on which the * request would be issued. -* @hba - per adapter instance -* @req - pointer to the request to be issued +* @hba: per adapter instance +* @req: pointer to the request to be issued * * Returns the hardware queue instance on which the request would * be queued.
@@ -114,7 +114,7 @@ struct ufs_hw_queue *ufshcd_mcq_req_to_hwq(struct ufs_hba *hba,/** * ufshcd_mcq_decide_queue_depth - decide the queue depth -* @hba - per adapter instance +* @hba: per adapter instance * * Returns queue-depth on success, non-zero on error *
Quoted 8 lines · Bart Van Assche
Fix the following kernel-doc warnings:
drivers/ufs/core/ufs-mcq.c:87: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_config_mac'drivers/ufs/core/ufs-mcq.c:87: warning: Function parameter or member 'max_active_cmds' not described in 'ufshcd_mcq_config_mac'drivers/ufs/core/ufs-mcq.c:107: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_req_to_hwq'drivers/ufs/core/ufs-mcq.c:107: warning: Function parameter or member 'req' not described in 'ufshcd_mcq_req_to_hwq'drivers/ufs/core/ufs-mcq.c:128: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_decide_queue_depth'
Quoted 9 lines
Cc Asutosh Das <[email protected]>Fixes 854f84e7feeb ("scsi: ufs: core: mcq: Find hardware queue to queue request")Fixes 2468da61ea09 ("scsi: ufs: core: mcq: Configure operation and runtime interface")Fixes 7224c806876e ("scsi: ufs: core: mcq: Calculate queue depth")Signed-off-by Bart Van Assche <[email protected]>---
drivers/ufs/core/ufs-mcq.c| 10 +++++-----1 file changed, 5 insertions(+), 5 deletions(-)
Thanks for the fix.
Quoted 35 lines
drivers/ufs/core/ufs-mcq.c +5
-5@@ -77,8 +77,8 @@ MODULE_PARM_DESC(poll_queues,/** * ufshcd_mcq_config_mac - Set the #Max Activ Cmds. -* @hba - per adapter instance -* @max_active_cmds - maximum # of active commands to the device at any time. +* @hba: per adapter instance +* @max_active_cmds: maximum # of active commands to the device at any time. * * The controller won't send more than the max_active_cmds to the device at * any time. @@ -96,8 +96,8 @@ void ufshcd_mcq_config_mac(struct ufs_hba *hba, u32 max_active_cmds)/** * ufshcd_mcq_req_to_hwq - find the hardware queue on which the * request would be issued. -* @hba - per adapter instance -* @req - pointer to the request to be issued +* @hba: per adapter instance +* @req: pointer to the request to be issued * * Returns the hardware queue instance on which the request would * be queued. @@ -114,7 +114,7 @@ struct ufs_hw_queue *ufshcd_mcq_req_to_hwq(struct ufs_hba *hba,/** * ufshcd_mcq_decide_queue_depth - decide the queue depth -* @hba - per adapter instance +* @hba: per adapter instance * * Returns queue-depth on success, non-zero on error *
Martin K. Petersen
AppliedBart,
Quoted 7 lines
Fix the following kernel-doc warnings:
drivers/ufs/core/ufs-mcq.c:87: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_config_mac'drivers/ufs/core/ufs-mcq.c:87: warning: Function parameter or member 'max_active_cmds' not described in 'ufshcd_mcq_config_mac'drivers/ufs/core/ufs-mcq.c:107: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_req_to_hwq'drivers/ufs/core/ufs-mcq.c:107: warning: Function parameter or member 'req' not described in 'ufshcd_mcq_req_to_hwq'drivers/ufs/core/ufs-mcq.c:128: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_decide_queue_depth'
Applied to 6.3/scsi-staging, thanks!
Signature · 1 line
Martin K. Petersen Oracle Linux Engineering
Martin K. Petersen
AppliedQuoted 9 lines · Bart Van Assche
Fix the following kernel-doc warnings:
drivers/ufs/core/ufs-mcq.c:87: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_config_mac'drivers/ufs/core/ufs-mcq.c:87: warning: Function parameter or member 'max_active_cmds' not described in 'ufshcd_mcq_config_mac'drivers/ufs/core/ufs-mcq.c:107: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_req_to_hwq'drivers/ufs/core/ufs-mcq.c:107: warning: Function parameter or member 'req' not described in 'ufshcd_mcq_req_to_hwq'drivers/ufs/core/ufs-mcq.c:128: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_decide_queue_depth'[...]
Applied to 6.3/scsi-queue, thanks!
[1/1] scsi: ufs: Fix kernel-doc syntax
https://git.kernel.org/mkp/scsi/c/b62c8292d223
Signature · 1 line
Martin K. Petersen Oracle Linux Engineering