fix abort defect
Subsystems (5)
[email protected]
maintainerv7 cover fix abort defect
From: Peter Wang <[email protected]>
This series fixes MCQ and SDB abort defect.
V7:
- Use a variable instead of a flag.
- Add a check for MCQ mode when setting this variable to UFS_ERR_HANDLER.
- Print OCS information for OCS_ABORTED and OCS_INVALID_COMMAND_STATUS.
- Add a MediaTek quirk for handling OCS_ABORTED in SDB mode.
- Skip notifying SCSI from ISR during SCSI abort (ufshcd_abort()).
V6:
- Add err handler check before set flag true.
V5:
- Change flag name.
- Amend comment and patch description.
V4:
- Remove nullify SQ entry abort requeue.
- Add more comment for flag usage and set description.
- Fix build warning.
V3:
- Change comment and use variable(rtc) for error print
- Change flag name and move flag set before ufshcd_clear_cmd
- Add SDB mode clear UTRLCLR tag receive OCS_ABORTED requeue
V2:
- Fix mcq_enabled build error.
Peter Wang (4):
ufs: core: fix the issue of ICU failure
ufs: core: requeue aborted request
ufs: core: add a quirk for MediaTek SDB mode aborted
ufs: core: skip ISR notifying scsi when ufshcd_abort
drivers/ufs/core/ufs-mcq.c | 21 ++++++---- drivers/ufs/core/ufshcd.c | 68 +++++++++++++++++++++++++-------- drivers/ufs/host/ufs-mediatek.c | 1 + include/ufs/ufshcd.h | 15 ++++++++ 4 files changed, 83 insertions(+), 22 deletions(-)
Signature · 1 line
2.45.2
[email protected]
maintainerPATCH v7 1/4 ufs: core: fix the issue of ICU failure
From: Peter Wang <[email protected]>
When setting the ICU bit without using read-modify-write, SQRTCy will restart SQ again and receive an RTC return error code 2 (Failure - SQ not stopped).
Additionally, the error log has been modified so that this type of error can be observed.
--- drivers/ufs/core/ufs-mcq.c | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-)
drivers/ufs/core/ufs-mcq.c +8 -7
@@ -539,7 +539,7 @@ int ufshcd_mcq_sq_cleanup(struct ufs_hba *hba, int task_tag)struct scsi_cmnd *cmd = lrbp->cmd;struct ufs_hw_queue *hwq;void __iomem *reg, *opr_sqd_base; -u32 nexus, id, val; +u32 nexus, id, val, rtc;int err;if (hba->quirks &UFSHCD_QUIRK_MCQ_BROKEN_RTC )
@@ -569,17 +569,18 @@ int ufshcd_mcq_sq_cleanup(struct ufs_hba *hba, int task_tag) opr_sqd_base =mcq_opr_base (hba,OPR_SQD , id);writel (nexus, opr_sqd_base +REG_SQCTI ); -/* SQRTCy.ICU = 1 */ -writel (SQ_ICU , opr_sqd_base +REG_SQRTC ); +/* Initiate Cleanup */ +writel (readl (opr_sqd_base +REG_SQRTC ) |SQ_ICU , + opr_sqd_base +REG_SQRTC );/* Poll SQRTSy.CUS = 1. Return result from SQRTSy.RTC */ reg = opr_sqd_base +REG_SQRTS ; err =read_poll_timeout (readl, val, val &SQ_CUS ,20 ,MCQ_POLL_US , false, reg); -if (err) -dev_err (hba->dev,"%s: failed. hwq=%d, tag=%d err=%ld\n" , - __func__, id, task_tag, -FIELD_GET (SQ_ICU_ERR_CODE_MASK ,readl (reg))); + rtc =FIELD_GET (SQ_ICU_ERR_CODE_MASK ,readl (reg)); +if (err || rtc) +dev_err (hba->dev,"%s: failed. hwq=%d, tag=%d err=%d RTC=%d\n" , + __func__, id, task_tag, err, rtc);if (ufshcd_mcq_sq_start (hba, hwq)) err = -ETIMEDOUT ;
Signature · 1 line
2.45.2
[email protected]
maintainerPATCH v7 2/4 ufs: core: requeue aborted request
In reply to [email protected]From: Peter Wang <[email protected]>
Regarding the specification of MCQ:
Aborts a command using SQ cleanup, The host controller will post a Completion Queue entry with OCS = ABORTED.
ufshcd_abort_all forcibly aborts all on-going commands. In MCQ mode, set a variable to notify SCSI to requeue the command after receiving response with OCS_ABORTED. This approach would then be consistent with legacy SDB mode.
Below is ufshcd_err_handler legacy SDB flow:ufshcd_err_handler()
ufshcd_abort_all()
ufshcd_abort_one()
ufshcd_try_to_abort_task()
ufshcd_complete_requests()
ufshcd_transfer_req_compl()
ufshcd_poll()
get outstanding_lock
clear outstanding_reqs tag
release outstanding_lock
__ufshcd_transfer_req_compl()
ufshcd_compl_one_cqe()
cmd->result = DID_REQUEUE
ufshcd_release_scsi_cmd()
scsi_done()ufshcd_intr()
ufshcd_sl_intr()
ufshcd_transfer_req_compl()
ufshcd_poll()
get outstanding_lock
clear outstanding_reqs tag
release outstanding_lock
__ufshcd_transfer_req_compl()
ufshcd_compl_one_cqe()
cmd->result = DID_REQUEUE
ufshcd_release_scsi_cmd()
scsi_done();Below is ufshcd_err_handler MCQ flow:
ufshcd_err_handler()
ufshcd_abort_all()
ufshcd_abort_one()
ufshcd_try_to_abort_task()
ufshcd_complete_requests()
ufshcd_mcq_compl_pending_transfer()
ufshcd_mcq_poll_cqe_lock()
ufshcd_mcq_process_cqe()
ufshcd_compl_one_cqe()
cmd->result = DID_ABORT // should change to DID_REQUEUE
ufshcd_release_scsi_cmd()
scsi_done()ufs_mtk_mcq_intr()
ufshcd_mcq_poll_cqe_lock()
ufshcd_mcq_process_cqe()
ufshcd_compl_one_cqe()
cmd->result = DID_ABORT // should change to DID_REQUEUE
ufshcd_release_scsi_cmd()
scsi_done()So what we need to correct is to notify SCSI to requeue when MCQ mode receives OCS: ABORTED.
--- drivers/ufs/core/ufshcd.c | 40 ++++++++++++++++++++++++--------------- include/ufs/ufshcd.h | 8 ++++++++ 2 files changed, 33 insertions(+), 15 deletions(-)
drivers/ufs/core/ufshcd.c +25 -15
@@ -3006,6 +3006,7 @@ static int ufshcd_queuecommand(struct Scsi_Host *host, struct scsi_cmnd *cmd)ufshcd_prepare_lrbp_crypto (scsi_cmd_to_rq (cmd), lrbp); lrbp->req_abort_skip = false; + lrbp->abort_initiated_by =UFS_NO_ABORT ;ufshcd_comp_scsi_upiu (hba, lrbp);
@@ -5404,10 +5405,19 @@ ufshcd_transfer_rsp_status(struct ufs_hba *hba, struct ufshcd_lrb *lrbp, }break ;case OCS_ABORTED : - result |=DID_ABORT <<16 ; +if (lrbp->abort_initiated_by ==UFS_ERR_HANDLER ) + result |=DID_REQUEUE <<16 ; +else + result |=DID_ABORT <<16 ; +dev_warn (hba->dev, +"OCS aborted from controller = %x for tag %d\n" , + ocs, lrbp->task_tag);break ;case OCS_INVALID_COMMAND_STATUS : result |=DID_REQUEUE <<16 ; +dev_warn (hba->dev, +"OCS invaild from controller = %x for tag %d\n" , + ocs, lrbp->task_tag);break ;case OCS_INVALID_CMD_TABLE_ATTR :case OCS_INVALID_PRDT_ATTR :
@@ -6471,26 +6481,12 @@ static bool ufshcd_abort_one(struct request *rq, void *priv)struct scsi_device *sdev = cmd->device;struct Scsi_Host *shost = sdev->host;struct ufs_hba *hba =shost_priv (shost); -struct ufshcd_lrb *lrbp = &hba->lrb[tag]; -struct ufs_hw_queue *hwq; -unsigned long flags; *ret =ufshcd_try_to_abort_task (hba, tag);dev_err (hba->dev,"Aborting tag %d / CDB %#02x %s\n" , tag, hba->lrb[tag].cmd ? hba->lrb[tag].cmd->cmnd[0 ] :-1 , *ret ?"failed" :"succeeded" ); -/* Release cmd in MCQ mode if abort succeeds */ -if (hba->mcq_enabled && (*ret ==0 )) { - hwq =ufshcd_mcq_req_to_hwq (hba,scsi_cmd_to_rq (lrbp->cmd)); -if (!hwq) -return 0 ; -spin_lock_irqsave (&hwq->cq_lock, flags); -if (ufshcd_cmd_inflight (lrbp->cmd)) -ufshcd_release_scsi_cmd (hba, lrbp); -spin_unlock_irqrestore (&hwq->cq_lock, flags); - } -return *ret ==0 ; }
@@ -7561,6 +7557,20 @@ int ufshcd_try_to_abort_task(struct ufs_hba *hba, int tag) goto out; } +/* +* When the host software receives a "FUNCTION COMPLETE", set this +* variable to requeue command after receive response with OCS_ABORTED +* +* MCQ mode: Host will post to CQ with OCS_ABORTED after SQ cleanup +* +* This variable is set because error handler ufshcd_abort_all forcibly +* aborts all commands, and the host controller will automatically +* fill in the OCS field of the corresponding response with OCS_ABORTED. +* Therefore, upon receiving this response, it needs to be requeued. +*/ +if (!err && hba->mcq_enabled &&ufshcd_eh_in_progress (hba)) + lrbp->abort_initiated_by =UFS_ERR_HANDLER ; + err =ufshcd_clear_cmd (hba, tag);if (err) dev_err(hba->dev, "%s: Failed clearing cmd at tag %d, err %d\n",
include/ufs/ufshcd.h +8 -0
@@ -145,6 +145,11 @@ enum ufs_pm_level {UFS_PM_LVL_MAX }; +enum ufs_abort_by { +UFS_NO_ABORT , +UFS_ERR_HANDLER , +}; +struct ufs_pm_lvl_states {enum ufs_dev_pwr_mode dev_state;enum uic_link_state link_state;
@@ -173,6 +178,8 @@ struct ufs_pm_lvl_states {* @crypto_key_slot: the key slot to use for inline crypto (-1 if none) * @data_unit_num: the data unit number for the first block for inline crypto * @req_abort_skip: skip request abort task flag +* @abort_initiated_by: This variable is used to store the scenario in +* which the abort occurs */ struct ufshcd_lrb {struct utp_transfer_req_desc *utr_descriptor_ptr;
@@ -202,6 +209,7 @@ struct ufshcd_lrb {#endif bool req_abort_skip; +int abort_initiated_by; };/**
Signature · 1 line
2.45.2
[email protected]
maintainerPATCH v7 3/4 ufs: core: add a quirk for MediaTek SDB mode aborted
In reply to [email protected]From: Peter Wang <[email protected]>
Because the MediaTek UFS controller uses UTRLCLR to clear commands and fills the OCS with ABORTED, this patch introduces a quirk to treat ABORTED as INVALID_OCS_VALUE.
--- drivers/ufs/core/ufshcd.c | 3 ++- drivers/ufs/host/ufs-mediatek.c | 1 + include/ufs/ufshcd.h | 6 ++++++ 3 files changed, 9 insertions(+), 1 deletion(-)
drivers/ufs/core/ufshcd.c +2 -1
@@ -5405,7 +5405,8 @@ ufshcd_transfer_rsp_status(struct ufs_hba *hba, struct ufshcd_lrb *lrbp, }break ;case OCS_ABORTED : -if (lrbp->abort_initiated_by ==UFS_ERR_HANDLER ) +if ((lrbp->abort_initiated_by ==UFS_ERR_HANDLER ) || + (!hba->mcq_enabled && (hba->quirks &UFSHCD_QUIRK_OCS_ABORTED ))) result |=DID_REQUEUE <<16 ;else result |=DID_ABORT <<16 ;
drivers/ufs/host/ufs-mediatek.c +1 -0
@@ -1021,6 +1021,7 @@ static int ufs_mtk_init(struct ufs_hba *hba) hba->quirks |=UFSHCI_QUIRK_SKIP_MANUAL_WB_FLUSH_CTRL ; hba->quirks |=UFSHCD_QUIRK_MCQ_BROKEN_INTR ; hba->quirks |=UFSHCD_QUIRK_MCQ_BROKEN_RTC ; + hba->quirks |=UFSHCD_QUIRK_OCS_ABORTED ; hba->vps->wb_flush_threshold =UFS_WB_BUF_REMAIN_PERCENT (80 );if (host->caps &UFS_MTK_CAP_DISABLE_AH8 )
include/ufs/ufshcd.h +6 -0
@@ -692,6 +692,12 @@ enum ufshcd_quirks {* single doorbell mode. */ UFSHCD_QUIRK_BROKEN_LSDBS_CAP =1 <<25 , + +/* +* Some host controllers set OCS_ABORTED after UTRLCLR (SDB mode), +* this quirk is set to treat OCS: ABORTED as INVALID_OCS_VALUE +*/ + UFSHCD_QUIRK_OCS_ABORTED = 1 << 26, }; enum ufshcd_caps {
Signature · 1 line
2.45.2
[email protected]
maintainerPATCH v7 4/4 ufs: core: skip ISR notifying scsi when ufshcd_abort
In reply to [email protected]From: Peter Wang <[email protected]>
When a SCSI abort occurs, ufshcd_try_to_abort_task may trigger the ISR, and the ISR may release the command and notify SCSI via scsi_done. This patch prevents the ISR from notifying SCSI to requeue, allowing SCSI to decide whether to requeue.
Below is ufshcd_abort legacy SDB flow:
ufshcd_abort()
ufshcd_try_to_abort_task() // will trigger ISR
get outstanding_lock
clear outstanding_reqs tag
ufshcd_release_scsi_cmd()
release outstanding_lock
ufshcd_intr()
ufshcd_sl_intr()
ufshcd_transfer_req_compl()
ufshcd_poll()
get outstanding_lock
clear outstanding_reqs tag
release outstanding_lock
__ufshcd_transfer_req_compl()
ufshcd_compl_one_cqe()
cmd->result = DID_REQUEUE
ufshcd_release_scsi_cmd()
scsi_done();In most cases, ufshcd_intr will not reach scsi_done because the outstanding_reqs tag is cleared by the original thread. Therefore, whether there is an interrupt or not doesn't affect the result because the ISR will do nothing in most cases.
In a very low chance, the ISR will reach scsi_done and notify SCSI to requeue, and the original thread will not call ufshcd_release_scsi_cmd. So should release because outstanding_reqs is clear by ISR.
Below is ufshcd_abort MCQ flow:
ufshcd_abort()
ufshcd_mcq_abort()
ufshcd_try_to_abort_task() // will trigger ISR
ufshcd_release_scsi_cmd()
ufs_mtk_mcq_intr()
ufshcd_mcq_poll_cqe_lock()
ufshcd_mcq_process_cqe()
ufshcd_compl_one_cqe()
cmd->result = DID_ABORT
ufshcd_release_scsi_cmd() // will release twice
scsi_done()In the case of MCQ ufshcd_abort, there is an issue where ufshcd_release_scsi_cmd might be called twice. We could simply skip the ISR release and scsi_done.
--- drivers/ufs/core/ufs-mcq.c | 6 ++++++ drivers/ufs/core/ufshcd.c | 27 +++++++++++++++++++++++++++ include/ufs/ufshcd.h | 1 + 3 files changed, 34 insertions(+)
drivers/ufs/core/ufs-mcq.c +6 -0
@@ -699,6 +699,12 @@ int ufshcd_mcq_abort(struct scsi_cmnd *cmd)return FAILED ; } +/* +* In MCQ mode, set this variable so that the ISR posted by +* the host controller can be skipped. +*/ + lrbp->abort_initiated_by =UFS_SCSI_ABORT ; +/* * The command is not in the submission queue, and it is not * in the completion queue either. Query the device to see if
drivers/ufs/core/ufshcd.c +27 -0
@@ -5537,6 +5537,27 @@ void ufshcd_compl_one_cqe(struct ufs_hba *hba, int task_tag,ufshcd_update_monitor (hba, lrbp);ufshcd_add_command_trace (hba, task_tag,UFS_CMD_COMP ); cmd->result =ufshcd_transfer_rsp_status (hba, lrbp, cqe); + +/* +* Let the SCSI layer decide how to handle the ufshcd_abort +* situation, neither releasing nor notifying scsi_done in MCQ +* mode. SDB mode should release because outstanding_reqs is +* clear by ISR. +*/ +if (lrbp->abort_initiated_by ==UFS_SCSI_ABORT ) { + ocs =ufshcd_get_tr_ocs (lrbp, cqe); +if ((hba->mcq_enabled) && (ocs ==OCS_ABORTED )) +return ; + +if ((!hba->mcq_enabled) && + ((ocs ==OCS_INVALID_COMMAND_STATUS ) || + ((hba->quirks &UFSHCD_QUIRK_OCS_ABORTED ) && + (ocs ==OCS_ABORTED )))) { +ufshcd_release_scsi_cmd (hba, lrbp); +return ; + } + } +ufshcd_release_scsi_cmd (hba, lrbp);/* Do not touch lrbp after scsi done */ scsi_done (cmd);
@@ -7673,6 +7694,12 @@ static int ufshcd_abort(struct scsi_cmnd *cmd) goto release; } +/* +* In SDB mode, set this variable so that the ISR posted by +* the host controller clear UTRLCLR can be skipped. +*/ + lrbp->abort_initiated_by =UFS_SCSI_ABORT ; + err =ufshcd_try_to_abort_task (hba, tag);if (err) {dev_err (hba->dev,"%s: failed with err %d\n" , __func__, err);
include/ufs/ufshcd.h +1 -0
@@ -148,6 +148,7 @@ enum ufs_pm_level {enum ufs_abort_by {UFS_NO_ABORT ,UFS_ERR_HANDLER , +UFS_SCSI_ABORT };struct ufs_pm_lvl_states {
Signature · 1 line
2.45.2
Bart Van Assche
reviewerQuoted 1 line · On 9/20/24 2:06 AM, [email protected] wrote:
This series fixes MCQ and SDB abort defect.
Hi Peter,
Patches 2, 3 and 4 in this series introduce a significant amount of complexity. Additionally, code paths are introduced that can only be triggered by UFS controllers that (incorrectly) generate a completion interrupt for aborted commands. I'm concerned that these patches will make the UFS host controller driver harder to maintain than necessary. Please take another look at the approach I proposed, namely making ufshcd_compl_one_cqe() ignore commands with completion status OCS_ABORTED. I think this approach will result in a simpler implementation, does not require a new quirk and minimizes the code paths that are only triggered by UFS host controllers that trigger a completion interrupt for aborted commands.
Thanks,
Bart.
Peter Wang (王信友)
maintainerQuoted 21 lines · Bart Van Assche
External email : Please do not click links or open attachments until you have verified the sender or the content.
Quoted 1 line · On 9/20/24 2:06 AM, [email protected] wrote:
This series fixes MCQ and SDB abort defect.
Hi Peter,
Patches 2, 3 and 4 in this series introduce a significant amount of complexity. Additionally, code paths are introduced that can only be triggered by UFS controllers that (incorrectly) generate a completion interrupt for aborted commands. I'm concerned that these patches will make the UFS host controller driver harder to maintain than necessary.
Please take another look at the approach I proposed, namely makingufshcd_compl_one_cqe()ignore commands with completion statusOCS_ABORTED. I think this approach will result in a simpler implementation, does not require a new quirk and minimizes the code paths that are only triggered by UFS host controllers that trigger a completion interrupt for aborted commands.
Quoted 3 lines
Thanks,
Bart.
Hi Bart,
Because I feel it's a bit weird to intentionally ignore a CQ slot in MCQ mode and directly requeue, but I will try to make changes according to your idea.
Thanks.
Peter