scsi: ufs: some cleanups and make the delay for host enabling customizable
Subsystems (2)
v3 cover scsi: ufs: some cleanups and make the delay for host enabling customizable
Hi,
This patchset applies some driver cleanups and performance improvement in ufs host drivers by making the delay for host enabling customizable according to vendors' requirements.
v2 -> v3
- Remove /arch/arm64/configs/defconfig chnage because it is for local test only
v1 -> v2
- Add patch #1 "scsi: ufs: fix uninitialized tx_lanes in ufshcd_disable_tx_lcc"
- Remove struct ufs_init_prefetch in patch #2
- Introduce common delay function in patch #4
- Replace all delay places by common delay function in ufs-mediatek in patch #5
- Use common delay function instead for host enabling delay in patch #6
- Add patch #7 "scsi: ufs: make HCE polling more compact to improve initializatoin latency"
- In patch #8, customize the delay in ufs_mtk_hce_enable_notify callback instead of ufs_mtk_init (Avri)
Stanley Chu (8):
scsi: ufs: fix uninitialized tx_lanes in ufshcd_disable_tx_lcc()
scsi: ufs: remove init_prefetch_data in struct ufs_hba
scsi: ufs: use an enum for host capabilities
scsi: ufs: introduce common delay function
scsi: ufs-mediatek: replace all delay places by common delay function
scsi: ufs: allow customized delay for host enabling
scsi: ufs: make HCE polling more compact to improve initializatoin
latency
scsi: ufs-mediatek: customize the delay for host enabling
drivers/scsi/ufs/ufs-mediatek.c | 35 ++++++++------- drivers/scsi/ufs/ufshcd.c | 47 +++++++++++--------- drivers/scsi/ufs/ufshcd.h | 78 ++++++++++++++++----------------- 3 files changed, 85 insertions(+), 75 deletions(-)
Signature · 1 line
2.18.0
PATCH v3 1/8 scsi: ufs: fix uninitialized tx_lanes in ufshcd_disable_tx_lcc()
In ufshcd_disable_tx_lcc(), if ufshcd_dme_get() or ufshcd_dme_peer_get() get fail, uninitialized variable "tx_lanes" may be used as unexpected lane ID for DME configuration.
Fix this issue by initializing "tx_lanes".
--- drivers/scsi/ufs/ufshcd.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/scsi/ufs/ufshcd.c +1 -1
@@ -4315,7 +4315,7 @@ EXPORT_SYMBOL_GPL(ufshcd_hba_enable);static int ufshcd_disable_tx_lcc (struct ufs_hba *hba,bool peer) { -int tx_lanes, i, err =0 ; +int tx_lanes =0 , i, err =0 ;if (!peer) ufshcd_dme_get(hba, UIC_ARG_MIB(PA_CONNECTEDTXDATALANES),
Signature · 1 line
2.18.0
PATCH v3 2/8 scsi: ufs: remove init_prefetch_data in struct ufs_hba
In reply to Stanley ChuStruct init_prefetch_data currently is used privately in ufshcd_init_icc_levels(), thus it can be removed from struct ufs_hba.
--- drivers/scsi/ufs/ufshcd.c | 15 ++++++--------- drivers/scsi/ufs/ufshcd.h | 11 ----------- 2 files changed, 6 insertions(+), 20 deletions(-)
drivers/scsi/ufs/ufshcd.c +6 -9
@@ -6501,6 +6501,7 @@ static void ufshcd_init_icc_levels(struct ufs_hba *hba) {int ret;int buff_len = hba->desc_size.pwr_desc; +u32 icc_level;u8 *desc_buf; desc_buf =kmalloc (buff_len,GFP_KERNEL );
@@ -6516,21 +6517,17 @@ static void ufshcd_init_icc_levels(struct ufs_hba *hba) goto out; } - hba->init_prefetch_data.icc_level = -ufshcd_find_max_sup_active_icc_level (hba, - desc_buf, buff_len); -dev_dbg (hba->dev,"%s: setting icc_level 0x%x" , - __func__, hba->init_prefetch_data.icc_level); + icc_level = +ufshcd_find_max_sup_active_icc_level (hba, desc_buf, buff_len); +dev_dbg (hba->dev,"%s: setting icc_level 0x%x" , __func__, icc_level); ret =ufshcd_query_attr_retry (hba,UPIU_QUERY_OPCODE_WRITE_ATTR , -QUERY_ATTR_IDN_ACTIVE_ICC_LVL ,0 ,0 , - &hba->init_prefetch_data.icc_level); +QUERY_ATTR_IDN_ACTIVE_ICC_LVL ,0 ,0 , &icc_level);if (ret)dev_err (hba->dev,"%s: Failed configuring bActiveICCLevel = %d ret = %d" , - __func__, hba->init_prefetch_data.icc_level , ret); - + __func__, icc_level, ret); out:kfree (desc_buf); }
drivers/scsi/ufs/ufshcd.h +0 -11
@@ -402,15 +402,6 @@ struct ufs_clk_scaling {bool is_suspended; }; -/** -* struct ufs_init_prefetch - contains data that is pre-fetched once during -* initialization -* @icc_level: icc level which was read during initialization -*/ -struct ufs_init_prefetch { -u32 icc_level; -}; -#define UFS_ERR_REG_HIST_LENGTH 8/** * struct ufs_err_reg_hist - keeps history of errors
@@ -541,7 +532,6 @@ enum ufshcd_quirks {* @intr_mask: Interrupt Mask Bits * @ee_ctrl_mask: Exception event control mask * @is_powered: flag to check if HBA is powered -* @init_prefetch_data: data pre-fetched during initialization * @eh_work: Worker to handle UFS errors that require s/w attention * @eeh_work: Worker to handle exception events * @errors: HBA errors
@@ -627,7 +617,6 @@ struct ufs_hba {u32 intr_mask;u16 ee_ctrl_mask;bool is_powered; -struct ufs_init_prefetch init_prefetch_data;/* Work Queues */ struct work_struct eh_work;
Signature · 1 line
2.18.0
PATCH v3 3/8 scsi: ufs: use an enum for host capabilities
In reply to Stanley ChuUse an enum to specify the host capabilities instead of #defines inside the structure definition.
--- drivers/scsi/ufs/ufshcd.h | 65 ++++++++++++++++++++++----------------- 1 file changed, 37 insertions(+), 28 deletions(-)
drivers/scsi/ufs/ufshcd.h +37 -28
@@ -501,6 +501,43 @@ enum ufshcd_quirks { UFSHCD_QUIRK_BROKEN_UFS_HCI_VERSION = 1 << 5, }; +enum ufshcd_caps { +/* Allow dynamic clk gating */ +UFSHCD_CAP_CLK_GATING =1 <<0 , + +/* Allow hiberb8 with clk gating */ +UFSHCD_CAP_HIBERN8_WITH_CLK_GATING =1 <<1 , + +/* Allow dynamic clk scaling */ +UFSHCD_CAP_CLK_SCALING =1 <<2 , + +/* Allow auto bkops to enabled during runtime suspend */ +UFSHCD_CAP_AUTO_BKOPS_SUSPEND =1 <<3 , + +/* +* This capability allows host controller driver to use the UFS HCI's +* interrupt aggregation capability. +* CAUTION: Enabling this might reduce overall UFS throughput. +*/ +UFSHCD_CAP_INTR_AGGR =1 <<4 , + +/* +* This capability allows the device auto-bkops to be always enabled +* except during suspend (both runtime and suspend). +* Enabling this capability means that device will always be allowed +* to do background operation when it's active but it might degrade +* the performance of ongoing read/write operations. +*/ +UFSHCD_CAP_KEEP_AUTO_BKOPS_ENABLED_EXCEPT_SUSPEND =1 <<5 , + +/* +* This capability allows host controller driver to automatically +* enable runtime power management by itself instead of waiting +* for userspace to control the power management. +*/ +UFSHCD_CAP_RPM_AUTOSUSPEND =1 <<6 , +}; +/** * struct ufs_hba - per adapter private structure * @mmio_base: UFSHCI base register address
@@ -653,34 +690,6 @@ struct ufs_hba {struct ufs_clk_gating clk_gating;/* Control to enable/disable host capabilities */ u32 caps; -/* Allow dynamic clk gating */ -#define UFSHCD_CAP_CLK_GATING (1 << 0) -/* Allow hiberb8 with clk gating */ -#define UFSHCD_CAP_HIBERN8_WITH_CLK_GATING (1 << 1) -/* Allow dynamic clk scaling */ -#define UFSHCD_CAP_CLK_SCALING (1 << 2) -/* Allow auto bkops to enabled during runtime suspend */ -#define UFSHCD_CAP_AUTO_BKOPS_SUSPEND (1 << 3) -/* -* This capability allows host controller driver to use the UFS HCI's -* interrupt aggregation capability. -* CAUTION: Enabling this might reduce overall UFS throughput. -*/ -#define UFSHCD_CAP_INTR_AGGR (1 << 4) -/* -* This capability allows the device auto-bkops to be always enabled -* except during suspend (both runtime and suspend). -* Enabling this capability means that device will always be allowed -* to do background operation when it's active but it might degrade -* the performance of ongoing read/write operations. -*/ -#define UFSHCD_CAP_KEEP_AUTO_BKOPS_ENABLED_EXCEPT_SUSPEND (1 << 5) -/* -* This capability allows host controller driver to automatically -* enable runtime power management by itself instead of waiting -* for userspace to control the power management. -*/ -#define UFSHCD_CAP_RPM_AUTOSUSPEND (1 << 6)struct devfreq *devfreq;struct ufs_clk_scaling clk_scaling;
Signature · 5 lines
2.18.0 _______________________________________________ linux-arm-kernel mailing list [email protected] http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
PATCH v3 4/8 scsi: ufs: introduce common delay function
In reply to Stanley ChuIntroduce common delay function to collect all delay requirements to simplify driver and take choices of udelay and usleep_range into consideration.
--- drivers/scsi/ufs/ufshcd.c | 27 ++++++++++++++++++--------- drivers/scsi/ufs/ufshcd.h | 1 + 2 files changed, 19 insertions(+), 9 deletions(-)
drivers/scsi/ufs/ufshcd.c +18 -9
@@ -597,6 +597,18 @@ static void ufshcd_print_pwr_info(struct ufs_hba *hba) hba->pwr_info.hs_rate); } +void ufshcd_wait_us (unsigned long us,unsigned long tolerance,bool can_sleep) +{ +if (!us) +return ; + +if (us <10 || !can_sleep) +udelay (us); +else +usleep_range (us, us + tolerance); +} +EXPORT_SYMBOL_GPL (ufshcd_wait_us); +/* * ufshcd_wait_for_register - wait for register value to change * @hba - per-adapter interface
@@ -620,10 +632,7 @@ int ufshcd_wait_for_register(struct ufs_hba *hba, u32 reg, u32 mask, val = val & mask;while ((ufshcd_readl (hba, reg) & mask) != val) { -if (can_sleep) -usleep_range (interval_us, interval_us +50 ); -else -udelay (interval_us); +ufshcd_wait_us (interval_us,50 , can_sleep);if (time_after (jiffies, timeout)) {if ((ufshcd_readl (hba, reg) & mask) != val) err = -ETIMEDOUT ;
@@ -3565,7 +3574,7 @@ static inline void ufshcd_add_delay_before_dme_cmd(struct ufs_hba *hba) }/* allow sleep for extra 50us if needed */ -usleep_range (min_sleep_time_us, min_sleep_time_us +50 ); +ufshcd_wait_us (min_sleep_time_us,50 , true); }/**
@@ -4289,7 +4298,7 @@ int ufshcd_hba_enable(struct ufs_hba *hba)* instruction might be read back. * This delay can be changed based on the controller. */ -usleep_range (1000 ,1100 ); +ufshcd_wait_us (1000 ,100 , true);/* wait for the host controller to complete initialization */ retry =10 ;
@@ -4301,7 +4310,7 @@ int ufshcd_hba_enable(struct ufs_hba *hba) "Controller enable failed\n");return -EIO ; } -usleep_range (5000 ,5100 ); +ufshcd_wait_us (5000 ,100 , true); }/* enable UIC related interrupts */
@@ -6224,7 +6233,7 @@ static int ufshcd_abort(struct scsi_cmnd *cmd) reg =ufshcd_readl (hba,REG_UTP_TRANSFER_REQ_DOOR_BELL );if (reg & (1 << tag)) {/* sleep for max. 200us to stabilize */ -usleep_range (100 ,200 ); +ufshcd_wait_us (100 ,100 , true);continue ; }/* command completed already */
@@ -7783,7 +7792,7 @@ static void ufshcd_vreg_set_lpm(struct ufs_hba *hba)*/ if (!ufshcd_is_link_active (hba) && hba->dev_quirks &UFS_DEVICE_QUIRK_DELAY_BEFORE_LPM ) -usleep_range (2000 ,2100 ); +ufshcd_wait_us (2000 ,100 , true);/* * If UFS device is either in UFS_Sleep turn off VCC rail to save some
drivers/scsi/ufs/ufshcd.h +1 -0
@@ -781,6 +781,7 @@ int ufshcd_init(struct ufs_hba * , void __iomem * , unsigned int);int ufshcd_make_hba_operational (struct ufs_hba *hba);void ufshcd_remove (struct ufs_hba *);int ufshcd_uic_hibern8_exit (struct ufs_hba *hba); +void ufshcd_wait_us (unsigned long us,unsigned long tolerance,bool can_sleep);int ufshcd_wait_for_register (struct ufs_hba *hba,u32 reg,u32 mask,u32 val,unsigned long interval_us,unsigned long timeout_ms,bool can_sleep);
Signature · 1 line
2.18.0
PATCH v3 5/8 scsi: ufs-mediatek: replace all delay places by common delay function
In reply to Stanley ChuA common delay function is introduced in UFS core driver, thus ufs-mediatek can use it to replace all delay codes.
--- drivers/scsi/ufs/ufs-mediatek.c | 21 +++++---------------- 1 file changed, 5 insertions(+), 16 deletions(-)
drivers/scsi/ufs/ufs-mediatek.c +5 -16
@@ -100,17 +100,6 @@ static int ufs_mtk_bind_mphy(struct ufs_hba *hba)return err; } -static void ufs_mtk_udelay (unsigned long us) -{ -if (!us) -return ; - -if (us <10 ) -udelay (us); -else -usleep_range (us, us +10 ); -} -static int ufs_mtk_setup_ref_clk (struct ufs_hba *hba,bool on) {struct ufs_mtk_host *host =ufshcd_get_variant (hba);
@@ -123,7 +112,7 @@ static int ufs_mtk_setup_ref_clk(struct ufs_hba *hba, bool on)if (on) {ufs_mtk_ref_clk_notify (on, res); -ufs_mtk_udelay (host->ref_clk_ungating_wait_us); +ufshcd_wait_us (host->ref_clk_ungating_wait_us,10 , true);ufshcd_writel (hba,REFCLK_REQUEST ,REG_UFS_REFCLK_CTRL ); }else {ufshcd_writel (hba,REFCLK_RELEASE ,REG_UFS_REFCLK_CTRL );
@@ -138,7 +127,7 @@ static int ufs_mtk_setup_ref_clk(struct ufs_hba *hba, bool on)if (((value &REFCLK_ACK ) >>1 ) == (value &REFCLK_REQUEST )) goto out; -usleep_range (100 ,200 ); +ufshcd_wait_us (100 ,100 , true); }while (time_before (jiffies, timeout));dev_err (hba->dev,"missing ack of refclk req, reg: 0x%x\n" , value);
@@ -150,7 +139,7 @@ static int ufs_mtk_setup_ref_clk(struct ufs_hba *hba, bool on) out: host->ref_clk_enabled = on;if (!on) { -ufs_mtk_udelay (host->ref_clk_gating_wait_us); +ufshcd_wait_us (host->ref_clk_gating_wait_us,10 , true);ufs_mtk_ref_clk_notify (on, res); }
@@ -430,12 +419,12 @@ static void ufs_mtk_device_reset(struct ufs_hba *hba)* * To be on safe side, keep the reset low for at least 10us. */ -usleep_range (10 ,15 ); +ufshcd_wait_us (10 ,5 , true);ufs_mtk_device_reset_ctrl (1 , res);/* Some devices may need time to respond to rst_n */ -usleep_range (10000 ,15000 ); +ufshcd_wait_us (10000 ,5000 , true);dev_info (hba->dev,"device reset done\n" ); }
Signature · 1 line
2.18.0
PATCH v3 6/8 scsi: ufs: allow customized delay for host enabling
In reply to Stanley ChuCurrently a 1 ms delay is applied before polling CONTROLLER_ENABLE bit. This delay may not be required or can be changed in different controllers. Make the delay as a changeable value in struct ufs_hba to allow it customized by vendors.
--- drivers/scsi/ufs/ufshcd.c | 3 ++- drivers/scsi/ufs/ufshcd.h | 1 + 2 files changed, 3 insertions(+), 1 deletion(-)
drivers/scsi/ufs/ufshcd.c +2 -1
@@ -4298,7 +4298,7 @@ int ufshcd_hba_enable(struct ufs_hba *hba)* instruction might be read back. * This delay can be changed based on the controller. */ -ufshcd_wait_us (1000 ,100 , true); +ufshcd_wait_us (hba->hba_enable_delay_us,100 , true);/* wait for the host controller to complete initialization */ retry =10 ;
@@ -8418,6 +8418,7 @@ int ufshcd_init(struct ufs_hba *hba, void __iomem *mmio_base, unsigned int irq) hba->mmio_base = mmio_base; hba->irq = irq; + hba->hba_enable_delay_us =1000 ; err =ufshcd_hba_init (hba);if (err)
drivers/scsi/ufs/ufshcd.h +1 -0
@@ -653,6 +653,7 @@ struct ufs_hba {u32 eh_flags;u32 intr_mask;u16 ee_ctrl_mask; +u16 hba_enable_delay_us;bool is_powered;/* Work Queues */
Signature · 1 line
2.18.0
PATCH v3 7/8 scsi: ufs: make HCE polling more compact to improve initializatoin latency
In reply to Stanley ChuReduce the waiting period between each HCE (Host Controller Enable) polling from 5 ms to 1 ms. In the same time, increase the maximum polling times to make "total polling time" unchanged approximately.
This change could make HCE initializatoin faster to improve latency of ufshcd initialization, error recovery, and resume behaviors.
--- drivers/scsi/ufs/ufshcd.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/scsi/ufs/ufshcd.c +2 -2
@@ -4301,7 +4301,7 @@ int ufshcd_hba_enable(struct ufs_hba *hba)ufshcd_wait_us (hba->hba_enable_delay_us,100 , true);/* wait for the host controller to complete initialization */ - retry =10 ; + retry =50 ;while (ufshcd_is_hba_active (hba)) {if (retry) { retry--;
@@ -4310,7 +4310,7 @@ int ufshcd_hba_enable(struct ufs_hba *hba) "Controller enable failed\n");return -EIO ; } -ufshcd_wait_us (5000 ,100 , true); +ufshcd_wait_us (1000 ,100 , true); }/* enable UIC related interrupts */
Signature · 1 line
2.18.0
PATCH v3 8/8 scsi: ufs-mediatek: customize the delay for host enabling
In reply to Stanley ChuMediaTek platform and UFS controller can dynamically customize the delay for host enabling according to different scenarios.
For example, for host initialization with low-level MPHY calibration required, longer delay shall be expected. But the delay could be removed if such MPHY calibration can be skipped, like resume flow.
--- drivers/scsi/ufs/ufs-mediatek.c | 14 ++++++++++++++ 1 file changed, 14 insertions(+)
drivers/scsi/ufs/ufs-mediatek.c +14 -0
@@ -71,6 +71,19 @@ static void ufs_mtk_cfg_unipro_cg(struct ufs_hba *hba, bool enable) } } +static int ufs_mtk_hce_enable_notify (struct ufs_hba *hba, +enum ufs_notify_change_status status) +{ +if (status ==PRE_CHANGE ) { +if (hba->pm_op_in_progress) + hba->hba_enable_delay_us =0 ; +else + hba->hba_enable_delay_us =100 ; + } + +return 0 ; +} +static int ufs_mtk_bind_mphy (struct ufs_hba *hba) {struct ufs_mtk_host *host =ufshcd_get_variant (hba);
@@ -552,6 +565,7 @@ static struct ufs_hba_variant_ops ufs_hba_mtk_vops = { .name = "mediatek.ufshci", .init = ufs_mtk_init, .setup_clocks = ufs_mtk_setup_clocks, + .hce_enable_notify = ufs_mtk_hce_enable_notify, .link_startup_notify = ufs_mtk_link_startup_notify, .pwr_change_notify = ufs_mtk_pwr_change_notify, .apply_dev_quirks = ufs_mtk_apply_dev_quirks,
Signature · 1 line
2.18.0