1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (c) 2013-2016, Linux Foundation. All rights reserved.
6 #include <linux/acpi.h>
8 #include <linux/delay.h>
9 #include <linux/devfreq.h>
10 #include <linux/gpio/consumer.h>
11 #include <linux/interconnect.h>
12 #include <linux/module.h>
14 #include <linux/phy/phy.h>
15 #include <linux/platform_device.h>
16 #include <linux/reset-controller.h>
17 #include <linux/time.h>
19 #include <soc/qcom/ice.h>
21 #include <ufs/ufshcd.h>
22 #include <ufs/ufshci.h>
23 #include <ufs/ufs_quirks.h>
24 #include <ufs/unipro.h>
25 #include "ufshcd-pltfrm.h"
28 #define MCQ_QCFGPTR_MASK GENMASK(7, 0)
29 #define MCQ_QCFGPTR_UNIT 0x200
30 #define MCQ_SQATTR_OFFSET(c) \
31 ((((c) >> 16) & MCQ_QCFGPTR_MASK) * MCQ_QCFGPTR_UNIT)
32 #define MCQ_QCFG_SIZE 0x40
50 #define QCOM_UFS_MAX_GEAR 5
51 #define QCOM_UFS_MAX_LANE 2
61 static const struct __ufs_qcom_bw_table
{
64 } ufs_qcom_bw_table
[MODE_MAX
+ 1][QCOM_UFS_MAX_GEAR
+ 1][QCOM_UFS_MAX_LANE
+ 1] = {
65 [MODE_MIN
][0][0] = { 0, 0 }, /* Bandwidth values in KB/s */
66 [MODE_PWM
][UFS_PWM_G1
][UFS_LANE_1
] = { 922, 1000 },
67 [MODE_PWM
][UFS_PWM_G2
][UFS_LANE_1
] = { 1844, 1000 },
68 [MODE_PWM
][UFS_PWM_G3
][UFS_LANE_1
] = { 3688, 1000 },
69 [MODE_PWM
][UFS_PWM_G4
][UFS_LANE_1
] = { 7376, 1000 },
70 [MODE_PWM
][UFS_PWM_G5
][UFS_LANE_1
] = { 14752, 1000 },
71 [MODE_PWM
][UFS_PWM_G1
][UFS_LANE_2
] = { 1844, 1000 },
72 [MODE_PWM
][UFS_PWM_G2
][UFS_LANE_2
] = { 3688, 1000 },
73 [MODE_PWM
][UFS_PWM_G3
][UFS_LANE_2
] = { 7376, 1000 },
74 [MODE_PWM
][UFS_PWM_G4
][UFS_LANE_2
] = { 14752, 1000 },
75 [MODE_PWM
][UFS_PWM_G5
][UFS_LANE_2
] = { 29504, 1000 },
76 [MODE_HS_RA
][UFS_HS_G1
][UFS_LANE_1
] = { 127796, 1000 },
77 [MODE_HS_RA
][UFS_HS_G2
][UFS_LANE_1
] = { 255591, 1000 },
78 [MODE_HS_RA
][UFS_HS_G3
][UFS_LANE_1
] = { 1492582, 102400 },
79 [MODE_HS_RA
][UFS_HS_G4
][UFS_LANE_1
] = { 2915200, 204800 },
80 [MODE_HS_RA
][UFS_HS_G5
][UFS_LANE_1
] = { 5836800, 409600 },
81 [MODE_HS_RA
][UFS_HS_G1
][UFS_LANE_2
] = { 255591, 1000 },
82 [MODE_HS_RA
][UFS_HS_G2
][UFS_LANE_2
] = { 511181, 1000 },
83 [MODE_HS_RA
][UFS_HS_G3
][UFS_LANE_2
] = { 1492582, 204800 },
84 [MODE_HS_RA
][UFS_HS_G4
][UFS_LANE_2
] = { 2915200, 409600 },
85 [MODE_HS_RA
][UFS_HS_G5
][UFS_LANE_2
] = { 5836800, 819200 },
86 [MODE_HS_RB
][UFS_HS_G1
][UFS_LANE_1
] = { 149422, 1000 },
87 [MODE_HS_RB
][UFS_HS_G2
][UFS_LANE_1
] = { 298189, 1000 },
88 [MODE_HS_RB
][UFS_HS_G3
][UFS_LANE_1
] = { 1492582, 102400 },
89 [MODE_HS_RB
][UFS_HS_G4
][UFS_LANE_1
] = { 2915200, 204800 },
90 [MODE_HS_RB
][UFS_HS_G5
][UFS_LANE_1
] = { 5836800, 409600 },
91 [MODE_HS_RB
][UFS_HS_G1
][UFS_LANE_2
] = { 298189, 1000 },
92 [MODE_HS_RB
][UFS_HS_G2
][UFS_LANE_2
] = { 596378, 1000 },
93 [MODE_HS_RB
][UFS_HS_G3
][UFS_LANE_2
] = { 1492582, 204800 },
94 [MODE_HS_RB
][UFS_HS_G4
][UFS_LANE_2
] = { 2915200, 409600 },
95 [MODE_HS_RB
][UFS_HS_G5
][UFS_LANE_2
] = { 5836800, 819200 },
96 [MODE_MAX
][0][0] = { 7643136, 819200 },
99 static void ufs_qcom_get_default_testbus_cfg(struct ufs_qcom_host
*host
);
100 static int ufs_qcom_set_core_clk_ctrl(struct ufs_hba
*hba
, bool is_scale_up
);
102 static struct ufs_qcom_host
*rcdev_to_ufs_host(struct reset_controller_dev
*rcd
)
104 return container_of(rcd
, struct ufs_qcom_host
, rcdev
);
107 #ifdef CONFIG_SCSI_UFS_CRYPTO
109 static inline void ufs_qcom_ice_enable(struct ufs_qcom_host
*host
)
111 if (host
->hba
->caps
& UFSHCD_CAP_CRYPTO
)
112 qcom_ice_enable(host
->ice
);
115 static int ufs_qcom_ice_init(struct ufs_qcom_host
*host
)
117 struct ufs_hba
*hba
= host
->hba
;
118 struct device
*dev
= hba
->dev
;
119 struct qcom_ice
*ice
;
121 ice
= of_qcom_ice_get(dev
);
122 if (ice
== ERR_PTR(-EOPNOTSUPP
)) {
123 dev_warn(dev
, "Disabling inline encryption support\n");
127 if (IS_ERR_OR_NULL(ice
))
128 return PTR_ERR_OR_ZERO(ice
);
131 hba
->caps
|= UFSHCD_CAP_CRYPTO
;
136 static inline int ufs_qcom_ice_resume(struct ufs_qcom_host
*host
)
138 if (host
->hba
->caps
& UFSHCD_CAP_CRYPTO
)
139 return qcom_ice_resume(host
->ice
);
144 static inline int ufs_qcom_ice_suspend(struct ufs_qcom_host
*host
)
146 if (host
->hba
->caps
& UFSHCD_CAP_CRYPTO
)
147 return qcom_ice_suspend(host
->ice
);
152 static int ufs_qcom_ice_program_key(struct ufs_hba
*hba
,
153 const union ufs_crypto_cfg_entry
*cfg
,
156 struct ufs_qcom_host
*host
= ufshcd_get_variant(hba
);
157 union ufs_crypto_cap_entry cap
;
159 cfg
->config_enable
& UFS_CRYPTO_CONFIGURATION_ENABLE
;
161 /* Only AES-256-XTS has been tested so far. */
162 cap
= hba
->crypto_cap_array
[cfg
->crypto_cap_idx
];
163 if (cap
.algorithm_id
!= UFS_CRYPTO_ALG_AES_XTS
||
164 cap
.key_size
!= UFS_CRYPTO_KEY_SIZE_256
)
168 return qcom_ice_program_key(host
->ice
,
169 QCOM_ICE_CRYPTO_ALG_AES_XTS
,
170 QCOM_ICE_CRYPTO_KEY_SIZE_256
,
172 cfg
->data_unit_size
, slot
);
174 return qcom_ice_evict_key(host
->ice
, slot
);
179 #define ufs_qcom_ice_program_key NULL
181 static inline void ufs_qcom_ice_enable(struct ufs_qcom_host
*host
)
185 static int ufs_qcom_ice_init(struct ufs_qcom_host
*host
)
190 static inline int ufs_qcom_ice_resume(struct ufs_qcom_host
*host
)
195 static inline int ufs_qcom_ice_suspend(struct ufs_qcom_host
*host
)
201 static void ufs_qcom_disable_lane_clks(struct ufs_qcom_host
*host
)
203 if (!host
->is_lane_clks_enabled
)
206 clk_bulk_disable_unprepare(host
->num_clks
, host
->clks
);
208 host
->is_lane_clks_enabled
= false;
211 static int ufs_qcom_enable_lane_clks(struct ufs_qcom_host
*host
)
215 err
= clk_bulk_prepare_enable(host
->num_clks
, host
->clks
);
219 host
->is_lane_clks_enabled
= true;
224 static int ufs_qcom_init_lane_clks(struct ufs_qcom_host
*host
)
227 struct device
*dev
= host
->hba
->dev
;
229 if (has_acpi_companion(dev
))
232 err
= devm_clk_bulk_get_all(dev
, &host
->clks
);
236 host
->num_clks
= err
;
241 static int ufs_qcom_check_hibern8(struct ufs_hba
*hba
)
245 unsigned long timeout
= jiffies
+ msecs_to_jiffies(HBRN8_POLL_TOUT_MS
);
248 err
= ufshcd_dme_get(hba
,
249 UIC_ARG_MIB_SEL(MPHY_TX_FSM_STATE
,
250 UIC_ARG_MPHY_TX_GEN_SEL_INDEX(0)),
252 if (err
|| tx_fsm_val
== TX_FSM_HIBERN8
)
255 /* sleep for max. 200us */
256 usleep_range(100, 200);
257 } while (time_before(jiffies
, timeout
));
260 * we might have scheduled out for long during polling so
261 * check the state again.
263 if (time_after(jiffies
, timeout
))
264 err
= ufshcd_dme_get(hba
,
265 UIC_ARG_MIB_SEL(MPHY_TX_FSM_STATE
,
266 UIC_ARG_MPHY_TX_GEN_SEL_INDEX(0)),
270 dev_err(hba
->dev
, "%s: unable to get TX_FSM_STATE, err %d\n",
272 } else if (tx_fsm_val
!= TX_FSM_HIBERN8
) {
274 dev_err(hba
->dev
, "%s: invalid TX_FSM_STATE = %d\n",
281 static void ufs_qcom_select_unipro_mode(struct ufs_qcom_host
*host
)
283 ufshcd_rmwl(host
->hba
, QUNIPRO_SEL
, QUNIPRO_SEL
, REG_UFS_CFG1
);
285 if (host
->hw_ver
.major
>= 0x05)
286 ufshcd_rmwl(host
->hba
, QUNIPRO_G4_SEL
, 0, REG_UFS_CFG0
);
290 * ufs_qcom_host_reset - reset host controller and PHY
292 static int ufs_qcom_host_reset(struct ufs_hba
*hba
)
295 struct ufs_qcom_host
*host
= ufshcd_get_variant(hba
);
298 if (!host
->core_reset
)
301 reenable_intr
= hba
->is_irq_enabled
;
302 ufshcd_disable_irq(hba
);
304 ret
= reset_control_assert(host
->core_reset
);
306 dev_err(hba
->dev
, "%s: core_reset assert failed, err = %d\n",
312 * The hardware requirement for delay between assert/deassert
313 * is at least 3-4 sleep clock (32.7KHz) cycles, which comes to
314 * ~125us (4/32768). To be on the safe side add 200us delay.
316 usleep_range(200, 210);
318 ret
= reset_control_deassert(host
->core_reset
);
320 dev_err(hba
->dev
, "%s: core_reset deassert failed, err = %d\n",
325 usleep_range(1000, 1100);
328 ufshcd_enable_irq(hba
);
333 static u32
ufs_qcom_get_hs_gear(struct ufs_hba
*hba
)
335 struct ufs_qcom_host
*host
= ufshcd_get_variant(hba
);
337 if (host
->hw_ver
.major
>= 0x4)
338 return UFS_QCOM_MAX_GEAR(ufshcd_readl(hba
, REG_UFS_PARAM0
));
340 /* Default is HS-G3 */
344 static int ufs_qcom_power_up_sequence(struct ufs_hba
*hba
)
346 struct ufs_qcom_host
*host
= ufshcd_get_variant(hba
);
347 struct ufs_host_params
*host_params
= &host
->host_params
;
348 struct phy
*phy
= host
->generic_phy
;
353 * HW ver 5 can only support up to HS-G5 Rate-A due to HW limitations.
354 * If the HS-G5 PHY gear is used, update host_params->hs_rate to Rate-A,
355 * so that the subsequent power mode change shall stick to Rate-A.
357 if (host
->hw_ver
.major
== 0x5) {
358 if (host
->phy_gear
== UFS_HS_G5
)
359 host_params
->hs_rate
= PA_HS_MODE_A
;
361 host_params
->hs_rate
= PA_HS_MODE_B
;
364 mode
= host_params
->hs_rate
== PA_HS_MODE_B
? PHY_MODE_UFS_HS_B
: PHY_MODE_UFS_HS_A
;
366 /* Reset UFS Host Controller and PHY */
367 ret
= ufs_qcom_host_reset(hba
);
371 /* phy initialization - calibrate the phy */
374 dev_err(hba
->dev
, "%s: phy init failed, ret = %d\n",
379 ret
= phy_set_mode_ext(phy
, mode
, host
->phy_gear
);
381 goto out_disable_phy
;
383 /* power on phy - start serdes and phy's power and clocks */
384 ret
= phy_power_on(phy
);
386 dev_err(hba
->dev
, "%s: phy power on failed, ret = %d\n",
388 goto out_disable_phy
;
391 ufs_qcom_select_unipro_mode(host
);
402 * The UTP controller has a number of internal clock gating cells (CGCs).
403 * Internal hardware sub-modules within the UTP controller control the CGCs.
404 * Hardware CGCs disable the clock to inactivate UTP sub-modules not involved
405 * in a specific operation, UTP controller CGCs are by default disabled and
406 * this function enables them (after every UFS link startup) to save some power
409 static void ufs_qcom_enable_hw_clk_gating(struct ufs_hba
*hba
)
411 ufshcd_rmwl(hba
, REG_UFS_CFG2_CGC_EN_ALL
, REG_UFS_CFG2_CGC_EN_ALL
,
414 /* Ensure that HW clock gating is enabled before next operations */
415 ufshcd_readl(hba
, REG_UFS_CFG2
);
418 static int ufs_qcom_hce_enable_notify(struct ufs_hba
*hba
,
419 enum ufs_notify_change_status status
)
421 struct ufs_qcom_host
*host
= ufshcd_get_variant(hba
);
426 err
= ufs_qcom_power_up_sequence(hba
);
431 * The PHY PLL output is the source of tx/rx lane symbol
432 * clocks, hence, enable the lane clocks only after PHY
435 err
= ufs_qcom_enable_lane_clks(host
);
438 /* check if UFS PHY moved from DISABLED to HIBERN8 */
439 err
= ufs_qcom_check_hibern8(hba
);
440 ufs_qcom_enable_hw_clk_gating(hba
);
441 ufs_qcom_ice_enable(host
);
444 dev_err(hba
->dev
, "%s: invalid status %d\n", __func__
, status
);
452 * ufs_qcom_cfg_timers - Configure ufs qcom cfg timers
454 * @hba: host controller instance
455 * @gear: Current operating gear
456 * @hs: current power mode
457 * @rate: current operating rate (A or B)
458 * @update_link_startup_timer: indicate if link_start ongoing
459 * @is_pre_scale_up: flag to check if pre scale up condition.
460 * Return: zero for success and non-zero in case of a failure.
462 static int ufs_qcom_cfg_timers(struct ufs_hba
*hba
, u32 gear
,
463 u32 hs
, u32 rate
, bool update_link_startup_timer
,
464 bool is_pre_scale_up
)
466 struct ufs_qcom_host
*host
= ufshcd_get_variant(hba
);
467 struct ufs_clk_info
*clki
;
468 unsigned long core_clk_rate
= 0;
469 u32 core_clk_cycles_per_us
;
472 * UTP controller uses SYS1CLK_1US_REG register for Interrupt
474 * It is mandatory to write SYS1CLK_1US_REG register on UFS host
475 * controller V4.0.0 onwards.
477 if (host
->hw_ver
.major
< 4 && !ufshcd_is_intr_aggr_allowed(hba
))
481 dev_err(hba
->dev
, "%s: invalid gear = %d\n", __func__
, gear
);
485 list_for_each_entry(clki
, &hba
->clk_list_head
, list
) {
486 if (!strcmp(clki
->name
, "core_clk")) {
488 core_clk_rate
= clki
->max_freq
;
490 core_clk_rate
= clk_get_rate(clki
->clk
);
496 /* If frequency is smaller than 1MHz, set to 1MHz */
497 if (core_clk_rate
< DEFAULT_CLK_RATE_HZ
)
498 core_clk_rate
= DEFAULT_CLK_RATE_HZ
;
500 core_clk_cycles_per_us
= core_clk_rate
/ USEC_PER_SEC
;
501 if (ufshcd_readl(hba
, REG_UFS_SYS1CLK_1US
) != core_clk_cycles_per_us
) {
502 ufshcd_writel(hba
, core_clk_cycles_per_us
, REG_UFS_SYS1CLK_1US
);
504 * make sure above write gets applied before we return from
507 ufshcd_readl(hba
, REG_UFS_SYS1CLK_1US
);
513 static int ufs_qcom_link_startup_notify(struct ufs_hba
*hba
,
514 enum ufs_notify_change_status status
)
520 if (ufs_qcom_cfg_timers(hba
, UFS_PWM_G1
, SLOWAUTO_MODE
,
522 dev_err(hba
->dev
, "%s: ufs_qcom_cfg_timers() failed\n",
527 err
= ufs_qcom_set_core_clk_ctrl(hba
, true);
529 dev_err(hba
->dev
, "cfg core clk ctrl failed\n");
531 * Some UFS devices (and may be host) have issues if LCC is
532 * enabled. So we are setting PA_Local_TX_LCC_Enable to 0
533 * before link startup which will make sure that both host
534 * and device TX LCC are disabled once link startup is
537 err
= ufshcd_disable_host_tx_lcc(hba
);
547 static void ufs_qcom_device_reset_ctrl(struct ufs_hba
*hba
, bool asserted
)
549 struct ufs_qcom_host
*host
= ufshcd_get_variant(hba
);
551 /* reset gpio is optional */
552 if (!host
->device_reset
)
555 gpiod_set_value_cansleep(host
->device_reset
, asserted
);
558 static int ufs_qcom_suspend(struct ufs_hba
*hba
, enum ufs_pm_op pm_op
,
559 enum ufs_notify_change_status status
)
561 struct ufs_qcom_host
*host
= ufshcd_get_variant(hba
);
562 struct phy
*phy
= host
->generic_phy
;
564 if (status
== PRE_CHANGE
)
567 if (ufs_qcom_is_link_off(hba
)) {
569 * Disable the tx/rx lane symbol clocks before PHY is
570 * powered down as the PLL source should be disabled
571 * after downstream clocks are disabled.
573 ufs_qcom_disable_lane_clks(host
);
576 /* reset the connected UFS device during power down */
577 ufs_qcom_device_reset_ctrl(hba
, true);
579 } else if (!ufs_qcom_is_link_active(hba
)) {
580 ufs_qcom_disable_lane_clks(host
);
583 return ufs_qcom_ice_suspend(host
);
586 static int ufs_qcom_resume(struct ufs_hba
*hba
, enum ufs_pm_op pm_op
)
588 struct ufs_qcom_host
*host
= ufshcd_get_variant(hba
);
589 struct phy
*phy
= host
->generic_phy
;
592 if (ufs_qcom_is_link_off(hba
)) {
593 err
= phy_power_on(phy
);
595 dev_err(hba
->dev
, "%s: failed PHY power on: %d\n",
600 err
= ufs_qcom_enable_lane_clks(host
);
604 } else if (!ufs_qcom_is_link_active(hba
)) {
605 err
= ufs_qcom_enable_lane_clks(host
);
610 return ufs_qcom_ice_resume(host
);
613 static void ufs_qcom_dev_ref_clk_ctrl(struct ufs_qcom_host
*host
, bool enable
)
615 if (host
->dev_ref_clk_ctrl_mmio
&&
616 (enable
^ host
->is_dev_ref_clk_enabled
)) {
617 u32 temp
= readl_relaxed(host
->dev_ref_clk_ctrl_mmio
);
620 temp
|= host
->dev_ref_clk_en_mask
;
622 temp
&= ~host
->dev_ref_clk_en_mask
;
625 * If we are here to disable this clock it might be immediately
626 * after entering into hibern8 in which case we need to make
627 * sure that device ref_clk is active for specific time after
631 unsigned long gating_wait
;
633 gating_wait
= host
->hba
->dev_info
.clk_gating_wait_us
;
638 * bRefClkGatingWaitTime defines the minimum
639 * time for which the reference clock is
640 * required by device during transition from
641 * HS-MODE to LS-MODE or HIBERN8 state. Give it
642 * more delay to be on the safe side.
645 usleep_range(gating_wait
, gating_wait
+ 10);
649 writel_relaxed(temp
, host
->dev_ref_clk_ctrl_mmio
);
652 * Make sure the write to ref_clk reaches the destination and
653 * not stored in a Write Buffer (WB).
655 readl(host
->dev_ref_clk_ctrl_mmio
);
658 * If we call hibern8 exit after this, we need to make sure that
659 * device ref_clk is stable for at least 1us before the hibern8
665 host
->is_dev_ref_clk_enabled
= enable
;
669 static int ufs_qcom_icc_set_bw(struct ufs_qcom_host
*host
, u32 mem_bw
, u32 cfg_bw
)
671 struct device
*dev
= host
->hba
->dev
;
674 ret
= icc_set_bw(host
->icc_ddr
, 0, mem_bw
);
676 dev_err(dev
, "failed to set bandwidth request: %d\n", ret
);
680 ret
= icc_set_bw(host
->icc_cpu
, 0, cfg_bw
);
682 dev_err(dev
, "failed to set bandwidth request: %d\n", ret
);
689 static struct __ufs_qcom_bw_table
ufs_qcom_get_bw_table(struct ufs_qcom_host
*host
)
691 struct ufs_pa_layer_attr
*p
= &host
->dev_req_params
;
692 int gear
= max_t(u32
, p
->gear_rx
, p
->gear_tx
);
693 int lane
= max_t(u32
, p
->lane_rx
, p
->lane_tx
);
695 if (WARN_ONCE(gear
> QCOM_UFS_MAX_GEAR
,
696 "ICC scaling for UFS Gear (%d) not supported. Using Gear (%d) bandwidth\n",
697 gear
, QCOM_UFS_MAX_GEAR
))
698 gear
= QCOM_UFS_MAX_GEAR
;
700 if (WARN_ONCE(lane
> QCOM_UFS_MAX_LANE
,
701 "ICC scaling for UFS Lane (%d) not supported. Using Lane (%d) bandwidth\n",
702 lane
, QCOM_UFS_MAX_LANE
))
703 lane
= QCOM_UFS_MAX_LANE
;
705 if (ufshcd_is_hs_mode(p
)) {
706 if (p
->hs_rate
== PA_HS_MODE_B
)
707 return ufs_qcom_bw_table
[MODE_HS_RB
][gear
][lane
];
709 return ufs_qcom_bw_table
[MODE_HS_RA
][gear
][lane
];
711 return ufs_qcom_bw_table
[MODE_PWM
][gear
][lane
];
715 static int ufs_qcom_icc_update_bw(struct ufs_qcom_host
*host
)
717 struct __ufs_qcom_bw_table bw_table
;
719 bw_table
= ufs_qcom_get_bw_table(host
);
721 return ufs_qcom_icc_set_bw(host
, bw_table
.mem_bw
, bw_table
.cfg_bw
);
724 static int ufs_qcom_pwr_change_notify(struct ufs_hba
*hba
,
725 enum ufs_notify_change_status status
,
726 struct ufs_pa_layer_attr
*dev_max_params
,
727 struct ufs_pa_layer_attr
*dev_req_params
)
729 struct ufs_qcom_host
*host
= ufshcd_get_variant(hba
);
730 struct ufs_host_params
*host_params
= &host
->host_params
;
733 if (!dev_req_params
) {
734 pr_err("%s: incoming dev_req_params is NULL\n", __func__
);
740 ret
= ufshcd_negotiate_pwr_params(host_params
, dev_max_params
, dev_req_params
);
742 dev_err(hba
->dev
, "%s: failed to determine capabilities\n",
748 * During UFS driver probe, always update the PHY gear to match the negotiated
749 * gear, so that, if quirk UFSHCD_QUIRK_REINIT_AFTER_MAX_GEAR_SWITCH is enabled,
750 * the second init can program the optimal PHY settings. This allows one to start
751 * the first init with either the minimum or the maximum support gear.
753 if (hba
->ufshcd_state
== UFSHCD_STATE_RESET
) {
755 * Skip REINIT if the negotiated gear matches with the
756 * initial phy_gear. Otherwise, update the phy_gear to
757 * program the optimal gear setting during REINIT.
759 if (host
->phy_gear
== dev_req_params
->gear_tx
)
760 hba
->quirks
&= ~UFSHCD_QUIRK_REINIT_AFTER_MAX_GEAR_SWITCH
;
762 host
->phy_gear
= dev_req_params
->gear_tx
;
765 /* enable the device ref clock before changing to HS mode */
766 if (!ufshcd_is_hs_mode(&hba
->pwr_info
) &&
767 ufshcd_is_hs_mode(dev_req_params
))
768 ufs_qcom_dev_ref_clk_ctrl(host
, true);
770 if (host
->hw_ver
.major
>= 0x4) {
771 ufshcd_dme_configure_adapt(hba
,
772 dev_req_params
->gear_tx
,
777 if (ufs_qcom_cfg_timers(hba
, dev_req_params
->gear_rx
,
778 dev_req_params
->pwr_rx
,
779 dev_req_params
->hs_rate
, false, false)) {
780 dev_err(hba
->dev
, "%s: ufs_qcom_cfg_timers() failed\n",
783 * we return error code at the end of the routine,
784 * but continue to configure UFS_PHY_TX_LANE_ENABLE
785 * and bus voting as usual
790 /* cache the power mode parameters to use internally */
791 memcpy(&host
->dev_req_params
,
792 dev_req_params
, sizeof(*dev_req_params
));
794 ufs_qcom_icc_update_bw(host
);
796 /* disable the device ref clock if entered PWM mode */
797 if (ufshcd_is_hs_mode(&hba
->pwr_info
) &&
798 !ufshcd_is_hs_mode(dev_req_params
))
799 ufs_qcom_dev_ref_clk_ctrl(host
, false);
809 static int ufs_qcom_quirk_host_pa_saveconfigtime(struct ufs_hba
*hba
)
812 u32 pa_vs_config_reg1
;
814 err
= ufshcd_dme_get(hba
, UIC_ARG_MIB(PA_VS_CONFIG_REG1
),
819 /* Allow extension of MSB bits of PA_SaveConfigTime attribute */
820 return ufshcd_dme_set(hba
, UIC_ARG_MIB(PA_VS_CONFIG_REG1
),
821 (pa_vs_config_reg1
| (1 << 12)));
824 static int ufs_qcom_apply_dev_quirks(struct ufs_hba
*hba
)
828 if (hba
->dev_quirks
& UFS_DEVICE_QUIRK_HOST_PA_SAVECONFIGTIME
)
829 err
= ufs_qcom_quirk_host_pa_saveconfigtime(hba
);
834 /* UFS device-specific quirks */
835 static struct ufs_dev_quirk ufs_qcom_dev_fixups
[] = {
836 { .wmanufacturerid
= UFS_VENDOR_SKHYNIX
,
837 .model
= UFS_ANY_MODEL
,
838 .quirk
= UFS_DEVICE_QUIRK_DELAY_BEFORE_LPM
},
839 { .wmanufacturerid
= UFS_VENDOR_TOSHIBA
,
840 .model
= UFS_ANY_MODEL
,
841 .quirk
= UFS_DEVICE_QUIRK_DELAY_AFTER_LPM
},
842 { .wmanufacturerid
= UFS_VENDOR_WDC
,
843 .model
= UFS_ANY_MODEL
,
844 .quirk
= UFS_DEVICE_QUIRK_HOST_PA_TACTIVATE
},
848 static void ufs_qcom_fixup_dev_quirks(struct ufs_hba
*hba
)
850 ufshcd_fixup_dev_quirks(hba
, ufs_qcom_dev_fixups
);
853 static u32
ufs_qcom_get_ufs_hci_version(struct ufs_hba
*hba
)
855 return ufshci_version(2, 0);
859 * ufs_qcom_advertise_quirks - advertise the known QCOM UFS controller quirks
860 * @hba: host controller instance
862 * QCOM UFS host controller might have some non standard behaviours (quirks)
863 * than what is specified by UFSHCI specification. Advertise all such
864 * quirks to standard UFS host controller driver so standard takes them into
867 static void ufs_qcom_advertise_quirks(struct ufs_hba
*hba
)
869 struct ufs_qcom_host
*host
= ufshcd_get_variant(hba
);
871 if (host
->hw_ver
.major
== 0x2)
872 hba
->quirks
|= UFSHCD_QUIRK_BROKEN_UFS_HCI_VERSION
;
874 if (host
->hw_ver
.major
> 0x3)
875 hba
->quirks
|= UFSHCD_QUIRK_REINIT_AFTER_MAX_GEAR_SWITCH
;
877 if (of_device_is_compatible(hba
->dev
->of_node
, "qcom,sm8550-ufshc") ||
878 of_device_is_compatible(hba
->dev
->of_node
, "qcom,sm8650-ufshc"))
879 hba
->quirks
|= UFSHCD_QUIRK_BROKEN_LSDBS_CAP
;
882 static void ufs_qcom_set_phy_gear(struct ufs_qcom_host
*host
)
884 struct ufs_host_params
*host_params
= &host
->host_params
;
888 * Default to powering up the PHY to the max gear possible, which is
889 * backwards compatible with lower gears but not optimal from
890 * a power usage point of view. After device negotiation, if the
891 * gear is lower a reinit will be performed to program the PHY
892 * to the ideal gear for this combo of controller and device.
894 host
->phy_gear
= host_params
->hs_tx_gear
;
896 if (host
->hw_ver
.major
< 0x4) {
898 * These controllers only have one PHY init sequence,
899 * let's power up the PHY using that (the minimum supported
902 host
->phy_gear
= UFS_HS_G2
;
903 } else if (host
->hw_ver
.major
>= 0x5) {
904 val
= ufshcd_readl(host
->hba
, REG_UFS_DEBUG_SPARE_CFG
);
905 dev_major
= FIELD_GET(UFS_DEV_VER_MAJOR_MASK
, val
);
908 * Since the UFS device version is populated, let's remove the
909 * REINIT quirk as the negotiated gear won't change during boot.
910 * So there is no need to do reinit.
912 if (dev_major
!= 0x0)
913 host
->hba
->quirks
&= ~UFSHCD_QUIRK_REINIT_AFTER_MAX_GEAR_SWITCH
;
916 * For UFS 3.1 device and older, power up the PHY using HS-G4
917 * PHY gear to save power.
919 if (dev_major
> 0x0 && dev_major
< 0x4)
920 host
->phy_gear
= UFS_HS_G4
;
924 static void ufs_qcom_set_host_params(struct ufs_hba
*hba
)
926 struct ufs_qcom_host
*host
= ufshcd_get_variant(hba
);
927 struct ufs_host_params
*host_params
= &host
->host_params
;
929 ufshcd_init_host_params(host_params
);
931 /* This driver only supports symmetic gear setting i.e., hs_tx_gear == hs_rx_gear */
932 host_params
->hs_tx_gear
= host_params
->hs_rx_gear
= ufs_qcom_get_hs_gear(hba
);
935 static void ufs_qcom_set_caps(struct ufs_hba
*hba
)
937 hba
->caps
|= UFSHCD_CAP_CLK_GATING
| UFSHCD_CAP_HIBERN8_WITH_CLK_GATING
;
938 hba
->caps
|= UFSHCD_CAP_CLK_SCALING
| UFSHCD_CAP_WB_WITH_CLK_SCALING
;
939 hba
->caps
|= UFSHCD_CAP_AUTO_BKOPS_SUSPEND
;
940 hba
->caps
|= UFSHCD_CAP_WB_EN
;
941 hba
->caps
|= UFSHCD_CAP_AGGR_POWER_COLLAPSE
;
942 hba
->caps
|= UFSHCD_CAP_RPM_AUTOSUSPEND
;
946 * ufs_qcom_setup_clocks - enables/disable clocks
947 * @hba: host controller instance
948 * @on: If true, enable clocks else disable them.
949 * @status: PRE_CHANGE or POST_CHANGE notify
951 * Return: 0 on success, non-zero on failure.
953 static int ufs_qcom_setup_clocks(struct ufs_hba
*hba
, bool on
,
954 enum ufs_notify_change_status status
)
956 struct ufs_qcom_host
*host
= ufshcd_get_variant(hba
);
959 * In case ufs_qcom_init() is not yet done, simply ignore.
960 * This ufs_qcom_setup_clocks() shall be called from
961 * ufs_qcom_init() after init is done.
969 ufs_qcom_icc_update_bw(host
);
971 if (!ufs_qcom_is_link_active(hba
)) {
972 /* disable device ref_clk */
973 ufs_qcom_dev_ref_clk_ctrl(host
, false);
979 /* enable the device ref clock for HS mode*/
980 if (ufshcd_is_hs_mode(&hba
->pwr_info
))
981 ufs_qcom_dev_ref_clk_ctrl(host
, true);
983 ufs_qcom_icc_set_bw(host
, ufs_qcom_bw_table
[MODE_MIN
][0][0].mem_bw
,
984 ufs_qcom_bw_table
[MODE_MIN
][0][0].cfg_bw
);
993 ufs_qcom_reset_assert(struct reset_controller_dev
*rcdev
, unsigned long id
)
995 struct ufs_qcom_host
*host
= rcdev_to_ufs_host(rcdev
);
997 ufs_qcom_assert_reset(host
->hba
);
998 /* provide 1ms delay to let the reset pulse propagate. */
999 usleep_range(1000, 1100);
1004 ufs_qcom_reset_deassert(struct reset_controller_dev
*rcdev
, unsigned long id
)
1006 struct ufs_qcom_host
*host
= rcdev_to_ufs_host(rcdev
);
1008 ufs_qcom_deassert_reset(host
->hba
);
1011 * after reset deassertion, phy will need all ref clocks,
1012 * voltage, current to settle down before starting serdes.
1014 usleep_range(1000, 1100);
1018 static const struct reset_control_ops ufs_qcom_reset_ops
= {
1019 .assert = ufs_qcom_reset_assert
,
1020 .deassert
= ufs_qcom_reset_deassert
,
1023 static int ufs_qcom_icc_init(struct ufs_qcom_host
*host
)
1025 struct device
*dev
= host
->hba
->dev
;
1028 host
->icc_ddr
= devm_of_icc_get(dev
, "ufs-ddr");
1029 if (IS_ERR(host
->icc_ddr
))
1030 return dev_err_probe(dev
, PTR_ERR(host
->icc_ddr
),
1031 "failed to acquire interconnect path\n");
1033 host
->icc_cpu
= devm_of_icc_get(dev
, "cpu-ufs");
1034 if (IS_ERR(host
->icc_cpu
))
1035 return dev_err_probe(dev
, PTR_ERR(host
->icc_cpu
),
1036 "failed to acquire interconnect path\n");
1039 * Set Maximum bandwidth vote before initializing the UFS controller and
1040 * device. Ideally, a minimal interconnect vote would suffice for the
1041 * initialization, but a max vote would allow faster initialization.
1043 ret
= ufs_qcom_icc_set_bw(host
, ufs_qcom_bw_table
[MODE_MAX
][0][0].mem_bw
,
1044 ufs_qcom_bw_table
[MODE_MAX
][0][0].cfg_bw
);
1046 return dev_err_probe(dev
, ret
, "failed to set bandwidth request\n");
1052 * ufs_qcom_init - bind phy with controller
1053 * @hba: host controller instance
1055 * Binds PHY with controller and powers up PHY enabling clocks
1058 * Return: -EPROBE_DEFER if binding fails, returns negative error
1059 * on phy power up failure and returns zero on success.
1061 static int ufs_qcom_init(struct ufs_hba
*hba
)
1064 struct device
*dev
= hba
->dev
;
1065 struct ufs_qcom_host
*host
;
1066 struct ufs_clk_info
*clki
;
1068 host
= devm_kzalloc(dev
, sizeof(*host
), GFP_KERNEL
);
1072 /* Make a two way bind between the qcom host and the hba */
1074 ufshcd_set_variant(hba
, host
);
1076 /* Setup the optional reset control of HCI */
1077 host
->core_reset
= devm_reset_control_get_optional(hba
->dev
, "rst");
1078 if (IS_ERR(host
->core_reset
)) {
1079 err
= dev_err_probe(dev
, PTR_ERR(host
->core_reset
),
1080 "Failed to get reset control\n");
1081 goto out_variant_clear
;
1084 /* Fire up the reset controller. Failure here is non-fatal. */
1085 host
->rcdev
.of_node
= dev
->of_node
;
1086 host
->rcdev
.ops
= &ufs_qcom_reset_ops
;
1087 host
->rcdev
.owner
= dev
->driver
->owner
;
1088 host
->rcdev
.nr_resets
= 1;
1089 err
= devm_reset_controller_register(dev
, &host
->rcdev
);
1091 dev_warn(dev
, "Failed to register reset controller\n");
1093 if (!has_acpi_companion(dev
)) {
1094 host
->generic_phy
= devm_phy_get(dev
, "ufsphy");
1095 if (IS_ERR(host
->generic_phy
)) {
1096 err
= dev_err_probe(dev
, PTR_ERR(host
->generic_phy
), "Failed to get PHY\n");
1097 goto out_variant_clear
;
1101 err
= ufs_qcom_icc_init(host
);
1103 goto out_variant_clear
;
1105 host
->device_reset
= devm_gpiod_get_optional(dev
, "reset",
1107 if (IS_ERR(host
->device_reset
)) {
1108 err
= dev_err_probe(dev
, PTR_ERR(host
->device_reset
),
1109 "Failed to acquire device reset gpio\n");
1110 goto out_variant_clear
;
1113 ufs_qcom_get_controller_revision(hba
, &host
->hw_ver
.major
,
1114 &host
->hw_ver
.minor
, &host
->hw_ver
.step
);
1116 host
->dev_ref_clk_ctrl_mmio
= hba
->mmio_base
+ REG_UFS_CFG1
;
1117 host
->dev_ref_clk_en_mask
= BIT(26);
1119 list_for_each_entry(clki
, &hba
->clk_list_head
, list
) {
1120 if (!strcmp(clki
->name
, "core_clk_unipro"))
1121 clki
->keep_link_active
= true;
1124 err
= ufs_qcom_init_lane_clks(host
);
1126 goto out_variant_clear
;
1128 ufs_qcom_set_caps(hba
);
1129 ufs_qcom_advertise_quirks(hba
);
1130 ufs_qcom_set_host_params(hba
);
1131 ufs_qcom_set_phy_gear(host
);
1133 err
= ufs_qcom_ice_init(host
);
1135 goto out_variant_clear
;
1137 ufs_qcom_setup_clocks(hba
, true, POST_CHANGE
);
1139 ufs_qcom_get_default_testbus_cfg(host
);
1140 err
= ufs_qcom_testbus_config(host
);
1142 /* Failure is non-fatal */
1143 dev_warn(dev
, "%s: failed to configure the testbus %d\n",
1149 ufshcd_set_variant(hba
, NULL
);
1154 static void ufs_qcom_exit(struct ufs_hba
*hba
)
1156 struct ufs_qcom_host
*host
= ufshcd_get_variant(hba
);
1158 ufs_qcom_disable_lane_clks(host
);
1159 phy_power_off(host
->generic_phy
);
1160 phy_exit(host
->generic_phy
);
1164 * ufs_qcom_set_clk_40ns_cycles - Configure 40ns clk cycles
1166 * @hba: host controller instance
1167 * @cycles_in_1us: No of cycles in 1us to be configured
1169 * Returns error if dme get/set configuration for 40ns fails
1170 * and returns zero on success.
1172 static int ufs_qcom_set_clk_40ns_cycles(struct ufs_hba
*hba
,
1175 struct ufs_qcom_host
*host
= ufshcd_get_variant(hba
);
1181 * UFS host controller V4.0.0 onwards needs to program
1182 * PA_VS_CORE_CLK_40NS_CYCLES attribute per programmed
1183 * frequency of unipro core clk of UFS host controller.
1185 if (host
->hw_ver
.major
< 4)
1189 * Generic formulae for cycles_in_40ns = (freq_unipro/25) is not
1190 * applicable for all frequencies. For ex: ceil(37.5 MHz/25) will
1191 * be 2 and ceil(403 MHZ/25) will be 17 whereas Hardware
1192 * specification expect to be 16. Hence use exact hardware spec
1193 * mandated value for cycles_in_40ns instead of calculating using
1196 switch (cycles_in_1us
) {
1197 case UNIPRO_CORE_CLK_FREQ_403_MHZ
:
1198 cycles_in_40ns
= 16;
1200 case UNIPRO_CORE_CLK_FREQ_300_MHZ
:
1201 cycles_in_40ns
= 12;
1203 case UNIPRO_CORE_CLK_FREQ_201_5_MHZ
:
1206 case UNIPRO_CORE_CLK_FREQ_150_MHZ
:
1209 case UNIPRO_CORE_CLK_FREQ_100_MHZ
:
1212 case UNIPRO_CORE_CLK_FREQ_75_MHZ
:
1215 case UNIPRO_CORE_CLK_FREQ_37_5_MHZ
:
1219 dev_err(hba
->dev
, "UNIPRO clk freq %u MHz not supported\n",
1224 err
= ufshcd_dme_get(hba
, UIC_ARG_MIB(PA_VS_CORE_CLK_40NS_CYCLES
), ®
);
1228 reg
&= ~PA_VS_CORE_CLK_40NS_CYCLES_MASK
;
1229 reg
|= cycles_in_40ns
;
1231 return ufshcd_dme_set(hba
, UIC_ARG_MIB(PA_VS_CORE_CLK_40NS_CYCLES
), reg
);
1234 static int ufs_qcom_set_core_clk_ctrl(struct ufs_hba
*hba
, bool is_scale_up
)
1236 struct ufs_qcom_host
*host
= ufshcd_get_variant(hba
);
1237 struct list_head
*head
= &hba
->clk_list_head
;
1238 struct ufs_clk_info
*clki
;
1239 u32 cycles_in_1us
= 0;
1240 u32 core_clk_ctrl_reg
;
1243 list_for_each_entry(clki
, head
, list
) {
1244 if (!IS_ERR_OR_NULL(clki
->clk
) &&
1245 !strcmp(clki
->name
, "core_clk_unipro")) {
1246 if (!clki
->max_freq
)
1247 cycles_in_1us
= 150; /* default for backwards compatibility */
1248 else if (is_scale_up
)
1249 cycles_in_1us
= ceil(clki
->max_freq
, (1000 * 1000));
1251 cycles_in_1us
= ceil(clk_get_rate(clki
->clk
), (1000 * 1000));
1256 err
= ufshcd_dme_get(hba
,
1257 UIC_ARG_MIB(DME_VS_CORE_CLK_CTRL
),
1258 &core_clk_ctrl_reg
);
1262 /* Bit mask is different for UFS host controller V4.0.0 onwards */
1263 if (host
->hw_ver
.major
>= 4) {
1264 if (!FIELD_FIT(CLK_1US_CYCLES_MASK_V4
, cycles_in_1us
))
1266 core_clk_ctrl_reg
&= ~CLK_1US_CYCLES_MASK_V4
;
1267 core_clk_ctrl_reg
|= FIELD_PREP(CLK_1US_CYCLES_MASK_V4
, cycles_in_1us
);
1269 if (!FIELD_FIT(CLK_1US_CYCLES_MASK
, cycles_in_1us
))
1271 core_clk_ctrl_reg
&= ~CLK_1US_CYCLES_MASK
;
1272 core_clk_ctrl_reg
|= FIELD_PREP(CLK_1US_CYCLES_MASK
, cycles_in_1us
);
1275 /* Clear CORE_CLK_DIV_EN */
1276 core_clk_ctrl_reg
&= ~DME_VS_CORE_CLK_CTRL_CORE_CLK_DIV_EN_BIT
;
1278 err
= ufshcd_dme_set(hba
,
1279 UIC_ARG_MIB(DME_VS_CORE_CLK_CTRL
),
1284 /* Configure unipro core clk 40ns attribute */
1285 return ufs_qcom_set_clk_40ns_cycles(hba
, cycles_in_1us
);
1288 static int ufs_qcom_clk_scale_up_pre_change(struct ufs_hba
*hba
)
1290 struct ufs_qcom_host
*host
= ufshcd_get_variant(hba
);
1291 struct ufs_pa_layer_attr
*attr
= &host
->dev_req_params
;
1294 ret
= ufs_qcom_cfg_timers(hba
, attr
->gear_rx
, attr
->pwr_rx
,
1295 attr
->hs_rate
, false, true);
1297 dev_err(hba
->dev
, "%s ufs cfg timer failed\n", __func__
);
1300 /* set unipro core clock attributes and clear clock divider */
1301 return ufs_qcom_set_core_clk_ctrl(hba
, true);
1304 static int ufs_qcom_clk_scale_up_post_change(struct ufs_hba
*hba
)
1309 static int ufs_qcom_clk_scale_down_pre_change(struct ufs_hba
*hba
)
1312 u32 core_clk_ctrl_reg
;
1314 err
= ufshcd_dme_get(hba
,
1315 UIC_ARG_MIB(DME_VS_CORE_CLK_CTRL
),
1316 &core_clk_ctrl_reg
);
1318 /* make sure CORE_CLK_DIV_EN is cleared */
1320 (core_clk_ctrl_reg
& DME_VS_CORE_CLK_CTRL_CORE_CLK_DIV_EN_BIT
)) {
1321 core_clk_ctrl_reg
&= ~DME_VS_CORE_CLK_CTRL_CORE_CLK_DIV_EN_BIT
;
1322 err
= ufshcd_dme_set(hba
,
1323 UIC_ARG_MIB(DME_VS_CORE_CLK_CTRL
),
1330 static int ufs_qcom_clk_scale_down_post_change(struct ufs_hba
*hba
)
1332 /* set unipro core clock attributes and clear clock divider */
1333 return ufs_qcom_set_core_clk_ctrl(hba
, false);
1336 static int ufs_qcom_clk_scale_notify(struct ufs_hba
*hba
,
1337 bool scale_up
, enum ufs_notify_change_status status
)
1339 struct ufs_qcom_host
*host
= ufshcd_get_variant(hba
);
1342 /* check the host controller state before sending hibern8 cmd */
1343 if (!ufshcd_is_hba_active(hba
))
1346 if (status
== PRE_CHANGE
) {
1347 err
= ufshcd_uic_hibern8_enter(hba
);
1351 err
= ufs_qcom_clk_scale_up_pre_change(hba
);
1353 err
= ufs_qcom_clk_scale_down_pre_change(hba
);
1356 ufshcd_uic_hibern8_exit(hba
);
1361 err
= ufs_qcom_clk_scale_up_post_change(hba
);
1363 err
= ufs_qcom_clk_scale_down_post_change(hba
);
1367 ufshcd_uic_hibern8_exit(hba
);
1371 ufs_qcom_icc_update_bw(host
);
1372 ufshcd_uic_hibern8_exit(hba
);
1378 static void ufs_qcom_enable_test_bus(struct ufs_qcom_host
*host
)
1380 ufshcd_rmwl(host
->hba
, UFS_REG_TEST_BUS_EN
,
1381 UFS_REG_TEST_BUS_EN
, REG_UFS_CFG1
);
1382 ufshcd_rmwl(host
->hba
, TEST_BUS_EN
, TEST_BUS_EN
, REG_UFS_CFG1
);
1385 static void ufs_qcom_get_default_testbus_cfg(struct ufs_qcom_host
*host
)
1387 /* provide a legal default configuration */
1388 host
->testbus
.select_major
= TSTBUS_UNIPRO
;
1389 host
->testbus
.select_minor
= 37;
1392 static bool ufs_qcom_testbus_cfg_is_ok(struct ufs_qcom_host
*host
)
1394 if (host
->testbus
.select_major
>= TSTBUS_MAX
) {
1395 dev_err(host
->hba
->dev
,
1396 "%s: UFS_CFG1[TEST_BUS_SEL} may not equal 0x%05X\n",
1397 __func__
, host
->testbus
.select_major
);
1404 int ufs_qcom_testbus_config(struct ufs_qcom_host
*host
)
1408 u32 mask
= TEST_BUS_SUB_SEL_MASK
;
1413 if (!ufs_qcom_testbus_cfg_is_ok(host
))
1416 switch (host
->testbus
.select_major
) {
1418 reg
= UFS_TEST_BUS_CTRL_0
;
1422 reg
= UFS_TEST_BUS_CTRL_0
;
1426 reg
= UFS_TEST_BUS_CTRL_0
;
1430 reg
= UFS_TEST_BUS_CTRL_0
;
1434 reg
= UFS_TEST_BUS_CTRL_1
;
1438 reg
= UFS_TEST_BUS_CTRL_1
;
1442 reg
= UFS_TEST_BUS_CTRL_1
;
1446 reg
= UFS_TEST_BUS_CTRL_1
;
1449 case TSTBUS_WRAPPER
:
1450 reg
= UFS_TEST_BUS_CTRL_2
;
1453 case TSTBUS_COMBINED
:
1454 reg
= UFS_TEST_BUS_CTRL_2
;
1457 case TSTBUS_UTP_HCI
:
1458 reg
= UFS_TEST_BUS_CTRL_2
;
1462 reg
= UFS_UNIPRO_CFG
;
1467 * No need for a default case, since
1468 * ufs_qcom_testbus_cfg_is_ok() checks that the configuration
1473 ufshcd_rmwl(host
->hba
, TEST_BUS_SEL
,
1474 (u32
)host
->testbus
.select_major
<< 19,
1476 ufshcd_rmwl(host
->hba
, mask
,
1477 (u32
)host
->testbus
.select_minor
<< offset
,
1479 ufs_qcom_enable_test_bus(host
);
1484 static void ufs_qcom_dump_dbg_regs(struct ufs_hba
*hba
)
1487 struct ufs_qcom_host
*host
;
1489 host
= ufshcd_get_variant(hba
);
1491 ufshcd_dump_regs(hba
, REG_UFS_SYS1CLK_1US
, 16 * 4,
1492 "HCI Vendor Specific Registers ");
1494 reg
= ufs_qcom_get_debug_reg_offset(host
, UFS_UFS_DBG_RD_REG_OCSC
);
1495 ufshcd_dump_regs(hba
, reg
, 44 * 4, "UFS_UFS_DBG_RD_REG_OCSC ");
1497 reg
= ufshcd_readl(hba
, REG_UFS_CFG1
);
1498 reg
|= UTP_DBG_RAMS_EN
;
1499 ufshcd_writel(hba
, reg
, REG_UFS_CFG1
);
1501 reg
= ufs_qcom_get_debug_reg_offset(host
, UFS_UFS_DBG_RD_EDTL_RAM
);
1502 ufshcd_dump_regs(hba
, reg
, 32 * 4, "UFS_UFS_DBG_RD_EDTL_RAM ");
1504 reg
= ufs_qcom_get_debug_reg_offset(host
, UFS_UFS_DBG_RD_DESC_RAM
);
1505 ufshcd_dump_regs(hba
, reg
, 128 * 4, "UFS_UFS_DBG_RD_DESC_RAM ");
1507 reg
= ufs_qcom_get_debug_reg_offset(host
, UFS_UFS_DBG_RD_PRDT_RAM
);
1508 ufshcd_dump_regs(hba
, reg
, 64 * 4, "UFS_UFS_DBG_RD_PRDT_RAM ");
1510 /* clear bit 17 - UTP_DBG_RAMS_EN */
1511 ufshcd_rmwl(hba
, UTP_DBG_RAMS_EN
, 0, REG_UFS_CFG1
);
1513 reg
= ufs_qcom_get_debug_reg_offset(host
, UFS_DBG_RD_REG_UAWM
);
1514 ufshcd_dump_regs(hba
, reg
, 4 * 4, "UFS_DBG_RD_REG_UAWM ");
1516 reg
= ufs_qcom_get_debug_reg_offset(host
, UFS_DBG_RD_REG_UARM
);
1517 ufshcd_dump_regs(hba
, reg
, 4 * 4, "UFS_DBG_RD_REG_UARM ");
1519 reg
= ufs_qcom_get_debug_reg_offset(host
, UFS_DBG_RD_REG_TXUC
);
1520 ufshcd_dump_regs(hba
, reg
, 48 * 4, "UFS_DBG_RD_REG_TXUC ");
1522 reg
= ufs_qcom_get_debug_reg_offset(host
, UFS_DBG_RD_REG_RXUC
);
1523 ufshcd_dump_regs(hba
, reg
, 27 * 4, "UFS_DBG_RD_REG_RXUC ");
1525 reg
= ufs_qcom_get_debug_reg_offset(host
, UFS_DBG_RD_REG_DFC
);
1526 ufshcd_dump_regs(hba
, reg
, 19 * 4, "UFS_DBG_RD_REG_DFC ");
1528 reg
= ufs_qcom_get_debug_reg_offset(host
, UFS_DBG_RD_REG_TRLUT
);
1529 ufshcd_dump_regs(hba
, reg
, 34 * 4, "UFS_DBG_RD_REG_TRLUT ");
1531 reg
= ufs_qcom_get_debug_reg_offset(host
, UFS_DBG_RD_REG_TMRLUT
);
1532 ufshcd_dump_regs(hba
, reg
, 9 * 4, "UFS_DBG_RD_REG_TMRLUT ");
1536 * ufs_qcom_device_reset() - toggle the (optional) device reset line
1537 * @hba: per-adapter instance
1539 * Toggles the (optional) reset line to reset the attached device.
1541 static int ufs_qcom_device_reset(struct ufs_hba
*hba
)
1543 struct ufs_qcom_host
*host
= ufshcd_get_variant(hba
);
1545 /* reset gpio is optional */
1546 if (!host
->device_reset
)
1550 * The UFS device shall detect reset pulses of 1us, sleep for 10us to
1551 * be on the safe side.
1553 ufs_qcom_device_reset_ctrl(hba
, true);
1554 usleep_range(10, 15);
1556 ufs_qcom_device_reset_ctrl(hba
, false);
1557 usleep_range(10, 15);
1562 #if IS_ENABLED(CONFIG_DEVFREQ_GOV_SIMPLE_ONDEMAND)
1563 static void ufs_qcom_config_scaling_param(struct ufs_hba
*hba
,
1564 struct devfreq_dev_profile
*p
,
1565 struct devfreq_simple_ondemand_data
*d
)
1568 p
->timer
= DEVFREQ_TIMER_DELAYED
;
1569 d
->upthreshold
= 70;
1570 d
->downdifferential
= 5;
1572 hba
->clk_scaling
.suspend_on_no_request
= true;
1575 static void ufs_qcom_config_scaling_param(struct ufs_hba
*hba
,
1576 struct devfreq_dev_profile
*p
,
1577 struct devfreq_simple_ondemand_data
*data
)
1582 static void ufs_qcom_reinit_notify(struct ufs_hba
*hba
)
1584 struct ufs_qcom_host
*host
= ufshcd_get_variant(hba
);
1586 phy_power_off(host
->generic_phy
);
1590 static const struct ufshcd_res_info ufs_res_info
[RES_MAX
] = {
1591 {.name
= "ufs_mem",},
1593 /* Submission Queue DAO */
1594 {.name
= "mcq_sqd",},
1595 /* Submission Queue Interrupt Status */
1596 {.name
= "mcq_sqis",},
1597 /* Completion Queue DAO */
1598 {.name
= "mcq_cqd",},
1599 /* Completion Queue Interrupt Status */
1600 {.name
= "mcq_cqis",},
1601 /* MCQ vendor specific */
1602 {.name
= "mcq_vs",},
1605 static int ufs_qcom_mcq_config_resource(struct ufs_hba
*hba
)
1607 struct platform_device
*pdev
= to_platform_device(hba
->dev
);
1608 struct ufshcd_res_info
*res
;
1609 struct resource
*res_mem
, *res_mcq
;
1612 memcpy(hba
->res
, ufs_res_info
, sizeof(ufs_res_info
));
1614 for (i
= 0; i
< RES_MAX
; i
++) {
1616 res
->resource
= platform_get_resource_byname(pdev
,
1619 if (!res
->resource
) {
1620 dev_info(hba
->dev
, "Resource %s not provided\n", res
->name
);
1624 } else if (i
== RES_UFS
) {
1625 res_mem
= res
->resource
;
1626 res
->base
= hba
->mmio_base
;
1630 res
->base
= devm_ioremap_resource(hba
->dev
, res
->resource
);
1631 if (IS_ERR(res
->base
)) {
1632 dev_err(hba
->dev
, "Failed to map res %s, err=%d\n",
1633 res
->name
, (int)PTR_ERR(res
->base
));
1634 ret
= PTR_ERR(res
->base
);
1640 /* MCQ resource provided in DT */
1641 res
= &hba
->res
[RES_MCQ
];
1642 /* Bail if MCQ resource is provided */
1646 /* Explicitly allocate MCQ resource from ufs_mem */
1647 res_mcq
= devm_kzalloc(hba
->dev
, sizeof(*res_mcq
), GFP_KERNEL
);
1651 res_mcq
->start
= res_mem
->start
+
1652 MCQ_SQATTR_OFFSET(hba
->mcq_capabilities
);
1653 res_mcq
->end
= res_mcq
->start
+ hba
->nr_hw_queues
* MCQ_QCFG_SIZE
- 1;
1654 res_mcq
->flags
= res_mem
->flags
;
1655 res_mcq
->name
= "mcq";
1657 ret
= insert_resource(&iomem_resource
, res_mcq
);
1659 dev_err(hba
->dev
, "Failed to insert MCQ resource, err=%d\n",
1664 res
->base
= devm_ioremap_resource(hba
->dev
, res_mcq
);
1665 if (IS_ERR(res
->base
)) {
1666 dev_err(hba
->dev
, "MCQ registers mapping failed, err=%d\n",
1667 (int)PTR_ERR(res
->base
));
1668 ret
= PTR_ERR(res
->base
);
1673 hba
->mcq_base
= res
->base
;
1677 remove_resource(res_mcq
);
1681 static int ufs_qcom_op_runtime_config(struct ufs_hba
*hba
)
1683 struct ufshcd_res_info
*mem_res
, *sqdao_res
;
1684 struct ufshcd_mcq_opr_info_t
*opr
;
1687 mem_res
= &hba
->res
[RES_UFS
];
1688 sqdao_res
= &hba
->res
[RES_MCQ_SQD
];
1690 if (!mem_res
->base
|| !sqdao_res
->base
)
1693 for (i
= 0; i
< OPR_MAX
; i
++) {
1694 opr
= &hba
->mcq_opr
[i
];
1695 opr
->offset
= sqdao_res
->resource
->start
-
1696 mem_res
->resource
->start
+ 0x40 * i
;
1697 opr
->stride
= 0x100;
1698 opr
->base
= sqdao_res
->base
+ 0x40 * i
;
1704 static int ufs_qcom_get_hba_mac(struct ufs_hba
*hba
)
1706 /* Qualcomm HC supports up to 64 */
1707 return MAX_SUPP_MAC
;
1710 static int ufs_qcom_get_outstanding_cqs(struct ufs_hba
*hba
,
1711 unsigned long *ocqs
)
1713 struct ufshcd_res_info
*mcq_vs_res
= &hba
->res
[RES_MCQ_VS
];
1715 if (!mcq_vs_res
->base
)
1718 *ocqs
= readl(mcq_vs_res
->base
+ UFS_MEM_CQIS_VS
);
1723 static void ufs_qcom_write_msi_msg(struct msi_desc
*desc
, struct msi_msg
*msg
)
1725 struct device
*dev
= msi_desc_to_dev(desc
);
1726 struct ufs_hba
*hba
= dev_get_drvdata(dev
);
1728 ufshcd_mcq_config_esi(hba
, msg
);
1731 static irqreturn_t
ufs_qcom_mcq_esi_handler(int irq
, void *data
)
1733 struct msi_desc
*desc
= data
;
1734 struct device
*dev
= msi_desc_to_dev(desc
);
1735 struct ufs_hba
*hba
= dev_get_drvdata(dev
);
1736 u32 id
= desc
->msi_index
;
1737 struct ufs_hw_queue
*hwq
= &hba
->uhq
[id
];
1739 ufshcd_mcq_write_cqis(hba
, 0x1, id
);
1740 ufshcd_mcq_poll_cqe_lock(hba
, hwq
);
1745 static int ufs_qcom_config_esi(struct ufs_hba
*hba
)
1747 struct ufs_qcom_host
*host
= ufshcd_get_variant(hba
);
1748 struct msi_desc
*desc
;
1749 struct msi_desc
*failed_desc
= NULL
;
1752 if (host
->esi_enabled
)
1756 * 1. We only handle CQs as of now.
1757 * 2. Poll queues do not need ESI.
1759 nr_irqs
= hba
->nr_hw_queues
- hba
->nr_queues
[HCTX_TYPE_POLL
];
1760 ret
= platform_device_msi_init_and_alloc_irqs(hba
->dev
, nr_irqs
,
1761 ufs_qcom_write_msi_msg
);
1763 dev_err(hba
->dev
, "Failed to request Platform MSI %d\n", ret
);
1767 msi_lock_descs(hba
->dev
);
1768 msi_for_each_desc(desc
, hba
->dev
, MSI_DESC_ALL
) {
1769 ret
= devm_request_irq(hba
->dev
, desc
->irq
,
1770 ufs_qcom_mcq_esi_handler
,
1771 IRQF_SHARED
, "qcom-mcq-esi", desc
);
1773 dev_err(hba
->dev
, "%s: Fail to request IRQ for %d, err = %d\n",
1774 __func__
, desc
->irq
, ret
);
1779 msi_unlock_descs(hba
->dev
);
1783 msi_lock_descs(hba
->dev
);
1784 msi_for_each_desc(desc
, hba
->dev
, MSI_DESC_ALL
) {
1785 if (desc
== failed_desc
)
1787 devm_free_irq(hba
->dev
, desc
->irq
, hba
);
1789 msi_unlock_descs(hba
->dev
);
1790 platform_device_msi_free_irqs_all(hba
->dev
);
1792 if (host
->hw_ver
.major
== 6 && host
->hw_ver
.minor
== 0 &&
1793 host
->hw_ver
.step
== 0)
1794 ufshcd_rmwl(hba
, ESI_VEC_MASK
,
1795 FIELD_PREP(ESI_VEC_MASK
, MAX_ESI_VEC
- 1),
1797 ufshcd_mcq_enable_esi(hba
);
1798 host
->esi_enabled
= true;
1805 * struct ufs_hba_qcom_vops - UFS QCOM specific variant operations
1807 * The variant operations configure the necessary controller and PHY
1808 * handshake during initialization.
1810 static const struct ufs_hba_variant_ops ufs_hba_qcom_vops
= {
1812 .init
= ufs_qcom_init
,
1813 .exit
= ufs_qcom_exit
,
1814 .get_ufs_hci_version
= ufs_qcom_get_ufs_hci_version
,
1815 .clk_scale_notify
= ufs_qcom_clk_scale_notify
,
1816 .setup_clocks
= ufs_qcom_setup_clocks
,
1817 .hce_enable_notify
= ufs_qcom_hce_enable_notify
,
1818 .link_startup_notify
= ufs_qcom_link_startup_notify
,
1819 .pwr_change_notify
= ufs_qcom_pwr_change_notify
,
1820 .apply_dev_quirks
= ufs_qcom_apply_dev_quirks
,
1821 .fixup_dev_quirks
= ufs_qcom_fixup_dev_quirks
,
1822 .suspend
= ufs_qcom_suspend
,
1823 .resume
= ufs_qcom_resume
,
1824 .dbg_register_dump
= ufs_qcom_dump_dbg_regs
,
1825 .device_reset
= ufs_qcom_device_reset
,
1826 .config_scaling_param
= ufs_qcom_config_scaling_param
,
1827 .program_key
= ufs_qcom_ice_program_key
,
1828 .reinit_notify
= ufs_qcom_reinit_notify
,
1829 .mcq_config_resource
= ufs_qcom_mcq_config_resource
,
1830 .get_hba_mac
= ufs_qcom_get_hba_mac
,
1831 .op_runtime_config
= ufs_qcom_op_runtime_config
,
1832 .get_outstanding_cqs
= ufs_qcom_get_outstanding_cqs
,
1833 .config_esi
= ufs_qcom_config_esi
,
1837 * ufs_qcom_probe - probe routine of the driver
1838 * @pdev: pointer to Platform device handle
1840 * Return: zero for success and non-zero for failure.
1842 static int ufs_qcom_probe(struct platform_device
*pdev
)
1845 struct device
*dev
= &pdev
->dev
;
1847 /* Perform generic probe */
1848 err
= ufshcd_pltfrm_init(pdev
, &ufs_hba_qcom_vops
);
1850 return dev_err_probe(dev
, err
, "ufshcd_pltfrm_init() failed\n");
1856 * ufs_qcom_remove - set driver_data of the device to NULL
1857 * @pdev: pointer to platform device handle
1861 static void ufs_qcom_remove(struct platform_device
*pdev
)
1863 struct ufs_hba
*hba
= platform_get_drvdata(pdev
);
1865 pm_runtime_get_sync(&(pdev
)->dev
);
1867 platform_device_msi_free_irqs_all(hba
->dev
);
1870 static const struct of_device_id ufs_qcom_of_match
[] __maybe_unused
= {
1871 { .compatible
= "qcom,ufshc" },
1872 { .compatible
= "qcom,sm8550-ufshc" },
1875 MODULE_DEVICE_TABLE(of
, ufs_qcom_of_match
);
1878 static const struct acpi_device_id ufs_qcom_acpi_match
[] = {
1882 MODULE_DEVICE_TABLE(acpi
, ufs_qcom_acpi_match
);
1885 static const struct dev_pm_ops ufs_qcom_pm_ops
= {
1886 SET_RUNTIME_PM_OPS(ufshcd_runtime_suspend
, ufshcd_runtime_resume
, NULL
)
1887 .prepare
= ufshcd_suspend_prepare
,
1888 .complete
= ufshcd_resume_complete
,
1889 #ifdef CONFIG_PM_SLEEP
1890 .suspend
= ufshcd_system_suspend
,
1891 .resume
= ufshcd_system_resume
,
1892 .freeze
= ufshcd_system_freeze
,
1893 .restore
= ufshcd_system_restore
,
1894 .thaw
= ufshcd_system_thaw
,
1898 static struct platform_driver ufs_qcom_pltform
= {
1899 .probe
= ufs_qcom_probe
,
1900 .remove
= ufs_qcom_remove
,
1902 .name
= "ufshcd-qcom",
1903 .pm
= &ufs_qcom_pm_ops
,
1904 .of_match_table
= of_match_ptr(ufs_qcom_of_match
),
1905 .acpi_match_table
= ACPI_PTR(ufs_qcom_acpi_match
),
1908 module_platform_driver(ufs_qcom_pltform
);
1910 MODULE_DESCRIPTION("Qualcomm UFS host controller driver");
1911 MODULE_LICENSE("GPL v2");